Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC - WIP - userguide: explain rule types and categorization - v2 #12105

Closed

Conversation

jufajardini
Copy link
Contributor

@jufajardini jufajardini commented Nov 8, 2024

Add documentation about the rule types introduced by 2696fda.

Previous PR: #12089

Built docs: https://suri-rtd-test.readthedocs.io/en/doc-sigtypes-et-properties-v2/rules/intro.html#rule-s-types-and-categorization

Describe changes:

  • add examples for each rule type
  • fix column mismatch in some cases
  • improve explanation based on discussions on last PR
  • fix typos and wrong explanations

TODOs:

  • Should still find a place for the flowcharts -- or decide it's not the moment for those.
  • I think that flow keywords could be examples for some cases, but understand better.

Add documentation about the rule types introduced by 2696fda.
Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.25%. Comparing base (278dc24) to head (6b31e20).

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #12105      +/-   ##
==========================================
+ Coverage   83.23%   83.25%   +0.01%     
==========================================
  Files         906      906              
  Lines      257647   257647              
==========================================
+ Hits       214458   214501      +43     
+ Misses      43189    43146      -43     
Flag Coverage Δ
fuzzcorpus 61.26% <ø> (+0.05%) ⬆️
livemode 19.42% <ø> (ø)
pcap 44.39% <ø> (-0.04%) ⬇️
suricata-verify 62.72% <ø> (+0.01%) ⬆️
unittests 59.28% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.


.. container:: example-rule

alert tcp-pkt any any -> any any (msg:"tcp-pkt, no content"; sid:201;)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love these example rules! <3
Suggestion: Perhaps explicit IP addresses here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, most of them are from the SV tests for rule types :D
I'll add a rule with explicit IP addresses, merci!

@jufajardini
Copy link
Contributor Author

Feedback incorporated in follow up #12107

@jufajardini jufajardini closed this Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants