LSsession : Add useUserCredentials parameter
[ldapsaisie.git] / doc / conf / srv-ldap.docbook
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <sect3 id="config-srv-ldap">
3   <title>Configuration des serveurs LDAP</title>
4
5 <para>Cette section décrit le tableau de configuration des différents serveurs
6 LDAP utilisés par l'application. Ce tableau contient lui même un tableau par
7 serveur LDAP.</para>
8
9 <programlisting linenumbering="unnumbered">
10   <citetitle>Structure</citetitle>...
11 <![CDATA[$GLOBALS['LSconfig'] = array(
12   ...
13   'ldap_servers' => array(
14     array (
15       'name' => [nom de l'annuaire],
16       'ldap_config'=> array(
17         // Définition des paramètres de connexion à l'annuaire
18       ),
19       'useUserCredentials' => [boolean],
20       'LSauth' => array (
21         'method' => [LSauth method]
22       ),
23       'LSprofiles' => array (
24         // Définition des LSprofiles
25       ),
26       'cacheLSprofiles' => [boolean],
27       'cacheSearch' => [boolean],
28       'authObjectType' => [LSobject],
29       'authObjectFilter' => [LSformat],
30       'authObjectTypeAttrPwd' => [attribut],
31       'LSaccess' => array (
32         [Type LSobject 1],
33         [Type LSobject 2],
34         ...
35       ),
36       'subDn' => array(
37         // Définition des sous-niveaux de l'annuaire
38       ),
39       'subDnLabel' => [nom des sous-niveaux],
40       'recoverPassword' => array(
41         // Définition des paramètres de configuration de la récupération de mot de passe
42       ),
43       'emailSender' => [email],
44       'keepLSsessionActive' => [booléen]
45     )
46   ...
47 );]]>
48 ...
49 </programlisting>
50
51 <!-- Début Paramètres Configuration -->  
52 <variablelist>
53 <title>Paramètres de configuration</title>
54
55 <varlistentry>
56   <term>name</term>
57   <listitem>
58     <simpara>Le nom d'affichage de ce serveur Ldap
59     (utilisé lorsque plusieurs serveur LDAP sont déclarés).</simpara>
60   </listitem>
61 </varlistentry>
62
63
64 <varlistentry>
65   <term>ldap_config</term>
66   <listitem>
67     <simpara>Informations de connexion au serveur LDAP. Ces informations sont 
68     structurées selon les attentes de la librairie &netldap;. 
69     <ulink url='http://pear.php.net/manual/fr/package.networking.net-ldap.connecting.php'>
70     Plus d'informations</ulink>
71     </simpara>
72   </listitem>
73 </varlistentry>
74
75 <varlistentry>
76   <term>useUserCredentials</term>
77   <listitem>
78     <simpara>Booléen définissant si il faut utiliser les identifiants de l'utilisateur pour
79     se connecter à l'annuaire (<emphasis>false</emphasis> par défaut). Si cette option est
80     activée, la connexion à l'annuaire LDAP sera établie avec la configuration fournie dans
81     le paramètre <emphasis>ldap_config</emphasis> en écrasant les informations de connexion
82     (<emphasis>binddn</emphasis> et <emphasis>bindpwd</emphasis>) par ceux de l'utilisateur.
83     Si l'utilisateur n'est pas encore connecté, la connexion sera étalie sans modifier la
84     configuration fournie.
85     </simpara>
86   </listitem>
87 </varlistentry>
88
89
90 <varlistentry>
91   <term>LSprofiles</term>
92   <listitem>
93     <simpara>Définition des profils d'utilisateurs se connectant à l'annuaire.
94     <link linkend="config-LSprofile">Voir la section concernée</link>.
95     </simpara>
96   </listitem>
97 </varlistentry>
98
99
100 <varlistentry>
101   <term>LSauth</term>
102   <listitem>
103     <simpara>Définition de la méthode d'authentification &LSauthMethod;. Pour le
104     moment ce tableau associatif ne contient qu'un paramètre <parameter>
105     method</parameter> qui correpond au nom de la librairie d'authentification.
106     Exemple : pour utiliser la classe <literal>LSauthMethod_HTTP</literal>, la
107     valeur du paramètre <parameter>method</parameter> sera <literal>HTTP</literal>.
108     </simpara>
109   </listitem>
110 </varlistentry>
111
112
113 <varlistentry>
114   <term>cacheLSprofiles</term>
115   <listitem>
116     <simpara>Activation/Désactivation de la mise en cache des &LSprofiles; des 
117     utilisateurs connectés à ce serveur.</simpara>
118   </listitem>
119 </varlistentry>
120
121
122 <varlistentry>
123   <term>cacheSearch</term>
124   <listitem>
125     <simpara>Activation/Désactivation de la mise en cache du résultat des 
126     recherches sur ce serveur.</simpara>
127   </listitem>
128 </varlistentry>
129
130
131 <varlistentry>
132   <term>authObjectType</term>
133   <listitem>
134     <simpara>Nom du type d'&LSobject; pouvant être utilisé pour authentifier un 
135     utilisateur se connectant à l'interface.</simpara>
136   </listitem>
137 </varlistentry>
138
139
140 <varlistentry>
141   <term>authObjectFilter</term>
142   <listitem>
143     <simpara>&LSformat; du filtre de recherche de l'utilisateur à sa connexion.
144     Le LSformat sera composé avec la valeur de l'information fourni par l'utilisateur.
145     Cela peut pemettre par exemple de permettre à l'utilisateur de se connecter en 
146     fournissant soit son login, soit son email. Exemple de valeur : 
147     <literal>(|(uid=%{user})(mail=%{user}))</literal></simpara>
148   </listitem>
149 </varlistentry>
150
151
152 <varlistentry>
153   <term>authObjectTypeAttrPwd</term>
154   <listitem>
155     <simpara>Nom de l'attribut "mot de passe" du type d'&LSobject; utilisé pour 
156     l'authentification des utilisateurs se connectant à l'interface.</simpara>
157   </listitem>
158 </varlistentry>
159
160
161 <varlistentry id="config-LSaccess">
162   <term>LSaccess</term>
163   <listitem>
164     <simpara>Définition des types d'&LSobjects; devant apparaître dans le menu de 
165     l'interface.</simpara>
166     <important><simpara>Ce paramètre n'est utilisé que pour les annuaires n'ayant 
167     pas de sous-niveaux (&subDn;).</simpara></important>
168   </listitem>
169 </varlistentry>
170
171
172 <varlistentry>
173   <term>subDn</term>
174   <listitem>
175     <simpara>Définition des sous-niveaux de connexion à l'annuaire.
176     <link linkend="config-subDn">Voir section concernée</link>.</simpara>
177     <important><simpara>Ce paramètre remplace le paramètre 
178     <link linkend="config-LSaccess">LSaccess</link> dans le cas d'un annuaire 
179     multi-niveaux.</simpara></important>
180   </listitem>
181 </varlistentry>
182
183
184 <varlistentry>
185   <term>subDnLabel</term>
186   <listitem>
187     <simpara>Définition du label utilisé pour qualifier les sous-niveaux de
188     connexion.</simpara>
189     <important><simpara>Ce paramètre est utile uniquement dans le cas d'un annuaire 
190     multi-niveaux.</simpara></important>
191   </listitem>
192 </varlistentry>
193
194
195 <varlistentry>
196   <term>recoverPassword</term>
197   <listitem>
198     <simpara>Définition des paramètres de la récupération de mot de passe.
199     <link linkend="config-recoverPassword">Voir la section concernée</link>.</simpara>
200   </listitem>
201 </varlistentry>
202
203
204 <varlistentry>
205   <term>emailSender</term>
206   <listitem>
207     <simpara>Adresse mail utilisée par &LdapSaisie; pour envoyer des e-mails en 
208     relation avec cet annuaire. Cette adresse est celle utilisée par défaut. 
209     L'adresse utilisée peut également être configurée dans le contexte de
210     configuration du module devant envoyer des e-mails.</simpara>
211   </listitem>
212 </varlistentry>
213
214 <varlistentry>
215   <term>keepLSsessionActive</term>
216   <listitem>
217     <simpara>Activation/Désactivation du maintient de la LSsession active.</simpara>
218     <simpara>Valeurs possibles : <emphasis>True</emphasis> ou 
219     <emphasis>False</emphasis></simpara>
220   </listitem>
221 </varlistentry>
222
223
224 </variablelist>
225 <!-- Fim Paramètres Configuration -->
226
227 &conf-LSprofile;
228
229 &conf-subDn;
230
231 &conf-recoverPassword;
232
233 </sect3>