Auf dieser Seite wird beschrieben, wie Sie sich bei einem Identity-Aware Proxy authentifizieren. (IAP) gesicherte Ressource von einem Nutzerkonto oder einem Dienstkonto.
Ein Nutzerkonto gehört zu einem einzelnen Nutzer. Ein Nutzerkonto muss authentifiziert werden, wenn Ihre Anwendung im Namen eines Nutzers auf Ressourcen zugreifen soll, die mit IAP gesichert sind. Weitere Informationen Weitere Informationen zu Nutzerkonten
Ein Dienstkonto ist keinem einzelnen Nutzer, sondern einer Anwendung zugeordnet. Ein Dienstkonto muss authentifiziert werden, wenn Sie einer Anwendung Zugriff auf Ihre mit IAP gesicherten Ressourcen gewähren möchten. Weitere Informationen Siehe Dienstkonten.
Hinweise
Für den Start ist Folgendes erforderlich:
- Eine IAP-gesicherte Anwendung, für die Sie programmgesteuert über ein Entwicklerkonto, ein Dienstkonto oder ein Mobilgerät verbinden App-Anmeldedaten.
Nutzerkonto authentifizieren
Sie können Nutzern den Zugriff auf Ihre App von einer Desktop- oder mobilen App aus aktivieren, um mit einer mit IAP gesicherten Ressource interagieren.
Von einer mobilen App aus authentifizieren
- Erstellen Sie eine OAuth-2.0-Client-ID für Ihre mobile App oder verwenden Sie eine bereits vorhandene. Wenn Sie eine vorhandene OAuth 2.0-Client-ID verwenden möchten, folgen Sie der Anleitung unter OAuth-Clients freigeben.
- Setzen Sie die OAuth-Client-ID für den programmatischen Zugriff auf die Anwendung auf die Zulassungsliste.
- Rufen Sie ein ID-Token für die mit IAP gesicherte Client-ID ab.
- Android: Fordern Sie mit der Google Sign-In API ein OpenID Connect-Token (OIDC) an. Geben Sie für die Client-ID von
requestIdToken
die Client-ID für die Ressource an, zu der Sie eine Verbindung herstellen möchten. - iOS: Fordern Sie mit Google Log-in ein ID-Token an.
- Android: Fordern Sie mit der Google Sign-In API ein OpenID Connect-Token (OIDC) an. Geben Sie für die Client-ID von
- Fügen Sie das ID-Token in einen
Authorization: Bearer
-Header ein, um die authentifizierte Anfrage an die mit IAP gesicherte Ressource zu senden.
Von einer Desktopanwendung aus authentifizieren
In diesem Abschnitt wird beschrieben, wie Sie ein Nutzerkonto von einer Desktop-Befehlszeile aus authentifizieren können.
- Damit Entwickler über die Befehlszeile auf Ihre Anwendung zugreifen können, erstellen Sie eine OAuth 2.0-Desktop-Client-ID oder geben Sie eine vorhandene OAuth-Client-ID für Computer frei.
- Fügen Sie die OAuth-Client-ID für den programmatischen Zugriff für die Anwendung der Zulassungsliste hinzu.
Bei der Anwendung anmelden
Jeder Entwickler, der auf eine mit IAP gesicherte App zugreifen möchte, müssen Sie sich zuerst anmelden. Sie können den Prozess in einem Skript bündeln, indem Sie mit der gcloud CLI. Im Folgenden finden Sie ein Beispiel mit curl, mit dem Sie sich anmelden und ein Token generieren können, um damit auf die Anwendung zuzugreifen:
- Melden Sie sich bei Ihrem Konto an, das Zugriff auf die Google Cloud-Ressource hat.
-
Starten Sie einen lokalen Server, der die eingehenden Anfragen wiederholen kann.
HINWEIS: Der Befehl verwendet das NetCat-Dienstprogramm. Sie können ein Dienstprogramm Ihrer Wahl verwenden.$ nc -k -l 4444
-
Öffnen Sie den folgenden URI, wobei
DESKTOP_CLIENT_ID
ist der/die/das Client-ID der Desktop-App:https://accounts.google.com/o/oauth2/v2/auth?client_id=DESKTOP_CLIENT_ID&response_type=code&scope=openid%20email&access_type=offline&redirect_uri=http://localhost:4444&cred_ref=true
-
Suchen Sie in der Ausgabe des lokalen Servers nach den Anfrageparametern. Sie sollten Folgendes sehen:
etwa so aussehen:
GET /?code=$CODE&scope=email%20openid%20https://www.googleapis.com/auth/userinfo.email&hd=google.com&prompt=consent HTTP/1.1
kopieren Sie den CODE,AUTH_CODE
unten zusammen mit die Client-ID und das Secret für die Desktop-App:curl --verbose \ --data client_id=DESKTOP_CLIENT_ID \ --data client_secret=DESKTOP_CLIENT_SECRET \ --data code=AUTH_CODE \ --data redirect_uri=http://localhost:4444 \ --data grant_type=authorization_code \ https://oauth2.googleapis.com/token
Dieser Code gibt ein JSON-Objekt mit einem
id_token
Feld, das mit denen Sie auf die Anwendung zugreifen können.
Auf die Anwendung zugreifen
Verwenden Sie für den Zugriff auf die App die
id_token
so:
curl --verbose --header 'Authorization: Bearer ID_TOKEN' URL
Aktualisierungstoken
Mit dem Aktualisierungstoken, das während der Anmeldung generiert wird, neue ID-Tokens. Das ist nützlich, wenn das ursprüngliche ID-Token abläuft. Jede ID ist etwa eine Stunde lang gültig. In dieser Zeit können Sie mehrere an eine bestimmte App senden.
Im Folgenden finden Sie ein Beispiel mit curl, um mithilfe des Aktualisierungstokens eine neue ID abzurufen.
Token. Im folgenden Beispiel
REFRESH_TOKEN
ist das Token
bei der Anmeldung aus.
DESKTOP_CLIENT_ID
und
DESKTOP_CLIENT_SECRET
sind die
wird auch bei der Anmeldung verwendet:
curl --verbose \ --data client_id=DESKTOP_CLIENT_ID \ --data client_secret=DESKTOP_CLIENT_SECRET \ --data refresh_token=REFRESH_TOKEN \ --data grant_type=refresh_token \ https://oauth2.googleapis.com/token
Dieser Code gibt ein JSON-Objekt mit dem neuen Feld id_token
zurück, mit dem Sie auf die Anwendung zugreifen können.
Dienstkonto authentifizieren
Sie können ein Dienstkonto-JWT verwenden. oder ein OpenID Connect OIDC-Token, um ein Dienstkonto mit einem Mit IAP gesicherte Ressource. In der folgenden Tabelle sind einige die Unterschiede zwischen den verschiedenen Authentifizierungs-Tokens und ihren Funktionen.
Authentifizierungsfunktionen | Dienstkonto-JWT | OpenID Connect-Token |
---|---|---|
Unterstützung für kontextsensitiven Zugriff | ||
Anforderung für OAuth 2.0-Client-ID | ||
Tokenbereich | URL der mit IAP gesicherten Ressource | OAuth 2.0-Client-ID |
Mit einem Dienstkonto-JWT authentifizieren
Die Authentifizierung eines Dienstkontos mithilfe eines JWT umfasst die folgenden Hauptschritte:
Gewähren Sie dem aufrufenden Dienstkonto die Rolle Ersteller von Dienstkonto-Tokens (
roles/iam.serviceAccountTokenCreator
).Die Rolle gewährt Hauptkonten die Berechtigung, kurzlebige Anmeldedaten wie JWTs zu erstellen.
Erstellen Sie ein JWT für die mit IAP gesicherte Ressource.
Signieren Sie das JWT mit dem privaten Schlüssel des Dienstkontos.
JWT erstellen
Das erstellte JWT sollte eine Nutzlast haben, die dem folgenden Beispiel ähnelt:
{ "iss": SERVICE_ACCOUNT_EMAIL_ADDRESS, "sub": SERVICE_ACCOUNT_EMAIL_ADDRESS, "aud": TARGET_URL, "iat": IAT, "exp": EXP, }
Geben Sie in den Feldern
iss
undsub
die E-Mail-Adresse des Dienstkontos an. Sie befindet sich in der JSON-Datei des Dienstkontos im Feldclient_email
oder wird übergeben. Typisches Format:service-account@PROJECT_ID.iam.gserviceaccount.com
Geben Sie im Feld
aud
die URL der mit IAP gesicherten Ressource an.Geben Sie im Feld
iat
die aktuelle Unix-Epochenzeit und im Feldexp
einen Zeitpunkt innerhalb von 3.600 Sekunden an. Gibt an, wann das JWT abläuft.
JWT signieren
Du kannst das JWT mit einer der folgenden Methoden signieren:
- Mit der IAM Credentials API können Sie ein JWT ohne direkten Zugriff auf einen privaten Schlüssel signieren.
- Verwende eine lokale Schlüsseldatei für Anmeldedaten, um das JWT lokal zu signieren.
JWT mit der IAM Service Account Credentials API signieren
Verwenden Sie die IAM Service Account Credentials API, um ein JWT für ein Dienstkonto zu signieren. Die Methode ruft den privaten Schlüssel ab, der mit deinem Dienstkonto verknüpft ist, und signiert damit die JWT-Nutzlast. Dies ermöglicht das Signieren eines JWT ohne direkten Zugriff auf einen privaten Schlüssel.
Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei IAP zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
gcloud
Führen Sie den folgenden Befehl aus, um eine Anfrage mit der JWT-Nutzlast vorzubereiten:
cat > claim.json << EOM { "iss": "SERVICE_ACCOUNT_EMAIL_ADDRESS", "sub": "SERVICE_ACCOUNT_EMAIL_ADDRESS", "aud": "TARGET_URL", "iat": $(date +%s), "exp": $((`date +%s` + 3600)) } EOM
Verwenden Sie den folgenden Google Cloud CLI-Befehl, um die Nutzlast in
request.json
zu signieren:gcloud iam service-accounts sign-jwt --iam-account=SERVICE_ACCOUNT_EMAIL_ADDRESS claim.json output.jwt
Bei einer erfolgreichen Anfrage enthält
output.jwt
ein signiertes JWT.Verwenden Sie das JWT, um auf Ihre mit IAP gesicherte Ressource zuzugreifen.
Python
import datetime
import json
import google.auth
from google.cloud import iam_credentials_v1
import jwt
def generate_jwt_payload(service_account_email: str, resource_url: str) -> str:
"""Generates JWT payload for service account.
The resource url provided must be the same as the url of the IAP secured resource.
Args:
service_account_email (str): Specifies service account JWT is created for.
resource_url (str): Specifies scope of the JWT, the URL that the JWT will be allowed to access.
Returns:
A signed-jwt that can be used to access IAP protected applications.
Access the application with the JWT in the Authorization Header.
curl --verbose --header 'Authorization: Bearer SIGNED_JWT' URL
"""
iat = datetime.datetime.now(tz=datetime.timezone.utc)
exp = iat + 3600
return json.dumps({
'iss': service_account_email,
'sub': service_account_email,
'aud': resource_url,
'iat': iat,
'exp': exp,
})
def sign_jwt(target_sa: str, resource_url: str) -> str:
"""Signs JWT payload using ADC and IAM credentials API.
Args:
target_sa (str): Service Account JWT is being created for.
iap.webServiceVersions.accessViaIap permission is required.
resource_url (str): Audience of the JWT, and scope of the JWT token.
This is the url of the IAP protected application.
Returns:
A signed-jwt that can be used to access IAP protected apps.
"""
source_credentials, _ = google.auth.default()
iam_client = iam_credentials_v1.IAMCredentialsClient(credentials=source_credentials)
return iam_client.sign_jwt(
name=iam_client.service_account_path('-', target_sa),
payload=generate_jwt_payload(target_sa, resource_url),
).signed_jwt
Bei einer erfolgreichen Anfrage gibt das Script ein signiertes JWT zurück. Verwenden Sie das JWT, um auf Ihre mit IAP gesicherte Ressource zuzugreifen.
curl
Führen Sie den folgenden Befehl aus, um eine Anfrage mit der JWT-Nutzlast vorzubereiten:
cat << EOF > request.json { "payload": JWT_PAYLOAD } EOF
Signieren Sie das JWT mithilfe der IAM Service Account Credentials API:
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d @request.json \ "https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/SERVICE_ACCOUNT_EMAIL_ADDRESS:signJwt"
Bei einer erfolgreichen Anfrage enthält die Antwort ein signiertes JWT.
Verwenden Sie das JWT, um auf Ihre mit IAP gesicherte Ressource zuzugreifen.
JWT aus einer lokalen Schlüsseldatei für Anmeldedaten signieren
JWTs werden mit dem privaten Schlüssel des Dienstkontos signiert.
Wenn Sie eine Schlüsseldatei für ein Dienstkonto haben, kann das JWT lokal signiert werden.
Das Script sendet zusammen mit der Nutzlast einen JWT-Header. Für kid
im Header die private Schlüssel-ID des Dienstkontos, die sich im
private_key_id
der JSON-Datei mit den Anmeldedaten für das Dienstkonto.
Der Schlüssel wird auch zum Signieren des JWT verwendet.
Python
import time
import jwt
import json
def generate_jwt_payload(service_account_email, resource_url):
"""Generates JWT payload for service account.
The resource url provided must be the same as the url of the IAP secured resource.
Args:
service_account_email (str): Specifies service account JWT is created for.
resource_url (str): Specifies scope of the JWT, the URL that the JWT will be allowed to access.
Returns:
A signed-jwt that can be used to access IAP protected applications.
Access the application with the JWT in the Authorization Header.
curl --verbose --header 'Authorization: Bearer SIGNED_JWT' URL
"""
iat = datetime.datetime.now(tz=datetime.timezone.utc)
exp = iat + 3600
return json.dumps({
'iss': service_account_email,
'sub': service_account_email,
'aud': resource_url,
'iat': iat,
'exp': exp,
})
def sign_jwt_with_key_file(credential_key_file_path, resource_url):
"""Signs JWT payload using local service account credential key file.
Args:
credential_key_file_path (str): Path to the downloaded JSON credentials of the service
account the JWT is being created for.
resource_url (str): Scope of JWT token, This is the url of the IAP protected application.
Returns:
A service account JWT created with a downloaded private key.
"""
with open(credential_key_file_path, 'r') as credential_key_file:
key_data = json.load(credential_key_file)
PRIVATE_KEY_ID_FROM_JSON = key_data["private_key_id"]
PRIVATE_KEY_FROM_JSON = key_data["private_key"]
SERVICE_ACCOUNT_EMAIL = key_data["client_email"]
# Sign JWT with private key and store key id in the header
additional_headers = {'kid': PRIVATE_KEY_ID_FROM_JSON}
payload = generate_jwt_payload(service_account_email=SERVICE_ACCOUNT_EMAIL, resource_url=resource_url)
signed_jwt = jwt.encode(
payload,
PRIVATE_KEY_FROM_JSON,
headers=additional_headers,
algorithm='RS256',
)
return signed_jwt
Das Ergebnis ist ein signiertes JWT.
Auf die Anwendung zugreifen
Für den Zugriff auf die Anwendung verwenden Sie signed-jwt
in jedem Fall so:
curl --verbose --header 'Authorization: Bearer SIGNED_JWT' URL
Mit einem OIDC-Token authentifizieren
- Erstellen oder vorhandene OAuth 2.0-Client-ID verwenden Wenn Sie eine vorhandene OAuth 2.0-Client-ID verwenden möchten, folgen Sie der Anleitung unter OAuth-Clients freigeben.
- Fügen Sie die OAuth-Client-ID für den programmatischen Zugriff für die Anwendung der Zulassungsliste hinzu.
Außerdem müssen Sie das Dienstkonto der Zugriffsliste für das mit IAP gesicherte Projekt hinzufügen. Die folgenden Codebeispiele zeigen, wie Sie ein OIDC-Token erhalten. Sie müssen
Das Token in einem Authorization: Bearer
-Header, um die Authentifizierungsanfrage zu senden
mit der IAP-gesicherten Ressource.
OIDC-Token für das Standarddienstkonto abrufen
Wenn Sie ein OIDC-Token für das Standarddienstkonto für Compute Engine, App Engine oder Cloud Run können Sie Folgendes verwenden: Codebeispiel zum Generieren des Tokens für den Zugriff auf ein mit IAP gesichertes Ressource:
C#
Go
Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei IAP zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Node.js
PHP
Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei IAP zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Python
Richten Sie zur Authentifizierung bei IAP die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Ruby
Richten Sie zur Authentifizierung bei IAP die Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
OIDC-Token aus einer lokalen Dienstkonto-Schlüsseldatei abrufen
Wenn Sie eine Dienstkonto-Schlüsseldatei haben, können Sie die vorhergehenden Codebeispiele anpassen, um die Dienstkonto-Schlüsseldatei bereitzustellen.
Bash
#!/usr/bin/env bash
set -euo pipefail
get_token() {
# Get the bearer token in exchange for the service account credentials.
local service_account_key_file_path="${1}"
local iap_client_id="${2}"
local iam_scope="https://www.googleapis.com/auth/iam"
local oauth_token_uri="https://www.googleapis.com/oauth2/v4/token"
local private_key_id="$(cat "${service_account_key_file_path}" | jq -r '.private_key_id')"
local client_email="$(cat "${service_account_key_file_path}" | jq -r '.client_email')"
local private_key="$(cat "${service_account_key_file_path}" | jq -r '.private_key')"
local issued_at="$(date +%s)"
local expires_at="$((issued_at + 600))"
local header="{'alg':'RS256','typ':'JWT','kid':'${private_key_id}'}"
local header_base64="$(echo "${header}" | base64)"
local payload="{'iss':'${client_email}','aud':'${oauth_token_uri}','exp':${expires_at},'iat':${issued_at},'sub':'${client_email}','target_audience':'${iap_client_id}'}"
local payload_base64="$(echo "${payload}" | base64)"
local signature_base64="$(printf %s "${header_base64}.${payload_base64}" | openssl dgst -binary -sha256 -sign <(printf '%s\n' "${private_key}") | base64)"
local assertion="${header_base64}.${payload_base64}.${signature_base64}"
local token_payload="$(curl -s \
--data-urlencode "grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer" \
--data-urlencode "assertion=${assertion}" \
https://www.googleapis.com/oauth2/v4/token)"
local bearer_id_token="$(echo "${token_payload}" | jq -r '.id_token')"
echo "${bearer_id_token}"
}
main(){
# TODO: Replace the following variables:
SERVICE_ACCOUNT_KEY="service_account_key_file_path"
IAP_CLIENT_ID="iap_client_id"
URL="application_url"
# Obtain the ID token.
ID_TOKEN=$(get_token "${SERVICE_ACCOUNT_KEY}" "${IAP_CLIENT_ID}")
# Access the application with the ID token.
curl --header "Authorization: Bearer ${ID_TOKEN}" "${URL}"
}
main "$@"
In allen anderen Fällen ein OIDC-Token abrufen
In allen anderen Fällen verwenden Sie die IAM Credentials API, um OIDC-Token generieren indem Sie die Identität eines Zieldienstkontos übernehmen, bevor Sie auf ein Mit IAP gesicherte Ressource. Dieser Vorgang umfasst folgende Schritte:
Weisen Sie dem anrufenden Dienstkonto (dem Dienstkonto, das mit dem Code verknüpft ist, über den das ID-Token abgerufen wird) die Rolle „Ersteller des OpenID Connect-Identitätstokens für das Dienstkonto“ (
roles/iam.serviceAccountOpenIdTokenCreator
) zu.Dadurch kann das aufrufende Dienstkonto die Identität des Zieldienstkontos.
Verwenden Sie die vom aufrufenden Dienstkonto bereitgestellten Anmeldedaten, um die generateIdToken für das Zieldienstkonto.
Geben Sie im Feld
audience
Ihre Client-ID an.
Eine detaillierte Anleitung finden Sie unter Erstellen Sie ein ID-Token.
Authentifizierung über Proxy-Autorisierungs-Header
Wenn Ihre Anwendung den Anfrageheader Authorization
verwendet, können Sie
Fügen Sie stattdessen das ID-Token in einen Proxy-Authorization: Bearer
-Header ein. Wenn ein gültiges ID-Token in einem Proxy-Authorization
-Header gefunden wird, autorisiert IAP die Anfrage damit. Nach der Autorisierung des
übergibt IAP den Authorization
-Header an Ihre
ohne die Inhalte zu verarbeiten.
Wenn im Proxy-Authorization
-Header kein gültiges ID-Token gefunden wird,
IAP verarbeitet weiterhin den Header Authorization
und
entfernt den Proxy-Authorization
-Header, bevor die Anfrage an Ihren
.