Doc / LSauth : Updated relative to last commit
authorBenjamin Renard <brenard@easter-eggs.com>
Thu, 25 Nov 2010 10:21:43 +0000 (11:21 +0100)
committerBenjamin Renard <brenard@easter-eggs.com>
Thu, 25 Nov 2010 10:21:43 +0000 (11:21 +0100)
14 files changed:
doc/LS.entities.xml
doc/LdapSaisie.docbook
doc/conf/LSauth.docbook [deleted file]
doc/conf/LSauth/LSauth.entities.xml [deleted file]
doc/conf/LSauth/LSauthCAS.docbook [deleted file]
doc/conf/LSauth/LSauthHTTP.docbook [deleted file]
doc/conf/LSauthMethod.docbook [new file with mode: 0644]
doc/conf/LSauthMethod/LSauthMethod.entities.xml [new file with mode: 0644]
doc/conf/LSauthMethod/LSauthMethod_CAS.docbook [new file with mode: 0644]
doc/conf/LSauthMethod/LSauthMethod_HTTP.docbook [new file with mode: 0644]
doc/conf/conf.docbook
doc/conf/conf.entities.xml
doc/conf/srv-ldap.docbook
doc/install/arbo.docbook

index 2168521..aff845b 100644 (file)
@@ -24,5 +24,5 @@
 <!ENTITY LSformats "<link linkend='config-LSformat'>LSformats</link>">
 <!ENTITY LSaddon "<link linkend='config-LSaddon'>LSaddon</link>">
 <!ENTITY LSaddons "<link linkend='config-LSaddon'>LSaddons</link>">
 <!ENTITY LSformats "<link linkend='config-LSformat'>LSformats</link>">
 <!ENTITY LSaddon "<link linkend='config-LSaddon'>LSaddon</link>">
 <!ENTITY LSaddons "<link linkend='config-LSaddon'>LSaddons</link>">
-<!ENTITY LSauth "<link linkend='config-LSauth'>LSauth</link>">
+<!ENTITY LSauthMethod "<link linkend='config-LSauthMethod'>LSauthMethod</link>">
 <!ENTITY LSselect "<emphasis>LSselect</emphasis>">
 <!ENTITY LSselect "<emphasis>LSselect</emphasis>">
index 245513d..0a795ed 100644 (file)
@@ -15,8 +15,8 @@ book SYSTEM "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   %conf-LSattribute-check_data-entities;
   <!ENTITY % conf-LSaddon-entities SYSTEM "conf/LSaddon/LSaddon.entities.xml">
   %conf-LSaddon-entities;
   %conf-LSattribute-check_data-entities;
   <!ENTITY % conf-LSaddon-entities SYSTEM "conf/LSaddon/LSaddon.entities.xml">
   %conf-LSaddon-entities;
-  <!ENTITY % conf-LSauth-entities SYSTEM "conf/LSauth/LSauth.entities.xml">
-  %conf-LSauth-entities;
+  <!ENTITY % conf-LSauthMethod-entities SYSTEM "conf/LSauthMethod/LSauthMethod.entities.xml">
+  %conf-LSauthMethod-entities;
 
   <!ENTITY intro SYSTEM "intro/intro.docbook">
   <!ENTITY install SYSTEM "install/install.docbook">
 
   <!ENTITY intro SYSTEM "intro/intro.docbook">
   <!ENTITY install SYSTEM "install/install.docbook">
diff --git a/doc/conf/LSauth.docbook b/doc/conf/LSauth.docbook
deleted file mode 100644 (file)
index aba7050..0000000
+++ /dev/null
@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<sect1 id='config-LSauth'>
-  <title>Configuration des LSauths</title>
-  <para>
-    Cette partie décrit la manière de configurer les différentes librairies
-    d'authentification d'&LdapSaisie; appelée &LSauth;. Ces librairies peuvent
-    avoir un fichier de configuration et il sera alors stocké dans le dossier
-    <literal>conf/LSauth/</literal>.
-  </para>
-  
-  &conf-LSauthHTTP;
-  &conf-LSauthCAS;
-  
-</sect1>
diff --git a/doc/conf/LSauth/LSauth.entities.xml b/doc/conf/LSauth/LSauth.entities.xml
deleted file mode 100644 (file)
index d4e0019..0000000
+++ /dev/null
@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<!ENTITY conf-LSauthHTTP SYSTEM "LSauthHTTP.docbook">
-<!ENTITY conf-LSauthCAS SYSTEM "LSauthCAS.docbook">
-
-
-
-
diff --git a/doc/conf/LSauth/LSauthCAS.docbook b/doc/conf/LSauth/LSauthCAS.docbook
deleted file mode 100644 (file)
index 0ab427f..0000000
+++ /dev/null
@@ -1,144 +0,0 @@
-<sect2 id="config-LSauthCAS">
-  <title>LSauthCAS</title>
-  <para>Cet &LSauth; est utilisé pour gérer l'authentification via un
-  service SSO &CAS;. Cette librairie doit être configuré en éditant le 
-  fichier de configiration <literal>conf/LSauth/config.LSauthCAS.php</literal>.</para>
-  
-<programlisting linenumbering="unnumbered">
-  <citetitle>Structure du fichier</citetitle>/*
- *****************************************************
- * Configuration of the CAS authentification support *
- *****************************************************
- */
-
-// phpCAS Path (http://www.ja-sig.org/wiki/display/CASC/phpCAS)
-define('PHP_CAS_PATH','/usr/share/php/CAS.php');
-
-// phpCAS Debug File
-// define('PHP_CAS_DEBUG_FILE','/tmp/phpCAS.log');
-
-// Disable logout
-define('LSAUTH_CAS_DISABLE_LOGOUT',false);
-
-// CAS Server version (used constant name know by phpCAS : CAS_VERSION_1_0 or CAS_VERSION_2_0)
-define('LSAUTH_CAS_VERSION','CAS_VERSION_2_0');
-
-// CAS Server hostname
-define('LSAUTH_CAS_SERVER_HOSTNAME','cas.univ.fr');
-
-// CAS Server port
-define('LSAUTH_CAS_SERVER_PORT',443);
-
-// CAS Server URI (empty by default)
-// define('LSAUTH_CAS_SERVER_URI','cas/');
-
-// No SSL validation for the CAS server
-define('LSAUTH_CAS_SERVER_NO_SSL_VALIDATION',false);
-
-// CAS server SSL Certificate path
-//define('LSAUTH_CAS_SERVER_SSL_CERT','');
-
-// CAS server SSL CA Certificate path
-//define('LSAUTH_CAS_SERVER_SSL_CACERT','');
-</programlisting>
-
-<!-- Début Paramètres Configuration -->  
-<variablelist>
-<title>Paramètres de configuration</title>
-
-<varlistentry>
-  <term>PHP_CAS_PATH</term>
-  <listitem>
-    <simpara>Le chemin d'accès du fichier <literal>CAS.php</literal> de 
-    la librairie &phpCAS;. Le chemin d'exemple correspond au chemin résultant
-    d'une installation via PEAR sur une Debian (Lenny).</simpara>
-  </listitem>
-</varlistentry>
-
-<varlistentry>
-  <term>PHP_CAS_DEBUG_FILE</term>
-  <listitem>
-    <simpara>Chemin du fichier de log de la librairie &phpCAS;. Commenter
-    la ligne pour désactiver les logs.</simpara>
-  </listitem>
-</varlistentry>
-
-<varlistentry>
-  <term>LSAUTH_CAS_DISABLE_LOGOUT</term>
-  <listitem>
-    <simpara>Booléen définissant si l'utilisateur peut se déconnecter du 
-    serveur &CAS; depuis l'interface.</simpara>
-    <note><simpara>Remarque : l'appel de l'URL de déconnexion via une requête
-    <literal>GET</literal> supprimera la session &php; et donc la session
-    LdapSaisie sans déconnecter pour autant l'utilisateur au niveau du 
-    serveur &CAS;. Cela peut donc permettre de gérer la déconnexion
-    automatique au niveau d'LdapSaisie suite à une déconnexion au niveau du
-    CAS à traver le concepte de <literal>Global Logout</literal>.</simpara></note>
-  </listitem>
-</varlistentry>
-
-<varlistentry>
-  <term>LSAUTH_CAS_VERSION</term>
-  <listitem>
-    <simpara>Nom de la constant &phpCAS; permettant de définir la version
-    CAS du serveur. Actuellement, la librairie &phpCAS; ne reconnait que 
-    la constante <literal>CAS_VERSION_1_0</literal> pour la version 1 de
-    CAS ou la constante <literal>CAS_VERSION_2_0</literal> pour la version
-    2 de CAS.</simpara>
-    <note><simpara>Remarque : Des tests on montrés que l'utilisation d'une
-    compatibilité CAS version 2 peut également fonctionner sur un version
-    3 du serveur CAS.</simpara></note>
-  </listitem>
-</varlistentry>
-
-<varlistentry>
-  <term>LSAUTH_CAS_SERVER_HOSTNAME</term>
-  <listitem>
-    <simpara>Le nom d'hôte du serveur &CAS;.</simpara>
-  </listitem>
-</varlistentry>
-
-<varlistentry>
-  <term>LSAUTH_CAS_SERVER_PORT</term>
-  <listitem>
-    <simpara>Le port d'écoute du serveur &CAS;.</simpara>
-  </listitem>
-</varlistentry>
-
-<varlistentry>
-  <term>LSAUTH_CAS_SERVER_URI</term>
-  <listitem>
-    <simpara>Le dossier HTTP dans lequel se trouve le service &CAS;.
-    Exemple : Pour un service CAS accessible via l'URL 
-    <literal>https://cas.univ.fr/cas/</literal>, la constante devra valoir
-    <literal>cas/</literal>.</simpara>
-  </listitem>
-</varlistentry>
-
-<varlistentry>
-  <term>LSAUTH_CAS_SERVER_NO_SSL_VALIDATION</term>
-  <listitem>
-    <simpara>Booléen permettant de désactiver la validation du certificat
-    SSL du serveur CAS lors des requêtes de validation des tickets CAS.</simpara>
-  </listitem>
-</varlistentry>
-
-<varlistentry>
-  <term>LSAUTH_CAS_SERVER_SSL_CERT</term>
-  <listitem>
-    <simpara>Chemin d'accès du fichier contenant le certificat SSL du serveur
-    CAS au format PEM. Commenter la ligne pour désactiver ce paramètre.</simpara>
-  </listitem>
-</varlistentry>
-
-<varlistentry>
-  <term>LSAUTH_CAS_SERVER_SSL_CACERT</term>
-  <listitem>
-    <simpara>Chemin d'accès du fichier contenant le certificat SSL de la 
-    CA du serveur CAS au format PEM. Commenter la ligne pour désactiver
-    ce paramètre.</simpara>
-  </listitem>
-</varlistentry>
-
-</variablelist>
-</sect2>
diff --git a/doc/conf/LSauth/LSauthHTTP.docbook b/doc/conf/LSauth/LSauthHTTP.docbook
deleted file mode 100644 (file)
index 19b4070..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-<sect2 id="config-LSauthHTTP">
-  <title>LSauthHTTP</title>
-  <para>Cet &LSauth; est utilisé pour gérer l'authentification via les
-  variables d'environnements définies suite à une authentification gérée
-  par le serveur HTTP. En &php;, ces informations sont consultables via
-  les variables <literal>$_SERVER['PHP_AUTH_USER']</literal> et 
-  <literal>$_SERVER['PHP_AUTH_PW']</literal>. Cet &LSauth; n'utilise ici
-  que la variable <literal>$_SERVER['PHP_AUTH_USER']</literal>. Si celle-ci
-  est présente, une recherche dans l'annuaire est effectué pour trouver
-  l'utilisateur correspondant. L'authentification réussi uniquement un et
-  un seul utilisateur est retourné par la recherche.</para>
-  
-  <note><simpara>La recherche est effectuée sur une égalité
-  parfaite du RDN ou en utilisant le &LSformat; de fitre de recherche 
-  <literal>authObjectFilter</literal> défini dans la 
-  <link linkend='config-srv-ldap'>configuration du serveur LDAP</link>
-  </simpara></note>
-</sect2>
diff --git a/doc/conf/LSauthMethod.docbook b/doc/conf/LSauthMethod.docbook
new file mode 100644 (file)
index 0000000..455c06c
--- /dev/null
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<sect1 id='config-LSauthMethod'>
+  <title>Configuration des LSauthMethods</title>
+  <para>
+    Cette partie décrit la manière de configurer les méthodes 
+    d'authentification d'&LdapSaisie; appelée &LSauthMethod;. Ces 
+    librairies peuvent avoir un fichier de configuration et il sera alors
+    stocké dans le dossier <literal>conf/LSauth/</literal>.
+  </para>
+  
+  &conf-LSauthMethod_HTTP;
+  &conf-LSauthMethod_CAS;
+  
+</sect1>
diff --git a/doc/conf/LSauthMethod/LSauthMethod.entities.xml b/doc/conf/LSauthMethod/LSauthMethod.entities.xml
new file mode 100644 (file)
index 0000000..f737603
--- /dev/null
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!ENTITY conf-LSauthMethod_HTTP SYSTEM "LSauthMethod_HTTP.docbook">
+<!ENTITY conf-LSauthMethod_CAS SYSTEM "LSauthMethod_CAS.docbook">
+
+
+
+
diff --git a/doc/conf/LSauthMethod/LSauthMethod_CAS.docbook b/doc/conf/LSauthMethod/LSauthMethod_CAS.docbook
new file mode 100644 (file)
index 0000000..e308890
--- /dev/null
@@ -0,0 +1,145 @@
+<sect2 id="config-LSauthMethod_CAS">
+  <title>LSauthMethod_CAS</title>
+  <para>Cette &LSauthMethod; est utilisée pour gérer l'authentification
+  via un service SSO &CAS;. Cette librairie doit être configurée en éditant
+  le fichier de configiration
+  <literal>conf/LSauth/config.LSauthMethod_CAS.php</literal>.</para>
+  
+<programlisting linenumbering="unnumbered">
+  <citetitle>Structure du fichier</citetitle>/*
+ *****************************************************
+ * Configuration of the CAS authentification support *
+ *****************************************************
+ */
+
+// phpCAS Path (http://www.ja-sig.org/wiki/display/CASC/phpCAS)
+define('PHP_CAS_PATH','/usr/share/php/CAS.php');
+
+// phpCAS Debug File
+// define('PHP_CAS_DEBUG_FILE','/tmp/phpCAS.log');
+
+// Disable logout
+define('LSAUTH_CAS_DISABLE_LOGOUT',false);
+
+// CAS Server version (used constant name know by phpCAS : CAS_VERSION_1_0 or CAS_VERSION_2_0)
+define('LSAUTH_CAS_VERSION','CAS_VERSION_2_0');
+
+// CAS Server hostname
+define('LSAUTH_CAS_SERVER_HOSTNAME','cas.univ.fr');
+
+// CAS Server port
+define('LSAUTH_CAS_SERVER_PORT',443);
+
+// CAS Server URI (empty by default)
+// define('LSAUTH_CAS_SERVER_URI','cas/');
+
+// No SSL validation for the CAS server
+define('LSAUTH_CAS_SERVER_NO_SSL_VALIDATION',false);
+
+// CAS server SSL Certificate path
+//define('LSAUTH_CAS_SERVER_SSL_CERT','');
+
+// CAS server SSL CA Certificate path
+//define('LSAUTH_CAS_SERVER_SSL_CACERT','');
+</programlisting>
+
+<!-- Début Paramètres Configuration -->  
+<variablelist>
+<title>Paramètres de configuration</title>
+
+<varlistentry>
+  <term>PHP_CAS_PATH</term>
+  <listitem>
+    <simpara>Le chemin d'accès du fichier <literal>CAS.php</literal> de 
+    la librairie &phpCAS;. Le chemin d'exemple correspond au chemin résultant
+    d'une installation via PEAR sur une Debian (Lenny).</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>PHP_CAS_DEBUG_FILE</term>
+  <listitem>
+    <simpara>Chemin du fichier de log de la librairie &phpCAS;. Commenter
+    la ligne pour désactiver les logs.</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>LSAUTH_CAS_DISABLE_LOGOUT</term>
+  <listitem>
+    <simpara>Booléen définissant si l'utilisateur peut se déconnecter du 
+    serveur &CAS; depuis l'interface.</simpara>
+    <note><simpara>Remarque : l'appel de l'URL de déconnexion via une requête
+    <literal>GET</literal> supprimera la session &php; et donc la session
+    LdapSaisie sans déconnecter pour autant l'utilisateur au niveau du 
+    serveur &CAS;. Cela peut donc permettre de gérer la déconnexion
+    automatique au niveau d'LdapSaisie suite à une déconnexion au niveau du
+    CAS à traver le concepte de <literal>Global Logout</literal>.</simpara></note>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>LSAUTH_CAS_VERSION</term>
+  <listitem>
+    <simpara>Nom de la constant &phpCAS; permettant de définir la version
+    CAS du serveur. Actuellement, la librairie &phpCAS; ne reconnait que 
+    la constante <literal>CAS_VERSION_1_0</literal> pour la version 1 de
+    CAS ou la constante <literal>CAS_VERSION_2_0</literal> pour la version
+    2 de CAS.</simpara>
+    <note><simpara>Remarque : Des tests on montrés que l'utilisation d'une
+    compatibilité CAS version 2 peut également fonctionner sur un version
+    3 du serveur CAS.</simpara></note>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>LSAUTH_CAS_SERVER_HOSTNAME</term>
+  <listitem>
+    <simpara>Le nom d'hôte du serveur &CAS;.</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>LSAUTH_CAS_SERVER_PORT</term>
+  <listitem>
+    <simpara>Le port d'écoute du serveur &CAS;.</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>LSAUTH_CAS_SERVER_URI</term>
+  <listitem>
+    <simpara>Le dossier HTTP dans lequel se trouve le service &CAS;.
+    Exemple : Pour un service CAS accessible via l'URL 
+    <literal>https://cas.univ.fr/cas/</literal>, la constante devra valoir
+    <literal>cas/</literal>.</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>LSAUTH_CAS_SERVER_NO_SSL_VALIDATION</term>
+  <listitem>
+    <simpara>Booléen permettant de désactiver la validation du certificat
+    SSL du serveur CAS lors des requêtes de validation des tickets CAS.</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>LSAUTH_CAS_SERVER_SSL_CERT</term>
+  <listitem>
+    <simpara>Chemin d'accès du fichier contenant le certificat SSL du serveur
+    CAS au format PEM. Commenter la ligne pour désactiver ce paramètre.</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>LSAUTH_CAS_SERVER_SSL_CACERT</term>
+  <listitem>
+    <simpara>Chemin d'accès du fichier contenant le certificat SSL de la 
+    CA du serveur CAS au format PEM. Commenter la ligne pour désactiver
+    ce paramètre.</simpara>
+  </listitem>
+</varlistentry>
+
+</variablelist>
+</sect2>
diff --git a/doc/conf/LSauthMethod/LSauthMethod_HTTP.docbook b/doc/conf/LSauthMethod/LSauthMethod_HTTP.docbook
new file mode 100644 (file)
index 0000000..c71468e
--- /dev/null
@@ -0,0 +1,18 @@
+<sect2 id="config-LSauthMethod_HTTP">
+  <title>LSauthMethod_HTTP</title>
+  <para>Cette &LSauthMethod; est utilisée pour gérer l'authentification
+  via les variables d'environnements définies suite à une authentification
+  gérée par le serveur HTTP. En &php;, ces informations sont consultables
+  via les variables <literal>$_SERVER['PHP_AUTH_USER']</literal> et
+  <literal>$_SERVER['PHP_AUTH_PW']</literal>. Cette &LSauthMethod; n'utilise
+  ici que la variable <literal>$_SERVER['PHP_AUTH_USER']</literal>. Si
+  celle-ci est présente, une recherche dans l'annuaire est effectué pour
+  trouver l'utilisateur correspondant. L'authentification réussi uniquement
+  si un et un seul utilisateur est retourné par la recherche.</para>
+  
+  <note><simpara>La recherche est effectuée sur une égalité
+  parfaite du RDN ou en utilisant le &LSformat; de fitre de recherche 
+  <literal>authObjectFilter</literal> défini dans la 
+  <link linkend='config-srv-ldap'>configuration du serveur LDAP</link>
+  </simpara></note>
+</sect2>
index b7e9e37..ae13519 100644 (file)
@@ -18,6 +18,6 @@
 
 &conf-LSobject;
 &conf-LSaddon;
 
 &conf-LSobject;
 &conf-LSaddon;
-&conf-LSauth;
+&conf-LSauthMethod;
 
 </chapter>
 
 </chapter>
index 7e19088..ca7211b 100644 (file)
@@ -10,7 +10,7 @@
 
 <!ENTITY conf-LSaddon SYSTEM "LSaddon.docbook">
 
 
 <!ENTITY conf-LSaddon SYSTEM "LSaddon.docbook">
 
-<!ENTITY conf-LSauth SYSTEM "LSauth.docbook">
+<!ENTITY conf-LSauthMethod SYSTEM "LSauthMethod.docbook">
 
 <!ENTITY conf-LSobject SYSTEM "LSobject.docbook">
 <!ENTITY conf-LSobject-container_auto_create SYSTEM "LSobject/container_auto_create.docbook">
 
 <!ENTITY conf-LSobject SYSTEM "LSobject.docbook">
 <!ENTITY conf-LSobject-container_auto_create SYSTEM "LSobject/container_auto_create.docbook">
index f33b8e2..558edb9 100644 (file)
@@ -85,10 +85,10 @@ serveur LDAP.</para>
 <varlistentry>
   <term>LSauth</term>
   <listitem>
 <varlistentry>
   <term>LSauth</term>
   <listitem>
-    <simpara>Définition de la méthode d'authentification &LSauth;. Pour le
+    <simpara>Définition de la méthode d'authentification &LSauthMethod;. Pour le
     moment ce tableau associatif ne contient qu'un paramètre <parameter>
     method</parameter> qui correpond au nom de la librairie d'authentification.
     moment ce tableau associatif ne contient qu'un paramètre <parameter>
     method</parameter> qui correpond au nom de la librairie d'authentification.
-    Exemple : pour utiliser la classe <literal>LSauthHTTP</literal>, la 
+    Exemple : pour utiliser la classe <literal>LSauthMethod_HTTP</literal>, la
     valeur du paramètre <parameter>method</parameter> sera <literal>HTTP</literal>.
     </simpara>
   </listitem>
     valeur du paramètre <parameter>method</parameter> sera <literal>HTTP</literal>.
     </simpara>
   </listitem>
index e29b509..49dd94d 100644 (file)
@@ -51,7 +51,7 @@
                 <varlistentry>
                   <term><filename>LSauth/</filename></term>
                   <listitem>
                 <varlistentry>
                   <term><filename>LSauth/</filename></term>
                   <listitem>
-                    <simpara>Configuration des &LSauth;.</simpara>
+                    <simpara>Configuration des &LSauthMethod;.</simpara>
                   </listitem>
                 </varlistentry>
                 
                   </listitem>
                 </varlistentry>