Habilitación de aplicaciones Java JBoss EAP para que los usuarios inicien sesión y accedan a Microsoft Graph

En este artículo se muestra una aplicación de Java JBoss EAP que inicia la sesión de los usuarios y obtiene un token de acceso para llamar a Microsoft Graph. Usa la Biblioteca de autenticación de Microsoft (MSAL) para Java.

En el siguiente diagrama se muestra la topología de la aplicación:

La aplicación cliente usa MSAL para Java (MSAL4J) para iniciar sesión de un usuario y obtener un token de acceso para Microsoft Graph desde Microsoft Entra ID. El token de acceso demuestra que el usuario está autorizado para acceder al punto de conexión de la API de Microsoft Graph tal como se define en el ámbito.

Requisitos previos

• Java 8 o versiones posteriores
• Maven 3
• Un inquilino de Microsoft Entra ID. Para obtener más información, consulte Cómo obtener un inquilino de Microsoft Entra ID.
• Una cuenta de usuario en su propio inquilino de Microsoft Entra ID si desea trabajar solo con cuentas en el directorio organizativo, es decir, modo de inquilino único. Si aún no ha creado una cuenta de usuario en el inquilino, debe hacerlo antes de continuar. Para obtener más información, consulte Cómo crear, invitar y eliminar usuarios.
• Una cuenta de usuario en el inquilino de Microsoft Entra ID de cualquier organización si desea trabajar con cuentas en cualquier directorio organizativo, es decir, en modo multiinquilino. Este ejemplo debe modificarse para trabajar con una cuenta personal de Microsoft. Si aún no ha creado una cuenta de usuario en el inquilino, debe hacerlo antes de continuar. Para obtener más información, consulte Cómo crear, invitar y eliminar usuarios.
• Una cuenta de Microsoft personal (por ejemplo, Xbox, Hotmail, Live, etc.) si desea trabajar con cuentas personales de Microsoft.

• JBoss EAP
• Visual Studio Code
• Azure Tools para Visual Studio Code

Recomendaciones

• Cierta familiaridad con los servlets de Java/Jakarta.
• Cierta familiaridad con el terminal Linux/OSX.
• jwt.ms para inspeccionar los tokens.
• Fiddler para supervisar la actividad de red y la solución de problemas.
• Siga el blog de Microsoft Entra ID para mantenerse al día con los últimos desarrollos.

Configuración del ejemplo

En las secciones siguientes se muestra cómo configurar la aplicación de ejemplo.

Clonación o descarga del repositorio de ejemplo

Para clonar el ejemplo, abra una ventana de Bash y use el siguiente comando:

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

Como alternativa, vaya al repositorio ms-identity-msal-java-samples y, a continuación, descárguelo como un archivo .zip y extráigalo en el disco duro.

Registro de la aplicación de ejemplo con el inquilino de Microsoft Entra ID

En este ejemplo hay un proyecto. En las secciones siguientes se muestra cómo registrar la aplicación mediante Azure Portal.

Selección del inquilino de Microsoft Entra ID el que quiere crear las aplicaciones

Para elegir el inquilino, siga estos pasos:

1. Inicie sesión en Azure Portal.

2. Si su cuenta existe en más de un inquilino de Microsoft Entra ID, seleccione el perfil en la esquina de Azure Portal y seleccione Cambiar directorio para modificar la sesión al inquilino de Microsoft Entra ID que desee.

Registro de la aplicación (java-servlet-webapp-call-graph)

En primer lugar, registre una nueva aplicación en Azure Portal siguiendo las instrucciones de Inicio rápido: Registro de una aplicación en la plataforma de identidades de Microsoft.

A continuación, siga estos pasos para completar el registro:

1. Vaya a la página de Registros de aplicaciones de la plataforma de identidad de Microsoft para desarrolladores.

2. Seleccione Nuevo registro.

3. En la página Registrar una aplicación que aparece, escriba la siguiente información de registro de la aplicación:

   • En la sección Nombre, escriba un nombre significativo de la aplicación, que se mostrará a los usuarios de la aplicación, por ejemplo, java-servlet-webapp-call-graph.

   • En Tipos de cuenta admitidos, seleccione una de las siguientes opciones:

     • Seleccione Solo las cuentas de este directorio organizativo si va a crear una aplicación para que solo la utilicen los usuarios de su inquilino, es decir, una aplicación de inquilino.
     • Seleccione Cuentas de cualquier directorio de la organización si desea que los usuarios de cualquier inquilino de Microsoft Entra ID puedan usar su aplicación, es decir, una aplicación multiinquilino.
     • Seleccione Cuentas de un directorio organizativo y cuentas de Microsoft personales para el conjunto más amplio de clientes, es decir, una aplicación multiinquilino que también admite cuentas personales de Microsoft.

   • Seleccione Cuentas personales de Microsoft para que solo las utilicen los usuarios de cuentas Microsoft personales (por ejemplo, cuentas de Hotmail, Live, Skype o Xbox).

   • En la sección URI de redirección, seleccione Web en el cuadro combinado y escriba los siguientes URI de redirección: http://localhost:8080/msal4j-servlet-graph/auth/redirect.

4. Seleccione Registrar para crear la aplicación.

5. En la página de registro de la aplicación, busque y copie el valor del identificador de la aplicación (cliente) para usarlo más adelante. Este valor se usa en el archivo o los archivos de configuración de la aplicación.

6. Seleccione Guardar para guardar los cambios.

7. En la página de registro de la aplicación, seleccione Certificados y secretos en el panel de navegación para abrir la página donde puede generar secretos y cargar certificados.

8. En la sección Secretos de cliente, seleccione Nuevo secreto de cliente.

9. Escriba una descripción, por ejemplo, secreto de aplicación.

10. Seleccione una de las duraciones disponibles: En 1 año, En 2 años o No caduca nunca.

11. Seleccione Agregar. Se muestra el valor generado.

12. Copie y guarde el valor generado para usarlo en pasos posteriores. Necesita este valor para los archivos de configuración del código. Este valor no volverá a aparecer y no podrá recuperarlo por ningún otro medio. Por lo tanto, asegúrese de guardarlo desde Azure Portal antes de navegar a cualquier otra pantalla o panel.

13. En la página de registro de la aplicación, seleccione Permisos de API en el panel de navegación para abrir la página y agregar acceso a las API que necesita la aplicación.

14. Selecciona Agregar permisos.

15. Asegúrese de que la pestaña API de Microsoft esté seleccionada.

16. En la sección API de Microsoft más usadas, seleccione Microsoft Graph.

17. En la sección Permisos delegados, seleccione User.Read en la lista. Si es necesario, utilice el cuadro de búsqueda.

18. Seleccione Agregar permisos.

Configuración de la aplicación (java-servlet-webapp-call-graph) para usar el registro de la aplicación

Siga estos pasos para configurar la aplicación:

1. Abra el proyecto en su IDE.

2. Abra el archivo ./src/main/resources/authentication.properties.

3. Busque la cadena {enter-your-tenant-id-here}. Reemplace el valor existente por uno de los siguientes valores:

   • El identificador de inquilino de Microsoft Entra ID si registró la aplicación con la opción Solo cuentas de este directorio organizativo.
   • La palabra organizations si registró la aplicación con la opción Cuentas de cualquier directorio organizativo.
   • La palabra common si registró la aplicación con la opción Cuentas de cualquier directorio organizativo y cuentas de Microsoft personales.
   • La palabra consumers si registró la aplicación con la opción Cuentas personales de Microsoft.

4. Busque la cadena {enter-your-client-id-here} y reemplace el valor existente por el identificador de aplicación o clientId de la aplicación java-servlet-webapp-call-graph que ha copiado de Azure Portal.

5. Busque la cadena {enter-your-client-secret-here} y reemplace el valor existente por el valor que ha guardado durante la creación de la aplicación java-servlet-webapp-call-graph en Azure Portal.

Compilación del ejemplo

Para crear el ejemplo mediante Maven, vaya al directorio que contiene el archivo pom.xml del ejemplo y, a continuación, ejecute el siguiente comando:

mvn clean package

Este comando genera un archivo .war que se puede ejecutar en varios servidores de aplicaciones.

Ejecución del ejemplo

Please confirm webapp properties
AppName : msal4j-servlet-auth-1707220080695
ResourceGroup : msal4j-servlet-auth-1707220080695-rg
Region : centralus
PricingTier : P1v3
OS : Linux
Java Version: Java 11
Web server stack: JBosseap 7
Deploy to slot : false
Confirm (Y/N) [Y]:
[INFO] Saving configuration to pom.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  26.196 s
[INFO] Finished at: 2024-02-06T11:48:16Z
[INFO] ------------------------------------------------------------------------

<build>
    <plugins>
        <plugin>
            <groupId>com.microsoft.azure</groupId>
            <artifactId>>azure-webapp-maven-plugin</artifactId>
            <version>x.xx.x</version>
            <configuration>
                <schemaVersion>v2</schemaVersion>
                <resourceGroup>your-resourcegroup-name</resourceGroup>
                <appName>your-app-name</appName>
            ...
            </configuration>
        </plugin>
    </plugins>
</build>

az login

mvn package azure-webapp:deploy

Exploración del ejemplo

Siga estos pasos para explorar el ejemplo:

1. Observe que el estado de inicio de sesión o de cierre de sesión se muestra en el centro de la pantalla.
2. Seleccione el botón contextual en la esquina. Este botón indica Iniciar sesión cuando se ejecuta por primera vez la aplicación.
3. En la página siguiente, siga las instrucciones e inicie sesión con una cuenta en el inquilino de Microsoft Entra ID.
4. En la pantalla de consentimiento, observe los ámbitos que se solicitan.
5. Observe que el botón contextual ahora indica Cerrar sesión y muestra el nombre de usuario.
6. Seleccione Detalles del token de identificador para ver algunas de las notificaciones descodificadas del token de identificador.
7. Seleccione Gráfico de llamadas para realizar una llamada al punto de conexión /me de Microsoft Graph y ver una selección de los detalles de usuario obtenidos.
8. Use el botón de la esquina para cerrar la sesión.

Sobre el código

En este ejemplo se usa MSAL para Java (MSAL4J) para iniciar sesión de un usuario y obtener un token para la API de Microsoft Graph. Usa el SDK de Microsoft Graph para Java para obtener datos de Graph. Debe agregar estas bibliotecas a los proyectos mediante Maven.

Si desea replicar el comportamiento de este ejemplo, puede copiar el archivo pom.xml y el contenido de las carpetas helpers y authservlets en la carpeta src/main/java/com/microsoft/azuresamples/msal4j. También necesita el archivo authentication.properties. Estas clases y archivos contienen código genérico que puede usar en una amplia gama de aplicaciones. También puede copiar el resto del ejemplo, pero las demás clases y archivos se compilan específicamente para abordar el objetivo de este ejemplo.

Contenido

En la tabla siguiente se muestra el contenido de la carpeta del proyecto de ejemplo:

ConfidentialClientApplication

Se crea una instancia de ConfidentialClientApplication en el archivo AuthHelper.java, como se muestra en el ejemplo siguiente. Este objeto ayuda a crear la dirección URL de autorización de Microsoft Entra ID y también ayuda a intercambiar el token de autenticación de un token de acceso.

// getConfidentialClientInstance method
IClientSecret secret = ClientCredentialFactory.createFromSecret(SECRET);
confClientInstance = ConfidentialClientApplication
                     .builder(CLIENT_ID, secret)
                     .authority(AUTHORITY)
                     .build();

Para la instanciación se utilizan los siguientes parámetros:

• El identificador de cliente de la aplicación.
• El secreto de cliente, que es un requisito para aplicaciones cliente confidenciales.
• Microsoft Entra ID Authority, que incluye el identificador de inquilino de Microsoft Entra.

En este ejemplo, estos valores se leen del archivo authentication.properties mediante un lector de propiedades del archivo Config.java.

Tutorial paso a paso

Los pasos siguientes proporcionan un tutorial de la funcionalidad de la aplicación:

1. El primer paso del proceso de inicio de sesión consiste en enviar una solicitud al punto de conexión /authorize del inquilino de Microsoft Entra ID. La instancia ConfidentialClientApplication de MSAL4J se usa para construir una dirección URL de solicitud de autorización. La aplicación redirige el explorador a esta dirección URL, que es donde el usuario inicia sesión.

   final ConfidentialClientApplication client = getConfidentialClientInstance();
   AuthorizationRequestUrlParameters parameters = AuthorizationRequestUrlParameters.builder(Config.REDIRECT_URI, Collections.singleton(Config.SCOPES))
           .responseMode(ResponseMode.QUERY).prompt(Prompt.SELECT_ACCOUNT).state(state).nonce(nonce).build();
   
   final String authorizeUrl = client.getAuthorizationRequestUrl(parameters).toString();
   contextAdapter.redirectUser(authorizeUrl);
   

   En la lista siguiente se describen las características de este código:

   • AuthorizationRequestUrlParameters: parámetros que se deben establecer para crear una AuthorizationRequestUrl.
   • REDIRECT_URI: donde Microsoft Entra ID redirige el navegador, junto con el código de autenticación, después de recopilar las credenciales de usuario. Debe coincidir con el URI de redireccionamiento en el registro de la aplicación Microsoft Entra ID en Azure Portal.
   • SCOPES: Los ámbitos son permisos solicitados por la aplicación.
     • Normalmente, los tres ámbitos openid profile offline_access son suficientes para recibir una respuesta de token de identificador.
     • La lista completa de ámbitos solicitados por la aplicación se puede encontrar en el archivo authentication.properties. Puede agregar más ámbitos, como User.Read.

2. Microsoft Entra ID presenta al usuario un mensaje de inicio de sesión. Si el intento de inicio de sesión es correcto, el navegador del usuario se vuelve a redirigir al punto de conexión de redirección de la aplicación. Una solicitud válida a este punto de conexión contendrá un código de autorización.

3. Después, la instancia de ConfidentialClientApplication intercambia este código de autorización por un token de identificador y un token de acceso de Microsoft Entra ID.

   // First, validate the state, then parse any error codes in response, then extract the authCode. Then:
   // build the auth code params:
   final AuthorizationCodeParameters authParams = AuthorizationCodeParameters
           .builder(authCode, new URI(Config.REDIRECT_URI)).scopes(Collections.singleton(Config.SCOPES)).build();
   
   // Get a client instance and leverage it to acquire the token:
   final ConfidentialClientApplication client = AuthHelper.getConfidentialClientInstance();
   final IAuthenticationResult result = client.acquireToken(authParams).get();
   

   En la lista siguiente se describen las características de este código:

   • AuthorizationCodeParameters: parámetros que se deben establecer para intercambiar el código de autorización por un identificador o token de acceso.
   • authCode: el código de autorización que se ha recibido en el punto de conexión de redireccionamiento.
   • REDIRECT_URI: el URI de redireccionamiento que se ha usado en el paso anterior se debe pasar de nuevo.
   • SCOPES: los ámbitos que se han usado en el paso anterior se deben pasar de nuevo.

4. Si acquireToken se realiza correctamente, se extraen las notificaciones de token. Si se supera la comprobación nonce, los resultados se colocan en context, una instancia de IdentityContextData, y se guardan en la sesión. Después, la aplicación puede crear una instancia de IdentityContextData a partir de la sesión por medio de una instancia de IdentityContextAdapterServlet siempre que necesite acceder a ella, como se muestra en el código siguiente:

   // parse IdToken claims from the IAuthenticationResult:
   // (the next step - validateNonce - requires parsed claims)
   context.setIdTokenClaims(result.idToken());
   
   // if nonce is invalid, stop immediately! this could be a token replay!
   // if validation fails, throws exception and cancels auth:
   validateNonce(context);
   
   // set user to authenticated:
   context.setAuthResult(result, client.tokenCache().serialize());
   

Protección de las rutas

Para obtener información sobre cómo la aplicación de ejemplo filtra el acceso a las rutas, consulte AuthenticationFilter.java. En el archivo authentication.properties, la propiedad app.protect.authenticated contiene las rutas separadas por comas a las que solo pueden acceder los usuarios autenticados, como se muestra en el ejemplo siguiente:

# for example, /token_details requires any user to be signed in and does not require special roles or groups claim(s)
app.protect.authenticated=/token_details, /call_graph

Gráfico de llamadas

Cuando el usuario navega a /call_graph, la aplicación crea una instancia de IGraphServiceClient desde el SDK de Java Graph y se pasa el token de acceso del usuario que ha iniciado sesión. El cliente de Graph coloca el token de acceso en los encabezados Authorization de sus solicitudes. Después, la aplicación solicita al cliente de Graph que llame al punto de conexión /me para devolver los detalles del usuario que ha iniciado sesión actualmente.

Si ya tiene un token de acceso válido para Graph Service con el ámbito User.Read, solo necesita el código siguiente para obtener acceso al punto de conexión /me:

//CallGraphServlet.java
User user = GraphHelper.getGraphClient(contextAdapter).me().buildRequest().get();

Ámbitos

Los ámbitos indican a Microsoft Entra ID el nivel de acceso que solicita la aplicación.

En función de los ámbitos solicitados, Microsoft Entra ID presenta un cuadro de diálogo de consentimiento al usuario cuando inicia sesión. Si el usuario da su consentimiento para uno o varios ámbitos y obtiene un token, los ámbitos con consentimiento se codifican en el access_token resultante.

Para los ámbitos solicitados por la aplicación, consulte authentication.properties. De forma predeterminada, la aplicación establece el valor de ámbitos en User.Read. Este ámbito concreto de la API de Microsoft Graph es para acceder a la información del usuario que ha iniciado sesión. El punto de conexión de Graph para acceder a esta información es https://graph.microsoft.com/v1.0/me. Las solicitudes válidas realizadas a este punto de conexión deben tener un access_token que contenga el ámbito User.Read en el encabezado Authorization.

Más información

• Biblioteca de autenticación de Microsoft (MSAL) para Java
• Plataforma de identidad de Microsoft (Microsoft Entra ID para desarrolladores)
• Inicio rápido: Registro de una aplicación en la plataforma de identidad de Microsoft
• Qué son las experiencias de consentimiento de las aplicaciones de Microsoft Entra ID
• Descripción del consentimiento del usuario y del administrador
• Ejemplos de código MSAL