@broberg/secret-scan 0.15.0 → 0.16.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -0
- package/dist/cli.cjs +690 -0
- package/dist/cli.cjs.map +1 -0
- package/dist/cli.d.cts +7 -0
- package/dist/cli.d.ts +7 -0
- package/dist/cli.js +688 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.cjs +26 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +26 -3
- package/dist/index.js.map +1 -1
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -36,6 +36,25 @@ const { redacted, findings } = redactSecrets("the key is sk-ant-api03-… use it
|
|
|
36
36
|
hasSecret("nothing here"); // false
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
+
## CLI — `secret-scan --stdin` (v0.16.1)
|
|
40
|
+
|
|
41
|
+
For a git hook or a CI step, without embedding a script:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
git diff --cached | npx secret-scan --stdin
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Prints `<label> line <n>` for each finding — **never the value** — and exits
|
|
48
|
+
**1** on a finding, **0** when nothing was found, **2** when it could not scan.
|
|
49
|
+
A secret spanning lines (a PEM key) is reported as `(spans several lines)`.
|
|
50
|
+
Same pattern set and defaults as `redactSecrets(text)` (format axis only).
|
|
51
|
+
|
|
52
|
+
v0.16.1 also adds `bearer-token` and `labeled-token-param` (`token=`, `key=`,
|
|
53
|
+
`secret=` …): a value of 24+ characters mixing letters and digits, so
|
|
54
|
+
`Bearer <token>`, `${TOKEN}` and plain words are left alone; and `upmetrics-key`
|
|
55
|
+
now takes 32–64 alphanumerics after `uk_`. The fleet gitleaks config
|
|
56
|
+
(`secret-gate/gitleaks.toml`) carries the same fleet formats (F090.6).
|
|
57
|
+
|
|
39
58
|
`redactSecrets` is **pure + deterministic**: clean input returns byte-identical
|
|
40
59
|
with `findings: []`. It replaces every detected secret with `[REDACTED:<label>]`
|
|
41
60
|
and never blocks the write — the surrounding knowledge survives.
|