You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
suricata/doc/userguide/devguide
Victor Julien 26b9c1d78d doc: update the SSH docs for the reworked state machine
State table and failure/completion semantics for the
per-direction scale (banner/kex/session, done never reported),
the removed banner_wait_eol state and legacy hook names, the new
eve ssh error/state fields, and the transactions/lua/upgrade
examples - all updated to match.

Ticket: #9046.
3 weeks ago
..
codebase src: remove unused enum values 9 months ago
contributing doc: add ai tool guidelines to contribution guide 4 weeks ago
extending doc: update the SSH docs for the reworked state machine 3 weeks ago
internals doc: add doc on internals of inspection of raw data 1 year ago
libsuricata doc: adjust for master to main rename 1 year ago
upgrading doc/devguide: explain alert logging changes 12 months ago
README.md devguide: update readme 5 years ago
index.rst devguide: add an upgrade section 3 years ago

README.md

Suricata Developer Guide

This directory contains the Suricata Developer's Guide. It is built as part of the Suricata Userguide.

The Sequence Diagrams seen in the Transactions documentation are generated with Mscgen. Mscgen is a small program to parse Message Sequence Charts that can be represented as text and can then converted to image.

If you need to update the diagrams, please edit the .msc files present in the diagrams directory (extending/app-layer/diagrams). Once those have been changed, in the scripts directory (in the main Suricata dir) there's a scrip that will generate images for all files: generate-images.sh (you'll have to install Mscgen for that to work).

More info about Mscgen can be found at: https://www.mcternan.me.uk/mscgen/