/Keycloak-FranceConnect

Extension Keycloak facilitant l'utilisation de FranceConnect

Primary LanguageHTMLMIT LicenseMIT

keycloak-franceconnect

English Version

Cette extension pour Keycloak ajoute un fournisseur d'identité permettant d'utiliser les services proposés par France Connect.

Build Status

Fonctionnalités

Compatibilité

La version 2.1 est compatible avec Keycloak 9.0.2 et supérieur. La version 2.0 est compatible avec Keycloak 8.0.1 jusqu'à 9.0.0.

Migration

Si vous utilisez déjà une ancienne version de l'extension, il est préférable de supprimer votre configuration afin d'éviter tout conflit possible.

  • 1.x -> 1.4 : Vous devez ajouter le niveau eIDAS dans la configuration du fournisseur d'identité.
  • 1.x -> 2.0+ : Vérifiez que votre fournisseur d'identité existe et que l'environnement France Connect sélectionné est celui désiré.

Installation

L'installation de l'extension est simple et peut-être réalisée sans redémarrage de Keycloak.

  • Téléchargez la dernière version de l'extension à partir de la page de release
  • Copiez le fichier JAR dans le dossier standalone/deployments de votre serveur Keycloak
  • Redémarrez Keycloak (optionnel, le déploiement à chaud devrait fonctionner)

Vous pouvez également cloner le repository Github et effectuer une installation locale avec la commande :

$ mvn clean install wildfly:deploy

Utilisation

Prérequis

Vous devez créer un compte France Connect afin de récupérer les informations nécessaires à la configuration de cette extension (clientId, clientSecret, configuration de l'url de redirection autorisée, ...).

Il existe 2 environnements de connexion, Integration et Production. La demande d'un compte permettant l'accès à l'environnement d'Intégration s'effectue par email au service support de France Connect.

Configuration

Suite à l'installation de l'extension, le fournisseur d'identité France Connect Particulier est apparu. Une fois ce dernier selectionné, vous arrivez sur la page de configuration suivante :

keycloak-fc-conf-provider

Sélectionnez l'environnement désiré, entrez votre clientId, clientSecret, les scopes que vous souhaitez demander, le niveau d'authentification eIDAS. L'alias configuré par défaut (france-connect-particulier) est utilisé par les thèmes fc-theme et iron-theme. Vous pouvez donc modifier le nom de l'alias si vous n'utilisez pas un de ces thèmes.

Vous trouverez également l'url de redirection qu'il faudra enregistrer sur le portail Partenaire de France Connect :

  • endpoint : https://<keycloak-url>/auth/realms/<realm>/broker/franceconnect-particulier/endpoint
  • logout : https://<keycloak-url>/auth/realms/<realm>/broker/franceconnect-particulier/endpoint/logout_response

Mappers

Une fois la configuration validée, vous pouvez ajouter des mappers afin de récupérer les attributs à partir des claims fournis par France Connect.

Exemples de mappers :

  • Name : lastName, Mapper Type : Attribute Importer, Claim : family_name, User Attribute Name : lastName
  • Name : firstName, Mapper Type : Attribute Importer, Claim : given_name, User Attribute Name : firstName
  • Name : email, Mapper Type : Attribute Importer, Claim : email, User Attribute Name : email

Thème

Cette extension fournit 2 thèmes :

  • fc-theme
  • iron-theme

Utilisez le thème de votre choix, et rendez-vous à l'adresse suivante : https://<keycloak-url>/auth/realms/<realm>/account

keycloak-fc-login

FAQ

Voir la FAQ

Comment contribuer

Voir ici