docs: state threat-model coverage scope honestly#263
Merged
Conversation
The tree-sitter discovery pipeline targets web-service shapes. Today that means Python web frameworks (Flask, FastAPI, Django, MCP servers) land in the supported sweet spot; Go HTTP services have thin coverage; CLI tools, libraries, and systems software aren't modeled and produce structurally-complete-but-empty threat models. Adds a Coverage scope subsection to the top-level README so users don't mistake "0 findings" for a clean bill of health. Tempers the SA-03.02 remediation rating in the baseline README to reflect the shape dependency. Coverage expansion (cobra/CLI patterns, more Go shapes) will be tracked in a follow-up issue. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Open
7 tasks
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.
Summary
THREAT_MODEL.mdremediation inpackages/darnit-baseline/README.mdto reflect the shape dependency.Why
A cold audit of a Go CLI (gittuf) showed darnit happily writing a
THREAT_MODEL.mdcontaining "Total findings: 0" because the Go entry-point queries only match HTTP routing patterns. The file looked complete; the audit gave a misleading impression. Honest docs surface that gap so users (and demo audiences) aren't surprised.Coverage expansion is tracked in #262.
Test plan
docs/generated/drift introduced (uv run python scripts/generate_docs.pyis a no-op)🤖 Generated with Claude Code