Freigeben über

Aktivieren der Anmeldung für Java WebSphere-Apps mit MSAL4J mit Azure Active Directory B2C

  • Artikel

Dieser Artikel veranschaulicht eine Java Servlet-Anwendung, die Benutzer mit Azure Active Directory B2C (Azure AD B2C) mithilfe der Microsoft-Authentifizierungsbibliothek für Java (MSAL4J) authentifiziert.

Das folgende Diagramm zeigt die Topologie der App:

Diagramm, das die Topologie der App zeigt.

Die App verwendet MSAL4J, um Benutzer anzumelden und ein ID-Token von Azure AD B2C abzurufen. Das ID-Token beweist, dass der Benutzer bei einem Azure AD B2C-Mandanten authentifiziert wird.

Voraussetzungen

Empfehlungen

  • Einige Kenntnisse mit den Java / Jakarta Servlets.
  • Vertrautheit mit Linux/OSX-Terminal oder Windows PowerShell.
  • jwt.ms zum Überprüfen Ihrer Token.
  • Fiddler zur Überwachung Ihrer Netzwerkaktivität und Problembehandlung.
  • Folgen Sie dem Microsoft Entra ID-Blog , um mit den neuesten Entwicklungen auf dem neuesten Stand zu bleiben.

Einrichten des Beispiels

In den folgenden Abschnitten wird gezeigt, wie Sie die Beispielanwendung einrichten.

Klonen oder Herunterladen des Beispiel-Repositorys

Um das Beispiel zu klonen, öffnen Sie ein Bash-Fenster, und verwenden Sie den folgenden Befehl:

git clone https://github.com/Azure-Samples/ms-identity-java-servlet-webapp-authentication.git
cd 1-Authentication/sign-in-b2c

Navigieren Sie alternativ zum Repository "ms-identity-java-servlet-webapp-authentication ", und laden Sie sie dann als .zip Datei herunter, und extrahieren Sie sie auf Ihre Festplatte.

Wichtig

Um Dateipfadlängenbeschränkungen für Windows zu vermeiden, klonen Oder extrahieren Sie das Repository in ein Verzeichnis in der Nähe des Stammverzeichnisses Ihrer Festplatte.

Registrieren der Beispielanwendung bei Ihrem Azure AD B2C-Mandanten

Das Beispiel enthält eine vorab registrierte Anwendung zu Testzwecken. Wenn Sie Ihren eigenen Azure AD B2C-Mandanten und Ihre eigene Anwendung verwenden möchten, führen Sie die Schritte in den folgenden Abschnitten aus, um die Anwendung im Azure-Portal zu registrieren und zu konfigurieren. Fahren Sie andernfalls mit den Schritten zum Ausführen des Beispiels fort.

Wählen Sie den Azure AD B2C-Mandanten aus, in dem Sie Ihre Anwendungen erstellen möchten.

Führen Sie die folgenden Schritte aus, um Ihren Mandanten auszuwählen:

  1. Melden Sie sich beim Azure-Portal an.

  2. Wenn Ihr Konto in mehr als einem Azure AD B2C-Mandanten vorhanden ist, wählen Sie Ihr Profil in der Ecke des Azure-Portal aus, und wählen Sie dann "Verzeichnis wechseln" aus, um Ihre Sitzung in den gewünschten Azure AD B2C-Mandanten zu ändern.

Erstellen von Benutzerflüssen und benutzerdefinierten Richtlinien

Informationen zum Erstellen allgemeiner Benutzerflüsse wie Registrierung, Anmeldung, Profilbearbeitung und Kennwortzurücksetzung finden Sie im Lernprogramm: Erstellen von Benutzerflüssen in Azure Active Directory B2C.

Sie sollten auch das Erstellen von benutzerdefinierten Richtlinien in Azure Active Directory B2C in Betracht ziehen, dies liegt jedoch außerhalb des Umfangs dieses Lernprogramms.

Hinzufügen externer Identitätsanbieter

Siehe Lernprogramm: Hinzufügen von Identitätsanbietern zu Ihren Anwendungen in Azure Active Directory B2C.

Registrieren der App (ms-identity-b2c-java-servlet-webapp-authentication)

Führen Sie die folgenden Schritte aus, um die App zu registrieren:

  1. Navigieren Sie zum Azure-Portal, und wählen Sie Azure AD B2C aus.

  2. Wählen Sie im Navigationsbereich "App-Registrierungen" und dann "Neue Registrierung" aus.

  3. Geben Sie auf der angezeigten Seite "Anwendung registrieren" die folgenden Anwendungsregistrierungsinformationen ein:

    • Geben Sie im Abschnitt "Name " einen aussagekräftigen Anwendungsnamen ein, der Benutzern der App angezeigt werden soll , ms-identity-b2c-java-servlet-webapp-authenticationz. B. .
    • Wählen Sie unter Unterstützte Kontotypen die Option Konten in allen Organisationsverzeichnissen und persönliche Microsoft-Konten (z.B. Skype, Xbox, Outlook.com) aus.
    • Wählen Sie im Abschnitt "Umleitungs-URI (optional)" im Kombinationsfeld "Web" aus, und geben Sie den folgenden Umleitungs-URI ein: http://localhost:8080/ms-identity-b2c-java-servlet-webapp-authentication/auth_redirect

  4. Wählen Sie Registrieren aus, um die Anwendung zu erstellen.

  5. Suchen Und kopieren Sie auf der Registrierungsseite der App den Wert der Anwendungs-ID (Client-ID ), die Sie später verwenden möchten. Sie verwenden diesen Wert in der Konfigurationsdatei oder -dateien Ihrer App.

  6. Wählen Sie Speichern aus, um die Änderungen zu speichern.

  7. Wählen Sie auf der Registrierungsseite der App im Navigationsbereich zertifikate und geheime Schlüssel aus, um die Seite zu öffnen, auf der Sie Geheime Schlüssel generieren und Zertifikate hochladen können.

  8. Wählen Sie im Abschnitt Geheime Clientschlüssel die Option Neuer geheimer Clientschlüssel aus.

  9. Geben Sie eine Beschreibung ein, z. B. den geheimen App-Schlüssel.

  10. Wählen Sie eine der verfügbaren Dauer aus: In 1 Jahr, in 2 Jahren oder nie abläuft.

  11. Wählen Sie Hinzufügen aus. Der generierte Wert wird angezeigt.

  12. Kopieren und speichern Sie den generierten Wert für die Verwendung in späteren Schritten. Sie benötigen diesen Wert für die Konfigurationsdateien Ihres Codes. Dieser Wert wird nicht mehr angezeigt, und Sie können ihn nicht auf andere Weise abrufen. Achten Sie daher darauf, sie aus dem Azure-Portal zu speichern, bevor Sie zu einem anderen Bildschirm oder Bereich navigieren.

Konfigurieren der App (ms-identity-b2c-java-servlet-webapp-authentication) für die Verwendung der App-Registrierung

Führen Sie die folgenden Schritte aus, um die App zu konfigurieren:

Hinweis

In den folgenden Schritten ClientID ist identisch mit Application ID oder AppId.

  1. Öffnen Sie das Projekt in Ihrer IDE.

  2. Öffnen Sie die Datei ./src/Standard/resources/authentication.properties.

  3. Suchen Sie die aad.clientId Eigenschaft, und ersetzen Sie den vorhandenen Wert durch die Anwendungs-ID oder clientId die ms-identity-b2c-java-servlet-webapp-authentication Anwendung aus dem Azure-Portal.

  4. Suchen Sie die aad.secret Eigenschaft, und ersetzen Sie den vorhandenen Wert durch den Wert, den Sie während der Erstellung der ms-identity-b2c-java-servlet-webapp-authentication Anwendung aus dem Azure-Portal gespeichert haben.

  5. Suchen Sie die Eigenschaft, und ersetzen Sie die aad.scopes vorhandene AnwendungsclientId durch den Wert, den Sie in Schritt 1 dieses Abschnitts eingefügt aad.clientId haben.

  6. Suchen Sie die aad.authority Eigenschaft, und ersetzen Sie die erste Instanz fabrikamb2c durch den Namen des Azure AD B2C-Mandanten, in dem Sie die ms-identity-b2c-java-servlet-webapp-authentication Anwendung im Azure-Portal erstellt haben.

  7. Suchen Sie die aad.authority Eigenschaft, und ersetzen Sie die zweite Instanz fabrikamb2c durch den Namen des Azure AD B2C-Mandanten, in dem Sie die ms-identity-b2c-java-servlet-webapp-authentication Anwendung im Azure-Portal erstellt haben.

  8. Suchen Sie die aad.signInPolicy Eigenschaft, und ersetzen Sie sie durch den Namen der Registrierungs-/Anmelde-Benutzerflussrichtlinie, die Sie im Azure AD B2C-Mandanten erstellt haben, in dem Sie die ms-identity-b2c-java-servlet-webapp-authentication Anwendung im Azure-Portal erstellt haben.

  9. Suchen Sie die aad.passwordResetPolicy Eigenschaft, und ersetzen Sie sie durch den Namen der Richtlinie zum Zurücksetzen des Benutzerflusses, die Sie im Azure AD B2C-Mandanten erstellt haben, in dem Sie die ms-identity-b2c-java-servlet-webapp-authentication Anwendung im Azure-Portal erstellt haben.

  10. Suchen Sie die aad.editProfilePolicy Eigenschaft, und ersetzen Sie sie durch den Namen der Edit Profile User-Flow-Richtlinie, die Sie im Azure AD B2C-Mandanten erstellt haben, in dem Sie die ms-identity-b2c-java-servlet-webapp-authentication Anwendung im Azure-Portal erstellt haben.

Erstellen des Beispiels

Um das Beispiel mit Maven zu erstellen, navigieren Sie zu dem Verzeichnis, das die pom.xml Datei für das Beispiel enthält, und führen Sie dann den folgenden Befehl aus:

mvn clean package

Dieser Befehl generiert eine WAR-Datei , die Sie auf einer Vielzahl von Anwendungsservern ausführen können.

Ausführen des Beispiels

Bei diesen Anweisungen wird davon ausgegangen, dass Sie WebSphere installiert und einen Server eingerichtet haben. Sie können die Anleitungen unter Deploy WebSphere Application Server (herkömmlicher) Cluster auf virtuellen Azure-Computern für eine einfache Servereinrichtung verwenden.

Bevor Sie in WebSphere bereitstellen können, führen Sie die folgenden Schritte aus, um einige Konfigurationsänderungen im Beispiel selbst vorzunehmen und dann das Paket zu erstellen oder neu zu erstellen:

  1. Navigieren Sie zur Datei "authentication.properties" Ihrer App, und ändern Sie den Wert ihrer app.homePage Server-URL und Portnummer, die Sie verwenden möchten, wie im folgenden Beispiel gezeigt:

    # 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. Verwenden Sie nach dem Speichern dieser Datei den folgenden Befehl, um Ihre App neu zu erstellen:

    mvn clean package

  3. Nachdem der Code die Erstellung abgeschlossen hat, kopieren Sie die WAR-Datei auf das Dateisystem des Zielservers.

Außerdem müssen Sie dieselbe Änderung in der Azure-App-Registrierung vornehmen, bei der Sie sie im Azure-Portal als Umleitungs-URI-Wert auf der Registerkarte "Authentifizierung" festlegen.

  1. Navigieren Sie zur Seite App-Registrierungen von Microsoft Identity Platform für Entwickler.

  2. Verwenden Sie das Suchfeld, um nach Ihrer App-Registrierung zu suchen , java-servlet-webapp-authenticationz. B. .

  3. Öffnen Sie die App-Registrierung, indem Sie den Namen auswählen.

  4. Wählen Sie im oberen Menü Authentifizierung aus.

  5. Wählen Sie im Abschnitt "Webumleitungs-URIs - " die Option "URI hinzufügen" aus.

  6. Füllen Sie den URI Ihrer App aus, indem Sie /auth/redirect anfügen , https://<server-url>:<port-number>/auth/redirectz. B. .

  7. Wählen Sie Speichern.

Führen Sie die folgenden Schritte aus, um das Beispiel mithilfe der Integrated Solutions Console von WebSphere bereitzustellen:

  1. Wählen Sie auf der Registerkarte "Anwendungen " die Option "Neue Anwendung" und dann " Neue Unternehmensanwendung" aus.

  2. Wählen Sie die von Ihnen erstellten WAR-Datei aus, und wählen Sie dann "Weiter" aus, bis Sie zum Installationsschritt " Map context roots" für Webmodule gelangen. Die anderen Standardeinstellungen sollten einwandfrei sein.

  3. Legen Sie für den Kontextstamm denselben Wert wie nach der Portnummer im "Umleitungs-URI" fest, den Sie in der Beispielkonfiguration/Azure-App-Registrierung festgelegt haben. Das heißt, wenn der Umleitungs-URI lautet http://<server-url>:9080/msal4j-servlet-auth/, sollte msal4j-servlet-authder Kontextstamm sein.

  4. Wählen Sie Fertig stellenaus.

  5. Wechseln Sie nach Abschluss der Installation der Anwendung zum Abschnitt "WebSphere-Unternehmensanwendungen " auf der Registerkarte "Anwendungen ".

  6. Wählen Sie die WAR-Datei aus der Liste der Anwendungen aus, und wählen Sie dann "Start für die Bereitstellung" aus.

  7. Navigieren Sie nach Abschluss der Bereitstellung zu http://<server-url>:9080/{whatever you set as the context root} der Anwendung, und Sie sollten in der Lage sein, die Anwendung anzuzeigen.

Untersuchen des Beispiels

Führen Sie die folgenden Schritte aus, um das Beispiel zu erkunden:

  1. Beachten Sie den angemeldeten oder abgemeldeten Status, der in der Mitte des Bildschirms angezeigt wird.
  2. Wählen Sie in der Ecke die Schaltfläche "Kontextsensitiv" aus. Diese Schaltfläche liest die Anmeldung , wenn Sie die App zum ersten Mal ausführen.
  3. Folgen Sie auf der nächsten Seite den Anweisungen, und melden Sie sich mit einem Konto Ihres ausgewählten Identitätsanbieters an.
  4. Beachten Sie, dass die Kontextsensitive Schaltfläche jetzt "Abmelden" anzeigt und Ihren Benutzernamen anzeigt.
  5. Wählen Sie ID-Tokendetails aus, um einige der decodierten Ansprüche des ID-Tokens anzuzeigen.
  6. Sie haben auch die Möglichkeit, Ihr Profil zu bearbeiten. Wählen Sie den Link aus, um Details wie Ihren Anzeigenamen, Ihren Aufenthaltsort und Ihren Beruf zu bearbeiten.
  7. Verwenden Sie die Schaltfläche in der Ecke, um sich abzumelden.
  8. Navigieren Sie nach dem Abmelden zur folgenden URL für die Tokendetailseite: http://localhost:8080/ms-identity-b2c-java-servlet-webapp-authentication/auth_token_details. Hier können Sie beobachten, wie die App anstelle der ID-Tokenansprüche einen 401: unauthorized Fehler anzeigt.

Informationen zum Code

In diesem Beispiel wird die Verwendung von MSAL4J zum Anmelden von Benutzern bei Ihrem Azure AD B2C-Mandanten veranschaulicht.

Contents

Die folgende Tabelle zeigt den Inhalt des Beispielprojektordners:

Datei/Ordner Beschreibung
AuthHelper.java Hilfsfunktionen für die Authentifizierung.
Config.java Wird beim Start ausgeführt und konfiguriert eigenschaftenleser und Logger.
authentication.properties Microsoft Entra ID und Programmkonfiguration.
AuthenticationFilter.java Leitet nicht authentifizierte Anforderungen an geschützte Ressourcen auf eine 401-Seite um.
MsalAuthSession Instanziiert mit einem HttpSession. Speichert alle MSAL-bezogenen Sitzungsattribute im Sitzungsattribut.
____Servlet.java Alle verfügbaren Endpunkte werden in .java Klassen definiert, die auf ____Servlet.java enden.
CHANGELOG.md Liste der Änderungen am Beispiel.
CONTRIBUTING.md Richtlinien für einen Beitrag zur Stichprobe.
LIZENZ Die Lizenz für das Beispiel.

ConfidentialClientApplication

Eine ConfidentialClientApplication Instanz wird in der datei AuthHelper.java erstellt, wie im folgenden Beispiel gezeigt. Dieses Objekt hilft beim Erstellen der Azure AD B2C-Autorisierungs-URL und hilft auch beim Austauschen des Authentifizierungstokens für ein Zugriffstoken.

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

Die folgenden Parameter werden für die Instanziierung verwendet:

  • Die Client-ID der App.
  • Der geheime Clientschlüssel, der eine Anforderung für vertrauliche Clientanwendungen ist.
  • Die Azure AD B2C Authority verkettet sich mit der geeigneten UserFlowPolicy Option für die Registrierung, Anmeldung, Profilbearbeitung oder Kennwortzurücksetzung.

In diesem Beispiel werden diese Werte aus der Datei "authentication.properties " mithilfe eines Eigenschaftenlesers in der datei Config.java gelesen.

Ausführliche exemplarische Vorgehensweise

Die folgenden Schritte bieten eine exemplarische Vorgehensweise für die Funktionalität der App:

  1. Der erste Schritt des Anmeldevorgangs besteht darin, eine Anforderung an den /authorize Endpunkt für Ihren Azure Active Directory B2C-Mandanten zu senden. Die MSAL4J-Instanz ConfidentialClientApplication wird verwendet, um eine Autorisierungsanforderungs-URL zu erstellen, und die App leitet den Browser zu dieser URL um, wie im folgenden Beispiel gezeigt:

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

    In der folgenden Liste werden die Features dieses Codes beschrieben:

    • AuthorizationRequestUrlParameters: Parameter, die festgelegt werden müssen, um eine AuthorizationRequestUrl zu erstellen.

    • REDIRECT_URI: Wo Azure AD B2C den Browser zusammen mit dem Authentifizierungscode umleitet, nachdem die Benutzeranmeldeinformationen gesammelt wurden.

    • SCOPES: Bereiche sind Berechtigungen, die von der Anwendung angefordert werden.

      Normalerweise reichen die drei Bereiche openid profile offline_access für den Empfang einer ID-Tokenantwort aus. MSAL4J erfordert jedoch alle Antworten von Azure AD B2C, um auch ein Zugriffstoken zu enthalten.

      Damit Azure AD B2C ein Zugriffstoken sowie ein ID-Token ausgibt, muss die Anforderung einen zusätzlichen Ressourcenbereich enthalten. Da für diese App kein externer Ressourcenbereich erforderlich ist, fügt sie eine eigene Client-ID als vierten Bereich hinzu, um ein Zugriffstoken zu erhalten.

      Eine vollständige Liste der Bereiche, die von der App angefordert werden, finden Sie in der Datei "authentication.properties ".

    • ResponseMode.QUERY: Azure AD B2C kann die Antwort als Formularparameter in einer HTTP POST-Anforderung oder als Abfragezeichenfolgenparameter in einer HTTP GET-Anforderung zurückgeben.

    • Prompt.SELECT_ACCOUNT: Azure AD B2C sollte den Benutzer bitten, das Konto auszuwählen, für das er sich authentifizieren möchte.

    • state: Eine eindeutige Variable, die von der App in die Sitzung in jeder Tokenanforderung festgelegt und nach Erhalt des entsprechenden Azure AD B2C-Umleitungsrückrufs zerstört wurde. Die Statusvariable stellt sicher, dass Azure AD B2C-Anforderungen /auth_redirect endpoint tatsächlich von Azure AD B2C-Autorisierungsanforderungen stammen, die von dieser App und dieser Sitzung stammen, wodurch CSRF-Angriffe verhindert werden. Dies geschieht in der datei AADRedirectServlet.java .

    • nonce: Eine eindeutige Variable, die von der App in die Sitzung in jeder Tokenanforderung festgelegt und nach erhalt des entsprechenden Tokens zerstört wird. Diese Nonce wird an die resultierenden Token verteilt Azure AD B2C transkribiert, wodurch sichergestellt wird, dass kein Token-Replay-Angriff auftritt.

  2. Dem Benutzer wird eine Anmeldeaufforderung von Azure Active Directory B2C angezeigt. Wenn der Anmeldeversuch erfolgreich ist, wird der Browser des Benutzers an den Umleitungsendpunkt der App umgeleitet. Eine gültige Anforderung an diesen Endpunkt enthält einen Autorisierungscode.

  3. Anschließend wechselt die ConfidentialClientApplication Instanz diesen Autorisierungscode für ein ID-Token und zugriffstoken aus Azure Active Directory B2C, wie im folgenden Beispiel gezeigt:

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

    In der folgenden Liste werden die Features dieses Codes beschrieben:

    • AuthorizationCodeParameters: Parameter, die festgelegt werden müssen, um den Autorisierungscode für eine ID und/oder ein Zugriffstoken auszutauschen.
    • authCode: Der Autorisierungscode, der am Umleitungsendpunkt empfangen wurde.
    • REDIRECT_URI: Der im vorherigen Schritt verwendete Umleitungs-URI muss erneut übergeben werden.
    • SCOPES: Die im vorherigen Schritt verwendeten Bereiche müssen erneut übergeben werden.

  4. Wenn acquireToken die Tokenansprüche erfolgreich sind, werden die Tokenansprüche extrahiert, und der Nonce-Anspruch wird anhand der in der Sitzung gespeicherten Nonce überprüft, wie im folgenden Beispiel gezeigt:

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

  5. Wenn die Nonce erfolgreich überprüft wird, wird der Authentifizierungsstatus in eine serverseitige Sitzung eingefügt, wobei Methoden genutzt werden, die von der MsalAuthSession Klasse verfügbar gemacht werden, wie im folgenden Beispiel gezeigt:

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

Weitere Informationen

Weitere Informationen zur Funktionsweise von OAuth 2.0-Protokollen in diesem Szenario und anderen Szenarien finden Sie unter Authentifizierungsszenarien für Microsoft Entra ID.

Nächster Schritt

Bereitstellen von Java WebSphere-Apps auf herkömmlichen WebSphere auf virtuellen Azure-Computern