728 Commits (df45fc9e97f49398d4dd0994c436bd38254689ee)

Author	SHA1	Message	Date
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
Juliana Fajardini	69c6657127	devguide: clarify cargo test usage for modules ... The documentation was showing an invalid path for running single tests.	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
Juliana Fajardini	6c616d84b1	devguide: clarify style guide for getframe funcs ... As the GetFrameIdByName can be probed, we must warn developers not to leave any output in them, or misleading messages could be printed. Task #5129	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
Juliana Fajardini	28b5f4a555	devguide: add page about app-layer frame support ... This explains the frame support from the perspective of a developer, with introductory explanation on how to add frame support to an applayer proto. Doc #4697	3 years ago
Philippe Antoine	8adf172ab8	nfs: limits the number of active transactions per flow ... Ticket: 4530	3 years ago
Jason Ish	b9a429e6ce	devguide: move image generation into sphinx setup ... While ReadTheDocs can't execute arbitrary scripts, we can install mscgen in the container that builds the docs (see .readthedocs.yaml). Then instead of calling generate-images.sh from the Makefile, move this into the setup function defined on conf.yaml, which will generate the scripts as part of a normal Sphinx workflow. This should give us an image generation solution that works on ReadTheDocs, and locally within anyones build system provided they have mscgen installed.	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	6ae80b2819	doc: replace ohloh with openhub link	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	c6e97222b7	devguide: add page about rust unittests ... Part of the task to offer better guidance on how and when to write unit tests or suricata-verify tests Also updated linking and index files, as well as testing page to refer to the unit tests pages Doc: #4590	3 years ago
Juliana Fajardini	747d225c84	devguide: repurpose unittests page to unittests-c ... Part of ongoing task to add more guidance on how to create unittests and suricata-verify tests for suri. There will also be a unittests-rust page. Doc: #4590	3 years ago
Juliana Fajardini	5b4c575f3b	devguide: add page about testing ... This page offers guidance about when to use unittests or s-v tests, and how to create input for those. Also lists other common ways to test Suri, such as fuzzing and the CI checks. Doc: #4590	3 years ago
Juliana Fajardini	fc958e9e89	userguide: update wiresharkwiki in public datasets	3 years ago
Juliana Fajardini	dbeb8bfa1f	doc/devguide: add few more explanations & details	3 years ago
Juliana Fajardini	2cd25e8105	devguide/app-layer: rename /img dir to /diagrams ... Semantically speaking it makes more sense, because it stores `msc` files for dynamic image generation. Updated files that refered to `img` accordingly, too.	3 years ago
Juliana Fajardini	f65b3908ed	devguide/transactions: add TSL_STATE enum snippet	3 years ago
Juliana Fajardini	d6c5dfacc7	devguide/transactions: update & refine diagrams ... - DNS sequence diagram was incorrect (transactions should be unidirectional). After changing it, it made sense to rename the file. Adjusted spacing, too. Updated transactions.rst accordingly. - TLS sequence diagram was refined to illustrate how Suricata actually implements the protocol.	3 years ago
Juliana Fajardini	84311ab151	devguide/transactions: fix wordings	3 years ago
Juliana Fajardini	2f3cee2429	devguide/code-style: fix typo in banned functions	3 years ago
Juliana Fajardini	a5b344e015	doc/devguide: add Transactions documentation page ... A guide on what is a transaction for Suricata engine, focusing on developers. - What's the purpose of a transaction; - transaction states and API callbacks; - Examples and sequence diagrams. - doc/devguide: add transactions.rst - doc/devguide/extending/app-layer/index.rst: add transactions.rst	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