userguide: explain rule types and categorization - v5 #12112
Closed
Conversation
This file contains 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
Add documentation about the rule types introduced by 2696fda. Add doc tags around code definitions that are referenced in the docs. Task #https://redmine.openinfosecfoundation.org/issues/7031
victorjulien
requested changes
Nov 12, 2024
| - Per transaction update | ||
| - On buffer keywords | ||
| - Application layer protocol-related, e.g. `http.host`, `rfb.secresult`, | ||
| dcerpc_stub_data |
There was a problem hiding this comment.
dce_stub_data or dcerpc.stub_data (last is newer, so use that)
|
|
||
| .. note:: Scope: `Flow, if stateful` | ||
|
|
||
| (**) Apply to the flow. If a segment isn't accepted into a stream for any |
There was a problem hiding this comment.
should this be directly under the (*) note?
There was a problem hiding this comment.
Will move it back there.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #12112 +/- ##
==========================================
+ Coverage 83.23% 83.28% +0.05%
==========================================
Files 906 906
Lines 257647 257647
==========================================
+ Hits 214458 214588 +130
+ Misses 43189 43059 -130
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Feedback incorporated: #12113 |
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.
Add documentation about the rule types introduced by 2696fda.
Add doc tags around code definitions that are referenced in the docs.
Task #https://redmine.openinfosecfoundation.org/issues/7031
Link to ticket: https://redmine.openinfosecfoundation.org/issues/
I guess this covers https://redmine.openinfosecfoundation.org/issues/7031
Built docs: https://suri-rtd-test.readthedocs.io/en/doc-sigtypes-et-properties-v5/rules/intro.html#rule-types-and-categorization
Previous PR: #12111
Describe changes: (tried to) address feedback:
Decode Eventsrule type toDecoder Events, since that's how they're defined in the original commit messagestarts with/startswith