Skip to content

Latest commit

 

History

History

roles

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
AppCreationScripts
AppCreationScripts
 
 
ReadmeFiles
ReadmeFiles
 
 
src/main
src/main
 
 
README.md
README.md
 
 
pom.xml
pom.xml
 
 

README.md

page_type languages products urlFragment description
sample
java
azure
msal-java
microsoft-entra-id
entra
msal-java-spring-boot-restrict-routes
This sample demonstrates a Java Spring MVC web app that authenticates users with Microsoft Entra ID and restricts access to routes based on the roles claim from the ID token.

Enable your Java Spring Boot web app to restrict access to routes using app roles with the Microsoft identity platform

Overview

This sample demonstrates a Java Spring Boot web app that uses the Microsoft Entra ID Spring Boot Starter client library for Java for authentication, authorization, and token acquisition with the OpenID Connect protocol to sign in users, and restricts access to some routes using Microsoft Entra application Roles (app roles) for authorization.

App roles, along with Security groups are popular means to implement authorization. Using Role-based Access Control (RBAC) with Application Roles and Role Claims, developers can securely enforce authorization policies with minimal effort on their part. Another approach is to use Microsoft Entra groups and Group Claims. Microsoft Entra groups and Application Roles are by no means mutually exclusive; they can be used in tandem to provide even finer grained access control.

A Microsoft Identity Platform Office Hours session covered Microsoft Entra app roles and security groups, featuring a similar scenario. A recording of the session is provided in this video Using Security Groups and Application Roles in your apps

For more information about how the protocols work in this scenario and other scenarios, see Authentication Scenarios for Microsoft Entra ID.

Overview

Scenario

  1. This Java Spring MVC web app leverages the Microsoft Entra ID Spring Boot Starter client library for Java to sign in a user and obtain an ID Token from Microsoft Entra ID.
  2. The ID Token token contains the roles claim. The application inspects the value of this claim to determine which pages the user is authorized to access.

This kind of authorization is implemented using role-based access control (RBAC). When using RBAC, an administrator grants permissions to roles, not to individual users or groups. The administrator can then assign roles to different users and groups to control who has then access to certain content and functionality.

This sample application defines the following two Application Roles:

  • PrivilegedAdmin: Authorized to access the Admins Only and the Regular Users pages.
  • RegularUser: Authorized to access the Regular Users page.

These application roles are defined in the Microsoft Entra admin center in the application's registration manifest. When a user signs into the application, Microsoft Entra ID emits a roles claim for each role that the user has been granted individually to the user in the from of role membership. Assignment of users and groups to roles can be done through the portal's UI, or programmatically using the Microsoft Graph and Azure AD Powershell. In this sample, application role management is done through the Microsoft Entra admin center or using PowerShell.

⚠️NOTE: Role claims will not be present for guest users in a tenant if the https://login.microsoftonline.com/common/ endpoint is used as the authority to sign in users. You need to sign-in a user to a tenanted endpoint like 'https://login.microsoftonline.com/tenantid'

Contents

File/folder Description
AppCreationScripts/ Scripts to automatically configure Microsoft Entra app registrations.
pom.xml Application dependencies.
src/main/resources/templates/ Thymeleaf Templates for UI.
src/main/resources/application.yml Application and Microsoft Entra ID Boot Starter Library Configuration.
src/main/java/com/microsoft/azuresamples/msal4j/msidentityspringbootwebapp/ This directory contains the main application entry point, controller, and config classes.
.../MsIdentitySpringBootWebappApplication.java Main class.
.../SampleController.java Controller with endpoint mappings.
.../SecurityConfig.java Security Configuration (e.g., which routes require authentication?).
.../Utilities.java Utility Class (e.g., filter ID token claims)
CHANGELOG.md List of changes to the sample.
CONTRIBUTING.md Guidelines for contributing to the sample.
LICENSE The license for the sample.

Prerequisites

Setup

Clone or download this repository

From your shell or command line:

    git clone https://github.com/Azure-Samples/ms-identity-java-spring-tutorial.git
    cd ms-identity-java-spring-tutorial
    cd 3-Authorization-II/roles

or download and extract the repository .zip file.

⚠️ To avoid path length limitations on Windows, we recommend cloning into a directory near the root of your drive.

Register the sample application with your Microsoft Entra tenant

There is one project in this sample. To register it, you can:

  • follow the steps below for manually register your apps
  • or use PowerShell scripts that:
    • automatically creates the Microsoft Entra applications and related objects (passwords, permissions, dependencies) for you.
    • modify the projects' configuration files.
Expand this section if you want to use this automation:

⚠️ If you have never used Azure AD Powershell before, we recommend you go through the App Creation Scripts once to ensure that your environment is prepared correctly for this step.

  1. On Windows, run PowerShell as Administrator and navigate to the root of the cloned directory

  2. If you have never used Azure AD Powershell before, we recommend you go through the App Creation Scripts once to ensure that your environment is prepared correctly for this step.

  3. In PowerShell run:

    Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process -Force

  4. Run the script to create your Microsoft Entra application and configure the code of the sample application accordingly.

  5. In PowerShell run:

    cd .\AppCreationScripts\
.\Configure.ps1

    Other ways of running the scripts are described in App Creation Scripts The scripts also provide a guide to automated application registration, configuration and removal which can help in your CI/CD scenarios.

Choose the Microsoft Entra tenant where you want to create your applications

As a first step you'll need to:

  1. Sign in to the Microsoft Entra admin center.
  2. If your account is present in more than one Microsoft Entra tenant, select your profile at the top right corner in the menu on top of the page, and then switch directory to change your portal session to the desired Microsoft Entra tenant.

Register the web app (java-spring-webapp-roles)

  1. Navigate to the Microsoft Entra admin center and select the Microsoft Entra ID service.
  2. Select the App Registrations blade on the left, then select New registration.
  3. In the Register an application page that appears, enter your application's registration information:
    • In the Name section, enter a meaningful application name that will be displayed to users of the app, for example java-spring-webapp-roles.
    • Under Supported account types, select Accounts in this organizational directory only.
    • In the Redirect URI (optional) section, select Web in the combo-box and enter the following redirect URI: http://localhost:8080/login/oauth2/code/.
  4. Select Register to create the application.
  5. In the app's registration screen, find and note the Application (client) ID. You use this value in your app's configuration file(s) later in your code.
  6. Select Save to save your changes.
  7. In the app's registration screen, select the Certificates & secrets blade in the left to open the page where we can generate secrets and upload certificates.
  8. In the Client secrets section, select New client secret:
    • Type a key description (for instance app secret),
    • Select one of the available key durations (In 1 year, In 2 years, or Never Expires) as per your security posture.
    • The generated key value will be displayed when you select the Add button. Copy the generated value for use in the steps later.
    • You'll need this key later in your code's configuration files. This key value will not be displayed again, and is not retrievable by any other means, so make sure to note it from the Microsoft Entra admin center before navigating to any other screen or blade.

Define the app Roles

  1. Still on the same app registration, select the App roles blade to the left.
  2. Select Create app role:
    • For Display name, enter a suitable name, for instance PrivilegedAdmin.
    • For Allowed member types, choose User.
    • For Value, enter PrivilegedAdmin.
    • For Description, enter PrivilegedAdmins who can view the Admin Page.
  3. Select Create app role:
    • For Display name, enter a suitable name, for instance RegularUser.
    • For Allowed member types, choose User.
    • For Value, enter RegularUser.
    • For Description, enter RegularUsers who can view the User Page.
  4. Select Apply to save your changes.

Assign users to app roles

To add users to the app role defined earlier, follow the guidelines here: Assign users and groups to roles.

Configure the web app (java-spring-webapp-roles) to use your app registration

Open the project in your IDE (like Visual Studio or Visual Studio Code) to configure the code.

In the steps below, "ClientID" is the same as "Application ID" or "AppId".

  1. Open the src\main\resources\application.yml file.
  2. Find the key Enter_Your_Tenant_ID_Here and replace the existing value with your Microsoft Entra tenant ID.
  3. Find the key Enter_Your_Client_ID_Here and replace the existing value with the application ID (clientId) of java-spring-webapp-roles app copied from the Microsoft Entra admin center.
  4. Find the key Enter_Your_Client_Secret_Here and replace the existing value with the key you saved during the creation of java-spring-webapp-roles copied from the Microsoft Entra admin center.
  5. Open the src/main/java/com/microsoft/azuresamples/msal4j/msidentityspringbootapplication/Sample.Controller.java file.
  6. Find the references to PrivilegedAdmin and RegularUser app roles in this file. If necessary, change them to reflect the app role names you chose in the previous steps.

Running the sample

To run the sample in Visual Studio Code, ensure that you have installed the Java Extension Pack.

  1. Open a terminal or the integrated VSCode terminal.
  2. In the same directory as this readme file, run mvn clean compile spring-boot:run.
  3. Open your browser and navigate to http://localhost:8080.

Experience

Explore the sample

  • Note the signed-in or signed-out status displayed at the center of the screen.
  • Click the context-sensitive button at the top right (it will read Sign In on first run)
  • Alternatively, click the link to token details, admins only or regular users. Since these are protected pages that require authentication, you'll be automatically redirected to the sign-in page.
  • Follow the instructions on the next page to sign in with an account in the Microsoft Entra tenant.
  • On the consent screen, note the scopes that are being requested.
  • Upon successful completion of the sign-in flow, you should be redirected to the home page (sign in status), or one of the other pages, depending on which button triggered your sign-in flow.
  • Note the context-sensitive button now says Sign out and displays your username to its left.
  • If you are on the home page, you'll see an option to click ID Token Details: click it to see some of the ID token's decoded claims, including roles.
  • Click the Admins Only button to view the /admin_only. Only users with app role PrivilegedAdmin will be able to view this page. Otherwise an authorization failure message will be displayed.
  • Click the Regular Users button to view the /regular_user page. Only users with app role RegularUser or PrivilegedAdmin will be able to view this page. Otherwise an authorization failure message will be displayed.
  • You can also use the button on the top right to sign out. The status page will reflect this.

ℹ️ Did the sample not work for you as expected? Then please reach out to us using the GitHub Issues page.

We'd love your feedback!

Were we successful in addressing your learning objective? Consider taking a moment to share your experience with us.

About the code

This sample demonstrates how to use Microsoft Entra ID Spring Boot Starter client library for Java to sign in users into your Microsoft Entra tenant. It also makes use of Spring Oauth2 Client and Spring Web boot starters. It uses claims from ID Token obtained from Microsoft Entra ID to display details of the signed-in user, and to restrict access to some pages by using the roles claim for authorization.

Project Initialization

Create a new Java Maven project and copy the pom.xml file from this project, and the src folder of this repository.

If you'd like to create a project like this from scratch, you may use Spring Initializer:

  • For Packaging, select Jar
  • For Java select version 11
  • For Dependencies, add the following:
    • Microsoft Entra ID
    • Spring Oauth2 Client
    • Spring Web
  • Be sure that it comes with Azure SDK version 3.3 or higher. If not, please consider replacing the pre-configured pom.xml with the pom.xml from this repository.

ID Token Claims

To extract token details, make use of Spring Security's AuthenticationPrincipal and OidcUser object in a request mapping. See the Sample Controller for an example of this app making use of ID Token claims.

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

Processing Roles claim in the ID token

The name of the the roles that the signed-in user is assigned to is returned in the roles claim of the token.

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

A common way to access them is documented in the ID Token Claims section above. Microsoft Entra ID Boot Starter (v3.3 and above) also parses the roles claim automatically and adds each role to the signed in user's Authorities, prefixing each with the string APPROLE_. This allows developers to make use of app roles with Spring PrePost condition annotations using the hasAuthority method. For example, you'll find the following @PreAuthorize conditions demonstrated in 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
}

To see a full list of authorities for a given user:

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

Sign-in and sign-out links

To sign in, you must make a request to the Microsoft Entra ID sign-in endpoint that is automatically configured by Microsoft Entra ID Spring Boot Starter client library for Java.

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

To sign out, you must make POST request to the logout endpoint.

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

Authentication-dependent UI elements

This app has some simple logic in the UI template pages for determining content to display based on whether the user is authenticated or not. For example, the following Spring Security Thymeleaf tags may be used:

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

Protecting routes with aadwebsecurityconfigureradapter

By default, this app protects the ID Token Details, Admins Only and Regular Users pages so that only logged-in users can access them. This app uses configures these routes from the app.protect.authenticated property from the application.yml file. To configure your app's specific requirements, extend Microsoft Entra IDWebSecurityConfigurationAdapter in one of your classes. For an example, see this app's SecurityConfig class.

@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 Microsoft Entra IDWebSecurityAdapter.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.
    }
}

Deployment

Deploy to Azure App Service. Prepare your app for deployment to Azure App Service, configure authentication parameters and use various Azure services for managing your operations.

More information

For more information about how OAuth 2.0 protocols work in this scenario and other scenarios, see Authentication Scenarios for Microsoft Entra ID.

Community Help and Support

Use Stack Overflow to get support from the community. Ask your questions on Stack Overflow first and browse existing issues to see if someone has asked your question before. Make sure that your questions or comments are tagged with [microsoft-entra-id azure-ad-b2c ms-identity adal msal, java].

If you find a bug in the sample, raise the issue on GitHub Issues.

To provide feedback on or suggest features for Microsoft Entra ID, visit User Voice page.

Contributing

If you'd like to contribute to this sample, see CONTRIBUTING.MD.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.