Manager: help messages correction
This commit is contained in:
Clément Oudot
parent
37773df261
commit
3d7e43df5e
|
|
@ -564,103 +564,101 @@ toujours en train de l'utiliser.</p>
|
||||||
EOT
|
EOT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
## vars
|
||||||
|
# en
|
||||||
sub help_vars_en {
|
sub help_vars_en {
|
||||||
print <<EOT;
|
print <<EOT;
|
||||||
<h3>Variables (LDAP attributes)</h3>
|
<h3>Exported variables</h3>
|
||||||
<p> Set here the LDAP attributes you need in your configuration or in exported
|
<p>Set here the attributes that will be collected from <tt>userDb</tt></p>
|
||||||
headers.</p>
|
<p>Declare as the following:</p>
|
||||||
<p> Declare as the following :</p>
|
<pre>MyName => real_attribute_name</pre>
|
||||||
<pre> <MyName> => <real LDAP attribute name></pre>
|
<p>Examples:</p>
|
||||||
<p>Examples :</p>
|
|
||||||
<pre>
|
<pre>
|
||||||
uid => uid
|
uid => uid
|
||||||
unit => ou
|
unit => ou
|
||||||
</pre>
|
</pre>
|
||||||
Declared names can be used in rules, groups, macros and HTTP headers by using
|
<p>Declared names can be used in rules, groups, macros and HTTP headers by using
|
||||||
them with '\$'. Example :
|
them with '\$'. Example:
|
||||||
<pre>
|
<pre>
|
||||||
group1 => \$uid eq 'user1' or \$uid eq 'user2'
|
group1 => \$uid eq 'user1' or \$uid eq 'user2'
|
||||||
</pre>
|
</pre>
|
||||||
EOT
|
EOT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# fr
|
||||||
sub help_vars_fr {
|
sub help_vars_fr {
|
||||||
print <<EOT;
|
print <<EOT;
|
||||||
<h3>Variables (attributs LDAP)</h3>
|
<h3>Variables exportées</h3>
|
||||||
<p> Indiquez ici tous les attributs LDAP dont vous avez besoin dans votre
|
<p>Indiquez ici tous les attributs qui seront collectés depuis <tt>userDB</tt></p>
|
||||||
configuration (pour définir les groupes, les macros, les règles
|
<p>La déclaration d'une variable se fait sous la forme :</p>
|
||||||
d'accès aux hôtes virtuels ou encore les en-têtes HTTP).</p>
|
<pre> MonNom => nom_reel_attribute</pre>
|
||||||
<p>La déclaration d'une variable se fait sous la forme :</p>
|
<p>Exemples :</p>
|
||||||
<pre> <nom declare> => <nom de l'attribut LDAP></pre>
|
|
||||||
<p>Exemples :</p>
|
|
||||||
<pre>
|
<pre>
|
||||||
uid => uid
|
uid => uid
|
||||||
unite => ou
|
unite => ou
|
||||||
</pre>
|
</pre>
|
||||||
Les noms déclarés s'utilisent ensuite dans les règles, les
|
<p>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
|
groupes, les macros ou les en-têtes HTTP en les faisant
|
||||||
précéder du signe '\$'. Exemple :
|
précéder du signe '\$'. Exemple :
|
||||||
<pre>
|
<pre>
|
||||||
group1 => \$uid eq 'user1' or \$uid eq 'user2'
|
group1 => \$uid eq 'user1' or \$uid eq 'user2'
|
||||||
</pre>
|
</pre>
|
||||||
EOT
|
EOT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
## virtualHosts
|
||||||
|
# en
|
||||||
sub help_virtualHosts_en {
|
sub help_virtualHosts_en {
|
||||||
print <<EOT;
|
print <<EOT;
|
||||||
<h3>Virtual Hosts</h3>
|
<h3>Virtual Hosts</h3>
|
||||||
|
<p>A virtual host configuration is cutted in 2 pieces: the rules and the
|
||||||
<p> A virtual host configuration is cutted in 2 pieces : the rules and the
|
|
||||||
HTTP headers.</p>
|
HTTP headers.</p>
|
||||||
|
<p class="info">If portal and Handlers are not in the same domain than declared
|
||||||
|
in <tt>General Parameters</tt> menu, active Cross-Domain Authenticatin functionnality.
|
||||||
|
Else, session cookie is not seen by Handlers.
|
||||||
|
|
||||||
<p> <u>Note</u> : If portal and handlers are not in the same domain than declared
|
<h4>Rules</h4>
|
||||||
in "General Parameters" menu, <u>you have to use</u> CDA modules. Else, session
|
<p>A rule associates a regular expression with a perl boolean expression.
|
||||||
cookie is not seen by handlers.
|
|
||||||
|
|
||||||
<h4> Rules </h4>
|
|
||||||
|
|
||||||
<p> 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,
|
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 :</p>
|
access is granted or not depending on the boolean expression result:</p>
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
# Virtual host test.example.com - rules
|
# Virtual host test.example.com - rules
|
||||||
^/protected => \$groups =~ /\\bgroup1\\b/
|
^/protected => \$groups =~ /\\bgroup1\\b/
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<p> This rule means that all URL starting with '/protected', are reserved to
|
<p>This rule means that all URL starting with <tt>/protected</tt> are reserved to
|
||||||
users member of 'group1'. You can also use 'accept', 'deny' and 'unprotect'
|
users member of <tt>group1</tt>. You can also use <tt>accept</tt>, <tt>deny</tt> and <tt>unprotect</tt>
|
||||||
keywords. 'accept' keyword means that all authenticated users are granted,
|
keywords</p>
|
||||||
'unprotect' means that authentication is not required.</p>
|
<ul>
|
||||||
|
<li><tt>accept</tt>: all authenticated users are granted,</li>
|
||||||
|
<li><tt>deny</tt>: no one is granted,</li>
|
||||||
|
<li><tt>unprotect</tt>: authenticaion not required.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
<p> If URL doesn't match any regular expression, 'default' rule is called to
|
<p>If URL doesn't match any regular expression, <tt>default</tt> rule is called to
|
||||||
grant or not.</p>
|
grant or not.</p>
|
||||||
|
|
||||||
<h5> Logout </h5>
|
<h5>Logout</h5>
|
||||||
|
<p>You can also write Logout rules to intercept application logout url using the
|
||||||
You can also write Logout rules to intercept application logout url using the
|
reserved words:</p>
|
||||||
reserved words :
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>logout_sso URL : the request generates a redirection to the portal to call
|
<li><tt>logout_sso URL</tt>: the request generates a redirection to the portal to call
|
||||||
logout mechanism. The request is not given to the application so its logout
|
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,</li>
|
function is not called. After logout, the user is redirected to the URL,</li>
|
||||||
<li>logout_app URL (Apache-2.x only) : the request is transmitted to the
|
<li><tt>logout_app URL</tt> (Apache-2.x only) the request is transmitted to the
|
||||||
application, but the result is not displayed : the user is redirected to the
|
application, but the result is not displayed: the user is redirected to the
|
||||||
URL,</li>
|
URL,</li>
|
||||||
<li>logout_app_sso URL (Apache-2.x only) : the request is transmitted to the
|
<li><tt>logout_app_sso URL</tt> (Apache-2.x only): the request is transmitted to the
|
||||||
application and then, the user is redirected to the portal with the logout
|
application and then, the user is redirected to the portal with the logout
|
||||||
call and then, he is redirected to the given URL.</li>
|
call and then, he is redirected to the given URL.</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h4> Headers </h4>
|
<h4>Headers</h4>
|
||||||
|
<p>Headers are used to inform the remote application on the connected user.
|
||||||
<p> Headers are used to inform the remote application on the connected user.
|
They are declared as:</p>
|
||||||
They are declared as :
|
<pre><Header Name> => <Perl expression>.</pre>
|
||||||
<tt><Header Name> => <Perl expression>.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p> Examples :</p>
|
|
||||||
|
|
||||||
|
<p>Examples:</p>
|
||||||
<pre>
|
<pre>
|
||||||
Auth-User => \$uid
|
Auth-User => \$uid
|
||||||
Unite => \$departmentUID
|
Unite => \$departmentUID
|
||||||
|
|
@ -668,72 +666,70 @@ They are declared as :
|
||||||
EOT
|
EOT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# fr
|
||||||
sub help_virtualHosts_fr {
|
sub help_virtualHosts_fr {
|
||||||
print <<EOT;
|
print <<EOT;
|
||||||
<h3>Hôtes virtuels</h3>
|
<h3>Hôtes virtuels</h3>
|
||||||
|
|
||||||
<p> La configuration d'un hôte virtuel est divisée en 2
|
<p> La configuration d'un hôte virtuel est divisée en 2
|
||||||
parties : les règles et les en-têtes HTTP exportés.</p>
|
parties : les règles et les en-têtes HTTP.</p>
|
||||||
|
|
||||||
<p> <u>Note</u> : pour que le mécanisme d'authentification fonctionne,
|
<p class="info"> Pour que le mécanisme d'authentification fonctionne,
|
||||||
tous les hôtes virtuels et le portail doivent se trouver dans le domaine
|
tous les hôtes virtuels et le portail doivent se trouver dans le domaine
|
||||||
déclaré dans les paramètres généraux ou
|
déclaré dans les paramètres généraux ou alors il faut activer la fonction
|
||||||
<u>utiliser les modules CDA</u> <i>(Cross-Domain-Authentication)</i> qui
|
Cross-Domain-Authentication.</p>
|
||||||
gère la transmission de l'identifiant.</p>
|
|
||||||
|
|
||||||
<h4> Règles</h4>
|
<h4>Règles</h4>
|
||||||
|
<p>Une règle associe une expression régulière perl
|
||||||
<p>Une règle associe une expression régulière perl
|
à une expression booléenne. Lors de l'accès d'un
|
||||||
à une expression booléenne. Lors de l'accès d'un
|
utilisateur, si l'URL demandée correspond à la règle, le
|
||||||
utilisateur, si l'URL demandée correspond à la règle, le
|
droit d'accès est calculé par l'expression booléenne.
|
||||||
droit d'accès est calculé par l'expression booléenne.
|
|
||||||
Exemple :</p>
|
Exemple :</p>
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
# Hôte virtuel test.example.com - règles
|
# Hôte virtuel test.example.com - règles
|
||||||
^/protected => \$groups =~ /\\bgroup1\\b/
|
^/protected => \$groups =~ /\\bgroup1\\b/
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
<p> La règle ci-dessus signifie que pour les URL commençant par
|
<p>La règle ci-dessus signifie que pour les URL commençant par
|
||||||
'/protected', les utilisateurs doivent appartenir au groupe 'group1'. Vous
|
<tt>/protected</tt>, les utilisateurs doivent appartenir au groupe <tt>group1</tt>.
|
||||||
pouvez également utiliser les mots-clefs 'accept', 'deny' et
|
Vous pouvez également utiliser les mots-clefs <tt>accept</tt>, <tt>deny</tt> et
|
||||||
'unprotect'. Attention, 'accept' signifie que tous les utilisateurs
|
<tt>unprotect</tt>:</p>
|
||||||
authentifiés peuvent accéder, 'unprotect' signifie que
|
|
||||||
l'authentification n'est pas obligatoire.</p>
|
|
||||||
|
|
||||||
<p>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).</p>
|
|
||||||
|
|
||||||
<h5> Logout </h5>
|
|
||||||
|
|
||||||
Vous pouvez également écrire des règles pour intercepter
|
|
||||||
les URL de déconnexions des applications en utilisant les
|
|
||||||
mots-clefs :
|
|
||||||
<ul>
|
<ul>
|
||||||
<li>logout_sso URL : la requête entraine une redirection vers le portail
|
<li><tt>accept</tt>: tous les utilisateurs authentifiés peuvent accéder,</li>
|
||||||
avec l'appel au système de déloguage. La requête n'est
|
<li><tt>deny</tt>: personne ne peut accéder,</li>
|
||||||
pas transmise à l'applicationthe. Après déloguage,
|
<li><tt>unprotect</tt>: l'authentification n'est pas obligatoire.</li>
|
||||||
l'utilisateur est renvoyé vers l'URL,</li>
|
|
||||||
<li>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,</li>
|
|
||||||
<li>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.</li>
|
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
<h4> En-têtes</h4>
|
<p>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 (<tt>default</tt>).</p>
|
||||||
|
|
||||||
<p> Les en-têtes servant à l'application à savoir qui est
|
<h5>Déconnexion</h5>
|
||||||
connecté se déclarent comme suit : <tt><nom de
|
Vous pouvez également écrire des règles pour intercepter
|
||||||
l'en-tête> => <expression Perl>.
|
les URL de déconnexions des applications en utilisant les
|
||||||
</p>
|
mots-clefs :
|
||||||
|
<ul>
|
||||||
|
<li><tt>logout_sso URL</tt> : 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,</li>
|
||||||
|
<li><tt>logout_app URL</tt> (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,</li>
|
||||||
|
<li><tt>logout_app_sso URL</tt> (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.</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
<p> Exemples :</p>
|
<h4>En-têtes</h4>
|
||||||
|
|
||||||
|
<p>Les en-têtes permettant à l'application de savoir qui est
|
||||||
|
connecté se déclarent comme suit :</p>
|
||||||
|
<pre><nom de l'en-tête> => <expression Perl>.</pre>
|
||||||
|
|
||||||
|
<p>Exemples :</p>
|
||||||
<pre>
|
<pre>
|
||||||
Auth-User => \$uid
|
Auth-User => \$uid
|
||||||
Unite => \$departmentUID
|
Unite => \$departmentUID
|
||||||
|
|
@ -741,22 +737,27 @@ l'en-tête> => <expression Perl>.
|
||||||
EOT
|
EOT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
## whatToTrace
|
||||||
|
# en
|
||||||
sub help_whatToTrace_en {
|
sub help_whatToTrace_en {
|
||||||
print <<EOT;
|
print <<EOT;
|
||||||
<h3>What to log in Apache</h3>
|
<h3>User name in Apache</h3>
|
||||||
<p> Set here le name of the variable (attribute) or macro that has to be used
|
<p>Set here the name of the variable (attribute) or macro that has to be used
|
||||||
in proected application Apache logs (don't forget "\$"). By default :
|
in protected application Apache logs (don't forget "\$").</p>
|
||||||
\$uid</p>
|
<p class="info">This value will be pushed in <tt>REMOTE_USER</tt> environment variable.</p>
|
||||||
|
<p class="default">Default value: \$uid</p>
|
||||||
EOT
|
EOT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# fr
|
||||||
sub help_whatToTrace_fr {
|
sub help_whatToTrace_fr {
|
||||||
print <<EOT;
|
print <<EOT;
|
||||||
<h3>Donnée à journaliser dans Apache</h3>
|
<h3>Nom de l'utilisateur dans Apache</h3>
|
||||||
<p> Indiquez ici le nom de la variable (attribut) ou de la macro qui doit
|
<p>Indiquez ici le nom de la variable (attribut) ou de la macro qui doit
|
||||||
être utilisée pour alimenter les journaux Apache des applications
|
être utilisée pour alimenter les journaux Apache des applications
|
||||||
protégées (n'oubliez pas le "\$"). Par défaut :
|
protégées (n'oubliez pas le "\$").</p>
|
||||||
\$uid</p>
|
<p class="info">Cette valeur sera inscrite dans la variable d'environnement <tt>REMOTE_USER</tt>.</p>
|
||||||
|
<p class="default">Valeur par défaut : \$uid</p>
|
||||||
EOT
|
EOT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -793,6 +794,8 @@ sub help_default_en {
|
||||||
<li>General parameters</li>
|
<li>General parameters</li>
|
||||||
<li>Variables</li>
|
<li>Variables</li>
|
||||||
<li>Virtual hosts</li>
|
<li>Virtual hosts</li>
|
||||||
|
<li>SAML2 service</li>
|
||||||
|
<li>SAML2 identity providers</li>
|
||||||
</ul>
|
</ul>
|
||||||
</p>
|
</p>
|
||||||
<p>Select a category to display parameters and sub categories.</p>
|
<p>Select a category to display parameters and sub categories.</p>
|
||||||
|
|
@ -810,6 +813,8 @@ sub help_default_fr {
|
||||||
<li>Paramètres généraux</li>
|
<li>Paramètres généraux</li>
|
||||||
<li>Variables</li>
|
<li>Variables</li>
|
||||||
<li>Hôtes virtuels</li>
|
<li>Hôtes virtuels</li>
|
||||||
|
<li>Service SAML2</li>
|
||||||
|
<li>Fournisseurs d'identité SAML2</li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>Chosir une catégorie pour afficher les paramètres et sous catégories.</p>
|
<p>Chosir une catégorie pour afficher les paramètres et sous catégories.</p>
|
||||||
<p>Cliquer sur le bouton <tt>Sauvegarder</tt> pour enregistrer les modifications.</p>
|
<p>Cliquer sur le bouton <tt>Sauvegarder</tt> pour enregistrer les modifications.</p>
|
||||||
|
|
@ -867,7 +872,7 @@ EOT
|
||||||
sub help_samlServicePrivateKey_en {
|
sub help_samlServicePrivateKey_en {
|
||||||
print <<EOT;
|
print <<EOT;
|
||||||
<h3>SAML service private key</h3>
|
<h3>SAML service private key</h3>
|
||||||
<p>Paste here the service private key in PEM format, with header and footer.</p>
|
<p>Load here the service private key in PEM format.</p>
|
||||||
<p>Example:</p>
|
<p>Example:</p>
|
||||||
<pre>
|
<pre>
|
||||||
-----BEGIN RSA PRIVATE KEY-----
|
-----BEGIN RSA PRIVATE KEY-----
|
||||||
|
|
@ -880,7 +885,7 @@ yJcaxZIi68VekQIgUTljUcS4HwLkn4jBhIq4gg21humTvKai3GYUszm+PZUCIDnR
|
||||||
X1EobS0/HFKASpX7GG4VTi9Rbd5jWbM5ZfSlCjLJ
|
X1EobS0/HFKASpX7GG4VTi9Rbd5jWbM5ZfSlCjLJ
|
||||||
-----END RSA PRIVATE KEY-----
|
-----END RSA PRIVATE KEY-----
|
||||||
</pre>
|
</pre>
|
||||||
<p class="info">The corresponding public key or certificate must be set inside SAML service metadata.</p>
|
<p class="info">The corresponding public key or certificate must be loaded inside SAML service metadata.</p>
|
||||||
EOT
|
EOT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -888,7 +893,7 @@ EOT
|
||||||
sub help_samlServicePrivateKey_fr {
|
sub help_samlServicePrivateKey_fr {
|
||||||
print <<EOT;
|
print <<EOT;
|
||||||
<h3>Clé privée du service SAML</h3>
|
<h3>Clé privée du service SAML</h3>
|
||||||
<p>Coller ici la clé privé du service au format PEM, en consevant l'en-tête et le pied.</p>
|
<p>Charger ici la clé privé du service au format PEM.</p>
|
||||||
<p>Exemple :</p>
|
<p>Exemple :</p>
|
||||||
<pre>
|
<pre>
|
||||||
-----BEGIN RSA PRIVATE KEY-----
|
-----BEGIN RSA PRIVATE KEY-----
|
||||||
|
|
@ -901,7 +906,7 @@ yJcaxZIi68VekQIgUTljUcS4HwLkn4jBhIq4gg21humTvKai3GYUszm+PZUCIDnR
|
||||||
X1EobS0/HFKASpX7GG4VTi9Rbd5jWbM5ZfSlCjLJ
|
X1EobS0/HFKASpX7GG4VTi9Rbd5jWbM5ZfSlCjLJ
|
||||||
-----END RSA PRIVATE KEY-----
|
-----END RSA PRIVATE KEY-----
|
||||||
</pre>
|
</pre>
|
||||||
<p class="info">La clé publique ou le certificat correspondant doit être défini dans les metadonnées du service.</p>
|
<p class="info">La clé publique ou le certificat correspondant doit être chargé dans les metadonnées du service.</p>
|
||||||
EOT
|
EOT
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -485,7 +485,7 @@ sub struct {
|
||||||
virtualHosts => {
|
virtualHosts => {
|
||||||
_nodes => ['nhash:/locationRules:virtualHosts:vhost'],
|
_nodes => ['nhash:/locationRules:virtualHosts:vhost'],
|
||||||
_upload => ['/exportedHeaders'],
|
_upload => ['/exportedHeaders'],
|
||||||
_help => 'default',
|
_help => 'virtualHosts',
|
||||||
_js => 'vhostRoot',
|
_js => 'vhostRoot',
|
||||||
},
|
},
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user