Configuration d’OpenID Connect dans Google Cloud Platform

Vue d’ensemble

OpenID Connect (OIDC) permet à vos workflows GitHub Actions d’accéder aux ressources dans Google Cloud Platform (GCP), sans avoir à stocker d’informations d’identification GPC en tant que secrets GitHub à long terme.

Ce guide offre une vue d’ensemble sur la façon de configurer GCP pour approuver le protocole OIDC de GitHub en tant qu’identité fédérée et il inclut un exemple de workflow pour l’action google-github-actions/auth qui utilise des jetons pour s’authentifier auprès de GCP et accéder aux ressources.

Prérequis

• Pour en savoir plus sur les concepts de base décrivant la façon dont GitHub utilise OIDC (OpenID Connect) ainsi que sur son architecture et ses avantages, consultez « À propos du renforcement de la sécurité avec OpenID Connect ».

• Avant de continuer, vous devez planifier votre stratégie de sécurité pour veiller à ce que les jetons d’accès soient uniquement alloués de manière prévisible. Pour contrôler la façon dont votre fournisseur de cloud émet des jetons d’accès, vous devez définir au moins une condition, afin que les dépôts non approuvés ne puissent pas demander de jetons d’accès à vos ressources cloud. Pour plus d’informations, consultez « À propos du renforcement de la sécurité avec OpenID Connect ».

Ajout d’un fournisseur d’identité de charge de travail Google Cloud

Pour configurer le fournisseur d’identité OIDC dans GCP, vous devez effectuer la configuration suivante. Pour obtenir des instructions afin d’apporter ces modifications, reportez-vous à la documentation GCP.

1. Créez un nouveau pool d’identités.
2. Configurez le mappage et ajoutez des conditions.
3. Connectez le nouveau pool à un compte de service.

Conseils supplémentaires pour la configuration du fournisseur d’identité :

• Pour durcir la sécurité, veillez à consulter « À propos du renforcement de la sécurité avec OpenID Connect ». Pour obtenir un exemple, consultez « À propos du renforcement de la sécurité avec OpenID Connect ».
• Pour que le compte de service soit disponible pour la configuration, il doit être affecté au rôle roles/iam.workloadIdentityUser. Pour plus d’informations, consultez la documentation de GCC.
• URL de l’émetteur à utiliser : https://HOSTNAME/_services/token

Mise à jour de votre workflow GitHub Actions

Pour mettre à jour vos workflows pour OIDC, vous devez apporter deux modifications à votre code YAML :

1. Ajoutez des paramètres d’autorisations pour le jeton.
2. Utilisez l’action google-github-actions/auth pour échanger le jeton OIDC (JWT) afin d’obtenir un jeton d’accès cloud.

Ajout de paramètres d’autorisations

 L’exécution du travail ou du workflow nécessite un paramètre permissions avec id-token: write. Vous ne pourrez pas demander le jeton OIDC JWT ID si le paramètre permissions est id-token a la valeur read ou none.

Le paramètre id-token: write permet au JWT d’être demandé à partir du fournisseur OIDC de GitHub à l’aide de l’une des approches suivantes :

• Utilisation de variables d’environnement sur l’exécuteur (ACTIONS_ID_TOKEN_REQUEST_URL et ACTIONS_ID_TOKEN_REQUEST_TOKEN).
• Utilisation du getIDToken() issu du kit de ressources Actions.

Si vous devez extraire un jeton OIDC pour un workflow, l’autorisation peut être définie au niveau du workflow. Par exemple :

permissions:
  id-token: write # This is required for requesting the JWT
  contents: read  # This is required for actions/checkout

permissions:
  id-token: write # This is required for requesting the JWT
  contents: read  # This is required for actions/checkout

Si vous avez uniquement besoin d’extraire un jeton OIDC pour un seul travail, alors cette autorisation peut être définie au sein de ce travail. Par exemple :

permissions:
  id-token: write # This is required for requesting the JWT

permissions:
  id-token: write # This is required for requesting the JWT

Demande du jeton d’accès

L’action google-github-actions/auth reçoit un jeton JWT à partir du fournisseur OIDC GitHub, puis demande un jeton d’accès à partir de GCP. Pour plus d’informations, consultez la documentation GCP.

Cet exemple comporte un travail appelé Get_OIDC_ID_token qui utilise des actions pour demander une liste de services à partir de GCP.

• <example-workload-identity-provider> : remplacez cela par le chemin d’accès à votre fournisseur d’identité dans GCP. Par exemple : projects/<example-project-id>/locations/global/workloadIdentityPools/<name-of-pool/providers/<name-of-provider>
• <example-service-account> : remplacez cela par le nom de votre compte de service dans GCP.
• <project-id> : remplacez cela par l’ID de votre projet GCP.

Cette action permet d’échanger un jeton OIDC GitHub pour obtenir un jeton d’accès Google Cloud, à l’aide de la fédération d’identité de charge de travail.

name: List services in GCP
on:
  pull_request:
    branches:
      - main

permissions:
  id-token: write

jobs:
  Get_OIDC_ID_token:
    runs-on: ubuntu-latest
    steps:
    - id: 'auth'
      name: 'Authenticate to GCP'
      uses: 'google-github-actions/auth@v0.3.1'
      with:
          create_credentials_file: 'true'
          workload_identity_provider: '<example-workload-identity-provider>'
          service_account: '<example-service-account>'
    - id: 'gcloud'
      name: 'gcloud'
      run: |-
        gcloud auth login --brief --cred-file="${{ steps.auth.outputs.credentials_file_path }}"
        gcloud services list

name: List services in GCP
on:
  pull_request:
    branches:
      - main

permissions:
  id-token: write

jobs:
  Get_OIDC_ID_token:
    runs-on: ubuntu-latest
    steps:
    - id: 'auth'
      name: 'Authenticate to GCP'
      uses: 'google-github-actions/auth@v0.3.1'
      with:
          create_credentials_file: 'true'
          workload_identity_provider: '<example-workload-identity-provider>'
          service_account: '<example-service-account>'
    - id: 'gcloud'
      name: 'gcloud'
      run: |-
        gcloud auth login --brief --cred-file="${{ steps.auth.outputs.credentials_file_path }}"
        gcloud services list

Pour aller plus loin

• Utilisation d’OpenID Connect avec des workflows réutilisables - À propos des exécuteurs auto-hébergés