suricata_check.checkers.community
=================================

.. py:module:: suricata_check.checkers.community

.. autoapi-nested-parse::

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

   Reference: TODO



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/suricata_check/checkers/community/best/index
   /autoapi/suricata_check/checkers/community/unexpected/index


Classes
-------

.. autoapisummary::

   suricata_check.checkers.community.BestChecker
   suricata_check.checkers.community.UnexpectedChecker


Package Contents
----------------

.. py:class:: BestChecker(include: Optional[collections.abc.Iterable[str]] = None)

   Bases: :py:obj:`suricata_check.checkers.interface.CheckerInterface`


   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.


   .. py:attribute:: 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



.. py:class:: UnexpectedChecker(include: Optional[collections.abc.Iterable[str]] = None)

   Bases: :py:obj:`suricata_check.checkers.interface.CheckerInterface`


   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.


   .. py:attribute:: 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