Vue d'ensemble de la configuration

Backends

La configuration de LemonLDAP::NG est stockée dans un backend permettant à tous les modules d'y accéder.

Tous les composants de LL::NG doivent avoir accès :

au système de stockage de la configuration
au système de stockage des sessions

La configuration détaillée des backends de stockage est disponible ici.

Par défaut, la configuration est stockée dans des fichiers, donc l'accès par le réseau n'est en général pas possible. Pour contourner ce problème, utiliser SOAP pour l'accès à la configuration ou un service réseau tel une base de donnée SQL ou un annuaire LDAP.

Le backend de configuration peut être indiqué dans le fichier local de configuration, dans la section configuration.

Par exemple, pour configurer le backend de configuration File :

[configuration]
type=File
dirName = /usr/local/lemonldap-ng/data/conf

Voir Comment changer le backend de configuration.

Manager

La majeure partie de la configuration peut être réalisée via le manager LemonLDAP::NG (par défaut http://manager.example.com).

Par défaut, le manager est protégé et n'autorise que l'utilisateur de démonstration “dwho”.

Cet utilisateur n'est plus disponible si on change de backend d'authentification ! Ne pas oublier de changer la règle d'accès à l'hôte virtuel du manager pour autoriser les nouveaux administrateurs.

SI l'accès au manager est perdu, on peut le déprotéger en éditant lemonldap-ng.in et en changeant le paramètre protection :

[manager]
 
# Manager protection: by default, the manager is protected by a demo account.
# You can protect it :
# * by Apache itself,
# * by the parameter 'protection' which can take one of the following
# values :
#   * authenticate : all authenticated users can access
#   * manager      : manager is protected like other virtual hosts: you
#                    have to set rules in the corresponding virtual host
#   * rule: <rule> : you can set here directly the rule to apply
#   * none         : no protection

Voir la documentation de protection du manager pour savoir comment utiliser les modules d'Apache ou LL::NG pour gérer l'accès au manager.

Le manager affiche des branches principales :

General Parameters: 1uthentication modules, portal, etc.
Variables: User information, macros and groups used to fill SSO session
Virtual Hosts: Access rules, headers, etc.
Service SAML : administration des métadonnées SAML
Fournisseurs d'identité SAML : IDP enregistrés
Fournisseurs de service SAML : SP enregistrés
OpenID Connect Service: OpenID Connect service configuration
OpenID Connect Providers: Registered OP
OpenID Connect Relying Parties: Registered RP

La configuration de LemonLDAP::NG est essentiellement une structure clef/valeur, ainsi le manager présente toutes les clefs en un arbre structuré. Un click sur la clef affiche la valeur associée.

Lorsque toutes les modifications sont effectuées, cliquer sur Sauver pour enregistrer la configuration.

LemonLDAP::NG effectue ensuite quelques tests sur la configuration et affiche les éventuelles erreurs et avertissements. La configuration n'est pas sauvée en cas d'erreur.

Éditeur de configuration en mode text

LemonLDAP::NG fournit un script qui permet d'éditer la configuration sans interface graphique, ce script se nomme lmConfigEditor et se trouvedans le répertoire bin/ de LemonLDAP::NG, par exemple /usr/share/lemonldap-ng/bin :

/usr/share/lemonldap-ng/bin/lmConfigEditor

Ce script doit être lancé par root, il utilisera ensuite le compte et le groupe d'Apache pour accéder à la configuration.

Ce script utilise la commande système editor, qui est liée à l'éditeur favori. Pour le changer :

update-alternatives --config editor

The configuration is displayed as a big Perl Hash, that you can edit:

$VAR1 = {
          'ldapAuthnLevel' => '2',
          'notificationWildcard' => 'allusers',
          'loginHistoryEnabled' => '1',
          'key' => 'q`e)kJE%<&wm>uaA',
          'samlIDPSSODescriptorSingleSignOnServiceHTTPPost' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST;#PORTAL#/saml/singleSignOn;',
          'portalSkin' => 'pastel',
          'failedLoginNumber' => '5',
          ...
          };

Si une modification est effectuée, la configuration est sauvée avec un nouveau numéro. Sinon, la configuration courante est gardée.

Interface en ligne de commande (CLI)

LemonLDAP::NG fournit un script qui autorise l'édition d'éléments de configuration en mode non-interactif. Ce script se nomme lemonldap-ng-cli et se trouve dans le répertoire bin/ de LemonLDAP::NG, par exemple /usr/share/lemonldap-ng/bin:

/usr/share/lemonldap-ng/bin/lemonldap-ng-cli

Ce script doit être lancé par root, il utilisera ensuite le compte et le groupe d'Apache pour accéder à la configuration.

Pour connaître les actions possibles, lancer :

/usr/share/lemonldap-ng/bin/lemonldap-ng-cli help

By default, when you change a value, it will be written to configuration backend but:

Configuration cache is not updated
Configuration number is not incremented

This allows to modify configuration without impacting running users.

You can force an update of the cache with:

/usr/share/lemonldap-ng/bin/lemonldap-ng-cli update-cache

And you can save current configuration into a new one:

/usr/share/lemonldap-ng/bin/lemonldap-ng-cli increment

To get information abour current configuration:

/usr/share/lemonldap-ng/bin/lemonldap-ng-cli info

Apache

LemonLDAP::NG ne gère pas la configuration d'Apache

LemonLDAP::NG fournit 3 fichiers de configuration Apache :

portal-apache2.conf: Portal virtual host, with SOAP and Issuer end points
manager-apache2.conf : hôte virtuel du manager
handler-apache2.conf : déclaration du handler, rechargement et exemple d'hôte virtuel

Ces fichiers doivent être inclus dans la configuration d'Apache, soit par des directives Include dans le fichier httpd.conf (voir démarrage rapide), ou via un lien symbolique dans de répertoire de configuration d'Apache (type /etc/httpd/conf.d).

Mod Perl must be loaded before LemonLDAP::NG, so include configuration after the mod_perl LoadModule directive.

Portail

Dans l'hôte virtuel du portail se trouve plusieurs éléments de configuration :

Directives standard d'hôte virtuel pour servir les pages du portail :

    ServerName auth.example.com
 
    # DocumentRoot
    DocumentRoot /usr/local/lemonldap-ng/htdocs/portal/
    <Directory /usr/local/lemonldap-ng/htdocs/portal/>
        Order allow,deny
        Allow from all
        Options +ExecCGI
    </Directory>
 
    # Perl script
    <Files *.pl>
        SetHandler perl-script
        PerlResponseHandler ModPerl::Registry
    </Files>
 
    # Directory index
    <IfModule mod_dir.c>
        DirectoryIndex index.pl index.html
    </IfModule>

SOAP end points (inactivated by default):

    # Gestion des fonctions SOAP functions pour la gestion des sessions (désactivée par défaut)
    <Location /index.pl/adminSessions>
        Order deny,allow
        Deny from all
    </Location>
 
    # Fonctions SOAP pour l'accès aux sessions (désactivées par défaut)
    <Location /index.pl/sessions>
        Order deny,allow
        Deny from all
    </Location>
 
    # Fonctions SOAP pour accéder à la configuration (désactivées par défaut)
    <Location /index.pl/config>
        Order deny,allow
        Deny from all
    </Location>
 
    # Fonctions SOAP pour insérer des notifications (désactivées par défaut)
    <Location /index.pl/notification>
        Order deny,allow
        Deny from all
    </Location>

Règles de réécriture pour la fourniture d'identité (requiert mod_rewrite):

    # Fournisseur d'identité SAML2
    <IfModule mod_rewrite.c>
        RewriteEngine On
        RewriteRule ^/saml/metadata /metadata.pl
        RewriteRule ^/saml/.* /index.pl
    </IfModule>
 
    # Fournisseur d'identité CAS
    <IfModule mod_rewrite.c>
        RewriteEngine On
        RewriteRule ^/cas/.* /index.pl
    </IfModule>
 
    # Fournisseur d'identité OpenID
    <IfModule mod_rewrite.c>
        RewriteEngine On
        RewriteRule ^/openidserver/.* /index.pl
    </IfModule>
 
    # OpenID Connect Issuer
    <IfModule mod_rewrite.c>
        RewriteEngine On
        RewriteRule ^/oauth2/.* /index.pl
        RewriteRule ^/.well-known/openid-configuration$ /openid-configuration.pl
    </IfModule>

Some Perl optimizations:

# Meilleures performances sous ModPerl::Registry
# A décommenter pour augmenter les performances du portail
<Perl>
    require Lemonldap::NG::Portal::SharedConf;
    Lemonldap::NG::Portal::SharedConf->compile(
        qw(delete header cache read_from_client cookie redirect unescapeHTML));
    # Décommenter cette ligne si le menu Lemonldap::NG est utilisé
    require Lemonldap::NG::Portal::Menu;
    # Décommenter cette ligne si les fonctions SOAP du portail sont utilisées
    require SOAP::Lite;
</Perl>

Manager

L'hôte virtuel du manager est utilisé pour servir l'interface de configuration et la documentation locale. It is run as a FastCGI application:

    # FASTCGI CONFIGURATION
    # ---------------------
 
    # 1) URI management
    RewriteEngine on
 
    RewriteRule "^/$" "/psgi/manager-server.fcgi" [PT]
    # For performances, you can delete the previous RewriteRule line after
    # puttings html files: simply put the HTML results of differents modules
    # (configuration, sessions, notifications) as manager.html, sessions.html,
    # notifications.html and uncomment the 2 following lines:
    # DirectoryIndex manager.html
    # RewriteCond "%{REQUEST_FILENAME}" "!\.html$"
 
    # REST URLs
    RewriteCond "%{REQUEST_FILENAME}" "!^/(?:static|doc|fr-doc|lib).*"
    RewriteRule "^/(.+)$" "/psgi/manager-server.fcgi/$1" [PT]
 
    Alias /psgi/ /var/lib/lemonldap-ng/manager/psgi/
 
    # 2) FastCGI engine
 
    # You can choose any FastCGI system. Here is an example using mod_fcgid
    # mod_fcgid configuration
    <Directory /var/lib/lemonldap-ng/manager/psgi/>
        SetHandler fcgid-script
        Options +ExecCGI
    </Directory>
 
    # If you want to use mod_fastcgi, replace lines below by:
    #FastCgiServer /var/lib/lemonldap-ng/manager/psgi/manager-server.fcgi
 
    # Or if you prefer to use CGI, use /psgi/manager-server.cgi instead of
    # /psgi/manager-server.fcgi and adapt the rewrite rules.

Configuration interface access is not protected by Apache but by LemonLDAP::NG itself (see lemonldap-ng.ini).

Agent (Handler)

Charger l'agent dans la mémoire d'Apache :

PerlOptions +GlobalRequest
PerlRequire Lemonldap/NG/Handler.pm

Capture des pages d'erreur :

ErrorDocument 403 http://auth.example.com/?lmError=403
ErrorDocument 500 http://auth.example.com/?lmError=500
ErrorDocument 503 http://auth.example.com/?lmError=503

Hôte virtuel pour le rechargement :

<VirtualHost *:80>
    ServerName reload.example.com
 
    # Configuration reload mechanism (only 1 per physical server is
    # needed): choose your URL to avoid restarting Apache when
    # configuration change
    <Location /reload>
        Order deny,allow
        Deny from all
        Allow from 127.0.0.0/8
        PerlHeaderParserHandler Lemonldap::NG::Handler->reload
    </Location>
 
    # Uncomment this to activate status module
    #<Location /status>
    #    Order deny,allow
    #    Deny from all
    #    Allow from 127.0.0.0/8
    #    PerlHeaderParserHandler Lemonldap::NG::Handler->status
    #</Location>
 
</VirtualHost>

Then, to protect a standard virtual host, the only configuration line to add is:

PerlHeaderParserHandler Lemonldap::NG::Handler

Rechargement de la configuration

Comme les agents gardent leur configuration en cache, lorsque la configuration est changée elle doit être mise à jour dans les agents. An Apache restart will work, but LemonLDAP::NG offers the mean to reload them through an HTTP request. Le rechargement de la configuration sera effectif en moins de 10 minutes.

After configuration is saved by Manager, LemonLDAP::NG will try to reload configuration on distant Handlers by sending an HTTP request to the servers. The servers and URLs can be configured in Manager, General Parameters > reload configuration URLs: keys are server names or IP the requests will be sent to, and values are the requested URLs.

Ces paramètres peuvent être surchargés dans le fichier ini de LemonLDAP::NG ini file, à la section apply.

Une URL par serveur physique est nécessaire, car les agents partagent le même cache de configuration pour chaque serveur physique.

La cible reload est gérée dans la configuration d'Apache, dans un hôte virtuel protégé par LemonLDAP::NG Handler, par exemple:

<VirtualHost *:80>
    ServerName reload.example.com
 
    <Location /reload>
        Order deny,allow
        Deny from all
        Allow from 127.0.0.0/8
        PerlHeaderParserHandler Lemonldap::NG::Handler->refresh
    </Location>
 
</VirtualHost>

Il faut autoriser l'accès à l'adresse IP du manager.

Fichier local

La configuration LemonLDAP::NG peut être gérée par un fichier local au format INI. Le fichier est nommé lemonldap-ng.ini et dispose des sections suivantes :

configuration : où la configuration est stockée
apply : les URL de rechargement des agents distants
all : paramètres pour tous les modules
portal : paramètres réservés au portail
manager : paramètres réservés au manager
manager : paramètres réservés aux agents

Lorsqu'un paramètre et fixé dans lemonldap-ng.ini, il surcharge le paramètre issu de la configuration globale.

Par exemple, pour surcharger l'apparence du portail :

[portal]
portalSkin = dark

Il est nécessaire de connaître le nom technique du paramètre de configuration pour le faire. Se référer à la liste des paramètres pour le trouver.