Index

Symbols

--evaluate-disabled suricata-check command line option --exclude suricata-check command line option --github suricata-check command line option --gitlab suricata-check command line option --help suricata-check command line option --include suricata-check command line option --include-all suricata-check command line option --issue-severity suricata-check command line option --log-level suricata-check command line option --out suricata-check command line option

--rules suricata-check command line option --single-rule suricata-check command line option -a suricata-check command line option -e suricata-check command line option -h suricata-check command line option -i suricata-check command line option -o suricata-check command line option -r suricata-check command line option -s suricata-check command line option

_

__getnewargs__() (suricata_check.checkers.principle.ml.PrincipleMLChecker method)

__repr__() (suricata_check.utils.checker_typing.Issue method) (suricata_check.utils.checker_typing.RuleReport method)

A

add_issue() (suricata_check.utils.checker_typing.RuleReport method) add_issues() (suricata_check.utils.checker_typing.RuleReport method) add_rule() (suricata_check.utils.checker_typing.OutputReport method) analyze_rule() (in module suricata_check) (in module suricata_check.suricata_check)

are_rule_options_always_put_before() (in module suricata_check.utils.checker) are_rule_options_equal_to_regex() (in module suricata_check.utils.checker) are_rule_options_put_before() (in module suricata_check.utils.checker)

B

BestChecker (class in suricata_check.checkers) (class in suricata_check.checkers.community) (class in suricata_check.checkers.community.best)

C

check_issue() (suricata_check.tests.checker.GenericChecker method) check_rule() (suricata_check.checkers.interface.checker.CheckerInterface method) (suricata_check.checkers.interface.CheckerInterface method) check_rule_option_recognition() (in module suricata_check.utils.checker) CheckerInterface (class in suricata_check.checkers.interface) (class in suricata_check.checkers.interface.checker) ClickHandler (class in suricata_check.utils) codes (suricata_check.checkers.BestChecker attribute) (suricata_check.checkers.community.best.BestChecker attribute) (suricata_check.checkers.community.BestChecker attribute) (suricata_check.checkers.community.unexpected.UnexpectedChecker attribute) (suricata_check.checkers.community.UnexpectedChecker attribute) (suricata_check.checkers.interface.checker.CheckerInterface attribute) (suricata_check.checkers.interface.CheckerInterface attribute) (suricata_check.checkers.interface.dummy.DummyChecker attribute) (suricata_check.checkers.interface.DummyChecker attribute) (suricata_check.checkers.mandatory.MandatoryChecker attribute) (suricata_check.checkers.MandatoryChecker attribute) (suricata_check.checkers.MetadataChecker attribute) (suricata_check.checkers.MsgChecker attribute) (suricata_check.checkers.OrderChecker attribute) (suricata_check.checkers.OverallChecker attribute) (suricata_check.checkers.PcreChecker attribute) (suricata_check.checkers.PerformanceChecker attribute) (suricata_check.checkers.principle.ml.PrincipleMLChecker attribute) (suricata_check.checkers.principle.principle.PrincipleChecker attribute) (suricata_check.checkers.principle.PrincipleChecker attribute) (suricata_check.checkers.PrincipleChecker attribute) (suricata_check.checkers.ReferenceChecker attribute) (suricata_check.checkers.SidChecker attribute) (suricata_check.checkers.StateChecker attribute) (suricata_check.checkers.styleguide.metadata.MetadataChecker attribute) (suricata_check.checkers.styleguide.MetadataChecker attribute) (suricata_check.checkers.styleguide.msg.MsgChecker attribute) (suricata_check.checkers.styleguide.MsgChecker attribute) (suricata_check.checkers.styleguide.order.OrderChecker attribute) (suricata_check.checkers.styleguide.OrderChecker attribute) (suricata_check.checkers.styleguide.overall.OverallChecker attribute) (suricata_check.checkers.styleguide.OverallChecker attribute) (suricata_check.checkers.styleguide.pcre.PcreChecker attribute) (suricata_check.checkers.styleguide.PcreChecker attribute) (suricata_check.checkers.styleguide.performance.PerformanceChecker attribute) (suricata_check.checkers.styleguide.PerformanceChecker attribute) (suricata_check.checkers.styleguide.reference.ReferenceChecker attribute) (suricata_check.checkers.styleguide.ReferenceChecker attribute) (suricata_check.checkers.styleguide.sid.SidChecker attribute) (suricata_check.checkers.styleguide.SidChecker attribute) (suricata_check.checkers.styleguide.state.StateChecker attribute) (suricata_check.checkers.styleguide.StateChecker attribute) (suricata_check.checkers.styleguide.whitespace.WhitespaceChecker attribute) (suricata_check.checkers.styleguide.WhitespaceChecker attribute) (suricata_check.checkers.UnexpectedChecker attribute) (suricata_check.checkers.WhitespaceChecker attribute)

count_rule_options() (in module suricata_check.utils.checker)

D

DummyChecker (class in suricata_check.checkers.interface) (class in suricata_check.checkers.interface.dummy)

E

emit() (suricata_check.utils.ClickHandler method) enabled_by_default (suricata_check.checkers.interface.checker.CheckerInterface attribute) (suricata_check.checkers.interface.CheckerInterface attribute) (suricata_check.checkers.interface.dummy.DummyChecker attribute) (suricata_check.checkers.interface.DummyChecker attribute) (suricata_check.checkers.principle.ml.PrincipleMLChecker attribute)

F

find_rules_file() (in module suricata_check.utils)

G

GenericChecker (class in suricata_check.tests.checker) get_all_subclasses() (in module suricata_check.utils.checker_typing) get_all_variable_groups() (in module suricata_check.utils.checker) get_checkers() (in module suricata_check) (in module suricata_check.suricata_check) get_options_regex() (in module suricata_check.utils.regex) get_regex_provider() (in module suricata_check.utils.regex) get_rule_body() (in module suricata_check.utils.regex) get_rule_group_entries() (in module suricata_check.utils.regex)

get_rule_keyword_sequences() (in module suricata_check.utils.checker) get_rule_option() (in module suricata_check.utils.checker) get_rule_option_position() (in module suricata_check.utils.checker) get_rule_option_positions() (in module suricata_check.utils.checker) get_rule_options() (in module suricata_check.utils.checker) get_rule_options_positions() (in module suricata_check.utils.checker) get_rule_sticky_buffer_naming() (in module suricata_check.utils.checker) get_rule_suboption() (in module suricata_check.utils.checker) get_rule_suboptions() (in module suricata_check.utils.checker) get_variable_groups() (in module suricata_check.utils.regex)

H

hash (suricata_check.utils.checker_typing.Issue property)

I

InvalidRuleError is_rule_option_always_equal_to_regex() (in module suricata_check.utils.checker) is_rule_option_always_put_before() (in module suricata_check.utils.checker) is_rule_option_equal_to() (in module suricata_check.utils.checker) is_rule_option_equal_to_regex() (in module suricata_check.utils.checker) is_rule_option_first() (in module suricata_check.utils.checker) is_rule_option_last() (in module suricata_check.utils.checker) is_rule_option_one_of() (in module suricata_check.utils.checker)

is_rule_option_put_before() (in module suricata_check.utils.checker) is_rule_option_set() (in module suricata_check.utils.checker) is_rule_suboption_always_equal_to_regex() (in module suricata_check.utils.checker) is_rule_suboption_equal_to() (in module suricata_check.utils.checker) is_rule_suboption_equal_to_regex() (in module suricata_check.utils.checker) is_rule_suboption_set() (in module suricata_check.utils.checker) is_valid_rule() (in module suricata_check.utils.regex) Issue (class in suricata_check.utils.checker_typing) issues (suricata_check.utils.checker_typing.RuleReport property)

M

main() (in module suricata_check) (in module suricata_check.suricata_check) MandatoryChecker (class in suricata_check.checkers) (class in suricata_check.checkers.mandatory) MetadataChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.metadata) module suricata_check suricata_check.__main__ suricata_check.checkers suricata_check.checkers.community suricata_check.checkers.community.best suricata_check.checkers.community.unexpected suricata_check.checkers.interface suricata_check.checkers.interface.checker suricata_check.checkers.interface.dummy suricata_check.checkers.mandatory suricata_check.checkers.principle suricata_check.checkers.principle.ml suricata_check.checkers.principle.principle suricata_check.checkers.styleguide suricata_check.checkers.styleguide.metadata suricata_check.checkers.styleguide.msg suricata_check.checkers.styleguide.order suricata_check.checkers.styleguide.overall suricata_check.checkers.styleguide.pcre suricata_check.checkers.styleguide.performance suricata_check.checkers.styleguide.reference suricata_check.checkers.styleguide.sid suricata_check.checkers.styleguide.state suricata_check.checkers.styleguide.whitespace suricata_check.suricata_check suricata_check.tests suricata_check.tests.checker suricata_check.utils suricata_check.utils.checker suricata_check.utils.checker_typing suricata_check.utils.regex

MsgChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.msg)

O

OrderChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.order) OutputReport (class in suricata_check.utils.checker_typing)

OutputSummary (class in suricata_check.utils.checker_typing) OverallChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.overall)

P

PcreChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.pcre) PerformanceChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.performance) PrincipleChecker (class in suricata_check.checkers) (class in suricata_check.checkers.principle) (class in suricata_check.checkers.principle.principle)

PrincipleMLChecker (class in suricata_check.checkers) (class in suricata_check.checkers.principle) (class in suricata_check.checkers.principle.ml) process_rules_file() (in module suricata_check) (in module suricata_check.suricata_check)

R

ReferenceChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.reference)

RuleReport (class in suricata_check.utils.checker_typing) rules (suricata_check.utils.checker_typing.OutputReport property)

S

select_rule_options_by_regex() (in module suricata_check.utils.checker) SidChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.sid) StateChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.state) suricata-check command line option --evaluate-disabled --exclude --github --gitlab --help --include --include-all --issue-severity --log-level --out --rules --single-rule -a -e -h -i -o -r -s suricata_check module suricata_check.__main__ module suricata_check.checkers module suricata_check.checkers.community module suricata_check.checkers.community.best module suricata_check.checkers.community.unexpected module suricata_check.checkers.interface module suricata_check.checkers.interface.checker module suricata_check.checkers.interface.dummy module

suricata_check.checkers.mandatory module suricata_check.checkers.principle module suricata_check.checkers.principle.ml module suricata_check.checkers.principle.principle module suricata_check.checkers.styleguide module suricata_check.checkers.styleguide.metadata module suricata_check.checkers.styleguide.msg module suricata_check.checkers.styleguide.order module suricata_check.checkers.styleguide.overall module suricata_check.checkers.styleguide.pcre module suricata_check.checkers.styleguide.performance module suricata_check.checkers.styleguide.reference module suricata_check.checkers.styleguide.sid module suricata_check.checkers.styleguide.state module suricata_check.checkers.styleguide.whitespace module suricata_check.suricata_check module suricata_check.tests module suricata_check.tests.checker module suricata_check.utils module suricata_check.utils.checker module suricata_check.utils.checker_typing module suricata_check.utils.regex module

T

test_code_structure() (suricata_check.tests.checker.GenericChecker method) to_dict() (suricata_check.utils.checker_typing.Issue method) (suricata_check.utils.checker_typing.RuleReport method)

train() (suricata_check.checkers.principle.ml.PrincipleMLChecker method)

U

UnexpectedChecker (class in suricata_check.checkers) (class in suricata_check.checkers.community) (class in suricata_check.checkers.community.unexpected)

W

WhitespaceChecker (class in suricata_check.checkers) (class in suricata_check.checkers.styleguide) (class in suricata_check.checkers.styleguide.whitespace)