]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc: Improve tos description 5047/head
authorJeff Lucovsky <jeff@lucovsky.org>
Sat, 2 May 2020 14:09:12 +0000 (10:09 -0400)
committerVictor Julien <victor@inliniac.net>
Sat, 6 Jun 2020 12:44:00 +0000 (14:44 +0200)
This commit improves the description of the `tos` keyword by emphasizing
that the value used should adhere to the guidelines in RFC2474. Instead
of specifying the DSCP value directly, right shift the DSCP value and
use that.

doc/userguide/rules/header-keywords.rst

index d1d2d7b88779f6b3587ba33a53bf846f70cc11a0..f407af7f05a5799d161db80cd30414ff1a0770db 100644 (file)
@@ -259,6 +259,13 @@ field. The tos keyword can be have a value from 0 - 255. This field of the
 IP header has been updated by `rfc2474 <https://tools.ietf.org/html/rfc2474>`_
 to include functionality for
 `Differentiated services <https://en.wikipedia.org/wiki/Differentiated_services>`_.
+Note that the value of the field has been defined with the right-most 2 bits having
+the value 0. When specifying a value for tos, ensure that the value follows this.
+
+E.g, instead of specifying the decimal value 34 (hex 22), right shift twice and use
+decimal 136 (hex 88).
+
+You can specify hexadecimal values as with a leading `x`, e.g, `x88`.
 
 Format of tos::