]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc: add file.name information to nfs keyword doc
authorjason taylor <jtfas90@gmail.com>
Wed, 20 Sep 2023 21:42:10 +0000 (21:42 +0000)
committerVictor Julien <victor@inliniac.net>
Wed, 6 Dec 2023 14:26:59 +0000 (15:26 +0100)
Signed-off-by: jason taylor <jtfas90@gmail.com>
doc/userguide/rules/index.rst
doc/userguide/rules/nfs-keywords.rst [new file with mode: 0644]

index 76266b33458100a6f4f802dc62a96434d979ef7a..2715da79ac7db5be423f239531f6bb1abfcaa2a4 100644 (file)
@@ -33,6 +33,7 @@ Suricata Rules
    ike-keywords
    http2-keywords
    quic-keywords
+   nfs-keywords
    app-layer
    xbits
    thresholding
diff --git a/doc/userguide/rules/nfs-keywords.rst b/doc/userguide/rules/nfs-keywords.rst
new file mode 100644 (file)
index 0000000..22c3304
--- /dev/null
@@ -0,0 +1,19 @@
+NFS Keywords
+============
+
+.. role:: example-rule-options
+
+file.name
+---------
+
+The ``file.name`` keyword can be used at the NFS application level. 
+
+Signature Example:
+
+.. container:: example-rule
+
+  alert nfs any any -> any any (msg:"NFS file.name usage"; \
+  :example-rule-options:`file.name; content:"file.txt";` \
+  classtype:bad-unknown; sid:1; rev:1;)
+
+For additional information on the ``file.name`` keyword, see :doc:`file-keywords`.
\ No newline at end of file