docs: add Reference Rule Libraries appendix mapping components to rule fields#63
Open
eeee2345 wants to merge 1 commit into
Open
docs: add Reference Rule Libraries appendix mapping components to rule fields#63eeee2345 wants to merge 1 commit into
eeee2345 wants to merge 1 commit into
Conversation
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.
Summary
AARM defines the spec, but the conformance story benefits from a reference rule library showing how a concrete rule pack instantiates each component. An integrator reading the System Components pages still has to decide which fields of a detection rule populate the Action Mediation Layer, which drive the PDP, and which end up signed into a receipt. This appendix makes that mapping explicit.
What this PR adds
appendix/reference-rule-libraries.mdx: a new page under a new "Appendix" group in the Specification tab.docs.jsonto register the group in navigation.The page contains:
ATR is used as the worked example because it is MIT-licensed, openly available, and already deployed at Microsoft and Cisco, so the mapping can be exercised against real rule data. The appendix is intentionally non-exclusive: the mapping is normative, the choice of library is not.
Notes
No changes to normative spec text or conformance requirements. Happy to revise framing, naming, or placement (Appendix vs. inside System Components) if the working group prefers.