Aller au contenu principal

GitHub Actions

Prélude​

L'intégration CI/CD de GitGuardian avec GitHub se présente sous la forme de GitHub Actions et s'effectue via notre application CLI : ggshield. ggshield est un wrapper autour de l'API GitGuardian pour la détection de secrets, une clé d'API est requise pour l'authentification.

Les actions ggshield se trouvent dans le répertoire des actions du dépôt GitHub.

Remarque : Si vous souhaitez garantir une couverture complète de vos dépôts GitHub ainsi que des scans et rapports complets de l'historique git, vous pourriez être intéressé par l'utilisation de l'intégration GitHub de GitGuardian.

Aperçu​

GitHub Actions output

S'il y a des fuites de secrets ou d'autres problèmes de sécurité dans votre commit, votre workflow sera marqué comme échoué.

GitHub Actions checks list

Veillez à ajouter GitGuardian scan à vos vérifications de statut requises dans les paramètres de votre dépôt afin d'empêcher la fusion des pull requests présentant des problèmes de sécurité.

Installation​

Les comptes de service sont recommandés pour exécuter cette intégration.

Veuillez noter que les comptes de service ne sont disponibles que pour les workspaces sous notre plan Growth ou Enterprise, et leur administration est réservée aux Managers. Si votre workspace est sous le plan Free, vous pouvez toujours utiliser un jeton d'accès personnel pour exécuter cette intégration.

  1. Créez un compte de service depuis la section API de votre workspace GitGuardian (ou un jeton d'accès personnel si vous êtes sur le plan Free).
  2. Ajoutez cette clé d'API à la variable d'environnement GITGUARDIAN_API_KEY dans les paramètres de votre projet. Vous pouvez définir la valeur GITGUARDIAN_API_KEY dans la page « Secrets » des paramètres de votre dépôt.
  3. Ajoutez un nouveau job à votre workflow GitHub en utilisant l'action GitGuardian/ggshield-action .github/workflows/gitguardian.

Modèle pour le scan de secrets​

name: GitGuardian scan

on: [push, pull_request]

jobs:
scanning:
name: GitGuardian scan
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0 # fetch all history so multiple commits can be scanned
- name: GitGuardian scan
uses: GitGuardian/ggshield/actions/secret@v1.56.1
env:
GITHUB_PUSH_BEFORE_SHA: ${{ github.event.before }}
GITHUB_PUSH_BASE_SHA: ${{ github.event.base }}
GITHUB_PULL_BASE_SHA: ${{ github.event.pull_request.base.sha }}
GITHUB_DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}