Aller au contenu

Connexion Keycloak

Maarch Courrier permet de se connecter avec un portail Keycloak.

Paramétrage

Configuration Keycloak

La configuration se fait dans le fichier de configuration config/keycloakConfig.xml

Voici la partie à configurer :

    <ROOT>
        <AUTH_SERVER_URL>http://your.keycloak.server/authentication/path</AUTH_SERVER_URL>
        <REALM>maarch_courrier</REALM>
        <CLIENT_ID>maarch</CLIENT_ID>
        <CLIENT_SECRET>secret</CLIENT_SECRET>
        <REDIRECT_URI>http://demo.maarchcourrier.com/</REDIRECT_URI> <!-- Should be the url of the login page -->
        <ENCRYPTION_ALGORITHM>RS256</ENCRYPTION_ALGORITHM>
        <ENCRYPTION_KEY_PATH>/path/to/key/file.pem</ENCRYPTION_KEY_PATH>
        <ENCRYPTION_KEY>key_content</ENCRYPTION_KEY>
        <SCOPE>openid profile email</SCOPE>
        <VERSION></VERSION>
    </ROOT>
  • AUTH_SERVER_URL : URL d'authentification du portail Keycloak
  • REALM : Le nom du "realm" contenant les utilisateurs de Maarch Courrier
  • CLIENT_ID : L'identifiant du client utilisé par Maarch Courrier pour communiquer avec Keycloak, défini dans l'administration de Keycloak
  • CLIENT_SECRET : Le secret du client utilisé par Maarch Courrier pour communiquer avec Keycloak, défini dans l'administration de Keycloak
  • REDIRECT_URI : L'adresse de redirection après connexion sur le portail Keycloak. Ce paramètre doit être l'URL de la page de connexion de MaarchCourrier (avec les paramètres page=login).
  • SCOPE : Périmètre des informations que Maarch Courrier demande à Keycloak lors de la connexion utilisateur.
  • VERSION : La version du serveur Keycloak configuré

Si vous avez paramétré votre instance Keycloak pour utiliser un algorithme de chiffrement, vous devez utiliser les paramètres suivants :

  • ENCRYPTION_ALGORITHM : Le nom de l'algorithme de chiffrement utilisé
  • ENCRYPTION_KEY_PATH : Le chemin vers la clé publique ou du certificat à utiliser
  • ENCRYPTION_KEY : Le contenu de la clé publique ou du certificat à utiliser

Vous ne pouvez pas utiliser ENCRYPTION_KEY_PATH et ENCRYPTION_KEY en même temps.

Activation du mode d'authentification Keycloak

Ouvrir config/login_method.xml et activer keycloak (copier le fichier dans votre custom s'il n'est pas customisé) : 

    <METHOD>
        <ID>keycloak</ID>
        <ENABLED>true</ENABLED>
    </METHOD>

Il faut également mettre ENABLED à false pour toutes les autres méthodes