Compartilhar via

Proteger aplicativos Java Spring Boot usando o Azure Active Directory B2C

  • Artigo

Este artigo demonstra um aplicativo Web Java Spring Boot que conecta usuários em seu locatário do Azure Active Directory B2C usando a biblioteca de cliente Spring Boot Starter do Azure AD B2C para Java. Ele usa o protocolo OpenID Connect.

O diagrama a seguir mostra a topologia do aplicativo:

Diagrama que mostra a topologia do aplicativo.

O aplicativo cliente usa a biblioteca de cliente Spring Boot Starter do Azure AD B2C para Java para entrar em um usuário e obter um token de ID do Azure AD B2C. O token de ID prova que o usuário está autenticado com o Azure AD B2C e permite que o usuário acesse rotas protegidas.

Pré-requisitos

Recomendações

  • Alguma familiaridade com o Spring Framework
  • Alguma familiaridade com o terminal Linux/OSX ou o Windows PowerShell
  • jwt.ms para inspecionar seus tokens.
  • Fiddler para monitorar sua atividade de rede e solução de problemas.
  • Siga o Blog do Microsoft Entra ID para se manter atualizado com os desenvolvimentos mais recentes.

Configurar o exemplo

As seções a seguir mostram como configurar o aplicativo de exemplo.

Clonar ou fazer download do repositório de exemplo

Para clonar o exemplo, abra uma janela Bash e use o seguinte comando:

git clone https://github.com/Azure-Samples/ms-identity-msal-java-samples.git
cd 4-spring-web-app/1-Authentication/sign-in-b2c

Como alternativa, navegue até o repositório ms-identity-msal-java-samples e, em seguida, baixe-o como um arquivo .zip e extraia-o para o disco rígido.

Importante

Para evitar limitações de comprimento de caminho de arquivo no Windows, clone ou extraia o repositório em um diretório próximo à raiz do disco rígido.

Este exemplo vem com um aplicativo pré-registrado para fins de demonstração. Se você quiser usar seu próprio locatário e aplicativo do Azure AD B2C, registre e configure o aplicativo no portal do Azure. Para obter mais informações, consulte a seção Registrar o aplicativo . Caso contrário, continue com as etapas na seção Executar o exemplo .

Escolha o locatário do Azure AD B2C onde você deseja criar seus aplicativos

Para escolher seu locatário, use as seguintes etapas:

  1. Entre no portal do Azure.

  2. Se sua conta estiver presente em mais de um locatário do Azure AD B2C, selecione seu perfil no canto do portal do Azure e selecione Alternar diretório para alterar sua sessão para o locatário B2C do Azure AD desejado.

Criar fluxos de usuário e políticas personalizadas

Para criar fluxos de usuário comuns, como inscrição, entrada, edição de perfil e redefinição de senha, consulte Tutorial: Criar fluxos de usuário no Azure Active Directory B2C.

Você também deve considerar a criação de políticas personalizadas no Azure Active Directory B2C. No entanto, essa tarefa está além do escopo deste tutorial. Para obter mais informações, consulte Visão geral da política personalizada do Azure AD B2C.

Adicionar provedores de identidade externos

Consulte Tutorial: Adicionar provedores de identidade aos seus aplicativos no Azure Active Directory B2C.

Registrar o aplicativo (java-spring-webapp-auth-b2c)

Para registrar o aplicativo, use as seguintes etapas:

  1. Navegue até o portal do Azure e selecione Azure AD B2C.

  2. Selecione Registros de aplicativo no painel de navegação e selecione Novo registro.

  3. Na página Registrar um aplicativo que aparece, insira as seguintes informações de registro de aplicativo:

    • Na seção Nome, insira um nome de aplicativo significativo para exibição aos usuários do aplicativo - por exemplo, java-spring-webapp-auth-b2c.
    • Em Tipos de conta com suporte, selecione Contas em qualquer provedor de identidade ou diretório organizacional (para autenticar usuários com fluxos de usuário).
    • Na seção Redirecionar URI (opcional), selecione Web na caixa de combinação e insira o seguinte URI de redirecionamento: http://localhost:8080/login/oauth2/code/.

  4. Selecione Registrar para criar o aplicativo.

  5. Na página de registro do aplicativo, localize e copie o valor de ID do aplicativo (cliente) para usar mais tarde. Use esse valor no(s) arquivo(s) de configuração do seu aplicativo.

  6. Selecione Salvar para salvar as alterações.

  7. Na página de registro do aplicativo, selecione o painel Certificados e segredos no painel de navegação para abrir a página para gerar segredos e carregar certificados.

  8. Na seção Segredos do Cliente, escolha Novo Segredo do Cliente.

  9. Digite uma descrição - por exemplo, segredo do aplicativo.

  10. Selecione uma das durações disponíveis de acordo com suas preocupações de segurança - por exemplo, Em 2 anos.

  11. Selecione Adicionar. O valor gerado é exibido.

  12. Copie e salve o valor gerado para uso em etapas posteriores. Você precisa desse valor para os arquivos de configuração do código. Esse valor não é exibido novamente e você não pode recuperá-lo por nenhum outro meio. Portanto, certifique-se de salvá-lo do portal do Azure antes de navegar para qualquer outra tela ou painel.

Configurar o aplicativo (java-spring-webapp-auth-b2c) para usar o registro do aplicativo

Use as seguintes etapas para configurar o aplicativo:

Observação

Nas etapas a seguir, ClientID é o mesmo que Application ID ou AppId.

  1. Abra o projeto em seu IDE.

  2. Abra o arquivo src/main/resources/application.yml .

  3. Localize a client-id propriedade e substitua o valor existente pela ID do aplicativo ou clientId do java-spring-webapp-auth-b2c aplicativo no portal do Azure.

  4. Localize a client-secret propriedade e substitua o valor existente pelo valor que você salvou durante a criação do aplicativo no portal do java-spring-webapp-auth-b2c Azure.

  5. Localize a base-uri propriedade e substitua as duas instâncias do valor fabrikamb2c pelo nome do locatário do Azure AD B2C no qual você criou o java-spring-webapp-auth-b2c aplicativo no portal do Azure.

  6. Localize a sign-up-or-sign-in propriedade e substitua-a pelo nome da política de fluxo de usuário de inscrição/entrada que você criou no locatário do Azure AD B2C no qual você criou o java-spring-webapp-auth-b2c aplicativo no portal do Azure.

  7. Localize a profile-edit propriedade e substitua-a pelo nome da política de fluxo de usuário de redefinição de senha criada no locatário do Azure AD B2C no qual você criou o java-spring-webapp-auth-b2c aplicativo no portal do Azure.

  8. Localize a password-reset propriedade e substitua-a pelo nome da política de fluxo de usuário de perfil de edição que você criou no locatário do Azure AD B2C no qual você criou o java-spring-webapp-auth-b2c aplicativo no portal do Azure.

  9. Abra o arquivo src/main/resources/templates/navbar.html.

  10. Encontre as referências aos b2c_1_susi fluxos e b2c_1_edit_profile substitua-os pelos seus sign-up-sign-in fluxos e profile-edit usuários.

Execute o exemplo

As seções a seguir mostram como implantar o exemplo nos Aplicativos Spring do Azure.

Pré-requisitos

Preparar o projeto Spring

Use as etapas a seguir para preparar o projeto:

  1. Use o comando Maven a seguir para criar o projeto:

    mvn clean package

  2. Execute o projeto de exemplo localmente usando o seguinte comando:

    mvn spring-boot:run

Configurar o plug-in do Maven

Execute o seguinte comando na raiz do projeto para configurar o aplicativo usando o plug-in Maven para Aplicativos Spring do Azure:

mvn com.microsoft.azure:azure-spring-apps-maven-plugin:1.19.0:config

A lista a seguir descreve as interações de comando:

  • Logon OAuth2: você precisa autorizar a entrada no Azure com base no protocolo OAuth2.
  • Selecione assinatura: selecione o número da lista de assinaturas onde você deseja criar sua instância do Azure Spring Apps, que tem como padrão a primeira assinatura da lista. Se você quiser usar o número padrão, pressione Enter.
  • Insira o nome dos Aplicativos Spring do Azure: insira o nome da instância de aplicativos Spring que você deseja criar. Se você quiser usar o nome padrão, pressione Enter.
  • Insira o nome do grupo de recursos: insira o nome do grupo de recursos no qual você deseja criar sua instância de aplicativos de primavera. Se você quiser usar o nome padrão, pressione Enter.
  • Skus: Selecione a SKU que você deseja usar para sua instância de aplicativos spring. Se você quiser usar o número padrão, pressione Enter.
  • Inserir o nome do aplicativo (demonstração): forneça um nome de aplicativo. Se você quiser usar a ID de artefato de projeto padrão, pressione Enter.
  • Tempos de execução: selecione o tempo de execução que você deseja usar para sua instância de aplicativos de primavera. Nesse caso, você deve usar o número padrão, então pressione Enter.
  • Expo o acesso público para esse aplicativo (boot-for-azure): pressione Y.
  • Confirme para salvar todas as configurações acima: pressione S. Se você pressionar n, a configuração não será salva no arquivo .pom .

O exemplo a seguir mostra a saída do processo de implantação:

Summary of properties:
Subscription id   : 12345678-1234-1234-1234-123456789101
Resource group name : rg-ms-identity-spring-boot-webapp
Azure Spring Apps name : cluster-ms-identity-spring-boot-webapp
Runtime Java version : Java 11
Region            : eastus
Sku               : Standard
App name          : ms-identity-spring-boot-webapp
Public access     : true
Instance count/max replicas : 1
CPU count         : 1
Memory size(GB)   : 2
Confirm to save all the above configurations (Y/n):
[INFO] Configurations are saved to: /home/user/ms-identity-msal-java-samples/4-spring-web-app/1-Authentication/sign-in/pom.    xml
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  01:57 min
[INFO] Finished at: 2024-02-14T13:50:44Z
[INFO] ------------------------------------------------------------------------

Depois de confirmar suas escolhas, o plug-in adiciona o elemento de plug-in e as configurações necessárias ao arquivo de pom.xml do projeto para configurar seu aplicativo para ser executado nos Aplicativos Spring do Azure.

A parte relevante do arquivo pom.xml deve ser semelhante ao exemplo a seguir:

<plugin>
    <groupId>com.microsoft.azure</groupId>
    <artifactId>azure-spring-apps-maven-plugin</artifactId>
    <version>1.19.0</version>
    <configuration>
        <subscriptionId>12345678-1234-1234-1234-123456789101</subscriptionId>
        <resourceGroup>rg-ms-identity-spring-boot-webapp</resourceGroup>
        <clusterName>cluster-ms-identity-spring-boot-webapp</clusterName>
        <region>eastus</region>
        <sku>Standard</sku>
        <appName>ms-identity-spring-boot-webapp</appName>
        <isPublic>true</isPublic>
        <deployment>
            <cpu>1</cpu>
            <memoryInGB>2</memoryInGB>
            <instanceCount>1</instanceCount>
            <runtimeVersion>Java 11</runtimeVersion>
            <resources>
                <resource>
                    <directory>${project.basedir}/target</directory>
                    <includes>
                        <include>*.jar</include>
                    </includes>
                </resource>
            </resources>
        </deployment>
    </configuration>
</plugin>

Você pode modificar as configurações dos Aplicativos Spring do Azure diretamente em seu arquivo pom.xml . Algumas configurações comuns são listadas na tabela a seguir:

Propriedade Obrigatório Descrição
subscriptionId false A ID da assinatura.
resourceGroup true O grupo de recursos do Azure para sua instância do Azure Spring Apps.
clusterName true O nome do cluster do Azure Spring Apps. Caso você esteja usando uma assinatura e um grupo de recursos que já tenham uma instância do Azure Spring Apps implantada, você também pode usar esse cluster existente para implantar.
appName true O nome do seu aplicativo no Azure Spring Apps.
region false A região na qual hospedar sua instância do Azure Spring Apps. O valor padrão é eastus. Para regiões válidas, consulte Regiões com suporte.
sku false A camada de preços para sua instância do Azure Spring Apps. O valor padrão é Basic, que é adequado apenas para ambientes de desenvolvimento e teste.
runtime false A configuração do ambiente de tempo de execução. Para mais informações, confira Informações de configuração.
deployment false Configuração de implantação. Para mais informações, confira Informações de configuração.

Para obter a lista completa de configurações, veja a documentação de referência do plug-in. Todos os plug-ins do Azure Maven compartilham um conjunto comum de configurações. Para essas configurações, consulte Configurações comuns. Para configurações específicas dos Aplicativos Spring do Azure, consulte Aplicativos Spring do Azure: Detalhes de Configuração.

Certifique-se de guardar os clusterName valores e appName para uso posterior.

Preparar o aplicativo para implantação

Quando você implanta seu aplicativo nos Aplicativos Spring do Azure, sua URL de redirecionamento muda para a URL de redirecionamento da instância do aplicativo implantado nos Aplicativos Spring do Azure. Use as seguintes etapas para alterar essas configurações no arquivo application.yml :

  1. Navegue até o arquivo src\main\resources\application.yml do aplicativo e altere o valor do nome de domínio do post-logout-redirect-uri aplicativo implantado, conforme mostrado no exemplo a seguir. Por exemplo, se você escolheu cluster-ms-identity-spring-boot-webapp sua instância do Azure Spring Apps na etapa anterior e ms-identity-spring-boot-webapp o nome do seu aplicativo, agora você deve usar https://cluster-ms-identity-spring-boot-webapp-ms-identity-spring-boot-webapp.azuremicroservices.io para o post-logout-redirect-uri valor.

    post-logout-redirect-uri: https://<cluster-name>-<app-name>.azuremicroservices.io

  2. Depois de salvar esse arquivo, use o seguinte comando para recriar seu aplicativo:

    mvn clean package

Importante

O arquivo application.yml do aplicativo atualmente contém o valor do segredo do cliente no client-secret parâmetro. Não é uma boa prática manter esse valor neste arquivo. Você também pode estar correndo um risco se confirmá-lo em um repositório Git.

Como uma etapa de segurança extra, você pode armazenar esse valor no Cofre de Chaves do Azure e carregar o segredo do Cofre de Chaves para disponibilizá-lo em seu aplicativo.

Atualizar o registro do aplicativo Microsoft Entra ID

Como o URI de redirecionamento é alterado para seu aplicativo implantado no Azure Spring Apps, você também precisa alterar o URI de redirecionamento no registro do aplicativo Microsoft Entra ID. Use as seguintes etapas para fazer essa alteração:

  1. Navegue até a página de registros de aplicativo da plataforma de identidade da Microsoft para desenvolvedores.

  2. Use a caixa de pesquisa para pesquisar o registro do aplicativo - por exemplo, java-servlet-webapp-authentication.

  3. Abra o registro do aplicativo selecionando seu nome.

  4. Selecione Autenticação no menu.

  5. Na seção Redirecionar URIs da Web - , selecione Adicionar URI.

  6. Preencha o URI do seu aplicativo, anexando /login/oauth2/code/ - por exemplo, https://<cluster-name>-<app-name>.azuremicroservices.io/login/oauth2/code/.

  7. Selecione Salvar.

Implantar o aplicativo

Use o seguinte comando para implantar o aplicativo:

mvn azure-spring-apps:deploy

A lista a seguir descreve a interação de comando:

  • Logon OAuth2: você precisa autorizar a entrada no Azure com base no protocolo OAuth2.

Depois que o comando for executado, você poderá pelas mensagens de log que a implantação foi bem-sucedida:

[INFO] Deployment(default) is successfully created
[INFO] Starting Spring App after deploying artifacts...
[INFO] Deployment Status: Running
[INFO]   InstanceName:demo-default-x-xxxxxxxxxx-xxxxx  Status:Running Reason:null       DiscoverStatus:UNREGISTERED
[INFO]   InstanceName:demo-default-x-xxxxxxxxx-xxxxx  Status:Terminating Reason:null       DiscoverStatus:UNREGISTERED
[INFO] Getting public url of app(demo)...
[INFO] Application url: https://<your-Azure-Spring-Apps-instance-name>-demo.azuremicroservices.io

Validar o aplicativo

Após a conclusão da implantação, acesse o aplicativo com a URL do aplicativo de saída. Use as seguintes etapas para verificar o log do aplicativo a fim de investigar qualquer problema de implantação:

  1. Acesse a URL do aplicativo de saída na página Saídas da seção Implantação .

  2. No painel de navegação da página Visão geral da instância de Aplicativos Spring do Azure, selecione Logs para verificar os logs do aplicativo.

Explorar o exemplo

Use as seguintes etapas para explorar o exemplo:

  1. Observe o status de entrada ou saída exibido no centro da tela.
  2. Selecione o botão sensível ao contexto no canto. Esse botão lê Entrar quando você executa o aplicativo pela primeira vez. Como alternativa, selecione o link para detalhes do token. Como essa página é protegida e requer autenticação, você será redirecionado automaticamente para a página de entrada.
  3. Na próxima página, siga as instruções e inicie sessão com uma conta do fornecedor de identidade escolhido. Você também pode optar por se inscrever ou entrar em uma conta local no locatário B2C usando um endereço de e-mail.
  4. Após a conclusão bem-sucedida do fluxo de entrada, você deve ser redirecionado para a página inicial - que mostra o status de entrada - ou para a página de detalhes do token, dependendo de qual botão acionou seu fluxo de entrada.
  5. Observe que o botão sensível ao contexto agora diz Sair e exibe seu nome de usuário.
  6. Se você estiver na página inicial, selecione Detalhes do token de ID para ver algumas das declarações decodificadas do token de ID.
  7. Edite seu perfil. Selecione editar perfil para alterar detalhes como seu nome para exibição, local de residência e profissão.
  8. Use o botão no canto para sair. A página de status reflete o novo estado.

Observações sobre o código

Este exemplo demonstra como usar a biblioteca de cliente Spring Boot Starter do Azure AD B2C para Java para entrar usuários em seu locatário do Azure AD B2C. O exemplo também usa os iniciadores de inicialização Spring Oauth2 Client e Spring Web. O exemplo usa declarações do token de ID obtido do Azure AD B2C para exibir os detalhes do usuário conectado.

Contents

A tabela a seguir mostra o conteúdo da pasta de projeto de exemplo:

Arquivo/pasta Descrição
pom.xml Dependências do aplicativo.
src/main/recursos/modelos/ Modelos Thymeleaf para interface do usuário.
src/main/recursos/application.yml Configuração do aplicativo e da biblioteca Microsoft Entra Boot Starter.
src/main/java/com/microsoft/azuresamples/msal4j/msidentityspringbootwebapp/ Esse diretório contém o ponto de entrada do aplicativo principal, o controlador e as classes de configuração.
.../MsIdentitySpringBootWebappApplication.java Classe principal.
.../SampleController.java Controller com mapeamentos de endpoint.
.../SecurityConfig.java Configuração de segurança - por exemplo, quais rotas exigem autenticação.
.../Utilities.java Classe de utilitário - por exemplo, declarações de token de ID de filtro.
CHANGELOG.md Lista de alterações à amostra.
CONTRIBUTING.md Orientações para contribuição à amostra.
LICENÇA A licença para a amostra.

Declarações de token de ID

Para extrair detalhes do token, o aplicativo usa o objeto e OidcUser o Spring Security AuthenticationPrincipal em um mapeamento de solicitação, conforme mostrado no exemplo a seguir. Consulte o Controlador de Exemplo para obter detalhes completos de como este aplicativo faz uso de declarações de token de ID.

import org.springframework.security.oauth2.core.oidc.user.OidcUser;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
//...
@GetMapping(path = "/some_path")
public String tokenDetails(@AuthenticationPrincipal OidcUser principal) {
    Map<String, Object> claims = principal.getIdToken().getClaims();
}

Para entrar, o aplicativo faz uma solicitação para o ponto de extremidade de entrada do Azure AD B2C configurado automaticamente pela biblioteca de cliente Spring Boot Starter do Azure AD B2C para Java, conforme mostrado no exemplo a seguir:

<a class="btn btn-success" href="/oauth2/authorization/{your-sign-up-sign-in-user-flow}">Sign In</a>

Para sair, o aplicativo faz uma solicitação POST para o logout ponto de extremidade, conforme mostrado no exemplo a seguir:

<form action="#" th:action="@{/logout}" method="post">
  <input class="btn btn-warning" type="submit" value="Sign Out" />
</form>

Elementos de interface do usuário dependentes de autenticação

O aplicativo tem uma lógica simples nas páginas de modelo da interface do usuário para determinar o conteúdo a ser exibido com base no fato de o usuário estar autenticado, conforme mostrado no exemplo a seguir usando as tags Thymeleaf do Spring Security:

<div sec:authorize="isAuthenticated()">
  this content only shows to authenticated users
</div>
<div sec:authorize="isAnonymous()">
  this content only shows to not-authenticated users
</div>

Proteger rotas com WebSecurityConfigurerAdapter

Por padrão, o aplicativo protege a página Detalhes do Token de ID para que apenas usuários conectados possam acessá-la. O aplicativo configura essas rotas a partir da app.protect.authenticated propriedade do arquivo application.yml. Para configurar os requisitos específicos do seu aplicativo, você pode estender WebSecurityConfigurerAdapter em uma de suas classes. Para obter um exemplo, consulte a classe SecurityConfig deste aplicativo, mostrada no código a seguir:

@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Value("${app.protect.authenticated}")
    private String[] protectedRoutes;

    private final AADB2COidcLoginConfigurer configurer;

    public SecurityConfig(AADB2COidcLoginConfigurer configurer) {
        this.configurer = configurer;
    }

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        // @formatter:off
        http.authorizeRequests()
            .antMatchers(protectedRoutes).authenticated()     // limit these pages to authenticated users (default: /token_details)
            .antMatchers("/**").permitAll()                  // allow all other routes.
            .and()
            .apply(configurer)
            ;
        // @formatter:off
    }
}

Mais informações

Para obter mais informações sobre como os protocolos OAuth 2.0 funcionam nesse cenário e em outros cenários, consulte Cenários de autenticação para Microsoft Entra ID.