Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
feat(installation): Implement checksum signature verification (#2157)
Shubham Hibaref37f2eff68c3
diff --git a/README.md b/README.mdindex 19d9b030e..8507980d9 100644--- a/README.md+++ b/README.md@@ -65,6 +65,10 @@ cd trufflehog; go install# Using installation scriptcurl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin++# Using installation script, verify checksum signature (requires cosign to be installed)+curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -v -b /usr/local/bin+# Using installation script to install a specific versioncurl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin <ReleaseTag like v3.56.0>```@@ -103,6 +107,9 @@ Verification steps are as follow:Replace `{version}` with the downloaded files version+Alternatively, if you are using installation script, pass `-v` option to perform signature verification.+This required Cosign binary to be installed prior to running installation script.+# :rocket: Quick Start## 1: Scan a repo for only verified secretsdiff --git a/scripts/install.sh b/scripts/install.shindex 97d6ddc7e..98fc55721 100755--- a/scripts/install.sh+++ b/scripts/install.sh@@ -9,6 +9,7 @@ $this: download go binaries for trufflesecurity/trufflehogUsage: $this [-b] bindir [-d] [tag]-b sets bindir or installation directory, Defaults to ./bin-d turns on debug logging+ -v verify checksum signature. Require cosign binary to be installed.[tag] is a tag fromhttps://github.com/trufflesecurity/trufflehog/releasesIf tag is missing, then the latest will be used.@@ -22,10 +23,11 @@ parse_args() {# over-ridden by flag belowBINDIR=${BINDIR:-./bin}- while getopts "b:dh?x" arg; do+ while getopts "b:dvh?x" arg; docase "$arg" inb) BINDIR="$OPTARG" ;;d) log_set_priority 10 ;;+ v) VERIFY_SIGN=true;;h | \?) usage "$0" ;;x) set -x ;;esac@@ -41,8 +43,15 @@ parse_args() {execute() {tmpdir=$(mktemp -d)log_debug "downloading files into ${tmpdir}"- http_download "${tmpdir}/${TARBALL}" "${TARBALL_URL}"http_download "${tmpdir}/${CHECKSUM}" "${CHECKSUM_URL}"++ if [ "$VERIFY_SIGN" = true ]; then+ http_download "${tmpdir}/${CHECKSUM}.${CERT_FORMAT}" "${CHECKSUM_URL}.${CERT_FORMAT}"+ http_download "${tmpdir}/${CHECKSUM}.${SIG_FORMAT}" "${CHECKSUM_URL}.${SIG_FORMAT}"+ verify_sign "${tmpdir}/${CHECKSUM}" "${tmpdir}/${CHECKSUM}.${CERT_FORMAT}" "${tmpdir}/${CHECKSUM}.${SIG_FORMAT}"+ fi++ http_download "${tmpdir}/${TARBALL}" "${TARBALL_URL}"hash_sha256_verify "${tmpdir}/${TARBALL}" "${tmpdir}/${CHECKSUM}"srcdir="${tmpdir}"(cd "${tmpdir}" && untar "${TARBALL}")@@ -326,6 +335,24 @@ hash_sha256_verify() {fi}+check_cosign_bin() {+ if [ "$VERIFY_SIGN" = true ]; then+ if [ ! -x "$(command -v "$COSIGN_BINARY")" ]; then+ log_err "Cosign binary is not installed. Follow steps from https://docs.sigstore.dev/system_config/installation/ to install it."+ return 1+ fi+ fi+}++verify_sign() {+ log_debug "Verifying artifact $1"+ ${COSIGN_BINARY} verify-blob "$1" \+ --certificate "$2" \+ --signature "$3" \+ --certificate-identity-regexp "https://github\.com/${OWNER}/${REPO}/\.github/workflows/.+" \+ --certificate-oidc-issuer "https://token.actions.githubusercontent.com"+}+cat /dev/null <<EOF------------------------------------------------------------------------End of functions from https://github.com/client9/shlib@@ -341,6 +368,10 @@ ARCH=$(uname_arch)PREFIX="$OWNER/$REPO"PLATFORM="${OS}/${ARCH}"GITHUB_DOWNLOAD=https://github.com/${OWNER}/${REPO}/releases/download+COSIGN_BINARY=cosign+VERIFY_SIGN=false+CERT_FORMAT=pem+SIG_FORMAT=sig# use in logging routineslog_prefix() {@@ -353,6 +384,8 @@ uname_arch_check "$ARCH"parse_args "$@"+check_cosign_bin+get_binarytag_to_version