From 3d7e43df5e39027c77023431f0a233b27367a38f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Oudot?= Date: Mon, 22 Mar 2010 10:38:37 +0000 Subject: [PATCH] Manager: help messages correction --- .../lib/Lemonldap/NG/Manager/Help.pm | 231 +++++++++--------- .../lib/Lemonldap/NG/Manager/_Struct.pm | 2 +- 2 files changed, 119 insertions(+), 114 deletions(-) diff --git a/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/Help.pm b/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/Help.pm index 446523ef5..0e523633b 100644 --- a/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/Help.pm +++ b/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/Help.pm @@ -564,103 +564,101 @@ toujours en train de l'utiliser.

EOT } +## vars +# en sub help_vars_en { print <Variables (LDAP attributes) -

Set here the LDAP attributes you need in your configuration or in exported -headers.

-

Declare as the following :

-
  <MyName> => <real LDAP attribute name>
-

Examples :

+

Exported variables

+

Set here the attributes that will be collected from userDb

+

Declare as the following:

+
MyName => real_attribute_name
+

Examples:

   uid   => uid
   unit  => ou
-Declared names can be used in rules, groups, macros and HTTP headers by using -them with '\$'. Example : +

Declared names can be used in rules, groups, macros and HTTP headers by using +them with '\$'. Example: 

   group1 => \$uid eq 'user1' or \$uid eq 'user2'
EOT } +# fr sub help_vars_fr { print <Variables (attributs LDAP) -

Indiquez ici tous les attributs LDAP dont vous avez besoin dans votre -configuration (pour définir les groupes, les macros, les règles -d'accès aux hôtes virtuels ou encore les en-têtes HTTP).

-

La déclaration d'une variable se fait sous la forme :

-
  <nom declare> => <nom de l'attribut LDAP>
-

Exemples :

+

Variables exportées

+

Indiquez ici tous les attributs qui seront collectés depuis userDB

+

La déclaration d'une variable se fait sous la forme :

+
  MonNom => nom_reel_attribute
+

Exemples :

   uid  => uid
   unite  => ou
-Les noms déclarés s'utilisent ensuite dans les règles, les -groupes, les macros ou les en-têtes HTTP en les faisant -précéder du signe '\$'. Exemple : +

Les noms déclarés s'utilisent ensuite dans les règles, les +groupes, les macros ou les en-têtes HTTP en les faisant +précéder du signe '\$'. Exemple : 

   group1 => \$uid eq 'user1' or \$uid eq 'user2'
EOT } +## virtualHosts +# en sub help_virtualHosts_en { print <Virtual Hosts - -

A virtual host configuration is cutted in 2 pieces : the rules and the +

A virtual host configuration is cutted in 2 pieces: the rules and the HTTP headers.

+

If portal and Handlers are not in the same domain than declared +in General Parameters menu, active Cross-Domain Authenticatin functionnality. +Else, session cookie is not seen by Handlers. -

Note : If portal and handlers are not in the same domain than declared -in "General Parameters" menu, you have to use CDA modules. Else, session -cookie is not seen by handlers. - -

Rules

- -

A rule associates a regular expression with a perl boolean expression. +

Rules

+

A rule associates a regular expression with a perl boolean expression. When a user tries to access to an URL that match with the regular expression, -access is granted or not depending on the boolean expression result :

- +access is granted or not depending on the boolean expression result:

   # Virtual host test.example.com - rules
   ^/protected => \$groups =~ /\\bgroup1\\b/
-

This rule means that all URL starting with '/protected', are reserved to -users member of 'group1'. You can also use 'accept', 'deny' and 'unprotect' -keywords. 'accept' keyword means that all authenticated users are granted, -'unprotect' means that authentication is not required.

+

This rule means that all URL starting with /protected are reserved to +users member of group1. You can also use accept, deny and unprotect +keywords

+
    +
  • accept: all authenticated users are granted,
    • +
  • deny: no one is granted,
    • +
  • unprotect: authenticaion not required.
    • +
-

If URL doesn't match any regular expression, 'default' rule is called to +

If URL doesn't match any regular expression, default rule is called to grant or not.

-
Logout
- -You can also write Logout rules to intercept application logout url using the -reserved words : +
Logout
+

You can also write Logout rules to intercept application logout url using the +reserved words:

    -
  • logout_sso URL : the request generates a redirection to the portal to call +
  • logout_sso URL: the request generates a redirection to the portal to call logout mechanism. The request is not given to the application so its logout function is not called. After logout, the user is redirected to the URL,
    • -
  • logout_app URL (Apache-2.x only) : the request is transmitted to the - application, but the result is not displayed : the user is redirected to the +
  • logout_app URL (Apache-2.x only) the request is transmitted to the + application, but the result is not displayed: the user is redirected to the URL,
    • -
  • logout_app_sso URL (Apache-2.x only) : the request is transmitted to the +
  • logout_app_sso URL (Apache-2.x only): the request is transmitted to the application and then, the user is redirected to the portal with the logout call and then, he is redirected to the given URL.
-

Headers

- -

Headers are used to inform the remote application on the connected user. -They are declared as : -<Header Name> => <Perl expression>. -

- -

Examples :

+

Headers

+

Headers are used to inform the remote application on the connected user. +They are declared as:

+
<Header Name> => <Perl expression>.
+

Examples:

   Auth-User => \$uid
   Unite     => \$departmentUID
@@ -668,72 +666,70 @@ They are declared as :
 EOT
 }
 
+# fr
 sub help_virtualHosts_fr {
     print <Hôtes virtuels
+
Hôtes virtuels

 
-
 La configuration d'un hôte virtuel est divisée en 2
-parties : les règles et les en-têtes HTTP exportés.

+
 La configuration d'un hôte virtuel est divisée en 2
+parties : les règles et les en-têtes HTTP.

 
-
 Note : pour que le mécanisme d'authentification fonctionne,
-tous les hôtes virtuels et le portail doivent se trouver dans le domaine
-déclaré dans les paramètres généraux ou
-utiliser les modules CDA (Cross-Domain-Authentication) qui
-gère la transmission de l'identifiant.

+
 Pour que le mécanisme d'authentification fonctionne,
+tous les hôtes virtuels et le portail doivent se trouver dans le domaine
+déclaré dans les paramètres généraux ou alors il faut activer la fonction
+Cross-Domain-Authentication.

 
-
 Règles

-
-
Une règle associe une expression régulière perl
-à une expression booléenne. Lors de l'accès d'un
-utilisateur, si l'URL demandée correspond à la règle, le
-droit d'accès est calculé par l'expression booléenne.
+
Règles

+
Une règle associe une expression régulière perl
+à une expression booléenne. Lors de l'accès d'un
+utilisateur, si l'URL demandée correspond à la règle, le
+droit d'accès est calculé par l'expression booléenne.
 Exemple :

-
 
-  # Hôte virtuel test.example.com - règles
+  # Hôte virtuel test.example.com - règles
   ^/protected => \$groups =~ /\\bgroup1\\b/
 

 
-
 La règle ci-dessus signifie que pour les URL commençant par
-'/protected', les utilisateurs doivent appartenir au groupe 'group1'. Vous
-pouvez également utiliser les mots-clefs 'accept', 'deny' et
-'unprotect'. Attention, 'accept' signifie que tous les utilisateurs
-authentifiés peuvent accéder, 'unprotect' signifie que
-l'authentification n'est pas obligatoire.

-
-
Si l'URL demandée ne correspond à aucune des expressions
-régulières, le droit d'accès est calculé à
-partir de l'expression booléenne définie dans la règle par
-défaut (default).

-
-
 Logout 

-
-Vous pouvez également écrire des règles pour intercepter
-les URL de déconnexions des applications en utilisant les
-mots-clefs :
+
La règle ci-dessus signifie que pour les URL commençant par
+/protected, les utilisateurs doivent appartenir au groupe group1.
+Vous pouvez également utiliser les mots-clefs accept, deny et
+unprotect:

 
    
- 
  • logout_sso URL : la requête entraine une redirection vers le portail
-  avec l'appel au système de déloguage. La requête n'est
-  pas transmise à l'applicationthe. Après déloguage,
-  l'utilisateur est renvoyé vers l'URL,
    • 
- 
  • logout_app URL (Apache-2.x seulement) : la requête est transmise
-  à l'applications mais le résultat n'est pas
-  affiché : l'utilisateur est redirigé vers l'URL,
    • 
- 
  • logout_app_sso URL (Apache-2.x seulement) : la requête est transmise
-  à l'application et ensuite, l'utilisateur est redirigé vers le
-  portail avec appel au système de déloguage. Il est ensuite
-  redirigé vers l'URL.
    • 
+ 
  • accept: tous les utilisateurs authentifiés peuvent accéder,
    • 
+ 
  • deny: personne ne peut accéder,
    • 
+ 
  • unprotect: l'authentification n'est pas obligatoire.
    • 
 

 
-
 En-têtes

+
Si l'URL demandée ne correspond à aucune des expressions
+régulières, le droit d'accès est calculé à
+partir de l'expression booléenne définie dans la règle par
+défaut (default).

 
-
 Les en-têtes servant à l'application à savoir qui est
-connecté se déclarent comme suit : <nom de
-l'en-tête> => <expression Perl>.
-

+
Déconnexion

+Vous pouvez également écrire des règles pour intercepter
+les URL de déconnexions des applications en utilisant les
+mots-clefs :
+
    
+ 
  • logout_sso URL : la requête entraîne une redirection vers le portail
+  avec l'appel au système de déconnexion. La requête n'est
+  pas transmise à l'application. Après déconnexion,
+  l'utilisateur est renvoyé vers l'URL,
    • 
+ 
  • logout_app URL (Apache-2.x seulement) : la requête est transmise
+  à l'applications mais le résultat n'est pas
+  affiché : l'utilisateur est redirigé vers l'URL,
    • 
+ 
  • logout_app_sso URL (Apache-2.x seulement) : la requête est transmise
+  à l'application et ensuite, l'utilisateur est redirigé vers le
+  portail avec appel au système de déconnexion. Il est ensuite
+  redirigé vers l'URL.
    • 
+

 
-
 Exemples :

+
En-têtes

 
+
Les en-têtes permettant à l'application de savoir qui est
+connecté se déclarent comme suit :

+
<nom de l'en-tête> => <expression Perl>.

+
+
Exemples :

 
   Auth-User => \$uid
   Unite     => \$departmentUID
@@ -741,22 +737,27 @@ l'en-tête> => <expression Perl>.
 EOT
 }
 
+## whatToTrace
+# en
 sub help_whatToTrace_en {
     print <What to log in Apache
-
 Set here le name of the variable (attribute) or macro that has to be used
-in proected application Apache logs (don't forget "\$"). By default :
-\$uid

+
User name in Apache

+
Set here the name of the variable (attribute) or macro that has to be used
+in protected application Apache logs (don't forget "\$").

+
This value will be pushed in REMOTE_USER environment variable.

+
Default value: \$uid

 EOT
 }
 
+# fr
 sub help_whatToTrace_fr {
     print <Donnée à journaliser dans Apache
-
 Indiquez ici le nom de la variable (attribut) ou de la macro qui doit
-être utilisée pour alimenter les journaux Apache des applications
-protégées (n'oubliez pas le "\$"). Par défaut :
-\$uid

+
Nom de l'utilisateur dans Apache

+
Indiquez ici le nom de la variable (attribut) ou de la macro qui doit
+être utilisée pour alimenter les journaux Apache des applications
+protégées (n'oubliez pas le "\$").

+
Cette valeur sera inscrite dans la variable d'environnement REMOTE_USER.

+
Valeur par défaut : \$uid

 EOT
 }
 
@@ -793,6 +794,8 @@ sub help_default_en {
 
  • General parameters
    • 
 
  • Variables
    • 
 
  • Virtual hosts
    • 
+
  • SAML2 service
    • 
+
  • SAML2 identity providers
    • 
 
 
    
 
    Select a category to display parameters and sub categories.
    
@@ -810,6 +813,8 @@ sub help_default_fr {
 
  • Paramètres généraux
    • 
 
  • Variables
    • 
 
  • Hôtes virtuels
    • 
+
  • Service SAML2
    • 
+
  • Fournisseurs d'identité SAML2
    • 
 
 
    Chosir une catégorie pour afficher les paramètres et sous catégories.
    
 
    Cliquer sur le bouton Sauvegarder pour enregistrer les modifications.
    
@@ -867,7 +872,7 @@ EOT
 sub help_samlServicePrivateKey_en {
     print <SAML service private key
-
    Paste here the service private key in PEM format, with header and footer.
    
+
    Load here the service private key in PEM format.
    
 
    Example:
    
 
     -----BEGIN RSA PRIVATE KEY-----
@@ -880,7 +885,7 @@ yJcaxZIi68VekQIgUTljUcS4HwLkn4jBhIq4gg21humTvKai3GYUszm+PZUCIDnR
 X1EobS0/HFKASpX7GG4VTi9Rbd5jWbM5ZfSlCjLJ
 -----END RSA PRIVATE KEY-----
 
    
-
    The corresponding public key or certificate must be set inside SAML service metadata.
    
+
    The corresponding public key or certificate must be loaded inside SAML service metadata.
    
 EOT
 }
 
@@ -888,7 +893,7 @@ EOT
 sub help_samlServicePrivateKey_fr {
     print <Clé privée du service SAML
-
    Coller ici la clé privé du service au format PEM, en consevant l'en-tête et le pied.
    
+
    Charger ici la clé privé du service au format PEM.
    
 
    Exemple :
    
 
     -----BEGIN RSA PRIVATE KEY-----
@@ -901,7 +906,7 @@ yJcaxZIi68VekQIgUTljUcS4HwLkn4jBhIq4gg21humTvKai3GYUszm+PZUCIDnR
 X1EobS0/HFKASpX7GG4VTi9Rbd5jWbM5ZfSlCjLJ
 -----END RSA PRIVATE KEY-----
 
    
-
    La clé publique ou le certificat correspondant doit être défini dans les metadonnées du service.
    
+
    La clé publique ou le certificat correspondant doit être chargé dans les metadonnées du service.
    
 EOT
 }
 
diff --git a/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/_Struct.pm b/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/_Struct.pm
index 09cbe119b..46c5e6ed1 100644
--- a/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/_Struct.pm
+++ b/modules/lemonldap-ng-manager/lib/Lemonldap/NG/Manager/_Struct.pm
@@ -485,7 +485,7 @@ sub struct {
         virtualHosts => {
             _nodes  => ['nhash:/locationRules:virtualHosts:vhost'],
             _upload => ['/exportedHeaders'],
-            _help   => 'default',
+            _help   => 'virtualHosts',
             _js     => 'vhostRoot',
         },