Nesta página, você vai aprender a fazer a autenticação em um recurso protegido pelo Identity-Aware Proxy (IAP) usando uma conta de usuário ou uma conta de serviço.
O acesso programático é o cenário em que você chama aplicativos protegidos pelo IAP de clientes que não são de navegador. Isso inclui ferramentas de linha de comando, chamadas de serviço para serviço e aplicativos para dispositivos móveis. Dependendo do caso de uso, talvez seja necessário autenticar no IAP usando credenciais de usuário ou de serviço.
A conta de usuário pertence a um usuário individual. Ela é usada na autenticação quando o aplicativo precisa acessar recursos protegidos pelo IAP em nome de um usuário. Para mais informações, consulte Contas de usuário.
Uma conta de serviço representa um aplicativo, e não um usuário individual. Ela é usada na conta de serviço quando você quer permitir que um aplicativo acesse seus recursos protegidos pelo IAP. Para mais informações, consulte Contas de serviço.
O IAP oferece suporte aos seguintes tipos de credenciais para acesso programático:
- Token de ID do OAuth 2.0: um token emitido pelo Google para um usuário humano ou uma conta de serviço com a declaração de público-alvo definida como o ID do recurso do aplicativo IAP.
- JWT assinado pela conta de serviço: um token JWT autoassinado ou emitido pelo Google para uma conta de serviço.
Transmita essas credenciais ao IAP no cabeçalho HTTP Authorization
ou
Proxy-Authorization
.
Antes de começar
Antes de começar, você precisa de um aplicativo protegido pelo IAP ao qual quer se conectar de maneira programática usando uma conta de desenvolvedor, uma conta de serviço ou credenciais de app para dispositivos móveis.
Autenticar uma conta de usuário
É possível liberar o acesso de usuários a seu aplicativo por meio de um app para computador ou dispositivos móveis para permitir que um programa interaja com um recurso protegido pelo IAP.
Autenticar usando um app para dispositivos móveis
- Crie ou use um ID do cliente OAuth 2.0 para o app para dispositivos móveis. Para usar um ID do cliente OAuth 2.0, siga as etapas em Como compartilhar clientes OAuth. Adicione o ID do cliente OAuth à lista de permissões para acesso programático ao aplicativo.
- Receba um token de ID para o ID do cliente protegido pelo IAP.
- Android: use a
API Google Sign-in
para solicitar um token do
OpenID Connect
(OIDC). Defina o
ID do cliente
requestIdToken
como o do recurso a que você está se conectando. - iOS: use o Login do Google para receber um token de ID.
- Android: use a
API Google Sign-in
para solicitar um token do
OpenID Connect
(OIDC). Defina o
ID do cliente
- Inclua o token de ID em um cabeçalho
Authorization: Bearer
para fazer a solicitação autenticada ao recurso protegido pelo IAP.
Autenticar usando um app para computador
Esta seção descreve como autenticar uma conta de usuário de uma linha de comando de um desktop.
- Para permitir que os desenvolvedores acessem seu aplicativo na linha de comando, crie um ID do cliente OAuth 2.0 para computador ou compartilhe um ID do cliente OAuth para computador existente.
- Adicione o ID do OAuth à lista de permissões para acesso programático ao aplicativo.
Fazer login no aplicativo
Cada desenvolvedor que quiser acessar um app protegido pelo IAP precisa fazer login primeiro. É possível empacotar o processo em um script, por exemplo, usando a CLI gcloud. O exemplo a seguir usa o curl para fazer login e gerar um token que pode ser usado para acessar o aplicativo:
- Faça login na conta que tem acesso ao recurso Google Cloud .
Inicie um servidor local que possa repetir as solicitações recebidas.
# Example using Netcat (http://netcat.sourceforge.net/) nc -k -l 4444
Acesse o seguinte URI, em que
DESKTOP_CLIENT_ID
é o ID do cliente do app para computador: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
Na saída do servidor local, procure os parâmetros de solicitação:
GET /?code=CODE&scope=email%20openid%20https://www.googleapis.com/auth/userinfo.email&hd=google.com&prompt=consent HTTP/1.1
Copie o valor CODE para substituir
AUTH_CODE
no comando a seguir, junto com o ID do cliente e a chave secreta do app para computador: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
Esse comando retorna um objeto JSON com um campo
id_token
que pode ser usado para acessar o aplicativo.
Acessar o aplicativo
Para acessar o app, use id_token
:
curl --verbose --header 'Authorization: Bearer ID_TOKEN' URL
Token de atualização
É possível usar o token de atualização gerado durante o fluxo de login para receber novos tokens de ID. Isso é útil quando o token de ID original expira. Cada token de ID é válido por cerca de uma hora. Durante esse período, é possível fazer várias solicitações a um app específico.
O exemplo a seguir usa o curl para usar o token de atualização e receber um novo token de ID.
Neste exemplo, REFRESH_TOKEN
é o token do fluxo de login.
DESKTOP_CLIENT_ID
e DESKTOP_CLIENT_SECRET
são os
mesmos usados no fluxo de login:
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
Esse comando retorna um objeto JSON com um novo campo id_token
, que
pode ser usado para acessar o app.
Autenticar uma conta de serviço
É possível usar um JWT da conta de serviço ou um token do OpenID Connect (OIDC) para autenticar uma conta de serviço com um recurso protegido pelo IAP. A tabela a seguir descreve algumas diferenças entre os diferentes tokens de autenticação e os recursos deles.
Recursos do Authentication | JWT da conta de serviço | Token do OpenID Connect |
---|---|---|
Suporte ao acesso baseado no contexto | ||
Requisitos do ID do cliente OAuth 2.0 | ||
Escopo do token | URL do recurso protegido pelo IAP | ID do cliente OAuth 2.0 |
Autenticar com um JWT de conta de serviço
O IAP oferece suporte à autenticação JWT da conta de serviço para identidades do Google, do Identity Platform e da federação de identidade de colaboradores configuradas.
A autenticação de uma conta de serviço usando um JWT compreende as seguintes etapas principais:
Conceda à conta de serviço de chamada o papel Criador de token da conta de serviço (
roles/iam.serviceAccountTokenCreator
).O papel concede aos principais a permissão para criar credenciais de curta duração, como JWTs.
Crie um JWT para o recurso protegido pelo IAP.
Assine o JWT usando a chave privada da conta de serviço.
Como criar o JWT
O JWT criado precisa ter um payload semelhante ao exemplo abaixo:
{
"iss": SERVICE_ACCOUNT_EMAIL_ADDRESS,
"sub": SERVICE_ACCOUNT_EMAIL_ADDRESS,
"aud": TARGET_URL,
"iat": IAT,
"exp": EXP,
}
Para os campos
iss
esub
, especifique o endereço de e-mail da conta de serviço. Ele é encontrado no campoclient_email
do arquivo JSON da conta de serviço ou transmitido. Formato típico:service-account@PROJECT_ID.iam.gserviceaccount.com
No campo
aud
, especifique o URL do recurso protegido por IAP.Para o campo
iat
, especifique a época atual do Unix e, para o campoexp
, especifique um horário dentro de 3600 segundos depois. Isso define quando o JWT expira.
Assinaturar o JWT
Use um dos seguintes métodos para assinar o JWT:
- Use a API de credenciais do IAM para assinar um JWT sem exigir acesso direto a uma chave privada.
- Use um arquivo de chave de credenciais local para assinar o JWT localmente.
Como assinar o JWT usando a API Service Account Credentials do IAM
Use a API Service Account Credentials do IAM para assinar um JWT de conta de serviço. O método busca a chave privada associada à sua conta de serviço e a usa para assinar o payload do JWT. Isso permite a assinatura de um JWT sem acesso direto a uma chave privada.
Para autenticar no IAP, configure as credenciais padrão do aplicativo. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
gcloud
- Execute o comando a seguir para preparar uma solicitação com o 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
- Use o comando da Google Cloud CLI a seguir para assinar o payload em
claim.json
:
gcloud iam service-accounts sign-jwt --iam-account="SERVICE_ACCOUNT_EMAIL_ADDRESS" claim.json output.jwt
Após uma solicitação bem-sucedida, output.jwt
contém um JWT assinado que pode ser usado para acessar o recurso protegido pelo 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
Execute o comando a seguir para preparar uma solicitação com o payload do JWT:
cat << EOF > request.json { "payload": JWT_PAYLOAD } EOF
Assinar o JWT usando o 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"
Após uma solicitação bem-sucedida, um JWT assinado é retornado na resposta.
Use o JWT para acessar o recurso protegido pelo IAP.
Assinando o JWT de um arquivo de chave de credencial local
Os JWTs são assinados usando a chave privada da conta de serviço.
Se você tiver um arquivo de chave da conta de serviço, o JWT poderá ser assinado localmente.
O script envia um cabeçalho JWT com o payload. Para o campo kid
no cabeçalho, use o ID da chave privada da conta de serviço, que está no
campo private_key_id
do arquivo JSON da credencial da conta de serviço.
A chave também é usada para assinar o JWT.
Como acessar o aplicativo
Em todos os casos, para acessar o app, use signed-jwt
:
curl --verbose --header 'Authorization: Bearer SIGNED_JWT' URL
Autenticar com um token OIDC
- Crie ou use um ID do cliente OAuth 2.0 existente. Para usar um ID do cliente OAuth 2.0, siga as etapas em Como compartilhar clientes OAuth.
- Adicione o ID do OAuth à lista de permissões para acesso programático ao aplicativo.
- Verifique se a conta de serviço padrão foi adicionada à lista de acesso do projeto protegido pelo IAP.
Ao fazer solicitações ao recurso protegido pelo IAP, é necessário incluir o token no cabeçalho Authorization
: Authorization: 'Bearer OIDC_TOKEN'
Os exemplos de código abaixo demonstram como receber um token OIDC.
Como conseguir um token OIDC para a conta de serviço padrão
Para receber um token do OIDC para a conta de serviço padrão do Compute Engine, do App Engine ou do Cloud Run, consulte a exemplo de código a seguir para gerar um token para acessar um recurso protegido pelo IAP:
C#
Para autenticar no IAP, configure as credenciais padrão do aplicativo. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Go
Para autenticar no IAP, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Para autenticar no IAP, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Para autenticar no IAP, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
PHP
Para autenticar no IAP, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Para autenticar no IAP, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ruby
Para autenticar no IAP, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Como conseguir um token OIDC de um arquivo de chave de conta de serviço local
Para gerar um token OIDC usando um arquivo de chave de conta de serviço, use o arquivo de chave para criar e assinar uma declaração JWT e troque essa declaração por um token de ID. O script Bash a seguir demonstra esse 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 "$@"
Esse script executa as seguintes etapas:
- Extrai as informações da chave da conta de serviço do arquivo de chave JSON.
- Cria um JWT com os campos necessários, incluindo o ID do cliente do IAP como o público-alvo.
- Assina o JWT usando a chave privada da conta de serviço
- Troca esse JWT por um token OIDC pelo serviço OAuth do Google
- Usa o token resultante para fazer uma solicitação autenticada ao recurso protegido pelo IAP
Para usar esse script:
- Salve-o em um arquivo, por exemplo:
get_iap_token.sh
- Torne-o executável:
chmod +x get_iap_token.sh
- Execute com três parâmetros:
./get_iap_token.sh service-account-key.json \
OAUTH_CLIENT_ID \
URL
Em que:
service-account-key.json
é o arquivo de chave da conta de serviço salvo- OAUTH_CLIENT_ID é o ID do cliente OAuth do recurso protegido pelo IAP
- URL é o URL que você quer acessar.
Como conseguir um token OIDC em todos os outros casos
Em todos os outros casos, use a API de credenciais do IAM para gerar um token OIDC falsificando uma conta de serviço de destino antes de acessar um recurso protegido pelo IAP: Esse processo envolve as seguintes etapas:
Forneça à conta de serviço de chamada (a conta de serviço associada ao código que está recebendo o token de ID) o papel de Criador do token de identidade do OpenID Connect da conta de serviço (
roles/iam.serviceAccountOpenIdTokenCreator
).Isso permite que a conta de serviço de chamada imite a conta de serviço de destino.
Use as credenciais fornecidas pela conta de serviço de chamada para chamar o método generateIdToken na conta de serviço de destino.
Defina o campo
audience
como o ID do cliente.
Para instruções passo a passo, consulte Criar um token de ID.
Autenticação pelo cabeçalho Proxy-Authorization
Se o aplicativo usar o cabeçalho de solicitação Authorization
, inclua o
token de ID em um cabeçalho Proxy-Authorization: Bearer
. Se um token de ID válido
for encontrado em um cabeçalho Proxy-Authorization
, o IAP vai autorizar
a solicitação com ele. Depois de autorizar a solicitação, o IAP
transmite o cabeçalho Authorization
para o aplicativo sem processar o
conteúdo.
Se nenhum token de ID válido for encontrado no cabeçalho Proxy-Authorization
,
o IAP vai continuar processando o cabeçalho Authorization
e
retirar o cabeçalho Proxy-Authorization
antes de transmitir a solicitação para o
app.
A seguir
- Saiba mais sobre Autorização: tokens do portador.
- Tente usar o Login no Android ou o Login no iOS.