Connectez-vous SSO à Drupal en utilisant Keycloak comme fournisseur OAuth / OpenID Connect

Marché

L'intégration Drupal OAuth/OpenID Connect SSO permet le SSO entre le site Drupal et Keycloak. Ce guide de configuration aide à configurer l'authentification unique (SSO) entre le site Drupal et Keycloak à l'aide du module OAuth/OpenID Connect. Lorsque vous incorporez le Connexion OAuth/OpenID Ce module, intégré à votre site Drupal, vous permet de vous connecter facilement grâce à vos identifiants Keycloak. Il est compatible avec Drupal 7, 8, 9, 10 et 11.

cour de récréation

Plans de tarification

Organiser un RDV

Procédure d'installation

Ancienne version
Nouvelle Version

Utiliser le compositeur
Utiliser Drush
Installation manuelle

Téléchargez le module :

le compositeur nécessite 'drupal/miniorange_oauth_client'
Accédez à étendre menu sur votre console d'administration Drupal et recherchez Configuration du client OAuth miniOrange en utilisant le champ de recherche.
Activez le module en cochant la case et cliquez sur le Installer .
Vous pouvez configurer le module à :

{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc

Installez le module :

drush et drupal/miniorange_oauth_client
Vider le cache:

drush cr
Vous pouvez configurer le module à :

{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc

À noter: Installation manuelle compatible uniquement avec Drupal 7, Drupal 8 et Drupal 9.

Accédez à étendre menu sur votre console d'administration Drupal et cliquez sur Installer un nouveau module.
Installer Drupal Connexion OAuth et OpenID Connect - Connexion SSO client OAuth2 module soit en téléchargeant le zip, soit depuis l'URL du paquet (tar/zip).
Cliquez sur Activer les modules nouvellement ajoutés.
Activez ce module en cochant la case et en cliquant sur installer .
Vous pouvez configurer le module à :

{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc

Utiliser le compositeur
Utiliser Drush
Installation manuelle

Téléchargez le module :

le compositeur nécessite 'drupal/miniorange_oauth_client'
Accédez à étendre menu sur votre console d'administration Drupal et recherchez Configuration du client OAuth miniOrange en utilisant le champ de recherche.
Activez le module en cochant la case et cliquez sur le Installer .
Vous pouvez configurer le module à :

{BaseURL}/admin/config/people/mo-oauth-client/mo-client-config

Installez le module :

drush et drupal/miniorange_oauth_client
Vider le cache:

drush cr
Vous pouvez configurer le module à :

{BaseURL}/admin/config/people/mo-oauth-client/mo-client-config

À noter: Installation manuelle compatible uniquement avec Drupal 7, Drupal 8 et Drupal 9.

Accédez à étendre menu sur votre console d'administration Drupal et cliquez sur Installer un nouveau module.
Installer Drupal Connexion OAuth et OpenID Connect - Connexion SSO client OAuth2 module soit en téléchargeant le zip, soit depuis l'URL du paquet (tar/zip).
Cliquez sur Activer les modules nouvellement ajoutés.
Activez ce module en cochant la case et en cliquant sur installer .
Vous pouvez configurer le module à :

{BaseURL}/admin/config/people/mo-oauth-client/mo-client-config

Étapes de configuration

Configurer Drupal comme client OAuth

Allez dans Configuration → Personnes → Configuration du client miniOrange OAuth dans le menu Administration. (/admin/config/people/miniorange_oauth_client)

Client OAuth Drupal - sélectionnez la configuration du client OAuth mimiorange

Sous l’onglet Configurer OAuth, sélectionnez le fournisseur OAuth souhaité dans la liste déroulante.

À noter: Si le fournisseur OAuth souhaité n'est pas répertorié dans la liste déroulante, veuillez le sélectionner Fournisseur OAuth personnalisé / Fournisseur OpenID personnalisé et continue.

Client OAuth Drupal - sélectionnez le fournisseur OAuth

Copiez le URL de rappel/redirection et gardez-le à portée de main. Cela sera nécessaire lors de la configuration du fournisseur OAuth.

À noter: Si votre fournisseur ne prend en charge que les URL de rappel/redirigation HTTPS et que vous disposez d'un site HTTP, assurez-vous d'activer la case à cocher « Appliquer l'URL de rappel HTTPS » en bas de l'onglet.

Saisissez le nom du fournisseur OAuth dans le champ Nom du profil champ de texte.

Client OAuth Drupal - Copier l'URL de rappel

Configurer Drupal comme client OAuth

Allez dans Configuration → Personnes → Client OAuth miniOrange dans le menu Administration. (admin/config/people/mo-oauth-client/mo-client-config)

Client OAuth Drupal - sélectionnez le client OAuth mimiorange

Dans l' Gérer section, sous la Configuration du client onglet, cliquez sur le + Ajouter nouveau bouton pour configurer le client OAuth souhaité.

Client Drupal OAuth : cliquez sur « Ajouter »

En vertu des Normes sur l’information et les communications, les organismes doivent rendre leurs sites et applications Web accessibles. Ils y parviennent en conformant leurs sites Web au niveau AA des Web Content Accessibility Guidelines (WCAG). Ajouter sélectionnez l'application OAuth souhaitée dans la liste déroulante.

Saisissez le nom du fournisseur OAuth dans le champ Nom de l'application personnalisée champ de texte. Copiez le URL de rappel/redirection et gardez-le à portée de main. Cela sera nécessaire lors de la configuration du fournisseur OAuth.

Client OAuth Drupal : saisissez le nom de l'application personnalisée et copiez l'URL de rappel.

Si votre fournisseur ne prend en charge que les URL de rappel/redirection HTTPS et que vous disposez d'un site HTTP, assurez-vous de vérifier le Appliquer l'URL de rappel HTTPS case à cocher dans le Paramètres languette.

Client OAuth Drupal : Appliquer l'URL de rappel HTTPS

Configurer keycloak avec la version-21.1.1
Configurer keycloak avec la version-18
Configurer keycloak avec une version inférieure

Créer une application d'authentification unique OAuth/OpenID dans Keycloak :

Connectez-vous à votre Cape de clé console d'administrateur.
Choisir Créer un royaume dans le menu déroulant principal.

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - Accédez au maître et cliquez sur le bouton Créer un royaume

Entrez le nom de l'application dans le champ Nom du royaume champ de texte et cliquez sur le Créer bouton pour continuer.

Accédez à la ANNONCEURS -> Liste des clients -> Créer un client.

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - Cliquez sur le bouton Créer un client

Dans l' Paramètres généraux, entrer le identité du client. Clique sur le Suivant .

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - entrez le nom de l'ID client dans le champ de texte

Dans l' Configuration des capacités, cochez la case pour Authentification client et cliquez sur le Suivant .

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - Cochez la case Authentification client

Dans l' Paramètres de connexion, collez le URL de rappel/redirection dans le URI de redirection valides champ de texte et cliquez sur le Enregistrer .

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - Copiez l'URL de rappel que vous avez copiée depuis le module client OAuth et collez-la dans le champ

Accédez à la Titres de compétences et copiez le Secret client et gardez-le à portée de main pour configurer Drupal en tant que client OAuth.

Authentification unique Keycloak OAuth/OIDC - Copiez le secret client

Accédez à la console Administrateur Keycloak.
Accédez à Paramètres du domaine → Généralités et copiez le ID de domaine en cliquant sur copier Icône.
Copiez l'URL du domaine Keycloak. Par exemple, si votre Keycloak est exécuté sur localhost, le domaine sera « https://localhost:8080 ». (Voir l'image ci-dessous)

Authentification unique Keycloak OAuth/OIDC - Copier le nom et le domaine du royaume

Créez une application d'authentification unique OAuth/OpenID dans Keycloak :

Tout d'abord, Télécharger Keycloak et l'installer.
Démarrer le serveur : Démarrez le serveur keycloak en exécutant le fichier _standalone.sh_ Répertoire racine de keycloak/bin/standalone.sh
Créer un royaume : Connectez-vous maintenant à la console d'administration de Keycloak et accédez au royaume souhaité. Vous pouvez ajouter un nouveau royaume en sélectionnant Créer un royaume option.

Créer un royaume : Saisissez le nom du domaine et copiez-le. Gardez-le à portée de main ; il vous sera nécessaire de configurer Drupal comme client OAuth ultérieurement. Cliquez ensuite sur CREATE pour ajouter un royaume.

Keycloak - Connectez-vous pour créer un royaume

Entrer le identité du client et copiez-le. Gardez-le à portée de main ; il vous faudra configurer Drupal comme client OAuth ultérieurement. Cliquez ensuite sur Enregistrer .

Activez la Authentification client et cliquez sur le Enregistrer .

Collez l'URL de rappel copiée (à l'étape 1) dans le URL de redirection valides zone de texte et cliquez sur le Enregistrer .

Accédez à la Titres de compétences et copiez le secret client.

Créez une application d'authentification unique OAuth/OpenID dans Keycloak :

Tout d'abord, Télécharger Keycloak et l'installer.
Démarrer le serveur : Démarrez le serveur keycloak en exécutant le fichier _standalone.sh_ Répertoire racine de keycloak/bin/standalone.sh
Ajouter un royaume : Connectez-vous maintenant à la console d'administration de Keycloak et accédez au royaume souhaité. Vous pouvez ajouter un nouveau royaume en sélectionnant Créer un royaume option.

Créer un royaume : Saisissez le nom du domaine et copiez-le. Gardez-le à portée de main ; il vous sera nécessaire de configurer Drupal comme client OAuth ultérieurement. Cliquez ensuite sur CREATE pour ajouter un royaume.

Maintenant, entrez le Pseudo et cliquez sur le bouton Enregistrer.

Accédez à la ANNONCEURS onglet et cliquez sur Créer .

Entrer le identité du client et copiez-le. Gardez-le à portée de main ; il vous faudra configurer Drupal comme client OAuth ultérieurement. Cliquez ensuite sur Enregistrer .

Collez le précédemment copié URL de rappel/redirection into the URL de redirection valides champ de texte et cliquez sur Enregistrer .

Accédez à la Titres de compétences et copiez le secret client.

Intégration de Drupal avec Keycloak :

Accédez au module miniOrange OAuth Client.
Chez Drupal Configurer OAuth onglet coller le copié identité du client et Secret client de Keyclaok dans le identité du client et Secret client champs de texte.

Keycloak OAuth/OIDC Single Sign On - Coller les informations d'identification du client

Chez Drupal Configurer OAuth onglet, remplacez "Keycloak_base_URL" par le copié URL du domaine Keycloak et le nom de royaume avec le nom de royaume copié dans le Autoriser le point de terminaison, Point de terminaison du jeton d'accès, ainsi Obtenir le point de terminaison des informations utilisateur champs de texte. Ensuite, cliquez sur le Enregistrer la configuration bouton pour continuer.

Saisissez les informations suivantes dans les champs de texte correspondants de l’onglet Configurer OAuth du module Drupal OAuth Client.

Domaine	profil de messagerie openid
Autoriser le point de terminaison	(URL de base Keycloak)/realms/{realm-name}/protocol/openid-connect/auth
Point de terminaison du jeton d'accès	(URL de base Keycloak)/realms/{realm-name}/protocol/openid-connect/token
Obtenir le point de terminaison des informations utilisateur	(URL de base de Keycloak)/realms/{realm-name}/protocol/openid-connect/userinfo

Keycloak OAuth/OIDC Single Sign On - Coller le nom du domaine et enregistrer la configuration

Intégration de Drupal avec Keycloak :

Accédez au module miniOrange OAuth Client.
In Ajouter onglet, collez le copié identité du client et Secret client de Keycloak dans le identité du client et Secret client champ de texte.

Drupal-Auth-SSO-Keycloak-Coller-Informations d'identification du client

Chez Drupal Configurer OAuth onglet, remplacez "Keycloak_base_URL" par le copié URL du domaine Keycloak et le nom de royaume avec le nom de royaume copié dans le Autoriser le point de terminaison, Point de terminaison du jeton d'accès, ainsi Obtenir le point de terminaison des informations utilisateur champs de texte. Ensuite, cliquez sur le Enregistrer la configuration bouton pour continuer.

Saisissez les informations suivantes dans les champs de texte correspondants de l’onglet Configurer OAuth du module Drupal OAuth Client.

Domaine	profil de messagerie openid
Autoriser le point de terminaison	(URL de base Keycloak)/realms/{realm-name}/protocol/openid-connect/auth
Point de terminaison du jeton d'accès	(URL de base Keycloak)/realms/{realm-name}/protocol/openid-connect/token
Obtenir le point de terminaison des informations utilisateur	(URL de base de Keycloak)/realms/{realm-name}/protocol/openid-connect/userinfo

Le Envoyer l'ID client et le secret dans Cette case à cocher vous permet de spécifier si l'ID client et le secret doivent être inclus dans l'en-tête ou le corps de la requête de jeton de point de terminaison. En cas de doute, vous pouvez conserver les paramètres par défaut.
Cliquez sur la case à cocher pour Activer la connexion avec OAuth, faites défiler vers le bas et cliquez sur l'icône Enregistrer la configuration .

Drupal OAuth OpenID OIDC Single Sign On (SSO) Activation de la case à cocher Connexion avec OAuth et cliquez sur Enregistrer la configuration

Tester la connexion entre Drupal et le fournisseur OAuth

Après avoir enregistré avec succès les configurations, veuillez cliquer sur le Effectuer une configuration de test bouton pour tester la connexion entre Drupal et le fournisseur OAuth.

Vérification de la connexion avec le fournisseur OAuth pour la configuration du client OAuth OIDC

Dans une fenêtre contextuelle de configuration de test, si vous n'avez aucune session active sur le même navigateur, vous serez invité à vous connecter au fournisseur OAuth. Une fois connecté, la liste des attributs reçus du fournisseur OAuth vous sera fournie.
Sélectionnez le Attribut d'e-mail dans le menu déroulant dans lequel l'identifiant e-mail de l'utilisateur est obtenu et cliquez sur le OK .

À noter: Le mappage de l'attribut Email est obligatoire pour effectuer l'authentification unique (SSO), c'est-à-dire la connexion au site Drupal avec les informations d'identification du fournisseur OAuth.

Client OAuth Drupal - sélectionnez l'attribut de courrier électronique

Sur le Cartographie des attributs et des rôles onglet, veuillez sélectionner l'onglet Attribut de nom d'utilisateur dans la liste déroulante et cliquez sur le Enregistrer la configuration .

Client OAuth Drupal - sélectionnez l'attribut utilisateur et cliquez sur Enregistrer la configuration

Déconnectez-vous et accédez à la page de connexion de votre site Drupal. Vous y trouverez automatiquement un lien « Connexion avec un fournisseur OAuth ». Si vous souhaitez ajouter le lien SSO à d'autres pages, suivez les étapes indiquées dans l'image ci-dessous :

Client OAuth Drupal - ajouter un lien sur d'autres pages

Tester la connexion entre Drupal et le fournisseur OAuth

Après avoir enregistré avec succès les configurations, cliquez sur le bouton Effectuer une configuration de test bouton pour tester la connexion entre Drupal et le fournisseur OAuth.

Dans une fenêtre contextuelle de configuration de test, si vous n'avez aucune session active sur le même navigateur, vous serez invité à vous connecter au fournisseur OAuth. Une fois connecté, la liste des attributs reçus du fournisseur OAuth vous sera fournie.
Cliquez sur le Configurer les mappages .

Sur le Cartographie d'attributs onglet, veuillez sélectionner l'onglet Attribut d'e-mail et Attribut de nom d'utilisateur dans la liste déroulante et cliquez sur le Enregistrer la configuration .

Déconnectez-vous et accédez à la page de connexion de votre site Drupal. Vous y trouverez automatiquement un lien « Connexion avec un fournisseur OAuth ». Si vous souhaitez ajouter le lien SSO à d'autres pages, suivez les étapes indiquées dans l'image ci-dessous :

Besoin d'assistance?

Si vous rencontrez des problèmes lors de la configuration ou si vous souhaitez des fonctionnalités supplémentaires, veuillez nous contacter à drupalsupport@xecurify.com.

Caractéristiques supplémentaires:

Dépannage:

Plus de FAQ ➔

Obtention d'une erreur : « Nom d'utilisateur non reçu. Vérifiez votre configuration de mappage d'attributs. » OU Obtention d'une erreur : « E-mail non reçu. Vérifiez votre configuration de mappage d'attributs. »

Suivez les étapes mentionnées ICI

J'obtiens le message « Les informations d'identification du client n'ont pas été trouvées dans les en-têtes ou le corps »
lorsque j'essaie d'effectuer une configuration de test

Suivez les étapes mentionnées ICI

Après avoir cliqué sur la déconnexion dans Drupal, cela me renvoie à la page d'accueil de Drupal. Cependant, lorsque j'essaie de me connecter avec un autre utilisateur, il ne me demande pas de me connecter mais me connecte automatiquement avec le même utilisateur

La fonctionnalité de déconnexion que vous avez mentionnée ici est le comportement par défaut d'un module. Elle vous déconnecte de Drupal mais pas de votre application/fournisseur. Pour permettre au module de se déconnecter de votre compte fournisseur/application (ce que vous recherchez), vous devez effectuer les configurations ci-dessous : [en savoir plus]

J'ai acheté le module Drupal payant et je l'ai remplacé par le module gratuit, mais je ne peux toujours pas utiliser les fonctionnalités payantes.

Comme vous avez effectué une mise à niveau vers l'une de nos versions payantes du module Drupal et remplacé le module gratuit par le module payant, vous devez d'abord activer le module payant. Veuillez vous référer aux étapes ci-dessous.En savoir plus]

Merci pour votre réponse. Nous reviendrons vers vous bientôt.

Quelque chose s'est mal passé. Veuillez soumettre à nouveau votre requête

Table des matières

Connectez-vous SSO à Drupal en utilisant Keycloak comme fournisseur OAuth / OpenID Connect