[PATCH nft,v2] doc: fix sinopsis of named counter, quota and ct {helper,timeout,expect}

[PATCH nft,v2] doc: fix sinopsis of named counter, quota and ct {helper,timeout,expect}

[Pablo Neira Ayuso]

Sinopsis is not complete. Add examples for counters and quotas.

Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
---
 doc/nft.txt              |  8 +++---
 doc/stateful-objects.txt | 62 ++++++++++++++++++++++++++++++++++++----
 2 files changed, 61 insertions(+), 9 deletions(-)

diff --git a/doc/nft.txt b/doc/nft.txt
index 13fe8b1f6671..c9bb901b85b9 100644
--- a/doc/nft.txt
+++ b/doc/nft.txt
@@ -291,7 +291,7 @@ Effectively, this is the nft-equivalent of *iptables-save* and
 TABLES
 ------
 [verse]
-{*add* | *create*} *table* ['family'] 'table' [*{ flags* 'flags' *; }*]
+{*add* | *create*} *table* ['family'] 'table' [ {*comment* 'comment' *;*'} *{ flags* 'flags' *; }*]
 {*delete* | *list* | *flush*} *table* ['family'] 'table'
 *list tables* ['family']
 *delete table* ['family'] *handle* 'handle'
@@ -344,7 +344,7 @@ add table inet mytable
 CHAINS
 ------
 [verse]
-{*add* | *create*} *chain* ['family'] 'table' 'chain' [*{ type* 'type' *hook* 'hook' [*device* 'device'] *priority* 'priority' *;* [*policy* 'policy' *;*] *}*]
+{*add* | *create*} *chain* ['family'] 'table' 'chain' [*{ type* 'type' *hook* 'hook' [*device* 'device'] *priority* 'priority' *;* [*policy* 'policy' *;*] [*comment* 'comment' *;*'] *}*]
 {*delete* | *list* | *flush*} *chain* ['family'] 'table' 'chain'
 *list chains* ['family']
 *delete chain* ['family'] 'table' *handle* 'handle'
@@ -527,7 +527,7 @@ The sets allowed_hosts and allowed_ports need to be created first. The next
 section describes nft set syntax in more detail.
 
 [verse]
-*add set* ['family'] 'table' 'set' *{ type* 'type' | *typeof* 'expression' *;* [*flags* 'flags' *;*] [*timeout* 'timeout' *;*] [*gc-interval* 'gc-interval' *;*] [*elements = {* 'element'[*,* ...] *} ;*] [*size* 'size' *;*] [*policy* 'policy' *;*] [*auto-merge ;*] *}*
+*add set* ['family'] 'table' 'set' *{ type* 'type' | *typeof* 'expression' *;* [*flags* 'flags' *;*] [*timeout* 'timeout' *;*] [*gc-interval* 'gc-interval' *;*] [*elements = {* 'element'[*,* ...] *} ;*] [*size* 'size' *;*] [*comment* 'comment' *;*'] [*policy* 'policy' *;*] [*auto-merge ;*] *}*
 {*delete* | *list* | *flush*} *set* ['family'] 'table' 'set'
 *list sets* ['family']
 *delete set* ['family'] 'table' *handle* 'handle'
@@ -580,7 +580,7 @@ automatic merge of adjacent/overlapping set elements (only for interval sets) |
 MAPS
 -----
 [verse]
-*add map* ['family'] 'table' 'map' *{ type* 'type' | *typeof* 'expression' [*flags* 'flags' *;*] [*elements = {* 'element'[*,* ...] *} ;*] [*size* 'size' *;*] [*policy* 'policy' *;*] *}*
+*add map* ['family'] 'table' 'map' *{ type* 'type' | *typeof* 'expression' [*flags* 'flags' *;*] [*elements = {* 'element'[*,* ...] *} ;*] [*size* 'size' *;*] [*comment* 'comment' *;*'] [*policy* 'policy' *;*] *}*
 {*delete* | *list* | *flush*} *map* ['family'] 'table' 'map'
 *list maps* ['family']
 
diff --git a/doc/stateful-objects.txt b/doc/stateful-objects.txt
index c7488b28d21e..4972969eb250 100644
--- a/doc/stateful-objects.txt
+++ b/doc/stateful-objects.txt
@@ -1,7 +1,9 @@
 CT HELPER
 ~~~~~~~~~
 [verse]
-*ct helper* 'helper' *{ type* 'type' *protocol* 'protocol' *;* [*l3proto* 'family' *;*] *}*
+*add* *ct helper* ['family'] 'table' 'name' *{ type* 'type' *protocol* 'protocol' *;* [*l3proto* 'family' *;*] *}*
+*delete* *ct helper* ['family'] 'table' 'name'
+*list* *ct helpers*
 
 Ct helper is used to define connection tracking helpers that can then be used in
 combination with the *ct helper set* statement. 'type' and 'protocol' are
@@ -22,6 +24,9 @@ string (e.g. ip)
 |l3proto |
 layer 3 protocol of the helper |
 address family (e.g. ip)
+|comment |
+per ct helper comment field |
+string
 |=================
 
 .defining and assigning ftp helper
@@ -43,7 +48,9 @@ table inet myhelpers {
 CT TIMEOUT
 ~~~~~~~~~~
 [verse]
-*ct timeout* 'name' *{ protocol* 'protocol' *; policy = {* 'state'*:* 'value' [*,* ...] *} ;* [*l3proto* 'family' *;*] *}*
+*add* *ct timeout*  ['family'] 'table' 'name' *{ protocol* 'protocol' *; policy = {* 'state'*:* 'value' [*,* ...] *} ;* [*l3proto* 'family' *;*] *}*
+*delete* *ct timeout* ['family'] 'table' 'name'
+*list* *ct timeouts*
 
 Ct timeout is used to update connection tracking timeout values.Timeout policies are assigned
 with the *ct timeout set* statement. 'protocol' and 'policy' are
@@ -65,6 +72,9 @@ unsigned integer
 |l3proto |
 layer 3 protocol of the timeout object |
 address family (e.g. ip)
+|comment |
+per ct timeout comment field |
+string
 |=================
 
 .defining and assigning ct timeout policy
@@ -98,7 +108,9 @@ sport=41360 dport=22
 CT EXPECTATION
 ~~~~~~~~~~~~~~
 [verse]
-*ct expectation* 'name' *{ protocol* 'protocol' *; dport* 'dport' *; timeout* 'timeout' *; size* 'size' *; [*l3proto* 'family' *;*] *}*
+*add* *ct expectation*  ['family'] 'table' 'name' *{ protocol* 'protocol' *; dport* 'dport' *; timeout* 'timeout' *; size* 'size' *; [*l3proto* 'family' *;*] *}*
+*delete* *ct expectation*  ['family'] 'table' 'name'
+*list* *ct expectations*
 
 Ct expectation is used to create connection expectations. Expectations are
 assigned with the *ct expectation set* statement. 'protocol', 'dport',
@@ -124,6 +136,9 @@ unsigned integer
 |l3proto |
 layer 3 protocol of the expectation object |
 address family (e.g. ip)
+|comment |
+per ct expectation comment field |
+string
 |=================
 
 .defining and assigning ct expectation policy
@@ -147,7 +162,9 @@ table ip filter {
 COUNTER
 ~~~~~~~
 [verse]
-*counter* ['packets bytes']
+*add* *counter* ['family'] 'table' 'name' [*{* [ *packets* 'packets' *bytes* 'bytes' ';' ] [ *comment* 'comment' ';' *}*]
+*delete* *counter* ['family'] 'table' 'name'
+*list* *counters*
 
 .Counter specifications
 [options="header"]
@@ -159,12 +176,31 @@ unsigned integer (64 bit)
 |bytes |
 initial count of bytes |
 unsigned integer (64 bit)
+|comment |
+per counter comment field |
+string
 |=================
 
+.*Using named counters*
+------------------
+nft add counter filter http
+nft add rule filter input tcp dport 80 counter name \"http\"
+------------------
+
+.*Using named counters with maps*
+------------------
+nft add counter filter http
+nft add counter filter https
+nft add rule filter input counter name tcp dport map { 80 : \"http\", 443 : \"https\" }
+------------------
+
 QUOTA
 ~~~~~
 [verse]
-*quota* [*over* | *until*] ['used']
+*add* *quota* ['family'] 'table' 'name' *{* [*over*|*until*] 'bytes' 'BYTE_UNIT' [ *used* 'bytes' 'BYTE_UNIT' ] ';' [ *comment* 'comment' ';' ] *}*
+BYTE_UNIT := bytes | kbytes | mbytes
+*delete* *quota* ['family'] 'table' 'name'
+*list* *quotas*
 
 .Quota specifications
 [options="header"]
@@ -177,4 +213,20 @@ Two arguments, unsigned integer (64 bit) and string: bytes, kbytes, mbytes.
 |used |
 initial value of used quota |
 Two arguments, unsigned integer (64 bit) and string: bytes, kbytes, mbytes
+|comment |
+per quota comment field |
+string
 |=================
+
+.*Using named quotas*
+------------------
+nft add quota filter user123 { over 20 mbytes }
+nft add rule filter input ip saddr 192.168.10.123 quota name \"user123\"
+------------------
+
+.*Using named quotas with maps*
+------------------
+nft add quota filter user123 { over 20 mbytes }
+nft add quota filter user124 { over 20 mbytes }
+nft add rule filter input quota name ip saddr map { 192.168.10.123 : \"user123\", 192.168.10.124 : \"user124\" }
+------------------
-- 
2.20.1

Re: [PATCH nft,v2] doc: fix sinopsis of named counter, quota and ct {helper,timeout,expect}

[Jeremy Sowden]

[-- Attachment #1: Type: text/plain, Size: 7830 bytes --]

On 2021-09-16, at 12:40:09 +0200, Pablo Neira Ayuso wrote:
> Sinopsis is not complete. Add examples for counters and quotas.

That should be "Synopsis".

J.

> Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
> ---
>  doc/nft.txt              |  8 +++---
>  doc/stateful-objects.txt | 62 ++++++++++++++++++++++++++++++++++++----
>  2 files changed, 61 insertions(+), 9 deletions(-)
>
> diff --git a/doc/nft.txt b/doc/nft.txt
> index 13fe8b1f6671..c9bb901b85b9 100644
> --- a/doc/nft.txt
> +++ b/doc/nft.txt
> @@ -291,7 +291,7 @@ Effectively, this is the nft-equivalent of *iptables-save* and
>  TABLES
>  ------
>  [verse]
> -{*add* | *create*} *table* ['family'] 'table' [*{ flags* 'flags' *; }*]
> +{*add* | *create*} *table* ['family'] 'table' [ {*comment* 'comment' *;*'} *{ flags* 'flags' *; }*]
>  {*delete* | *list* | *flush*} *table* ['family'] 'table'
>  *list tables* ['family']
>  *delete table* ['family'] *handle* 'handle'
> @@ -344,7 +344,7 @@ add table inet mytable
>  CHAINS
>  ------
>  [verse]
> -{*add* | *create*} *chain* ['family'] 'table' 'chain' [*{ type* 'type' *hook* 'hook' [*device* 'device'] *priority* 'priority' *;* [*policy* 'policy' *;*] *}*]
> +{*add* | *create*} *chain* ['family'] 'table' 'chain' [*{ type* 'type' *hook* 'hook' [*device* 'device'] *priority* 'priority' *;* [*policy* 'policy' *;*] [*comment* 'comment' *;*'] *}*]
>  {*delete* | *list* | *flush*} *chain* ['family'] 'table' 'chain'
>  *list chains* ['family']
>  *delete chain* ['family'] 'table' *handle* 'handle'
> @@ -527,7 +527,7 @@ The sets allowed_hosts and allowed_ports need to be created first. The next
>  section describes nft set syntax in more detail.
>
>  [verse]
> -*add set* ['family'] 'table' 'set' *{ type* 'type' | *typeof* 'expression' *;* [*flags* 'flags' *;*] [*timeout* 'timeout' *;*] [*gc-interval* 'gc-interval' *;*] [*elements = {* 'element'[*,* ...] *} ;*] [*size* 'size' *;*] [*policy* 'policy' *;*] [*auto-merge ;*] *}*
> +*add set* ['family'] 'table' 'set' *{ type* 'type' | *typeof* 'expression' *;* [*flags* 'flags' *;*] [*timeout* 'timeout' *;*] [*gc-interval* 'gc-interval' *;*] [*elements = {* 'element'[*,* ...] *} ;*] [*size* 'size' *;*] [*comment* 'comment' *;*'] [*policy* 'policy' *;*] [*auto-merge ;*] *}*
>  {*delete* | *list* | *flush*} *set* ['family'] 'table' 'set'
>  *list sets* ['family']
>  *delete set* ['family'] 'table' *handle* 'handle'
> @@ -580,7 +580,7 @@ automatic merge of adjacent/overlapping set elements (only for interval sets) |
>  MAPS
>  -----
>  [verse]
> -*add map* ['family'] 'table' 'map' *{ type* 'type' | *typeof* 'expression' [*flags* 'flags' *;*] [*elements = {* 'element'[*,* ...] *} ;*] [*size* 'size' *;*] [*policy* 'policy' *;*] *}*
> +*add map* ['family'] 'table' 'map' *{ type* 'type' | *typeof* 'expression' [*flags* 'flags' *;*] [*elements = {* 'element'[*,* ...] *} ;*] [*size* 'size' *;*] [*comment* 'comment' *;*'] [*policy* 'policy' *;*] *}*
>  {*delete* | *list* | *flush*} *map* ['family'] 'table' 'map'
>  *list maps* ['family']
>
> diff --git a/doc/stateful-objects.txt b/doc/stateful-objects.txt
> index c7488b28d21e..4972969eb250 100644
> --- a/doc/stateful-objects.txt
> +++ b/doc/stateful-objects.txt
> @@ -1,7 +1,9 @@
>  CT HELPER
>  ~~~~~~~~~
>  [verse]
> -*ct helper* 'helper' *{ type* 'type' *protocol* 'protocol' *;* [*l3proto* 'family' *;*] *}*
> +*add* *ct helper* ['family'] 'table' 'name' *{ type* 'type' *protocol* 'protocol' *;* [*l3proto* 'family' *;*] *}*
> +*delete* *ct helper* ['family'] 'table' 'name'
> +*list* *ct helpers*
>
>  Ct helper is used to define connection tracking helpers that can then be used in
>  combination with the *ct helper set* statement. 'type' and 'protocol' are
> @@ -22,6 +24,9 @@ string (e.g. ip)
>  |l3proto |
>  layer 3 protocol of the helper |
>  address family (e.g. ip)
> +|comment |
> +per ct helper comment field |
> +string
>  |=================
>
>  .defining and assigning ftp helper
> @@ -43,7 +48,9 @@ table inet myhelpers {
>  CT TIMEOUT
>  ~~~~~~~~~~
>  [verse]
> -*ct timeout* 'name' *{ protocol* 'protocol' *; policy = {* 'state'*:* 'value' [*,* ...] *} ;* [*l3proto* 'family' *;*] *}*
> +*add* *ct timeout*  ['family'] 'table' 'name' *{ protocol* 'protocol' *; policy = {* 'state'*:* 'value' [*,* ...] *} ;* [*l3proto* 'family' *;*] *}*
> +*delete* *ct timeout* ['family'] 'table' 'name'
> +*list* *ct timeouts*
>
>  Ct timeout is used to update connection tracking timeout values.Timeout policies are assigned
>  with the *ct timeout set* statement. 'protocol' and 'policy' are
> @@ -65,6 +72,9 @@ unsigned integer
>  |l3proto |
>  layer 3 protocol of the timeout object |
>  address family (e.g. ip)
> +|comment |
> +per ct timeout comment field |
> +string
>  |=================
>
>  .defining and assigning ct timeout policy
> @@ -98,7 +108,9 @@ sport=41360 dport=22
>  CT EXPECTATION
>  ~~~~~~~~~~~~~~
>  [verse]
> -*ct expectation* 'name' *{ protocol* 'protocol' *; dport* 'dport' *; timeout* 'timeout' *; size* 'size' *; [*l3proto* 'family' *;*] *}*
> +*add* *ct expectation*  ['family'] 'table' 'name' *{ protocol* 'protocol' *; dport* 'dport' *; timeout* 'timeout' *; size* 'size' *; [*l3proto* 'family' *;*] *}*
> +*delete* *ct expectation*  ['family'] 'table' 'name'
> +*list* *ct expectations*
>
>  Ct expectation is used to create connection expectations. Expectations are
>  assigned with the *ct expectation set* statement. 'protocol', 'dport',
> @@ -124,6 +136,9 @@ unsigned integer
>  |l3proto |
>  layer 3 protocol of the expectation object |
>  address family (e.g. ip)
> +|comment |
> +per ct expectation comment field |
> +string
>  |=================
>
>  .defining and assigning ct expectation policy
> @@ -147,7 +162,9 @@ table ip filter {
>  COUNTER
>  ~~~~~~~
>  [verse]
> -*counter* ['packets bytes']
> +*add* *counter* ['family'] 'table' 'name' [*{* [ *packets* 'packets' *bytes* 'bytes' ';' ] [ *comment* 'comment' ';' *}*]
> +*delete* *counter* ['family'] 'table' 'name'
> +*list* *counters*
>
>  .Counter specifications
>  [options="header"]
> @@ -159,12 +176,31 @@ unsigned integer (64 bit)
>  |bytes |
>  initial count of bytes |
>  unsigned integer (64 bit)
> +|comment |
> +per counter comment field |
> +string
>  |=================
>
> +.*Using named counters*
> +------------------
> +nft add counter filter http
> +nft add rule filter input tcp dport 80 counter name \"http\"
> +------------------
> +
> +.*Using named counters with maps*
> +------------------
> +nft add counter filter http
> +nft add counter filter https
> +nft add rule filter input counter name tcp dport map { 80 : \"http\", 443 : \"https\" }
> +------------------
> +
>  QUOTA
>  ~~~~~
>  [verse]
> -*quota* [*over* | *until*] ['used']
> +*add* *quota* ['family'] 'table' 'name' *{* [*over*|*until*] 'bytes' 'BYTE_UNIT' [ *used* 'bytes' 'BYTE_UNIT' ] ';' [ *comment* 'comment' ';' ] *}*
> +BYTE_UNIT := bytes | kbytes | mbytes
> +*delete* *quota* ['family'] 'table' 'name'
> +*list* *quotas*
>
>  .Quota specifications
>  [options="header"]
> @@ -177,4 +213,20 @@ Two arguments, unsigned integer (64 bit) and string: bytes, kbytes, mbytes.
>  |used |
>  initial value of used quota |
>  Two arguments, unsigned integer (64 bit) and string: bytes, kbytes, mbytes
> +|comment |
> +per quota comment field |
> +string
>  |=================
> +
> +.*Using named quotas*
> +------------------
> +nft add quota filter user123 { over 20 mbytes }
> +nft add rule filter input ip saddr 192.168.10.123 quota name \"user123\"
> +------------------
> +
> +.*Using named quotas with maps*
> +------------------
> +nft add quota filter user123 { over 20 mbytes }
> +nft add quota filter user124 { over 20 mbytes }
> +nft add rule filter input quota name ip saddr map { 192.168.10.123 : \"user123\", 192.168.10.124 : \"user124\" }
> +------------------
> --
> 2.20.1
>
>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH nft,v2] doc: fix sinopsis of named counter, quota and ct {helper,timeout,expect}

[Pablo Neira Ayuso]

[-- Attachment #1: Type: text/plain, Size: 254 bytes --]

On Thu, Sep 16, 2021 at 11:48:27AM +0100, Jeremy Sowden wrote:
> On 2021-09-16, at 12:40:09 +0200, Pablo Neira Ayuso wrote:
> > Sinopsis is not complete. Add examples for counters and quotas.
> 
> That should be "Synopsis".

Thanks for reviewing.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]