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

.. py:module:: suricata_check.checkers

.. autoapi-nested-parse::

   The `suricata_check.checkers` module contains all rule checkers.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/suricata_check/checkers/community/index
   /autoapi/suricata_check/checkers/interface/index
   /autoapi/suricata_check/checkers/styleguide/index


Classes
-------

.. autoapisummary::

   suricata_check.checkers.MandatoryChecker


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

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

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


   The `MandatoryChecker` contains several checks based on the Suricata syntax that are critical.

   Codes M000-M009 report on mandatory rule syntax violations.

   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