Update README with threat-model, sinks, and taxonomy documentation#38
Merged
Update README with threat-model, sinks, and taxonomy documentation#38
Conversation
Added sections for threat-model and sinks with example output from a Rails project. Explains the taxonomy-to-threat mapping pipeline, conjunctive matching, and what sinks are. Updated the How it works section to show the optional [taxonomy] and [[security.sinks]] TOML blocks. Regenerated the What it detects section (446 to 516 tool defs after the security-relevant library additions).
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
1 participant
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.
The README had the two new commands in the usage block but no explanation of what they do. Added sections for `threat-model` and `sinks` with example output from a Rails project, matching the pattern of the existing Diff, Missing, and Enrichment sections. Explains the taxonomy-to-threat mapping pipeline, conjunctive matching, and what sinks are in plain language.
Updated the How it works section to show the optional `[taxonomy]` and `[[security.sinks]]` blocks in the example TOML. Regenerated the What it detects section (446 to 516 tool defs after the security-relevant library additions).