suricata-check
Getting Started
The
suricata-check
project
CLI Usage
Suppressing rule issues
Configuration using
suricata-check.ini
Visual Studio Code Extension
CI/CD Integration
API Usage
Writing checkers
Contributing
CLI Reference
suricata-check
(CLI)
API Reference
suricata_check
Indices and tables
Index
Module Index
Search Page
suricata-check
Index
Index
Symbols
|
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
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
--ini
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
_
__hash__() (suricata_check.utils.rule.Rule method)
(suricata_check.utils.rule.RuleOption method)
__repr__() (suricata_check.utils.checker_typing.Issue method)
(suricata_check.utils.checker_typing.RuleReport method)
__str__() (suricata_check.utils.rule.Rule method)
__version__ (in module suricata_check)
A
action (suricata_check.utils.rule.Rule attribute)
add_flowbits_option() (suricata_check.utils.rule.Rule method)
add_issue() (suricata_check.utils.checker_typing.RuleReport method)
add_issues() (suricata_check.utils.checker_typing.RuleReport method)
add_metadata_options() (suricata_check.utils.rule.Rule method)
add_option() (suricata_check.utils.rule.Rule method)
add_reference_option() (suricata_check.utils.rule.Rule method)
add_rule() (suricata_check.utils.checker_typing.OutputReport method)
ADDRESS_GROUPS (in module suricata_check.utils.regex)
ALL_DETECTION_KEYWORDS (in module suricata_check.utils.regex)
ALL_KEYWORDS (in module suricata_check.utils.regex)
ALL_METADATA_KEYWORDS (in module suricata_check.utils.regex)
ALL_MODIFIER_KEYWORDS (in module suricata_check.utils.regex)
ALL_TRANSFORMATION_KEYWORDS (in module suricata_check.utils.regex)
ALL_VARIABLES (in module suricata_check.utils.regex)
analyze_rule() (in module suricata_check)
APP_LAYER_KEYWORDS (in module suricata_check.utils.regex)
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
BASE64_BUFFER_KEYWORDS (in module suricata_check.utils.regex)
BASE64_TRANSFORMATION_KEYWORDS (in module suricata_check.utils.regex)
BestChecker (class in suricata_check.checkers.community)
BUFFER_KEYWORDS (in module suricata_check.utils.regex)
C
check_for_update() (in module suricata_check)
check_issue() (suricata_check.tests.checker.GenericChecker method)
check_rule() (suricata_check.checkers.interface.CheckerInterface method)
check_rule_option_recognition() (in module suricata_check.utils.checker)
checker (suricata_check.tests.checker.GenericChecker attribute)
(suricata_check.utils.checker_typing.Issue attribute)
CheckerInterface (class in suricata_check.checkers.interface)
CLASSTYPES (in module suricata_check.utils.regex)
code (suricata_check.utils.checker_typing.Issue attribute)
codes (suricata_check.checkers.community.BestChecker attribute)
(suricata_check.checkers.community.UnexpectedChecker attribute)
(suricata_check.checkers.interface.CheckerInterface attribute)
(suricata_check.checkers.interface.DummyChecker attribute)
(suricata_check.checkers.MandatoryChecker attribute)
(suricata_check.checkers.styleguide.MetadataChecker attribute)
(suricata_check.checkers.styleguide.MsgChecker attribute)
(suricata_check.checkers.styleguide.OrderChecker attribute)
(suricata_check.checkers.styleguide.OverallChecker attribute)
(suricata_check.checkers.styleguide.PcreChecker attribute)
(suricata_check.checkers.styleguide.PerformanceChecker attribute)
(suricata_check.checkers.styleguide.ReferenceChecker attribute)
(suricata_check.checkers.styleguide.SidChecker attribute)
(suricata_check.checkers.styleguide.StateChecker attribute)
(suricata_check.checkers.styleguide.WhitespaceChecker attribute)
COMPATIBILITY_MODIFIER_KEYWORDS (in module suricata_check.utils.regex)
CONTENT_KEYWORDS (in module suricata_check.utils.regex)
count_rule_options() (in module suricata_check.utils.checker)
D
DCERPC_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
dest_addr (suricata_check.utils.rule.Rule attribute)
dest_port (suricata_check.utils.rule.Rule attribute)
direction (suricata_check.utils.rule.Rule attribute)
DNS_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
DummyChecker (class in suricata_check.checkers.interface)
E
enabled (suricata_check.utils.rule.Rule attribute)
enabled_by_default (suricata_check.checkers.interface.CheckerInterface attribute)
(suricata_check.checkers.interface.DummyChecker attribute)
EXTENSIVE_SUMMARY_TYPE (in module suricata_check.utils.checker_typing)
F
find_rules_file() (in module suricata_check.utils)
FLOW_KEYWORDS (in module suricata_check.utils.regex)
FLOW_STREAM_KEYWORDS (in module suricata_check.utils.regex)
flowbits (suricata_check.utils.rule.Rule attribute)
FTP_KEYWORDS (in module suricata_check.utils.regex)
G
GenericChecker (class in suricata_check.tests.checker)
get_all_variable_groups() (in module suricata_check.utils.checker)
get_checkers() (in module suricata_check)
get_ini_kwargs() (in module suricata_check)
get_options_regex() (in module suricata_check.utils.regex)
get_regex_provider() (in module suricata_check.utils.regex_provider)
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)
header (suricata_check.utils.rule.Rule attribute)
HEADER_REGEX (in module suricata_check.utils.regex)
HTTP_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
I
ICMP_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
include (suricata_check.checkers.interface.CheckerInterface attribute)
InvalidRuleError
IP_ADDRESS_REGEX (in module suricata_check.utils.regex)
IP_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
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)
issues_by_group (suricata_check.utils.checker_typing.OutputSummary attribute)
issues_by_type (suricata_check.utils.checker_typing.OutputSummary attribute)
ISSUES_TYPE (in module suricata_check.utils.checker_typing)
J
JA3_JA4_KEYWORDS (in module suricata_check.utils.regex)
L
line_begin (suricata_check.utils.checker_typing.RuleReport attribute)
line_end (suricata_check.utils.checker_typing.RuleReport attribute)
LRU_CACHE_SIZE (in module suricata_check.utils.regex)
LUA_KEYWORDS (in module suricata_check.utils.regex)
M
main() (in module suricata_check)
MandatoryChecker (class in suricata_check.checkers)
Match (in module suricata_check.utils.regex_provider)
MATCH_LOCATION_KEYWORDS (in module suricata_check.utils.regex)
message (suricata_check.utils.checker_typing.Issue attribute)
metadata (suricata_check.utils.rule.Rule attribute)
METADATA_DATE_KEYWORDS (in module suricata_check.utils.regex)
METADATA_NON_DATE_KEYWORDS (in module suricata_check.utils.regex)
MetadataChecker (class in suricata_check.checkers.styleguide)
MODIFIER_KEYWORDS (in module suricata_check.utils.regex)
module
suricata_check
suricata_check.__main__
suricata_check.checkers
suricata_check.checkers.community
suricata_check.checkers.interface
suricata_check.checkers.styleguide
suricata_check.tests
suricata_check.tests.checker
suricata_check.utils
suricata_check.utils.checker
suricata_check.utils.checker_typing
suricata_check.utils.regex
suricata_check.utils.regex_provider
suricata_check.utils.rule
MsgChecker (class in suricata_check.checkers.styleguide)
N
name (suricata_check.utils.rule.RuleOption attribute)
NON_FUNCTIONAL_KEYWORDS (in module suricata_check.utils.regex)
O
options (suricata_check.utils.rule.Rule attribute)
OrderChecker (class in suricata_check.checkers.styleguide)
OTHER_BUFFERS (in module suricata_check.utils.regex)
OTHER_KEYWORDS (in module suricata_check.utils.regex)
OTHER_PAYLOAD_KEYWORDS (in module suricata_check.utils.regex)
OutputReport (class in suricata_check.utils.checker_typing)
OutputSummary (class in suricata_check.utils.checker_typing)
overall_summary (suricata_check.utils.checker_typing.OutputSummary attribute)
OverallChecker (class in suricata_check.checkers.styleguide)
P
parse() (in module suricata_check.utils.rule)
ParsingError
Pattern (in module suricata_check.utils.regex_provider)
PcreChecker (class in suricata_check.checkers.styleguide)
PERFORMANCE_DETECTION_OPTIONS (in module suricata_check.utils.regex)
PerformanceChecker (class in suricata_check.checkers.styleguide)
POINTER_MOVEMENT_KEYWORDS (in module suricata_check.utils.regex)
PORT_GROUPS (in module suricata_check.utils.regex)
process_rules_file() (in module suricata_check)
proto (suricata_check.utils.rule.Rule attribute)
PROTOCOL_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
R
raw (suricata_check.utils.rule.Rule attribute)
ReferenceChecker (class in suricata_check.checkers.styleguide)
references (suricata_check.utils.rule.Rule attribute)
Rule (class in suricata_check.utils.rule)
rule (suricata_check.utils.checker_typing.RuleReport attribute)
RULE_REPORTS_TYPE (in module suricata_check.utils.checker_typing)
RULE_SUMMARY_TYPE (in module suricata_check.utils.checker_typing)
RuleOption (class in suricata_check.utils.rule)
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)
severity (suricata_check.utils.checker_typing.Issue attribute)
SidChecker (class in suricata_check.checkers.styleguide)
SIMPLE_SUMMARY_TYPE (in module suricata_check.utils.checker_typing)
SIZE_KEYWORDS (in module suricata_check.utils.regex)
source_addr (suricata_check.utils.rule.Rule attribute)
source_port (suricata_check.utils.rule.Rule attribute)
SSH_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
StateChecker (class in suricata_check.checkers.styleguide)
STATEFUL_KEYWORDS (in module suricata_check.utils.regex)
STICKY_BUFFER_NAMING (in module suricata_check.utils.regex)
STREAM_KEYWORDS (in module suricata_check.utils.regex)
summary (suricata_check.utils.checker_typing.OutputReport attribute)
(suricata_check.utils.checker_typing.RuleReport attribute)
suricata-check command line option
--evaluate-disabled
--exclude
--github
--gitlab
--help
--include
--include-all
--ini
--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.interface
module
suricata_check.checkers.styleguide
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
suricata_check.utils.regex_provider
module
suricata_check.utils.rule
module
T
TCP_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
test_code_structure() (suricata_check.tests.checker.GenericChecker method)
THRESHOLD_KEYWORDS (in module suricata_check.utils.regex)
TLS_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
to_dict() (suricata_check.utils.checker_typing.Issue method)
(suricata_check.utils.checker_typing.RuleReport method)
TRANSFORMATION_KEYWORDS (in module suricata_check.utils.regex)
U
UDP_SPECIFIC_KEYWORDS (in module suricata_check.utils.regex)
UnexpectedChecker (class in suricata_check.checkers.community)
V
value (suricata_check.utils.rule.RuleOption attribute)
W
WhitespaceChecker (class in suricata_check.checkers.styleguide)