Skydda Java Spring Boot-appar med hjälp av roller och rollanspråk

Den här artikeln visar en Java Spring Boot-webbapp som använder Microsoft Entra ID Spring Boot Starter-klientbiblioteket för Java för autentisering, auktorisering och tokenförvärv. Appen använder OpenID Connect-protokollet för att logga in användare och begränsar åtkomsten till vissa vägar med hjälp av Microsoft Entra ID-programroller (approller) för auktorisering.

Approller, tillsammans med säkerhetsgrupper, är populära sätt att implementera auktorisering. Med rollbaserad åtkomstkontroll (RBAC) med programroller och rollanspråk kan du på ett säkert sätt tillämpa auktoriseringsprinciper med minimal ansträngning. En annan metod är att använda Microsoft Entra-ID-grupper och gruppanspråk. Microsoft Entra-ID-grupper och programroller utesluter inte varandra. Du kan använda dem båda för att ge detaljerad åtkomstkontroll.

En video som beskriver ett liknande scenario finns i Implementera auktorisering i dina program med hjälp av approller, säkerhetsgrupper, omfång och katalogroller.

Mer information om hur protokollen fungerar i det här scenariot och andra scenarier finns i Autentisering kontra auktorisering.

Följande diagram visar appens topologi:

Diagram som visar appens topologi.

Appen använder Microsoft Entra ID Spring Boot Starter-klientbiblioteket för Java för att logga in en användare och hämta en ID-token från Microsoft Entra-ID. ID-token innehåller rollanspråket. Programmet inspekterar värdet för det här anspråket för att avgöra vilka sidor som användaren har behörighet att komma åt.

Den här typen av auktorisering implementeras med hjälp av RBAC. Med RBAC ger en administratör behörighet till roller, inte till enskilda användare eller grupper. Administratören kan sedan tilldela roller till olika användare och grupper för att styra vem som har åtkomst till visst innehåll och vissa funktioner.

Det här exempelprogrammet definierar följande två programroller:

• PrivilegedAdmin: Har behörighet att komma åt sidorna Endast administratörer och Vanliga användare .
• RegularUser: Har behörighet att komma åt sidan Vanliga användare .

Dessa programroller definieras i Azure Portal i programmets registreringsmanifest. När en användare loggar in i programmet genererar Microsoft Entra-ID ett rollanspråk för varje roll som beviljas användaren individuellt i form av rollmedlemskap.

Du kan tilldela användare och grupper till roller via Azure Portal.

Förutsättningar

• JDK version 15. Det här exemplet har utvecklats på ett system med Java 15, men det kan vara kompatibelt med andra versioner.
• Maven 3
• Java-tilläggspaketet för Visual Studio Code rekommenderas för att köra det här exemplet i Visual Studio Code.
• En Microsoft Entra-ID-klientorganisation. Mer information finns i Hämta en Microsoft Entra-ID-klientorganisation.
• Ett användarkonto i din Microsoft Entra-ID-klientorganisation. Det här exemplet fungerar inte med ett personligt Microsoft-konto. Om du loggade in på Azure Portal med ett personligt konto och du inte har något användarkonto i din katalog måste du därför skapa ett nu.
• Visual Studio Code
• Azure Tools för Visual Studio Code

Rekommendationer

• Viss kunskap om Spring Framework.
• Viss kunskap om Linux/OSX-terminalen.
• jwt.ms för att inspektera dina token.
• Fiddler för övervakning av nätverksaktivitet och felsökning.
• Följ Microsoft Entra-bloggen för att hålla dig up-to-date med den senaste utvecklingen.

Konfigurera exemplet

I följande avsnitt visas hur du konfigurerar exempelprogrammet.

Klona eller ladda ned exempellagringsplatsen

Om du vill klona exemplet öppnar du ett Bash-fönster och använder följande kommando:

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

Du kan också gå till lagringsplatsen ms-identity-msal-java-samples och sedan ladda ned den som en .zip fil och extrahera den till hårddisken.

Registrera exempelprogrammet med din Microsoft Entra ID-klientorganisation

Det finns ett projekt i det här exemplet. Följande avsnitt visar hur du registrerar appen med hjälp av Azure Portal.

Välj den Microsoft Entra-ID-klientorganisation där du vill skapa dina program

Använd följande steg för att välja klientorganisation:

1. Logga in på Azure-portalen.

2. Om ditt konto finns i mer än en Microsoft Entra-ID-klientorganisation väljer du din profil i hörnet av Azure Portal och väljer sedan Växla katalog för att ändra sessionen till önskad Microsoft Entra ID-klientorganisation.

Registrera appen (java-spring-webapp-roles)

Använd följande steg för att registrera appen:

1. Gå till Azure Portal och välj Microsoft Entra-ID.

2. Välj Appregistreringar i navigeringsfönstret och välj sedan Ny registrering.

3. På sidan Registrera ett program som visas anger du följande programregistreringsinformation:

   • I avsnittet Namn anger du ett beskrivande programnamn för visning för användare av appen , till exempel java-spring-webapp-roles.
   • Under Kontotyper som stöds väljer du Endast Konton i den här organisationskatalogen.
   • I avsnittet Omdirigerings-URI (valfritt) väljer du Webb i kombinationsrutan och anger följande omdirigerings-URI: http://localhost:8080/login/oauth2/code/.

4. Välj Registrera för att skapa programmet.

5. På appens registreringssida letar du upp och kopierar värdet program-ID (klient) för senare användning. Du använder det här värdet i appens konfigurationsfil eller filer.

6. På appens registreringssida väljer du Certifikat och hemligheter i navigeringsfönstret för att öppna sidan där du kan generera hemligheter och ladda upp certifikat.

7. Under avsnittet Klienthemlighet välj Ny klienthemlighet.

8. Skriv en beskrivning – till exempel apphemlighet.

9. Välj en av de tillgängliga varaktigheterna: Om ett år, Om två år eller Aldrig upphör att gälla.

10. Markera Lägga till. Det genererade värdet visas.

11. Kopiera och spara det genererade värdet för användning i senare steg. Du behöver det här värdet för kodens konfigurationsfiler. Det här värdet visas inte igen och du kan inte hämta det på något annat sätt. Se därför till att spara den från Azure Portal innan du går till någon annan skärm eller ett annat fönster.

Definiera approllerna

Använd följande steg för att definiera approllerna:

1. I samma appregistrering väljer du Approller i navigeringsfönstret.

2. Välj Skapa approll och ange sedan följande värden:

   • Som Visningsnamn anger du ett lämpligt namn , till exempel PrivilegedAdmin.
   • För Tillåtna medlemstyper väljer du Användare.
   • Som Värde anger du PrivilegedAdmin.
   • Som Beskrivning anger du PrivilegedAdmins som kan visa administratörssidan.

3. Välj Skapa approll och ange sedan följande värden:

   • Som Visningsnamn anger du ett lämpligt namn , till exempel RegularUser.
   • För Tillåtna medlemstyper väljer du Användare.
   • Ange RegularUser som Värde.
   • Som Beskrivning anger du RegularUsers som kan visa användarsidan.

4. Tryck på Apply (Verkställ) för att spara ändringarna.

Tilldela användare till approller

Om du vill lägga till användare i approllen som definierades tidigare följer du riktlinjerna här: Tilldela användare och grupper till roller.

Konfigurera appen (java-spring-webapp-roles) så att den använder din appregistrering

Använd följande steg för att konfigurera appen:

1. Öppna projektet i din IDE.

2. Öppna filen src\main\resources\application.yml.

3. Leta upp platshållaren Enter_Your_Tenant_ID_Here och ersätt det befintliga värdet med ditt Klient-ID för Microsoft Entra.

4. Leta upp platshållaren Enter_Your_Client_ID_Here och ersätt det befintliga värdet med program-ID:t eller clientId appen java-spring-webapp-roles som kopierades från Azure Portal.

5. Leta upp platshållaren Enter_Your_Client_Secret_Here och ersätt det befintliga värdet med det värde som du sparade när java-spring-webapp-roles du skapade kopierade från Azure Portal.

6. Öppna filen src/main/java/com/microsoft/azuresamples/msal4j/msidentityspringbootapplication/Sample.Controller.java.

7. Hitta referenserna till approllerna PrivilegedAdmin och RegularUser i den här filen. Om det behövs ändrar du dem så att de återspeglar de approllnamn som du valde i föregående steg.

Kör exemplet

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

Utforska exemplet

Använd följande steg för att utforska exemplet:

1. Observera den inloggade eller utloggade statusen som visas i mitten av skärmen.
2. Välj den sammanhangskänsliga knappen i hörnet. Den här knappen läser Logga in när du först kör appen. Du kan också välja tokeninformation, endast administratörer eller vanliga användare. Eftersom dessa sidor är skyddade och kräver autentisering omdirigeras du automatiskt till inloggningssidan.
3. På nästa sida följer du anvisningarna och loggar in med ett konto i Microsoft Entra ID-klientorganisationen.
4. Observera de omfång som begärs på medgivandeskärmen.
5. När inloggningsflödet har slutförts bör du omdirigeras till startsidan – som visar inloggningsstatusen – eller någon av de andra sidorna, beroende på vilken knapp som utlöste inloggningsflödet.
6. Observera att den sammanhangskänsliga knappen nu säger Logga ut och visar ditt användarnamn.
7. Om du är på startsidan väljer du ID-tokeninformation för att se några av ID-tokens avkodade anspråk, inklusive roller.
8. Välj Endast administratörer för att visa /admin_only. Endast användare med approll PrivilegedAdmin kan visa den här sidan. Annars visas ett meddelande om auktoriseringsfel.
9. Välj Vanliga användare för att visa sidan /regular_user . Endast användare med approll RegularUser eller PrivilegedAdmin kan visa den här sidan. Annars visas ett meddelande om auktoriseringsfel.
10. Använd knappen i hörnet för att logga ut. Statussidan visar det nya tillståndet.

Om koden

Det här exemplet visar hur du använder Microsoft Entra ID Spring Boot Starter-klientbiblioteket för Java för att logga in användare i din Microsoft Entra-ID-klientorganisation. Exemplet använder även Spring Oauth2-klienten och Spring Web-startstartarna. Exemplet använder anspråk från den ID-token som hämtats från Microsoft Entra-ID:t för att visa information om den inloggade användaren och för att begränsa åtkomsten till vissa sidor med hjälp av rollanspråket för auktorisering.

Innehåll

I följande tabell visas innehållet i exempelprojektmappen:

ID-tokenanspråk

För att extrahera tokeninformation använder appen Spring Securitys AuthenticationPrincipal och OidcUser objektet i en begärandemappning, som du ser i följande exempel. Se Exempelkontrollanten för fullständig information om hur den här appen använder ID-tokenanspråk.

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

Bearbeta ett rollanspråk i ID-token

Rollanspråket för token innehåller namnen på de roller som den inloggade användaren har tilldelats, enligt följande exempel:

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

Ett vanligt sätt att komma åt rollnamnen dokumenteras i avsnittet ID-tokenanspråk .

Microsoft Entra ID Boot Starter v3.3 och senare parsar även rollanspråket automatiskt och lägger till varje roll i den inloggade användarens Authorities, prefix var och en med strängen APPROLE_. Den här konfigurationen gör det möjligt för utvecklare att använda approller med Spring-villkorsanteckningar PrePost med hjälp av hasAuthority metoden. Du kan till exempel hitta följande @PreAuthorize villkor som visas i 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
}

Följande kod hämtar en fullständig lista över myndigheter för en viss användare:

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

Inloggnings- och utloggningslänkar

För inloggning skickar appen en begäran till Microsoft Entra ID-inloggningsslutpunkten automatiskt konfigurerad av Microsoft Entra ID Spring Boot Starter-klientbiblioteket för Java, enligt följande exempel:

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

För utloggning gör appen en POST-begäran till logout slutpunkten, som du ser i följande exempel:

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

Autentiseringsberoende gränssnittselement

Appen har lite enkel logik på mallsidorna för användargränssnittet för att bestämma innehåll som ska visas baserat på om användaren autentiseras, som du ser i följande exempel med Hjälp av Spring Security Thymeleaf-taggar:

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

Skydda vägar med AADWebSecurityConfigurerAdapter

Som standard skyddar appen sidorna ID-tokeninformation, Endast administratörer och Vanliga användare så att endast inloggade användare kan komma åt dem. Appen konfigurerar dessa vägar från app.protect.authenticated egenskapen från filen application.yml . Om du vill konfigurera appens specifika krav kan du utöka AADWebSecurityConfigurationAdapter i någon av dina klasser. Ett exempel finns i den här appens SecurityConfig-klass , som visas i följande kod:

@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.
    }
}

Mer information

• Microsofts identitetsplattform dokumentation
• Översikt över Microsoft Authentication Library (MSAL)
• Snabbstart: Registrera ett program med Microsofts identitetsplattform
• Snabbstart: Konfigurera ett klientprogram för åtkomst till webb-API:er
• Förstå funktioner för medgivande för Microsoft Entra-ID-program
• Förstå användar- och administratörsmedgivande
• Program och tjänstobjekt i Azure Active Directory
• Nationella moln
• MSAL-kodexempel
• Azure Active Directory Spring Boot Starter-klientbibliotek för Java
• Microsoft Authentication Library for Java (MSAL4J)
• MSAL4J Wiki
• ID-token
• Åtkomsttoken i Microsofts identitetsplattform

Mer information om hur OAuth 2.0-protokoll fungerar i det här scenariot och andra scenarier finns i Autentiseringsscenarier för Microsoft Entra-ID.