LSformElement_password : Added possibility to have multiple contact mail attributes
[ldapsaisie.git] / doc / conf / LSattribute / LSattr_html / LSattr_html_password.docbook
1 <sect4 id="config-LSattr_html_password">
2   <title>LSattr_html_password</title>
3   <para>Ce type est utilisé pour la gestion des attributs dont la valeur est
4   un mot de passe.</para>
5   
6   <programlisting linenumbering="unnumbered">
7 <citetitle>Structure</citetitle>...
8 <![CDATA['html_options' => array(
9   'isLoginPassword' => [booleen],
10   'generationTool' => [booleen],
11   'autoGenerate' => [booleen],
12   'lenght' => [nombre de caractères],
13   'chars' => array ( // Caractères que peut contenir le mot de passe
14     array( // Liste caractère avec un nombre mininum d'apparition supérieur à 1
15       'nb' => [nb caractères],
16       'chars' => '[liste de caractères possibles]'
17     ),
18     '[autre liste de caractères possible]', // Liste caractère avec un nombre 
19                                             // d'apparitions égal à 1
20     ...
21   ),
22   'verify' => [booléen],  // Activation de l'outil de vérification du mot de passe
23   'viewHash' => [booléen],  // Activation de l'outil de visualisation du mot de passe haché
24   'mail' => array( // Configuration de l'envoi du mot de passe par mail
25     'subject' => "[LSformat du sujet du mail]",
26     'msg' => "[LSformat du message du mail]",
27     'mail_attr' => 'mail', // Attribut mail de l'objet
28     'send' => 1,  // Activation par défaut de l'envoi du mot de passe
29     'ask' => 1,   // Laisser le choix à l'utilisateur
30     'canEdit' => 1   // Activation de l'édition du LSformat du message par l'utilisateur
31   )
32 ),]]>
33 ...
34 </programlisting>
35
36 <variablelist>
37 <title>Paramètres de configuration</title>
38
39 <varlistentry>
40   <term>isLoginPassword</term>
41   <listitem>
42     <simpara>Booléen définissant si le mot de passe est celui utilisé par l'utilisateur
43     pour se logguer à l'annuaire LDAP. Si c'est le cas, le mot de passe saisi dans le
44     formulaire sera utilisé pour une tentative de connexion de l'utilisateur afin de
45     déterminer si le mot de passe a été modifié ou non. (Par défaut : <literal>Vrai</literal>)</simpara>
46   </listitem>
47 </varlistentry>
48
49 <varlistentry>
50   <term>generationTool</term>
51   <listitem>
52     <simpara>Booléen définissant si l'outil de génération de mot de passe est
53     activé.</simpara>
54   </listitem>
55 </varlistentry>
56
57 <varlistentry>
58   <term>autoGenerate</term>
59   <listitem>
60     <simpara>Active la génération automatique du mot de passe lorsque l'attribut
61     n'a encore aucune valeur de définie. Il faut également que l'outil de
62     génération soit activé (<parameter>generationTool</parameter>).</simpara>
63   </listitem>
64 </varlistentry>
65
66 <varlistentry>
67   <term>lenght</term>
68   <listitem>
69     <simpara>Nombre de caractères que devront contenir les mots de passe générés.
70     </simpara>
71   </listitem>
72 </varlistentry>
73
74 <varlistentry>
75   <term>chars</term>
76   <listitem>
77     <para>Tableau contenant une liste de listes de caractères possibles pour
78     composer le mot de passe. Dans chacune de ces listes, au moins un caractère
79     sera utilisé dans le nouveau mot de passe. Il est possible de définir un
80     nombre supérieur de caractères d'une liste devant apparaître dans les mots de
81     passe générés en spécifiant un tableau associatif dont la clé <emphasis>nb
82     </emphasis> associra le nombre entier de caractères et la clé <emphasis>chars
83     </emphasis> la liste de caractères. Une liste de caractères est un chaîne.</para>
84   </listitem>
85 </varlistentry>
86
87 <varlistentry>
88   <term>verify</term>
89   <listitem>
90     <simpara>Booléen définissant si l'outil de vérification du mot de passe est
91     activé. Si celui-ci est activé, l'utilisateur pourra entrer un mot de passe
92     dans le champ et cliquer sur un bouton qui lancera une procédure de
93     vérification du mot de passe via un test de connexion à l'annuaire.</simpara>
94   </listitem>
95 </varlistentry>
96
97 <varlistentry>
98   <term>viewHash</term>
99   <listitem>
100     <simpara>Booléen définissant si l'utilisateur aura accès à la fonctionnalité 
101     de visualisation du mot de passe haché.</simpara>
102   </listitem>
103 </varlistentry>
104
105 <varlistentry>
106   <term>mail</term>
107   <listitem>
108     <para>Paramètres de configuration de l'envoi par mail du mot de passe à
109     l'utilisateur. Lorsque cet outil est activé, lors de la modification/création
110     du mot de passe, l'utilisateur pourra recevoir un mail lui spécifiant son
111     nouveau mot de passe.
112     
113     <variablelist>
114       <title>Paramêtres de configuration</title>
115
116       <varlistentry>
117         <term>send</term>
118         <listitem>
119           <simpara>Booléen définissant si l'envoi du mot de passe est activé par
120           défaut.</simpara>
121         </listitem>
122       </varlistentry>
123       
124       <varlistentry>
125         <term>ask</term>
126         <listitem>
127           <simpara>Booléen définissant si on laisse le choix à l'utilisateur
128           d'activer ou non l'envoi du mot de passe par mail.</simpara>
129         </listitem>
130       </varlistentry>
131       
132       <varlistentry>
133         <term>canEdit</term>
134         <listitem>
135           <simpara>Booléen définissant si on laisse la possibilité à l'utilisateur
136           d'éditer le &LSformat; du message et du sujet.</simpara>
137         </listitem>
138       </varlistentry>
139
140       <varlistentry>
141         <term>subject</term>
142         <listitem>
143           <simpara>&LSformat; du sujet du mail. Ce format sera composé avec la
144           valeur du nouveau mot de passe de l'utilisateur.</simpara>
145         </listitem>
146       </varlistentry>
147       
148       <varlistentry>
149         <term>msg</term>
150         <listitem>
151           <simpara>&LSformat; du message du mail. Ce format sera composé avec la
152           valeur du nouveau mot de passe de l'utilisateur.</simpara>
153         </listitem>
154       </varlistentry>
155       
156       <varlistentry>
157         <term>mail_attr</term>
158         <listitem>
159           <simpara>Le nom de l'attribut listant les mails possibles de
160           l'utilisateur. Par défaut, la première valeur de l'attribut sera
161           utilisée comme adresse mail destinatrice. Cet attribut peut également
162           être un tableau de plusieurs noms d'attributs. Dans ce cas, la première
163           valeur correcte sera retenue.
164           Si <parameter>canEdit</parameter> est activé, l'utilisateur pourra
165           choisir l'adresse mail destinatrice parmi la liste des valeurs de
166           l'attribut.</simpara>
167         </listitem>
168       </varlistentry>
169
170       <varlistentry>
171         <term>bcc</term>
172         <listitem>
173           <simpara>Mettre en <emphasis>BCC</emphasis> un mail systématiquement
174           (ou plusieurs en les séparant par des virgules).</simpara>
175         </listitem>
176       </varlistentry>
177
178       <varlistentry>
179         <term>headers</term>
180         <listitem>
181           <simpara>Un tableau de type clé/valeur ou la clé est le nom d'un header
182           à ajouter au mail et la valeur est la valeur de l'header en question.
183           </simpara>
184         </listitem>
185       </varlistentry>
186       
187     </variablelist>
188     
189     </para>
190   </listitem>
191 </varlistentry>
192
193 </variablelist>
194   
195   
196 </sect4>