Files
smirk-backend-core/tools/secret-scan.sh
T
jwinterm 54fe344d14 security: scanner covers nsec/pepper classes; ignore bare-hex key files; PRIVACY.md
- tools/secret-scan.sh now also flags nsec1 Nostr secret keys and
  *_PEPPER/*_SALT/*INTEGRITY_SECRET hex assignments, the secret classes
  this backend actually handles (previously only PEM/seed shapes).
- .gitignore: *.hex + admin-key* so an operator running inside the
  checkout cannot commit the raw admin key (create-admin-wallet --out).
- PRIVACY.md pointing to the canonical smirk.cash/privacy, framed for
  self-hosting operators as independent data controllers.
2026-07-19 15:52:07 -04:00

43 lines
1.6 KiB
Bash
Executable File

#!/usr/bin/env bash
#
# secret-scan: block private keys and seed material from entering the tree.
#
# Public-safe by design: it matches on secret *shapes* (key blocks, mnemonic
# markers), never on project-internal names. gitleaks runs alongside it in CI
# for broad token/credential patterns.
#
# ./tools/secret-scan.sh
#
set -uo pipefail
cd "$(dirname "$0")/.."
if git rev-parse --is-inside-work-tree >/dev/null 2>&1 && [ -n "$(git ls-files)" ]; then
mapfile -t FILES < <(git ls-files)
else
mapfile -t FILES < <(find . -type f -not -path './.git/*' -not -path './target/*' -printf '%P\n')
fi
# Secret shapes (not names), covering the classes this backend actually handles:
# - PEM/OpenSSH/PGP private-key blocks and seed-phrase markers
# - nsec1... Nostr SECRET keys (bech32)
# - a *_PEPPER / *_SALT (or admin key/secret) assigned a 32+ hex-char value, i.e.
# an `openssl rand -hex 32` peppered secret pasted in cleartext
PATTERNS='(-----BEGIN ([A-Z ]+ )?PRIVATE KEY-----|-----BEGIN PGP PRIVATE KEY|BEGIN OPENSSH PRIVATE KEY|\b(mnemonic|seed[_ ]?phrase)\b\s*[:=]|nsec1[0-9a-z]{20,}|\b[A-Z_]*(PEPPER|SALT|INTEGRITY_SECRET)[A-Z_]*\s*=\s*[0-9a-fA-F]{32,})'
fail=0
for f in "${FILES[@]}"; do
[ -f "$f" ] || continue
case "$f" in tools/secret-scan.sh) continue ;; esac
if grep -EnI "$PATTERNS" "$f" >/dev/null 2>&1; then
echo "SECRET-SCAN: possible key/seed material in $f"
grep -EnI "$PATTERNS" "$f" | sed 's/^/ /'
fail=1
fi
done
if [ "$fail" -ne 0 ]; then
echo "SECRET-SCAN FAILED — remove key/seed material before committing."
exit 1
fi
echo "secret-scan OK (${#FILES[@]} files checked)."