documentation/manual/ja/module_specs/Zend_Ldap-API.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!-- Reviewed: no -->
   3 <!-- EN-Revision: 20792 -->
   4 <sect1 id="zend.ldap.api" xmlns:xi="http://www.w3.org/2001/XInclude">
   5     <title>API概要</title>
   6
   7     <sect2 id="zend.ldap.api.configuration">
   8         <title>設定／オプション</title>
   9
  10         <para>
  11             <classname>Zend_Ldap</classname>コンポーネント用のオプション配列は、
  12             コンストラクタあるいは<methodname>setOptions()</methodname>メソッドで指定できます。
  13             下記のオプションが利用できます:
  14         </para>
  15
  16         <table id="zend.ldap.api.configuration.table">
  17             <title>Zend_Ldapオプション</title>
  18
  19             <tgroup cols="2">
  20                 <thead>
  21                     <row>
  22                         <entry>名前</entry>
  23                         <entry>説明</entry>
  24                     </row>
  25                 </thead>
  26
  27                 <tbody>
  28                     <row>
  29                         <entry><property>host</property></entry>
  30
  31                         <entry>
  32                             <acronym>LDAP</acronym>サーバのデフォルトのホスト名。
  33                             <methodname>connect()</methodname>で指定しなかった場合に使用します
  34                              (<methodname>bind()</methodname>の際にユーザ名を正規化するときにも使用します)。
  35                         </entry>
  36                     </row>
  37
  38                     <row>
  39                         <entry><property>port</property></entry>
  40
  41                         <entry>
  42                             <acronym>LDAP</acronym>サーバのデフォルトのポート。
  43                             <methodname>connect()</methodname>で指定しなかった場合に使用します。
  44                         </entry>
  45                     </row>
  46
  47                     <row>
  48                         <entry><property>useStartTls</property></entry>
  49
  50                         <entry>
  51                             <acronym>LDAP</acronym>クライアント側に
  52                             <acronym>TLS</acronym>(別名<acronym>SSLv2</acronym>)
  53                             での暗号化トランスポートを要求するか否か。
  54                             実運用環境では <constant>TRUE</constant> を指定することを強く推奨します。
  55                             これにより、パスワードが平文で送られてしまうことを防ぎます。
  56                             デフォルト値は <constant>FALSE</constant> です。
  57                             というのも、この機能を使用するにはサーバ側に別途、
  58                             証明書のインストールが必要となることが多いからです。
  59                             <emphasis>useSsl</emphasis>オプションと
  60                             <emphasis>useStartTls</emphasis>オプションは共存できません。
  61                             <emphasis>useStartTls</emphasis>オプションのほうが
  62                             <emphasis>useSsl</emphasis>より推奨されていますが、
  63                             中にはこの新しい仕組みをサポートしていないサーバもあります。
  64                         </entry>
  65                     </row>
  66
  67                     <row>
  68                         <entry><property>useSsl</property></entry>
  69
  70                         <entry>
  71                             <acronym>LDAP</acronym>クライアント側に
  72                             <acronym>SSL</acronym>での暗号化トランスポートを要求するか否か。
  73                             <emphasis>useSsl</emphasis>オプションと
  74                             <emphasis>useStartTls</emphasis> オプションは共存できません。
  75                         </entry>
  76                     </row>
  77
  78                     <row>
  79                         <entry><property>username</property></entry>
  80
  81                         <entry>
  82                             デフォルトの認証ユーザ名。
  83                             サーバによっては、DN 形式を要求するものもあります。
  84                             DN にバインドすることを<acronym>LDAP</acronym>サーバーが要求するならば、
  85                             これは DN 形式で与えられなければなりません。
  86                             そして、バインディングは単純なユーザー名で可能でなければなりません
  87                         </entry>
  88                     </row>
  89
  90                     <row>
  91                         <entry><property>password</property></entry>
  92
  93                         <entry>
  94                             デフォルトの認証パスワード (上のユーザ名との組み合わせでのみ使用します)。
  95                         </entry>
  96                     </row>
  97
  98                     <row>
  99                         <entry><property>bindRequiresDn</property></entry>
 100
 101                         <entry>
 102                             <constant>TRUE</constant> を指定すると、ユーザ名が DN 形式でない場合に
 103                             <classname>Zend_Ldap</classname> をバインド時に使用してアカウントの DN を取得します。
 104                             デフォルト値は <constant>FALSE</constant> です。
 105                         </entry>
 106                     </row>
 107
 108                     <row>
 109                         <entry><property>baseDn</property></entry>
 110
 111                         <entry>
 112                             (アカウントなどの) 検索に使用するデフォルトのベース DN。
 113                             このオプションは、アカウントに関する大半の操作で必須となります。
 114                             そのアカウントが存在する DN を指す必要があります。
 115                         </entry>
 116                     </row>
 117
 118                     <row>
 119                         <entry><property>accountCanonicalForm</property></entry>
 120
 121                         <entry>
 122                             アカウント名の正規化方式を表す整数値。
 123                             以下の<link
 124                                 linkend="zend.ldap.introduction.theory-of-operations.account-name-canonicalization">
 125                             <emphasis>アカウント名の正規化</emphasis></link>
 126                             節を参照ください。
 127                         </entry>
 128                     </row>
 129
 130                     <row>
 131                         <entry><property>accountDomainName</property></entry>
 132
 133                         <entry>
 134                             対象となる<acronym>LDAP</acronym>サーバの <acronym>FQDN</acronym> ドメイン
 135                             (例 example.com)。
 136                         </entry>
 137                     </row>
 138
 139                     <row>
 140                         <entry><property>accountDomainNameShort</property></entry>
 141
 142                         <entry>
 143                             対象となる<acronym>LDAP</acronym>サーバの '短い' ドメイン。
 144                             これは、Windows ネットワークの NetBIOS ドメイン名として用いられますが、
 145                             AD 以外のサーバで用いられることもあります。
 146                         </entry>
 147                     </row>
 148
 149                     <row>
 150                         <entry><property>accountFilterFormat</property></entry>
 151
 152                         <entry>
 153                             アカウントを検索する際に使用する<acronym>LDAP</acronym>検索フィルタ。
 154                             この文字列は
 155                             <ulink url="http://php.net/sprintf"><methodname>sprintf()</methodname></ulink>
 156                             形式のものとなり、ユーザ名を表す '<emphasis>%s</emphasis>'
 157                             をひとつ含む必要があります。デフォルト値は
 158                             '<emphasis>(&amp;(objectClass=user)(sAMAccountName=%s))</emphasis>' です。
 159                             ただし、<emphasis>bindRequiresDn</emphasis> が <constant>TRUE</constant>
 160                             の場合のデフォルト値は
 161                             '<emphasis>(&amp;(objectClass=posixAccount)(uid=%s))</emphasis>'
 162                             となります。独自のスキーマを使用している場合は、
 163                             それにあわせてこのオプションを変更しなければなりません。
 164                         </entry>
 165                     </row>
 166
 167                     <row>
 168                         <entry><property>allowEmptyPassword</property></entry>
 169
 170                         <entry>
 171                             <acronym>LDAP</acronym>サーバによっては、
 172                             匿名バインドの際のパスワードに空文字を設定できるものもあります。
 173                             この挙動は、ほとんどの場合において好ましくないものです。
 174                             そのため、空のパスワードは明示的に無効にしています。
 175                             この値を<constant>TRUE</constant>にすると、
 176                             バインド時に空文字列のパスワードを使用できるようになります。
 177                         </entry>
 178                     </row>
 179
 180                     <row>
 181                         <entry><property>optReferrals</property></entry>
 182
 183                         <entry>
 184                             <constant>TRUE</constant>に設定すると、
 185                             参照先を追跡するよう<acronym>LDAP</acronym>クライアントに指示します。
 186                             デフォルト値は<constant>FALSE</constant>です。
 187                         </entry>
 188                     </row>
 189
 190                     <row>
 191                         <entry><property>tryUsernameSplit</property></entry>
 192
 193                         <entry>
 194                             <constant>FALSE</constant>にセットすると、
 195                             バインディング手続きの間、与えられたユーザー名において
 196                             ユーザー名をドメインから切り離すために、
 197                             最初の<emphasis>@</emphasis>または<emphasis>\</emphasis>文字で分割してはいけないことを示します。
 198                             これにより、一部のドメーン情報を継承しない
 199                             （例えばバインディングのための電子メール・アドレスを使用する）、
 200                             <emphasis>@</emphasis>または<emphasis>\</emphasis>を含むユーザー名を
 201                             ユーザーが利用できるようになります。
 202                             デフォルト値は<constant>TRUE</constant>です。
 203                         </entry>
 204                     </row>
 205                 </tbody>
 206             </tgroup>
 207         </table>
 208     </sect2>
 209
 210     <sect2 id="zend.ldap.api.reference">
 211         <title>APIリファレンス</title>
 212
 213         <note>
 214             <para><emphasis>斜体</emphasis>のメソッド名は static メソッドです。</para>
 215         </note>
 216
 217         <xi:include href="Zend_Ldap-API-Ldap.xml">
 218             <xi:fallback><xi:include href="../../en/module_specs/Zend_Ldap-API-Ldap.xml" /></xi:fallback>
 219         </xi:include>
 220         <xi:include href="Zend_Ldap-API-Ldap-Attribute.xml">
 221             <xi:fallback><xi:include href="../../en/module_specs/Zend_Ldap-API-Ldap-Attribute.xml" /></xi:fallback>
 222         </xi:include>
 223         <xi:include href="Zend_Ldap-API-Ldap-Dn.xml">
 224             <xi:fallback><xi:include href="../../en/module_specs/Zend_Ldap-API-Ldap-Dn.xml" /></xi:fallback>
 225         </xi:include>
 226         <xi:include href="Zend_Ldap-API-Ldap-Filter.xml" />
 227         <xi:include href="Zend_Ldap-API-Ldap-Node.xml">
 228             <xi:fallback><xi:include href="../../en/module_specs/Zend_Ldap-API-Ldap-Node.xml" /></xi:fallback>
 229         </xi:include>
 230         <xi:include href="Zend_Ldap-API-Ldap-Node-RootDse.xml" />
 231         <xi:include href="Zend_Ldap-API-Ldap-Node-Schema.xml" />
 232         <xi:include href="Zend_Ldap-API-Ldap-Ldif-Encoder.xml" />
 233     </sect2>
 234 </sect1>