Protección de aplicaciones de Java WebSphere mediante roles de aplicación y notificaciones de rol

Artículo
03/19/2024

En este artículo se muestra una aplicación de WebSphere de Java que usa OpenID Connect para iniciar sesión de usuarios y roles de aplicación de Microsoft Entra ID (roles de aplicación) para la autorización.

Esta aplicación implementa el control de acceso basado en rol (RBAC) mediante los roles de aplicación y la característica de notificaciones de rol de Microsoft Entra ID. Otro enfoque consiste en usar grupos de identificadores de Microsoft Entra y notificaciones de grupo. Los grupos de identificadores de Microsoft Entra y los roles de aplicación no son mutuamente excluyentes. Puede usarlos para proporcionar un control de acceso específico.

También puede usar RBAC con roles de aplicación y notificaciones de rol para aplicar directivas de autorización de forma segura.

Para ver un vídeo que trata este escenario y este ejemplo, consulte Implementación de la autorización en las aplicaciones mediante roles de aplicación, grupos de seguridad, ámbitos y roles de directorio.

Para obtener más información sobre cómo funcionan los protocolos en este escenario y en otros escenarios, consulte Autenticación frente a autorización.

Esta aplicación usa MSAL para Java (MSAL4J) para iniciar sesión en un usuario y obtener un token de identificador de Microsoft Entra ID.

En este ejemplo se usa primero MSAL para Java (MSAL4J) para iniciar sesión en el usuario. En la página principal, muestra una opción para que el usuario vea las notificaciones en sus tokens de identificador. Esta aplicación también permite a los usuarios ver una página de administrador con privilegios o una página de usuario normal, según el rol de aplicación al que se les haya asignado. La idea es proporcionar un ejemplo de cómo, dentro de una aplicación, el acceso a determinadas funcionalidades o páginas está restringido a subconjuntos de usuarios en función del rol al que pertenecen.

Este tipo de autorización se implementa mediante RBAC. Con RBAC, un administrador concede permisos a roles, no a usuarios o grupos individuales. A continuación, el administrador puede asignar roles a distintos usuarios y grupos para controlar quién tiene acceso a determinados contenidos y funcionalidades.

Esta aplicación de ejemplo define los dos roles de aplicación siguientes:

PrivilegedAdmin: autorizado para acceder solo a los administradores y a las páginas Usuarios normales.
RegularUser: autorizado para acceder a la página Usuarios normales.

Estos roles de aplicación se definen en Azure Portal en el manifiesto de registro de la aplicación. Cuando un usuario inicia sesión en la aplicación, Microsoft Entra ID emite una notificación de roles para cada rol concedido individualmente al usuario en forma de pertenencia a roles.

Puede asignar usuarios y grupos a roles a través de Azure Portal o mediante programación mediante Microsoft Graph y Microsoft Azure AD PowerShell. En este artículo se describen ambas técnicas.

Nota:

Las notificaciones de rol no están presentes para los usuarios invitados en un inquilino si el https://login.microsoftonline.com/common/ punto de conexión se usa como autoridad para iniciar sesión de los usuarios. Debe iniciar sesión de un usuario en un punto de conexión inquilino, como https://login.microsoftonline.com/tenantid.

Requisitos previos

JDK versión 8 o posterior
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 Id. de Microsoft Entra 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 Creación, invitación y eliminación de usuarios.

Recomendaciones

Cierta familiaridad con los Servlets de Java /Jakarta.
Cierta familiaridad con el terminal Linux/OSX o Windows PowerShell.
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.

Clonar o descargar el 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/3-Authorization-II/roles

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.

Importante

Para evitar limitaciones de longitud de ruta de acceso de archivo en Windows, clone o extraiga el repositorio en un directorio cerca de la raíz del disco duro.

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

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

Elija el inquilino de Microsoft Entra ID donde desea crear las aplicaciones.

Para elegir el inquilino, siga estos pasos:

Inicie sesión en Azure Portal.
Si la cuenta está presente en más de un inquilino de Microsoft Entra ID, seleccione el perfil en la esquina de Azure Portal y, a continuación, seleccione Cambiar directorio para cambiar la sesión al inquilino de Microsoft Entra ID deseado.

Registrar la aplicación (java-servlet-webapp-roles)

En primer lugar, registre una nueva aplicación en Azure Portal siguiendo las instrucciones de Inicio rápido: Registro de una aplicación con el Plataforma de identidad de Microsoft.

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

Vaya a la página de Registros de aplicaciones de la plataforma de identidad de Microsoft para desarrolladores.
Seleccione Nuevo registro.
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 de aplicación significativo para mostrar a los usuarios de la aplicación; por ejemplo, java-servlet-webapp-roles.
- En Tipos de cuenta admitidos, seleccione una de las siguientes opciones:
  - Seleccione Cuentas en este directorio organizativo solo si va a compilar una aplicación solo para que la usen los usuarios del inquilino, es decir, una aplicación de un solo inquilino .
- En la sección URI de redirección, seleccione Web en el cuadro combinado y escriba el siguiente URI de redirección: http://localhost:8080/msal4j-servlet-roles/auth/redirect.
Seleccione Registrar para crear la aplicación.
En la página de registro de la aplicación, busque y copie el valor de id. de aplicación (cliente) para usarlo más adelante. Este valor se usa en el archivo o archivos de configuración de la aplicación.
Seleccione Guardar para guardar los cambios.
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.
En la sección Secretos de cliente, seleccione Nuevo secreto de cliente.
Escriba una descripción, por ejemplo, secreto de aplicación.
Seleccione una de las duraciones disponibles: En 1 año, En 2 años o Nunca expira.
Seleccione Agregar. Se muestra el valor generado.
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 se muestra de nuevo y no se puede recuperar por ningún otro medio. Por lo tanto, asegúrese de guardarlo desde Azure Portal antes de navegar a cualquier otra pantalla o panel.

Definición de los roles de aplicación

Para definir los roles de aplicación, siga estos pasos:

Todavía en el mismo registro de aplicaciones, seleccione Roles de aplicación en el panel de navegación.
Seleccione Crear rol de aplicación y escriba los valores siguientes:
- En Nombre para mostrar, escriba un nombre adecuado; por ejemplo, PrivilegedAdmin.
- En Tipos de miembros permitidos, elija Usuario.
- En Valor, escriba PrivilegedAdmin.
- En Descripción, escriba PrivilegedAdmins quién puede ver la página de administración.
Seleccione Crear rol de aplicación y escriba los valores siguientes:
- En Nombre para mostrar, escriba un nombre adecuado; por ejemplo, RegularUser.
- En Tipos de miembros permitidos, elija Usuario.
- En Valor, escriba RegularUser.
- En Descripción, escriba RegularUsers que pueden ver la página de usuario.
Seleccione Aplicar para guardar los cambios.

Asignación de usuarios a los roles de aplicación

Para agregar usuarios al rol de aplicación definido anteriormente, siga las instrucciones que se indican aquí: Asignación de usuarios y grupos a roles.

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

Siga estos pasos para configurar la aplicación:

Nota:

En los pasos siguientes, ClientID es igual Application ID que o AppId.

Abra el proyecto en el IDE.
Abra el archivo authentication.properties .
Busque la cadena {enter-your-tenant-id-here}. Reemplace el valor existente por el identificador de inquilino del identificador de inquilino de Microsoft Entra.
Busque la cadena {enter-your-client-id-here} y reemplace el valor existente por el identificador de aplicación o clientId de la java-servlet-webapp-call-graph aplicación copiada de Azure Portal.
Busque la cadena {enter-your-client-secret-here} y reemplace el valor existente por el valor que guardó durante la creación de la java-servlet-webapp-roles aplicación, en Azure Portal.
Busque la app.roles propiedad y asegúrese de que el valor esté establecido app.roles=admin PrivilegedAdmin, user RegularUseren o sustituya los nombres de sus roles específicos.

Compilación del ejemplo

Para compilar 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

En estas instrucciones se supone que instaló WebSphere y configuró un servidor. Puede usar las instrucciones de Implementación de un clúster de WebSphere Application Server (tradicional) en Azure Virtual Machines para una configuración básica del servidor.

Para poder realizar la implementación en WebSphere, siga estos pasos para realizar algunos cambios de configuración en el propio ejemplo y, a continuación, compilar o recompilar el paquete:

Vaya al archivo authentication.properties de la aplicación y cambie el valor de app.homePage a la dirección URL del servidor y el número de puerto que planea usar, como se muestra en el ejemplo siguiente:

# app.homePage is by default set to dev server address and app context path on the server
# for apps deployed to azure, use https://your-sub-domain.azurewebsites.net
app.homePage=https://<server-url>:<port-number>/msal4j-servlet-auth/

Después de guardar este archivo, use el siguiente comando para volver a generar la aplicación:
```
mvn clean package
```
Una vez que el código termine de compilarse, copie el archivo .war en el sistema de archivos del servidor de destino.

También debe realizar el mismo cambio en el registro de aplicaciones de Azure, donde lo establezca en Azure Portal como valor URI de redirección en la pestaña Autenticación .

Vaya a la página de Registros de aplicaciones de la plataforma de identidad de Microsoft para desarrolladores.
Use el cuadro de búsqueda para buscar el registro de la aplicación; por ejemplo, java-servlet-webapp-authentication.
Para abrir el registro de la aplicación, seleccione su nombre.
Seleccione Autenticar desde el menú.
En la sección URI de redirección web - , seleccione Agregar URI.
Rellene el URI de la aplicación, anexando /auth/redirect ( por ejemplo, https://<server-url>:<port-number>/auth/redirect.
Seleccione Guardar.

Siga estos pasos para implementar el ejemplo mediante la consola de soluciones integradas de WebSphere:

En la pestaña Aplicaciones , seleccione Nueva aplicación y, a continuación , Nueva aplicación empresarial.
Elija el archivo .war que ha compilado y, después, seleccione Siguiente hasta llegar al paso de instalación Asignar raíces de contexto para módulos web. La otra configuración predeterminada debe ser correcta.
Para la raíz del contexto, establézcalo en el mismo valor que después del número de puerto en el "URI de redirección" establecido en configuración de ejemplo o registro de aplicaciones de Azure. Es decir, si el URI de redirección es http://<server-url>:9080/msal4j-servlet-auth/, la raíz del contexto debe ser msal4j-servlet-auth.
Seleccione Finalizar.
Una vez finalizada la instalación de la aplicación, vaya a la sección Aplicaciones empresariales de WebSphere de la pestaña Aplicaciones .
Seleccione el archivo .war que instaló en la lista de aplicaciones y, a continuación, seleccione Iniciar para implementar.
Una vez finalizada la implementación, vaya a http://<server-url>:9080/{whatever you set as the context root} y debería poder ver la aplicación.

Exploración del ejemplo

Siga estos pasos para explorar el ejemplo:

Observe que el estado de inicio de sesión o de cierre de sesión se muestra en el centro de la pantalla.
Seleccione el botón contextual en la esquina. Este botón lee Iniciar sesión cuando se ejecuta por primera vez la aplicación.
En la página siguiente, siga las instrucciones e inicie sesión con una cuenta en el inquilino de Microsoft Entra ID.
En la pantalla de consentimiento, observe los ámbitos que se solicitan.
Observe que el botón contextual ahora indica Cerrar sesión y muestra el nombre de usuario.
Seleccione Id. Token Details (Detalles del token de identificador) para ver algunas de las notificaciones descodificadas del token de identificador.
Seleccione Solo administradores para ver la /admin_only página. Solo los usuarios con rol PrivilegedAdmin de aplicación pueden ver esta página. De lo contrario, se muestra un mensaje de error de autorización.
Seleccione Usuarios normales para ver la /regular_user página. Solo los usuarios con rol RegularUser de aplicación o PrivilegedAdmin pueden ver esta página. De lo contrario, se muestra un mensaje de error de autorización.
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 un usuario y obtener un token de identificador que puede contener la notificación de roles. En función de la notificación de roles presente, el usuario que ha iniciado sesión puede acceder a ninguna, una o ambas páginas protegidas y Admins OnlyRegular Users.

Si desea replicar el comportamiento de este ejemplo, puede copiar el archivo pom.xml y el contenido de las carpetas auxiliares 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:

Archivo/carpeta	Descripción
src/main/java/com/microsoft/azuresamples/msal4j/roles/	Este directorio contiene las clases que definen la lógica empresarial de back-end de la aplicación.
src/main/java/com/microsoft/azuresamples/msal4j/authservlets/	Este directorio contiene las clases que se usan para los puntos de conexión de inicio de sesión y cierre de sesión.
____Servlet.java	Todos los puntos de conexión disponibles se definen en .java clases que terminan en ____Servlet.java.
src/main/java/com/microsoft/azuresamples/msal4j/helpers/	Clases auxiliares para la autenticación.
AuthenticationFilter.java	Redirige las solicitudes no autenticadas a los puntos de conexión protegidos a una página 401.
src/main/resources/authentication.properties	Microsoft Entra ID y configuración del programa.
src/main/webapp/	Este directorio contiene la interfaz de usuario: plantillas de JSP
CHANGELOG.md	Lista de cambios en el ejemplo.
CONTRIBUTING.md	Directrices para contribuir al ejemplo.
LICENCIA	Licencia del ejemplo.

Procesamiento de una notificación de roles en el token de identificador

La notificación de roles del token incluye los nombres de los roles a los que está asignado el usuario que ha iniciado sesión, como se muestra en el ejemplo siguiente:

{
  ...
  "roles": [
    "Role1",
    "Role2",]
  ...
}

ConfidentialClientApplication

Se crea una ConfidentialClientApplication instancia 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 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();

Los parámetros siguientes se usan para crear instancias:

Identificador de cliente de la aplicación.
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 en el archivo Config.java .

Tutorial paso a paso

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

El primer paso del proceso de inicio de sesión es enviar una solicitud al /authorize punto de conexión del inquilino de Microsoft Entra ID. La instancia de MSAL4J ConfidentialClientApplication 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 compilar una authorizationRequestUrl.
- REDIRECT_URI: donde Microsoft Entra ID redirige el explorador ( 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 de Id. de Microsoft Entra 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.
Microsoft Entra ID presenta al usuario un mensaje de inicio de sesión. Si el intento de inicio de sesión se realiza correctamente, el explorador del usuario se redirige al punto de conexión de redireccionamiento de la aplicación. Una solicitud válida a este punto de conexión contiene un código de autorización.
A continuación, la ConfidentialClientApplication instancia intercambia este código de autorización para 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 de un identificador o token de acceso.
- authCode: el código de autorización que se recibió en el punto de conexión de redireccionamiento.
- REDIRECT_URI: el URI de redirección usado en el paso anterior debe pasarse de nuevo.
- SCOPES: los ámbitos usados en el paso anterior deben pasarse de nuevo.
Si acquireToken se realiza correctamente, se extraen las notificaciones de token. Si se supera la comprobación de nonce, los resultados se colocan en ( una instancia de IdentityContextData ) y se guardan en context la sesión. A continuación, la aplicación puede crear una instancia IdentityContextData de desde la sesión mediante una instancia de IdentityContextAdapterServlet siempre que necesite acceso 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 app.protect.authenticated propiedad 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 claim(s)
app.protect.authenticated=/token_details

Cualquiera de las rutas enumeradas en los conjuntos de reglas separados por comas en app.protect.roles también están fuera de los límites de los usuarios autenticados no autenticados, como se muestra en el ejemplo siguiente. Sin embargo, estas rutas también contienen una lista separada por espacios de pertenencias a roles de aplicación: solo los usuarios que tienen al menos uno de los roles correspondientes pueden acceder a estas rutas después de la autenticación.

# local short names for app roles - for example, sets admin to mean PrivilegedAdmin (useful for long rule sets defined in the next key, app.protect.roles)
app.roles=admin PrivilegedAdmin, user RegularUser

# A route and its corresponding <space-separated> role(s) that can access it; the start of the next route & its role(s) is delimited by a <comma-and-space-separator>
# this says: /admins_only can be accessed by PrivilegedAdmin, /regular_user can be accessed by PrivilegedAdmin role and the RegularUser role
app.protect.roles=/admin_only admin, /regular_user admin user

Á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 diálogo de consentimiento al usuario al iniciar sesión. Si el usuario da su consentimiento a uno o varios ámbitos y obtiene un token, los ámbitos con consentimiento se codifican en el objeto resultante access_token.

Para los ámbitos solicitados por la aplicación, consulte authentication.properties. MsAL solicita estos tres ámbitos y se proporcionan de forma predeterminada por el identificador de Entra de Microsoft.

Información adicional

Paso siguiente

Implementación de aplicaciones de Java WebSphere en WebSphere tradicional en Azure Virtual Machines

Compartir a través de