Intégrer la validation de l'IaC avec GitHub Actions

Vous pouvez utiliser l'action Analyze Code Security pour valider l'infrastructure as code (IaC) qui fait partie de votre workflow GitHub Actions. La validation IaC vous permet de déterminer si vos définitions de ressources Terraform enfreignent les règles d'administration et les détecteurs Security Health Analytics existants appliqués à vos ressources Google Cloud .

Pour en savoir plus sur la validation IaC, consultez Valider votre IaC par rapport aux règles de votre organisation. Google Cloud

Avant de commencer

Effectuez ces tâches pour commencer à valider l'IaC avec GitHub Actions.

Activer le niveau Premium ou Enterprise de Security Command Center

Vérifiez que le niveau Premium ou Enterprise de Security Command Center est activé au niveau de l'organisation.

L'activation de Security Command Center permet d'utiliser les API securityposture.googleapis.com et securitycentermanagement.googleapis.com.

Créer un compte de service

Créez un compte de service que vous pourrez utiliser pour l'action "Analyser la sécurité du code".

  1. In the Google Cloud console, go to the Create service account page.

    Go to Create service account
  2. Select your project.

  3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

    In the Service account description field, enter a description. For example, Service account for quickstart.

  4. Click Create and continue.

  5. Grant the Security Posture Shift-Left Validator role to the service account.

    To grant the role, find the Select a role list, then select Security Posture Shift-Left Validator.

  6. Click Continue.

  7. Click Done to finish creating the service account.

Pour en savoir plus sur les autorisations de validation IaC, consultez IAM pour les activations au niveau de l'organisation.

Configurer l'authentification

  1. Configurez la fédération d'identité de charge de travail avec votre fournisseur d'identité GitHub. Pour savoir comment procéder, consultez Fédération d'identité de charge de travail.

  2. Obtenez l'URL de votre jeton d'identité de fédération d'identité de charge de travail. Par exemple, https://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/POOL_ID/providers/PROVIDER_ID.

    Réfléchissez aux éléments suivants :

    • PROJECT_NUMBER est le numéro du projetGoogle Cloud dans lequel vous avez configuré la fédération d'identité de charge de travail.
    • POOL_ID est le nom du pool.
    • PROVIDER_ID est le nom de votre fournisseur d'identité.

  3. Ajoutez l'action "S'authentifier auprès de Google Cloud" à votre workflow pour authentifier l'action de validation de l'IaC.

Définir vos règles

Définissez vos règles d'administration et vos détecteurs Security Health Analytics. Pour définir ces règles à l'aide d'une stratégie de sécurité, effectuez les tâches décrites dans Créer et déployer une stratégie.

Créer votre fichier JSON de plan Terraform

  1. Créez votre code Terraform. Pour obtenir des instructions, consultez Créer votre code Terraform.

  2. Dans vos actions GitHub, initialisez Terraform. Par exemple, si vous utilisez l'action HashiCorp - Setup Terraform, exécutez la commande suivante :

    - name: Terraform Init
  id: init
  run: terraform init

  3. Créez un fichier de plan Terraform :

    - name: Create Terraform Plan
  id: plan
  run: terraform plan -out=TF_PLAN_FILE

    Remplacez TF_PLAN_FILE par le nom du fichier de plan Terraform. Exemple :myplan.tfplan

  4. Convertissez votre fichier de plan au format JSON :

    - name: Convert Terraform Plan to JSON
  id: convert
  run: terraform show -no-color -json TF_PLAN_FILE > TF_PLAN_JSON_FILE

    Remplacez TF_PLAN_JSON_FILE par le nom du fichier de plan Terraform, au format JSON. Exemple :mytfplan.json

Ajouter l'action à votre workflow GitHub Actions

  1. Dans le dépôt GitHub, accédez à votre workflow.
  2. Ouvrez l'éditeur de workflow.
  3. Dans la barre latérale GitHub Marketplace, recherchez Analyze Code Security.
  4. Dans la section Installation, copiez la syntaxe.
  5. Collez la syntaxe en tant que nouvelle étape dans votre workflow.

  6. Remplacez les valeurs suivantes :

    • workload_identity_provider par le lien vers l'URL de votre jeton d'identité de fédération d'identité de charge de travail.
    • service_account par l'adresse e-mail du compte de service que vous avez créé pour l'action.
    • organization_id par l'ID de votre organisation Google Cloud .
    • scan_file_ref par le chemin d'accès à votre fichier de plan Terraform, au format JSON.
    • failure_criteria avec les critères de seuil d'échec qui déterminent quand l'action échoue. Les critères de seuil sont basés sur le nombre de problèmes critiques, de gravité élevée, moyenne et faible rencontrés par l'analyse de validation IaC. failure_criteria spécifie le nombre de problèmes autorisés pour chaque niveau de gravité et la façon dont les problèmes sont agrégés (AND ou OR). Par exemple, si vous souhaitez que l'action échoue si elle rencontre un problème critique ou un problème de gravité élevée, définissez failure_criteria sur Critical:1,High:1,Operator:OR. La valeur par défaut est Critical:1,High:1,Medium:1,Low:1,Operator:OR, ce qui signifie que si l'analyse de validation de l'IaC rencontre un problème, l'action doit échouer.

Vous pouvez maintenant exécuter le workflow pour valider votre fichier de plan Terraform. Pour exécuter le workflow manuellement, consultez Exécuter un workflow manuellement.

Afficher le rapport sur les cas de non-respect des règles IaC

  1. Dans votre dépôt GitHub, cliquez sur Actions, puis sélectionnez votre workflow.

  2. Cliquez sur l'exécution la plus récente de votre workflow.

    Dans la section Artefacts, le rapport sur les cas de non-respect (ias-scan-sarif.json) est disponible dans un fichier ZIP. Le rapport inclut les champs suivants :

    • Un champ rules qui décrit les règles enfreintes par le plan Terraform. Chaque règle inclut un ruleID que vous pouvez faire correspondre aux résultats inclus dans le rapport.
    • Champ results qui décrit les modifications proposées de l'élément qui enfreignent une règle spécifique.

  3. Résolvez les cas de non-respect des règles dans votre code Terraform avant de l'appliquer.

Étapes suivantes