Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
feat(signing): Sign checksum (#1894)
Shubham Hibare11df3dc747a1
diff --git a/.github/workflows/release.yml b/.github/workflows/release.ymlindex 61be8d5ad..bbfd6be35 100644--- a/.github/workflows/release.yml+++ b/.github/workflows/release.yml@@ -8,6 +8,7 @@ on:permissions:contents: writepackages: write+ id-token: writejobs:Release:@@ -36,6 +37,8 @@ jobs:uses: actions/setup-go@v4with:go-version: '1.21'+ - name: Cosign install+ uses: sigstore/cosign-installer@11086d25041f77fe8fe7b9ea4e48e3b9192b8f19 #v3.1.2- name: Run GoReleaseruses: goreleaser/goreleaser-action@v5with:diff --git a/.goreleaser.yml b/.goreleaser.ymlindex fdd8d3153..6fe74c284 100644--- a/.goreleaser.yml+++ b/.goreleaser.yml@@ -96,3 +96,15 @@ brews:homepage: "https://github.com/trufflesecurity/trufflehog"install: |bin.install "trufflehog"+signs:+ - cmd: cosign+ signature: "${artifact}.sig"+ certificate: "${artifact}.pem"+ args:+ - "sign-blob"+ - "--oidc-issuer=https://token.actions.githubusercontent.com"+ - "--output-certificate=${certificate}"+ - "--output-signature=${signature}"+ - "${artifact}"+ - "--yes"+ artifacts: checksum\ No newline at end of filediff --git a/README.md b/README.mdindex 11cab8baa..2dc35aa21 100644--- a/README.md+++ b/README.md@@ -69,6 +69,40 @@ curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scrcurl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin <ReleaseTag like v3.56.0>```+# :closed_lock_with_key: Verifying the artifacts++Checksums are applied to all artifacts, and the resulting checksum file is signed using cosign.++You need the following tool to verify signature:++- [Cosign](https://docs.sigstore.dev/cosign/installation/)++Verification steps are as follow:++1. Download the artifact files you want, and the following files from the [releases](https://github.com/trufflesecurity/trufflehog/releases) page.++ - trufflehog\_{version}\_checksums.txt+ - trufflehog\_{version}\_checksums.txt.pem+ - trufflehog\_{version}\_checksums.txt.sig++2. Verify the signature:++ ```shell+ cosign verify-blob <path to trufflehog_{version}_checksums.txt> \+ --certificate <path to trufflehog_{version}_checksums.txt.pem> \+ --signature <path to trufflehog_{version}_checksums.txt.sig> \+ --certificate-identity-regexp 'https://github\.com/trufflesecurity/trufflehog/\.github/workflows/.+' \+ --certificate-oidc-issuer "https://token.actions.githubusercontent.com"+ ```++3. Once the signature is confirmed as valid, you can proceed to validate that the SHA256 sums align with the downloaded artifact:++ ```shell+ sha256sum --ignore-missing -c trufflehog_{version}_checksums.txt+ ```++Replace `{version}` with the downloaded files version+# :rocket: Quick Start## 1: Scan a repo for only verified secrets