Commit Graph

601 Commits (809aebfee183c680ae14e4d58316e477fad0dca0)

Author SHA1 Message Date
Morris Chan e10cd5618b yaml: grammar fixup
(cherry picked from commit b9aac6dd18)
3 years ago
Victor Julien 017c689078 doc: fix description of iptables rules
(cherry picked from commit a006aef4d0)
3 years ago
Andreas Herz c9bde24756 doc: add note on the hashsize recommendation for datasets
(cherry picked from commit 3045e75ee1)
3 years ago
Victor Julien 653379fb01 doc/install: point to userguide
(cherry picked from commit 4dbdaf8a8e)
3 years ago
Victor Julien b63ea6e584 doc: remove legacy windows install guide
(cherry picked from commit 19cabc9a02)
3 years ago
Victor Julien 8d316f7de5 doc: remove legacy pfring install guide
(cherry picked from commit 01f43604b9)
3 years ago
Wes Hurd e7690edb21 doc: add docutils.conf to disable smart quotes
(cherry picked from commit aee41957e1)
3 years ago
Jeff Lucovsky 0730fdcd6b add to doc/pfring: Document additional cluster types
(cherry picked from commit 0ad6d4358f)
3 years ago
Jeff Lucovsky 581c06bee5 doc/pfring: Document additional cluster types
This commit adds brief discussion for additional cluster types for use
with the pf-ring packet source.

Newly added:
- cluster_inner_flow
- cluster_inner_flow_2_tuple
- cluster_inner_flow_4_tuple
- cluster_inner_flow_5_tuple

Issue: 5975
(cherry picked from commit b1918168f9)
3 years ago
Jeff Lucovsky 7dc4bf740a doc/byte_math: Add divide by 0 discussion.
Issue: 5945
(cherry picked from commit fd46c93a8f)
3 years ago
Juliana Fajardini 35b275654f docs: clarify exception policy's supported values
As flow.memcap-policy and defrag.memcap-policy do not support flow
actions, clarify that in the documentation. Also fix some typos, and
add missing values in some places where the exception policies were
explained.

Related to
Bug #5940

(cherry picked from commit 31066c7c3b)
3 years ago
Jason Ish 126f06b47e doc/userguide: ubuntu: install software-properties-common
This package likely needs to be installed when starting with an Ubuntu
container or other minimal Ubuntu install.

Ticket: #5616
(cherry picked from commit 0a4e3d0f82)
3 years ago
jason taylor 088cc71e6b userguide: update http2 config header syntax
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Shivani Bhardwaj 6bdcba2588 doc: update base64_decode notes
(cherry picked from commit 2a0cb1f3da)
3 years ago
Lukas Sismis 694d65f937 docs: replace Openhub reference 4 years ago
Lukas Sismis 12cc71447f transversal: backport: replace remaining website references 4 years ago
Lukas Sismis afbd68ad22 transversal: remove suricata-ids.org references
(cherry picked from commit e101384e7b)
4 years ago
Juliana Fajardini 21492a419e userguide: add section about exception policies
This describes briefly what the exception policies are, what is the
engine's behavior, what options are available and to which parts are
they implemented.

Task #5475
Task #5515
4 years ago
Juliana Fajardini 9e571b6a13 userguide: minor rewording and typo fixes
Some of these were recently introduced, some were highlited after the
applayer sections got merged. Some paragraphs seem to have been changed
due to trying to respect character limits for lines. Also includes a
typo pointed out by one of our community members via Discord.
4 years ago
Juliana Fajardini fff9d529b7 exceptions: add reject support to exception policy
This enables the usage of 'reject' as an exception policy. As for both
IPS and IDS modes the intended result of sending a reject packet is to
reject the related flow, this will effectively mean setting the reject
action to the packet that triggered the exception condition, and then
dropping the associated flow.

Task #5503

(cherry picked from commit bbd968c738)
4 years ago
Juliana Fajardini ac67593a0e userguide: briefly introduce exception policy opts
Added them in the configuration section so folks can be more aware of
them, while a more complete documentation isn't around.

Related to
Task #5475

(cherry picked from commit ef54f36e34)
4 years ago
Juliana Fajardini 374e4879a1 userguide: update defrag settings options
We were still mentioning that there were only three options.

(cherry picked from commit 3c74e443bd)
4 years ago
Juliana Fajardini 6f360471e3 userguide: add section about HTTP2 settings
This was in master but not in 60x yet.
4 years ago
Juliana Fajardini 06091e0fc6 userguide: merge sections about AppLayer Parsers
We had two sections under the suricata.yaml configuration section
describing settings for application layer parsers. This merges them into
one and also fixes a few subsection title levels.

Task #5364

(cherry picked from commit 0cc040cf61)
4 years ago
Shivani Bhardwaj 8762699edf doc/conf: fix sphinx language setting
sphinx-build 5.1.1 and above throws a warning which is treated as an
error while building.

Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).

(cherry picked from commit 2c4d6b33ae)
4 years ago
Juliana Fajardini 47243c0839 userguide: dynamically determine copyright date
This uses the date of doc generation to determine the copyright date
for the trailing date. Based on Jeff Lucovsky solution.

(cherry picked from commit e0c8dba7ac)
4 years ago
Juliana Fajardini 4f9c600bed userguide: explain alert queue behavior and stats
Added sections along packet-alert-max config section explaining
packet alert queue overflow (when Suri reaches packet alert max), when
alerts are discarded etc.

Since from the user perspective it shouldn't matter how we process the
alert queue, the term "replace" is used, even though there's not exactly
a replacing action happening, with the queue bein pre-processed before
being appended to the Packet.

Also described the associated stats and added an explanation on when to
change packet-alert-max.

Task #5178

(cherry picked from commit 1956dc3d5d)
4 years ago
Juliana Fajardini 9a1a439bd6 doc/userguide: explain packet-alert-max config
Task #4207

(cherry picked from commit 49542d0f1b)
4 years ago
Jason Ish 746f0236f5 doc/userguide: document ftp max-line-length
(cherry picked from commit 7d6bc60abb)
4 years ago
Victor Julien 6e5b7199cf doc/smb: add resource limits section
(cherry picked from commit 976748b777)
4 years ago
Jeff Lucovsky 1306dbf268 doc/yaml: Signal-termination option description
(cherry picked from commit 93842aa14a)
4 years ago
Shivani Bhardwaj 0e9f42c744 doc/xbits: clarify noalert usage 4 years ago
Jeff Lucovsky 00ab84fd63 doc: Describe per-thread stack size config setting
Issue: 4550

This commit documents the new per-thread stack-size setting. Some
systems have a small default value that is not suitable for Suricata's
multi-threaded architecture and adjustment may be required.

(cherry picked from commit 117e11b0ae)
4 years ago
Shivani Bhardwaj 45745ed2ea doc: add usage of flowbits OR op
Ticket 5130

(cherry picked from commit 015c9fe1e3)
4 years ago
Odin Jenseg 89f453f7e7 doc/eve-json-format/dns: Describing Z-bit
(cherry picked from commit 2a5d79e426)
4 years ago
Juliana Fajardini 30b1e221ce doc/lua-functions: add sha items to SCFileInfo doc
(cherry picked from commit 751906b71d)
5 years ago
Philippe Antoine 590e917e94 http2: document HTTP1 keywords enabling
For HTTP signatures to match on HTTP2 traffic if configure
option app-layer.protocols.http2.http1-rules is enabled
5 years ago
Philippe Antoine b96f9c0dd5 doc: update sphinx api to use add_css_file
instead of deprecated add_stylesheet

(cherry picked from commit 95f225e8fb)
5 years ago
Jason Ish 029e3114b8 doc/quickstart: use new test url that works
Replace http://testmyids.org with http://testmynids.org/uid/index.html,
as testmyids.org now always redirects to https.

(cherry picked from commit 560974b2db)
5 years ago
Josh Stroschein 0eaa64aad5 doc: update installation documentation for CentOS and Fedora
(cherry picked from commit 7ece0ac31f)
5 years ago
Philippe Antoine eb2a5587fb http: makes decompression time limit configurable
(cherry picked from commit a04b5566a6)
5 years ago
Jeff Lucovsky 95df464ba8 doc/lua: Lua API name consistency
This commit updates the documentation of the SCFlow* function names
available to Lua scripts.

Formerly, they used the prefix "Sc"; now they use "SC".

(cherry picked from commit 25e9483168)
5 years ago
Victor Julien 0ad5a38fb4 ci: buildbot is decommissioned, so remove prscript refs
(cherry picked from commit 372fc26739)
5 years ago
Sascha Steinbiss 773545e6d9 doc: build all manpages
(cherry picked from commit f78f444a5e)
5 years ago
Kirby Kuehl 2a8571b3f4 doc: fix URL for unix-socket python example
(cherry picked from commit 5499a6f7cd)
5 years ago
Philippe Antoine 096dce4bba http2: allow filestore to work with HTTP2 5 years ago
Philippe Antoine 4e242645be doc: explicit header normalization further
And their concatenation as described in RFC 2616
5 years ago
Philippe Antoine 6b30890de9 doc: http.uri.raw has no spaces
as they are in the protocol

cf bug #2881
5 years ago
Victor Julien 7b4ac8dbab doc/userguide: update http keywords 6 years ago
Victor Julien ca47d75c80 doc/userguide: explain --strict-rule-keywords 6 years ago