Document secret-shapes coverage limits - #89
Merged
Conversation
The detector docs described what secret-shapes catches but not what it deliberately does not, which invites the assumption that enabling it covers any secret in any config an agent reads. Add a "Known coverage limits" section covering the three key/value pairing positions where an opaque value is missed (secret-ish word at the start of the key, decoration between separator and value, flag forms with no separator), each with the reason it is not simply widened. Also document the path-shaped-value rejection added in #85, so the behaviour reads as intentional rather than as a detector miss. Cross-reference from the threat model's "Intentionally not covered" list, and restate that none of this affects the exact-match promise for registered values. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 ignore
Docs only — no behaviour change.
The
secret-shapessection described what the detector catches but not what it deliberately doesn't, which invites the assumption that enabling it covers any secret in any config an agent reads. Both fixes shipped in 0.2.3 (#85, #87) came out of that gap in understanding.Adds a Known coverage limits section to
docs/plugins.md:Cross-referenced from the threat model's "Intentionally not covered" list, which previously had no entry for best-effort detector misses.
🤖 Generated with Claude Code