Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3,562 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

keyhog - secret scanner - 923 detectors - gpu

latest release  MIT OR Apache-2.0  CI  GitHub stars and repository-owned star history

Part of Santh  ·  blog  ·  @SanthProject


KeyHog: Rust secret scanner

keyhog scans source trees, git history, Docker images, GitHub/GitLab/Bitbucket repository collections, S3/GCS/Azure Blob buckets, and running systems for leaked credentials. 923 embedded detectors, decode-through (base64/hex/url/protobuf), confidence scoring, and SARIF output without hand-written runtime configuration. After verified-install calibration, keyhog scan . works with the canonical defaults; a source-built multi-backend binary first runs keyhog calibrate-autoroute.

The binary banner is v0.5.49 · secret scanner · 923 detectors; its compiled progress line reports 923 detectors (5822 patterns) together with the operator-visible route (for example, backend=simd-regex | gpu=none).

keyhog scan: boxed findings with severity, confidence, file:line, and remediation, then a results summary and an honest coverage-gap line

Get started

Install and run your first scan

On Linux or macOS:

curl -fsSL https://santh.dev/keyhog/install.sh | sh
keyhog scan .

On Windows PowerShell:

iwr https://santh.dev/keyhog/install.ps1 -UseBasicParsing | iex
keyhog scan .

KeyHog exits 0 when the scan is clean and 1 when it reports findings above your severity floor. Exit 1 means the scanner worked. Review each finding's file, line, detector, and remediation before deciding whether to remove, rotate, or suppress the credential. Other nonzero codes describe input, system, verification, or coverage failures; see the exit-code reference.

For the next scan, use the recipes cookbook or the copyable commands in Choose the right workflow. You can scan Git history, container images, cloud buckets, repository collections, URLs, and a whole machine without changing tools.

Add it to GitHub Actions

Create .github/workflows/keyhog.yml:

name: keyhog
on:
  push:
    branches: [main]
  pull_request:
permissions:
  contents: read
  security-events: write
jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: santhreal/keyhog@v0
        with:
          path: .
          severity: high

The Action scans the checked-out tree, fails on findings at high or critical, uploads SARIF to Code Scanning, and retains the report as a workflow artifact. Installation, coverage, backend, and report-publication failures also fail the job.

Use the GitHub Action guide for inputs, outputs, baseline adoption, monorepo partitions, verification, and failure behavior. Use the CI guide for GitLab, CircleCI, Jenkins, Buildkite, and generic shell jobs. Use the mass-scanning guide for repository organizations, hosted Git groups, cloud buckets, and partitioned inventories.

Choose the right workflow

Choose the source boundary first. A preset changes detection work, while a backend changes execution. Neither one expands a working-tree scan into Git history, a provider inventory, cloud storage, or a host audit.

There is no honest scan everything shortcut. A complete estate review runs the relevant boundaries below as separate jobs and retains each json-envelope report with its raw exit code.

Need Start with Throughput and reuse Coverage boundary
Quick local feedback keyhog scan . --fast --incremental Reuses unchanged-file hashes. The fast preset skips decode, entropy, and ML work. Run the default policy before merge because fast is intentionally narrower.
Full repository scan keyhog scan . Calibrated auto and the CPU-core worker default. Add --incremental for repeated scans of the same trusted tree. Current files only. It does not add Git history.
Staged commit gate keyhog scan --git-staged or keyhog hook install Reads exact index blobs, so unstaged edits cannot change the result. Staged content only. Run a working-tree scan separately when local unstaged bytes matter.
GitHub pull-request gate santhreal/keyhog@v0 The Action installs, scans, publishes SARIF and an artifact, then preserves KeyHog's status. One checked-out path. Use provider inventory scanning for an organization.
GitLab, Jenkins, Buildkite, or shell CI keyhog scan . --format json-envelope --output keyhog.json Persist the report and exit code on success, findings, and errors. Use --git-diff <base> only for an explicitly narrower changed-line gate. The bytes present in the checkout, or the selected diff.
Adopt a repository with known findings Create .keyhog-baseline.json, commit it, then scan with --baseline .keyhog-baseline.json. Existing identities remain visible in the baseline while only new findings fail the gate. A baseline does not suppress changed credentials or incomplete coverage.
Recursive Git recovery keyhog scan --deep --git-history . --git-blobs . --daemon=off Calibrate the deep policy once per worker class. Run in process. Reachable additions and blobs in one repository. It does not scan deleted unreachable objects or other repositories.
Container or archive inspection keyhog scan --docker-image registry/app:v1 or keyhog scan incoming/ Keep an envelope report so skipped, corrupt, encrypted, unsafe, or oversized members remain visible. Only the selected image or filesystem path and supported nested formats.
URL, response, or HAR inspection keyhog scan --url https://api.example.com/config or keyhog scan capture.har Use bounded source limits and preserve the terminal envelope. Only fetched responses or capture entries. This is not a crawler.
Organization or cloud inventory keyhog scan --daemon=off --github-org acme --format json-envelope --output acme.json Partition by provider, owner, or bucket. Run independent partitions concurrently with one report and status each. One selected provider inventory per job. Pagination or object limits remain coverage boundaries.
Confirm whether eligible findings are live keyhog scan . --verify Provider concurrency and rate controls are separate from scanner workers. Sends credential-derived requests to declared provider endpoints. Not every detector supports verification.
Whole-host health scan sudo keyhog scan-system --space 50G Uses all CPU cores by default and scans discovered Git history after filesystem data. Local mounted filesystems. Network mounts are opt-in and the space ceiling is hard.
GPU-backed directory, history, archive, remote, or cloud inventory on Unix Calibrate autoroute, start keyhog daemon start --mass, then run keyhog scan --daemon=mass <SOURCE>. Streams bounded batches through one compiled CPU, Hyperscan, CUDA, Metal, or WGPU worker. The terminal receipt reports exact total and GPU batches, chunks, bytes, GPU share, and throughput. Baselines, incremental state, verification, lockdown, presets, overlays, and other scanner-policy changes are rejected before acquisition.

Scan every supported source boundary

Use one command per boundary. Keep a json-envelope report and the raw exit status for each inventory partition.

Source or use case Command
Several local roots keyhog scan services/api services/web deploy/
Continuously changed files keyhog watch services/api deploy/
Staged bytes, changed lines, reachable history, or blobs keyhog scan --git-staged, --git-diff main, --git-history ., or --git-blobs .
Native binaries and firmware strings keyhog scan --binary firmware.bin
Archives and compressed sources keyhog scan incoming/ (supported members expand automatically)
Docker image layers keyhog scan --docker-image registry/app:v1
JavaScript, source maps, WASM, or an endpoint response keyhog scan --url https://api.example.com/config
HTTP request and response captures keyhog scan capture.har
GitHub issues, pull requests, discussions, wikis, and gists keyhog scan --github-collaboration owner/repo --github-issues --github-pull-requests --github-discussions --github-wiki --github-gists
GitHub, GitLab, or Bitbucket inventories --github-org ORG, --gitlab-group GROUP, or --bitbucket-workspace WORKSPACE
S3, GCS, or Azure Blob inventories --s3-bucket BUCKET, --gcs-bucket BUCKET, or --azure-container-url URL
A bounded stream from another tool `producer

Endpoint fetching is bounded and SSRF-screened. It is not a crawler. Private cloud endpoints and credential forwarding require their explicit trust flags. Provider tokens belong in the documented environment variables, not process arguments.

Use the workflow chooser for source and policy details, the GitHub Action guide for the maintained repository gate, the direct CI guide for durable reports and exit handling, and the mass-scanning guide for partitioning and aggregation. The recipes cookbook covers containers, archives, URLs, GitHub collaboration content, and cloud sources.

Speed and concurrency without guesswork

Start with the defaults. A verified installation calibrates every policy for the current host, binary, detector corpus, and workload classes. Recalibrate after any of those identities changes:

keyhog calibrate-autoroute --policy all
keyhog backend --autoroute --json
Control Use it for Keep this invariant
Calibrated --backend auto Routine CPU, Hyperscan, or GPU selection. An explicit backend is a diagnostic override, not a faster default.
--threads <N> Reserving CPU capacity on a shared runner. Dedicated hosts should normally leave it unset so KeyHog uses the available cores. Every value must be positive. Several concurrent KeyHog processes each own a worker pool, so divide the host budget across partitions.
--reader-threads <N> Measured storage pipelines where reader work, not scanning, is the bottleneck. The default derives from the scan worker pool. Leave it unset until profiling shows a reader bottleneck.
--incremental and --incremental-cache <PATH> Repeated scans of the same trusted tree. Do not share one index across unrelated repositories or untrusted jobs.
Provider or repository partitions Concurrent estate scanning and independent retries. Preserve one terminal envelope and raw exit code per partition. Do not concatenate findings and discard coverage state.
--verify-concurrency, --verify-rate, and --verify-batch Bounding live provider checks independently of file scanning. Verification sends credential-derived requests. Provider rate limits, not CPU count, own this concurrency.
Mass daemon TB-scale directory, history, archive, remote, or cloud streams on one Unix worker. Each frame is limited to 8 MiB and 1,024 chunks. The daemon serializes fragment state and returns an exact CPU/GPU execution receipt.
--fast, default, --deep, or --precision Selecting an explicit detection-cost and recall policy. These presets are mutually exclusive and change coverage. They are not interchangeable speed knobs.

Inspect the resolved policy with keyhog config --effective. Use --profile to measure scanner phases before changing reader, batch, or channel-depth controls. Keep advanced pipeline controls unset unless a reproducible measurement on the target worker shows an improvement.

For a recurring full repository scan:

keyhog scan . --incremental \
  --format json-envelope --output keyhog.json

For a shared runner where the job is allocated four scanner workers and one reader worker:

keyhog scan . --threads 4 --reader-threads 1 \
  --format json-envelope --output keyhog.json

The second command is a resource budget, not a universal optimum. Measure the target host before choosing explicit worker counts.

For deep recovery and system-wide triage, use their dedicated guides because their coverage and completion rules differ from a normal repository scan.

Secret scanner benchmarks

These panels compare detection policy, CPU and GPU execution requests, incremental cache behavior, and warm daemon requests. Every value is generated from the checked benchmark snapshot. The snapshot binds the scanner version, executable digest, detector digest, corpus, host, and run timestamp. Use the full benchmark evidence for competitor provenance and per-category recall.

Detection accuracy

KeyHog KeyHog v0.5.49 scanned the mirror corpus: 15,000 fixtures, 3,000 labeled positives, and 2,430,321 input bytes. The answer-key manifest was excluded from the scan tree. The row uses the default policy on the explicit Hyperscan/SIMD route on AMD Ryzen 9 9950X 16-Core Processor.

Precision Recall F1 True positives False positives False negatives
0.9708 0.9200 0.9447 2,760 83 240

Documentation changes were uncommitted; the measured KeyHog v0.5.49 executable and detector digests were identical across every row. Treat these as development-host configuration comparisons, not release routing evidence.

Execution routes, presets, and cache

Measured on AMD Ryzen 9 9950X 16-Core Processor with NVIDIA GeForce RTX 5090, 32 logical cores, 15,000 fixtures, 3,000 labeled positives, and 2,430,321 input bytes. Scanner: KeyHog v0.5.49. Documentation changes were uncommitted; the measured KeyHog v0.5.49 executable and detector digests were identical across every row. Treat these as development-host configuration comparisons, not release routing evidence.

Full scan by execution route

All rows use the default detection policy with incremental cache and daemon off. The automatic row records the requested policy, but the benchmark result does not bind the selected persisted route, so it is not routing proof. GPU rows include acquisition and full scanner startup on this small corpus; they are not GPU kernel crossover measurements.

Requested route Wall Throughput Peak RSS F1
Hyperscan/SIMD 1.00 s 2.32 MB/s 1028 MiB 0.9447
Pure-Rust CPU 2.10 s 1.10 MB/s 1069 MiB 0.9447
CUDA 11.35 s 0.20 MB/s 1758 MiB 0.9447
WGPU 11.44 s 0.20 MB/s 1664 MiB 0.9447
Automatic 2.32 s 1.00 MB/s 1166 MiB 0.9447

Detection policy on Hyperscan/SIMD

The route, cache, daemon state, corpus, and host remain fixed. Presets change detection work, so compare precision and recall as well as time.

Policy Wall Precision Recall F1 Findings
Fast 936 ms 0.9733 0.9113 0.9413 2,816
Default 1.00 s 0.9708 0.9200 0.9447 2,868
Deep 970 ms 0.9708 0.9207 0.9451 2,875
Precision 933 ms 0.9690 0.8033 0.8784 2,488

Incremental warm rerun

The benchmark populates the BLAKE3 Merkle index, then times the second identical scan. The small synthetic tree changes little because scanner startup dominates; measure your repository before claiming a speedup.

Hyperscan/SIMD default policy Wall Throughput Peak RSS
Cache off 1.00 s 2.32 MB/s 1028 MiB
Warm incremental cache 977 ms 2.37 MB/s 1082 MiB

Warm daemon requests

One deterministic 8 MiB regular file (sha256:afafbe7b6487fd62866f510e7c281a9e7bfeaa8dc585d7b0478c92ee6c4f5ef5) was scanned once in process and once through an owned daemon after one warmup request. Daemon time is the client request; daemon RSS belongs to the resident server.

Explicit route In process Warm daemon Warm / one-shot In-process RSS Daemon RSS
Hyperscan/SIMD 488 ms 214 ms 0.44× 733 MiB 769 MiB
Pure-Rust CPU 1.60 s 155 ms 0.10× 739 MiB 779 MiB
CUDA 1.43 s 220 ms 0.15× 1141 MiB 1160 MiB
WGPU 1.33 s 214 ms 0.16× 1090 MiB 1109 MiB

The daemon is not a general directory or CI accelerator. It accepts only eligible single-file and bounded-stdin requests on Unix, and it serializes execution.

CPU, reader, storage, size, and partition scaling

Generated by make -C benchmarks readme-scaling from benchmarks/reports/readme-scaling.json. The harness ran 3 measured trials after 1 warm-up with explicit simd and daemon routing off. Worker scaling uses a warm client page cache to isolate CPU work. Reader, corpus-size, storage, and partition rows request clean-page eviction with posix_fadvise where the platform supports it; the snapshot records the policy on every row. Every workload is byte-deterministic and finding-free.

Host: AMD Ryzen 9 9950X 16-Core Processor, 32 effective logical cores, 94,140 MiB RAM, Linux 6.17.0-19-generic. Evidence: developer-dirty, binary 0944d11ac221.

Scan worker scaling

Workers Reader threads Median wall p95 wall Throughput Speedup Efficiency Median peak RSS
1 auto 17,828.3 ms 18,163.3 ms 3.6 MiB/s 1.00x 100.0% 662.6 MiB
2 auto 9,135.0 ms 9,167.1 ms 7.0 MiB/s 1.95x 97.6% 670.3 MiB
4 auto 4,788.6 ms 4,799.2 ms 13.4 MiB/s 3.72x 93.1% 683.5 MiB
8 auto 2,653.0 ms 2,675.9 ms 24.1 MiB/s 6.72x 84.0% 714.5 MiB
16 auto 1,651.9 ms 1,740.5 ms 38.7 MiB/s 10.79x 67.5% 770.3 MiB
32 auto 1,359.2 ms 1,359.3 ms 47.1 MiB/s 13.12x 41.0% 822.9 MiB

Filesystem reader scaling

Scan workers Reader threads Median wall p95 wall Throughput Relative to 1 reader Median peak RSS
32 1 1,493.8 ms 1,507.9 ms 42.8 MiB/s 1.00x 806.8 MiB
32 2 1,442.7 ms 1,459.0 ms 44.4 MiB/s 1.04x 820.5 MiB
32 4 1,433.7 ms 1,510.4 ms 44.6 MiB/s 1.04x 819.0 MiB
32 8 1,455.0 ms 1,505.8 ms 44.0 MiB/s 1.03x 819.3 MiB
32 16 1,446.6 ms 1,464.6 ms 44.2 MiB/s 1.03x 824.9 MiB
32 32 1,420.7 ms 1,486.1 ms 45.0 MiB/s 1.05x 821.9 MiB

Corpus-size scaling

Corpus Files Exact bytes Median wall p95 wall Throughput Median peak RSS
small 256 8 MiB 547.5 ms 548.2 ms 14.6 MiB/s 753.3 MiB
medium 1,024 64 MiB 1,456.1 ms 1,471.3 ms 44.0 MiB/s 817.0 MiB
large 2,048 256 MiB 4,476.6 ms 4,677.0 ms 57.2 MiB/s 941.7 MiB

Storage scaling

Storage class Filesystem Device ID Median wall p95 wall Throughput Relative to first storage Median peak RSS
workspace ext4 66305 1,463.5 ms 1,468.2 ms 43.7 MiB/s 1.00x 820.2 MiB
local-temp ext4 66308 1,459.8 ms 1,468.8 ms 43.8 MiB/s 1.00x 825.3 MiB

Concurrent partition scaling

Processes Workers per process Aggregate workers Total files Total bytes Median wall Aggregate throughput Speedup Median summed peak RSS
1 32 32 256 8 MiB 562.0 ms 14.2 MiB/s 1.00x 760.8 MiB
2 16 32 512 16 MiB 737.6 ms 21.7 MiB/s 1.52x 1,436.3 MiB
4 8 32 1,024 32 MiB 1,067.6 ms 30.0 MiB/s 2.11x 2,735.5 MiB

These rows are measurements, not universal tuning constants. Run the generator on the target host and storage. Use the knee where throughput stops improving, then reserve CPU and memory for the CI runner or orchestration layer.

Reproduce all four benchmark groups with make -C benchmarks readme-matrix. The command measures the required matrix and fails if any requested CPU, Hyperscan, CUDA, Metal, WGPU, preset, cache, daemon, thread, reader, storage, corpus size, or partition row is unavailable. Use make -C benchmarks readme-matrix-check to verify that both snapshots, reports, and README agree.

Choose a scan configuration

Start with the default policy and calibrated automatic routing. Change one axis only when the workflow requires it:

Workflow Detection policy Execution and reuse Additional control
First repository scan Default Calibrated auto; --daemon=auto Review all findings before adding suppressions.
Repeated local tree or CI scan Default Calibrated auto; --incremental Persist the incremental cache only between scans of the same trusted tree.
Short feedback loop --fast Calibrated auto; optional --incremental Accept reduced decode, entropy, and ML coverage. Run the default policy before merge.
Highest-recall recovery --deep In process Deep is mutually exclusive with fast and precision, and is not daemon eligible.
Lower-noise large inventory --precision In process for repository collections, history, and cloud sources The preset raises confidence floors and disables entropy discovery. It can miss lower-confidence credentials.
TB-scale directory, history, archive, remote, or cloud inventory on Unix Default keyhog daemon start --mass, then --daemon=mass Batches stay bounded at 8 MiB and 1,024 chunks. Preserve the terminal coverage report and GPU execution receipt.
Live credential validation Default In process Add --verify explicitly. Verification sends credential-derived requests to providers.
Linux no-swap scan Default plus --lockdown In process; incremental cache disabled Lockdown refuses verification, plaintext secrets, fast mode, and completeness-reducing switches.

--fast, --deep, and --precision are mutually exclusive detection presets. --lockdown is a fail-closed execution mode, not a fourth preset. Explicit --backend values are diagnostics and benchmark overrides. They do not replace the persisted fastest-correct evidence used by automatic routing. See Configuration, autoroute calibration, daemon and warm scans, and hardening for the full contracts.

How KeyHog works

KeyHog compiles its 923 detectors into a shared trigger/extraction plan, uses Hyperscan when that feature is present, decodes nested encodings before matching, and can apply explicit per-detector Bayesian Beta(α,β) confidence calibration. Hardware acceleration is an explicit backend selection layer; every selected backend must preserve the same detector ids and findings contract:

Layer / Backend When How
simdsieve prefilter AVX-512 / AVX2 / NEON Layer 1: skims every file for 12 high-value literal prefixes in one SIMD pass: AWS AKIA/ASIA, GitHub ghp_, OpenAI sk-proj-, Slack xoxb-/xoxp-, SendGrid SG., Square sq0csp-, and Stripe sk_live_/sk_test_/rk_live_/rk_test_
gpu-cuda-region-presence executable CUDA peer + persisted calibration proof VYRE literal-set region-presence through CUDA, followed by the shared CPU validation tail
gpu-metal-region-presence executable native Metal peer + persisted calibration proof VYRE literal-set region-presence through Metal, followed by the shared CPU validation tail
gpu-wgpu-region-presence executable WGPU peer + persisted calibration proof VYRE literal-set region-presence through WGPU, followed by the shared CPU validation tail
simd-regex Hyperscan compiled and live parallel Hyperscan trigger scan plus full-regex extraction; portable builds do not expose this backend and report cpu-fallback instead
cpu-fallback portable build or explicit CPU selection Aho-Corasick prefix + Rust regex extraction

Autoroute

KeyHog autoroute measures every eligible backend with phase-two localization on and off, then persists the fastest parity-checked route for the exact binary, host, resolved policy, and workload class. It is not a hardware heuristic or fallback hierarchy. A missing, stale, invalid, or quarantined decision is never called autoroute: KeyHog warns, scans every byte through the scalar correctness oracle, and reports complete_after_recovery with the recalibration command.

Install performs the visible calibration. To recalibrate an installed binary, run keyhog calibrate-autoroute; inspect evidence with keyhog backend --autoroute. Explicit --backend values are diagnostic and benchmark overrides, not autoroute proof. Single-backend portable builds do not need a routing cache.

If an automatically selected accelerated backend faults, KeyHog warns and replays the same stable input through the fastest remaining measured-correct peer. GPU recovery retains completed shards and scans only exact unprocessed ranges. KeyHog reports complete_after_recovery. The affected workload route is quarantined in a bounded runtime-health artifact separate from calibration timings, so a restart cannot retry it. Successful recalibration clears only the repaired workload identities. Explicit or required backends remain hard contracts and are never substituted.

The complete parity contract, workload identity, GPU/Hyperscan behavior, daemon semantics, cache lifecycle, and troubleshooting matrix live in the autoroute reference.

Full documentation: santhreal.github.io/keyhog - install, first scan, output formats, detection internals, suppressions, verification, pre-commit + CI integration, CLI reference, autoroute, exit codes, env vars, and contributing. Source under docs/.


Install, verify, and maintain KeyHog

The stable installer endpoints select the current release for your platform:

curl -fsSL https://santh.dev/keyhog/install.sh | sh
iwr https://santh.dev/keyhog/install.ps1 -UseBasicParsing | iex

Installers authenticate release assets before replacing a binary. Linux x86_64 statically links Hyperscan. macOS release assets enable native Metal and WGPU without requiring Homebrew Vectorscan. Windows assets are portable no-system-library builds. The current matrix includes macOS x86_64 and arm64 and Windows x86_64. Linux and Windows arm64 release assets are not produced.

Verify and maintain the installed binary:

keyhog --version --full
keyhog doctor
keyhog update --check
keyhog update

Use the install guide for prerequisites, pinned installer authentication, offline installation, source builds, repair, uninstall, and exact platform support. The release page contains checksums, signatures, SBOMs, and platform archives.

What it catches

923 embedded detectors with detector-owned offline validation and companions:

  • Cloud providers: AWS (access key + secret + STS verification), Azure (subscription key, storage account key, SAS), GCP (service account, API key), Cloudflare, Heroku, Vercel, Supabase.
  • Payment processors: Stripe, Braintree, Razorpay, Paddle, Plaid, Square, and PayPal, with detector-owned checks and optional or required companions. A Razorpay key secret requires its nearby key ID.
  • Source forges: GitHub PATs (with CRC32 checksum), GitLab tokens, Bitbucket app passwords, npm tokens (with checksum), Gitea / Forgejo / Codeberg.
  • Auth / SSO: Okta, Auth0, Clerk, JumpCloud, Kinde.
  • Comms: Slack, Discord, Twilio, SendGrid, Postmark, Mailgun, Resend, Loops.
  • AI / ML: OpenAI (sk-/sk-proj-), Anthropic, Google AI Studio, Cohere, Mistral, HuggingFace, Replicate. HuggingFace organization credentials include both the current hf_ form and legacy api_org_ tokens.
  • Password managers: 1Password account secret keys (A3- followed by five or six segmented uppercase alpha-numeric components).
  • Databases: Postgres connection strings, MongoDB Atlas, Supabase service-role, PlanetScale, Neon, Turso, MySQL, Redis URLs.
  • Generic + entropy discovery: API_KEY=<high-entropy-blob> catches credentials with no named detector, gated by per-context entropy thresholds + ML scoring.
  • Cryptographic material: RSA / EC / SSH private keys, PGP private blocks, JWT signing secrets.

Each detector ships as a TOML file (data, not code): service metadata, regex patterns, keywords, offline validators, entropy and ML policy, companion fields, and verification handler. Adding a new detector is a single reviewable TOML change; the contributor guide walks through it.

keyhog explain <id> dumps any detector's full spec: patterns, keywords, verification endpoint, plus a service-keyed rotation and step-by-step remediation guide, so a finding is never a black box:

keyhog explain github-classic-pat: detector spec dump (pattern ghp_[A-Za-z0-9]{36}, keyword, verification URL) followed by the github rotation guide and step-by-step remediation

Browse detector authoring and inspection in the detector reference, or query the installed corpus with keyhog detectors --search <term> --verbose.

Why higher recall, fewer false positives

  • Decode-through scanning. Kubernetes Secret manifests, Jupyter notebooks, JWT payloads, base64-wrapped envs, Helm values, and docker-config auth: blobs. The structured preprocessor treats balanced Helm actions as inert render-time values and closes missing Jupyter delimiters at end of file, so literal bytes and complete code cells remain covered. It decodes structured values in place and feeds every downstream detector the plaintext. Detectors do not each need to re-implement decoding. Decode-enabled scans also recover side-effect-free JavaScript byte-array XOR and AES-256-CBC expressions when all recovery material is embedded, including strict CryptoJS/OpenSSL salted passphrase wrappers. KeyHog never executes the source.
  • Multiline reassembly. "sk-proj-" + \ continuation in JavaScript, YAML multi-line strings, Makefile backslash-continuation, Helm / Jinja templated outputs, all reassembled before regex matching.
  • Companion validation. Required companions gate high-noise detectors. A Twilio API key without its API secret is skipped. Optional companions enrich confidence or verification. AWS access-key detection does not require its secret, but the secret is needed for live verification.
  • Confidence scoring. Every finding carries a [0.0, 1.0] score derived from Shannon entropy, surrounding context, companion match, detector-owned offline proof (GitHub/npm CRC32 and PyPI payload decoding), structural evidence, and a small ML classifier (~30k params). Default threshold 0.40 (the canonical ScanConfig::default() floor; same as the --min-confidence default and the [scan].min_confidence example below) filters low-quality matches without hiding real secrets.
  • Bayesian per-detector calibration. keyhog calibrate --fp generic-api-key writes a Beta(α,β) posterior. Scans use it only when --calibration-cache or [system].calibration_cache points at that file, so confidence tuning is explicit and reproducible instead of depending on stray host cache state.

Performance

Use the reproducible harness in benchmarks/ to compare KeyHog, Betterleaks, Kingfisher, TruffleHog, and Titus under one scoring contract. The harness excludes the ground-truth manifest from every scan tree. The generated tables remain empty until current-schema runs exist. Run make -C benchmarks report after measurement. Do not edit generated tables by hand.

Detection leaderboard

Corpus: mirror - 15000 fixtures, 3000 labeled positives. Every scanner scored identically (SecretBench overlap rule); the answer-key manifest is excluded from the scan tree.

Rank Scanner F1 Precision Recall Findings Wall Peak RSS
1 KeyHog 0.9447 0.9708 0.9200 2868 1.01s 1044 MB
2 Kingfisher 0.4720 0.3912 0.5947 5241 4.44s 427 MB
3 Betterleaks 0.3585 0.2313 0.7967 10828 0.68s 200 MB

Result provenance

Scanner Scanner version / executable digest Corpus identity Host identity Run date
KeyHog version: KeyHog v0.5.49
Commit: 837275b7c520fa3cb94781ae88be7fb3c45549b1
Detector Set: 923 (923-8785f8837d2cd505)
Build Target: x86_64-linux
ML Model Version: moe-v1-246a05b92bec9aa3
ML Model Card: recorded 2026-07-15; features 55; synthetic F1 0.971 / P 0.945 / R 0.999; real F1 0.832 / P 0.753 / R 0.931 / recall@0.40 0.938; zero-recall detectors 2/32; six-scanner differential unavailable
executable SHA-256: 0944d11ac221b61f15a7f67f67cb1bc408430319284f4369af34adf7207d0cb0
mirror; 15,000 fixtures; 3,000 labeled positives; 2,430,321 bytes hostname SHA-256/12: 82fcd9288623
Linux 6.17.0-19-generic
AMD Ryzen 9 9950X 16-Core Processor
2026-07-31T15:52:33Z
Kingfisher version: kingfisher 1.94.0
executable SHA-256: a49f8e9838d7f1da1e9f328a4dbc45a16996bce5078cde3ff1b8ad422d8ab07a
mirror; 15,000 fixtures; 3,000 labeled positives; 2,430,321 bytes hostname SHA-256/12: 82fcd9288623
Linux 6.17.0-19-generic
AMD Ryzen 9 9950X 16-Core Processor
2026-07-31T15:52:43Z
Betterleaks version: betterleaks version dev
executable SHA-256: 466f7d34e1ebcf12ecd5939494f509c17125e54416226976fced2f046da56ba4
mirror; 15,000 fixtures; 3,000 labeled positives; 2,430,321 bytes hostname SHA-256/12: 82fcd9288623
Linux 6.17.0-19-generic
AMD Ryzen 9 9950X 16-Core Processor
2026-07-31T15:52:36Z

Speed & memory

Scanner Config Corpus Wall Throughput Peak RSS
Betterleaks default-nocache-nodaemon-no-validate mirror 0.68s 3.4 MB/s 200 MB
KeyHog simd-nocache-nodaemon-full mirror 1.01s 2.3 MB/s 1044 MB
Kingfisher default-nocache-nodaemon-low-no-validate mirror 4.44s 0.5 MB/s 427 MB

Per-category recall comparison

Diagnostic recall slice only. Overall precision and F1 remain the comparison contract; false positives are counted in their scored categories.

Category KeyHog P/R/F1 KeyHog TP/FN Best competitor P/R/F1 Recall gap
generic-high-entropy-string 1.000 / 0.547 / 0.707 99/82 Betterleaks 1.000 / 0.807 / 0.893 +0.260

Bounded static recovery telemetry

Selected run: scanner KeyHog KeyHog v0.5.49<br>Commit: 837275b7c520fa3cb94781ae88be7fb3c45549b1<br>Detector Set: 923 (923-8785f8837d2cd505)<br>Build Target: x86_64-linux<br>ML Model Version: moe-v1-246a05b92bec9aa3<br>ML Model Card: recorded 2026-07-15; features 55; synthetic F1 0.971 / P 0.945 / R 0.999; real F1 0.832 / P 0.753 / R 0.931 / recall@0.40 0.938; zero-recall detectors 2/32; six-scanner differential unavailable; corpus mirror (15,000 fixtures, 2,430,321 bytes); generated 2026-07-31T15:52:33Z; artifact mirror-keyhog-simd-nocache-nodaemon-full.json.

Telemetry schema: static-recovery-v1.

Disposition Exact count
Supported 0
Unsupported 0
Erroneous 0
Rejection reason Exact count
none 0

Bigram Bloom evidence

Evidence schema: bloom-evidence-v1.

Field Exact result
Corpus samsung-creddata-fx-record-spans-v1
Corpus revision f1de3f85dbdf42bf7b3467c0d273a4dfe44d56ee
Corpus SHA-256 4f2de506f334521121bb5b4aef8a37bf0b8153a4f9115e7ba9392d0eed1757b9
Fixture SHA-256 a0ff018dc0a64b2cc78b25999043d1a441afa0087070f4cd8d73ae82408a59b4
Executable SHA-256 0944d11ac221b61f15a7f67f67cb1bc408430319284f4369af34adf7207d0cb0
Workspace detector corpus SHA-256 4a0520fdfb29ad1d8dac25cc5cb9eb22a7a98570aba6944b68a64e94502a9fbf
Scanner detector digest 0ca3c41a0d87be39
Detector corpus SHA-256 beab12386a58fa89b33be34088bb5b1372b220c9f16cd1c6be0c93b2d8927691
Bloom rejection 124/51794 (0.23%); 51670 admitted
External availability 51794 measured; 0 explicitly unavailable of 51794 declared; reasons:
Enabled vs bypassed findings IDENTICAL; 1454/1454 findings
Finding identity SHA-256 b20485fac4b14eb601a4024268afe8f9ffa4cb103850339b12c54bae3f5bf8c3 / b20485fac4b14eb601a4024268afe8f9ffa4cb103850339b12c54bae3f5bf8c3
Bloom density/state 1782/65536 slots; healthy; saturation at 39322

Finding identity binds detector, file, line, byte span, and credential SHA-256; plaintext credentials are never recorded.

Reproduce: make -C benchmarks canonical KEYHOG_BIN=/absolute/path/to/keyhog reruns the exact KeyHog, Betterleaks, and Kingfisher mirror run set, including the executable-bound CredData Bloom differential, into benchmarks/results/; make -C benchmarks report regenerates the tables above and benchmarks/reports/. See benchmarks/README.md for the corpora (mirror, competitor home-turf, Samsung/CredData) and the backend/cache/daemon/OS/GPU matrix.

GPU-backed mass daemon workers

The optional Unix mass daemon keeps one compiled scanner and its calibrated CPU, Hyperscan, CUDA, Metal, or WGPU backend state warm. Local filesystem scans send only canonical root and source-policy metadata; the daemon reads and batches those bytes in its own process. Git, binary, remote, and cloud sources that require client-side credentials still use protected bounded chunk frames:

# Calibrate on this worker class, then run the service in the foreground
# or under a service manager.
keyhog calibrate-autoroute --policy default
keyhog daemon start --mass

# Stream one independently retryable inventory partition.
keyhog scan --daemon=mass /srv/inventory/team-a \
  --format json-envelope --output team-a.json
keyhog daemon status
keyhog daemon stop

Daemon-local filesystem batches and protected wire batches each carry at most 8 MiB of raw payload and 1,024 chunks. Input size does not determine resident batch memory, so the same route can process a TB-scale tree without collecting it in RAM. Local file payload bytes never cross the IPC socket. The daemon holds an exclusive fragment-state lease for the transaction and clears that state when the client finishes, disconnects, or fails.

For protected wire batches, the client validates the completion receipt against the exact chunks and bytes it sent. For daemon-local paths, the daemon receipt is the source-byte authority. Stderr reports the transport, total and GPU batches, chunks, bytes, GPU byte share, whether GPU processed more than half of all bytes, and daemon-side throughput. Invalid receipt invariants fail instead of emitting a scan report. Acquisition gaps remain visible in the envelope and use exit 13.

Routine workers use persisted autoroute evidence. Add --mass-gpu-primary at daemon startup when a TB-scale worker must prove that GPU processed more than half of all non-empty payload bytes. The client fails before reporting when the terminal receipt is CPU-majority. To diagnose a GPU-only worker, force --backend gpu-cuda-region-presence or --backend gpu-wgpu-region-presence. A forced GPU service exits 12 when GPU startup fails and returns an error instead of substituting CPU after a runtime fault. An explicit backend remains a diagnostic override, not autoroute proof.

--daemon=mass is an explicit required route. It never falls back to an in-process scan. Baseline state, incremental state, live verification, lockdown, presets, detector overlays, custom allowlists, and scanner-policy overrides remain in-process contracts and are rejected before source acquisition. Warm one-file and stdin requests remain available on the same socket through --daemon=on.

See daemon and warm scans and mass scanning.

System-wide credential triage

sudo keyhog scan-system --space 50G
sudo keyhog scan-system --include-network --exclude /mnt/backup

scan-system is a bounded local-host audit, not a replacement for repository or cloud inventory partitioning. Review mount, network-filesystem, space-ceiling, and privilege behavior before running it. See system-wide triage.

Lock down sensitive local scans

Linux --lockdown is a fail-closed process-protection mode:

keyhog scan . --daemon=off --lockdown

It locks current and future memory, disables core dumps and the incremental cache, remains in process, and refuses verification, plaintext output, fast mode, and completeness-reducing switches. It fails on unsupported platforms or insufficient locked-memory capacity. See hardening and data handling.

Use KeyHog as a Rust library

use keyhog_core::{Chunk, ChunkMetadata, RawMatch};
use keyhog_scanner::CompiledScanner;

let detectors = keyhog_core::load_embedded_detectors_or_fail()?;
let scanner = CompiledScanner::compile(detectors)?;
let findings = scanner.scan(&Chunk {
    data: "TOKEN=sk_live_EXAMPLE…".into(),
    metadata: ChunkMetadata::default(),
})?;
let report_safe: Vec<_> = findings.iter().map(RawMatch::to_redacted).collect();

The default library methods are deterministic portable CPU references. Explicit backend methods return typed errors instead of terminating the process or silently substituting another engine. Raw chunks and matches can contain plaintext. Convert them with RawMatch::to_redacted, or use final VerifiedFinding values, before JSON, logs, disk, or network boundaries.

The architecture guide defines crate ownership, backend contracts, recovery receipts, source helpers, and safe reporting boundaries. Crate-level Rust documentation owns the complete API.

Configure policy with explicit precedence

Repository policy lives in .keyhog.toml:

verify = false

[scan]
severity = "high"
incremental = true

[system]
gpu = "auto"

Resolution order is built-in defaults, user configuration, repository configuration, environment where documented, then explicit CLI overrides. Unknown keys and invalid combinations fail before scanning. Run keyhog config --effective to inspect the resolved policy without exposing proxy credentials.

See configuration and precedence for every key and environment variables for credential and runtime inputs.

Architecture

KeyHog keeps orchestration at the edge and domain behavior in libraries:

sources -> scanner -> suppression/confidence -> reporting
                 \-> optional verifier
CLI and Action own process, transport, and exit semantics.

Detector definitions remain data under detectors/. keyhog-core owns detector and finding types, keyhog-scanner owns matching and execution backends, keyhog-sources owns input acquisition, keyhog-verifier owns live checks, and keyhog-cli owns operator workflows.

Start with the architecture guide for the repository map, dependency direction, bytes-to-finding pipeline, routing ownership, and profiling entrypoints.

Inspect and extend the installation

keyhog detectors --search aws --verbose
keyhog explain aws-access-key
keyhog backend --autoroute --json
keyhog completion zsh

The CLI reference lists every command, flag, generated default, and exit status. Use keyhog --help and keyhog <command> --help for the exact installed version.

Contributing

  • New detector? Drop a TOML in detectors/, open a PR. The contributor guide (CONTRIBUTING.md) has the schema and a worked example.
  • Bug / missed secret / false positive? File an issue with the redacted credential shape and detector id; each report becomes a permanent test fixture under tests/contracts/.
  • Preparing a release? Add validated change fragments, then run python3 -B scripts/release.py <next-version> locally or with --ssh. The release operations guide covers benchmark refresh, signing, Pages, release assets, and crates.io.
  • Security issue in KeyHog itself? Don't open a public issue; use GitHub private vulnerability reporting. If that form is unavailable, email security@santh.dev; PGP is not required.

Changelog. Open issues.

Credits

KeyHog stands on prior secret-scanning work. Ideas borrowed from:

  • TruffleHog: detector breadth and verification semantics
  • Betterleaks: token-efficiency and false-positive suppression
  • Titus: scanning ergonomics and severity calibration

Thanks to these projects and their contributors.

License

License: MIT OR Apache-2.0.

Terms: MIT and Apache-2.0. This dual license covers the code and detector TOMLs. Commercial use, embedding, forks, and hosted services are permitted under either license.


Star history

KeyHog GitHub star history from repository-owned observations

Generated from UTC observations of GitHub's public star count. The repository stores the first point and each later count transition. Same-day reruns replace that day's point, and unchanged counts create no commit.

Releases

Packages

Contributors

Languages