Juliana Fajardini
ef54f36e34
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
3 years ago
Juliana Fajardini
3c74e443bd
userguide: update defrag settings options
...
We were still mentioning that there were only three options.
3 years ago
Juliana Fajardini
0cc040cf61
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
3 years ago
Shivani Bhardwaj
a77977ec62
doc: add description for tls.random
3 years ago
jason taylor
c29942c029
userguide: update dsize documentation/examples
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Philippe Antoine
461725a9bf
dhcp: adds leasetime keyword
...
As it is logged
Ticket: #5435
3 years ago
Shivani Bhardwaj
2c4d6b33ae
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).
3 years ago
Benjamin Wilkins
3b1b9a32fb
doc: Document SCByteVarGet lua function
...
Add documentation for accessing results from byte_extract and byte_math
in lua match functions
Issue: 2871
3 years ago
Philippe Antoine
5c7b5c5fb5
krb: detection for ticket encryption
...
As is done for logging.
Ticket: #5442
3 years ago
Jufajardini Reichow
61f9f0df55
userguide/rules/meta: minor formatting adjustments
3 years ago
Jufajardini Reichow
45f14bb97c
userguide/rules: explain sid uniqueness within gid
...
While Suri will throw an error if two signatures have the same `sid`
and no `gid`, or same `sid` and same `gid`, it will just accept same
`sid` for different `gid`s.
Related to
Task #5441
3 years ago
jason taylor
87990b138c
doc: update priority wording userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
a7d739a05b
doc: update to 80 char formatting userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
9bd55ff81b
doc: metadata information update userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
563dc66837
doc: update priority information userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
f73a60eb89
doc: update reference section in userguide meta
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
e611ef5ccb
doc: update userguide meta classtype information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
39bc56ec97
doc: update rev and gid userguide meta wording
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
b9cb66c58f
doc: add clarity around userguide meta information
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
790ef9a53f
doc: add sid reserved range reference
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
38a179d89d
doc: add clarity to rule msg tips
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
299a931e49
doc: update example rule list
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
98c29da6ec
doc: add clarity to role wording
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
c0bdb6cc10
doc: meta keyword doc example rule update
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
ca9e9009ba
doc: add bsize keyword examples
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Jufajardini Reichow
f9c9091bb5
userguide: fix typo in inline mode illustration
...
The image describing Suricata's sliding window had two of the "packets"
with the same text. Now they actually give the sense of a sliding
window.
This was found by Zhiyuan-liao.
3 years ago
jason taylor
34e0a384ad
doc: update to include additional rule references
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
4405704372
doc: update intro direction content
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
3eeacf8a3d
doc: fixed HOME_NET/EXTERNAL example formatting
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
f2c7998903
doc: add clarity around HOME_NET/EXTERNAL_NET
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
76cca8b08a
doc: minor example rule description update
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
4f61a35fe7
doc: minor wording restructure
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
845ba154a6
doc: add tcp-pkt/tcp-stream to intro
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
56f49bfe8e
doc: minor punctuation update
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
ab300ab0ae
doc: intro example rule update to simpler example
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
2f240230f0
doc: minor intro wording update
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Philippe Antoine
c7214be99b
snmp: adds usm keyword
...
as is logged
Ticker: #5416
3 years ago
Juliana Fajardini
45b7aad2b5
devguide: incorporate contribution process page
...
That page existed only in our redmine. Updated and added a few things,
like a paragraph about our expectations for feature contributors.
Also updated links, contacts and some other processes that may have
changed since last edition.
Added some section labels in related documents, for ease of referencing.
Task #4929
3 years ago
Andreas Dolp
db73a12540
doc/tls: Add documentation for TLS logging
3 years ago
Andreas Dolp
f42bb45ccd
doc/tls: Remove redundant example
3 years ago
Andreas Dolp
324f5ec10c
doc: Add missing ")" in example
3 years ago
Andreas Dolp
e4163c4e02
doc: Fix typos
3 years ago
Andreas Dolp
49bd6cfa5d
doc: Fix broken link
3 years ago
Eric Leblond
6f06f7c22c
doc: add info about capture_file key
3 years ago
Eric Leblond
0c7e4c13a1
doc: add conditional pcap logging info
3 years ago
jason taylor
d799956348
doc: add note about file.data and file_data
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
83f2056d20
doc: update file_data to file.data keyword
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
cd54d0dbc8
doc: remove extra newline in order to match style
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
jason taylor
38bd775ca0
doc: remove extraneous + characters
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
3 years ago
Jason Ish
6ceeb08351
doc/userguide: updates for eve dns v1 removal
...
Ticket: #4157
3 years ago
Juliana Fajardini
1956dc3d5d
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
3 years ago
Juliana Fajardini
49542d0f1b
doc/userguide: explain packet-alert-max config
...
Task #4207
3 years ago
Jason Ish
7d6bc60abb
doc/userguide: document ftp max-line-length
3 years ago
Victor Julien
976748b777
doc/smb: add resource limits section
3 years ago
William Harding
f0528afc2d
doc/userguide: sphinx syntax correction
3 years ago
Juliana Fajardini
55843aee8e
devguide: update readme
...
Use it to explain how to go about the sequence diagram images
(generation, updating, what is mscgen etc).
Also remove portion that referred to Sphinx builds, as these don't make
sense now.
3 years ago
Juliana Fajardini
e0c8dba7ac
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.
3 years ago
Juliana Fajardini
67af1504b3
devguide: drop use of mscgen script in builds/make
...
Currently, it seems easier to upload the diagram images to git than to
try to make the image generation script work with out of the tree builds
and other corner cases.
This means, however, that one must activelly remember to update msc
diagram files, run the script and re-add new png files, if those ever
need to be updated. To raise awareness to that, a watermark was added
to the diagram images.
Also removed configuration steps that added mscgen as dependency
(locally and for workflow builds and readthedocs).
3 years ago
Juliana Fajardini
5d63613c4b
devguide: add watermark to sequence diagrams
...
Make it more evident that the sequence diagrams in the transactions
page are generated with Mscgen
3 years ago
Juliana Fajardini
6f77c722a2
devguide: move into userguide as last chapter
...
Moved devguide dir into userguide dir.
Since the devguide is now incorporated as the last chapter of the
userguide, removed build and configuration files from the devguide
dir, as these are no longer needed.
Task #4909
3 years ago
Philippe Antoine
cfcade58ad
http: move xff logging to alert object
...
Ticket: 4860
instead of root field
3 years ago
Andreas Dolp
d4144c04cd
Doc: Fix typo in documentation of suricata.yaml.
3 years ago
Shivani Bhardwaj
015c9fe1e3
doc: add usage of flowbits OR op
...
Ticket 5130
3 years ago
Jeff Lucovsky
117e11b0ae
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.
3 years ago
Victor Julien
e04fcfcf2f
doc/userguide: minor rewording and reformatting for runmodes
3 years ago
Philippe Antoine
8adf172ab8
nfs: limits the number of active transactions per flow
...
Ticket: 4530
3 years ago
Philippe Antoine
11d3af551b
doc: suricata.yaml fields about maximum transactions
...
For HTTP2, MQTT and FTP.
3 years ago
Juliana Fajardini
579d7dcc01
pgsql: add initial support
...
- add nom parsers for decoding most messages from StartupPhase and
SimpleQuery subprotocols
- add unittests
- tests/fuzz: add pgsql to confyaml
Feature: #4241
3 years ago
Victor Julien
cf4ddab6f4
doc/quic: update for new quic.version logic
3 years ago
Emmanuel Thompson
6641efb74f
doc/quic: Add documentation for QUIC keywords
3 years ago
Emmanuel Thompson
9ad60e7661
doc/quic: Add quic to eve json format
3 years ago
Andreas Dolp
f714484591
Doc: Fix typos in documentation of suricata.yaml.
3 years ago
Philippe Antoine
0cfdec1266
detect: xor transform
...
Ticket: 3285
The xor transform applies xor decoding to a buffer, with a key
specified as an option in hexadecimal. Arbitrary key sizes are
accepted.
3 years ago
Jason Ish
cda11b8d97
doc/update: mention change of default rule path
3 years ago
Jason Ish
8071d8239e
doc: update rule section to current default
...
Update the rule section to better describe whats seen in a default
install of Suricata including a link to the rule management section.
3 years ago
Jeff Lucovsky
93842aa14a
doc/yaml: Signal-termination option description
3 years ago
Juliana Fajardini
de0ce26e3f
userguide: update references to Suricata website
...
Many places were still referencing the old Suricata page.
Used git grep with replace to update them. Checked that new links work.
Left old references when they were only documentation examples (for
output or unittests).
Task#4915
3 years ago
Juliana Fajardini
7b20488d4e
userguide: fix low-hanging typos Config page
3 years ago
Odin Jenseg
2a5d79e426
doc/eve-json-format/dns: Describing Z-bit
3 years ago
Lukas Sismis
dab3274263
dpdk: add documentation for the DPDK runmode
...
Briefly present the DPDK runmode through configuration file.
3 years ago
Lukas Sismis
e4b5239202
doc: fix typo in "Stream engine" documentation
3 years ago
Philippe Antoine
27dd0c6b3d
eve/ftp-data: log alert metadata in ftp-data object
...
Ticket: 4860
instead of directly in root
3 years ago
Juliana Fajardini
7c636d25c7
userguide: (nit) fix typo in lua-output page
3 years ago
Juliana Fajardini
4256c1ccd5
userguide: rename pg Lua Scripting->Lua Detection
...
Since we can have scripts for output _or_ detection, it seems more
clear to rename this page to add more meaning
3 years ago
Juliana Fajardini
59e5a21fca
userguide: update buffers list for lua-scripting
3 years ago
Juliana Fajardini
e7f1736f3a
userguide/lua: add explanation about `need` diffs
...
The differences on how the `need` key works, depending on script
usage (output or detection) confuses users, sometimes (cf doc#4725).
While we don't fix that, just explain this behavior.
3 years ago
Andreas Dolp
b25350ee13
doc: Fix typo in documentation of rule keyword flow
3 years ago
Juliana Fajardini
fc958e9e89
userguide: update wiresharkwiki in public datasets
3 years ago
Philippe Antoine
bce3c46874
pcre2: remove PCRE1 as dependency
3 years ago
Philippe Antoine
fae7389ae2
pcre2: document the behavioral changes
3 years ago
Juliana Fajardini
751906b71d
doc/lua-functions: add sha items to SCFileInfo doc
4 years ago
Jason Ish
2cff811609
doc: remove prelude and document as removed
4 years ago
Jason Ish
3e9d1e813a
doc/upgrade: move ike logging changes to 7.0 changes
...
Was mistakenly put in 6.0 changes.
4 years ago
Jason Ish
f56634ac46
doc/upgrade: mention that nss is no longer required
4 years ago
Lukas Sismis
71196098a1
doc: Update public-data-sets.rst
...
Replace dead link
Dataset on ll.mit.edu returns 404. Link updated with a search result of more datasets.
4 years ago
Joshua Lumb
cf9b2b5fd1
detect-dsize: Add ! operator for dsize matching
4 years ago
myr463
755124763d
doc: escape dot in pcre
4 years ago
Shivani Bhardwaj
51be8f0238
doc/dcerpc: add proto keywords
4 years ago
showipintbri
a39025bf24
doc: Grammar Correction
4 years ago
Juliana Fajardini
6b8b58f98a
doc/eve: common fields and alert updates
...
- update examples for both
- change app_proto from alert field to common field, as
per JsonBuilder's changes.
4 years ago
Juliana Fajardini
eacf933edf
doc/eve: fix typos
4 years ago
Philippe Antoine
95f225e8fb
doc: update sphinx api to use add_css_file
...
instead of deprecated add_stylesheet
4 years ago
Jeff Lucovsky
fcd1ae3bf1
doc: Protocol name/case change for upgrade doc
...
This commit adds a one-liner to the upgrade document for 7.0 stating
that protocol names/values are now builtin to Suricata and that names
and their casing may change.
4 years ago
Simon Dugas
0ed62e93ec
doc/modbus: add eve logging documentation
4 years ago
frank honza
f83d51d0cb
ike: set event for multiple server proposals
4 years ago
Andreas Herz
a5f36eccf1
doc: add documentation for rawbytes keyword
4 years ago
frank honza
ab59ef0d79
ikev1: add documentation for ikev1
4 years ago
frank honza
ecdf9f6b0b
ikev1: rename ikev2 to common ike
...
Renaming was done with shell commands, git mv for moving the files and content like
find -iname '*.c' | xargs sed -i 's/ikev1/ike/g' respecting the different mixes of upper/lower case.
4 years ago
Shivani Bhardwaj
d708744f2b
doc: fix ubuntu pkg name for tcmalloc
4 years ago
Jason Ish
560974b2db
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.
4 years ago
Josh Stroschein
7ece0ac31f
doc: update installation documentation for CentOS and Fedora
4 years ago
Philippe Antoine
a04b5566a6
http: makes decompression time limit configurable
4 years ago
Jeff Lucovsky
25e9483168
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".
4 years ago
Jason Ish
547afcb983
doc/userguide/transforms: remove not about libnss being required
4 years ago
Jason Ish
41591af48b
doc/userguide/install: remove libnss
4 years ago
Jason Ish
4b9af8d2ce
doc/userguide: document --disable-hashing
4 years ago
Jason Ish
c0ddad8e7e
doc/ja3: libnss support no longer required
4 years ago
Kirby Kuehl
5499a6f7cd
doc: fix URL for unix-socket python example
4 years ago
Sascha Steinbiss
f78f444a5e
doc: build all manpages
4 years ago
Carl Smith
9b840104bd
lua: Make the rule action available to output scripts
...
Useful for those that want to do custom logging from lua
4 years ago
Justin Ossevoort
320de5f43d
eve: Log tenant_id for all eve-json messages
4 years ago
Sascha Steinbiss
15c42e0d83
doc: add documentation for SRV DNS JSON structure
4 years ago
Philippe Antoine
096dce4bba
http2: allow filestore to work with HTTP2
4 years ago
Philippe Antoine
4e242645be
doc: explicit header normalization further
...
And their concatenation as described in RFC 2616
4 years ago
Philippe Antoine
6b30890de9
doc: http.uri.raw has no spaces
...
as they are in the protocol
cf bug #2881
4 years ago
Victor Julien
7b4ac8dbab
doc/userguide: update http keywords
4 years ago
Victor Julien
ca47d75c80
doc/userguide: explain --strict-rule-keywords
4 years ago
Jeff Lucovsky
a18a9d3046
doc: New sticky buffer icmpv4.hdr
4 years ago
Phil Young
76de981574
napatech: Added comment indicating that hba will be deprecated
...
HBA will be deprecated in Suricata 7
4 years ago
Jason Ish
3030a3da18
doc: provide eve 1 deprecation date
4 years ago
Victor Julien
c95850c6ce
doc/rules: document config rule option
4 years ago
Jeff Lucovsky
6f9b7e052a
doc/eve: Update threaded filename examples
4 years ago
Jason Ish
f70e1f571e
doc/userguide: add info about --set and lists
5 years ago
Jason Ish
69fffb2dc4
doc/userguide: include man page even when not including pdf
...
Fix a mistake in Makefile.am where the man page was only being
added to the distribution if the PDF was also created. It should
be included even if the PDF cannot be included.
5 years ago
Shivani Bhardwaj
87617b200c
doc/datasets: add info about memcap and hashsize
5 years ago
Jason Ish
7d44e80a50
doc: document removal of unified2
...
And suggest an alternate tool, Meer if compatibility with
Barnyard2 style databases is required.
Redmine ticket:
https://redmine.openinfosecfoundation.org/issues/3497
5 years ago
Jason Ish
e71f2b22fa
doc: add removal of individual json loggers
...
Add link to multiple eve instances as a replacement for this
feature.
5 years ago
Philippe Antoine
9b5c923327
http: disables lzma by default for HTTP
5 years ago
Victor Julien
e1ecb7dc41
doc/datasets: explain reloads, general improvements
5 years ago
Simon Dugas
48da18b081
doc: dns - document additional fields in eve event
...
Documentation of additional fields for soa and sshfp. Also some minor
doc fixes and updates.
5 years ago
Jeff Lucovsky
06f41f608c
doc: Improve grammar, spelling and clarifications
...
This commit improves the overall documentation's grammar, spelling, and
adds clarifications where needed.
5 years ago
jason taylor
b21160a6e3
doc: http.host keyword note for matching on port
...
Signed-off-by: jason taylor <jtfas90@gmail.com>
5 years ago
Odin Jenseg
4549505418
doc/userguide: fix outdated xdp info
5 years ago
Philippe Antoine
999af4f62a
http2: adds documentation
5 years ago
James Dutrisac
8d5e54c046
pcap: recusively reading pcaps / documentation
...
Changes to doc/userguide/partials/options.rst for feature 2363
(reading pcaps recursively)
5 years ago
Sascha Steinbiss
4e1a41a17d
output-json: add MAC address output
...
This commit adds MAC address output to the EVE-JSON format. We follow the
remarks made in Redmine ticket #962 : for packets, log MAC src/dst as a
scalar field in EVE; for flows, log MAC src/dst as lists in EVE. Field names
are different between flow and packet context to avoid type confusion
(src_mac vs. src_macs). Configuration approach and JSON representation is
taken from previous GitHub PR #2700 .
5 years ago
Sascha Steinbiss
c31360070b
rust/mqtt: add MQTT parser
5 years ago
Jeff Lucovsky
a5d30a3220
doc/output: Document multithreaded eve option
5 years ago
Philippe Antoine
1569f3e349
transform: adds url_decode keyword
...
Fixes https://redmine.openinfosecfoundation.org/issues/2689
Adds a new source file to handle this keyword.
And modifies documentation, Makefile, and registration accordingly.
url_decode decodes url-encoded data, ie replacing '+' with space
and '%HH' with its value.
5 years ago
Victor Julien
00cc3c7374
eve/ssh: change hassh logging format
...
Elastic search didn't accept the 'hassh' and 'hassh.string'. It would
see the first 'hassh' as a string and split the second key into a
object 'hassh' with a string member 'string'. So two different types
for 'hassh', so it rejected it.
This patch mimics the ja3(s) logging by creating a 'hassh' object
with 2 members: 'hash', which holds the md5 representation, and
'string' which holds the string representation.
5 years ago