Aanmelden inschakelen voor Java Tomcat-apps met behulp van Microsoft Entra ID

In dit artikel wordt een Java Tomcat-app gedemonstreerd waarmee gebruikers zich aanmelden bij uw Microsoft Entra ID-tenant met behulp van de Microsoft Authentication Library (MSAL) voor Java.

In het volgende diagram ziet u de topologie van de app:

Diagram dat de topologie van de app toont.

De client-app gebruikt MSAL voor Java (MSAL4J) om gebruikers aan te melden bij hun eigen Microsoft Entra ID-tenant en een ID-token te verkrijgen van Microsoft Entra ID. Het id-token bewijst dat een gebruiker is geverifieerd met deze tenant. De app beveiligt de routes op basis van de verificatiestatus van de gebruiker.

Vereisten

• JDK versie 8 of hoger
• Maven 3
• Een Microsoft Entra ID-tenant. Zie Een Microsoft Entra ID-tenant verkrijgen voor meer informatie.
• Een gebruikersaccount in uw eigen Microsoft Entra ID-tenant als u alleen met accounts in uw organisatiedirectory wilt werken, dat wil zeggen in de modus voor één tenant. Als u nog geen gebruikersaccount hebt gemaakt in uw Microsoft Entra ID-tenant, moet u dit doen voordat u doorgaat. Zie Gebruikers maken, uitnodigen en verwijderen voor meer informatie.
• Een gebruikersaccount in de Microsoft Entra ID-tenant van een willekeurige organisatie als u wilt werken met accounts in een willekeurige organisatiedirectory, dat wil zeggen in multitenantmodus. U moet dit voorbeeld wijzigen om te werken met een persoonlijk Microsoft-account. Als u nog geen gebruikersaccount hebt gemaakt in uw Microsoft Entra ID-tenant, moet u dit doen voordat u doorgaat. Zie Gebruikers maken, uitnodigen en verwijderen voor meer informatie.
• Een persoonlijk Microsoft-account, bijvoorbeeld Xbox, Hotmail, Live, enzovoort, als u wilt werken met persoonlijke Microsoft-accounts.

• Tomcat 9
• Visual Studio Code
• Azure Tools voor Visual Studio Code

Aanbevelingen

• Enige vertrouwdheid met de Java / Jakarta Servlets.
• Enige bekendheid met Linux/OSX-terminal.
• jwt.ms om uw tokens te inspecteren.
• Fiddler om uw netwerkactiviteit te controleren en problemen op te lossen.
• Volg de Microsoft Entra-blog om up-to-date te blijven met de nieuwste ontwikkelingen.

Het voorbeeld instellen

In de volgende secties ziet u hoe u de voorbeeldtoepassing instelt.

De voorbeeldopslagplaats klonen of downloaden

Als u het voorbeeld wilt klonen, opent u een Bash-venster en gebruikt u de volgende opdracht:

git clone https://github.com/Azure-Samples/ms-identity-msal-java-samples.git
cd 3-java-servlet-web-app/1-Authentication/sign-in

U kunt ook naar de ms-identity-msal-java-samples-repository gaan, deze vervolgens als een .zip-bestand downloaden en op uw harde schijf uitpakken.

De voorbeeldtoepassing registreren bij uw Microsoft Entra ID-tenant

Er is één project in dit voorbeeld. In deze sectie wordt beschreven hoe u de app registreert.

Registreer eerst de app in de Azure-portal door de instructies in Quickstart: een toepassing registreren bij het Microsoft-identiteitsplatform te volgen.

Gebruik vervolgens de volgende stappen om de registratie te voltooien:

1. Ga naar de pagina App-registraties in het Microsoft identity platform voor ontwikkelaars.

2. Selecteer Nieuwe registratie.

3. Voer op de pagina Een toepassing registreren die wordt weergegeven de volgende registratiegegevens voor de toepassing in:

   • Voer in de sectie Name een duidelijke applicatienaam in die aan gebruikers van de app wordt weergegeven, bijvoorbeeld .

   • Selecteer onder Ondersteunde accounttypen een van de volgende opties:

     • Selecteer Alleen accounts in deze organisatiemap als u een toepassing maakt die alleen wordt gebruikt door gebruikers in uw tenant - dat wil zeggen een single-tenant-toepassing.
     • Selecteer Accounts in any organizational directory als u wilt dat gebruikers in een willekeurige Microsoft Entra ID-tenant uw toepassing kunnen gebruiken; dat wil zeggen een multitenant-toepassing.
     • Selecteer Accounts in een organisatiedirectory en persoonlijke Microsoft-accounts voor de breedst mogelijke klantenkring, dat wil zeggen: een multitenanttoepassing die ook persoonlijke Microsoft-accounts ondersteunt.
     • Selecteer Persoonlijke Microsoft-accounts voor alleen gebruik door gebruikers van persoonlijke Microsoft-accounts, bijvoorbeeld Hotmail-, Live-, Skype- en Xbox-accounts.

   • Selecteer in de sectie Omleidings-URI in de keuzelijst Web en voer de volgende omleidings-URI in: .

4. Selecteer Registreren om de toepassing te maken.

5. Ga op de registratiepagina van de app naar de waarde van Toepassings-id (client) en kopieer deze om later te gebruiken. U gebruikt deze waarde in het configuratiebestand of de bestanden van uw app.

6. Selecteer certificaten en geheimen op de registratiepagina van de app in het navigatiedeelvenster om de pagina te openen om geheimen te genereren en certificaten te uploaden.

7. Selecteer in de sectie Clientgeheimen de optie Nieuw clientgeheim.

8. Typ een beschrijving, bijvoorbeeld app-geheim.

9. Selecteer een vervaldatum voor het geheim of geef een aangepaste levensduur op. Clientgeheimen zijn beperkt tot een maximale levensduur van 24 maanden en Microsoft adviseert een vervaldatum van minder dan 12 maanden. Voor productie-apps gebruikt u bij voorkeur een certificaat of federatieve identiteitsreferentie in plaats van een clientgeheim.

10. Selecteer Toevoegen. De gegenereerde waarde wordt weergegeven.

11. Kopieer en sla de gegenereerde waarde op voor gebruik in latere stappen. U hebt deze waarde nodig voor de configuratiebestanden van uw code. Deze waarde wordt niet opnieuw weergegeven en u kunt deze niet op een andere manier ophalen. Zorg er dus voor dat u deze opslaat in Azure Portal voordat u naar een ander scherm of deelvenster navigeert.

De app configureren voor het gebruik van uw app-registratie

Gebruik de volgende stappen om de app te configureren:

1. Open het project in uw IDE.

2. Open het bestand ./src/main/resources/authentication.properties.

3. Zoek de tekenreeks . Vervang de bestaande waarde door een van de volgende waarden:

   • Uw Microsoft Entra ID-tenant-id als u uw app hebt geregistreerd met de optie Alleen accounts in deze organisatiedirectory.
   • Het woord als u uw app hebt geregistreerd met de optie Accounts in een willekeurige organisatiedirectory.
   • Het woord als u uw app hebt geregistreerd met de optie Accounts in een organisatiemap en persoonlijke Microsoft-accounts.
   • Het woord als u uw app hebt geregistreerd met de optie Persoonlijke Microsoft-accounts.

4. Zoek de tekenreeks en vervang de bestaande waarde door de toepassings-id of van de -toepassing die vanuit de Azure-portal is gekopieerd.

5. Zoek de tekenreeks en vervang de bestaande waarde door de waarde die u hebt opgeslagen tijdens het maken van de -app in de Azure-portal.

Compileer het voorbeeld

Als u het voorbeeld wilt bouwen met behulp van Maven, gaat u naar de map met het pom.xml-bestand voor het voorbeeld en voert u de volgende opdracht uit:

mvn clean package

Met deze opdracht wordt een WAR-bestand gegenereerd dat u op verschillende toepassingsservers kunt uitvoeren.

De voorbeeldtoepassing uitvoeren

Please confirm webapp properties
AppName : msal4j-servlet-auth-1707209552268
ResourceGroup : msal4j-servlet-auth-1707209552268-rg
Region : centralus
PricingTier : P1v2
OS : Linux
Java Version: Java 11
Web server stack: Tomcat 9.0
Deploy to slot : false
Confirm (Y/N) [Y]: [INFO] Saving configuration to pom.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  37.112 s
[INFO] Finished at: 2024-02-06T08:53:02Z
[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

Het voorbeeld verkennen

Gebruik de volgende stappen om het voorbeeld te verkennen:

1. Merk op dat de aanmeldings- of afmeldstatus in het midden van het scherm wordt weergegeven.
2. Selecteer de contextgevoelige knop in de hoek. Op deze knop staat Sign In wanneer u de app voor het eerst opent.
3. Volg op de volgende pagina de instructies en meld u aan met een account in de Microsoft Entra ID-tenant.
4. Let op de machtigingen die op het toestemmingsscherm worden gevraagd.
5. Merk op dat de contextgevoelige knop nu Afmelden zegt en uw gebruikersnaam weergeeft.
6. Selecteer Details van id-token om enkele van de gedecodeerde claims van het id-token weer te geven.
7. Gebruik de knop in de hoek om u af te melden.
8. Nadat u zich hebt afgemeld, selecteert u ID-tokendetails om te zien dat de app een -fout weergeeft in plaats van de claims van het ID-token wanneer de gebruiker niet is geautoriseerd.

Over de code

In dit voorbeeld ziet u hoe u MSAL voor Java (MSAL4J) gebruikt om gebruikers aan te melden bij uw Microsoft Entra ID-tenant. Als u MSAL4J in uw eigen toepassingen wilt gebruiken, moet u deze toevoegen aan uw projecten met behulp van Maven.

Als u het gedrag van dit voorbeeld wilt repliceren, kunt u het pom.xml-bestand en de inhoud van de helpers en authservlets-mappen kopiëren in de map src/main/java/com/microsoft/azuresamples/msal4j . U hebt ook het bestand authentication.properties nodig. Deze klassen en bestanden bevatten algemene code die u kunt gebruiken in een breed scala aan toepassingen. U kunt ook de rest van het voorbeeld kopiëren, maar de andere klassen en bestanden zijn specifiek ontworpen om aan het doel van dit voorbeeld te voldoen.

Inhoud

In de volgende tabel ziet u de inhoud van de voorbeeldprojectmap:

ConfidentialClientApplication

Er wordt een exemplaar van gemaakt in het bestand AuthHelper.java, zoals in het volgende voorbeeld wordt weergegeven. Dit object helpt bij het maken van de autorisatie-URL van Microsoft Entra ID en helpt ook bij het uitwisselen van het verificatietoken voor een toegangstoken.

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

De volgende parameters worden gebruikt voor instantiëring:

• De client-id van de app.
• Het clientgeheim, dat vereist is voor Vertrouwelijke clienttoepassingen.
• De Microsoft Entra ID Authority, die uw Microsoft Entra ID-tenant-id bevat.

In dit voorbeeld worden deze waarden gelezen uit het bestand authentication.properties met behulp van een eigenschappenlezer in het bestand Config.java .

Stapsgewijze handleiding

De volgende stappen bieden een overzicht van de functionaliteit van de app:

1. De eerste stap van het aanmeldproces is het verzenden van een aanvraag naar het -eindpunt voor uw Microsoft Entra ID-tenant. Het MSAL4J-exemplaar wordt gebruikt om een URL voor een autorisatieaanvraag op te bouwen. De app leidt de browser om naar deze URL, waar de gebruiker zich aanmeldt.

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

   In de volgende lijst worden de functies van deze code beschreven:

   • : Parameters die moeten worden ingesteld om een AuthorizationRequestUrl op te bouwen.

   • : waar Microsoft Entra ID de browser naartoe omleidt, samen met de autorisatiecode, nadat de gebruikersreferenties zijn verzameld. Deze moet overeenkomen met de omleidings-URI in de app-registratie voor Microsoft Entra ID in de Azure-portal.

   • : Scopes zijn machtigingen die door de applicatie worden aangevraagd. Normaal gesproken volstaan de drie scopes voor het ontvangen van een ID-tokenreactie.

     U vindt een volledige lijst met machtigingen die de app aanvraagt in het bestand authentication.properties. U kunt meer machtigingen toevoegen, zoals .

2. De gebruiker krijgt een aanmeldingsprompt van Microsoft Entra ID. Als de aanmeldingspoging is geslaagd, wordt de browser van de gebruiker omgeleid naar het omleidingseindpunt van de app. Een geldig verzoek aan dit eindpunt bevat een autorisatiecode.

3. Het -exemplaar wisselt deze autorisatiecode vervolgens uit voor een ID-token en toegangstoken van 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();
   

   In de volgende lijst worden de functies van deze code beschreven:

   • : Parameters die moeten worden ingesteld om de autorisatiecode voor een ID-token en/of toegangstoken uit te wisselen.
   • : De autorisatiecode die is ontvangen bij het omleidingseindpunt.
   • : De redirect-URI die in de vorige stap is gebruikt, moet opnieuw worden meegegeven.
   • : De scopes die in de vorige stap zijn gebruikt, moeten opnieuw worden doorgegeven.

4. Als slaagt, worden de tokenclaims geëxtraheerd. Als de nonce-controle slaagt, worden de resultaten in geplaatst — een exemplaar van — en in de sessie opgeslagen. De toepassing kan vervolgens de uit de sessie instantiëren via een exemplaar van wanneer zij er toegang toe nodig heeft, zoals in de volgende code wordt weergegeven:

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

De routes beveiligen

Zie AuthenticationFilter.java voor informatie over hoe de voorbeeld-app de toegang tot routes filtert. In het bestand authentication.properties bevat de -eigenschap de door komma's gescheiden routes waartoe alleen geverifieerde gebruikers toegang hebben, zoals in het volgende voorbeeld wordt weergegeven:

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

Scopes

Scopes geven Microsoft Entra ID aan welk toegangsniveau de applicatie aanvraagt.

Op basis van de aangevraagde machtigingen toont Microsoft Entra ID de gebruiker een toestemmingsvenster wanneer deze zich aanmeldt. Als de gebruiker instemt met een of meer scopes en een token verkrijgt, worden de scopes waarvoor toestemming is gegeven gecodeerd in de resulterende .

Zie authentication.properties voor de machtigingen die door de toepassing zijn aangevraagd. Deze drie machtigingen worden standaard aangevraagd door MSAL en verleend door Microsoft Entra ID.

Meer informatie

• Microsoft Authentication Library (MSAL) voor Java
• Referentiedocumentatie voor MSAL Java
• Microsoft identity platform (Microsoft Entra ID voor ontwikkelaars)
• Snelstart: een toepassing registreren bij het Microsoft identity platform
• Inzicht in toestemmingservaringen voor toepassingen in Microsoft Entra ID
• Inzicht in toestemming van gebruikers en beheerders
• MSAL-codevoorbeelden