Questo documento descrive come autenticarsi a una risorsa protetta da IAP da un account utente o unaccount di serviziot.
L'accesso programmatico è lo scenario in cui chiami applicazioni protette da IAP da client non basati su browser. Sono inclusi strumenti della riga di comando, chiamate da servizio a servizio e applicazioni mobile. A seconda del tuo caso d'uso, potresti voler eseguire l'autenticazione a IAP utilizzando le credenziali utente o le credenziali di servizio.
Un account utente appartiene a un singolo utente. Autentichi un account utente quando la tua applicazione richiede l'accesso alle risorse protette da IAP per conto di un utente. Per ulteriori informazioni, vedi Account utente.
Un account di servizio rappresenta un'applicazione anziché un singolo utente. Autentichi un account di servizio quando vuoi consentire a un'applicazione di accedere alle tue risorse protette da IAP. Per maggiori informazioni, consulta Service account.
IAP supporta il seguente tipo di credenziali per l'accesso programmatico:
- Token ID OAuth 2.0: un token emesso da Google per un utente umano o un account di servizio con l'attestazione del pubblico impostata sull'ID risorsa dell'applicazione IAP.
- JWT firmato dell'account di servizio: un token JWT autofirmato o emesso da Google per un service account.
Trasferisci queste credenziali a IAP nell'intestazione HTTP Authorization
o Proxy-Authorization
.
Prima di iniziare
Prima di iniziare, devi disporre di un'applicazione protetta da acquisti in-app a cui vuoi connetterti in modo programmatico utilizzando un account sviluppatore, un account di servizio o le credenziali dell'app mobile.
Autenticare un account utente
Puoi attivare l'accesso degli utenti alla tua app da un'app mobile o desktop per consentire a un programma di interagire con una risorsa protetta da IAP.
Autenticarsi da un'app mobile
- Crea o utilizza un ID client OAuth 2.0 esistente per la tua app mobile. Per utilizzare un ID client OAuth 2.0 esistente, segui i passaggi descritti in Come condividere i client OAuth. Aggiungi l'ID client OAuth alla lista consentita per l'accesso programmatico per l'applicazione.
- Ottieni un token ID per l'ID client protetto da IAP.
- Android: utilizza l'API Google Sign-In per richiedere un token OpenID Connect (OIDC). Imposta l'ID client
requestIdToken
sull'ID client della risorsa a cui ti stai connettendo. - iOS: utilizza Accedi con Google per ottenere un token ID.
- Android: utilizza l'API Google Sign-In per richiedere un token OpenID Connect (OIDC). Imposta l'ID client
- Includi il token ID in un'intestazione
Authorization: Bearer
per effettuare la richiesta autenticata alla risorsa protetta da IAP.
Autenticarsi da un'app desktop
Questa sezione descrive come autenticare un account utente da una riga di comando del computer.
- Per consentire agli sviluppatori di accedere alla tua applicazione dalla riga di comando, crea un ID client OAuth 2.0 desktop o condividi un ID client OAuth desktop esistente.
- Aggiungi l'ID OAuth alla lista consentita per l'accesso programmatico per l'applicazione.
Accedi all'applicazione
Ogni sviluppatore che vuole accedere a un'IAP;app protetta da acquisti in-app deve prima accedere. Puoi raggruppare il processo in uno script, ad esempio utilizzando l'interfaccia a riga di comando gcloud. L'esempio seguente utilizza curl per accedere e generare un token che può essere utilizzato per accedere all'applicazione:
- Accedi al tuo account che ha accesso alla risorsa Google Cloud .
Avvia un server locale in grado di fare l'echo delle richieste in entrata.
# Example using Netcat (http://netcat.sourceforge.net/) nc -k -l 4444
Vai al seguente URI, dove
DESKTOP_CLIENT_ID
è l'ID client dell'app per computer: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
Nell'output del server locale, cerca i parametri della richiesta:
GET /?code=CODE&scope=email%20openid%20https://www.googleapis.com/auth/userinfo.email&hd=google.com&prompt=consent HTTP/1.1
Copia il valore di CODE per sostituire
AUTH_CODE
nel comando seguente, insieme al ID client e al client secret dell'app per computer:curl --verbose \ --data client_id=DESKTOP_CLIENT_ID \ --data client_secret=DESKTOP_CLIENT_SECRET \ --data code=CODE \ --data redirect_uri=http://localhost:4444 \ --data grant_type=authorization_code \ https://oauth2.googleapis.com/token
Questo comando restituisce un oggetto JSON con un campo
id_token
che puoi utilizzare per accedere all'applicazione.
Accedere all'applicazione
Per accedere all'app, utilizza id_token
:
curl --verbose --header 'Authorization: Bearer ID_TOKEN' URL
Token di aggiornamento
Puoi utilizzare il token di aggiornamento generato durante il flusso di accesso per ottenere nuovi token ID. Questo è utile quando il token ID originale scade. Ogni token ID è valido per circa un'ora, durante la quale puoi effettuare più richieste a un'app specifica.
L'esempio seguente utilizza curl per utilizzare il token di aggiornamento per ottenere un nuovo token ID.
In questo esempio, REFRESH_TOKEN
è il token del flusso di accesso.
DESKTOP_CLIENT_ID
e DESKTOP_CLIENT_SECRET
sono gli stessi
utilizzati nel flusso di accesso:
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
Questo comando restituisce un oggetto JSON con un nuovo campo id_token
che
puoi utilizzare per accedere all'app.
Autenticare un account di servizio
Puoi utilizzare un JWT del service account o un token OpenID Connect (OIDC) per autenticare un account di servizio con una risorsa protetta da IAP. La seguente tabella illustra alcune delle differenze tra i vari token di autenticazione e le relative funzionalità.
Funzionalità di autenticazione | JWT del service account | Token OpenID Connect |
---|---|---|
Supporto dell'accesso sensibile al contesto | ||
Requisito dell'ID client OAuth 2.0 | ||
Ambito del token | URL della risorsa protetta da IAP | ID client OAuth 2.0 |
Autenticarsi con un JWT del account di servizio
IAP supporta l'autenticazione JWT dell'account di servizio per le identità Google, Identity Platform e le applicazioni configurate per la federazione delle identità per la forza lavoro.
L'autenticazione di un account di servizio utilizzando un JWT comprende i seguenti passaggi principali:
Concedi al account di servizio chiamante il ruolo Creatore token service account (
roles/iam.serviceAccountTokenCreator
).Il ruolo concede alle entità servizio l'autorizzazione a creare credenziali di breve durata, come i JWT.
Crea un JWT per la risorsa protetta da IAP.
Firma il JWT utilizzando la chiave privata del account di servizio.
Crea il JWT
Il JWT creato deve avere un payload simile all'esempio seguente:
{
"iss": SERVICE_ACCOUNT_EMAIL_ADDRESS,
"sub": SERVICE_ACCOUNT_EMAIL_ADDRESS,
"aud": TARGET_URL,
"iat": IAT,
"exp": EXP,
}
Per i campi
iss
esub
, specifica l'indirizzo email del service account. Questo valore si trova nel campoclient_email
del file JSON dell'account di servizio o viene passato. Formato tipico:service-account@PROJECT_ID.iam.gserviceaccount.com
Per il campo
aud
, specifica l'URL della risorsa protetta da IAP.Per il campo
iat
, specifica l'ora Unix epoch corrente e per il campoexp
, specifica un'ora entro 3600 secondi successivi. Questo definisce la scadenza del JWT.
Firma il JWT
Per firmare il JWT, puoi utilizzare uno dei seguenti metodi:
- Utilizza l'API IAM Credentials per firmare un JWT senza richiedere l'accesso diretto a una chiave privata.
- Utilizza un file di chiave delle credenziali locale per firmare il JWT localmente.
Firma il JWT utilizzando l'API IAM Service Account Credentials
Utilizza l'API IAM Service Account Credentials per firmare un JWT dell'account di servizio. Il metodo recupera la chiave privata associata al tuo account di servizio e la utilizza per firmare il payload JWT. Ciò consente la firma di un JWT senza accesso diretto a una chiave privata.
Per eseguire l'autenticazione in IAP, configura le credenziali predefinite dell'applicazione. Per maggiori informazioni, vedi Configurare l'autenticazione per un ambiente di sviluppo locale.
gcloud
- Esegui il comando seguente per preparare una richiesta con il payload JWT
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
- Utilizza il seguente comando Google Cloud CLI per firmare il payload in
claim.json
:
gcloud iam service-accounts sign-jwt --iam-account="SERVICE_ACCOUNT_EMAIL_ADDRESS" claim.json output.jwt
Dopo una richiesta riuscita, output.jwt
contiene un JWT firmato che puoi utilizzare per accedere alla risorsa protetta da IAP.
Python
import datetime
import json
import google.auth
from google.cloud import iam_credentials_v1
def generate_jwt_payload(service_account_email: str, resource_url: str) -> str:
"""Generates JWT payload for service account.
Creates a properly formatted JWT payload with standard claims (iss, sub, aud,
iat, exp) needed for IAP authentication.
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:
str: JSON string containing the JWT payload with properly formatted claims.
"""
# Create current time and expiration time (1 hour later) in UTC
iat = datetime.datetime.now(tz=datetime.timezone.utc)
exp = iat + datetime.timedelta(seconds=3600)
# Convert datetime objects to numeric timestamps (seconds since epoch)
# as required by JWT standard (RFC 7519)
payload = {
"iss": service_account_email,
"sub": service_account_email,
"aud": resource_url,
"iat": int(iat.timestamp()),
"exp": int(exp.timestamp()),
}
return json.dumps(payload)
def sign_jwt(target_sa: str, resource_url: str) -> str:
"""Signs JWT payload using ADC and IAM credentials API.
Uses Google Cloud's IAM Credentials API to sign a JWT. This requires the
caller to have iap.webServiceVersions.accessViaIap permission on the target
service account.
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:
str: A signed JWT that can be used to access IAP protected apps.
Use in Authorization header as: 'Bearer <signed_jwt>'
"""
# Get default credentials from environment or application credentials
source_credentials, project_id = google.auth.default()
# Initialize IAM credentials client with source credentials
iam_client = iam_credentials_v1.IAMCredentialsClient(credentials=source_credentials)
# Generate the service account resource name
# If project_id is None, use '-' as placeholder as per API requirements
project = project_id if project_id else "-"
name = iam_client.service_account_path(project, target_sa)
# Create and sign the JWT payload
payload = generate_jwt_payload(target_sa, resource_url)
# Sign the JWT using the IAM credentials API
response = iam_client.sign_jwt(name=name, payload=payload)
return response.signed_jwt
curl
Esegui questo comando per preparare una richiesta con il payload JWT:
cat << EOF > request.json { "payload": JWT_PAYLOAD } EOF
Firma il JWT utilizzando IAM
API Service Account Credentials:
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"
Dopo una richiesta riuscita, nella risposta viene restituito un JWT firmato.
Utilizza il JWT per accedere alla risorsa protetta da IAP.
Firma il JWT da un file di chiave delle credenziali locale
I JWT vengono firmati utilizzando la chiave privata del account di servizio.
Se hai un file della chiave del service account, il JWT può essere firmato localmente.
Lo script invia un'intestazione JWT insieme al payload. Per il campo kid
nell'intestazione, utilizza l'ID della chiave privata dell'account di servizio, che si trova nel campo
private_key_id
del file JSON delle credenziali dell'account di servizio.
La chiave viene utilizzata anche per firmare il JWT.
Accedere all'applicazione
In tutti i casi, per accedere all'app, utilizza signed-jwt
:
curl --verbose --header 'Authorization: Bearer SIGNED_JWT' URL
Autenticarsi con un token OIDC
- Crea o utilizza un ID client OAuth 2.0 esistente. Per utilizzare un ID client OAuth 2.0 esistente, segui i passaggi descritti in Come condividere i client OAuth.
- Aggiungi l'ID OAuth alla lista consentita per l'accesso programmatico per l'applicazione.
- Assicurati che l'account di servizio predefinito sia aggiunto all'elenco di accesso per il progetto protetto da IAP.
Quando effettui richieste alla risorsa protetta da IAP, devi includere il token nell'intestazione Authorization
: Authorization: 'Bearer OIDC_TOKEN'
I seguenti esempi di codice mostrano come ottenere un token OIDC.
Ottieni un token OIDC per il account di servizio predefinito
Per ottenere un token OIDC per il account di servizio predefinito per Compute Engine, App Engine o Cloud Run, fai riferimento al seguente esempio di codice per generare un token per accedere a una risorsa protetta da IAP:
C#
Per eseguire l'autenticazione in IAP, configura le Credenziali predefinite dell'applicazione. Per maggiori informazioni, vedi Configurare l'autenticazione per un ambiente di sviluppo locale.
Go
Per eseguire l'autenticazione in IAP, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per eseguire l'autenticazione in IAP, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per eseguire l'autenticazione in IAP, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
PHP
Per eseguire l'autenticazione in IAP, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Python
Per eseguire l'autenticazione in IAP, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ruby
Per eseguire l'autenticazione in IAP, configura le Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ottenere un token OIDC da un file delle chiavi per l'account di servizio locale
Per generare un token OIDC utilizzando un file delle chiavi per l'account di servizio, utilizzerai il file delle chiavi per creare e firmare un'asserzione JWT, quindi scambierai l'asserzione con un token ID. Il seguente script Bash mostra questo processo:
Bash
#!/usr/bin/env bash
#
# Example script that generates an OIDC token using a service account key file
# and uses it to access an IAP-secured resource
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}"
# Define the scope and token endpoint
local iam_scope="https://www.googleapis.com/auth/iam"
local oauth_token_uri="https://www.googleapis.com/oauth2/v4/token"
# Extract data from service account key file
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')"
# Set token timestamps (current time and expiration 10 minutes later)
local issued_at="$(date +%s)"
local expires_at="$((issued_at + 600))"
# Create JWT header and payload
local header="{'alg':'RS256','typ':'JWT','kid':'${private_key_id}'}"
local header_base64="$(echo "${header}" | base64 | tr -d '\n')"
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 | tr -d '\n')"
# Create JWT signature using the private key
local signature_base64="$(printf %s "${header_base64}.${payload_base64}" | openssl dgst -binary -sha256 -sign <(printf '%s\n' "${private_key}") | base64 | tr -d '\n')"
local assertion="${header_base64}.${payload_base64}.${signature_base64}"
# Exchange the signed JWT assertion for an ID token
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)"
# Extract just the ID token from the response
local bearer_id_token="$(echo "${token_payload}" | jq -r '.id_token')"
echo "${bearer_id_token}"
}
main() {
# Check if required arguments are provided
if [[ $# -lt 3 ]]; then
echo "Usage: $0 <service_account_key_file.json> <iap_client_id> <url>"
exit 1
fi
# Assign parameters to variables
SERVICE_ACCOUNT_KEY="$1"
IAP_CLIENT_ID="$2"
URL="$3"
# Generate the ID token
echo "Generating token..."
ID_TOKEN=$(get_token "${SERVICE_ACCOUNT_KEY}" "${IAP_CLIENT_ID}")
# Access the IAP-secured resource with the token
echo "Accessing: ${URL}"
curl --header "Authorization: Bearer ${ID_TOKEN}" "${URL}"
}
# Run the main function with all provided arguments
main "$@"
Questo script esegue i seguenti passaggi:
- Estrae le informazioni sulla chiave dell'account di servizio dal file della chiave JSON
- Crea un JWT con i campi necessari, incluso l'ID client IAP come pubblico di destinazione
- Firma il JWT utilizzando la chiave privata dell'account di servizio
- Scambia questo JWT con un token OIDC tramite il servizio OAuth di Google
- Utilizza il token risultante per effettuare una richiesta autenticata alla risorsa protetta da IAP
Per utilizzare questo script:
- Salvalo in un file, ad esempio
get_iap_token.sh
. - Rendi eseguibile:
chmod +x get_iap_token.sh
- Esegui il comando con tre parametri:
./get_iap_token.sh service-account-key.json \
OAUTH_CLIENT_ID \
URL
Dove:
service-account-key.json
è il file della chiave del account di servizio scaricato- OAUTH_CLIENT_ID è l'ID client OAuth per la risorsa protetta da IAP
- URL è l'URL a cui vuoi accedere
Ottenere un token OIDC in tutti gli altri casi
In tutti gli altri casi, utilizza l'API IAM Credentials per generare un token OIDC impersonando un account di servizio di destinazione subito prima di accedere a una risorsa protetta da IAP. Questa procedura prevede i seguenti passaggi:
Fornisci al account di servizio chiamante (il account di servizio associato al codice che ottiene il token ID) il ruolo Service Account OpenID Connect Identity Token Creator (
roles/iam.serviceAccountOpenIdTokenCreator
).In questo modo, il account di servizio chiamante può simulare l'identità del account di servizio di destinazione.
Utilizza le credenziali fornite dall'account di servizio chiamante per chiamare il metodo generateIdToken sull'account di servizio di destinazione.
Imposta il campo
audience
sul tuo ID client.
Per istruzioni passo passo, vedi Creare un token ID.
Autenticazione dall'intestazione Proxy-Authorization
Se la tua applicazione utilizza l'intestazione della richiesta Authorization
, puoi includere il
token ID in un'intestazione Proxy-Authorization: Bearer
. Se viene trovato un token ID valido
in un'intestazione Proxy-Authorization
, IAP autorizza
la richiesta. Dopo aver autorizzato la richiesta, IAP
trasferisce l'intestazione Authorization
alla tua applicazione senza elaborarne il
contenuto.
Se non viene trovato alcun token ID valido nell'intestazione Proxy-Authorization
,
IAP continua a elaborare l'intestazione Authorization
e
rimuove l'intestazione Proxy-Authorization
prima di passare la richiesta alla tua
applicazione.
Passaggi successivi
- Scopri di più su Autorizzazione: token di tipo Bearer.
- Prova Sign-In per Android o Sign-In per iOS.