Skip to content

0.2.0

Choose a tag to compare

@github-actions github-actions released this 10 Oct 18:31
· 17 commits to main since this release
Immutable release. Only release title and notes can be modified.
0.2.0
4bf0cf5

Adds personal-data detectors, stable pseudonyms and a config file, and makes scanning about 2.5x faster.

New detectors: email addresses, IPv4 and IPv6 addresses (loopback is left alone), payment card numbers (Luhn-checked, known issuer prefixes), and international phone numbers (off by default: --enable phone). Each has context checks so version strings (Chrome/126.0.0.0), timestamps, MAC addresses, ssh://git@host and icon@2x.png are left untouched; a "must not change" corpus guards them.

Pseudonym mode: --mode pseudonym replaces emails and IPs with stable HMAC-SHA256 tags such as [email:gqgkqsm4], so the same value maps to the same tag across a file and across runs while the log stays debuggable. Secrets keep fixed [REDACTED:id] markers. The key comes from --key-file or LOGSCRUB_KEY (never argv); without one a random per-run key is used.

Config file: --config logscrub.toml takes enable / disable lists, an allow-list (exact values or regexes) and custom RE2 rules. It is parsed strictly. Flags override the file. See the wiki's Configuration page.

Speed: a per-detector prefilter takes a 12.5 MB log from 3.0 s to 1.2 s despite five more detectors. A test and the fuzz target assert it never changes the output.

Dependency: github.com/BurntSushi/toml (no transitive dependencies) for the config file.

Pattern matching cannot find secrets with no recognisable shape; review the output before sharing it.