1 #ifndef _LINUX_NF_TABLES_H
2 #define _LINUX_NF_TABLES_H
3 
4 #define NFT_TABLE_MAXNAMELEN	32
5 #define NFT_CHAIN_MAXNAMELEN	32
6 #define NFT_USERDATA_MAXLEN	256
7 
8 /**
9  * enum nft_registers - nf_tables registers
10  *
11  * nf_tables used to have five registers: a verdict register and four data
12  * registers of size 16. The data registers have been changed to 16 registers
13  * of size 4. For compatibility reasons, the NFT_REG_[1-4] registers still
14  * map to areas of size 16, the 4 byte registers are addressed using
15  * NFT_REG32_00 - NFT_REG32_15.
16  */
17 enum nft_registers {
18 	NFT_REG_VERDICT,
19 	NFT_REG_1,
20 	NFT_REG_2,
21 	NFT_REG_3,
22 	NFT_REG_4,
23 	__NFT_REG_MAX,
24 
25 	NFT_REG32_00	= 8,
26 	MFT_REG32_01,
27 	NFT_REG32_02,
28 	NFT_REG32_03,
29 	NFT_REG32_04,
30 	NFT_REG32_05,
31 	NFT_REG32_06,
32 	NFT_REG32_07,
33 	NFT_REG32_08,
34 	NFT_REG32_09,
35 	NFT_REG32_10,
36 	NFT_REG32_11,
37 	NFT_REG32_12,
38 	NFT_REG32_13,
39 	NFT_REG32_14,
40 	NFT_REG32_15,
41 };
42 #define NFT_REG_MAX	(__NFT_REG_MAX - 1)
43 
44 #define NFT_REG_SIZE	16
45 #define NFT_REG32_SIZE	4
46 
47 /**
48  * enum nft_verdicts - nf_tables internal verdicts
49  *
50  * @NFT_CONTINUE: continue evaluation of the current rule
51  * @NFT_BREAK: terminate evaluation of the current rule
52  * @NFT_JUMP: push the current chain on the jump stack and jump to a chain
53  * @NFT_GOTO: jump to a chain without pushing the current chain on the jump stack
54  * @NFT_RETURN: return to the topmost chain on the jump stack
55  *
56  * The nf_tables verdicts share their numeric space with the netfilter verdicts.
57  */
58 enum nft_verdicts {
59 	NFT_CONTINUE	= -1,
60 	NFT_BREAK	= -2,
61 	NFT_JUMP	= -3,
62 	NFT_GOTO	= -4,
63 	NFT_RETURN	= -5,
64 };
65 
66 /**
67  * enum nf_tables_msg_types - nf_tables netlink message types
68  *
69  * @NFT_MSG_NEWTABLE: create a new table (enum nft_table_attributes)
70  * @NFT_MSG_GETTABLE: get a table (enum nft_table_attributes)
71  * @NFT_MSG_DELTABLE: delete a table (enum nft_table_attributes)
72  * @NFT_MSG_NEWCHAIN: create a new chain (enum nft_chain_attributes)
73  * @NFT_MSG_GETCHAIN: get a chain (enum nft_chain_attributes)
74  * @NFT_MSG_DELCHAIN: delete a chain (enum nft_chain_attributes)
75  * @NFT_MSG_NEWRULE: create a new rule (enum nft_rule_attributes)
76  * @NFT_MSG_GETRULE: get a rule (enum nft_rule_attributes)
77  * @NFT_MSG_DELRULE: delete a rule (enum nft_rule_attributes)
78  * @NFT_MSG_NEWSET: create a new set (enum nft_set_attributes)
79  * @NFT_MSG_GETSET: get a set (enum nft_set_attributes)
80  * @NFT_MSG_DELSET: delete a set (enum nft_set_attributes)
81  * @NFT_MSG_NEWSETELEM: create a new set element (enum nft_set_elem_attributes)
82  * @NFT_MSG_GETSETELEM: get a set element (enum nft_set_elem_attributes)
83  * @NFT_MSG_DELSETELEM: delete a set element (enum nft_set_elem_attributes)
84  * @NFT_MSG_NEWGEN: announce a new generation, only for events (enum nft_gen_attributes)
85  * @NFT_MSG_GETGEN: get the rule-set generation (enum nft_gen_attributes)
86  */
87 enum nf_tables_msg_types {
88 	NFT_MSG_NEWTABLE,
89 	NFT_MSG_GETTABLE,
90 	NFT_MSG_DELTABLE,
91 	NFT_MSG_NEWCHAIN,
92 	NFT_MSG_GETCHAIN,
93 	NFT_MSG_DELCHAIN,
94 	NFT_MSG_NEWRULE,
95 	NFT_MSG_GETRULE,
96 	NFT_MSG_DELRULE,
97 	NFT_MSG_NEWSET,
98 	NFT_MSG_GETSET,
99 	NFT_MSG_DELSET,
100 	NFT_MSG_NEWSETELEM,
101 	NFT_MSG_GETSETELEM,
102 	NFT_MSG_DELSETELEM,
103 	NFT_MSG_NEWGEN,
104 	NFT_MSG_GETGEN,
105 	NFT_MSG_MAX,
106 };
107 
108 /**
109  * enum nft_list_attributes - nf_tables generic list netlink attributes
110  *
111  * @NFTA_LIST_ELEM: list element (NLA_NESTED)
112  */
113 enum nft_list_attributes {
114 	NFTA_LIST_UNPEC,
115 	NFTA_LIST_ELEM,
116 	__NFTA_LIST_MAX
117 };
118 #define NFTA_LIST_MAX		(__NFTA_LIST_MAX - 1)
119 
120 /**
121  * enum nft_hook_attributes - nf_tables netfilter hook netlink attributes
122  *
123  * @NFTA_HOOK_HOOKNUM: netfilter hook number (NLA_U32)
124  * @NFTA_HOOK_PRIORITY: netfilter hook priority (NLA_U32)
125  */
126 enum nft_hook_attributes {
127 	NFTA_HOOK_UNSPEC,
128 	NFTA_HOOK_HOOKNUM,
129 	NFTA_HOOK_PRIORITY,
130 	__NFTA_HOOK_MAX
131 };
132 #define NFTA_HOOK_MAX		(__NFTA_HOOK_MAX - 1)
133 
134 /**
135  * enum nft_table_flags - nf_tables table flags
136  *
137  * @NFT_TABLE_F_DORMANT: this table is not active
138  */
139 enum nft_table_flags {
140 	NFT_TABLE_F_DORMANT	= 0x1,
141 };
142 
143 /**
144  * enum nft_table_attributes - nf_tables table netlink attributes
145  *
146  * @NFTA_TABLE_NAME: name of the table (NLA_STRING)
147  * @NFTA_TABLE_FLAGS: bitmask of enum nft_table_flags (NLA_U32)
148  * @NFTA_TABLE_USE: number of chains in this table (NLA_U32)
149  */
150 enum nft_table_attributes {
151 	NFTA_TABLE_UNSPEC,
152 	NFTA_TABLE_NAME,
153 	NFTA_TABLE_FLAGS,
154 	NFTA_TABLE_USE,
155 	__NFTA_TABLE_MAX
156 };
157 #define NFTA_TABLE_MAX		(__NFTA_TABLE_MAX - 1)
158 
159 /**
160  * enum nft_chain_attributes - nf_tables chain netlink attributes
161  *
162  * @NFTA_CHAIN_TABLE: name of the table containing the chain (NLA_STRING)
163  * @NFTA_CHAIN_HANDLE: numeric handle of the chain (NLA_U64)
164  * @NFTA_CHAIN_NAME: name of the chain (NLA_STRING)
165  * @NFTA_CHAIN_HOOK: hook specification for basechains (NLA_NESTED: nft_hook_attributes)
166  * @NFTA_CHAIN_POLICY: numeric policy of the chain (NLA_U32)
167  * @NFTA_CHAIN_USE: number of references to this chain (NLA_U32)
168  * @NFTA_CHAIN_TYPE: type name of the string (NLA_NUL_STRING)
169  * @NFTA_CHAIN_COUNTERS: counter specification of the chain (NLA_NESTED: nft_counter_attributes)
170  */
171 enum nft_chain_attributes {
172 	NFTA_CHAIN_UNSPEC,
173 	NFTA_CHAIN_TABLE,
174 	NFTA_CHAIN_HANDLE,
175 	NFTA_CHAIN_NAME,
176 	NFTA_CHAIN_HOOK,
177 	NFTA_CHAIN_POLICY,
178 	NFTA_CHAIN_USE,
179 	NFTA_CHAIN_TYPE,
180 	NFTA_CHAIN_COUNTERS,
181 	__NFTA_CHAIN_MAX
182 };
183 #define NFTA_CHAIN_MAX		(__NFTA_CHAIN_MAX - 1)
184 
185 /**
186  * enum nft_rule_attributes - nf_tables rule netlink attributes
187  *
188  * @NFTA_RULE_TABLE: name of the table containing the rule (NLA_STRING)
189  * @NFTA_RULE_CHAIN: name of the chain containing the rule (NLA_STRING)
190  * @NFTA_RULE_HANDLE: numeric handle of the rule (NLA_U64)
191  * @NFTA_RULE_EXPRESSIONS: list of expressions (NLA_NESTED: nft_expr_attributes)
192  * @NFTA_RULE_COMPAT: compatibility specifications of the rule (NLA_NESTED: nft_rule_compat_attributes)
193  * @NFTA_RULE_POSITION: numeric handle of the previous rule (NLA_U64)
194  * @NFTA_RULE_USERDATA: user data (NLA_BINARY, NFT_USERDATA_MAXLEN)
195  */
196 enum nft_rule_attributes {
197 	NFTA_RULE_UNSPEC,
198 	NFTA_RULE_TABLE,
199 	NFTA_RULE_CHAIN,
200 	NFTA_RULE_HANDLE,
201 	NFTA_RULE_EXPRESSIONS,
202 	NFTA_RULE_COMPAT,
203 	NFTA_RULE_POSITION,
204 	NFTA_RULE_USERDATA,
205 	__NFTA_RULE_MAX
206 };
207 #define NFTA_RULE_MAX		(__NFTA_RULE_MAX - 1)
208 
209 /**
210  * enum nft_rule_compat_flags - nf_tables rule compat flags
211  *
212  * @NFT_RULE_COMPAT_F_INV: invert the check result
213  */
214 enum nft_rule_compat_flags {
215 	NFT_RULE_COMPAT_F_INV	= (1 << 1),
216 	NFT_RULE_COMPAT_F_MASK	= NFT_RULE_COMPAT_F_INV,
217 };
218 
219 /**
220  * enum nft_rule_compat_attributes - nf_tables rule compat attributes
221  *
222  * @NFTA_RULE_COMPAT_PROTO: numerice value of handled protocol (NLA_U32)
223  * @NFTA_RULE_COMPAT_FLAGS: bitmask of enum nft_rule_compat_flags (NLA_U32)
224  */
225 enum nft_rule_compat_attributes {
226 	NFTA_RULE_COMPAT_UNSPEC,
227 	NFTA_RULE_COMPAT_PROTO,
228 	NFTA_RULE_COMPAT_FLAGS,
229 	__NFTA_RULE_COMPAT_MAX
230 };
231 #define NFTA_RULE_COMPAT_MAX	(__NFTA_RULE_COMPAT_MAX - 1)
232 
233 /**
234  * enum nft_set_flags - nf_tables set flags
235  *
236  * @NFT_SET_ANONYMOUS: name allocation, automatic cleanup on unlink
237  * @NFT_SET_CONSTANT: set contents may not change while bound
238  * @NFT_SET_INTERVAL: set contains intervals
239  * @NFT_SET_MAP: set is used as a dictionary
240  * @NFT_SET_TIMEOUT: set uses timeouts
241  * @NFT_SET_EVAL: set contains expressions for evaluation
242  */
243 enum nft_set_flags {
244 	NFT_SET_ANONYMOUS		= 0x1,
245 	NFT_SET_CONSTANT		= 0x2,
246 	NFT_SET_INTERVAL		= 0x4,
247 	NFT_SET_MAP			= 0x8,
248 	NFT_SET_TIMEOUT			= 0x10,
249 	NFT_SET_EVAL			= 0x20,
250 };
251 
252 /**
253  * enum nft_set_policies - set selection policy
254  *
255  * @NFT_SET_POL_PERFORMANCE: prefer high performance over low memory use
256  * @NFT_SET_POL_MEMORY: prefer low memory use over high performance
257  */
258 enum nft_set_policies {
259 	NFT_SET_POL_PERFORMANCE,
260 	NFT_SET_POL_MEMORY,
261 };
262 
263 /**
264  * enum nft_set_desc_attributes - set element description
265  *
266  * @NFTA_SET_DESC_SIZE: number of elements in set (NLA_U32)
267  */
268 enum nft_set_desc_attributes {
269 	NFTA_SET_DESC_UNSPEC,
270 	NFTA_SET_DESC_SIZE,
271 	__NFTA_SET_DESC_MAX
272 };
273 #define NFTA_SET_DESC_MAX	(__NFTA_SET_DESC_MAX - 1)
274 
275 /**
276  * enum nft_set_attributes - nf_tables set netlink attributes
277  *
278  * @NFTA_SET_TABLE: table name (NLA_STRING)
279  * @NFTA_SET_NAME: set name (NLA_STRING)
280  * @NFTA_SET_FLAGS: bitmask of enum nft_set_flags (NLA_U32)
281  * @NFTA_SET_KEY_TYPE: key data type, informational purpose only (NLA_U32)
282  * @NFTA_SET_KEY_LEN: key data length (NLA_U32)
283  * @NFTA_SET_DATA_TYPE: mapping data type (NLA_U32)
284  * @NFTA_SET_DATA_LEN: mapping data length (NLA_U32)
285  * @NFTA_SET_POLICY: selection policy (NLA_U32)
286  * @NFTA_SET_DESC: set description (NLA_NESTED)
287  * @NFTA_SET_ID: uniquely identifies a set in a transaction (NLA_U32)
288  * @NFTA_SET_TIMEOUT: default timeout value (NLA_U64)
289  * @NFTA_SET_GC_INTERVAL: garbage collection interval (NLA_U32)
290  */
291 enum nft_set_attributes {
292 	NFTA_SET_UNSPEC,
293 	NFTA_SET_TABLE,
294 	NFTA_SET_NAME,
295 	NFTA_SET_FLAGS,
296 	NFTA_SET_KEY_TYPE,
297 	NFTA_SET_KEY_LEN,
298 	NFTA_SET_DATA_TYPE,
299 	NFTA_SET_DATA_LEN,
300 	NFTA_SET_POLICY,
301 	NFTA_SET_DESC,
302 	NFTA_SET_ID,
303 	NFTA_SET_TIMEOUT,
304 	NFTA_SET_GC_INTERVAL,
305 	__NFTA_SET_MAX
306 };
307 #define NFTA_SET_MAX		(__NFTA_SET_MAX - 1)
308 
309 /**
310  * enum nft_set_elem_flags - nf_tables set element flags
311  *
312  * @NFT_SET_ELEM_INTERVAL_END: element ends the previous interval
313  */
314 enum nft_set_elem_flags {
315 	NFT_SET_ELEM_INTERVAL_END	= 0x1,
316 };
317 
318 /**
319  * enum nft_set_elem_attributes - nf_tables set element netlink attributes
320  *
321  * @NFTA_SET_ELEM_KEY: key value (NLA_NESTED: nft_data)
322  * @NFTA_SET_ELEM_DATA: data value of mapping (NLA_NESTED: nft_data_attributes)
323  * @NFTA_SET_ELEM_FLAGS: bitmask of nft_set_elem_flags (NLA_U32)
324  * @NFTA_SET_ELEM_TIMEOUT: timeout value (NLA_U64)
325  * @NFTA_SET_ELEM_EXPIRATION: expiration time (NLA_U64)
326  * @NFTA_SET_ELEM_USERDATA: user data (NLA_BINARY)
327  * @NFTA_SET_ELEM_EXPR: expression (NLA_NESTED: nft_expr_attributes)
328  */
329 enum nft_set_elem_attributes {
330 	NFTA_SET_ELEM_UNSPEC,
331 	NFTA_SET_ELEM_KEY,
332 	NFTA_SET_ELEM_DATA,
333 	NFTA_SET_ELEM_FLAGS,
334 	NFTA_SET_ELEM_TIMEOUT,
335 	NFTA_SET_ELEM_EXPIRATION,
336 	NFTA_SET_ELEM_USERDATA,
337 	NFTA_SET_ELEM_EXPR,
338 	__NFTA_SET_ELEM_MAX
339 };
340 #define NFTA_SET_ELEM_MAX	(__NFTA_SET_ELEM_MAX - 1)
341 
342 /**
343  * enum nft_set_elem_list_attributes - nf_tables set element list netlink attributes
344  *
345  * @NFTA_SET_ELEM_LIST_TABLE: table of the set to be changed (NLA_STRING)
346  * @NFTA_SET_ELEM_LIST_SET: name of the set to be changed (NLA_STRING)
347  * @NFTA_SET_ELEM_LIST_ELEMENTS: list of set elements (NLA_NESTED: nft_set_elem_attributes)
348  * @NFTA_SET_ELEM_LIST_SET_ID: uniquely identifies a set in a transaction (NLA_U32)
349  */
350 enum nft_set_elem_list_attributes {
351 	NFTA_SET_ELEM_LIST_UNSPEC,
352 	NFTA_SET_ELEM_LIST_TABLE,
353 	NFTA_SET_ELEM_LIST_SET,
354 	NFTA_SET_ELEM_LIST_ELEMENTS,
355 	NFTA_SET_ELEM_LIST_SET_ID,
356 	__NFTA_SET_ELEM_LIST_MAX
357 };
358 #define NFTA_SET_ELEM_LIST_MAX	(__NFTA_SET_ELEM_LIST_MAX - 1)
359 
360 /**
361  * enum nft_data_types - nf_tables data types
362  *
363  * @NFT_DATA_VALUE: generic data
364  * @NFT_DATA_VERDICT: netfilter verdict
365  *
366  * The type of data is usually determined by the kernel directly and is not
367  * explicitly specified by userspace. The only difference are sets, where
368  * userspace specifies the key and mapping data types.
369  *
370  * The values 0xffffff00-0xffffffff are reserved for internally used types.
371  * The remaining range can be freely used by userspace to encode types, all
372  * values are equivalent to NFT_DATA_VALUE.
373  */
374 enum nft_data_types {
375 	NFT_DATA_VALUE,
376 	NFT_DATA_VERDICT	= 0xffffff00U,
377 };
378 
379 #define NFT_DATA_RESERVED_MASK	0xffffff00U
380 
381 /**
382  * enum nft_data_attributes - nf_tables data netlink attributes
383  *
384  * @NFTA_DATA_VALUE: generic data (NLA_BINARY)
385  * @NFTA_DATA_VERDICT: nf_tables verdict (NLA_NESTED: nft_verdict_attributes)
386  */
387 enum nft_data_attributes {
388 	NFTA_DATA_UNSPEC,
389 	NFTA_DATA_VALUE,
390 	NFTA_DATA_VERDICT,
391 	__NFTA_DATA_MAX
392 };
393 #define NFTA_DATA_MAX		(__NFTA_DATA_MAX - 1)
394 
395 /* Maximum length of a value */
396 #define NFT_DATA_VALUE_MAXLEN	64
397 
398 /**
399  * enum nft_verdict_attributes - nf_tables verdict netlink attributes
400  *
401  * @NFTA_VERDICT_CODE: nf_tables verdict (NLA_U32: enum nft_verdicts)
402  * @NFTA_VERDICT_CHAIN: jump target chain name (NLA_STRING)
403  */
404 enum nft_verdict_attributes {
405 	NFTA_VERDICT_UNSPEC,
406 	NFTA_VERDICT_CODE,
407 	NFTA_VERDICT_CHAIN,
408 	__NFTA_VERDICT_MAX
409 };
410 #define NFTA_VERDICT_MAX	(__NFTA_VERDICT_MAX - 1)
411 
412 /**
413  * enum nft_expr_attributes - nf_tables expression netlink attributes
414  *
415  * @NFTA_EXPR_NAME: name of the expression type (NLA_STRING)
416  * @NFTA_EXPR_DATA: type specific data (NLA_NESTED)
417  */
418 enum nft_expr_attributes {
419 	NFTA_EXPR_UNSPEC,
420 	NFTA_EXPR_NAME,
421 	NFTA_EXPR_DATA,
422 	__NFTA_EXPR_MAX
423 };
424 #define NFTA_EXPR_MAX		(__NFTA_EXPR_MAX - 1)
425 
426 /**
427  * enum nft_immediate_attributes - nf_tables immediate expression netlink attributes
428  *
429  * @NFTA_IMMEDIATE_DREG: destination register to load data into (NLA_U32)
430  * @NFTA_IMMEDIATE_DATA: data to load (NLA_NESTED: nft_data_attributes)
431  */
432 enum nft_immediate_attributes {
433 	NFTA_IMMEDIATE_UNSPEC,
434 	NFTA_IMMEDIATE_DREG,
435 	NFTA_IMMEDIATE_DATA,
436 	__NFTA_IMMEDIATE_MAX
437 };
438 #define NFTA_IMMEDIATE_MAX	(__NFTA_IMMEDIATE_MAX - 1)
439 
440 /**
441  * enum nft_bitwise_attributes - nf_tables bitwise expression netlink attributes
442  *
443  * @NFTA_BITWISE_SREG: source register (NLA_U32: nft_registers)
444  * @NFTA_BITWISE_DREG: destination register (NLA_U32: nft_registers)
445  * @NFTA_BITWISE_LEN: length of operands (NLA_U32)
446  * @NFTA_BITWISE_MASK: mask value (NLA_NESTED: nft_data_attributes)
447  * @NFTA_BITWISE_XOR: xor value (NLA_NESTED: nft_data_attributes)
448  *
449  * The bitwise expression performs the following operation:
450  *
451  * dreg = (sreg & mask) ^ xor
452  *
453  * which allow to express all bitwise operations:
454  *
455  * 		mask	xor
456  * NOT:		1	1
457  * OR:		0	x
458  * XOR:		1	x
459  * AND:		x	0
460  */
461 enum nft_bitwise_attributes {
462 	NFTA_BITWISE_UNSPEC,
463 	NFTA_BITWISE_SREG,
464 	NFTA_BITWISE_DREG,
465 	NFTA_BITWISE_LEN,
466 	NFTA_BITWISE_MASK,
467 	NFTA_BITWISE_XOR,
468 	__NFTA_BITWISE_MAX
469 };
470 #define NFTA_BITWISE_MAX	(__NFTA_BITWISE_MAX - 1)
471 
472 /**
473  * enum nft_byteorder_ops - nf_tables byteorder operators
474  *
475  * @NFT_BYTEORDER_NTOH: network to host operator
476  * @NFT_BYTEORDER_HTON: host to network opertaor
477  */
478 enum nft_byteorder_ops {
479 	NFT_BYTEORDER_NTOH,
480 	NFT_BYTEORDER_HTON,
481 };
482 
483 /**
484  * enum nft_byteorder_attributes - nf_tables byteorder expression netlink attributes
485  *
486  * @NFTA_BYTEORDER_SREG: source register (NLA_U32: nft_registers)
487  * @NFTA_BYTEORDER_DREG: destination register (NLA_U32: nft_registers)
488  * @NFTA_BYTEORDER_OP: operator (NLA_U32: enum nft_byteorder_ops)
489  * @NFTA_BYTEORDER_LEN: length of the data (NLA_U32)
490  * @NFTA_BYTEORDER_SIZE: data size in bytes (NLA_U32: 2 or 4)
491  */
492 enum nft_byteorder_attributes {
493 	NFTA_BYTEORDER_UNSPEC,
494 	NFTA_BYTEORDER_SREG,
495 	NFTA_BYTEORDER_DREG,
496 	NFTA_BYTEORDER_OP,
497 	NFTA_BYTEORDER_LEN,
498 	NFTA_BYTEORDER_SIZE,
499 	__NFTA_BYTEORDER_MAX
500 };
501 #define NFTA_BYTEORDER_MAX	(__NFTA_BYTEORDER_MAX - 1)
502 
503 /**
504  * enum nft_cmp_ops - nf_tables relational operator
505  *
506  * @NFT_CMP_EQ: equal
507  * @NFT_CMP_NEQ: not equal
508  * @NFT_CMP_LT: less than
509  * @NFT_CMP_LTE: less than or equal to
510  * @NFT_CMP_GT: greater than
511  * @NFT_CMP_GTE: greater than or equal to
512  */
513 enum nft_cmp_ops {
514 	NFT_CMP_EQ,
515 	NFT_CMP_NEQ,
516 	NFT_CMP_LT,
517 	NFT_CMP_LTE,
518 	NFT_CMP_GT,
519 	NFT_CMP_GTE,
520 };
521 
522 /**
523  * enum nft_cmp_attributes - nf_tables cmp expression netlink attributes
524  *
525  * @NFTA_CMP_SREG: source register of data to compare (NLA_U32: nft_registers)
526  * @NFTA_CMP_OP: cmp operation (NLA_U32: nft_cmp_ops)
527  * @NFTA_CMP_DATA: data to compare against (NLA_NESTED: nft_data_attributes)
528  */
529 enum nft_cmp_attributes {
530 	NFTA_CMP_UNSPEC,
531 	NFTA_CMP_SREG,
532 	NFTA_CMP_OP,
533 	NFTA_CMP_DATA,
534 	__NFTA_CMP_MAX
535 };
536 #define NFTA_CMP_MAX		(__NFTA_CMP_MAX - 1)
537 
538 /**
539  * enum nft_lookup_attributes - nf_tables set lookup expression netlink attributes
540  *
541  * @NFTA_LOOKUP_SET: name of the set where to look for (NLA_STRING)
542  * @NFTA_LOOKUP_SREG: source register of the data to look for (NLA_U32: nft_registers)
543  * @NFTA_LOOKUP_DREG: destination register (NLA_U32: nft_registers)
544  * @NFTA_LOOKUP_SET_ID: uniquely identifies a set in a transaction (NLA_U32)
545  */
546 enum nft_lookup_attributes {
547 	NFTA_LOOKUP_UNSPEC,
548 	NFTA_LOOKUP_SET,
549 	NFTA_LOOKUP_SREG,
550 	NFTA_LOOKUP_DREG,
551 	NFTA_LOOKUP_SET_ID,
552 	__NFTA_LOOKUP_MAX
553 };
554 #define NFTA_LOOKUP_MAX		(__NFTA_LOOKUP_MAX - 1)
555 
556 enum nft_dynset_ops {
557 	NFT_DYNSET_OP_ADD,
558 	NFT_DYNSET_OP_UPDATE,
559 };
560 
561 /**
562  * enum nft_dynset_attributes - dynset expression attributes
563  *
564  * @NFTA_DYNSET_SET_NAME: name of set the to add data to (NLA_STRING)
565  * @NFTA_DYNSET_SET_ID: uniquely identifier of the set in the transaction (NLA_U32)
566  * @NFTA_DYNSET_OP: operation (NLA_U32)
567  * @NFTA_DYNSET_SREG_KEY: source register of the key (NLA_U32)
568  * @NFTA_DYNSET_SREG_DATA: source register of the data (NLA_U32)
569  * @NFTA_DYNSET_TIMEOUT: timeout value for the new element (NLA_U64)
570  * @NFTA_DYNSET_EXPR: expression (NLA_NESTED: nft_expr_attributes)
571  */
572 enum nft_dynset_attributes {
573 	NFTA_DYNSET_UNSPEC,
574 	NFTA_DYNSET_SET_NAME,
575 	NFTA_DYNSET_SET_ID,
576 	NFTA_DYNSET_OP,
577 	NFTA_DYNSET_SREG_KEY,
578 	NFTA_DYNSET_SREG_DATA,
579 	NFTA_DYNSET_TIMEOUT,
580 	NFTA_DYNSET_EXPR,
581 	__NFTA_DYNSET_MAX,
582 };
583 #define NFTA_DYNSET_MAX		(__NFTA_DYNSET_MAX - 1)
584 
585 /**
586  * enum nft_payload_bases - nf_tables payload expression offset bases
587  *
588  * @NFT_PAYLOAD_LL_HEADER: link layer header
589  * @NFT_PAYLOAD_NETWORK_HEADER: network header
590  * @NFT_PAYLOAD_TRANSPORT_HEADER: transport header
591  */
592 enum nft_payload_bases {
593 	NFT_PAYLOAD_LL_HEADER,
594 	NFT_PAYLOAD_NETWORK_HEADER,
595 	NFT_PAYLOAD_TRANSPORT_HEADER,
596 };
597 
598 /**
599  * enum nft_payload_attributes - nf_tables payload expression netlink attributes
600  *
601  * @NFTA_PAYLOAD_DREG: destination register to load data into (NLA_U32: nft_registers)
602  * @NFTA_PAYLOAD_BASE: payload base (NLA_U32: nft_payload_bases)
603  * @NFTA_PAYLOAD_OFFSET: payload offset relative to base (NLA_U32)
604  * @NFTA_PAYLOAD_LEN: payload length (NLA_U32)
605  */
606 enum nft_payload_attributes {
607 	NFTA_PAYLOAD_UNSPEC,
608 	NFTA_PAYLOAD_DREG,
609 	NFTA_PAYLOAD_BASE,
610 	NFTA_PAYLOAD_OFFSET,
611 	NFTA_PAYLOAD_LEN,
612 	__NFTA_PAYLOAD_MAX
613 };
614 #define NFTA_PAYLOAD_MAX	(__NFTA_PAYLOAD_MAX - 1)
615 
616 /**
617  * enum nft_exthdr_attributes - nf_tables IPv6 extension header expression netlink attributes
618  *
619  * @NFTA_EXTHDR_DREG: destination register (NLA_U32: nft_registers)
620  * @NFTA_EXTHDR_TYPE: extension header type (NLA_U8)
621  * @NFTA_EXTHDR_OFFSET: extension header offset (NLA_U32)
622  * @NFTA_EXTHDR_LEN: extension header length (NLA_U32)
623  */
624 enum nft_exthdr_attributes {
625 	NFTA_EXTHDR_UNSPEC,
626 	NFTA_EXTHDR_DREG,
627 	NFTA_EXTHDR_TYPE,
628 	NFTA_EXTHDR_OFFSET,
629 	NFTA_EXTHDR_LEN,
630 	__NFTA_EXTHDR_MAX
631 };
632 #define NFTA_EXTHDR_MAX		(__NFTA_EXTHDR_MAX - 1)
633 
634 /**
635  * enum nft_meta_keys - nf_tables meta expression keys
636  *
637  * @NFT_META_LEN: packet length (skb->len)
638  * @NFT_META_PROTOCOL: packet ethertype protocol (skb->protocol), invalid in OUTPUT
639  * @NFT_META_PRIORITY: packet priority (skb->priority)
640  * @NFT_META_MARK: packet mark (skb->mark)
641  * @NFT_META_IIF: packet input interface index (dev->ifindex)
642  * @NFT_META_OIF: packet output interface index (dev->ifindex)
643  * @NFT_META_IIFNAME: packet input interface name (dev->name)
644  * @NFT_META_OIFNAME: packet output interface name (dev->name)
645  * @NFT_META_IIFTYPE: packet input interface type (dev->type)
646  * @NFT_META_OIFTYPE: packet output interface type (dev->type)
647  * @NFT_META_SKUID: originating socket UID (fsuid)
648  * @NFT_META_SKGID: originating socket GID (fsgid)
649  * @NFT_META_NFTRACE: packet nftrace bit
650  * @NFT_META_RTCLASSID: realm value of packet's route (skb->dst->tclassid)
651  * @NFT_META_SECMARK: packet secmark (skb->secmark)
652  * @NFT_META_NFPROTO: netfilter protocol
653  * @NFT_META_L4PROTO: layer 4 protocol number
654  * @NFT_META_BRI_IIFNAME: packet input bridge interface name
655  * @NFT_META_BRI_OIFNAME: packet output bridge interface name
656  * @NFT_META_PKTTYPE: packet type (skb->pkt_type), special handling for loopback
657  * @NFT_META_CPU: cpu id through smp_processor_id()
658  * @NFT_META_IIFGROUP: packet input interface group
659  * @NFT_META_OIFGROUP: packet output interface group
660  * @NFT_META_CGROUP: socket control group (skb->sk->sk_classid)
661  */
662 enum nft_meta_keys {
663 	NFT_META_LEN,
664 	NFT_META_PROTOCOL,
665 	NFT_META_PRIORITY,
666 	NFT_META_MARK,
667 	NFT_META_IIF,
668 	NFT_META_OIF,
669 	NFT_META_IIFNAME,
670 	NFT_META_OIFNAME,
671 	NFT_META_IIFTYPE,
672 	NFT_META_OIFTYPE,
673 	NFT_META_SKUID,
674 	NFT_META_SKGID,
675 	NFT_META_NFTRACE,
676 	NFT_META_RTCLASSID,
677 	NFT_META_SECMARK,
678 	NFT_META_NFPROTO,
679 	NFT_META_L4PROTO,
680 	NFT_META_BRI_IIFNAME,
681 	NFT_META_BRI_OIFNAME,
682 	NFT_META_PKTTYPE,
683 	NFT_META_CPU,
684 	NFT_META_IIFGROUP,
685 	NFT_META_OIFGROUP,
686 	NFT_META_CGROUP,
687 };
688 
689 /**
690  * enum nft_meta_attributes - nf_tables meta expression netlink attributes
691  *
692  * @NFTA_META_DREG: destination register (NLA_U32)
693  * @NFTA_META_KEY: meta data item to load (NLA_U32: nft_meta_keys)
694  * @NFTA_META_SREG: source register (NLA_U32)
695  */
696 enum nft_meta_attributes {
697 	NFTA_META_UNSPEC,
698 	NFTA_META_DREG,
699 	NFTA_META_KEY,
700 	NFTA_META_SREG,
701 	__NFTA_META_MAX
702 };
703 #define NFTA_META_MAX		(__NFTA_META_MAX - 1)
704 
705 /**
706  * enum nft_ct_keys - nf_tables ct expression keys
707  *
708  * @NFT_CT_STATE: conntrack state (bitmask of enum ip_conntrack_info)
709  * @NFT_CT_DIRECTION: conntrack direction (enum ip_conntrack_dir)
710  * @NFT_CT_STATUS: conntrack status (bitmask of enum ip_conntrack_status)
711  * @NFT_CT_MARK: conntrack mark value
712  * @NFT_CT_SECMARK: conntrack secmark value
713  * @NFT_CT_EXPIRATION: relative conntrack expiration time in ms
714  * @NFT_CT_HELPER: connection tracking helper assigned to conntrack
715  * @NFT_CT_L3PROTOCOL: conntrack layer 3 protocol
716  * @NFT_CT_SRC: conntrack layer 3 protocol source (IPv4/IPv6 address)
717  * @NFT_CT_DST: conntrack layer 3 protocol destination (IPv4/IPv6 address)
718  * @NFT_CT_PROTOCOL: conntrack layer 4 protocol
719  * @NFT_CT_PROTO_SRC: conntrack layer 4 protocol source
720  * @NFT_CT_PROTO_DST: conntrack layer 4 protocol destination
721  */
722 enum nft_ct_keys {
723 	NFT_CT_STATE,
724 	NFT_CT_DIRECTION,
725 	NFT_CT_STATUS,
726 	NFT_CT_MARK,
727 	NFT_CT_SECMARK,
728 	NFT_CT_EXPIRATION,
729 	NFT_CT_HELPER,
730 	NFT_CT_L3PROTOCOL,
731 	NFT_CT_SRC,
732 	NFT_CT_DST,
733 	NFT_CT_PROTOCOL,
734 	NFT_CT_PROTO_SRC,
735 	NFT_CT_PROTO_DST,
736 	NFT_CT_LABELS,
737 };
738 
739 /**
740  * enum nft_ct_attributes - nf_tables ct expression netlink attributes
741  *
742  * @NFTA_CT_DREG: destination register (NLA_U32)
743  * @NFTA_CT_KEY: conntrack data item to load (NLA_U32: nft_ct_keys)
744  * @NFTA_CT_DIRECTION: direction in case of directional keys (NLA_U8)
745  * @NFTA_CT_SREG: source register (NLA_U32)
746  */
747 enum nft_ct_attributes {
748 	NFTA_CT_UNSPEC,
749 	NFTA_CT_DREG,
750 	NFTA_CT_KEY,
751 	NFTA_CT_DIRECTION,
752 	NFTA_CT_SREG,
753 	__NFTA_CT_MAX
754 };
755 #define NFTA_CT_MAX		(__NFTA_CT_MAX - 1)
756 
757 /**
758  * enum nft_limit_attributes - nf_tables limit expression netlink attributes
759  *
760  * @NFTA_LIMIT_RATE: refill rate (NLA_U64)
761  * @NFTA_LIMIT_UNIT: refill unit (NLA_U64)
762  */
763 enum nft_limit_attributes {
764 	NFTA_LIMIT_UNSPEC,
765 	NFTA_LIMIT_RATE,
766 	NFTA_LIMIT_UNIT,
767 	__NFTA_LIMIT_MAX
768 };
769 #define NFTA_LIMIT_MAX		(__NFTA_LIMIT_MAX - 1)
770 
771 /**
772  * enum nft_counter_attributes - nf_tables counter expression netlink attributes
773  *
774  * @NFTA_COUNTER_BYTES: number of bytes (NLA_U64)
775  * @NFTA_COUNTER_PACKETS: number of packets (NLA_U64)
776  */
777 enum nft_counter_attributes {
778 	NFTA_COUNTER_UNSPEC,
779 	NFTA_COUNTER_BYTES,
780 	NFTA_COUNTER_PACKETS,
781 	__NFTA_COUNTER_MAX
782 };
783 #define NFTA_COUNTER_MAX	(__NFTA_COUNTER_MAX - 1)
784 
785 /**
786  * enum nft_log_attributes - nf_tables log expression netlink attributes
787  *
788  * @NFTA_LOG_GROUP: netlink group to send messages to (NLA_U32)
789  * @NFTA_LOG_PREFIX: prefix to prepend to log messages (NLA_STRING)
790  * @NFTA_LOG_SNAPLEN: length of payload to include in netlink message (NLA_U32)
791  * @NFTA_LOG_QTHRESHOLD: queue threshold (NLA_U32)
792  * @NFTA_LOG_LEVEL: log level (NLA_U32)
793  * @NFTA_LOG_FLAGS: logging flags (NLA_U32)
794  */
795 enum nft_log_attributes {
796 	NFTA_LOG_UNSPEC,
797 	NFTA_LOG_GROUP,
798 	NFTA_LOG_PREFIX,
799 	NFTA_LOG_SNAPLEN,
800 	NFTA_LOG_QTHRESHOLD,
801 	NFTA_LOG_LEVEL,
802 	NFTA_LOG_FLAGS,
803 	__NFTA_LOG_MAX
804 };
805 #define NFTA_LOG_MAX		(__NFTA_LOG_MAX - 1)
806 
807 /**
808  * enum nft_queue_attributes - nf_tables queue expression netlink attributes
809  *
810  * @NFTA_QUEUE_NUM: netlink queue to send messages to (NLA_U16)
811  * @NFTA_QUEUE_TOTAL: number of queues to load balance packets on (NLA_U16)
812  * @NFTA_QUEUE_FLAGS: various flags (NLA_U16)
813  */
814 enum nft_queue_attributes {
815 	NFTA_QUEUE_UNSPEC,
816 	NFTA_QUEUE_NUM,
817 	NFTA_QUEUE_TOTAL,
818 	NFTA_QUEUE_FLAGS,
819 	__NFTA_QUEUE_MAX
820 };
821 #define NFTA_QUEUE_MAX		(__NFTA_QUEUE_MAX - 1)
822 
823 #define NFT_QUEUE_FLAG_BYPASS		0x01 /* for compatibility with v2 */
824 #define NFT_QUEUE_FLAG_CPU_FANOUT	0x02 /* use current CPU (no hashing) */
825 #define NFT_QUEUE_FLAG_MASK		0x03
826 
827 /**
828  * enum nft_reject_types - nf_tables reject expression reject types
829  *
830  * @NFT_REJECT_ICMP_UNREACH: reject using ICMP unreachable
831  * @NFT_REJECT_TCP_RST: reject using TCP RST
832  * @NFT_REJECT_ICMPX_UNREACH: abstracted ICMP unreachable for bridge and inet
833  */
834 enum nft_reject_types {
835 	NFT_REJECT_ICMP_UNREACH,
836 	NFT_REJECT_TCP_RST,
837 	NFT_REJECT_ICMPX_UNREACH,
838 };
839 
840 /**
841  * enum nft_reject_code - Generic reject codes for IPv4/IPv6
842  *
843  * @NFT_REJECT_ICMPX_NO_ROUTE: no route to host / network unreachable
844  * @NFT_REJECT_ICMPX_PORT_UNREACH: port unreachable
845  * @NFT_REJECT_ICMPX_HOST_UNREACH: host unreachable
846  * @NFT_REJECT_ICMPX_ADMIN_PROHIBITED: administratively prohibited
847  *
848  * These codes are mapped to real ICMP and ICMPv6 codes.
849  */
850 enum nft_reject_inet_code {
851 	NFT_REJECT_ICMPX_NO_ROUTE	= 0,
852 	NFT_REJECT_ICMPX_PORT_UNREACH,
853 	NFT_REJECT_ICMPX_HOST_UNREACH,
854 	NFT_REJECT_ICMPX_ADMIN_PROHIBITED,
855 	__NFT_REJECT_ICMPX_MAX
856 };
857 #define NFT_REJECT_ICMPX_MAX	(__NFT_REJECT_ICMPX_MAX - 1)
858 
859 /**
860  * enum nft_reject_attributes - nf_tables reject expression netlink attributes
861  *
862  * @NFTA_REJECT_TYPE: packet type to use (NLA_U32: nft_reject_types)
863  * @NFTA_REJECT_ICMP_CODE: ICMP code to use (NLA_U8)
864  */
865 enum nft_reject_attributes {
866 	NFTA_REJECT_UNSPEC,
867 	NFTA_REJECT_TYPE,
868 	NFTA_REJECT_ICMP_CODE,
869 	__NFTA_REJECT_MAX
870 };
871 #define NFTA_REJECT_MAX		(__NFTA_REJECT_MAX - 1)
872 
873 /**
874  * enum nft_nat_types - nf_tables nat expression NAT types
875  *
876  * @NFT_NAT_SNAT: source NAT
877  * @NFT_NAT_DNAT: destination NAT
878  */
879 enum nft_nat_types {
880 	NFT_NAT_SNAT,
881 	NFT_NAT_DNAT,
882 };
883 
884 /**
885  * enum nft_nat_attributes - nf_tables nat expression netlink attributes
886  *
887  * @NFTA_NAT_TYPE: NAT type (NLA_U32: nft_nat_types)
888  * @NFTA_NAT_FAMILY: NAT family (NLA_U32)
889  * @NFTA_NAT_REG_ADDR_MIN: source register of address range start (NLA_U32: nft_registers)
890  * @NFTA_NAT_REG_ADDR_MAX: source register of address range end (NLA_U32: nft_registers)
891  * @NFTA_NAT_REG_PROTO_MIN: source register of proto range start (NLA_U32: nft_registers)
892  * @NFTA_NAT_REG_PROTO_MAX: source register of proto range end (NLA_U32: nft_registers)
893  * @NFTA_NAT_FLAGS: NAT flags (see NF_NAT_RANGE_* in linux/netfilter/nf_nat.h) (NLA_U32)
894  */
895 enum nft_nat_attributes {
896 	NFTA_NAT_UNSPEC,
897 	NFTA_NAT_TYPE,
898 	NFTA_NAT_FAMILY,
899 	NFTA_NAT_REG_ADDR_MIN,
900 	NFTA_NAT_REG_ADDR_MAX,
901 	NFTA_NAT_REG_PROTO_MIN,
902 	NFTA_NAT_REG_PROTO_MAX,
903 	NFTA_NAT_FLAGS,
904 	__NFTA_NAT_MAX
905 };
906 #define NFTA_NAT_MAX		(__NFTA_NAT_MAX - 1)
907 
908 /**
909  * enum nft_masq_attributes - nf_tables masquerade expression attributes
910  *
911  * @NFTA_MASQ_FLAGS: NAT flags (see NF_NAT_RANGE_* in linux/netfilter/nf_nat.h) (NLA_U32)
912  */
913 enum nft_masq_attributes {
914 	NFTA_MASQ_UNSPEC,
915 	NFTA_MASQ_FLAGS,
916 	__NFTA_MASQ_MAX
917 };
918 #define NFTA_MASQ_MAX		(__NFTA_MASQ_MAX - 1)
919 
920 /**
921  * enum nft_redir_attributes - nf_tables redirect expression netlink attributes
922  *
923  * @NFTA_REDIR_REG_PROTO_MIN: source register of proto range start (NLA_U32: nft_registers)
924  * @NFTA_REDIR_REG_PROTO_MAX: source register of proto range end (NLA_U32: nft_registers)
925  * @NFTA_REDIR_FLAGS: NAT flags (see NF_NAT_RANGE_* in linux/netfilter/nf_nat.h) (NLA_U32)
926  */
927 enum nft_redir_attributes {
928 	NFTA_REDIR_UNSPEC,
929 	NFTA_REDIR_REG_PROTO_MIN,
930 	NFTA_REDIR_REG_PROTO_MAX,
931 	NFTA_REDIR_FLAGS,
932 	__NFTA_REDIR_MAX
933 };
934 #define NFTA_REDIR_MAX		(__NFTA_REDIR_MAX - 1)
935 
936 /**
937  * enum nft_gen_attributes - nf_tables ruleset generation attributes
938  *
939  * @NFTA_GEN_ID: Ruleset generation ID (NLA_U32)
940  */
941 enum nft_gen_attributes {
942 	NFTA_GEN_UNSPEC,
943 	NFTA_GEN_ID,
944 	__NFTA_GEN_MAX
945 };
946 #define NFTA_GEN_MAX		(__NFTA_GEN_MAX - 1)
947 
948 #endif /* _LINUX_NF_TABLES_H */
949