Configurar a inscrição e a entrada com o OpenID Connect - Azure AD B2C

Artigo
03/21/2023

Antes de começar, use o seletor Escolher um tipo de política para escolher o tipo de política que você está configurando. O Azure Active Directory B2C oferece dois métodos para definir como os usuários interagem com seus aplicativos: por meio de fluxos dos usuários predefinidos ou de políticas personalizadas totalmente configuráveis. As etapas necessárias neste artigo são diferentes para cada método.

O OpenID Connect é um protocolo de autenticação criado com base no OAuth 2.0 que pode ser usado para que os usuários entrem com segurança. A maioria dos provedores de identidade que usa esse protocolo é compatível com o Azure AD B2C.

Este artigo explica como você pode adicionar provedores de identidade do OpenID Connect personalizados em seus fluxos de usuário.

Importante

Seus pontos de extremidade devem estar em conformidade com os requisitos de segurança do Azure AD B2C. As versões e as criptografias de TLS mais antigas foram preterida. Para obter mais informações, consulte TLS do Azure AD B2C e requisitos do conjunto de criptografias.

Pré-requisitos

Criar um fluxo do usuário para que os usuários podem se registrar e entrar no seu aplicativo.
Registrar um aplicativo Web.

Conclua as etapas em Introdução às políticas personalizadas no Active Directory B2C
Registrar um aplicativo Web.

Adicionar o provedor de identidade

Entre no portal do Azure como administrador global do locatário Azure AD B2C.
Se você tiver acesso a vários locatários, selecione o ícone Configurações no menu superior para alternar para o seu locatário do Azure Active Directory B2C no menu Diretórios + assinaturas.
Escolha Todos os serviços no canto superior esquerdo do portal do Azure, procure e selecione Azure AD B2C.
Selecione Provedores de identidade e Novo provedor do OpenID Connect.
Insira um Nome. Por exemplo, digite Contoso.

Defina o provedor de identidade do OpenId Connect adicionando-o ao elemento ClaimsProviders no arquivo de extensão da política.

Abra TrustFrameworkExtensions.xml.
Localize o elemento ClaimsProviders. Se ele não existir, adicione-o sob o elemento raiz.

Adicione um novo ClaimsProvider da seguinte maneira:

<ClaimsProvider>
  <Domain>contoso.com</Domain>
  <DisplayName>Login with Contoso</DisplayName>
  <TechnicalProfiles>
    <TechnicalProfile Id="Contoso-OpenIdConnect">
      <DisplayName>Contoso</DisplayName>
      <Description>Login with your Contoso account</Description>
      <Protocol Name="OpenIdConnect"/>
      <Metadata>
        <Item Key="METADATA">https://your-identity-provider.com/.well-known/openid-configuration</Item>
        <Item Key="client_id">00000000-0000-0000-0000-000000000000</Item>
        <Item Key="response_types">code</Item>
        <Item Key="scope">openid profile</Item>
        <Item Key="response_mode">form_post</Item>
        <Item Key="HttpBinding">POST</Item>
        <Item Key="UsePolicyInRedirectUri">false</Item>
      </Metadata>
      <!-- <CryptographicKeys>
        <Key Id="client_secret" StorageReferenceId="B2C_1A_ContosoSecret"/>
      </CryptographicKeys> -->
      <OutputClaims>
        <OutputClaim ClaimTypeReferenceId="issuerUserId" PartnerClaimType="oid"/>
        <OutputClaim ClaimTypeReferenceId="tenantId" PartnerClaimType="tid"/>
        <OutputClaim ClaimTypeReferenceId="givenName" PartnerClaimType="given_name" />
        <OutputClaim ClaimTypeReferenceId="surName" PartnerClaimType="family_name" />
        <OutputClaim ClaimTypeReferenceId="displayName" PartnerClaimType="name" />
        <OutputClaim ClaimTypeReferenceId="email" PartnerClaimType="email" />
        <OutputClaim ClaimTypeReferenceId="authenticationSource" DefaultValue="socialIdpAuthentication" AlwaysUseDefaultValue="true" />
        <OutputClaim ClaimTypeReferenceId="identityProvider" PartnerClaimType="iss" />
        <OutputClaim ClaimTypeReferenceId="objectId" PartnerClaimType="oid"/>
      </OutputClaims>
      <OutputClaimsTransformations>
        <OutputClaimsTransformation ReferenceId="CreateRandomUPNUserName"/>
        <OutputClaimsTransformation ReferenceId="CreateUserPrincipalName"/>
        <OutputClaimsTransformation ReferenceId="CreateAlternativeSecurityId"/>
        <OutputClaimsTransformation ReferenceId="CreateSubjectClaimFromAlternativeSecurityId"/>
      </OutputClaimsTransformations>
      <UseTechnicalProfileForSessionManagement ReferenceId="SM-SocialLogin"/>
    </TechnicalProfile>
  </TechnicalProfiles>
</ClaimsProvider>

Configurar o provedor de identidade

Todos os provedores de identidade do OpenID Connect descrevem um documento de metadados que contém a maioria das informações necessárias para entrar. Esse documento de metadados inclui informações como as URLs a serem usadas e o local das chaves de assinatura públicas do serviço. O documento de metadados do OpenID Connect sempre está localizado em um ponto de extremidade que termina com .well-known/openid-configuration. Insira a URL de metadados do provedor de identidade do OpenID Connect que você deseja adicionar.

Na URL de Metadados, insira a URL do documento de metadados do OpenID Connect.

Nos metadados do perfil técnico <Item Key="METADATA">, insira a URL do documento de metadados do OpenID Connect.

ID do cliente e segredo

Para permitir que os usuários entrem, o provedor de identidade exige que os desenvolvedores registrem um aplicativo em seus serviços. Este aplicativo tem uma ID que é conhecida como o ID do cliente e um segredo do cliente.

O segredo do cliente é opcional. No entanto, você precisará fornecer um segredo do cliente se o Tipo de resposta for code, que usa o segredo para trocar o código do token.

Para adicionar a ID do cliente e o segredo do cliente, copie esses valores do provedor de identidade e insira-os nos campos correspondentes.

Nos metadados do perfil técnico <Item Key="client_id">, insira a ID do cliente.

Criar uma chave de política

Se o segredo do cliente for necessário, armazene o que você registrou anteriormente no locatário do Azure AD B2C.

Entre no portal do Azure.
Verifique se você está usando o diretório que contém seu locatário do Azure AD B2C. Selecione o filtro Diretório + assinatura na barra de ferramentas do portal.
Na página Configurações do portal | Diretórios + assinaturas, encontre o diretório Azure Active Directory B2C na lista Nome do diretório e, em seguida, selecione Alternar.
Escolha Todos os serviços no canto superior esquerdo do Portal do Azure, pesquise Azure AD B2C e selecione-o.
Na página de Visão Geral, selecione Estrutura de Experiência de Identidade.
Selecione Chaves de Política e, em seguida, escolha Adicionar.
Para Opções, escolha Manual.
Insira um Nome para a chave de política. Por exemplo, ContosoSecret. O prefixo B2C_1A_ será adicionado automaticamente ao nome da chave.
Em Segredo, insira o segredo do cliente que você registrou anteriormente.
Para Uso de chave, selecione Signature.
Clique em Criar.

No elemento XML CryptographicKeys, adicione o seguinte elemento:

<CryptographicKeys>
  <Key Id="client_secret" StorageReferenceId="B2C_1A_ContosoSecret"/>
</CryptographicKeys>

Escopo

O escopo define as informações e as permissões que você deseja coletar do provedor de identidade, por exemplo, openid profile. Para receber o token de ID do provedor de identidade, o escopo openid deve ser especificado.

Sem o token de ID, os usuários não conseguem entrar no Azure AD B2C usando o provedor de identidade personalizado. É possível acrescentar outros escopos separados por espaço. Veja a documentação do provedor de identidade personalizado para saber quais outros escopos podem estar disponíveis.

No Escopo, insira os escopos do provedor de identidade. Por exemplo, openid profile.

Nos metadados de perfil técnico <Item Key="scope">, insira os escopos do provedor de identidade. Por exemplo, openid profile.

Tipo de resposta

O tipo de resposta descreve que tipo de informação é retornada na chamada inicial para o authorization_endpoint do provedor de identidade personalizado. Os seguintes tipos de resposta podem ser usados:

code: conforme o fluxo de código de autorização, um código será retornado ao Azure AD B2C. O Azure AD B2C prossegue para chamar o token_endpoint para trocar o código pelo token.
id_token: um token de ID é devolvido do provedor de identidade personalizado para o Azure AD B2C.

No Tipo de resposta, selecione code ou id_token, de acordo com as configurações do seu provedor de identidade.

Nos metadados do perfil técnico <Item Key="response_types">, selecione code ou id_token, de acordo com as configurações do seu provedor de identidade.

Modo de resposta

O modo de resposta define o método que deve ser usado para retornar os dados do provedor de identidade personalizado para o Azure AD B2C. Os seguintes modos de resposta podem ser usados:

form_post: esse modo de resposta é recomendado para obter a melhor segurança possível. A resposta é transmitida por meio do método HTTP POST, com o código ou o token codificado no corpo usando o formato application/x-www-form-urlencoded.
query: o código ou o token é devolvido como um parâmetro de consulta.

No Modo de resposta, selecione form_post ou query, de acordo com as configurações do seu provedor de identidade.

Nos metadados do perfil técnico <Item Key="response_mode">, selecione form_post ou query, de acordo com as configurações do seu provedor de identidade.

Dica de domínio

A dica de domínio pode ser usada para pular diretamente para a página de entrada do provedor de identidade especificado, em vez de fazer com que o usuário faça uma seleção na lista de provedores de identidade disponíveis.

Para permitir esse tipo de comportamento, insira um valor para a dica de domínio. Para pular para o provedor de identidade personalizado, acrescente o parâmetro domain_hint=<domain hint value> ao final da solicitação ao chamar o Azure AD B2C para entrar.

Na Dica de domínio, insira um nome de domínio usado na dica de domínio.

No elemento XML do perfil técnico <Domain>contoso.com</Domain>, insira um nome de domínio usado na dica de domínio. Por exemplo, contoso.com.

Mapeamento das declarações

Depois que o provedor de identidade personalizado envia um token de ID para o Azure AD B2C, o Azure AD B2C precisa ser capaz de mapear as declarações do token recebido para as declarações que ele reconhece e usa. Para cada um dos seguintes mapeamentos, veja a documentação do provedor de identidade personalizado para entender as declarações que são retornadas nos tokens do provedor de identidade:

ID de usuário: insira a declaração que fornece o identificador exclusivo para o usuário conectado.
Nome de exibição: insira a declaração que fornece o nome de exibição ou o nome completo do usuário.
Nome: insira a declaração que fornece o nome do usuário.
Sobrenome: insira a declaração que fornece o sobrenome do usuário.
Email: insira a declaração que fornece o endereço de email do usuário.

O elemento OutputClaims contém uma lista de declarações retornadas pelo seu provedor de identidade. Mapeie o nome da declaração definida em sua política para o nome definido no provedor de identidade. No elemento <OutputClaims>, configure o atributo PartnerClaimType com o nome da declaração correspondente, conforme definido pelo seu provedor de identidade.

ClaimTypeReferenceId	PartnerClaimType
`issuerUserId`	Insira a declaração que fornece o identificador exclusivo para o usuário conectado.
`displayName`	Insira a declaração que fornece o nome de exibição ou o nome completo do usuário.
`givenName`	Insira a declaração que fornece o nome do usuário.
`surName`	Insira a declaração que fornece o sobrenome do usuário.
`email`	Insira a declaração que fornece o endereço de email do usuário.
`identityProvider`	Insira a declaração que fornece o nome do emissor do token. Por exemplo, `iss`. Se o provedor de identidade não incluir a declaração do emissor no token, defina o atributo `DefaultValue` com um identificador exclusivo do provedor de identidade. Por exemplo, `DefaultValue="contoso.com"`.

Adicionar o provedor de identidade a um fluxo de usuário

No locatário do Azure AD B2C, selecione Fluxos dos usuários.
Clique no fluxo de usuário para o qual você deseja adicionar o provedor de identidade.
Em Provedores de identidade social, selecione o provedor de identidade que você adicionou. Por exemplo, Contoso.
Clique em Salvar.

Testar seu fluxo de usuário

Para testar a política, selecione Executar fluxo de usuário.
Em Aplicativo, selecione o aplicativo Web denominado testapp1 registrado anteriormente. A URL de resposta deve mostrar https://jwt.ms.
Selecione o botão Executar fluxo de usuário.
Na página de inscrição ou de entrada, selecione o provedor de identidade que você deseja entrar. Por exemplo, Contoso.

Se o processo de entrada for bem-sucedido, seu navegador será redirecionado para https://jwt.ms, que exibe o conteúdo do token retornado pelo Azure AD B2C.

Adicione um percurso de usuário

Neste ponto, o provedor de identidade foi configurado, mas ainda não está disponível em nenhuma das páginas de entrada. Se você não tiver seu próprio percurso de usuário personalizado, crie a duplicata de um percurso de usuário de um modelo existente; caso contrário, passe para a próxima etapa.

Abra o arquivo TrustFrameworkBase.xml do starter pack.
Localize e copie todo o conteúdo do elemento UserJourney que inclui Id="SignUpOrSignIn".
Abra o TrustFrameworkExtensions.xml e localize o elemento UserJourneys. Se o elemento não existir, adicione um.
Cole todo o conteúdo do elemento UserJourney que você copiou como filho do elemento UserJourneys.
Renomeie a ID do percurso de usuário. Por exemplo, Id="CustomSignUpSignIn".

Adicione o provedor de identidade a um percurso de usuário

Agora que você tem um percurso de usuário, adicione a ele o novo provedor de identidade. Primeiro, adicione um botão de entrada e, em seguida, vincule o botão a uma ação. A ação é o perfil técnico criado anteriormente.

No percurso de usuário, localize o elemento da etapa de orquestração que inclui Type="CombinedSignInAndSignUp" ou Type="ClaimsProviderSelection". Normalmente é a primeira etapa de orquestração. O elementoClaimsProviderSelectionscontém uma lista de provedores de identidade que um usuário pode usar para se conectar. A ordem dos elementos controla a ordem dos botões de entrada apresentados para o usuário. Adicione um elemento XML ClaimsProviderSelection. Defina o valor de TargetClaimsExchangeId com um nome amigável.
Na próxima etapa de orquestração, adicione um elemento ClaimsExchange. Defina a ID com o valor da ID de troca de declarações de destino. Atualize o valor de TechnicalProfileReferenceId para a ID do perfil técnico criado anteriormente.

O XML a seguir demonstra as duas primeiras etapas de orquestração de um percurso do usuário com o provedor de identidade:

<OrchestrationStep Order="1" Type="CombinedSignInAndSignUp" ContentDefinitionReferenceId="api.signuporsignin">
  <ClaimsProviderSelections>
    ...
    <ClaimsProviderSelection TargetClaimsExchangeId="ContosoExchange" />
  </ClaimsProviderSelections>
  ...
</OrchestrationStep>

<OrchestrationStep Order="2" Type="ClaimsExchange">
  ...
  <ClaimsExchanges>
    <ClaimsExchange Id="ContosoExchange" TechnicalProfileReferenceId="Contoso-OpenIdConnect" />
  </ClaimsExchanges>
</OrchestrationStep>

Configurar a política de terceira parte confiável

A política de terceira parte confiável, por exemplo SignUpSignIn.xml, especifica a jornada do usuário que o Azure AD B2C será executado. Localize o elemento DefaultUserJourney na terceira parte confiável. Atualize a ReferenceId para corresponder à ID do percurso do usuário, na qual você adicionou o provedor de identidade.

No exemplo a seguir, para o percurso do CustomSignUpSignIn usuário, o ReferenceId é definido como CustomSignUpSignIn:

<RelyingParty>
  <DefaultUserJourney ReferenceId="CustomSignUpSignIn" />
  ...
</RelyingParty>

Carregar a política personalizada

Entre no portal do Azure.
Selecione o ícone Diretório + Assinatura na barra de ferramentas do portal e selecione o diretório que contém o locatário do Azure AD B2C.
No portal do Azure, pesquise e selecione Azure AD B2C.
Em Políticas, selecione Identity Experience Framework.
Selecione Carregar política personalizadae, em seguida, carregue os dois arquivos de política que você alterou, na seguinte ordem: a política de extensão, por exemplo TrustFrameworkExtensions.xml, a política de terceira parte confiável, como SignUpSignIn.xml.

Selecione a política de terceira parte confiável, por exemplo, B2C_1A_signup_signin.
Em Aplicativo, selecione o aplicativo Web que você registrou anteriormente. A URL de resposta deve mostrar https://jwt.ms.
Selecione o botão Executar agora.
Na página de inscrição ou entrada, selecione Contoso para entrar com a conta do Google.

Se o processo de entrada for bem-sucedido, seu navegador será redirecionado para https://jwt.ms, que exibe o conteúdo do token retornado pelo Azure AD B2C.

Problemas conhecidos

O Azure AD B2C não dá suporte a JWE (Criptografia Web JSON) para trocar tokens criptografados com provedores de identidade de conexão OpenID.

Próximas etapas

Para obter mais informações, confira o guia de referência do perfil técnico do OpenId Connect.

Compartilhar via

Pré-requisitos

Adicionar o provedor de identidade

Configurar o provedor de identidade

ID do cliente e segredo

Criar uma chave de política

Escopo

Tipo de resposta

Modo de resposta

Dica de domínio

Mapeamento das declarações

Adicionar o provedor de identidade a um fluxo de usuário

Testar seu fluxo de usuário

Adicione um percurso de usuário

Adicione o provedor de identidade a um percurso de usuário

Configurar a política de terceira parte confiável

Carregar a política personalizada

Problemas conhecidos

Próximas etapas

Comentários

Recursos adicionais

Compartilhar via

Configurar a inscrição e entrada com o OpenID Connect genérico usando o Azure Active Directory B2C

Pré-requisitos

Adicionar o provedor de identidade

Configurar o provedor de identidade

ID do cliente e segredo

Criar uma chave de política

Escopo

Tipo de resposta

Modo de resposta

Dica de domínio

Mapeamento das declarações

Adicionar o provedor de identidade a um fluxo de usuário

Testar seu fluxo de usuário

Adicione um percurso de usuário

Adicione o provedor de identidade a um percurso de usuário

Configurar a política de terceira parte confiável

Carregar a política personalizada

Problemas conhecidos

Próximas etapas

Comentários

Recursos adicionais