GitHub Marketplace Docker Image Version (latest semver) License GitHub stars

Find exposed credentials in your commits using GitGuardian shield.

The GitGuardian shield (ggshield) is a CLI application that runs in your local environment or in a CI environment to help you detect more than 400 types of secrets, as well as other potential security vulnerabilities or policy breaks.

GitGuardian shield uses our public API through py-gitguardian to scan your files and detect potential secrets or issues in your code. The /v1/scan endpoint of the public API is stateless. We will not store any files you are sending or any secrets we have detected.

• A GitGuardian account. Sign up now if you haven't before!
• A GitGuardian API Key. You can create your API Key here. The only required scope is scan.

Add a new job to your GitHub workflow using the GitGuardian/ggshield-action action.

name: GitGuardian scan
on: [push, pull_request]
jobs:
 scanning:
 name: GitGuardian scan
 runs-on: ubuntu-latest
 permissions:
 contents: read
 steps:
 - name: Checkout
 uses: actions/checkout@v4
 with:
 fetch-depth: 0 # fetch all history so multiple commits can be scanned
 - name: GitGuardian scan
 uses: GitGuardian/ggshield-action@v1
 env:
 GITHUB_PUSH_BEFORE_SHA: ${{ github.event.before }}
 GITHUB_PUSH_BASE_SHA: ${{ github.event.base }}
 GITHUB_DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
 GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}

Add your GitGuardian API Key to the GITGUARDIAN_API_KEY secret in your project settings.

The action accepts the same extra options as the ggshield secret scan ci command. Here is the command reference.

Example:

name: GitGuardian scan
on: [push, pull_request]
jobs:
 scanning:
 name: GitGuardian scan
 runs-on: ubuntu-latest
 permissions:
 contents: read
 steps:
 - name: Checkout
 uses: actions/checkout@v4
 with:
 fetch-depth: 0 # fetch all history so multiple commits can be scanned
 - name: GitGuardian scan
 uses: GitGuardian/ggshield-action@v1
 with:
 args: -v --ignore-known-secrets
 env:
 GITHUB_PUSH_BEFORE_SHA: ${{ github.event.before }}
 GITHUB_PUSH_BASE_SHA: ${{ github.event.base }}
 GITHUB_DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
 GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}

Scan output example

This a sample scan result from GitGuardian shield.

If the secret detected has been revoked and you do not wish to rewrite git history, you can use a value of the policy break (for example: the value of |_password_|) or the ignore SHA displayed in your .gitguardian.yaml under matches-ignore.

An example configuration file is available here.

Status example

If there are secret leaks or other security issues in your commit your workflow will be marked as failed.

Be sure to add GitGuardian scan to your required status checks in your repository settings to stop pull requests with security issues from being merged.

GitGuardian shield is MIT licensed.