Lernziele
Für Nutzer der App Engine-Anwendung festlegen, dass sie sich mithilfe von IAP authentifizieren müssen
Auf Identitäten von Nutzern in der Anwendung zugreifen, um die E-Mail-Adresse des aktuellen Nutzers aufzurufen
Kosten
In diesem Dokument verwenden Sie die folgenden kostenpflichtigen Komponenten von Google Cloud:
Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen.
Nach Abschluss der in diesem Dokument beschriebenen Aufgaben können Sie weitere Kosten vermeiden, indem Sie die erstellten Ressourcen löschen. Weitere Informationen finden Sie unter Bereinigen.
Hinweis
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Die Abrechnung für das Google Cloud-Projekt muss aktiviert sein.
- Bereite deine Entwicklungsumgebung vor.
Hintergrund
In dieser Anleitung werden Nutzer mithilfe von IAP authentifiziert. Dies ist nur eine von mehreren möglichen Vorgehensweisen zur Authentifizierung. Weitere Informationen über die verschiedenen Methoden zur Authentifizierung von Nutzern finden Sie im Abschnitt Authentifizierungskonzepte.
Anwendung "Hello user-email-address
"
Die Anwendung für diese Anleitung ist eine App Engine-Minimalanwendung vom Typ "Hello World", mit einem untypischen Feature: Anstelle von "Hello World" wird "Hello user-email-address
" angezeigt, wobei user-email-address
die E-Mail-Adresse des authentifizierten Nutzers ist.
Zur Bereitstellung dieser Funktionalität werden die Authentifizierungsinformationen ausgewertet, die der IAP-Dienst jeder Webanfrage hinzufügt, die er an die Anwendung weiterleitet. Jeder Webanfrage an Ihre Anwendung werden drei neue Anfrageheader hinzugefügt. Die ersten beiden Header sind Nur-Text-Strings, mit denen Sie den Nutzer identifizieren können. Der dritte Header ist ein kryptografisch signiertes Objekt mit denselben Informationen.
X-Goog-Authenticated-User-Email
: Ein Nutzer wird durch seine E-Mail-Adresse identifiziert. Speichern Sie keine personenbezogenen Daten, wenn dies für Ihre Anwendung möglich ist. Diese Anwendung speichert keine Daten, sondern gibt sie lediglich an den Nutzer zurück.X-Goog-Authenticated-User-Id
: Diese von Google zugewiesene Nutzer-ID stellt keine Information über den Nutzer dar. Eine Anwendung kann aber aufgrund der Nutzer-ID feststellen, dass ein angemeldeter Nutzer zuvor schon einmal authentifiziert wurde.X-Goog-Iap-Jwt-Assertion
: Sie können Google Cloud-Anwendungen so konfigurieren, dass neben Webanfragen aus dem Internet auch Webanfragen von anderen Cloud-Anwendungen unter Umgehung von IAP akzeptiert werden. Wenn eine Anwendung in dieser Weise konfiguriert ist, besteht die Möglichkeit, dass solche Anfragen gefälschte Header haben. Anstatt der oben genannten Nur-Text-Header können Sie deshalb auch den kryptografisch signierten Header verwenden und verifizieren. Damit lässt sich prüfen, ob die Informationen von Google bereitgestellt wurden. Die E-Mail-Adresse des Nutzers sowie eine nichtflüchtige Nutzer-ID stehen als Teil dieses signierten Headers zur Verfügung.
Wenn die Anwendung so konfiguriert ist, dass nur Webanfragen aus dem Internet darauf zugreifen können, und dafür gesorgt ist, dass niemand den IAP-Dienst für die Anwendung deaktivieren kann, muss für den Abruf einer eindeutigen Nutzer-ID nur eine einzige Codezeile geschrieben werden:
user_id = request.env["HTTP_X_GOOG_AUTHENTICATED_USER_ID"]
Eine robuste Anwendung sollte jedoch auf Fehler vorbereitet sein, etwa, wenn unerwartete Konfigurations- oder Umgebungsprobleme auftreten. Daher empfehlen wir stattdessen, eine Funktion zu erstellen, die den kryptografisch signierten Header verwendet und verifiziert. Die Signatur eines solchen Headers kann nicht gefälscht und kann nach erfolgter Verifizierung zur Rückgabe der Identifizierung verwendet werden.
Quellcode erstellen
Erstellen Sie mit einem Texteditor eine Datei mit dem Namen
app.rb
und fügen Sie den folgenden Code ein:Die Datei
app.rb
wird weiter unten im Abschnitt Erläuterungen zum Code dieser Anleitung ausführlich erläutert.Navigieren Sie in Ihrem Terminalfenster zum selben Ordner wie das neu erstellte
app.rb
und führen Siebundle init
aus.Hängen Sie Folgendes an das resultierende Gemfile an:
Das Gemfile listet alle nicht standardmäßigen Ruby-Bibliotheken auf, die App Engine zum Laden von App Engine benötigt:
Sinatra
ist das Ruby-Web-Framework, das für die Anwendung verwendet wird.jwt
stellt die JWT-Prüf- und -Decodierungsmethode bereit.
Installieren Sie die im Gemfile aufgeführten Abhängigkeiten:
bundle install
Erstellen Sie eine Datei mit dem Namen
app.yaml
und fügen Sie den folgenden Text ein:Die Datei
app.yaml
gibt für App Engine an, welche Sprachumgebung Ihr Code benötigt.
Code verstehen
In diesem Abschnitt wird erläutert, wie der Code in der Datei app.rb
funktioniert. Wenn Sie nur die Anwendung ausführen möchten, können Sie mit dem Abschnitt Anwendung bereitstellen fortfahren.
Wenn die Anwendung eine
HTTP GET
- Anfrage an die Startseite erhält, führt Sinatra den folgenden Block aus:Der Block ruft den JWT-Assertion-Header-Wert ab, den IAP aus der eingehenden Anfrage hinzugefügt hat, und ruft eine Methode auf, um diesen kryptografisch signierten Wert zu überprüfen. Der erste zurückgegebene Wert (E-Mail) wird dann auf einer minimalen Webseite verwendet, die Sinatra erstellt.
Die Methode
validate_assertion
verwendet die MethodeJWT.decode
aus derjwt
-Bibliothek des Drittanbieters, um zu überprüfen, ob die Assertion ordnungsgemäß signiert ist, und um die Nutzlastinformationen aus der Assertion zu extrahieren. Diese Informationen sind die E-Mail-Adresse des authentifizierten Nutzers sowie eine persistente eindeutige ID für den Nutzer. Wenn die Assertion nicht decodiert werden kann, gibt diese Methodenil
für jeden dieser Werte zurück und gibt eine Meldung aus, um den Fehler zu protokollieren.Damit eine JWT-Assertion validiert werden kann, müssen die Public-Key-Zertifikate der Entität, die die Assertion signiert hat (in diesem Fall Google), und das Ziel (Identitätsanbieter) bekannt sein, für das die Assertion bestimmt ist. Bei einer App Engine-Anwendung ist das Ziel ein String mit Identifizierungsinformationen für das Google Cloud-Projekt. Diese Methode ruft diese Zertifikate und den Zielgruppenstring aus den vorangehenden Methoden ab.
Sie können die numerische ID und den Namen des Google Cloud-Projekts suchen und diese Werte selbst in den Quellcode einfügen. Die Methode
audience
erledigt dies jedoch für Sie, indem Sie den Standardmetadatendienst abfragen, der für jede App Engine-Anwendung verfügbar ist. Da sich der Metadatendienst außerhalb des Anwendungscodes befindet, wird dieses Ergebnis im Objektsettings
des Sinatra-Frameworks gespeichert.Der App Engine-Metadatendienst und vergleichbare Metadatendienste für andere Google Cloud-Computing-Dienste verhalten sich wie eine Website und werden mit Standardwebabfragen abgefragt. Er ist jedoch keine externe Website, sondern ein internes Feature, das angeforderte Informationen zur ausgeführten Anwendung zurückgibt. Sie können also ohne Sicherheitsbedenken
http
-Anfragen anstelle vonhttps
-Anfragen verwenden. Hier wird der App Engine-Metadatendienst verwendet, um die aktuellen Google Cloud-IDs abzurufen, die zum Definieren der gewünschten Zielgruppe der JWT-Assertion erforderlich sind.Für die Verifizierung einer digitalen Signatur wird das Public-Key-Zertifikat des Signaturgebers benötigt. Google stellt eine Website zur Verfügung, die alle aktuell verwendeten Public-Key-Zertifikate zurückgibt. Diese Ergebnisse werden im Cache gespeichert, falls sie in der gleichen Anwendungsinstanz noch einmal benötigt werden.
Anwendung bereitstellen
Jetzt können Sie die Anwendung bereitstellen und IAP aktivieren, damit Nutzer sich authentifizieren müssen, bevor sie auf die Anwendung zugreifen können.
Wechseln Sie in Ihrem Terminalfenster zum Verzeichnis mit der Datei
app.yaml
und stellen Sie die Anwendung in App Engine bereit:gcloud app deploy
Wählen Sie bei entsprechender Aufforderung eine Region in der Nähe aus.
Wenn Sie gefragt werden, ob Sie den Bereitstellungsvorgang fortsetzen möchten, geben Sie
Y
ein.Ihre Anwendung ist dann innerhalb weniger Minuten online verfügbar.
Rufen Sie die Anwendung auf:
gcloud app browse
Kopieren Sie in der Ausgabe die Webadresse der Anwendung (
web-site-url
).Fügen Sie
web-site-url
in ein Browserfenster ein, um die Anwendung zu öffnen.Es wird keine E-Mail-Adresse angezeigt, da Sie IAP noch nicht verwenden und damit keine Nutzerinformationen an die Anwendung gesendet werden.
IAP aktivieren
Nachdem jetzt eine App Engine-Instanz vorhanden ist, können Sie sie mit IAP schützen:
Rufen Sie in der Google Cloud Console die Seite Identity-Aware Proxy auf.
Da Sie zum ersten Mal eine Authentifizierungsoption für dieses Projekt aktiviert haben, werden Sie in einer Meldung darauf hingewiesen, dass Sie den OAuth-Zustimmungsbildschirm konfigurieren müssen, bevor Sie IAP verwenden können.
Klicken Sie auf Zustimmungsbildschirm konfigurieren.
Geben Sie auf dem Tab OAuth-Zustimmungsbildschirm der Seite Anmeldedaten Werte in die folgenden Felder ein:
Wenn sich Ihr Konto in einer Google Workspace-Organisation befindet, wählen Sie Extern aus und klicken Sie auf Erstellen. Die Anwendung ist anfangs nur für Nutzer verfügbar, die Sie ausdrücklich zulassen.
Geben Sie im Feld Name der Anwendung den Namen
IAP Example
ein.Geben Sie im Feld Support-E-Mail-Adresse Ihre E-Mail-Adresse ein.
Geben Sie im Feld Autorisierte Domain den Hostnamen-Teil der Anwendungs-URL ein, z. B.
iap-example-999999.uc.r.appspot.com
. Drücken Sie die TasteEnter
, nachdem Sie den Hostnamen im Feld eingegeben haben.Geben Sie im Feld Link zur Startseite der Anwendung die URL für Ihre Anwendung ein, z. B.
https://iap-example-999999.uc.r.appspot.com/
.Verwenden Sie zu Testzwecken im Feld Link zur Datenschutzerklärung der Anwendung die URL für den Link zur Startseite.
Klicken Sie auf Speichern. Wenn Sie aufgefordert werden, Anmeldedaten zu erstellen, können Sie das Fenster schließen.
Rufen Sie in der Google Cloud Console die Seite Identity-Aware Proxy auf.
Klicken Sie zum Aktualisieren der Seite auf Aktualisieren refresh. Auf der Seite wird eine Liste von Ressourcen angezeigt, die Sie schützen können.
Klicken Sie in die Spalte IAP, um IAP für die Anwendung zu aktivieren.
Rufen Sie in Ihrem Browser noch einmal
web-site-url
auf.Anstelle der Webseite wird ein Anmeldebildschirm zur Authentifizierung angezeigt. Wenn Sie sich anmelden, wird Ihnen der Zugriff verweigert, da in IAP keine Liste von Nutzern vorhanden ist, die für die Anwendung zugelassen sind.
Autorisierte Nutzer in die Anwendung einfügen
Rufen Sie in der Google Cloud Console die Seite "Identity-Aware Proxy" auf.
Klicken Sie auf das Kästchen für die App Engine-Anwendung und dann auf Hauptkonto hinzufügen.
Geben Sie
allAuthenticatedUsers
ein und wählen Sie dann die Cloud IAP-Rolle Nutzer von IAP-gesicherten Web-Apps aus.Klicken Sie auf Speichern.
Nun hat jeder Nutzer, der von Google authentifiziert werden kann, die Möglichkeit, auf die Anwendung zuzugreifen. Bei Bedarf können Sie den Zugriff weiter einschränken und dafür etwa eine oder mehr Personen bzw. Gruppen als Hauptkonto hinzufügen:
Gmail- oder Google Workspace-E-Mail-Adressen
E-Mail-Adresse einer Google-Gruppe
Google Workspace-Domainname
Auf die Anwendung zugreifen
Rufen Sie im Browser
web-site-url
auf:Klicken Sie zum Aktualisieren der Seite auf Aktualisieren refresh.
Melden Sie sich auf dem Anmeldebildschirm mit Ihren Google-Anmeldedaten an.
Die Seite "Hello
user-email-address
" wird mit Ihrer E-Mail-Adresse angezeigt.Wenn Sie noch immer die gleiche Seite wie zuvor sehen, aktualisiert der Browser neue Anfragen möglicherweise nicht vollständig, nachdem IAP jetzt aktiviert ist. Schließen Sie in diesem Fall alle Browserfenster, öffnen Sie sie wieder und versuchen Sie es noch einmal.
Konzepte der Authentifizierung
Es gibt mehrere Möglichkeiten für Anwendungen, Nutzer zu authentifizieren und den Zugriff auf autorisierte Nutzer einzuschränken. In den folgenden Abschnitten werden gängige Authentifizierungsmethoden dargestellt, wobei die Methoden mit höherem Aufwand für die Anwendung zuerst aufgeführt sind.
Option | Vorteile | Nachteile |
---|---|---|
Authentifizierung von Anwendungen |
|
|
OAuth2 |
|
|
IAP |
|
|
Von der Anwendung verwaltete Authentifizierung
Bei dieser Methode wird jeder Aspekt der Nutzerauthentifizierung von der Anwendung selbst verwaltet. Die Anwendung muss dabei ihre eigene Datenbank mit Nutzeranmeldedaten bereitstellen sowie Nutzersitzungen verwalten. Außerdem muss sie Funktionen zum Verwalten von Nutzerkonten und Passwörtern, zum Prüfen von Nutzeranmeldedaten sowie zum Erstellen, Prüfen und Aktualisieren von Nutzersitzungen bei jeder authentifizierten Anmeldung enthalten. Das folgende Diagramm veranschaulicht diese Methode, bei der die Authentifizierung von der Anwendung verwaltet wird.
Wie im Diagramm dargestellt, erstellt und verwaltet die App nach der Anmeldung des Nutzers Informationen zur Nutzersitzung. Wenn der Nutzer eine Anfrage an die Anwendung sendet, muss die Anfrage Sitzungsinformationen enthalten, für deren Verifizierung die Anwendung zuständig ist.
Der Hauptvorteil besteht bei diesem Ansatz darin, dass er eigenständig ist und von der Anwendung gesteuert werden kann. Die Anwendung muss dabei nicht im Internet verfügbar sein. Der Hauptnachteil ist, dass die Anwendung nun für die Bereitstellung aller Kontoverwaltungsfunktionen und für den Schutz aller vertraulichen Anmeldedaten zuständig ist.
Externe Authentifizierung mit OAuth2
Eine gute Alternative zur Verwaltung und Ausführung aller Vorgänge in der Anwendung ist die Verwendung eines externen Identitätsdienstes wie Google. Dieser ist für alle Kontoinformationen und Funktionen sowie für den Schutz vertraulicher Anmeldedaten zuständig. Wenn sich dann ein Nutzer bei der Anwendung anmeldet, wird die Anfrage an den Identitätsdienst weitergeleitet, der den Nutzer authentifiziert und die Anfrage mit den erforderlichen Authentifizierungsinformationen an die Anwendung zurücksendet. Weitere Informationen finden Sie unter Als Endnutzer authentifizieren.
Das folgende Diagramm zeigt die externe Authentifizierung mit der OAuth2-Methode.
Der Ablauf im Diagramm beginnt, wenn der Nutzer eine Anfrage zum Zugriff auf die Anwendung sendet. Anstatt direkt zu reagieren, leitet die Anwendung den Browser des Nutzers an die Google-Identitätsplattform weiter. Auf dieser Plattform wird dann eine Seite zur Anmeldung bei Google angezeigt. Nach erfolgreicher Anmeldung wird der Browser des Nutzers zurück zur Anwendung geleitet. Diese Anfrage enthält Informationen, mit denen die Anwendung Informationen über den nun authentifizierten Nutzer abrufen kann. Danach antwortet die Anwendung dem Nutzer.
Diese Methode bietet viele Vorteile für die Anwendung. Alle Kontoverwaltungsfunktionen und Risiken werden dabei an den externen Dienst delegiert. Dieser ist dann auch für die Verbesserung der Anmeldungs- und Kontosicherheit zuständig, die dort ohne Änderung der Anwendung vorgenommen werden kann. Allerdings muss die Anwendung bei dieser Methode Zugriff auf das Internet haben, wie im vorherigen Diagramm gezeigt. Darüber hinaus ist die Anwendung nach der Authentifizierung des Nutzers für die Verwaltung der Sitzungen verantwortlich.
Identity-Aware Proxy
Beim dritten der in dieser Anleitung behandelten Ansätze wird mit IAP die gesamte Authentifizierung und Sitzungsverwaltung mit etwaigen Änderungen an der Anwendung durchgeführt. IAP fängt alle Webanfragen an Ihre Anwendung ab, blockiert alle nicht authentifizierten Anfragen und leitet die anderen weiter, wobei Nutzeridentitätsdaten an jede Anfrage angefügt werden.
Die Verarbeitung von Anfragen wird im folgenden Diagramm gezeigt.
Anfragen von Nutzern werden von IAP abgefangen und nicht authentifizierte Anfragen werden blockiert. Authentifizierte Anfragen werden an die Anwendung weitergeleitet, wenn der authentifizierte Nutzer in der Liste der zugelassenen Nutzer enthalten ist. An die über IAP weitergeleiteten Anfragen werden Header angefügt, die den Nutzer identifizieren, der die Anfrage gestellt hat.
Die Anwendung muss dabei keine Informationen zu Nutzerkonten oder Sitzungen verarbeiten. Jeder Vorgang, der eine eindeutige Kennung für den Nutzer benötigt, kann diese direkt aus jeder eingehenden Webanfrage abrufen. Dieser Ansatz ist jedoch nur für Computing-Dienste möglich, die IAP unterstützen, beispielsweise App Engine und Load-Balancer. Sie können IAP nicht auf einem lokalen Entwicklungscomputer verwenden.
Bereinigen
Damit Ihrem Google Cloud-Konto die in dieser Anleitung verwendeten Ressourcen nicht in Rechnung gestellt werden, löschen Sie entweder das Projekt, das die Ressourcen enthält, oder Sie behalten das Projekt und löschen die einzelnen Ressourcen.
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.