Commit Graph

626 Commits (suricata-6.0.20)

Author SHA1 Message Date
Ralph Eastwood 87ab88dc58 napatech: update docs to remove hba reference
(cherry picked from commit 9865164e75)
1 year ago
Philippe Antoine 47c5d2b0fa doc: fix byte_test examples
As this keyword has 4 mandatory arguments, and some examples
had only three...

Ticket: 6629
(cherry picked from commit 4933b817aa)
2 years ago
Lukas Sismis 78c9722243 doc: update userguide installation instructions
The commit updates obsolete installation instructions
from the userguide and reformats certain parts for
improved clarity.

Ticket: #5988
2 years ago
jason taylor a94254b53b doc: update file.data keyword documentation
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
Juliana Fajardini 57a7d2830d userguide: update tls not_after/not_before mentions
Our tls fields not_after and not_before are actually logged as
`notafter` and `notbefore`, but were documented with the underscore.

Update the documentation, since updating the log format itself would be
a breaking change.

Task #5494

(cherry picked from commit a649a92afd)
2 years ago
Travis Green d12a544891 doc: add tcp flags documentation
Signed-off-by: jason taylor <jtfas90@gmail.com>
(cherry picked from commit 96a0e7016f)
2 years ago
Juliana Fajardini 6509d201ac docs: adjust readthedocs config to new options
Our documentation was failing to build, seems connected to the new way
of indicating build options (cf
https://readthedocs.org/projects/suricata/builds/22112658/,
https://docs.readthedocs.io/en/stable/config-file/v2.html#build,
and https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os).

Added the build.os required new field, and adjusted the way python
version is passed.

For the new configuration style for read the docs, one of the ways to
pass extra configuration for python is having a requirements file.

(cherry picked from commit 1a132f454a)
2 years ago
Jason Ish 4257725dc0 readthedocs: pin theme to sphinx_rtd_theme
ReadTheDocs changed the default theme.
2 years ago
jason taylor 0e6e5f562d userguide: add details about tcp flow pass
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
jason taylor 5a6700e2b6 doc: hyperscan information updated
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
jason taylor 5bff34860f doc: update file.name keyword information
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
jason taylor ee9637f5a7 doc: update fileext keyword information
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
jason taylor fba868a94e doc: update file.magic information
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
Juliana Fajardini 8bc6514e02 userguide/install: add info on ubuntu ppa installs
Bringing info that was only in our Redmine wiki to our documentation,
and update package to Suricata-6.0, now that the stable points to
Suricata 7.

Task #6231

(cherry picked from commit 4fd3205bf0)
2 years ago
Juliana Fajardini 15b100bc4c userguide/eve: format and reorganize alert section
The `field action` portion seemed to be comprised of a more generic
section that followed it. Also formatted the section for lines to be
within the character limit.

(cherry picked from commit 9900bdc162)
2 years ago
Juliana Fajardini 5eeb81563f output/drop: add verdict field
Related to
Bug #5464

(cherry picked from commit 0437173848)
2 years ago
Juliana Fajardini bbfc445b4a exception: fix use of master switch with default
If an exception policy wasn't set up individually, use the GetDefault
function to pick one. This will check for the master switch option and
handle 'auto' cases.

Instead of deciding what the auto value should be when we are parsing
the master switch, leave that for when some of the other policies is to
be set via the master switch, when since this can change for specific
exception policies - like for midstream, for instance.

Update exceptions policies documentation to clarify that the default
configuration in IPS when midstream is enabled is `ignore`, not
`drop-flow`.

Bug #6169

(cherry picked from commit e306bc6ecc)
2 years ago
Juliana Fajardini 82aa48f0e8 userguide: update exception policy behaviors table
Some exception policies can only be applied to the triggering packet or
only make sense considering the whole flow. Highlight such cases in the
table showing each exception policy.

Related to
Bug #5825

(cherry picked from commit c0db25d055)
2 years ago
Juliana Fajardini 63b2792f65 doc: add midstream scenarios for exception policy
The different interactions between midstream pick-up sessions and the
exception policy can be quite difficult to visualize. Add a section for
that in the userguide.

Related to
Bug #5825

(cherry picked from commit 0c2922f02e)
2 years ago
Juliana Fajardini 6a32139a65 exceptions: add master switch config option
This allows all traffic Exception Policies to be set from one
configuration point. All exception policy options are available in IPS
mode. Bypass, pass and auto (disabled) are also available in iDS mode

Exception Policies set up individually will overwrite this setup for the
given traffic exception.

Task #5219

(cherry picked from commit 0d9289014b)
2 years ago
Jason Ish e6774b1203 doc/devguide: language fix for sphinx
Newer Sphinx does not allow a language of none, set to "en" like we do
for the user guide.
2 years ago
Shivani Bhardwaj f578fd0379 doc: fix typo encryption-handling
(cherry picked from commit aeb408dd9d)
2 years ago
Jason Ish f9a0bbe0f3 doc/userguide: start on a security chapter
This is the start of a security consideration chapter, starting with
directions on how to run Suricata as a non-root user.
2 years ago
Jason Ish 27bda31af0 doc/userguide: dataset upgrade notes 2 years ago
Jason Ish ea3a470eb9 doc/userguide: notes about Lua rules being disabled by default 2 years ago
Morris Chan e10cd5618b yaml: grammar fixup
(cherry picked from commit b9aac6dd18)
2 years ago
Victor Julien 017c689078 doc: fix description of iptables rules
(cherry picked from commit a006aef4d0)
2 years ago
Andreas Herz c9bde24756 doc: add note on the hashsize recommendation for datasets
(cherry picked from commit 3045e75ee1)
2 years ago
Victor Julien 653379fb01 doc/install: point to userguide
(cherry picked from commit 4dbdaf8a8e)
2 years ago
Victor Julien b63ea6e584 doc: remove legacy windows install guide
(cherry picked from commit 19cabc9a02)
2 years ago
Victor Julien 8d316f7de5 doc: remove legacy pfring install guide
(cherry picked from commit 01f43604b9)
2 years ago
Wes Hurd e7690edb21 doc: add docutils.conf to disable smart quotes
(cherry picked from commit aee41957e1)
2 years ago
Jeff Lucovsky 0730fdcd6b add to doc/pfring: Document additional cluster types
(cherry picked from commit 0ad6d4358f)
2 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)
2 years ago
Jeff Lucovsky 7dc4bf740a doc/byte_math: Add divide by 0 discussion.
Issue: 5945
(cherry picked from commit fd46c93a8f)
2 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)
2 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 3 years ago
Lukas Sismis 12cc71447f transversal: backport: replace remaining website references 3 years ago
Lukas Sismis afbd68ad22 transversal: remove suricata-ids.org references
(cherry picked from commit e101384e7b)
3 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
3 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.
3 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)
3 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)
3 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)
3 years ago
Juliana Fajardini 6f360471e3 userguide: add section about HTTP2 settings
This was in master but not in 60x yet.
3 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)
3 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)
3 years ago