Jason Ish
5f598931ac
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
14daa42e0b
doc/userguide: dataset upgrade notes
2 years ago
Jason Ish
4a97461f9a
doc/userguide: notes about Lua rules being disabled by default
2 years ago
Juliana Fajardini
c0db25d055
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
2 years ago
Juliana Fajardini
0c2922f02e
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
2 years ago
Philippe Antoine
415b036dca
http1: implement http.request_header
...
So that it is generic for HTTP1 and HTTP2
Ticket: #5780
2 years ago
Philippe Antoine
7256ec8a6e
detect/http2: do not escape ':' in header name or value
...
for keywords http.request_header and http.response_header
Ticket: #5780
2 years ago
Philippe Antoine
656554f293
http2: rename http2.header to http.request_header
...
Or http.response_header based on the direction
http2.header had a different behavior than http.header and this was
confusing.
Ticket: #5780
2 years ago
Philippe Antoine
e30f4943ae
doc: GitHub PRs workflow
2 years ago
Jeremy MountainJohnson
435d74d744
userguide/install: add info on arch-based installs
...
Add Arch AUR information for installation on Arch-based distros.
2 years ago
Philippe Antoine
5c419b79b7
doc: upgrade guide for logging http custom headers
...
Ticket: #5320
2 years ago
Juliana Fajardini
f83c67bbb5
doc: add missing rule to engine-analysis section
...
The first report didn't have an example rule to go with.
2 years ago
Lukas Sismis
11c3aa868d
doc: add DPDK Bond PMD docs
...
Ticket: #6099
2 years ago
Philippe Antoine
9287cbc33a
http: logs custom headers in a subobject
...
This subobject is request_headers or response_headers
This especially avoids json keys collisions.
Ticket: #5320
Also fixes typo referrer/referer
2 years ago
Jason Ish
5af73b3879
doc/userguide: document include files
...
Document how to use include files, plus add a deprecation notice on
the use of multiple "include" statements.
2 years ago
Jason Ish
a71dee5516
doc/userguide: merge logging changes in 7.0 upgrade notes
...
Two "Logging changes" sections existed, merge.
2 years ago
Jason Ish
f8620d0ed2
docs: update url to docs.suricata.io
2 years ago
Victor Julien
3de687f30c
profiling/rules: doc updates
2 years ago
Eric Leblond
694bff11ac
doc: add rule profiling information
2 years ago
Jason Ish
b0c329da04
doc/userguide: provide more RPM doc
...
- Address the various RPM distributions
- User info
- Systemd info
Related issue: #5884
2 years ago
Eloy Pérez González
b3c7130749
krb5: update krb5_msg_type keyword docs
2 years ago
Lukas Sismis
1c3cb1e8cc
docs: refactor DPDK docs and add performance tuning section
...
Ticket: #5857
Ticket: #5858
2 years ago
Lukas Sismis
03319263db
docs: wrap DPDK doc section at 80 chars
2 years ago
Lukas Sismis
d0bf3ba638
dpdk: add configure option
...
Ticket: #5859
2 years ago
Victor Julien
0903536fd6
doc: spelling
...
Thanks to Josh Soref.
2 years ago
Philippe Antoine
9bd2b72e2b
doc: explain where tls.store stores certificates
...
By adding a reference/link to the doc about the suricata.yaml
config section pecifying the directory where the certificates
are stored
2 years ago
Victor Julien
c0d9b3c078
doc/userguide: spelling
2 years ago
Victor Julien
4dbdaf8a8e
doc/install: point to userguide
2 years ago
Victor Julien
19cabc9a02
doc: remove legacy windows install guide
2 years ago
Victor Julien
01f43604b9
doc: remove legacy pfring install guide
2 years ago
Wes Hurd
aee41957e1
doc: add docutils.conf to disable smart quotes
2 years ago
Andreas Herz
3045e75ee1
doc: add note on the hashsize recommendation for datasets
2 years ago
Victor Julien
a006aef4d0
doc: fix description of iptables rules
2 years ago
Bazzan Don
38b3fffbc7
doc/optimization: move "convert.py" to Python3
...
Ticket: #5596
2 years ago
Morris Chan
b9aac6dd18
yaml: grammar fixup
2 years ago
Juliana Fajardini
ae2a477978
devguide: clarify clang formatting changes policy
...
It was pointed out by a contributor that our workflow mentioned
rewrite-branch as the preferred way, while in fact our policy is to add
said changes to a different commit. Updating documentation to prevent
other situations like that.
2 years ago
Rafael Girão
6ec3bc189a
docs: remove obsolete af-packet warning
2 years ago
John Dewey
365bec3da6
netmap: Correct LB + Netmap YAML usage
...
Corrected the example YAML configuration when using Netmap and
LB.
2 years ago
Jeff Lucovsky
0ad6d4358f
add to doc/pfring: Document additional cluster types
2 years ago
Jeff Lucovsky
b1918168f9
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
2 years ago
Philippe Antoine
59734d16a1
detect: use http.connection to client
...
Ticket: #5746
2 years ago
Philippe Antoine
6bc7f02e13
doc: rules can have http1 as protocol
...
Ticket: #5962
2 years ago
Jeff Lucovsky
fd46c93a8f
doc/byte_math: Add divide by 0 discussion.
...
Issue: 5945
2 years ago
Juliana Fajardini
d314b57e6b
userguide/muti-tenant: fix typo
2 years ago
jason taylor
5abcd50142
doc: add tenant id value requirement
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
2 years ago
Juliana Fajardini
31066c7c3b
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
2 years ago
Jeff Lucovsky
35bbdf4124
doc/content: Add limits for distance/within
...
Ticket: 5740
2 years ago
Philippe Antoine
8f9cd8ff1a
doc: security.limit-noproc upgrade note
...
Ticket: #5621
2 years ago
Shivani Bhardwaj
0f3e7761da
doc: add dataset examples
2 years ago
Lancer Cheng
6142593a69
doc: add version filed in NTLMSSP documentation
...
Bug OISF#5783
2 years ago
Haleema Khan
609df1776e
userguide: update tls keywords information
...
Ticket #5544
3 years ago
jason taylor
8e5b1fe8e6
userguide: add DHCP EVE log information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Victor Julien
f4fa51986e
doc: warn IPS users on new exception policy default
3 years ago
Philippe Antoine
e3105a6614
ftp: adds a config option ftp-hash for autofp-scheduler
...
This allows ftp-data and ftp flows to be processed by the same
thread. Otherwise, there may be a concurrency issue where the
would-be ftp-data flow is first processed, and thus not recognized
as such. And the ftp flow gets processed later and the expectation
coming from it is never found.
To do so, the flow hash gets used as usual, except for flows that
may be either ftp or ftp-data, that is either one port is 21, or
both ports are high ones.
Ticket: #5205
3 years ago
Jason Ish
1b844cd7f7
doc/userguide: document --include command line option
3 years ago
Philippe Antoine
b52293b609
dcerpc: config limit maximum number of live transactions
...
As is done for other protocols
Ticket: #5779
3 years ago
Juliana Fajardini
918bd7435c
userguide/config: update log format symbols list
...
There were some possible format options missing after the recent changes
in the log format.
3 years ago
Juliana Fajardini
0d9289014b
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
3 years ago
jason taylor
0632233791
userguide: update http.cookie description
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Philippe Antoine
55c4834e4e
smb: configurable max number of transactions per flow
...
Ticket: #5753
3 years ago
Jason Ish
48f0fd3c74
doc/userguide: update logging section for time formats
...
- Update fragment of configuration file to match suricata.yaml with
new default-log-format.
- Document new %z format specifier.
3 years ago
Juliana Fajardini
4c7ca2c367
devguide/install: add note about ubuntu version
...
We want to make it clear with which system the instructions for
installing from were tested with.
3 years ago
Juliana Fajardini
377885f420
exception-policies: fix typos
3 years ago
Bazzan Don
6e4a5cee7a
devguide: add page on installing suricata from git
...
As part of the process of moving documentation from redmine
to "Read the Docs", this commit moves installing Suricata using git
page from redmine wiki into Suricata Developer Guide section.
It also updates the necessary steps.
Ticket: #5585
3 years ago
Jason Ish
0a4e3d0f82
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
3 years ago
Richard McConnell
b39a4c63fe
doc: document AF_XDP feature
3 years ago
Todd Mortimer
15c77be937
swf-decompression: Disable by default.
...
Add an entry to the upgrade guide noting the change.
Ticket: #5632
3 years ago
Jeff Lucovsky
197ad51138
doc: Update bsize documentation
...
This commit updates the bsize documentation
1. Describe what happens when "content" immediately precedes "bsize"
2. Include the operators and
3. Include examples using the operators.
3 years ago
jason taylor
9dc8fffe05
userguide: update tos keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
1d9b91a987
userguide: update fragoffset keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
7c73144988
userguide: update fragbits information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
4be9793e36
userguide: update geoip information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
e8eba6e4a1
userguide: update id keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
cfd0da133e
userguide: update ipv6.hdr keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
150a04b597
userguide: update ipv4.hdr keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
298f59c2ba
userguide: update ip_proto keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
6226492976
userguide: update sameip keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
f97ba44339
userguide: update ipopts keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
9b4e6e5802
userguide: update ttl keyword information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Philippe Antoine
ce710181f6
doc: update doc for HTTP file.data to server
...
Ticket: #4144
Completes e587f6792a
3 years ago
Jeff Lucovsky
5a6e68285b
doc/netmap: Describe Netmap IPS usage
...
Issue: 5512
This commit summarizes Netmap usage with Suricata's IPS mode.
3 years ago
Jason Ish
9d653512f9
doc/userguide: update bittorrent-dht eve examples
...
Update the bittorrent-dht examples using real log records with peers
and nodes broken down into objects.
3 years ago
Jason Ish
065f3ab9f1
doc: rename bittorrent-dht to bittorrent_dht in eve output
3 years ago
Jason Ish
0ea9ba66d1
userguide/eve-log: remove mentions of requiring Rust
...
Rust is required to build now.
3 years ago
Aaron Bungay
d166c48d28
docs: update for bittorrent-dht app-layer
3 years ago
Philippe Antoine
a003640ecf
security: prevents process creation
...
with setrlimit NPROC.
So that, if Suricata wants to execve or such to create a new process
the OS will forbid it so that RCE exploits are more painful to write.
Ticket: #5373
3 years ago
Richard McConnell
7f4c1d5e2f
doc/systemd: add documentation for sd_notify
3 years ago
Eric Leblond
9fb0137d9d
doc: add reference to ipaddr in IP matching
3 years ago
Eric Leblond
3bd48d9336
detect: doc link for ip.src and ip.dst
3 years ago
Eric Leblond
da8b16eaeb
doc: add ip.dst and ip.src doc
3 years ago
Eric Leblond
3599cbf1c4
doc: document new dataset types
...
Feature: #5383
3 years ago
Eric Leblond
a1a22cccd2
doc: document dataset-lookup
...
Ticket: #5184
3 years ago
Eric Leblond
20973e9e6b
doc: add dataset-clear command
...
Ticket: #5184
3 years ago
Eric Leblond
c5559cb68f
doc: document dataset-dump command
...
Ticket: #5184
3 years ago
Victor Julien
2f6c014f70
doc/devguide: update packet (de)alloc in unittests
3 years ago
Lukas Sismis
37cf365e19
docs: remove outdated constraint of negation support for ssl_state
...
Commit 487cdda93d
adds negation support for the SSL state.
3 years ago
Juliana Fajardini
e4b46e0763
doc/acknowledgements: add a few more names
...
Added some names of known contributors to the documentation
3 years ago
Juliana Fajardini
3c25185e0b
devguide: add section about stale tickets policy
...
Just to set the right expectations, and to have it registered for us,
too.
3 years ago
Shivani Bhardwaj
2a0cb1f3da
doc: update base64_decode notes
3 years ago
Lukas Sismis
e101384e7b
transversal: remove suricata-ids.org references
3 years ago