Skip to content

Commit cb39f69

Browse files
committed
docs(gitleaks): improve descriptions for allowlisted credentials
1 parent ed5534b commit cb39f69

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

.github/.gitleaks.toml

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,32 @@ description = "Ignore test/example credentials with gitleaks:allow comment"
1313
regexTarget = "line"
1414
regex = '''gitleaks:allow'''
1515

16-
# Allowlist specific test credential
16+
# Allowlist specific test credentials
1717
[[rules.allowlist]]
18-
description = "Test WIF credential used in examples and fixtures"
18+
description = "Test WIF credential (serverWIF) used in examples and fixtures"
1919
regexTarget = "match"
2020
regex = '''L1cReZseWmqcYra3vrqj9TPBGHhvDQFD2jYuu1RUj5rrfpVLiKHs'''
2121

22+
[[rules.allowlist]]
23+
description = "Test private key hex (clientPrivHex/alicePrivKey) used in examples and regression tests"
24+
regexTarget = "match"
25+
regex = '''143ab18a84d3b25e1a13cefa90038411e5d2014590a2a4a57263d1593c8dee1c'''
26+
27+
[[rules.allowlist]]
28+
description = "Historical test WIF credential - no longer in use but in git history"
29+
regexTarget = "match"
30+
regex = '''L268WKbTbLTrZL6aW5A5rzd4'''
31+
32+
[[rules.allowlist]]
33+
description = "Historical test public key - no longer in use but in git history"
34+
regexTarget = "match"
35+
regex = '''0279be667ef9dcbbac55a062'''
36+
2237
# Allowlist paths for test fixtures and examples
2338
[[rules.allowlist]]
24-
description = "Ignore credentials in test fixtures"
39+
description = "Ignore credentials in test fixtures, examples, and regression tests"
2540
paths = [
2641
'''pkg/internal/testabilities/fixture/.*''',
42+
'''pkg/internal/regressiontests/.*''',
2743
'''examples/.*''',
2844
]

0 commit comments

Comments
 (0)