Habilitar aplicativos Java Spring Boot para conectar usuários e acessar o Microsoft Graph

Este artigo apresenta um aplicativo Web Java Spring Boot que conecta usuários e obtém um token de acesso para chamar o Microsoft Graph. Ele usa a biblioteca de clientes do Microsoft Entra ID Spring Boot Starter para Java para autenticação, autorização e aquisição de token. Ele usa o SDK do Microsoft Graph para Java para obter dados do Graph.

O diagrama a seguir mostra a topologia do aplicativo:

O aplicativo usa a biblioteca de clientes do Microsoft Entra ID Spring Boot Starter para Java para obter um token de acesso para o Microsoft Graph do Microsoft Entra ID. O token de acesso confirma que o usuário está autorizado a acessar o ponto de extremidade de API do Microsoft Graph, conforme definido no escopo.

Pré-requisitos

• Versão 15 do JDK: Este exemplo foi desenvolvido em um sistema com Java 15, mas pode ser compatível com outras versões.
• Maven 3
• O Pacote de extensão Java para Visual Studio Code é recomendado para executar este exemplo no Visual Studio Code.
• Um locatário do Microsoft Entra ID. Para obter mais informações, consulte Como obter um locatário do Microsoft Entra ID.
• Uma conta de usuário no seu locatário do Microsoft Entra ID. Este exemplo não funciona com uma conta pessoal da Microsoft. Portanto, se você tiver conectado no portal do Azure com uma conta pessoal e não tiver uma conta de usuário em seu diretório, será necessário criar uma agora.
• Código do Visual Studio
• Ferramentas do Azure para o Visual Studio Code

Recomendações

• Alguma familiaridade com o Spring Framework.
• Alguma familiaridade com o terminal Linux/OSX.
• jwt.ms para inspecionar seus tokens.
• Fiddler para monitorar sua atividade de rede e solução de problemas.
• Siga o Blog do Microsoft Entra para ficar up-to-date com os desenvolvimentos mais recentes.

Configurar o exemplo

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

Clone ou baixe o repositório de exemplo.

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

git clone https://github.com/Azure-Samples/ms-identity-msal-java-samples.git
cd 4-spring-web-app/2-Authorization-I/call-graph

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

Registrar os aplicativos de exemplo com seu locatário do Microsoft Entra ID

Há um projeto neste exemplo. As seções a seguir mostram como registrar o aplicativo usando o portal do Azure.

Escolha o locatário do Microsoft Entra ID no qual você deseja criar seus aplicativos

Siga as etapas a seguir para escolher o locatário:

1. Entre no portal do Azure.

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

Registrar o aplicativo (java-spring-webapp-call-graph)

Para registrar o aplicativo, use estas etapas:

1. Navegue até o portal do Azure e selecione Microsoft Entra ID.

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 do aplicativo:

   • Na seção Nome, insira um nome de aplicativo relevante para exibição aos usuários do aplicativo: por exemplo, java-spring-webapp-call-graph.
   • Em Tipos de contas com suporte, selecione Contas somente neste diretório organizacional.
   • Na seção URI de redirecionamento (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 do ID do aplicativo (cliente) para uso posterior. Use esse valor no(s) arquivo(s) de configuração do aplicativo.

6. Na página de registo do aplicativo, selecione Segredos de certificados & no painel de navegação para abrir a página em que possa gerar segredos e carregar certificados.

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

8. Insira uma descrição, por exemplo, segredo do aplicativo.

9. Selecione uma das durações disponíveis: Em 1 ano, Em 2 anos ou Nunca expira.

10. Selecione Adicionar. O valor gerado é exibido.

11. Copie e salve o valor gerado para uso nas etapas posteriores. Esse valor é necessário para os arquivos de configuração do código. Esse valor não é exibido novamente e você não pode recuperá-lo por outros meios. Portanto, salve-o no portal do Azure antes de navegar para qualquer outra tela ou painel.

12. Na página de registro do aplicativo, selecione o painel de Permissões de API no painel de navegação para abrir a página de acesso às APIs de que o aplicativo precisa.

13. Selecione Adicionar permissões e selecione a guia APIs da Microsoft.

14. Na seção APIs da Microsoft frequentemente utilizadas, selecione Microsoft Graph.

15. Na seção Permissões delegadas, selecione User.Read da lista. Use a caixa de pesquisa, se necessário.

16. Selecione Adicionar Permissões.

Configure o aplicativo (java-spring-webapp-call-graph) para usar o registro do aplicativo

Use as seguintes etapas para configurar o aplicativo:

1. Abrir o projeto no seu IDE.

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

3. Localize o espaço reservado Enter_Your_Tenant_ID_Here e substitua o valor existente pela ID de locatário do Microsoft Entra.

4. Localize o espaço reservado Enter_Your_Client_ID_Here e substitua o valor existente pelo ID do aplicativo ou clientId do aplicativo java-spring-webapp-call-graph copiado do portal do Azure.

5. Localize o espaço reservado Enter_Your_Client_Secret_Here e substitua o valor existente pelo valor que você salvou durante a criação do java-spring-webapp-call-graph copiado do portal do Azure.

Execute o exemplo

az login

az upgrade

az extension add --name containerapp --upgrade

az extension add --name containerapp --upgrade --allow-preview true

az provider register --namespace Microsoft.App
az provider register --namespace Microsoft.OperationalInsights

export RESOURCE_GROUP="ms-identity-containerapps"
export LOCATION="canadacentral"
export ENVIRONMENT="env-ms-identity-containerapps"
export API_NAME="ms-identity-api"
export JAR_FILE_PATH_AND_NAME="./target/ms-identity-spring-boot-webapp-0.0.1-SNAPSHOT.jar"

az group create  \
    --name $RESOURCE_GROUP \
    --location $LOCATION \

az containerapp env create \
    --name $ENVIRONMENT \
    --resource-group $RESOURCE_GROUP \
    --location $LOCATION

az containerapp env show \
    --name $ENVIRONMENT \
    --resource-group $RESOURCE_GROUP \
    --query properties.defaultDomain

az containerapp up \
    --name $API_NAME \
    --resource-group $RESOURCE_GROUP \
    --location $LOCATION \
    --environment $ENVIRONMENT \
    --artifact <JAR_FILE_PATH_AND_NAME> \
    --ingress external \
    --target-port 8080 \
    --query properties.configuration.ingress.fqdn

Explorar o exemplo

Use as seguintes etapas para explorar o exemplo:

1. Observe o status de conectado ou desconectado exibido no centro da tela.
2. Selecione o botão contextual no canto. Esse botão lê Entrar quando você executa o aplicativo pela primeira vez. Como alternativa, selecione detalhes do token ou gráfico de chamadas. Como essa página é protegida e requer autenticação, você é redirecionado automaticamente para a página de entrada.
3. Na próxima página, siga as instruções e conecte-se com uma conta no locatário do Microsoft Entra ID.
4. Na tela de consentimento, observe os escopos que estão sendo solicitados.
5. Após a conclusão bem-sucedida do fluxo de entrada, você deverá ser redirecionado para a página inicial, que mostra o status de entrada ou uma das outras páginas, dependendo do botão que acionou o fluxo de entrada.
6. Observe que o botão contextual agora diz Sair e exibe seu nome de usuário.
7. Se você estiver na página inicial, selecione Detalhes do token de ID para ver algumas das declarações decodificadas do token de ID.
8. Selecione Chamar o Graph para chamar o ponto de extremidade do Microsoft Graph /me endpoint e ver uma seleção dos detalhes do usuário obtidos.
9. 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 apresenta como usar a biblioteca de clientes do Spring Boot Starter da ID do Microsoft Entra para Java para conectar usuários ao locatário da ID do Microsoft Entra e obter um token de acesso para chamar o Microsoft Graph. O exemplo também usa o Spring Oauth2 Client e os iniciadores da inicialização do Spring Web.

Conteúdos

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

Declarações de token de ID

Para extrair detalhes do token, o aplicativo usa o objeto do Spring Security AuthenticationPrincipal e OidcUser em um mapeamento de solicitação, conforme mostra o exemplo a seguir. Consulte o Controlador de Exemplo para obter todos os detalhes de como esse aplicativo usa 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();
}

Links de entrada e saída

Para entrar, o aplicativo faz uma solicitação ao ponto de extremidade de entrada do Microsoft Entra ID configurado automaticamente pela biblioteca cliente Spring Boot Starter do Microsoft Entra ID para Java, conforme mostra o exemplo a seguir:

<a class="btn btn-success" href="/oauth2/authorization/azure">Sign In</a>

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

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

Elementos de IU dependentes de autenticação

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

<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 AADWebSecurityConfigurerAdapter

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

@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfig extends AADWebSecurityConfigurerAdapter{
  @Value( "${app.protect.authenticated}" )
  private String[] protectedRoutes;

    @Override
    public void configure(HttpSecurity http) throws Exception {
    // use required configuration form AADWebSecurityAdapter.configure:
    super.configure(http);
    // add custom configuration:
    http.authorizeRequests()
      .antMatchers(protectedRoutes).authenticated()     // limit these pages to authenticated users (default: /token_details, /call_graph)
      .antMatchers("/**").permitAll();                  // allow all other routes.
    }
}

Chamar Graph

Quando o usuário navega para /call_graph, o aplicativo cria uma instância do GraphServiceClient usando um Oauth2AuthorizedClient ou graphAuthorizedClient que o iniciador de inicialização do Microsoft Entra ID preparou. O aplicativo solicita que o GraphServiceClient chame o ponto de extremidade /me e exibe detalhes do usuário conectado atual. GraphServiceClient é do SDK do Microsoft Graph para Java, v3.

O Oauth2AuthorizedClient deve ser preparado com os escopos corretos. Consulte o arquivo application.yml e a seção Escopos a seguir. O Oauth2AuthorizedClient é usado para exibir o token de acesso e colocá-lo no cabeçalho Authorization de solicitações GraphServiceClient, conforme mostra o exemplo a seguir:

//see SampleController.java
@GetMapping(path = "/call_graph")
public String callGraph(@RegisteredOAuth2AuthorizedClient("graph") OAuth2AuthorizedClient graphAuthorizedClient) {
  // See the Utilities.graphUserProperties() method for the full example of the following operation:
  GraphServiceClient graphServiceClient = Utilities.getGraphServiceClient(graphAuthorizedClient);
  User user = graphServiceClient.me().buildRequest().get();
  return user.displayName;
}

O exemplo a seguir do arquivo application.yml mostra os escopos solicitados:

# see application.yml file
authorization-clients:
  graph:
    # Specifies the Microsoft Graph scopes that your app needs access to:
    scopes: https://graph.microsoft.com/User.Read

Escopos

Escopos informam ao Microsoft Entra ID o nível de acesso que o aplicativo está solicitando. Para obter os escopos do Microsoft Graph solicitados por esse aplicativo, consulte application.yml.

Por padrão, o aplicativo define o valor de escopos como https://graph.microsoft.com/User.Read. O escopo User.Read é para acessar as informações do usuário conectado atual a partir do ponto de extremidade /me. As solicitações válidas para o ponto de extremidade /me devem conter o escopo User.Read.

Quando um usuário se conecta, o Microsoft Entra ID apresenta uma caixa de diálogo de consentimento para o usuário com base nos escopos solicitados pelo aplicativo. Se o usuário consentir com um ou mais escopos e obtiver um token, os escopos consentidos serão codificados no token de acesso resultante.

Nesse aplicativo, a superfície graphAuthorizedClient é o token de acesso que confirma quais escopos o usuário consentiu. O aplicativo usa esse token para criar uma instância de GraphServiceClient que lida com as solicitações do Graph.

Usando GraphServiceClient.me().buildRequest().get(), uma solicitação é criada e feita para https://graph.microsoft.com/v1.0/me. O token de acesso é colocado no Authorization cabeçalho da solicitação.

Mais informações

• Documentação da plataforma de identidade da Microsoft
• Visão geral da Biblioteca de autenticação da Microsoft (MSAL)
• Início rápido: registrar um aplicativo na plataforma de identidade da Microsoft
• Início Rápido: Configurar um aplicativo cliente para acessar APIs Web
• Noções básicas sobre as experiências de consentimento do aplicativo Microsoft Entra ID
• Entenda o consentimento do usuário e do administrador
• Objetos de entidade de serviço e aplicativo no Microsoft Entra ID
• Nuvens nacionais
• Exemplos de código do MSAL
• Biblioteca de cliente do Azure Active Directory Spring Boot Starter para Java
• Biblioteca de Autenticação da Microsoft para Java (MSAL4J)
• Wiki do MSAL4J
• Tokens de ID
• Tokens de acesso da plataforma de identidade da Microsoft

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