Skip to content

Commit

Permalink
doc: update file.data keyword documentation
Browse files Browse the repository at this point in the history
Signed-off-by: jason taylor <[email protected]>
(cherry picked from commit abf3fbf)
  • Loading branch information
jmtaylor90 committed Nov 22, 2023
1 parent 2440413 commit 5abb1e4
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
21 changes: 21 additions & 0 deletions doc/userguide/rules/file-keywords.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,27 @@ Suricata comes with several rule keywords to match on various file
properties. They depend on properly configured
:doc:`../file-extraction/file-extraction`.

file.data
---------

The ``file.data`` sticky buffer matches on contents of files that are
seen in flows that Suricata evaluates. The various payload keywords can
be used (e.g. ``startswith``, ``nocase`` and ``bsize``) with ``file.data``.

Example::

alert smtp any any -> any any (msg:"smtp app layer file.data example"; \
file.data; content:"example file content"; sid:1; rev:1)

alert http any any -> any any (msg:"http app layer file.data example"; \
file.data; content:"example file content"; sid:2; rev:1)

alert tcp any any -> any any (msg:"tcp file.data example"; \
file.data; content:"example file content"; sid:4; rev:1)

**Note** file_data is the legacy notation but can still be used.


file.name
---------

Expand Down
2 changes: 1 addition & 1 deletion doc/userguide/rules/http-keywords.rst
Original file line number Diff line number Diff line change
Expand Up @@ -786,4 +786,4 @@ Notes
than 1k, 'content:!"<html"; depth:1024;' can only match if the
pattern '<html' is absent from the first inspected chunk.

- ``file_data`` can also be used with SMTP
- Refer to :doc:`file-keywords` for additional information.
2 changes: 1 addition & 1 deletion src/detect-file-data.c
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ void DetectFiledataRegister(void)
sigmatch_table[DETECT_FILE_DATA].name = "file.data";
sigmatch_table[DETECT_FILE_DATA].alias = "file_data";
sigmatch_table[DETECT_FILE_DATA].desc = "make content keywords match on file data";
sigmatch_table[DETECT_FILE_DATA].url = "/rules/http-keywords.html#file-data";
sigmatch_table[DETECT_FILE_DATA].url = "/rules/file-keywords.html#file-data";
sigmatch_table[DETECT_FILE_DATA].Setup = DetectFiledataSetup;
#ifdef UNITTESTS
sigmatch_table[DETECT_FILE_DATA].RegisterTests = DetectFiledataRegisterTests;
Expand Down

0 comments on commit 5abb1e4

Please sign in to comment.