Skip to content

Take the scanner's key from 1Password, not from a GitHub secret #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imanimanyara merged 1 commit into from
Nov 13, 2026
Merged

Take the scanner's key from 1Password, not from a GitHub secret #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions .github/workflows/security.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ on:
type: string
default: 'mbstring, xml, ctype, iconv, intl'
secrets:
GITGUARDIAN_API_KEY:
OP_SERVICE_ACCOUNT_TOKEN:
description: >-
GitGuardian API key. Optional: without it the scan step is skipped with a warning rather
than failing, so adding this job cannot turn every caller red before the key exists.
A caller must pass `secrets: inherit` (or the key by name) for it to arrive at all.
1Password service-account token, scoped to the CI vault. The one credential GitHub holds:
every other secret this workflow needs is named by an `op://` reference below and fetched
at run time, so rotating one is an edit in 1Password and nothing here changes.
Optional -- without it the scan is skipped with a warning rather than failing, so adding a
job that needs a credential cannot redden every caller before the credential exists.
A caller must pass `secrets: inherit` for it to arrive at all.
required: false

jobs:
Expand Down Expand Up @@ -83,18 +86,30 @@ jobs:
# Failing closed is right for a FINDING -- a leaked credential must stop the build -- and
# wrong for a missing setting, which would paint every caller red for a reason none of them
# introduced. Same shape as simtabi/repo-templates' Refresh Bot credentials gate.
- name: Is the scanner configured?
- name: Is 1Password reachable?
id: creds
env:
HAS_KEY: ${{ secrets.GITGUARDIAN_API_KEY != '' }}
HAS_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN != '' }}
run: |
if [ "${HAS_KEY}" = true ]; then
if [ "${HAS_TOKEN}" = true ]; then
echo "ready=true" >> "$GITHUB_OUTPUT"
else
echo "::warning title=ggshield not configured::No GITGUARDIAN_API_KEY reached this workflow, so no secret scan ran. Add it as an org secret and have the caller pass secrets: inherit."
echo "::warning title=secret scan skipped::No OP_SERVICE_ACCOUNT_TOKEN reached this workflow, so ggshield did not run. Set it as an org secret and have the caller pass secrets: inherit."
echo "ready=false" >> "$GITHUB_OUTPUT"
fi

# The op:// reference is a location, not a value, so it belongs here in plain text: it
# documents what the job needs, and rotating the credential behind it changes nothing in
# this file. GITGUARDIAN_API_KEY is exported into the job's environment for the next step.
- name: Load secrets from 1Password
if: steps.creds.outputs.ready == 'true'
uses: 1password/load-secrets-action@70062d7a876d3eb6334754fa26efd2fbd90c32f2 # v5.0.1
with:
export-env: true
env:
OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.OP_SERVICE_ACCOUNT_TOKEN }}
GITGUARDIAN_API_KEY: op://CI/GitGuardian/credential

- name: ggshield secret scan
if: steps.creds.outputs.ready == 'true'
uses: GitGuardian/ggshield-action@5cc1ed2be3e8bf625d354c7170731880670f74de # v1.56.1
Expand All @@ -103,4 +118,3 @@ jobs:
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 }}
Loading