StackGuardian / StackGuardian/tirith
feat(core): inline suppressions — bypass/exclude/include checks from the code
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 165
- Forks
- 42
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 11
Description
Inline skip comments (#tirith:skip=<policy-id>: reason) are the adoption pattern users expect
from existing scanners. Two forms: a
suppressions file (policy id + resource address + required reason + optional expiry), which
works today because it filters on meta.address from the plan; and the in-code comment form,
which plan JSON cannot carry and therefore waits on an HCL source provider (Research). Suppressed
findings must appear in the verdict as suppressed-with-reason — never as a silent pass — and pack
coverage claims must count them.
Acceptance. A suppressed failing policy exits green with the suppression listed in every output
format; a suppression without a reason is a validation error; expiry turns it back into a failure.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the existing suppressions-file filtering on plan JSON and meta.address, then investigate the proposed HCL source provider needed for inline comments. Verify that suppressed findings appear with their reasons in every output format, that missing reasons fail validation, that expired suppressions fail again, and that pack coverage includes suppressed findings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, terraform
- Domain
- security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100