Bejelentkezés engedélyezése Java WebSphere-alkalmazásokhoz az MSAL4J és az Azure Active Directory B2C használatával

Ez a cikk egy Java Servlet-alkalmazást mutat be, amely az Azure Active Directory B2C (Azure AD B2C) használatával hitelesíti a felhasználókat a Microsoft Authentication Library for Java (MSAL4J) használatával.

Az alábbi ábrán az alkalmazás topológiája látható:

Az alkalmazás topológiáját bemutató diagram.

Az alkalmazás MSAL4J használatával jelentkezik be a felhasználókba, és egy azonosító jogkivonatot szerez be az Azure AD B2C-ből. Az azonosító jogkivonat igazolja, hogy a felhasználó hitelesítése egy Azure AD B2C-bérlőn történik.

Előfeltételek

• JDK 8-os vagy újabb verzió
• Maven 3
• Egy Azure AD B2C-bérlő. További információ : Oktatóanyag: Azure Active Directory B2C-bérlő létrehozása
• Egy felhasználói fiók az Azure AD B2C-bérlőben.

• WebSphere
• Visual Studio Code
• Azure Tools for Visual Studio Code

Ajánlások

• Néhány ismerős a Java / Jakarta Servlets.
• A Linux/OSX terminál ismerete.
• jwt.ms a jogkivonatok vizsgálatához.
• A Fiddler a hálózati tevékenység figyeléséhez és a hibaelhárításhoz.
• Kövesse a Microsoft Entra blogot , hogy up-tonaprakész maradjon a legújabb fejleményekkel.

A minta beállítása

Az alábbi szakaszok bemutatják, hogyan állíthatja be a mintaalkalmazást.

A mintaadattár klónozása vagy letöltése

A minta klónozásához nyisson meg egy Bash-ablakot, és használja a következő parancsot:

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

Másik lehetőségként keresse meg az ms-identity-msal-java-samples adattárat, majd töltse le .zip fájlként, és bontsa ki a merevlemezre.

Fontos

A Windows fájlelérési útvonalának korlátozásainak elkerülése érdekében klónozza vagy bontsa ki az adattárat a merevlemez gyökerének közelében található könyvtárba.

A mintaalkalmazás regisztrálása az Azure AD B2C-bérlővel

A minta egy előre regisztrált alkalmazással rendelkezik tesztelési célokra. Ha saját Azure AD B2C-bérlőt és -alkalmazást szeretne használni, kövesse az alábbi szakaszokban leírt lépéseket az alkalmazás Azure Portalon való regisztrálásához és konfigurálásához. Ellenkező esetben folytassa a minta futtatásának lépéseivel.

Válassza ki azt az Azure AD B2C-bérlőt, ahol az alkalmazásokat létre szeretné hozni

A bérlő kiválasztásához kövesse az alábbi lépéseket:

1. Jelentkezzen be az Azure Portalra.

2. Ha a fiókja több Azure AD B2C-bérlőben is megtalálható, válassza ki a profilját az Azure Portal sarkában, majd válassza a Címtár váltása lehetőséget a munkamenet kívánt Azure AD B2C-bérlőre való módosításához.

Felhasználói folyamatok és egyéni szabályzatok létrehozása

Ha olyan gyakori felhasználói folyamatokat szeretne létrehozni, mint a regisztráció, a bejelentkezés, a profil szerkesztése és a jelszó alaphelyzetbe állítása, tekintse meg a következő oktatóanyagot: Felhasználói folyamatok létrehozása az Azure Active Directory B2C-ben.

Érdemes lehet egyéni szabályzatokat is létrehozni az Azure Active Directory B2C-ben , de ez nem terjed ki az oktatóanyag hatókörére.

Külső identitásszolgáltatók hozzáadása

Lásd az oktatóanyagot: Identitásszolgáltatók hozzáadása az alkalmazásokhoz az Azure Active Directory B2C-ben.

Az alkalmazás regisztrálása (ms-identity-b2c-java-servlet-webapp-authentication)

Az alkalmazás regisztrálásához kövesse az alábbi lépéseket:

1. Lépjen az Azure Portalra , és válassza az Azure AD B2C-t.

2. Válassza az Alkalmazásregisztrációk lehetőséget a navigációs panelen, majd válassza az Új regisztráció lehetőséget.

3. A megjelenő Alkalmazás regisztrálása lapon adja meg a következő alkalmazásregisztrációs adatokat:

   • A Név szakaszban adjon meg egy értelmes alkalmazásnevet, amely megjeleníthető az alkalmazás felhasználói számára – példáulms-identity-b2c-java-servlet-webapp-authentication.
   • A Támogatott fióktípusok területen válassza a Fiókok lehetőséget bármely szervezeti címtárban és személyes Microsoft-fiókban (pl. Skype, Xbox, Outlook.com).
   • Az Átirányítási URI (nem kötelező) szakaszban válassza a Web lehetőséget a kombinált listában, és adja meg a következő átirányítási URI-t: http://localhost:8080/ms-identity-b2c-java-servlet-webapp-authentication/auth_redirect.

4. Válassza a Regisztráció elemet az alkalmazás létrehozásához.

5. Az alkalmazás regisztrációs oldalán keresse meg és másolja ki az alkalmazás (ügyfél) azonosítójának értékét, amelyet később használni szeretne. Ezt az értéket az alkalmazás konfigurációs fájljában vagy fájljaiban használja.

6. Válassza a Mentés lehetőséget a módosítások mentéséhez.

7. Az alkalmazás regisztrációs oldalán válassza a Tanúsítványok > titkos kulcsok lehetőséget a navigációs panelen a titkos kulcsok létrehozására és tanúsítványok feltöltésére szolgáló lap megnyitásához.

8. Az Ügyfél titkos kulcsok szakaszban válassza az Új ügyfélkód lehetőséget.

9. Írja be a leírást – például az alkalmazás titkos kódját.

10. Válasszon egyet a rendelkezésre álló időtartamok közül: 1 év, 2 év alatt vagy Soha nem jár le.

11. Válassza a Hozzáadás lehetőséget. Megjelenik a létrehozott érték.

12. Másolja és mentse a létrehozott értéket a későbbi lépésekben való használatra. Szüksége van erre az értékre a kód konfigurációs fájljaihoz. Ez az érték nem jelenik meg újra, és más módon nem kérhető le. Ezért mindenképpen mentse az Azure Portalról, mielőtt bármilyen más képernyőre vagy panelre navigálna.

Konfigurálja az alkalmazást (ms-identity-b2c-java-servlet-webapp-authentication) az alkalmazásregisztráció használatára

Az alkalmazás konfigurálásához kövesse az alábbi lépéseket:

Feljegyzés

A következő lépésekben ugyanaz, ClientID mint Application ID vagy AppId.

1. Nyissa meg a projektet az IDE-ben.

2. Nyissa meg a ./src/main/resources/authentication.properties fájlt.

3. Keresse meg a aad.clientId tulajdonságot, és cserélje le a meglévő értéket az alkalmazásazonosítóra vagy clientId az alkalmazásra az ms-identity-b2c-java-servlet-webapp-authentication Azure Portalon.

4. Keresse meg a aad.secret tulajdonságot, és cserélje le a meglévő értéket az alkalmazás létrehozása során az ms-identity-b2c-java-servlet-webapp-authentication Azure Portalról mentett értékre.

5. Keresse meg a aad.scopes tulajdonságot, és cserélje le a meglévő alkalmazás ügyfélazonosítóját a szakasz 1. lépésében megadott aad.clientId értékre.

6. Keresse meg a aad.authority tulajdonságot, és cserélje le az első példányt fabrikamb2c annak az Azure AD B2C-bérlőnek a nevére, amelyben az ms-identity-b2c-java-servlet-webapp-authentication alkalmazást az Azure Portalon hozta létre.

7. Keresse meg a aad.authority tulajdonságot, és cserélje le a második példányt fabrikamb2c annak az Azure AD B2C-bérlőnek a nevére, amelyben az ms-identity-b2c-java-servlet-webapp-authentication alkalmazást az Azure Portalon hozta létre.

8. Keresse meg a aad.signInPolicy tulajdonságot, és cserélje le annak a regisztrációs/bejelentkezési felhasználói folyamat szabályzatnak a nevére, amelyet abban az Azure AD B2C-bérlőben hozott létre, amelyben az alkalmazást az ms-identity-b2c-java-servlet-webapp-authentication Azure Portalon hozta létre.

9. Keresse meg a aad.passwordResetPolicy tulajdonságot, és cserélje le az Azure AD B2C-bérlőben létrehozott jelszó-visszaállítási felhasználói folyamat szabályzat nevére, amelyben az alkalmazást az ms-identity-b2c-java-servlet-webapp-authentication Azure Portalon hozta létre.

10. Keresse meg a aad.editProfilePolicy tulajdonságot, és cserélje le az Azure AD B2C-bérlőben létrehozott szerkesztési profil felhasználói folyamat szabályzatának nevére, amelyben az alkalmazást az ms-identity-b2c-java-servlet-webapp-authentication Azure Portalon hozta létre.

A minta összeállítása

Ha a mintát a Maven használatával szeretné létrehozni, keresse meg a minta pom.xml fájljának könyvtárát, majd futtassa a következő parancsot:

mvn clean package

Ez a parancs létrehoz egy .war fájlt, amelyet különböző alkalmazáskiszolgálókon futtathat.

Minta futtatása

Ezek az utasítások feltételezik, hogy telepítette a WebSphere-et, és beállított egy kiszolgálót. Az alapszintű kiszolgálóbeállításhoz használhatja a WebSphere Application Server (hagyományos) fürt Üzembe helyezése Azure-beli virtuális gépeken című útmutatót.

Mielőtt üzembe helyezhető a WebSphere-ben, az alábbi lépésekkel végezze el a minta konfigurációs módosításait, majd hozza létre vagy építse újra a csomagot:

1. Lépjen az alkalmazás authentication.properties fájljára, és módosítsa a használni kívánt kiszolgáló URL-címét és portszámátapp.homePage, ahogyan az alábbi példában látható:

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

2. A fájl mentése után használja az alábbi parancsot az alkalmazás újraépítéséhez:

   mvn clean package
   

3. Miután a kód elkészült, másolja át a .war fájlt a célkiszolgáló fájlrendszerére.

Ugyanezt a módosítást kell elvégeznie az Azure-alkalmazásregisztrációban is, ahol az Azure Portalon az Átirányítási URI értékként van beállítva a Hitelesítés lapon.

1. Lépjen a Microsoft Identitásplatform fejlesztőknek Alkalmazásregisztrációk lapra.

2. A keresőmező használatával keresse meg az alkalmazásregisztrációt – például java-servlet-webapp-authentication.

3. Nyissa meg az alkalmazásregisztrációt a nevének kiválasztásával.

4. Válassza a Hitelesítés lehetőséget a menüben.

5. A Webes - átirányítási URI-k szakaszban válassza az URI hozzáadása lehetőséget.

6. Töltse ki az alkalmazás URI-ját, és fűzze hozzá az /auth/redirect parancsot – például https://<server-url>:<port-number>/auth/redirect.

7. Válassza a Mentés lehetőséget.

A minta üzembe helyezéséhez kövesse az alábbi lépéseket a WebSphere integrált megoldáskonzoljával:

1. Az Alkalmazások lapon válassza az Új alkalmazás, majd az Új vállalati alkalmazás lehetőséget.

2. Válassza ki a létrehozott .war fájlt, majd válassza a Tovább lehetőséget, amíg el nem ér a Webmodulok telepítési lépéséhez tartozó Map context roots elemhez. A többi alapértelmezett beállításnak megfelelőnek kell lennie.

3. A környezet gyökeréhez állítsa be ugyanazt az értéket, mint a mintakonfigurációban/Azure-alkalmazásregisztrációban beállított "Átirányítási URI" portszáma után. Vagyis ha az átirányítási URI az http://<server-url>:9080/msal4j-servlet-auth/, akkor a környezet gyökerének kell lennie msal4j-servlet-auth.

4. Válassza a Befejezés lehetőséget.

5. Miután az alkalmazás telepítése befejeződött, lépjen az Alkalmazások lap WebSphere vállalati alkalmazások szakaszára.

6. Válassza ki a telepített .war fájlt az alkalmazások listájából, majd válassza a Telepítés indítása lehetőséget.

7. Az üzembe helyezés befejezése után lépjen az http://<server-url>:9080/{whatever you set as the context root} alkalmazásra, és látnia kell az alkalmazást.

A minta vizsgálata

A minta megismeréséhez kövesse az alábbi lépéseket:

1. Figyelje meg a bejelentkezett vagy kijelentkezett állapotot a képernyő közepén.
2. Válassza a sarokban található környezetérzékeny gombot. Ez a gomb beolvassa a bejelentkezést az alkalmazás első futtatásakor.
3. A következő lapon kövesse az utasításokat, és jelentkezzen be a kiválasztott identitásszolgáltató fiókjával.
4. Figyelje meg, hogy a környezetfüggő gomb most kijelentkezik , és megjeleníti a felhasználónevét.
5. Válassza az Azonosító jogkivonat részletei lehetőséget az azonosító jogkivonat egyes dekódolt jogcímeinek megtekintéséhez.
6. Lehetősége van a profil szerkesztésére is. A hivatkozásra kattintva szerkesztheti az olyan részleteket, mint a megjelenített név, a lakóhely és a foglalkozás.
7. A kijelentkezéshez használja a sarokban lévő gombot.
8. A kijelentkezés után keresse meg a következő URL-címet a jogkivonat részleteinek oldalához: http://localhost:8080/ms-identity-b2c-java-servlet-webapp-authentication/auth_token_details. Itt megfigyelheti, hogy az alkalmazás hogyan jelenít meg hibát 401: unauthorized az azonosító jogkivonat jogcímei helyett.

Tudnivalók a kódról

Ez a minta bemutatja, hogyan használhatja az MSAL4J-t a felhasználók Azure AD B2C-bérlőbe való bejelentkezésére.

Tartalom

Az alábbi táblázat a mintaprojekt mappájának tartalmát mutatja be:

Fájl/mappa	Leírás
AuthHelper.java	Segédfüggvények a hitelesítéshez.
Config.java	Indításkor fut, és konfigurálja a tulajdonságolvasót és a naplózót.
authentication.properties	Microsoft Entra-azonosító és programkonfiguráció.
AuthenticationFilter.java	A nem hitelesített kéréseket átirányítja a védett erőforrásokra egy 401-es lapra.
MsalAuthSession	Példányosított egy HttpSession. Az MSAL-hez kapcsolódó munkamenet-attribútumokat a munkamenet attribútumban tárolja.
*Servlet.java	Az összes elérhető végpont java osztályokban van definiálva, amelyek neve Servlet.végződik.
CHANGELOG.md	A minta módosításainak listája.
CONTRIBUTING.md	Útmutató a mintához való hozzájáruláshoz.
LICENC	A minta licence.

ConfidentialClientApplication

A rendszer létrehoz egy ConfidentialClientApplication példányt a AuthHelper.java fájlban, ahogy az az alábbi példában is látható. Ez az objektum segít létrehozni az Azure AD B2C engedélyezési URL-címét, és segít a hitelesítési jogkivonat cseréjében egy hozzáférési jogkivonathoz.

IClientSecret secret = ClientCredentialFactory.createFromSecret(SECRET);
confClientInstance = ConfidentialClientApplication
                     .builder(CLIENT_ID, secret)
                     .b2cAuthority(AUTHORITY + policy)
                     .build();

A rendszer a következő paramétereket használja a példányosításhoz:

• Az alkalmazás ügyfélazonosítója.
• Az ügyfél titkos kódja, amely a bizalmas ügyfélalkalmazások követelménye.
• Az Azure AD B2C-szolgáltató összefűzve van a UserFlowPolicy megfelelő regisztrációhoz, bejelentkezéshez, profil-szerkesztéshez vagy jelszó-visszaállításhoz.

Ebben a mintában ezeket az értékeket a rendszer a authentication.properties fájlból olvassa be a Config.java fájl egyik tulajdonságolvasójának használatával.

Útmutató lépésről lépésre

Az alábbi lépések bemutatja az alkalmazás funkcióit:

1. A bejelentkezési folyamat első lépése egy kérés küldése az /authorize Azure Active Directory B2C-bérlő végpontjára. Az MSAL4J-példány ConfidentialClientApplication egy engedélyezési kérelem URL-címének létrehozására szolgál, és az alkalmazás átirányítja a böngészőt erre az URL-címre, ahogyan az a következő példában látható:

   final ConfidentialClientApplication client = getConfidentialClientInstance(policy);
   final AuthorizationRequestUrlParameters parameters = AuthorizationRequestUrlParameters
       .builder(REDIRECT_URI, Collections.singleton(SCOPES)).responseMode(ResponseMode.QUERY)
       .prompt(Prompt.SELECT_ACCOUNT).state(state).nonce(nonce).build();
   
   final String redirectUrl = client.getAuthorizationRequestUrl(parameters).toString();
   Config.logger.log(Level.INFO, "Redirecting user to {0}", redirectUrl);
   resp.setStatus(302);
   resp.sendRedirect(redirectUrl);
   

   Az alábbi lista a kód funkcióit ismerteti:

   • AuthorizationRequestUrlParameters: Az AuthorizationRequestUrl létrehozásához be kell állítani paramétereket.

   • REDIRECT_URI: Ahol az Azure AD B2C átirányítja a böngészőt a hitelesítési kóddal együtt a felhasználói hitelesítő adatok gyűjtése után.

   • SCOPES: A hatókörök az alkalmazás által kért engedélyek.

     Általában a három hatókör openid profile offline_access elegendő lenne egy azonosító jogkivonat-válasz fogadásához. Az MSAL4J azonban megköveteli, hogy az Azure AD B2C minden válasza tartalmazzon hozzáférési jogkivonatot is.

     Ahhoz, hogy az Azure AD B2C kiadhasson egy hozzáférési jogkivonatot és egy azonosító jogkivonatot, a kérésnek tartalmaznia kell egy további erőforrás-hatókört. Mivel ez az alkalmazás valójában nem igényel külső erőforrás-hatókört, negyedik hatókörként hozzáadja a saját ügyfél-azonosítóját a hozzáférési jogkivonat fogadásához.

     Az alkalmazás által kért hatókörök teljes listáját a authentication.properties fájlban találja.

   • ResponseMode.QUERY: Az Azure AD B2C egy HTTP POST-kérelemben űrlapparamákként vagy egy HTTP GET-kérelem lekérdezési sztringparamjaként adja vissza a választ.

   • Prompt.SELECT_ACCOUNT: Az Azure AD B2C-nek meg kell kérnie a felhasználót, hogy válassza ki azt a fiókot, amellyel hitelesítést kíván végezni.

   • state: Az alkalmazás által az egyes jogkivonat-kérelmek munkamenetébe beállított egyedi változó, amely a megfelelő Azure AD B2C-átirányítási visszahívás fogadása után megsemmisül. Az állapotváltozó biztosítja, hogy az Azure AD B2C-kérések ténylegesen az /auth_redirect endpoint alkalmazásból és ebből a munkamenetből származó Azure AD B2C engedélyezési kérelmekből származnak, ezáltal megelőzve a CSRF-támadásokat. Ez a AADRedirectServlet.java fájlban történik.

   • nonce: Az alkalmazás által az egyes jogkivonat-kérelmek munkamenetébe beállított egyedi változó, amely a megfelelő jogkivonat fogadása után megsemmisült. Ez a nonce át lesz írva az azure AD B2C-nek kiosztott jogkivonatokra, így biztosítva, hogy ne fordul elő jogkivonat-visszajátszásos támadás.

2. Az Azure Active Directory B2C egy bejelentkezési kérést jelenít meg a felhasználónak. Ha a bejelentkezési kísérlet sikeres, a rendszer átirányítja a felhasználó böngészőjét az alkalmazás átirányítási végpontjára. A végpontra irányuló érvényes kérés tartalmaz egy engedélyezési kódot.

3. A ConfidentialClientApplication példány ezután kicseréli ezt az engedélyezési kódot egy azonosító jogkivonatra és hozzáférési jogkivonatra az Azure Active Directory B2C-ből, az alábbi példában látható módon:

   final AuthorizationCodeParameters authParams = AuthorizationCodeParameters
                       .builder(authCode, new URI(REDIRECT_URI))
                       .scopes(Collections.singleton(SCOPES)).build();
   
   final ConfidentialClientApplication client = AuthHelper
           .getConfidentialClientInstance(policy);
   final Future<IAuthenticationResult> future = client.acquireToken(authParams);
   final IAuthenticationResult result = future.get();
   

   Az alábbi lista a kód funkcióit ismerteti:

   • AuthorizationCodeParameters: Olyan paraméterek, amelyeket be kell állítani az engedélyezési kód azonosítóra és/vagy hozzáférési jogkivonatra való cseréjéhez.
   • authCode: Az átirányítási végponton kapott engedélyezési kód.
   • REDIRECT_URI: Az előző lépésben használt átirányítási URI-t ismét át kell adni.
   • SCOPES: Az előző lépésben használt hatóköröket ismét át kell adni.

4. Ha acquireToken a jogkivonat-jogcímek sikeresek, a rendszer kinyeri a jogkivonat-jogcímeket, és érvényesíti a nem érvényes jogcímet a munkamenetben tárolt nem jogkivonattal szemben, az alábbi példában látható módon:

   parseJWTClaimsSetAndStoreResultInSession(msalAuth, result, serializedTokenCache);
   validateNonce(msalAuth)
   processSuccessfulAuthentication(msalAuth);
   

5. Ha a nem érvényesítés sikeresen megtörtént, a hitelesítési állapot egy kiszolgálóoldali munkamenetbe kerül, az MsalAuthSession osztály által közzétett metódusok használatával, ahogyan az alábbi példában látható:

   msalAuth.setAuthenticated(true);
   msalAuth.setUsername(msalAuth.getIdTokenClaims().get("name"));
   

További információ

• Mi az az Azure Active Directory B2C?
• Az Active Directory B2C-ben használható alkalmazástípusok
• Azure Active Directory B2C-vel kapcsolatos javaslatok és ajánlott eljárások
• Azure AD B2C-munkamenet
• Microsoft Authentication Library (MSAL) Java-hoz

További információ az OAuth 2.0 protokollok működéséről ebben a forgatókönyvben és más forgatókönyvekben: Hitelesítési forgatókönyvek a Microsoft Entra ID-hoz.

Következő lépés

Java WebSphere-alkalmazások üzembe helyezése a hagyományos WebSphere-ben azure-beli virtuális gépeken