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
Philippe Antoine 32d0bd2bbb detect: limit base64_decode `bytes` to 64KiB
Ticket: 7613

Avoids potential large per-thread memory allocation. A buffer with the
size of the largest decode_base64 buffer size setting would be allocated
per thread. As this was a u32, it could mean a per-thread 4GiB memory
allocation.

64KiB was already the built-in default for cases where bytes size wasn't
specified.
10 months ago
..
3rd-party-integration
_static doc/userguide: avoid horizontal scroll on rtd 3 years ago
appendix doc/userguide: generate eve documentation 1 year ago
capture-hardware doc: update eBPF compilation instructions 2 years ago
configuration userguide: explain rule types and categorization 12 months ago
devguide userguide: explain rule types and categorization 12 months ago
file-extraction doc/file-extraction: fix highlight syntax 1 year ago
licenses
lua doc/userguide: document Lua base64 library 11 months ago
manpages userguide/suricatactl: use suricata community page 10 months ago
output doc/output: EVE output buffering related settings 11 months ago
partials doc/output: EVE output buffering related settings 11 months ago
performance doc/userguide: fix typo 11 months ago
reputation doc: spelling 3 years ago
rule-management userguide: expand documentation for rule profiling 1 year ago
rules detect: limit base64_decode `bytes` to 64KiB 10 months ago
setting-up-ipsinline-for-linux
upgrade doc: add napatech plugin upgrade notes 1 year ago
.gitignore doc/userguide: generate eve documentation 1 year ago
Makefile.am dist: include generate-evedoc.sh 11 months ago
Makefile.sphinx
README.md devguide: move into userguide as last chapter 4 years ago
acknowledgements.rst doc/acknowledgements: add a few more names 3 years ago
command-line-options.rst
conf.py doc/userguide: generate eve documentation 1 year ago
convert.py doc/optimization: move "convert.py" to Python3 3 years ago
docutils.conf doc: add docutils.conf to disable smart quotes 3 years ago
generate-evedoc.sh doc/userguide: generate eve documentation 1 year ago
index.rst doc/userguide: generate eve documentation 1 year ago
initscripts.rst
install.rst docs: remove mentions to Suricata-6 1 year ago
make-sense-alerts.rst
public-data-sets.rst userguide: update Security Onion docs reference 1 year ago
quickstart.rst doc/quickstart: add software-properties instruction 2 years ago
requirements.txt docs: adjust readthedocs config to new options 2 years ago
security.rst userguide/security: grammar fixes 3 years ago
setting-up-ipsinline-for-linux.rst doc: fix description of iptables rules 3 years ago
setting-up-ipsinline-for-windows.rst
support-status.rst devguide: make 'contributing' a chapter 2 years ago
unix-socket.rst doc: remove python references related to suricatasc 11 months ago
upgrade.rst doc: add upgrade note about suricatasc and suricatactl 11 months 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.