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
Shivani Bhardwaj b21f737aee doc: add doc on internals of inspection of raw data
Explain briefly the internals of inspection of raw data in the following order:
- Stream Engine
- Stream reassembly
- Role of Detection Engine and Applayer Parsers
- High level communication between Stream and Detection Engine
- Relevant suricata.yaml settings

alongwith some diagrams.

Ticket 4351
7 months ago
..
codebase doc/code-style: add rust; minor cleanups 10 months ago
contributing doc: add rst header order recommendation 12 months ago
extending doc/devguide: section with conceptualized steps for adding app-layer 8 months ago
internals doc: add doc on internals of inspection of raw data 7 months ago
libsuricata plugin: document app-layer plugins 1 year ago
upgrading devguide: add an upgrade section 2 years ago
README.md devguide: update readme 4 years ago
index.rst devguide: add an upgrade section 2 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/