Welcome to suricata-check’s documentation!

Getting Started

• The suricata-check project
  • Features
  • Installation
  • Usage
  • Output
  • Issue codes
  • Contributing
  • License
  • Citations
• CLI Usage
  • Output
  • Single rule processing
  • Dealing with multiple rules files
  • Enabling and disabling checker issues
  • CI/CD Integration
• CI/CD Integration
  • GitHub
  • GitLab
• API Usage
  • Analyze a single rule
  • Inspecting issues
  • Selecting checkers
  • Processing rulesets
• Writing checkers
  • CheckerInterface
  • Detecting issues
  • Using custom checkers
  • Testing checkers
  • Releasing checkers as a package
• Contributing
  • Reporting bugs
  • Proposing new rule issues
  • Preparing the development environment
  • Running tests
  • Training new models
  • Linting
  • Docs
  • Pull requests
  • Writing Extensions

CLI Reference

• suricata-check (CLI)
  • suricata-check

API Reference

• 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

Indices and tables

• Index
• Module Index
• Search Page