Login SSO no Drupal usando Keycloak como provedor de conexão OAuth / OpenID

Visão geral

A integração SSO do Drupal OAuth/OpenID Connect permite o SSO entre o site Drupal e o Keycloak. Este guia de configuração ajuda a configurar o Single Sign-On (SSO) entre o site Drupal e o Keycloak usando o módulo OAuth/OpenID Connect. Ao incorporar o Conexão OAuth/OpenID Com este módulo para o site Drupal, você pode acessar o site Drupal facilmente usando as credenciais do Keycloak. Este módulo é compatível com Drupal 7, Drupal 8, Drupal 9, Drupal 10 e Drupal 11.

Playground

Planos de preços

Agendar uma Reunião

Passos da instalação

Versão antiga
nova Versão

Usando o Composer
Usando Drush
Instalação manual

Baixe o módulo:

compositor requer 'drupal/miniorange_oauth_client'
Acessar Estender menu no seu console de administração do Drupal e pesquise por Configuração do cliente OAuth miniOrange usando a caixa de pesquisa.
Habilite o módulo marcando a caixa de seleção e clicando em Instale botão.
Você pode configurar o módulo em:

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

Instale o módulo:

drush em drupal/miniorange_oauth_client
Limpe o cache:

drush cr
Você pode configurar o módulo em:

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

Observação: A instalação manual é compatível apenas com Drupal 7, Drupal 8 e Drupal 9.

Acessar Estender menu no seu console de administração do Drupal e clique em Instalar novo módulo.
Instalar o Drupal Login OAuth e OpenID Connect - Login SSO do cliente OAuth2 módulo baixando o zip ou a partir da URL do pacote (tar/zip).
Clique em Ativar módulos recém-adicionados.
Habilite este módulo marcando a caixa de seleção e clicando em instalar botão.
Você pode configurar o módulo em:

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

Usando o Composer
Usando Drush
Instalação manual

Baixe o módulo:

compositor requer 'drupal/miniorange_oauth_client'
Acessar Estender menu no seu console de administração do Drupal e pesquise por Configuração do cliente OAuth miniOrange usando a caixa de pesquisa.
Habilite o módulo marcando a caixa de seleção e clicando em Instale botão.
Você pode configurar o módulo em:

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

Instale o módulo:

drush em drupal/miniorange_oauth_client
Limpe o cache:

drush cr
Você pode configurar o módulo em:

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

Observação: Instalação manual compatível apenas com Drupal 7, Drupal 8 e Drupal 9.

Acessar Estender menu no seu console de administração do Drupal e clique em Instalar novo módulo.
Instalar o Drupal Login OAuth e OpenID Connect - Login SSO do cliente OAuth2 módulo baixando o zip ou a partir da URL do pacote (tar/zip).
Clique em Ativar módulos recém-adicionados.
Habilite este módulo marcando a caixa de seleção e clicando em instalar botão.
Você pode configurar o módulo em:

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

Etapas de configuração

Configurar o Drupal como um cliente OAuth

Acesse Configuração → Personalidades → Configuração do cliente miniOrange OAuth no menu Administração. (/admin/config/people/miniorange_oauth_client)

Cliente Drupal OAuth - selecione mimiorange Configuração do Cliente OAuth

Na aba Configurar OAuth, selecione o Provedor OAuth desejado no menu suspenso.

Observação: Se o Provedor OAuth desejado não estiver listado no menu suspenso, selecione Provedor OAuth personalizado / Provedor OpenID personalizado E continue.

Cliente Drupal OAuth - selecione Provedor OAuth

Copie o URL de retorno/redirecionamento e mantenha-o à mão. Isso será necessário ao configurar o Provedor OAuth.

Observação: Se o seu provedor oferece suporte apenas a URLs de retorno/redirecionamento HTTPS e você tem um site HTTP, certifique-se de marcar a caixa de seleção "Aplicar URL de retorno HTTPS" na parte inferior da guia.

Insira o nome do provedor OAuth no Nome visível campo de texto.

Cliente Drupal OAuth - Copiar URL de retorno de chamada

Configurar o Drupal como um cliente OAuth

Acesse Configuração → Personalidades → Cliente OAuth miniOrange no menu Administração. (admin/config/people/mo-oauth-client/mo-client-config)

Cliente OAuth Drupal - selecione o cliente OAuth mimiorange

De acordo com o relatório Gerenciar seção, sob o Configuração do Cliente guia, clique no + Adicionar novo botão para configurar o cliente OAuth desejado.

Cliente Drupal OAuth - Clique em Adicionar novo

Sob o Adicione selecione o aplicativo OAuth desejado no menu suspenso.

Observação: Se o Provedor OAuth desejado não estiver listado no menu suspenso, selecione Provedor OAuth personalizado / Provedor OpenID personalizado E continue.

Insira o nome do provedor OAuth no Nome do aplicativo personalizado campo de texto. Copie o URL de retorno/redirecionamento e mantenha-o à mão. Isso será necessário ao configurar o Provedor OAuth.

Cliente Drupal OAuth - Insira o nome do aplicativo personalizado e copie o URL de retorno de chamada

Se o seu provedor suporta apenas URLs de retorno/redirecionamento HTTPS e você tem um site HTTP, certifique-se de verificar o Aplicar URL de retorno de chamada HTTPS caixa de seleção no Configurações aba.

Cliente Drupal OAuth - Aplicar URL de retorno de chamada HTTPS

Configurar o keycloak com a versão 21.1.1
Configurar o keycloak com a versão 18
Configurar o keycloak com uma versão inferior

Crie um aplicativo de logon único OAuth/OpenID no Keycloak:

Entrar na sua Manto-chave console do administrador.
Selecionar Criar reino no menu suspenso mestre.

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - Navegue até o mestre e clique no botão Criar Realm

Digite o nome do aplicativo no Nome do reino campo de texto e clique em Criar botão para prosseguir.

Navegue até a Clientes -> Lista de clientes -> Criar cliente.

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - Clique no botão criar cliente

De acordo com o relatório Configurações gerais, introduzir o ID do cliente. Clique no Seguinte botão.

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - insira o nome do ID do cliente no campo de texto

De acordo com o relatório Configuração de capacidade, ative a caixa de seleção para Autenticação de cliente e clique em Seguinte botão.

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - Habilitar a caixa de seleção de autenticação do cliente

De acordo com o relatório Configurações de login, cole o URL de retorno/redirecionamento para dentro do URIs de redirecionamento válidos campo de texto e clique em Economize botão.

Drupal Keycloak OAuth/OIDC Single Sign On - SSO - Copie o URL de retorno de chamada que você copiou do módulo OAuth Client e cole-o no campo

Navegue até a Credenciais guia e copie o Segredo do cliente e mantenha-o à mão para configurar o Drupal como cliente OAuth.

Keycloak OAuth/OIDC Single Sign On - Copie o segredo do cliente

Acesse o console do administrador do Keycloak.
Acessar Configurações de reino → Geral e copie o ID do reino clicando em copiar ícone.
Copie a URL do domínio do Keycloak. Por exemplo, se o seu Keycloak estiver rodando em localhost, o domínio seria "https://localhost:8080". (veja a imagem abaixo)

Keycloak OAuth/OIDC Single Sign On - Nome de Domínio e Domínio CCopy

Crie um aplicativo de logon único OAuth/OpenID no Keycloak:

Primeiro de tudo, Baixar Keycloak e instalá-lo.
Iniciar servidor: Inicie o servidor keycloak executando o arquivo _standalone.sh_ Diretório raiz de keycloak/bin/standalone.sh
Criar Reino: Agora faça login no console de administração do Keycloak e navegue até o domínio desejado. Você pode adicionar um novo domínio selecionando Criar reino opção.

Criar Reino: Digite o nome do domínio e copie-o. Mantenha-o à mão, pois será necessário configurar o Drupal como cliente OAuth posteriormente. Em seguida, clique em CRIAR para adicionar reino.

Introduzir o ID do cliente e copie-o. Mantenha-o à mão, pois será necessário configurar o Drupal como cliente OAuth posteriormente, então clique em Economize botão.

permitir que o Autenticação de cliente e clique no Economize botão.

Cole a URL de retorno copiada (na etapa 1) no URLs de redirecionamento válidas área de texto e clique em Economize botão.

Navegue até a Credenciais aba e copie o Segredo do Cliente.

Crie um aplicativo de logon único OAuth/OpenID no Keycloak:

Primeiro de tudo, Baixar Keycloak e instalá-lo.
Iniciar servidor: Inicie o servidor keycloak executando o arquivo _standalone.sh_ Diretório raiz de keycloak/bin/standalone.sh
Adicionar Realm: Agora faça login no console de administração do Keycloak e navegue até o domínio desejado. Você pode adicionar um novo domínio selecionando Criar reino opção.

Criar Reino: Digite o nome do domínio e copie-o. Mantenha-o à mão, pois será necessário configurar o Drupal como cliente OAuth posteriormente. Em seguida, clique em CRIAR para adicionar reino.

Agora, digite o Como o seu nome será exibido e clique no botão Salvar.

Navegue até a Clientes guia e clique em Criar botão.

Introduzir o ID do cliente e copie-o. Mantenha-o à mão, pois será necessário configurar o Drupal como cliente OAuth posteriormente, então clique em Economize botão.

Cole o copiado anteriormente URL de retorno/redirecionamento no URLs de redirecionamento válidas campo de texto e clique em Economize botão.

Navegue até a Credenciais aba e copie o Segredo do Cliente.

Integrando Drupal com Keycloak:

Acesse o módulo miniOrange OAuth Client.
No Drupal Configurar OAuth tabule e cole o copiado ID do cliente e Segredo do cliente de Keyclaok no ID do cliente e Segredo do cliente campos de texto.

Keycloak OAuth/OIDC Single Sign On - Colar credenciais do cliente

No Drupal Configurar OAuth guia, substitua "Keycloak_base_URL" pelo copiado URL do domínio Keycloak e nome do reino com nome do reino copiado no Autorizar ponto final, Ponto de extremidade do token de acesso e Obter ponto final de informações do usuário campos de texto. Em seguida, clique em Salvar configuração botão para prosseguir.

Insira as seguintes informações nos campos de texto correspondentes da guia Configurar OAuth do módulo Drupal OAuth Client.

Objetivo	perfil de e-mail openid
Autorizar ponto final	(URL base do Keycloak)/realms/{nome-do-realm}/protocolo/openid-connect/auth
Ponto de extremidade do token de acesso	(URL base do Keycloak)/realms/{nome-do-realm}/protocolo/openid-connect/token
Obter ponto final de informações do usuário	(URL base do Keycloak)/realms/{nome-do-realm}/protocolo/openid-connect/userinfo

Keycloak OAuth/OIDC Single Sign On - Colar nome do reino e domínio Salvar configuração

Integrando Drupal com Keycloak:

Acesse o módulo miniOrange OAuth Client.
In Adicione guia, cole o copiado ID do cliente e Segredo do cliente de Keycloak no ID do cliente e Segredo do cliente campo de texto.

Drupal-Auth-SSO-Keycloak-Paste-Client-Credentials

No Drupal Configurar OAuth guia, substitua "Keycloak_base_URL" pelo copiado URL do domínio Keycloak e nome do reino com nome do reino copiado no Autorizar ponto final, Ponto de extremidade do token de acesso e Obter ponto final de informações do usuário campos de texto. Em seguida, clique em Salvar configuração botão para prosseguir.

Insira as seguintes informações nos campos de texto correspondentes da guia Configurar OAuth do módulo Drupal OAuth Client.

Objetivo	perfil de e-mail openid
Autorizar ponto final	(URL base do Keycloak)/realms/{nome-do-realm}/protocolo/openid-connect/auth
Ponto de extremidade do token de acesso	(URL base do Keycloak)/realms/{nome-do-realm}/protocolo/openid-connect/token
Obter ponto final de informações do usuário	(URL base do Keycloak)/realms/{nome-do-realm}/protocolo/openid-connect/userinfo

O processo de Enviar ID do cliente e segredo em A caixa de seleção "Client ID" permite especificar se o ID do Cliente e o Segredo devem ser incluídos no cabeçalho ou no corpo da Solicitação de Endpoint de Token. Se não tiver certeza de qual opção selecionar, você pode usar as configurações padrão.
Clique na caixa de seleção para Habilitar login com OAuth, role para baixo e clique em Salvar configuração botão.

Drupal OAuth OpenID OIDC Single Sign On (SSO) Habilitando a caixa de seleção Login com OAuth e clicando em Salvar configuração

Teste de conexão entre Drupal e provedor OAuth

Após salvar as configurações com sucesso, clique em Executar configuração de teste botão para testar a conexão entre o Drupal e o provedor OAuth.

OAuth-OIDC-Configuração-do-Cliente-Verificar-Conexão-com-Provedor-OAuth

Em um pop-up de Configuração de Teste, se você não tiver nenhuma sessão ativa no mesmo navegador, será solicitado que você faça login no Provedor OAuth. Após o login, você receberá uma lista de atributos recebidos do Provedor OAuth.
Selecione os Atributo de e-mail no menu suspenso no qual o ID de e-mail do usuário é obtido e clique em Pronto botão.

Observação: O mapeamento do atributo de e-mail é obrigatório para executar o SSO, ou seja, fazer login no site Drupal com credenciais do provedor OAuth.

Cliente Drupal OAuth - selecione Atributo de e-mail

No Mapeamento de Atributos e Funções guia, selecione a Atributo de nome de usuário na lista suspensa e clique em Salvar configuração botão.

Cliente Drupal OAuth - selecione o atributo do usuário e clique em salvar configuração

Agora, saia e acesse a página de login do seu site Drupal. Você encontrará automaticamente um link para Login com Provedor OAuth. Se quiser adicionar o link SSO a outras páginas, siga os passos mostrados na imagem abaixo:

Cliente Drupal OAuth - adicionar link em outras páginas

Teste de conexão entre Drupal e provedor OAuth

Após salvar as configurações com sucesso, clique no botão Executar configuração de teste botão para testar a conexão entre o Drupal e o provedor OAuth.

Em um pop-up de Configuração de Teste, se você não tiver nenhuma sessão ativa no mesmo navegador, será solicitado que você faça login no Provedor OAuth. Após o login, você receberá uma lista de atributos recebidos do Provedor OAuth.
Clique no Configurar mapeamentos botão.

No Mapeamento de Atributos guia, selecione a Atributo de e-mail e Atributo de nome de usuário na lista suspensa e clique em Salvar configuração botão.

Observação: O mapeamento do atributo de e-mail é obrigatório para executar o SSO, ou seja, fazer login no site Drupal com credenciais do provedor OAuth.

Agora, saia e acesse a página de login do seu site Drupal. Você encontrará automaticamente um link para Login com Provedor OAuth. Se quiser adicionar o link SSO a outras páginas, siga os passos mostrados na imagem abaixo:

Precisa de assistência?

Se você enfrentar algum problema durante a configuração ou se desejar alguns recursos adicionais, entre em contato conosco em drupalsupport@xecurify.com.

Recursos adicionais:

Solução de problemas:

Mais perguntas frequentes ➔

Recebendo o erro: 'Nome de usuário não recebido. Verifique sua configuração de Mapeamento de Atributos.' OU Recebendo o erro: 'E-mail não recebido. Verifique sua configuração de Mapeamento de Atributos.'

Siga os passos mencionados AQUI

Estou recebendo a mensagem "As credenciais do cliente não foram encontradas nos cabeçalhos ou no corpo"
quando tento executar a configuração de teste

Siga os passos mencionados AQUI

Depois de clicar em "Sair" no Drupal, ele me leva de volta à página inicial do Drupal. No entanto, quando tento fazer login com outro usuário, ele não me pede para fazer login, mas me conecta automaticamente com o mesmo usuário.

A funcionalidade de logout que você mencionou aqui é o comportamento padrão de um módulo. Ela desconecta você do Drupal, mas não do seu aplicativo/provedor. Para permitir que o módulo efetue logout da sua conta de provedor/aplicativo (o que você está procurando), você precisa fazer as configurações abaixo: [saiba mais]

Comprei o módulo pago do Drupal e o substituí pelo módulo gratuito, mas ainda não consigo usar os recursos pagos.

Como você atualizou para uma de nossas versões pagas do módulo Drupal e substituiu o módulo gratuito pelo pago, você precisa primeiro ativar o módulo pago. Consulte os passos abaixo.Saiba mais]

Obrigado pela sua resposta. Entraremos em contato em breve.

Algo deu errado. Envie sua consulta novamente.

conteúdo

Login SSO no Drupal usando Keycloak como provedor de conexão OAuth / OpenID