suricata_check.checkers.community

The suricata_check.checkers.community modules contains several checkers based on community issues, such as this GitHub.

Reference: TODO

Submodules

`BestChecker`	The BestChecker contains several checks for best practices to improve the experience of Suricata rules for everyone.
`UnexpectedChecker`	The UnexpectedChecker contains several checks for unexpected Suricata behavior that users may not anticipate.

class suricata_check.checkers.community.BestChecker(include: collections.abc.Iterable[str] | None = None)[source]

The BestChecker contains several checks for best practices to improve the experience of Suricata rules for everyone.

Codes C100-C110 report on missing fields that should be set.

Initializes the checker given a list of issue codes to emit.

codes: A Mapping of issue codes emitted by the checker to metadata for those issue types. The metadata is structured in the form of a Mapping from attribute name to attribute value. The one mandatory metadata attribute is severity, which must be one of the levels provided by the logging module

class suricata_check.checkers.community.UnexpectedChecker(include: collections.abc.Iterable[str] | None = None)[source]

The UnexpectedChecker contains several checks for unexpected Suricata behavior that users may not anticipate.

Codes C000-C010 report on unexpected behavior.

Initializes the checker given a list of issue codes to emit.

codes: A Mapping of issue codes emitted by the checker to metadata for those issue types. The metadata is structured in the form of a Mapping from attribute name to attribute value. The one mandatory metadata attribute is severity, which must be one of the levels provided by the logging module