|
| 1 | +title = "datadog-lambda-extension gitleaks config" |
| 2 | + |
| 3 | +# This file configures gitleaks to suppress known false positives. |
| 4 | +# Only add entries here after confirming a finding is NOT a real secret. |
| 5 | +# If a real secret is found: rotate it immediately, then add the commit to [allowlist.commits]. |
| 6 | +# |
| 7 | +# Maintenance workflow: |
| 8 | +# 1. gitleaks flags something on a PR |
| 9 | +# 2. Review the finding — is it a real secret or a false positive? |
| 10 | +# 3. Real secret → rotate immediately, fix the code, optionally add the commit hash below |
| 11 | +# 4. False positive → add the appropriate entry below with a comment explaining why |
| 12 | + |
| 13 | +[allowlist] |
| 14 | +description = "Known false positives" |
| 15 | + |
| 16 | +# paths: skip entire directories or files from scanning. |
| 17 | +# Use when a directory contains third-party code or test fixtures with fake data. |
| 18 | +# Examples: |
| 19 | +# "integration-tests/node_modules" — npm dependencies, not our code |
| 20 | +# "bottlecap/tests/fixtures" — test payloads with placeholder values |
| 21 | +# "docs/examples" — documentation examples with fake keys |
| 22 | +paths = [ |
| 23 | + # npm dependencies bundled under integration-tests — not our code, would be noisy |
| 24 | + "integration-tests/node_modules", |
| 25 | +] |
| 26 | + |
| 27 | +# regexes: suppress findings whose matched secret value matches one of these patterns. |
| 28 | +# Use for placeholder/example values that appear in source or docs but are not real secrets. |
| 29 | +# Examples: |
| 30 | +# '''your-api-key''' — generic placeholder in docs or scripts |
| 31 | +# '''my_test_key''' — unit test placeholder (bottlecap/tests/) |
| 32 | +# '''AKIAIOSFODNN7EXAMPLE''' — AWS example key from official AWS documentation |
| 33 | +# '''DD_API_KEY_EXAMPLE''' — Datadog placeholder used in README examples |
| 34 | +regexes = [] |
| 35 | + |
| 36 | +# commits: suppress all findings from a specific historical commit. |
| 37 | +# Use when a commit contained a now-rotated credential that cannot be rewritten |
| 38 | +# (e.g., it is already on the default branch or in a public tag). |
| 39 | +# Always document why the commit is suppressed and confirm the credential was rotated. |
| 40 | +# Examples: |
| 41 | +# "abc123def456" — rotated DD_API_KEY accidentally committed on 2024-01-15, key invalidated |
| 42 | +commits = [] |
0 commit comments