Secret Scrubber

Settings

Safe defaults, and how to move from dry-run to live.

Evidence. Unless tagged, statements on this page are covered by automated tests, not confirmed on a live site. Exceptions: confirmed on a test site in testing

Every value is checked when you save. Errors show next to the field.

Defaults

SettingDefaultNotes
Dry-runonDetect and log only. Nothing is replaced or deleted. A banner shows dry-run or live.
Replace files even when no secrets are foundoff
Size limit (MB)251 to 100. Larger files are logged as skipped.
Extensionshar, json, log, txt, envOptional: csv, yaml, yml, xml, conf, ini.
Email maskingmask allMask all, mask outside allowed domains, or do not mask.
Allowed email domainsnoneUsed by "outside allowed domains".
Extra header, query and form parameter namesnoneRedacted in addition to the built-in lists.
Cookie names whose values are keptnoneBy default every cookie value is redacted. Names are case-sensitive.
Allowlist (values never redacted)noneExact values.
Entropy detectiononHigh-entropy strings next to words like token, secret, key. Turn off to reduce false positives.
Mask phone numbersoffProduces more false positives.
Hash file names in the audit logoffStores a SHA-256 prefix instead of the name.
Audit retention (months)121 to 120. Older rows are deleted daily. The daily purge is covered by tests and has not been observed on a real site.

Roll out in dry-run first

  1. Install. Dry-run is on and nothing is changed.
  2. Run the Leak audit (below) to see how many files hold secrets.
  3. Let normal traffic run for a few days in dry-run. Read the audit log: "Would sanitize" and "Verified clean".
  4. Review false positives. Add harmless values to the allowlist, or adjust email, entropy or cookie settings.
  5. Run the Permission check. Do not rely on removing a permission to stop the app: dry-run is the control that stops all changes.
  6. Turn dry-run off in a test project during low traffic. Upload a test file. Check that the sanitized copy exists, the preview renders, the original is gone and the audit row says "Sanitized". confirmed on a test site
  7. Watch the issue panel and audit log for "Failed: needs attention" for a week.

Existing attachments are not processed automatically when dry-run is switched off. Use "Sanitize flagged files now" for the ones dry-run flagged. confirmed on a test site

Deleted originals cannot be restored

There is no undo. confirmed on a test site

Leak audit

A read-only scan of up to 500 recent issues. It reports counts only, never values. Use it to see how many existing attachments hold secrets before you change anything. confirmed on a test site

Sanitize flagged files now

Processes attachments that dry-run logged as "Would sanitize" and that were never replaced.

Also on the admin page