Como acessar recursos de um provedor de identidade OIDC

Este documento mostra como usar a federação de identidades para acessar recursos do Google Cloud a partir de um provedor de identidade compatível com o OpenID Connect (OIDC).

Os aplicativos executados fora do Google Cloud costumavam usar chaves de conta de serviço para acessar os recursos do Google Cloud. Com a federação de identidade, é possível permitir que uma identidade externa personifique uma conta de serviço. Isso possibilita que a carga de trabalho acesse os recursos do Google Cloud diretamente, usando um token de acesso de curta duração, e elimina a sobrecarga de manutenção e segurança associada às chaves de conta de serviço.

Antes de começar

  1. Ative as APIs IAM, Resource Manager, Service Account Credentials, and Security Token Service (STS).

    Ative as APIs

  2. Verifique se você tem os papéis Administrador de pool de Identidade da carga de trabalho (roles/iam.workloadIdentityPoolAdmin) e Administrador da conta de serviço (roles/iam.serviceAccountAdmin) no projeto.

    Como alternativa, o papel básico de Proprietário do IAM (roles/owner) também inclui permissões para configurar a federação de identidade. Não conceda papéis básicos em um ambiente de produção, recomendamos que você faça isso em um ambiente de desenvolvimento ou teste.

  3. Atualize a política da sua organização para permitir federações do provedor de identidade.

  4. Crie uma conta de serviço do Google Cloud.

  5. Conceda à conta de serviço acesso para chamar as APIs do Google Cloud necessárias à carga de trabalho.

Configurações do provedor de identidade para o OIDC

Ao adicionar um provedor de identidade OIDC ao seu pool de identidades de carga de trabalho, você precisa fornecer:

  • Um ID do provedor.

  • O URI do emissor do provedor. Ele normalmente tem o formato https://example.com. Consulte a documentação do seu provedor sobre a integração de OIDC para encontrar o URI.

  • Uma lista de mapeamentos de atributo que mapeiam as declarações em um token externo para os atributos em um token do Google. Use assertion para referenciar a credencial externa, google para atributos do Google e attribute para atributos personalizados.

    Há dois atributos do Google: google.subject e google.groups. É possível mencionar esses atributos nas vinculações de papéis do IAM. google.subject também aparece nas entradas de registro do Cloud Logging.

    É preciso fornecer um mapeamento para google.subject. Em geral, recomendamos mapeá-lo para assertion.sub, que precisa fornecer um identificador estável para uso em vinculações de papéis do IAM. O mapeamento é semelhante a este:

    google.subject=assertion.sub
    

    Para declarações mais complexas, use a Common Expression Language. Por exemplo, se o pool de identidades de carga de trabalho tiver vários provedores de identidade, será possível acrescentar um prefixo para diferenciá-los:

    google.subject="provider-a::" + assertion.sub
    

    O campo google.subject não pode exceder 127 caracteres.

    Também é possível especificar atributos personalizados. Por exemplo, o comando a seguir mapeia assertion.foo para attribute.bar:

    attribute.bar=assertion.foo
    

    Consulte a documentação do seu provedor sobre tokens de acesso para ver uma lista completa das declarações que você pode usar como referência.

    Para referir-se a uma parte específica de uma declaração em uma expressão, use a função extract() CEL, que extrai um valor de uma declaração com base em um modelo fornecido por você. Para saber mais sobre extract(), consulte Como extrair valores de atributos.

    Para verificar se uma credencial contém uma declaração, use a função has().

  • Uma lista de públicos permitidos especificando quais valores o campo aud da credencial externa pode conter. É possível configurar no máximo 10 públicos, cada um com até 256 caracteres. Consulte a documentação do provedor para mais informações sobre os valores padrão de aud.

    Como alternativa, caso seu provedor de identidade permita que você configure um valor personalizado para aud, deixe o parâmetro de público permitido em branco e defina o valor de aud como o nome de recurso completo do seu provedor de identidade de carga de trabalho. O prefixo HTTP é opcional. Por exemplo:

    //iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID
    https://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID
    

    Em ambos os casos, todas as solicitações de troca de token que não contiverem um dos valores permitidos serão rejeitadas.

Também é possível especificar vários parâmetros opcionais:

  • Um nome de exibição e uma descrição

  • Uma condição de atributo que especifica aqueles que o principal precisa apresentar. A condição pode ser aplicada a declarações na credencial externa ou a atributos na credencial do Google. Qualquer solicitação que não atenda à condição será rejeitada.

    As condições do atributo são formatadas como uma expressão CEL que retorna um booleano. Por exemplo, o comando a seguir rejeita solicitações de qualquer identidade que não seja membro de um grupo específico:

    GROUP in assertion.groups
    

    Se o provedor de identidade estiver disponível para o público em geral, é recomendável usar condições de atributos. Para saber mais sobre casos de uso comuns, consulte Condições de atributo.

Criar um pool de identidades de carga de trabalho e um provedor

Use um pool de identidade de carga de trabalho para organizar e gerenciar identidades externas. Os pools de identidade de carga de trabalho são isolados uns dos outros, mas um único pool pode representar qualquer número de contas de serviço. Em geral, recomendamos a criação de um novo pool para cada um dos ambientes, como desenvolvimento, preparação ou produção.

Para criar um novo pool de identidades de carga de trabalho, você precisa fornecer um ID. Também é possível fornecer uma description e um nome de exibição opcionais. O ID não pode começar com gcp- porque esse prefixo está reservado para uso do Google.

Depois de criar o pool de identidades da carga de trabalho, é possível adicionar um provedor de identidade de carga de trabalho. Cada provedor de pool de identidades de carga de trabalho representa um provedor de identidade específico. Um único pool pode conter vários provedores. Para criar o provedor, você precisará das informações descritas nesta página em Configurações do provedor de identidade para o OIDC.

Console

  1. No Console do Cloud, acesse a página Novo provedor de carga de trabalho e pool.

    Acessar "Novo provedor de carga de trabalho" e "Pool"

  2. Insira um nome para o pool de identidades da carga de trabalho.

    O Console do Cloud usa o nome para criar um ID de pool. Para alterar o ID do pool, clique em Editar. Não será possível alterar o ID do pool depois.

  3. Opcional: insira uma descrição para o pool de identidades da carga de trabalho.

  4. Clique em Continuar.

  5. Na lista suspensa Selecionar um provedor, selecione OpenID Connect (OIDC). Em seguida, clique em Continuar.

  6. Insira o nome do provedor.

    O Console do Cloud usa o nome para criar um ID do provedor. Para alterar o ID do provedor, clique em Editar. Não será possível alterar o ID depois.

  7. Digite o URL do emissor do provedor e clique em Continuar.

  8. Para configurar o mapeamento de atributos, clique em Editar mapeamento.

    O mapeamento de atributos permite usar informações sobre identidades externas para conceder acesso a um subconjunto dessas identidades. Para provedores de identidade OIDC, recomendamos mapear google.subject para assertion.sub. Outros mapeamentos são opcionais.

    Para detalhes, consulte Configurações do provedor de identidade para o OIDC nesta página.

  9. Opcional: para fornecer uma condição de atributo, que especifica as identidades que podem se autenticar, clique em Adicionar condição e digite uma expressão válida Linguagem de expressão comum (CEL, na sigla em inglês). Veja mais detalhes em Condições de atributo.

  10. Clique em Salvar para criar o pool de identidades e o provedor da carga de trabalho.

gcloud

Para criar um pool de identidades da carga de trabalho,use o comando gcloud iam workload-identity-pools create:

gcloud iam workload-identity-pools create POOL_ID \
    --location="global" \
    --description="DESCRIPTION" \
    --display-name="DISPLAY_NAME"

A resposta é semelhante ao exemplo a seguir:

Created workload identity pool [POOL_ID].

Para adicionar um provedor de pool de identidades de carga de trabalho, use o comando gcloud iam workload-identity-pools providers create-oidc:

gcloud iam workload-identity-pools providers create-oidc PROVIDER_ID \
    --workload-identity-pool="POOL_ID" \
    --issuer-uri="ISSUER_URI" \
    --location="global" \
    --attribute-mapping="google.subject=assertion.sub"

A resposta é semelhante ao exemplo a seguir:

Created workload identity pool provider [PROVIDER_ID].

REST

Para criar um pool de identidades da carga de trabalho, faça o seguinte:

O método projects.locations.workloadIdentityPools.create cria um pool de identidades da carga de trabalho.

Método HTTP e URL:

POST https://iam.googleapis.com/v1/projects/project-id/locations/global/workloadIdentityPools?workloadIdentityPoolId=pool-id

Corpo JSON da solicitação:

{
  "description": "description",
  "display-name": "display-name"
}

Para enviar a solicitação, expanda uma destas opções:

O método retorna uma Operation de longa duração semelhante a esta:

{
  "name": "projects/project-number/locations/global/workloadIdentityPools/pool-id/operations/operation-id"
}

Para adicionar um provedor de pool de Identidade da carga de trabalho, faça o seguinte:

O método projects.locations.workloadIdentityPools.providers.create adiciona um provedor de identidade OIDC.

Método HTTP e URL:

POST https://iam.googleapis.com/v1/projects/project-id/locations/global/workloadIdentityPools/pool-id/providers?workloadIdentityPoolProviderId=provider-id

Corpo JSON da solicitação:

{
  "issuerUrl": "issuer-uri"
}

Para enviar a solicitação, expanda uma destas opções:

O método retorna uma Operation de longa duração semelhante a esta:

{
  "name": "projects/project-number/locations/global/workloadIdentityPools/pool-id/providers/provider-id/operations/operation-id"
}

Permitir identidades externas para personificar uma conta de serviço

Identidades externas não podem acessar a maioria dos recursos do Google Cloud diretamente. Em vez disso, você permite que as identidades representem uma conta de serviço, concedendo a elas o papel Usuário de identidade da carga de trabalho (roles/iam.workloadIdentityUser) na conta de serviço. Quando as identidades externas personificam uma conta de serviço, elas têm os mesmos papéis e permissões que a conta de serviço.

Para conceder o papel Usuário de identidade da carga de trabalho a identidades externas, faça o seguinte:

Console

Antes de conceder o papel de Usuário de identidade da carga de trabalho, decida quais identidades você poderá personificar a conta de serviço. É possível conceder o papel a todas as identidades no pool de identidades de carga de trabalho ou a um subconjunto dessas identidades com base no mapeamento de atributos:

Identidades Nome do atributo Valor do atributo
Identidade única subject SUBJECT_NAME
Todas as identidades com um valor de atributo específico ATTRIBUTE_NAME ATTRIBUTE_VALUE

Em seguida, conceda acesso à conta de serviço e, opcionalmente, faça o download de um arquivo de configuração para gerar credenciais automaticamente:

  1. No Console do Cloud, acesse a página Pools de identidade da carga de trabalho.

    Acessar os pools de identidade da carga de trabalho

  2. Encontre o pool de identidades da carga de trabalho que contém as identidades externas e clique no ícone Editar. O Console do Cloud mostra detalhes sobre o pool de identidades da carga de trabalho.

  3. Clique em CONCEDER ACESSO.

  4. Na lista suspensa Conta de serviço, selecione a conta de serviço que as identidades externas representarão.

  5. Escolha quais identidades no pool podem representar a conta de serviço.

    Para permitir que todas as identidades personifiquem a conta de serviço, selecione Todas as identidades no pool.

    Para permitir que um subconjunto de identidades represente a conta de serviço, selecione Somente identidades correspondentes ao filtro e faça o seguinte:

    1. Na lista suspensa Nome do atributo, selecione o atributo que você quer avaliar.

      Apenas os atributos mapeados aparecem na lista. Os prefixos google. e attribute. não são exibidos.

    2. No campo Valor do atributo, insira o valor esperado do atributo.

  6. Clique em Save.

    Se as identidades já tiverem acesso à conta de serviço, o Console do Cloud mostrará detalhes sobre o pool de identidades da carga de trabalho. É possível pular as etapas restantes.

    Se as identidades tiverem acesso à conta de serviço, o Console do Cloud mostrará a caixa de diálogo Configurar seu aplicativo.

  7. Opcional: para fazer o download de um arquivo de configuração para gerar credenciais automaticamente, faça o seguinte:

    1. Na lista suspensa Provedor, selecione o provedor que contém as identidades externas que representarão a conta de serviço.

    2. Clique em Fazer o download da configuração para fazer o download de um arquivo de configuração JSON.

  8. Clique em Dispensar.

gcloud

Antes de conceder o papel de Usuário de identidade da carga de trabalho, decida quais identidades você poderá representar a conta de serviço. É possível conceder o papel a todas as identidades no pool de identidades de carga de trabalho ou a um subconjunto dessas identidades com base no mapeamento de atributos:

Identidades Formato do identificador
Identidade única principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_NAME
Todas as identidades com um valor de atributo específico. principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/attribute.ATTRIBUTE_NAME/ATTRIBUTE_VALUE
Todas as identidades em um pool principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/*

Em seguida, execute o comando gcloud iam service-accounts add-iam-policy-binding:

gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
    --role=roles/iam.workloadIdentityUser \
    --member="PRINCIPAL"

Substitua os seguintes valores:

  • SERVICE_ACCOUNT_EMAIL: o endereço de e-mail da conta de serviço padrão.
  • PRINCIPAL: as identidades externas que representarão a conta de serviço.

REST

Antes de conceder o papel de Usuário de identidade da carga de trabalho, decida quais identidades você poderá representar a conta de serviço. É possível conceder o papel a todas as identidades no pool de identidades de carga de trabalho ou a um subconjunto dessas identidades com base no mapeamento de atributos:

Identidades Formato do identificador
Identidade única principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/subject/SUBJECT_NAME
Todas as identidades com um valor de atributo específico. principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/attribute.ATTRIBUTE_NAME/ATTRIBUTE_VALUE
Todas as identidades em um pool principalSet://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/*

Em seguida, use o padrão read-modify-write para atualizar a política:

  1. Leia a política do IAM da conta de serviço.
  2. Modifique a política para conceder o papel.
  3. Grave a política atualizada.

Leia a política do IAM da conta de serviço.

O método serviceAccounts.getIamPolicy recebe a política do IAM de uma conta de serviço.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID do projeto do Google Cloud. Os IDs do projeto são strings alfanuméricas, como my-project.
  • SA_ID: o ID da sua conta de serviço. Pode ser o endereço de e-mail da conta de serviço no formato SA_NAME@PROJECT_ID.iam.gserviceaccount.com ou o ID numérico exclusivo da conta de serviço.

  • POLICY_VERSION: a versão da política a ser retornada. As solicitações precisam especificar a versão mais recente da política, que é a versão 3 da política. Para saber mais detalhes, consulte Como especificar uma versão da política ao receber uma política.

Método HTTP e URL:

POST https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts/SA_ID:getIamPolicy

Corpo JSON da solicitação:

{
  "options": {
    "requestedPolicyVersion": POLICY_VERSION
  }
}

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

{
  "version": 1,
  "etag": "BwWKmjvelug=",
  "bindings": [
    {
      "role": "roles/serviceAccountAdmin",
      "members": [
        "user:admin@example.com"
      ]
    }
  ]
}

Quando não houver política, a resposta conterá apenas o padrão etag. Se você receber essa resposta, adicione um campo version, definido como 3 e um campo bindings, definidos como uma matriz vazia.

Modificar a política para conceder os papéis apropriados aos principais.

Para conceder um papel, modifique a matriz bindings do corpo da resposta:

  • Se uma vinculação para o papel não existir, adicione um novo objeto à matriz bindings que defina o papel que você quer conceder e o principal a quem você quer conceder.
  • Se já houver uma vinculação para o papel, adicione o novo principal à lista de existentes.

Exemplo:

Para conceder o papel de usuário de identidade de carga de trabalho (roles/iam.workloadIdentityUser) a todas as identidades do pool, altere o exemplo mostrado na etapa anterior da seguinte maneira:

{
  "version": 1,
  "etag": "BwUqLaVeua8=",
  "bindings": [
    {
      "role": "roles/iam.workloadIdentityUser",
      "members": [
        "principalSet://iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/*"
      ]
    },
    {
      "role": "roles/iam.serviceAccountAdmin",
      "members": [
        "user:admin@example.com"
      ]
    }
  ]
}

Grave a política atualizada.

O método serviceAccounts.setIamPolicy define uma política atualizada do IAM para a conta de serviço.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID do projeto do Google Cloud. Os IDs do projeto são strings alfanuméricas, como my-project.
  • SA_ID: o ID da sua conta de serviço. Pode ser o endereço de e-mail da conta de serviço no formato SA_NAME@PROJECT_ID.iam.gserviceaccount.com ou o ID numérico exclusivo da conta de serviço.

  • POLICY: uma representação JSON da política que você quer definir. Para mais informações sobre o formato de uma política, consulte a referência da política.

    Por exemplo, para definir a política mostrada na etapa anterior, substitua policy pelo seguinte:

    {
      "version": 1,
      "etag": "BwUqLaVeua8=",
      "bindings": [
        {
          "role": "roles/iam.workloadIdentityUser",
          "members": [
            "principalSet://iam.googleapis.com/projects/1234567890123/locations/global/workloadIdentityPools/my-pool/*"
          ]
        },
        {
          "role": "roles/iam.serviceAccountAdmin",
          "members": [
            "user:admin@example.com"
          ]
        }
      ]
    }
    

Método HTTP e URL:

POST https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts/SA_ID:setIamPolicy

Corpo JSON da solicitação:

{
  "policy": POLICY
}

Para enviar a solicitação, expanda uma destas opções:

A resposta contém a política atualizada.

Gerar credenciais do Google

Se você usa uma biblioteca de cliente compatível, pode configurá-la para que ela gere credenciais do Google automaticamente. Se preferir, gere um token de ID do OIDC manualmente e troque-o pelas credenciais do Google.

Quando possível, recomendamos que você gere credenciais automaticamente. Assim, não é necessário implementar o processo de troca de token por conta própria.

Gerar credenciais automaticamente

Se você acessar o Google Cloud com uma biblioteca de cliente para um dos seguintes idiomas, será possível configurar a biblioteca de cliente para gerar credenciais automaticamente usando federação de identidade:

C++

A maioria das bibliotecas de cliente do Google Cloud para C++ é compatível com a federação de identidade usando um objeto ChannelCredentials, que é criado chamando grpc::GoogleDefaultCredentials(). Para inicializar essa credencial, crie as bibliotecas de cliente com a versão 1.36.0 ou posteriores do gRPC.

A biblioteca de cliente do Cloud Storage para C++ usa a API REST, não a gRPC. Portanto, ela não é compatível com a federação de identidade.

Go

As bibliotecas de cliente do Go são compatíveis com a federação de identidade se usarem a versão v0.0.0-20210218202405-ba52d332ba99 ou posteriores do módulo golang.org/x/oauth2.

Para verificar qual versão deste módulo sua biblioteca de cliente usa, execute os seguintes comandos:

cd $GOPATH/src/cloud.google.com/go
go list -m golang.org/x/oauth2

Java

As bibliotecas de cliente do Java aceitam federação de identidade se usarem a versão 0.24.0 ou posteriores do artefato com.google.auth:google-auth-library-oauth2-http.

Para verificar qual versão desse artefato a biblioteca de cliente usa, execute o seguinte comando do Maven no diretório do aplicativo:

mvn dependency:list -DincludeArtifactIds=google-auth-library-oauth2-http

Node.js

As bibliotecas de cliente do Node.js são compatíveis com a federação de identidade se usarem a versão 7.0.2 ou posteriores do pacote google-auth-library.

Para verificar qual versão desse pacote sua biblioteca de cliente usa, execute o seguinte comando no diretório do seu aplicativo:

npm list google-auth-library

Ao criar um objeto GoogleAuth, é possível especificar um ID de projeto ou permitir que GoogleAuth encontre o ID do projeto automaticamente. Para encontrar o ID do projeto automaticamente, a conta de serviço no arquivo de configuração precisa ter o papel de navegador (roles/browser), ou um papel com permissões equivalentes no projeto. Para ver detalhes, consulte o README do pacote google-auth-library.

Python

As bibliotecas de cliente do Python são compatíveis com a federação de identidade se usarem a versão 1.27.0 ou posteriores do pacote google-auth.

Para verificar qual versão desse pacote sua biblioteca de cliente usa, execute o seguinte comando no ambiente em que o pacote está instalado:

pip show google-auth

Para especificar um ID de projeto para o cliente de autenticação, defina a variável de ambiente GOOGLE_CLOUD_PROJECT ou permita que o cliente encontre o ID do projeto automaticamente. Para encontrar o ID do projeto automaticamente, a conta de serviço no arquivo de configuração precisa ter o papel de Navegador (roles/browser) ou um papel com permissões equivalentes no projeto. Para ver detalhes, consulte o guia do usuário do pacote google-auth.

Para configurar a biblioteca de cliente para gerar credenciais automaticamente, crie um arquivo de configuração JSON. É possível criar esse arquivo com o Console do Cloud ou com a ferramenta gcloud.

O arquivo de configuração especifica como a biblioteca de cliente receberá os tokens do provedor de identidade. Existem algumas maneiras diferentes de a biblioteca de cliente receber tokens:

  • Credenciais originárias do arquivo: os tokens são carregados de um arquivo. Outro processo precisa atualizar esse arquivo com um novo token OIDC antes que o antigo expire. Por exemplo, se o token tiver um ciclo de vida de uma hora, você precisará atualizar o arquivo antes de ele completar 1 hora.
  • Credenciais fornecidas pelo URL: os tokens são carregados de um servidor local com um endpoint que responde a solicitações HTTP GET. A resposta precisa ser um token de ID do OIDC, em texto simples ou em formato JSON.

Console

Primeiro, siga as instruções nesta página para permitir que identidades externas representem uma conta de serviço. Em seguida, crie um arquivo de configuração JSON para qualquer conta de serviço que as identidades externas possam representar.

Para criar um arquivo de configuração JSON, faça o seguinte:

  1. No Console do Cloud, acesse a página Pools de identidade da carga de trabalho.

    Acessar pools de identidade da carga de trabalho

  2. Encontre o pool de identidades da carga de trabalho que contém o provedor de identidade que você quer usar e clique no ícone Editar. O Console do Cloud mostra detalhes sobre o pool de identidades da carga de trabalho.
  3. Clique em Contas de serviço conectadas
  4. Encontre a conta de serviço que você quer usar e clique em Download.
  5. Na lista suspensa Provedor, selecione o provedor que contém as identidades OIDC que personificam a conta de serviço.
  6. Na caixa Caminho do token de código do OIDC, digite uma das seguintes opções:

    • Para credenciais de origem do arquivo: o caminho do arquivo onde os tokens de ID do OIDC serão armazenados.
    • Para credenciais provenientes de URL: o URL que fornece tokens de ID do OIDC em resposta a solicitações HTTP GET.
  7. Na lista suspensa Tipo de formato, selecione txt para o formato de texto ou json para o formato JSON.

    Se você selecionar json, confirme se o valor na caixa Nome do campo do token do assunto corresponde ao nome do campo JSON que contém o token. Atualize o valor conforme necessário.

  8. Clique em Fazer o download da configuração para fazer o download do arquivo de configuração JSON e clique em Concluído

Se você estiver usando credenciais com origem no URL e quiser incluir cabeçalhos HTTP específicos na solicitação, adicione estes cabeçalhos ao arquivo de configuração:

  1. Abra o arquivo de configuração em um editor de texto e encontre o campo headers. Aparecerá da seguinte maneira:

    "headers": {},
    
  2. Adicione os cabeçalhos HTTP ao objeto headers como pares de chave-valor. Cada chave e valor precisa estar entre aspas duplas.

    Por exemplo, para enviar o cabeçalho X-Example-One com o valor test e o cabeçalho X-Example-Two com o valor example, adicione o seguinte:

    "headers": {
      "X-Example-One": "test",
      "X-Example-Two": "example"
    },
    
  3. Salve suas alterações no arquivo de configuração.

gcloud

Para usar credenciais originadas de arquivos, execute o comando gcloud iam workload-identity-pools create-cred-config para gerar o arquivo de configuração. A sinalização --credential-source-type é opcional; a sinalização --credential-source-field-name é opcional, a menos que --credential-source-type seja json:

gcloud iam workload-identity-pools create-cred-config \
    projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID \
    --service-account=SERVICE_ACCOUNT_EMAIL \
    --output-file=CONFIGURATION_FILEPATH \
    --credential-source-file=TOKEN_FILEPATH \
    --credential-source-type=SOURCE_TYPE \
    --credential-source-field-name=FIELD_NAME

Substitua os seguintes valores:

  • PROJECT_NUMBER: ID numérico do projeto.
  • POOL ID: ID do pool de identidade da carga de trabalho.
  • PROVIDER_ID: ID do provedor do pool de Identidade da carga de trabalho.
  • SERVICE_ACCOUNT_EMAIL: o endereço de e-mail da conta de serviço a ser personificada.
  • CONFIGURATION_FILEPATH: o caminho do arquivo de configuração.
  • TOKEN_FILEPATH: o caminho do arquivo onde os tokens de ID do OIDC serão armazenados.
  • SOURCE_TYPE: o formato do arquivo do token de ID do OIDC. Defina como text ou json. O padrão é text.
  • FIELD_NAME: para arquivos de token JSON, o nome do campo JSON que contém o token. Obrigatório se --credential-source-type for json.

Para usar credenciais originadas de arquivos, execute o comando gcloud iam workload-identity-pools create-cred-config para gerar o arquivo de configuração. As sinalizações --credential-source-headers e --credential-source-type são opcionais; a sinalização --credential-source-field-name é opcional, a menos que --credential-source-type seja json:

gcloud iam workload-identity-pools create-cred-config \
    projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID \
    --service-account=SERVICE_ACCOUNT_EMAIL \
    --output-file=CONFIGURATION_FILEPATH \
    --credential-source-url="TOKEN_URL" \
    --credential-source-headers="KEY_1=VALUE_1,KEY_2=VALUE_2" \
    --credential-source-type=source_type \
    --credential-source-field-name=field_name

Substitua os seguintes valores:

  • PROJECT_NUMBER: ID numérico do projeto.
  • POOL_ID: ID do pool de identidade da carga de trabalho.
  • PROVIDER_ID: ID do provedor do pool de Identidade da carga de trabalho.
  • SERVICE_ACCOUNT_EMAIL: o endereço de e-mail da conta de serviço a ser personificada.
  • CONFIGURATION_FILEPATH: o caminho do arquivo de configuração.
  • TOKEN_URL: o URL que fornece tokens de ID do OIDC em resposta às solicitações HTTP GET.
  • KEY_1, KEY_2: o nome de um cabeçalho HTTP a ser incluído na solicitação.
  • VALUE_1, VALUE_2: o valor de um cabeçalho HTTP a ser incluído na solicitação.
  • SOURCE_TYPE: o formato do arquivo de token do OIDC. Defina como text ou json. O padrão é text.
  • FIELD_NAME: para arquivos de token JSON, o nome do campo que contém o token. Obrigatório se --credential-source-type for json.

Depois de gerar o arquivo de configuração, defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS como o caminho de arquivo do arquivo de configuração. Essa variável de ambiente instrui a biblioteca de cliente a usar o Application Default Credentials para autenticar. Para detalhes, consulte Como localizar credenciais automaticamente.

Trocar credenciais manualmente

Depois que sua identidade externa conseguir personificar uma conta de serviço, troque as credenciais dela por credenciais do Google manualmente.

Para trocar credenciais:

  1. Consiga um token de ID do OIDC do seu provedor de identidade (consulte a documentação do seu provedor de identidade para ver instruções detalhadas).

  2. Envie o token de ID do OIDC para o método token() do Security Token Service a fim de receber um token de acesso federado:

    REST

    O método token troca um token de terceiros por um do Google.

    Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

    • PROJECT_NUMBER: o número do projeto do Google Cloud.
    • POOL_ID: o ID do pool de identidades da carga de trabalho que você criou.
    • PROVIDER_ID: o ID do provedor de identidade que você configurou.
    • ACCESS_TOKEN: o token do provedor de identidade.

    Método HTTP e URL:

    POST https://sts.googleapis.com/v1/token

    Corpo JSON da solicitação:

    {
      "audience": "//iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID",
      "grantType": "urn:ietf:params:oauth:grant-type:token-exchange",
      "requestedTokenType": "urn:ietf:params:oauth:token-type:access_token",
      "scope": "https://www.googleapis.com/auth/cloud-platform",
      "subjectTokenType": "urn:ietf:params:oauth:token-type:jwt",
      "subjectToken": "ACCESS_TOKEN"
    }
    

    Para enviar a solicitação, expanda uma destas opções:

     

    O método retorna um token federado.

  3. Chame generateAccessToken() para trocar o token federado por um token de acesso de conta de serviço. Um número limitado de APIs do Google Cloud é compatível com tokens federados. Todas as APIs do Google Cloud são compatíveis com tokens de acesso da conta de serviço.

    REST

    O método serviceAccounts.generateAccessToken da API Service Account Credentials gera um token de acesso do OAuth 2.0 para uma conta de serviço.

    Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

    • PROJECT_ID: o ID do projeto do Google Cloud. Os IDs do projeto são strings alfanuméricas, como my-project.
    • SA_ID: o ID da sua conta de serviço. Pode ser o endereço de e-mail da conta de serviço no formato SA_NAME@PROJECT_ID.iam.gserviceaccount.com ou o ID numérico exclusivo da conta de serviço.
    • token: o token de acesso federado.

    Método HTTP e URL:

    POST https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/SA_NAME@PROJECT_ID.iam.gserviceaccount.com:generateAccessToken

    Corpo JSON da solicitação:

    {
      "scope": [
        "https://www.googleapis.com/auth/cloud-platform"
      ]
    }
    

    Para enviar a solicitação, expanda uma destas opções:

    Se a solicitação generateAccessToken for bem-sucedida, o corpo da resposta conterá um token de acesso do OAuth 2.0 e um prazo de validade. O accessToken poderá ser usado para autenticar uma solicitação em nome da conta de serviço até que o expireTime seja atingido.

    {
      "accessToken": "eyJ0eXAi...NiJ9",
      "expireTime": "2020-04-07T15:01:23.045123456Z"
    }
    

Quando você tiver um token de acesso para uma conta de serviço, poderá usá-lo para chamar as APIs do Google Cloud incluindo o token no cabeçalho Authorization das suas solicitações:

Authorization: Bearer SERVICE_ACCOUNT_ACCESS_TOKEN

A solicitação está autorizada como a conta de serviço.

A seguir