You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
fix(scanner): qualify the exact instructional curl placeholder - #81
The published scanner reported two historical Echidna documentation examples as curl-auth-header findings. Both contain the exact public instructional value your-key-here. The scanner correctly inspected the full history; changing scan scope or ignoring the path would hide unrelated credentials.
Change
Add one rule-local, whole-secret equality allowance, ^your-key-here$, to the inherited curl-auth-header rule. The upstream detector, full-history defaults, trusted-base policy checks, and ignore-file policy remain active. A durable control runs in the real-scanner self-test lane and verifies the actual detector identity for a synthetic credential and for credential values with the placeholder attached on either side.
The checked-in evidence records the exact scanner/configuration digests and the local qualification scope. It does not claim a hosted consumer result or general security assurance.
Validation
Gitleaks 8.30.1: eight before/after controls qualified the exact exception without accepting the three credential cases.
The committed helper passes all four same-path controls and requires curl-auth-header for each expected rejection.
The existing real-scanner regression suite and inherited detector controls pass, including full-history deleted credentials and trusted PR policy refusal cases.
Full, non-shallow Echidna history at 977ce94d9a83b8a3a47f54a67a14d004380fcdfa: 1,364 commits, approximately 1.69 GB, zero findings with the qualified configuration; 33.12 seconds wall time.
Bash syntax, actionlint 1.7.12, and git diff --check pass.
Rollout
After this source revision is published on main, repin and run the suite and Echidna consumer canaries at that same published SHA. Compare their actual detector receipts and preserved check contexts before retiring any compatibility workflows. Namespace migration is a separate change.
No actionable comments were generated in the recent review.
Summary
Summary by CodeRabbit
Bug Fixes
The secret scanner no longer flags the exact your-key-here placeholder in curl authentication headers. Credentials and values with that placeholder as a prefix or suffix are still detected.
Tests
Added automated checks to verify the placeholder exemption and confirm that synthetic credentials continue to be detected.
Documentation
Added a record of the scanner’s qualification results and the checks performed.
The Gitleaks baseline now suppresses findings for the exact your-key-here curl placeholder. A control script and workflow step verify that credentials, including values adjoining the placeholder, still produce findings. A JSON record documents scanner qualification and consumer scan evidence.
Changes: Exact-placeholder Gitleaks qualification
Layer / File(s)
Summary
Allow the exact placeholder config/gitleaks/estate-baseline.toml
The provenance comment now identifies the baseline as derived from metadatastician/standards. A rule-specific allowlist matches only the complete extracted secret your-key-here.
The control script checks that the exact placeholder produces no finding and that a credential alone or adjoining the placeholder produces a curl-auth-header finding. The workflow runs the control against the estate baseline. The evidence record documents qualification results, consumer scan results and scope limits.
hyperpolymath/cicd-suite#62: Introduced the bounded Gitleaks scanner, estate baseline and real-scanner self-test workflow that this change extends.
hyperpolymath/cicd-suite#65: Audits published scanner revisions against consumer snapshots; this change updates the baseline used in those audits.
hyperpolymath/cicd-suite#64: Repairs the production caller pin to the published reusable scanner; this change updates the scanner implementation consumed by callers.
Merge Risk: Minimal · up to 9200b
The change stops the scanner from flagging the exact instructional placeholder your-key-here in curl examples. Real credentials, including values attached to the placeholder, are still reported, and a new self-test checks this. No actionable merge-blocking risk was found. The rollout plan still calls for consumer canaries at the published SHA after merge.
Pre-merge checks: 5
Check name
Status
Explanation
Title check
The title clearly and concisely summarises the main change: qualifying the exact instructional curl placeholder in the scanner.
Description check
The description directly explains the scanner issue, configuration change, validation, evidence, and rollout plan. It is related to the changeset.
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 1 files. (3 skipped: 3 unsupported.)
Finishing Touches
Generate docstrings
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
Recent review details
Context from checks skipped due to timeout: 1
GitHub Check: CodeRabbit
Additional context used
GitHub Check: SonarCloud Code Analysis
actions/secret-scan-check/placeholder-control.sh
[failure] 13-13: Add a default case (*) to handle unexpected values.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Problem
The published scanner reported two historical Echidna documentation examples as
curl-auth-headerfindings. Both contain the exact public instructional valueyour-key-here. The scanner correctly inspected the full history; changing scan scope or ignoring the path would hide unrelated credentials.Change
Add one rule-local, whole-secret equality allowance,
^your-key-here$, to the inheritedcurl-auth-headerrule. The upstream detector, full-history defaults, trusted-base policy checks, and ignore-file policy remain active. A durable control runs in the real-scanner self-test lane and verifies the actual detector identity for a synthetic credential and for credential values with the placeholder attached on either side.The checked-in evidence records the exact scanner/configuration digests and the local qualification scope. It does not claim a hosted consumer result or general security assurance.
Validation
curl-auth-headerfor each expected rejection.977ce94d9a83b8a3a47f54a67a14d004380fcdfa: 1,364 commits, approximately 1.69 GB, zero findings with the qualified configuration; 33.12 seconds wall time.git diff --checkpass.Rollout
After this source revision is published on main, repin and run the suite and Echidna consumer canaries at that same published SHA. Compare their actual detector receipts and preserved check contexts before retiring any compatibility workflows. Namespace migration is a separate change.