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
Cole Dishington c46308957f flow: optionally use pkt recursion for hash
If a Suricata inline IPS device is routing traffic over a
non-encrypted tunnel, like IPv6 tunnels, packets in a flow
will be dropped and not be matched. e.g.

The following example is a Suricata inline IPS with an IPv6 tunnel:
request: IPv4]ICMP] -> |IPS| -> IPv6]IPv4]ICMP]
reply:              <- |IPS| <- IPv6]IPv4]ICMP]
Both the IPv4 request and IPv6 reply will be seen by Suricata on
ingress. The flows will not be matched due to flow recursion level.

Optionally use pkt recursion level in flow hash. Excluding recursion
level in flow hash allows matching of packet flows and defrag on an
inline IPS Suricata scenario where the IPS device is a tunnel
terminator.

Feature: 6260
2 years ago
..
3rd-party-integration
…
_static
…
appendix doc/userguide: generate eve documentation 2 years ago
capture-hardware doc: update eBPF compilation instructions 2 years ago
configuration flow: optionally use pkt recursion for hash 2 years ago
devguide doc: add guide for ticket title 2 years ago
file-extraction doc/file-extraction: fix highlight syntax 2 years ago
licenses
…
lua doc/userguide: document lua hashlib 2 years ago
manpages
…
output doc: improve documentation about guess-applayer-tx 2 years ago
partials redis: add automatic trimming support for streams 2 years ago
performance userguide: expand documentation for rule profiling 2 years ago
reputation
…
rule-management userguide: expand documentation for rule profiling 2 years ago
rules doc: Add ftp.command sticky buffer 2 years ago
setting-up-ipsinline-for-linux
…
upgrade doc: add napatech plugin upgrade notes 2 years ago
.gitignore doc/userguide: generate eve documentation 2 years ago
Makefile.am doc/userguide: generate eve documentation 2 years ago
Makefile.sphinx
…
README.md
…
acknowledgements.rst
…
command-line-options.rst
…
conf.py doc/userguide: generate eve documentation 2 years ago
convert.py
…
docutils.conf
…
generate-evedoc.sh doc/userguide: generate eve documentation 2 years ago
index.rst doc/userguide: generate eve documentation 2 years ago
initscripts.rst
…
install.rst docs: remove mentions to Suricata-6 2 years ago
make-sense-alerts.rst
…
public-data-sets.rst userguide: update Security Onion docs reference 2 years ago
quickstart.rst
…
requirements.txt
…
security.rst
…
setting-up-ipsinline-for-linux.rst
…
setting-up-ipsinline-for-windows.rst
…
support-status.rst devguide: make 'contributing' a chapter 3 years ago
unix-socket.rst
…
upgrade.rst doc: improve documentation about guess-applayer-tx 2 years ago
verifying-source-files.rst doc: add source verification docs 2 years ago
what-is-suricata.rst
…

README.md

Suricata User Guide

This directory contains the Suricata Guide. The Suricata Developer's guide is included as a chapter of the Guide. The Sphinx Document Generator is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.

Verifying Changes

There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).

The documentation source can be built with make -f Makefile.sphinx html. Substitute the 'html' word for desired output format.

There are different application dependencies based on the output desired.