Accede a los recursos desde un proveedor de identidad de OIDC

En este documento, se muestra cómo usar la federación de identidades para acceder a los recursos de Google Cloud desde un proveedor de identidad que sea compatible con OpenID Connect (OIDC).

En general, las aplicaciones que se ejecutan fuera de Google Cloud usan claves de cuentas de servicio para acceder a los recursos de Google Cloud. Mediante la federación de identidades, puedes permitir que una identidad externa actúe en nombre de una cuenta de servicio. Esto permite que la carga de trabajo acceda a los recursos de Google Cloud directamente mediante un token de acceso de corta duración y quite la carga de seguridad y mantenimiento asociada con las claves de la cuenta de servicio.

Antes de comenzar

  1. Habilita las API de IAM, Resource Manager, Service Account Credentials, and Security Token Service (STS).

    Habilita las API

  2. Asegúrate de tener la función de administrador de grupo de Workload Identity (roles/iam.workloadIdentityPoolAdmin).

    De manera alternativa, la función básica de propietario de IAM (roles/owner) también incluye permisos para configurar la federación de identidades. No deberías otorgar funciones básicas en un entorno de producción, pero puedes otorgarlas en un entorno de desarrollo o de prueba.

  3. Actualiza la política de la organización para permitir la federación del proveedor de identidad.

  4. Crea una cuenta de servicio de Google Cloud.

  5. Otorga acceso a la cuenta de servicio para llamar a las API de Google Cloud que requiere la carga de trabajo.

Crea un grupo de Workload Identity

Puedes usar un grupo de Workload Identity para organizar y administrar identidades externas. Los grupos de Workload Identity se aíslan unos de otros, pero un solo grupo puede actuar en nombre de cualquier cantidad de cuentas de servicio. En general, recomendamos crear un grupo nuevo para cada uno de tus entornos, como desarrollo, etapa de pruebas o producción.

Para crear un grupo nuevo de Workload Identity, debes proporcionar un ID. También puedes proporcionar una descripción y un nombre visible opcionales.

gcloud

Ejecuta el comando gcloud iam workload-identity-pools create para crear un grupo de Workload Identity:

gcloud iam workload-identity-pools create pool-id \
    --location="global" \
    --description="description" \
    --display-name="display-name"

La respuesta es similar a la siguiente:

Created workload identity pool [pool-id].

REST

El método projects.locations.workloadIdentityPools.create crea un grupo de Workload Identity.

Método HTTP y URL:

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

Cuerpo JSON de la solicitud:

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

Para enviar tu solicitud, expande una de estas opciones:

Mediante este método, se muestra una Operation de larga duración similar a la siguiente:

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

Agrega un proveedor de identidad de OIDC

A fin de configurar un proveedor de identidad de OIDC para el grupo de Workload Identity, proporciona al menos lo siguiente:

  • Un ID para el proveedor

  • El ID del grupo de Workload Identity de la sección anterior de este documento

  • El URI de la entidad emisora del proveedor. Por lo general, toma el formato https://example.com. Consulta la documentación de tu proveedor sobre la integración de OIDC para encontrar el URI

  • Una lista de asignaciones de atributos que mapean las reclamaciones de un token externo a los atributos de un token de Google. Usa assertion a fin de hacer referencia a la credencial externa, google para los atributos de Google y attribute para los atributos personalizados.

    Hay dos atributos de Google: google.subject y google.groups. Puedes hacer referencia a estos atributos en las vinculaciones de funciones de IAM. google.subject también aparece en las entradas de registro de Cloud Logging.

    Debes proporcionar una asignación para google.subject. Por lo general, recomendamos asignarla a assertion.sub, que debería proporcionar un identificador estable para usar en vinculaciones de funciones de IAM. La asignación se ve de la siguiente manera:

    google.subject=assertion.sub
    

    Para aserciones más complejas, puedes usar Common Expression Language. Por ejemplo, si tu grupo de Workload Identity contiene varios proveedores de identidad, puedes agregar un prefijo para quitar la ambigüedad entre ellos:

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

    El campo google.subject no puede superar los 127 caracteres.

    También puedes especificar atributos personalizados. Por ejemplo, a continuación, se mapea assertion.foo a attribute.bar:

    attribute.bar=assertion.foo
    

    Consulta la documentación de tu proveedor sobre los tokens de acceso para obtener una lista completa de las reclamaciones a las que puedes hacer referencia.

    Para hacer referencia a una parte específica de una reclamación en una expresión, usa la función extract() de CEL, que extrae un valor de una reclamación a partir de una plantilla que proporciones. Para obtener más información sobre extract(), consulta Extrae valores de atributos.

    Para verificar si una credencial contiene una reclamación, usa la función has().

  • Una lista de públicos permitidos que especifican qué valores puede contener el campo aud en la credencial externa. Puedes configurar un máximo de 10 públicos, cada uno de hasta 256 caracteres. Consulta la documentación del proveedor a fin de obtener información sobre sus valores predeterminados para aud.

    De manera alternativa, si tu proveedor de identidad te permite configurar un valor personalizado para aud, puedes dejar el parámetro de públicos permitidos y establecer el valor de aud en el nombre completo de recursos de tu proveedor de Workload Identity. El prefijo HTTP es opcional; por ejemplo:

    //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
    

    En cualquier caso, se rechazan todas las solicitudes de intercambio de tokens que no contengan uno de los valores permitidos.

También puedes proporcionar varios parámetros opcionales:

  • Un nombre visible y una descripción

  • Una condición de atributo que especifica los atributos que debe mostrar el principal. La condición de atributo puede aplicarse a las reclamaciones de la credencial externa o a los atributos de la credencial de Google. Se rechaza cualquier solicitud que no cumpla con la condición de atributo.

    Las condiciones de los atributos tienen el formato de una expresión CEL que muestra un valor booleano. Por ejemplo, lo siguiente rechaza las solicitudes de cualquier identidad que no sea miembro de un grupo específico:

    group in assertion.groups
    

    Se recomienda el uso de condiciones de atributos si el proveedor de identidad está disponible para el público general. Para obtener más información sobre los casos de uso comunes, consulta Condiciones de atributos.

En el siguiente ejemplo, se muestra cómo agregar un proveedor de identidad:

gcloud

Ejecuta el comando gcloud iam workload-identity-pools providers create-oidc para agregar un proveedor de identidad:

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"

La respuesta es similar a la siguiente:

Created workload identity pool provider [provider-id].

REST

Mediante el método projects.locations.workloadIdentityPools.providers.create, se agrega un proveedor de identidad de OIDC.

Método HTTP y URL:

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

Cuerpo JSON de la solicitud:

{
  "issuerUrl": "issuer-uri"
}

Para enviar tu solicitud, expande una de estas opciones:

Mediante este método, se muestra una Operation de larga duración similar a la siguiente:

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

Otorga permiso para actuar en nombre de una cuenta de servicio

Las identidades externas no pueden acceder de forma directa a la mayoría de los recursos de Google Cloud. En su lugar, les otorgas la función de usuario de Workload Identity (roles/iam.workloadIdentityUser) para permitir que actúen en nombre de una cuenta de servicio.

Si deseas agregar esta vinculación de función para una identidad específica, usa el valor que mapeaste a google.subject:

gcloud iam service-accounts add-iam-policy-binding service-account-email \
    --role roles/iam.workloadIdentityUser \
    --member "principal://iam.googleapis.com/projects/project-number/locations/global/workloadIdentityPools/pool-id/subject/subject"

A fin de agregar esta vinculación para todos los miembros de un grupo, ejecuta el siguiente comando:

gcloud iam service-accounts add-iam-policy-binding service-account-email \
    --role roles/iam.workloadIdentityUser \
    --member "principalSet://iam.googleapis.com/projects/project-number/locations/global/workloadIdentityPools/pool-id/group/group-name"

También puedes otorgar acceso en función de atributos personalizados. Por ejemplo:

gcloud iam service-accounts add-iam-policy-binding service-account-email \
    --role="roles/iam.workloadIdentityUser" \
    --member="principalSet://iam.googleapis.com/projects/project-number/locations/global/workloadIdentityPools/pool-id/attribute.custom-attribute-name/custom-attribute-value"

Para revocar el acceso, reemplaza add-iam-policy-binding por remove-iam-policy-binding.

También puedes agregar o revocar vinculaciones mediante la API de REST o las bibliotecas cliente. Para obtener más información, consulta Otorga, cambia y revoca el acceso a los recursos.

Genera credenciales de Google

Si usas una biblioteca cliente compatible, puedes configurar la biblioteca cliente para que genere credenciales de Google automáticamente. De forma alternativa, puedes generar un token de ID de OIDC de forma manual y, luego, intercambiar el token por las credenciales de Google.

Te recomendamos que, cuando sea posible, generes las credenciales de forma automática para que no tengas que implementar el proceso de intercambio de tokens tú mismo.

Genera credenciales automáticamente

Si accedes a Google Cloud con una biblioteca cliente para uno de los siguientes lenguajes, puedes configurar la biblioteca cliente para que genere credenciales de forma automática mediante la federación de identidades:

C++

La mayoría de las bibliotecas cliente de Google Cloud para C++ admiten la federación de identidades mediante un objeto ChannelCredentials, que se crea mediante una llamada a grpc::GoogleDefaultCredentials(). Para inicializar esta credencial, debes compilar las bibliotecas cliente con la versión 1.36.0 o posterior de gRPC.

La biblioteca cliente de Cloud Storage para C++ usa la API de REST, no gRPC, por lo que no admite la federación de identidades.

Comienza a usarlo

Las bibliotecas cliente para Go admiten la federación de identidades si usan la versión v0.0.0-20210218202405-ba52d332ba99 o una versión posterior del módulo golang.org/x/oauth2.

Para verificar qué versión de este módulo usa tu biblioteca cliente, ejecuta los siguientes comandos:

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

Java

Las bibliotecas cliente para Java admiten la federación de identidades si usan la versión 0.24.0 o posterior del artefacto com.google.auth:google-auth-library-oauth2-http.

Para verificar qué versión de este artefacto usa tu biblioteca cliente, ejecuta el siguiente comando de Maven en el directorio de tu aplicación:

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

Node.js

Las bibliotecas cliente de Node.js admiten la federación de identidades si usan la versión 7.0.2 o una versión posterior del paquete google-auth-library.

Para verificar qué versión de este paquete usa tu biblioteca cliente, ejecuta el siguiente comando en el directorio de tu aplicación:

npm list google-auth-library

Cuando creas un objeto GoogleAuth, puedes especificar un ID del proyecto o puedes permitir que GoogleAuth encuentre el ID del proyecto de forma automática. Para encontrar el ID del proyecto de manera automática, la cuenta de servicio en el archivo de configuración debe tener la función de Navegador (roles/browser) o una función con permisos equivalentes en tu proyecto. Para obtener más información, consulta el README del paquete google-auth-library.

Python

Las bibliotecas cliente para Python admiten la federación de identidades si usan la versión 1.27.0 o posterior del paquete google-auth.

Para verificar qué versión de este paquete usa tu biblioteca cliente, ejecuta el siguiente comando en el entorno en el que está instalado el paquete:

pip show google-auth

Si deseas especificar un ID del proyecto para el cliente de autenticación, puedes configurar la variable de entorno GOOGLE_CLOUD_PROJECT o permitir que el cliente busque el ID del proyecto de forma automática. Para encontrar el ID del proyecto de manera automática, la cuenta de servicio en el archivo de configuración debe tener la función de Navegador (roles/browser) o una función con permisos equivalentes en tu proyecto. Para obtener más información, consulta la guía del usuario del paquete google-auth.

La biblioteca cliente puede obtener tokens del proveedor de identidad de varias maneras:

  • Credenciales provistas por el archivo: los tokens se cargan desde un archivo. Otro proceso debe actualizar este archivo con un token de OIDC nuevo antes de que caduque el token anterior. Por ejemplo, si el token tiene un ciclo de vida de 1 hora, debes actualizar el archivo antes de que tenga 1 hora de antigüedad.
  • Credenciales basadas en URL: Los tokens se cargan desde un servidor local con un extremo que responde a las solicitudes GET HTTP. La respuesta debe ser un token de ID de OIDC, ya sea en texto sin formato o en formato JSON.

Para usar credenciales basadas en archivos, ejecuta el comando gcloud iam workload-identity-pools create-cred-config para generar el archivo de configuración. La marca --credential-source-type es opcional. La marca --credential-source-field-name es opcional, a menos que --credential-source-type sea 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

Reemplaza los siguientes valores:

  • project-number: El ID numérico del proyecto.
  • pool-id: El ID del grupo de identidades de la carga de trabajo.
  • provider-id: El ID del proveedor de grupos de identidades de la carga de trabajo.
  • service-account-email: La dirección de correo electrónico de la cuenta de servicio que representar.
  • configuration-filepath: La ruta de acceso del archivo de configuración
  • token-filepath: La ruta de acceso del archivo en la que se almacenarán los tokens de ID de OIDC.
  • source-type: el formato del archivo de token de ID de OIDC. Se establece en text o json. La configuración predeterminada es text.
  • field-name: para los archivos de token JSON, el nombre del campo JSON que contiene el token. Obligatorio si --credential-source-type es json.

Para usar credenciales basadas en URL, también debes ejecutar el comando gcloud iam workload-identity-pools create-cred-config para generar el archivo de configuración. Las marcas --credential-source-headers y --credential-source-type son opcionales. La marca --credential-source-field-name es opcional, a menos que --credential-source-type sea 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="key1=value1,key2=value2" \
    --credential-source-type=source-type \
    --credential-source-field-name=field-name

Reemplaza los siguientes valores:

  • project-number: El ID numérico del proyecto.
  • pool-id: El ID del grupo de identidades de la carga de trabajo.
  • provider-id: El ID del proveedor de grupos de identidades de la carga de trabajo.
  • service-account-email: La dirección de correo electrónico de la cuenta de servicio que representar.
  • configuration-filepath: La ruta de acceso del archivo de configuración
  • token-url: La URL que proporciona tokens de ID de OIDC en respuesta a solicitudes GET de HTTP.
  • key1, key2: El nombre de un encabezado HTTP que se incluye en la solicitud.
  • value1, value2: El valor de un encabezado HTTP que se incluye en la solicitud.
  • source-type: el formato del archivo de token de OIDC. Se establece en text o json. La configuración predeterminada es text.
  • field-name: para los archivos de token JSON, el nombre del campo que contiene el token Obligatorio si --credential-source-type es json.

Después de generar el archivo de configuración, establece la variable de entorno GOOGLE_APPLICATION_CREDENTIALS en la ruta del archivo de configuración. Esta variable de entorno le indica a la biblioteca cliente que use las Credenciales predeterminadas de la aplicación para autenticarse. Para obtener más información, consulta Encuentra credenciales de forma automática.

Intercambia credenciales manualmente

Una vez que la identidad externa tenga la capacidad de suplantar una cuenta de servicio, puedes intercambiar sus credenciales por las credenciales de Google de forma manual.

Para intercambiar credenciales, haz lo siguiente:

  1. Obtén un token de ID de OIDC de tu proveedor de identidad (consulta su documentación para obtener instrucciones detalladas).

  2. Pasa el token de ID de OIDC al método token() del servicio de tokens de seguridad para obtener un token de acceso federado:

    REST

    El método token intercambia un token de terceros por un token de Google.

    Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

    • project-number: Es el número de tu proyecto de Google Cloud.
    • pool-id: Es el ID del grupo de Workload Identity que creaste con anterioridad en este instructivo.
    • provider-id: Es el ID del proveedor de identidad que configuraste con anterioridad en este instructivo.

    Método HTTP y URL:

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

    Cuerpo JSON de la solicitud:

    {
      "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": "oidc-id-token"
    }
    

    Para enviar tu solicitud, expande una de estas opciones:

     

    El método muestra un token federado.

  3. Llama a generateAccessToken() para intercambiar el token federado por un token de acceso a una cuenta de servicio. Una cantidad limitada de API de Google Cloud admite tokens federados. Todas las API de Google Cloud admiten tokens de acceso a la cuenta de servicio.

    REST

    Mediante el método serviceAccounts.generateAccessToken de la API de credenciales de la cuenta de servicio, se genera un token de acceso de OAuth 2.0 para una cuenta de servicio.

    Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

    • PROJECT_ID: El ID del proyecto de Google Cloud Los ID de proyecto son strings alfanuméricas, como my-project.
    • SA_ID: El ID de la cuenta de servicio. Puede ser la dirección de correo electrónico de la cuenta de servicio con el formato SA_NAME@PROJECT_ID.iam.gserviceaccount.com o el ID numérico único de la cuenta de servicio.
    • token: Es el token de acceso federado.

    Método HTTP y URL:

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

    Cuerpo JSON de la solicitud:

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

    Para enviar tu solicitud, expande una de estas opciones:

    Si la solicitud generateAccessToken tiene éxito, el cuerpo de la respuesta contendrá un token de acceso de OAuth 2.0 y un tiempo de caducidad. El accessToken se puede usar para autenticar una solicitud en nombre de la cuenta de servicio hasta que se haya alcanzado el expireTime.

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

Una vez que tengas un token de acceso para una cuenta de servicio, puedes usarlo a fin de llamar a las API de Google Cloud. A tal fin, incluye el token en el encabezado Authorization de las solicitudes:

Authorization: Bearer service-account-access-token

La solicitud está autorizada como la cuenta de servicio.

Próximos pasos