Doc / LSauth : Updated relative to last commit
[ldapsaisie.git] / doc / conf / LSauthMethod / LSauthMethod_CAS.docbook
1 <sect2 id="config-LSauthMethod_CAS">
2   <title>LSauthMethod_CAS</title>
3   <para>Cette &LSauthMethod; est utilisée pour gérer l'authentification
4   via un service SSO &CAS;. Cette librairie doit être configurée en éditant
5   le fichier de configiration
6   <literal>conf/LSauth/config.LSauthMethod_CAS.php</literal>.</para>
7   
8 <programlisting linenumbering="unnumbered">
9   <citetitle>Structure du fichier</citetitle>/*
10  *****************************************************
11  * Configuration of the CAS authentification support *
12  *****************************************************
13  */
14
15 // phpCAS Path (http://www.ja-sig.org/wiki/display/CASC/phpCAS)
16 define('PHP_CAS_PATH','/usr/share/php/CAS.php');
17
18 // phpCAS Debug File
19 // define('PHP_CAS_DEBUG_FILE','/tmp/phpCAS.log');
20
21 // Disable logout
22 define('LSAUTH_CAS_DISABLE_LOGOUT',false);
23
24 // CAS Server version (used constant name know by phpCAS : CAS_VERSION_1_0 or CAS_VERSION_2_0)
25 define('LSAUTH_CAS_VERSION','CAS_VERSION_2_0');
26
27 // CAS Server hostname
28 define('LSAUTH_CAS_SERVER_HOSTNAME','cas.univ.fr');
29
30 // CAS Server port
31 define('LSAUTH_CAS_SERVER_PORT',443);
32
33 // CAS Server URI (empty by default)
34 // define('LSAUTH_CAS_SERVER_URI','cas/');
35
36 // No SSL validation for the CAS server
37 define('LSAUTH_CAS_SERVER_NO_SSL_VALIDATION',false);
38
39 // CAS server SSL Certificate path
40 //define('LSAUTH_CAS_SERVER_SSL_CERT','');
41
42 // CAS server SSL CA Certificate path
43 //define('LSAUTH_CAS_SERVER_SSL_CACERT','');
44 </programlisting>
45
46 <!-- Début Paramètres Configuration -->  
47 <variablelist>
48 <title>Paramètres de configuration</title>
49
50 <varlistentry>
51   <term>PHP_CAS_PATH</term>
52   <listitem>
53     <simpara>Le chemin d'accès du fichier <literal>CAS.php</literal> de 
54     la librairie &phpCAS;. Le chemin d'exemple correspond au chemin résultant
55     d'une installation via PEAR sur une Debian (Lenny).</simpara>
56   </listitem>
57 </varlistentry>
58
59 <varlistentry>
60   <term>PHP_CAS_DEBUG_FILE</term>
61   <listitem>
62     <simpara>Chemin du fichier de log de la librairie &phpCAS;. Commenter
63     la ligne pour désactiver les logs.</simpara>
64   </listitem>
65 </varlistentry>
66
67 <varlistentry>
68   <term>LSAUTH_CAS_DISABLE_LOGOUT</term>
69   <listitem>
70     <simpara>Booléen définissant si l'utilisateur peut se déconnecter du 
71     serveur &CAS; depuis l'interface.</simpara>
72     <note><simpara>Remarque : l'appel de l'URL de déconnexion via une requête
73     <literal>GET</literal> supprimera la session &php; et donc la session
74     LdapSaisie sans déconnecter pour autant l'utilisateur au niveau du 
75     serveur &CAS;. Cela peut donc permettre de gérer la déconnexion
76     automatique au niveau d'LdapSaisie suite à une déconnexion au niveau du
77     CAS à traver le concepte de <literal>Global Logout</literal>.</simpara></note>
78   </listitem>
79 </varlistentry>
80
81 <varlistentry>
82   <term>LSAUTH_CAS_VERSION</term>
83   <listitem>
84     <simpara>Nom de la constant &phpCAS; permettant de définir la version
85     CAS du serveur. Actuellement, la librairie &phpCAS; ne reconnait que 
86     la constante <literal>CAS_VERSION_1_0</literal> pour la version 1 de
87     CAS ou la constante <literal>CAS_VERSION_2_0</literal> pour la version
88     2 de CAS.</simpara>
89     <note><simpara>Remarque : Des tests on montrés que l'utilisation d'une
90     compatibilité CAS version 2 peut également fonctionner sur un version
91     3 du serveur CAS.</simpara></note>
92   </listitem>
93 </varlistentry>
94
95 <varlistentry>
96   <term>LSAUTH_CAS_SERVER_HOSTNAME</term>
97   <listitem>
98     <simpara>Le nom d'hôte du serveur &CAS;.</simpara>
99   </listitem>
100 </varlistentry>
101
102 <varlistentry>
103   <term>LSAUTH_CAS_SERVER_PORT</term>
104   <listitem>
105     <simpara>Le port d'écoute du serveur &CAS;.</simpara>
106   </listitem>
107 </varlistentry>
108
109 <varlistentry>
110   <term>LSAUTH_CAS_SERVER_URI</term>
111   <listitem>
112     <simpara>Le dossier HTTP dans lequel se trouve le service &CAS;.
113     Exemple : Pour un service CAS accessible via l'URL 
114     <literal>https://cas.univ.fr/cas/</literal>, la constante devra valoir
115     <literal>cas/</literal>.</simpara>
116   </listitem>
117 </varlistentry>
118
119 <varlistentry>
120   <term>LSAUTH_CAS_SERVER_NO_SSL_VALIDATION</term>
121   <listitem>
122     <simpara>Booléen permettant de désactiver la validation du certificat
123     SSL du serveur CAS lors des requêtes de validation des tickets CAS.</simpara>
124   </listitem>
125 </varlistentry>
126
127 <varlistentry>
128   <term>LSAUTH_CAS_SERVER_SSL_CERT</term>
129   <listitem>
130     <simpara>Chemin d'accès du fichier contenant le certificat SSL du serveur
131     CAS au format PEM. Commenter la ligne pour désactiver ce paramètre.</simpara>
132   </listitem>
133 </varlistentry>
134
135 <varlistentry>
136   <term>LSAUTH_CAS_SERVER_SSL_CACERT</term>
137   <listitem>
138     <simpara>Chemin d'accès du fichier contenant le certificat SSL de la 
139     CA du serveur CAS au format PEM. Commenter la ligne pour désactiver
140     ce paramètre.</simpara>
141   </listitem>
142 </varlistentry>
143
144 </variablelist>
145 </sect2>