Partager via

Sécuriser les applications Java Spring Boot à l’aide de rôles et de revendications de rôles

  • Article

Cet article montre une application web Java Spring Boot qui utilise la Bibliothèque cliente Spring Boot Starter de Microsoft Entra ID pour Java pour l’authentification, l’autorisation et l’acquisition de jetons. L’application utilise le protocole OpenID Connect pour connecter des utilisateurs et limite l’accès à certains itinéraires à l’aide des rôles d’application Microsoft Entra ID (rôles d’application) pour l’autorisation.

Les rôles d’application, ainsi que les groupes de sécurité, sont des moyens populaires d’implémenter l’autorisation. Grâce à l’accès en fonction du rôle (RBAC) avec des rôles d’application et des revendications de rôle, vous pouvez appliquer en toute sécurité des stratégies d’autorisation avec un minimum d’efforts. Une autre approche consiste à utiliser des groupes Microsoft Entra ID et des revendications de groupe. Les groupes Microsoft Entra ID et les rôles d’application ne s’excluent pas mutuellement. Vous pouvez utiliser les deux pour fournir un contrôle d’accès précis.

Pour voir une vidéo qui couvre un scénario similaire, consultez Implémenter l’autorisation dans vos applications avec des rôles d’application, des groupes de sécurité, des étendues et des rôles d’annuaire.

Pour en savoir plus sur le fonctionnement des protocoles dans ce scénario et dans d’autres, consultez Authentification ou autorisation.

Le diagramme suivant illustre la topologie de l’application :

Diagramme qui montre la topologie de l’application.

L’application utilise la bibliothèque cliente Spring Boot Starter de Microsoft Entra ID pour Java pour connecter un utilisateur et obtenir un jeton d’ID à partir de Microsoft Entra ID. Le jeton d’ID contient la revendication de rôles. L’application inspecte la valeur de cette revendication pour déterminer les pages auxquelles l’utilisateur est autorisé à accéder.

Ce type d’autorisation est implémenté à l’aide du RBAC. En utilisant le RBAC, un administrateur accorde des autorisations aux rôles, pas à des utilisateurs individuels ou à des groupes. L’administrateur peut alors attribuer des rôles aux différents utilisateurs et groupes pour contrôler l’accès à certains contenus et fonctionnalités.

Cet exemple d’application définit les deux rôles d’application suivants :

  • PrivilegedAdmin : autorisé à accéder aux pages Administrateurs uniquement et Utilisateurs habituels.
  • RegularUser : autorisé à accéder à la page Utilisateurs habituels.

Ces rôles d’application sont définis dans le portail Azure au sein du manifeste de l’inscription d’application. Lorsqu’un utilisateur se connecte à l’application, Microsoft Entra ID émet une revendication de rôles pour chaque rôle accordé individuellement à l’utilisateur sous la forme d’une appartenance à un rôle.

Vous affecter des utilisateurs et des groupes à des rôles sur le portail Azure.

Remarque

Les revendications de rôle ne sont pas disponibles pour les utilisateurs invités d’un locataire si le point de terminaison https://login.microsoftonline.com/common/ est utilisé comme autorité pour connecter des utilisateurs. Vous devez connecter un utilisateur à un point de terminaison client tel que https://login.microsoftonline.com/tenantid.

Prérequis

Recommandations

  • Un certaine connaissance de Spring Framework.
  • Être familiarisé avec le terminal Linux/OSX.
  • jwt.ms pour inspecter vos jetons.
  • Fiddler pour la supervision de votre activité réseau et la résolution des problèmes.
  • Suivez le blog Microsoft Entra ID pour rester au courant des dernières évolutions.

Configurer l’exemple

Les sections suivantes vous montrent comment configurer l’exemple d’application.

Clonez ou téléchargez l’exemple de dépôt

Pour cloner l’exemple, ouvrez une fenêtre Bash et utilisez la commande suivante :

git clone https://github.com/Azure-Samples/ms-identity-msal-java-samples.git
cd 4-spring-web-app/3-Authorization-II/roles

Vous pouvez également accéder au dépôt ms-identity-msal-java-samples, puis le télécharger en tant que fichier .zip et l’extraire sur votre disque dur.

Important

Pour éviter les limitations de longueur de fichier sous Windows, clonez ou extrayez le dépôt dans un répertoire proche de la racine de votre disque dur.

Inscrivez l’exemple d’application auprès de votre locataire Microsoft Entra ID

Cet exemple contient un seul projet. Les sections suivantes vous montrent comment inscrire l’application à l’aide du Portail Azure.

Choisissez le locataire Microsoft Entra ID où vous voulez créer vos applications.

Pour choisir votre locataire, suivez les étapes ci-dessous :

  1. Connectez-vous au portail Azure.

  2. Si votre compte est présent dans plusieurs locataires Microsoft Entra ID, sélectionnez votre profil dans le coin du portail Azure, puis sélectionnez Changer d’annuaire pour faire correspondre votre session au locataire Microsoft Entra ID souhaité.

Inscrire l’application (java-spring-webapp-roles)

Pour inscrire l’application, effectuez les étapes suivantes :

  1. Accédez au portail Azure, puis sélectionnez Microsoft Entra ID.

  2. Dans le volet de navigation, sélectionnez Inscriptions d’applications, puis sélectionnez Nouvelle inscription.

  3. Dans la page Inscrire une application qui s’affiche, saisissez les informations suivantes relatives à l’inscription de votre application :

    • Dans la section Nom, saisissez un nom d’application cohérent qui s’affichera pour les utilisateurs de l’application, par exemple java-spring-webapp-roles.
    • Sous Types de comptes pris en charge, sélectionnez Comptes dans cet annuaire organisationnel uniquement.
    • Dans la section URI de redirection (facultatif), sélectionnez Web dans la zone de liste modifiable et entrez l’URI de redirection suivant : http://localhost:8080/login/oauth2/code/.

  4. Sélectionnez Inscrire pour créer l’application.

  5. Dans la page d’inscription de l’application, recherchez et copiez la valeur ID d’application (client) pour l’utiliser ultérieurement. Vous utilisez cette valeur dans le ou les fichiers de configuration de votre application.

  6. Sur la page d’inscription de l’application, sélectionnez Certificats et secrets dans le volet de navigation pour ouvrir la page permettant de générer des secrets et de charger des certificats.

  7. Dans la section Secrets client, sélectionnez Nouveau secret client.

  8. Saisissez une description (par exemple, secret de l’application).

  9. Sélectionnez l’une des durées disponibles : Dans 1 an, Dans 2 ans ou N’expire jamais.

  10. Sélectionnez Ajouter. La valeur générée s’affiche.

  11. Copiez et sauvegardez la valeur générée pour l’utiliser dans les étapes ultérieures. Vous avez besoin de cette valeur pour les fichiers de configuration de votre code. Cette valeur n’apparaîtra plus, et vous ne pouvez pas la récupérer par d’autres moyens. Veillez donc à la sauvegarder à partir du portail Azure avant d’accéder un autre écran ou à un autre volet.

Définir les rôles d’application

Pour définir les rôles d’application, procédez comme suit :

  1. Sans quitter l’inscription d’application, sélectionnez Rôles d’application dans le volet de navigation.

  2. Sélectionnez Créer un rôle d’application, puis saisissez les valeurs suivantes :

    • Pour Nom d’affichage, saisissez un nom approprié, par exemple PrivilegedAdmin.
    • Pour Types de membres autorisés, choisissez Utilisateur.
    • Pour Valeur, saisissez PrivilegedAdmin.
    • Pour Description, saisissez PrivilegedAdmins qui peut consulter la page d’administration.

  3. Sélectionnez Créer un rôle d’application, puis saisissez les valeurs suivantes :

    • Pour Nom d’affichage, saisissez un nom approprié, par exemple RegularUser.
    • Pour Types de membres autorisés, choisissez Utilisateur.
    • Pour Valeur, saisissez RegularUser.
    • Pour Description, saisissez RegularUsers qui peut consulter la page utilisateur.

  4. Sélectionnez Appliquer pour enregistrer vos modifications.

Affecter des utilisateurs aux rôles d’application

Pour ajouter des utilisateurs au rôle d’application défini précédemment, suivez les instructions suivantes : Affecter des utilisateurs et des groupes à des rôles.

Configurer l’application (java-spring-webapp-roles) pour utiliser l’inscription de votre application

Pour configurer l’application, procédez comme suit :

Remarque

Dans les étapes suivantes, ClientID est identique à Application ID ou AppId.

  1. Ouvrez le projet dans votre IDE.

  2. Ouvrez le fichier src\main\resources\application.yml.

  3. Recherchez l’espace réservé Enter_Your_Tenant_ID_Here et remplacez la valeur existante par l’ID de votre locataire Microsoft Entra.

  4. Recherchez l’espace réservé Enter_Your_Client_ID_Here et remplacez la valeur existante par l’ID d’application ou l’clientId de l’application java-spring-webapp-roles que vous avez copié à partir du portail Azure.

  5. Recherchez l’espace réservé Enter_Your_Client_Secret_Here et remplacez la valeur existante par celle que vous avez enregistrée lors de la création de java-spring-webapp-roles que vous avez copié dans le portail Azure.

  6. Ouvrez le fichier src/main/java/com/microsoft/azuresamples/msal4j/msidentityspringbootapplication/Sample.Controller.java.

  7. Recherchez les références aux rôles d’application PrivilegedAdmin et RegularUser dans ce fichier. Si nécessaire, modifiez-les pour refléter les noms de rôles d’application que vous avez choisis dans les étapes précédentes.

Exécution de l'exemple

Les sections suivantes vous expliquent comment déployer l’exemple sur Azure Container Apps.

Prérequis

Préparer le projet Spring

Suivez la procédure ci-dessous pour préparer le projet :

  1. Utilisez la commande Maven suivante pour générer le projet :

    mvn clean verify

  2. Exécutez l’exemple de projet localement à l’aide de la commande suivante :

    mvn spring-boot:run

Programme d’installation

Pour vous connecter à Azure à partir de l’interface CLI, exécutez la commande suivante et suivez les invites pour procéder à l’authentification.

az login

Pour être sûr d’utiliser la dernière version de l’interface CLI, exécutez la commande de mise à niveau.

az upgrade

Ensuite, installez ou mettez à jour l’extension Azure Container Apps pour l’interface CLI.

Si vous recevez des erreurs concernant des paramètres manquants lorsque vous exécutez des commandes az containerapp dans Azure CLI, vérifiez que la dernière version de l’extension Azure Container Apps est installée.

az extension add --name containerapp --upgrade

Remarque

À compter de mai 2024, les extensions Azure CLI n’activent plus les fonctionnalités en préversion par défaut. Pour accéder aux fonctionnalités en préversion de Container Apps, installez l’extension Container Apps avec --allow-preview true.

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

Maintenant que la version actuelle de l’extension ou du module est installée, inscrivez les espaces de noms Microsoft.App et Microsoft.OperationalInsights.

Remarque

Les ressources Azure Container Apps ont migré de l’espace de noms Microsoft.Web vers l’espace de noms Microsoft.App. Pour plus d’informations, reportez-vous à Migration de l’espace de noms de Microsoft.Web vers Microsoft.App en mars 2022.

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

Créer l’environnement Azure Container Apps

À présent que votre configuration Azure CLI est terminée, vous pouvez définir les variables d’environnement utilisées dans cet article.

Définissez les variables suivantes dans votre interpréteur de commandes Bash.

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"

Créez un groupe de ressources.

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

Créer un environnement avec un espace de travail Log Analytics généré automatiquement.

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

Afficher le domaine par défaut de l’environnement d’application conteneur. Notez ce domaine à utiliser dans les sections ultérieures.

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

Préparer l’application pour le déploiement

Lorsque vous déployez votre application dans Azure Container Apps, votre URL de redirection devient l’URL de redirection de votre instance d’application déployée dans Azure Container Apps. Suivez les étapes ci-dessous pour modifier ces paramètres dans votre fichier application.yml :

  1. Naviguez jusqu’au fichier src\main\resources\application.yml de votre application et remplacez la valeur post-logout-redirect-uri par le nom de domaine de votre application déployée, comme indiqué dans l’exemple suivant. Veillez à remplacer <API_NAME> et <default-domain-of-container-app-environment> avec vos valeurs réelles : Par exemple, avec le domaine par défaut de votre environnement Azure Container App à l’étape précédente et ms-identity-api pour le nom de votre application, vous devez utiliser https://ms-identity-api.<default-domain> pour la valeur post-logout-redirect-uri.

    post-logout-redirect-uri: https://<API_NAME>.<default-domain-of-container-app-environment>

  2. Après avoir enregistré ce fichier, utilisez la commande suivante pour reconstruire votre application :

    mvn clean package

Important

Le fichier application.yml de l’application contient actuellement la valeur de votre secret client dans le paramètre client-secret. Il n’est pas judicieux de conserver cette valeur dans ce fichier. Vous pouvez également prendre un risque en délivrant le fichier à un dépôt Git. Pour obtenir l’approche recommandée, consultez Gérer les secrets dans Azure Container Apps.

Mettez à jour l’enregistrement de votre application Microsoft Entra ID

Étant donné que l’URI de redirection change pour votre application déployée sur Azure Container Apps, vous devez également modifier l’URI de redirection dans votre enregistrement d’application Microsoft Entra ID. Pour cela, effectuez les étapes suivantes :

  1. Accédez à la page Inscriptions d’applications de la plateforme d’identités Microsoft pour les développeurs.

  2. Utilisez le champ de recherche pour rechercher l’enregistrement de votre application - par exemple, java-servlet-webapp-authentication.

  3. Ouvrez votre enregistrement d’application en sélectionnant son nom.

  4. Sélectionnez Authentification dans le menu déroulant.

  5. Dans la section Web - Redirection des URI, sélectionnez Ajouter un URI.

  6. Remplissez l’URI de votre application, en ajoutant /login/oauth2/code/ - par exemple, https://<containerapp-name>.<default domain of container app environment>/login/oauth2/code/.

  7. Cliquez sur Enregistrer.

Déployer l’application

Déployez le package JAR sur Azure Container Apps.

Remarque

Si nécessaire, vous pouvez spécifier la version de JDK dans les variables d’environnement de génération Java. Pour en savoir plus, consultez Créer des variables d’environnement pour Java dans Azure Container Apps.

Vous pouvez maintenant déployer votre fichier WAR avec la commande CLI az containerapp up.

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

Remarque

La version par défaut du JDK est la version 17. Si vous devez changer la version de JDK pour qu’elle soit compatible avec votre application, vous pouvez utiliser l’argument --build-env-vars BP_JVM_VERSION=<YOUR_JDK_VERSION> pour ajuster le numéro de version.

Pour en savoir plus sur la génération de variables d’environnement, consultez Générer des variables d’environnement pour Java dans Azure Container Apps.

Validez l’application

Dans cet exemple, la commande containerapp up inclut l’argument --query properties.configuration.ingress.fqdn qui renvoie le nom de domaine complet (FQDN), également appelé URL de l’application. Procédez comme suit pour vérifier les journaux d’activité de l’application afin d’identifier un éventuel problème de déploiement :

  1. Accédez à l’URL de l’application de sortie à partir de la page Sorties de la section Déploiement.

  2. Dans le volet de navigation de la page Vue d’ensemble de l’instance Azure Container Apps, sélectionnez Journaux d’activité pour vérifier les journaux d’activité de l’application.

Explorer l’exemple

Procédez comme suit pour examiner l’exemple :

  1. Notez l’état de connexion ou de déconnexion qui s’affiche au centre de l’écran.
  2. Sélectionnez le bouton contextuel dans le coin. Ce bouton indique Connexion lorsque vous exécutez l’application pour la première fois. Vous pouvez également sélectionner détails du jeton, administrateurs uniquement ou utilisateurs habituels. Étant donné que ces pages sont protégée et nécessitent une authentification, vous êtes automatiquement redirigé vers la page de connexion.
  3. Suivez les instructions de la page suivante et connectez-vous avec un compte dans le locataire Microsoft Entra ID.
  4. Sur l’écran de consentement, notez les portées demandées.
  5. Une fois le processus de connexion terminé, vous devez être redirigé vers la page d’accueil, qui affiche l’état de connexion ou l’une des autres pages, selon le bouton qui a déclenché votre processus de connexion.
  6. Notez que le bouton contextuel indique maintenant Déconnexion et affiche votre nom d’utilisateur.
  7. Si vous vous trouvez sur la page d’accueil, sélectionnez Détails du jeton d’ID pour voir certaines des revendications décodées du jeton d’ID, y compris les rôles.
  8. Sélectionnez Administrateurs uniquement pour afficher /admin_only. Seuls les utilisateurs disposant d’un rôle d’application PrivilegedAdmin peuvent voir cette page. Pour les autres, un message d’échec d’autorisation s’affiche.
  9. Sélectionnez Utilisateurs habituels pour afficher la page /regular_user. Seuls les utilisateurs disposant d’un rôle d’application RegularUser ou PrivilegedAdmin peuvent voir cette page. Pour les autres, un message d’échec d’autorisation s’affiche.
  10. Utilisez le bouton dans le coin pour vous déconnecter. La page d’état reflète le nouvel état.

À propos du code

Cet exemple montre comment utiliser la bibliothèque cliente Spring Boot Starter de Microsoft Entra ID pour Java en vue de connecter des utilisateurs à votre locataire Microsoft Entra ID. L’exemple utilise également le client Spring Oauth2 et les boot starters Spring Web. L’exemple utilise les revendications du jeton d’ID obtenu à partir de Microsoft Entra ID pour afficher les détails de l’utilisateur connecté et pour restreindre l’accès à certaines pages à l’aide de la revendication de rôles pour l’autorisation.

Contenu

Le tableau suivant montre le contenu de l’exemple de dossier du projet :

Fichier/Dossier Description
pom.xml Dépendances de l’application.
src/main/resources/templates/ Modèles Thymeleaf pour l’interface utilisateur.
src/main/resources/application.yml Configuration de la bibliothèque de l’application et de Microsoft Entra ID Boot Starter.
src/main/java/com/microsoft/azuresamples/msal4j/msidentityspringbootwebapp/ Ce répertoire contient le point d’entrée, le contrôleur et les classes de configuration principaux de l’application.
.../MsIdentitySpringBootWebappApplication.java Classe principale.
.../SampleController.java Contrôleur avec mappages de point de terminaison.
.../SecurityConfig.java Configuration de la sécurité : par exemple, quels itinéraires nécessitent une authentification.
.../Utilities.java Classe Utility : par exemple, filtrer les revendications de jeton d’ID.
CHANGELOG.md Liste des modifications apportées à l’exemple.
CONTRIBUTING.md Instructions pour contribuer à l’exemple.
LICENCE` Licence de l’exemple.

Revendications de jetons d’ID

Pour extraire les détails du jeton, l’application utilise l’objet AuthenticationPrincipal et OidcUser de Spring Security dans un mappage de requête, comme illustré dans l’exemple suivant. Pour en savoir plus sur la façon dont cette application utilise les revendications de jetons d’ID, consultez le contrôleur d’exemple.

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();
}

Traiter une revendication de rôles dans le jeton d’ID

La revendication de rôles du jeton inclut les noms des rôles auxquels l’utilisateur connecté est affecté, comme dans l’exemple suivant :

{
  ...
  "roles": [
    "PrivilegedAdmin",
    "RegularUser",]
  ...
}

Un moyen courant d’accéder aux noms de rôle est expliqué dans la section revendications de jeton d’ID.

Microsoft Entra ID Boot Starter v3.3 et les versions ultérieures analysent également la revendication de rôles automatiquement et ajoute chaque rôle aux Authorities de l’utilisateur connecté, en préfixant chacun d’eux avec la chaîne APPROLE_. Cette configuration permet aux développeurs d’utiliser des rôles d’application avec des annotations de condition Spring PrePost à l’aide de la méthode hasAuthority. Par exemple, vous trouverez les conditions @PreAuthorize suivantes présentées dans SampleController.java :

@GetMapping(path = "/admin_only")
@PreAuthorize("hasAuthority('APPROLE_PrivilegedAdmin')")
public String adminOnly(Model model) {
    // restrict to users who have PrivilegedAdmin app role only
}
@GetMapping(path = "/regular_user")
@PreAuthorize("hasAnyAuthority('APPROLE_PrivilegedAdmin','APPROLE_RegularUser')")
public String regularUser(Model model) {
    // restrict to users who have any of RegularUser or PrivilegedAdmin app roles
}

Le code suivant obtient une liste complète des autorités pour un utilisateur donné :

@GetMapping(path = "/some_path")
public String tokenDetails(@AuthenticationPrincipal OidcUser principal) {
   Collection<? extends GrantedAuthority> authorities = principal.getAuthorities();
}

Pour la connexion, l’application envoie une demande au point de terminaison de connexion Microsoft Entra ID automatiquement configuré par la bibliothèque cliente Spring Boot Starter de Microsoft Entra ID pour Java, comme le montre l’exemple suivant :

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

Pour la déconnexion, l’application effectue une requête POST au point de terminaison logout, comme indiqué dans l’exemple suivant :

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

Éléments d’interface utilisateur dépendant de l’authentification

L’application est dotée d’une logique simple dans les pages modèles de l’interface utilisateur pour déterminer le contenu à afficher en fonction de l’authentification de l’utilisateur, comme le montre l’exemple suivant qui utilise les balises 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>

Protéger les itinéraires avec AADWebSecurityConfigurerAdapter

Par défaut, l’application protège les pages Détails du jeton d’ID, Administrateurs uniquement et Utilisateurs habituels afin que seuls les utilisateurs connectés puissent y accéder. L’application configure ces itinéraires à l’aide de la propriété app.protect.authenticated à partir du fichier application.yml. Pour configurer les exigences spécifiques de votre application, vous pouvez étendre AADWebSecurityConfigurationAdapter dans l’une de vos classes. Pour obtenir un exemple, consultez la classe SecurityConfig de cette application, illustrée dans le code suivant :

@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, /admin_only, /regular_user)
      .antMatchers("/**").permitAll();                  // allow all other routes.
    }
}

Plus d’informations

Pour en savoir plus sur le fonctionnement des protocoles OAuth 2.0 dans ce scénario et dans d’autres, consultez Scénarios d’authentification pour Microsoft Entra ID.