1 #ifndef _LINUX_NF_TABLES_H
2 #define _LINUX_NF_TABLES_H
4 #define NFT_CHAIN_MAXNAMELEN 32
14 #define NFT_REG_MAX (__NFT_REG_MAX - 1)
17 * enum nft_verdicts - nf_tables internal verdicts
19 * @NFT_CONTINUE: continue evaluation of the current rule
20 * @NFT_BREAK: terminate evaluation of the current rule
21 * @NFT_JUMP: push the current chain on the jump stack and jump to a chain
22 * @NFT_GOTO: jump to a chain without pushing the current chain on the jump stack
23 * @NFT_RETURN: return to the topmost chain on the jump stack
25 * The nf_tables verdicts share their numeric space with the netfilter verdicts.
36 * enum nf_tables_msg_types - nf_tables netlink message types
38 * @NFT_MSG_NEWTABLE: create a new table (enum nft_table_attributes)
39 * @NFT_MSG_GETTABLE: get a table (enum nft_table_attributes)
40 * @NFT_MSG_DELTABLE: delete a table (enum nft_table_attributes)
41 * @NFT_MSG_NEWCHAIN: create a new chain (enum nft_chain_attributes)
42 * @NFT_MSG_GETCHAIN: get a chain (enum nft_chain_attributes)
43 * @NFT_MSG_DELCHAIN: delete a chain (enum nft_chain_attributes)
44 * @NFT_MSG_NEWRULE: create a new rule (enum nft_rule_attributes)
45 * @NFT_MSG_GETRULE: get a rule (enum nft_rule_attributes)
46 * @NFT_MSG_DELRULE: delete a rule (enum nft_rule_attributes)
47 * @NFT_MSG_NEWSET: create a new set (enum nft_set_attributes)
48 * @NFT_MSG_GETSET: get a set (enum nft_set_attributes)
49 * @NFT_MSG_DELSET: delete a set (enum nft_set_attributes)
50 * @NFT_MSG_NEWSETELEM: create a new set element (enum nft_set_elem_attributes)
51 * @NFT_MSG_GETSETELEM: get a set element (enum nft_set_elem_attributes)
52 * @NFT_MSG_DELSETELEM: delete a set element (enum nft_set_elem_attributes)
54 enum nf_tables_msg_types {
74 * enum nft_list_attributes - nf_tables generic list netlink attributes
76 * @NFTA_LIST_ELEM: list element (NLA_NESTED)
78 enum nft_list_attributes {
83 #define NFTA_LIST_MAX (__NFTA_LIST_MAX - 1)
86 * enum nft_hook_attributes - nf_tables netfilter hook netlink attributes
88 * @NFTA_HOOK_HOOKNUM: netfilter hook number (NLA_U32)
89 * @NFTA_HOOK_PRIORITY: netfilter hook priority (NLA_U32)
91 enum nft_hook_attributes {
97 #define NFTA_HOOK_MAX (__NFTA_HOOK_MAX - 1)
100 * enum nft_table_flags - nf_tables table flags
102 * @NFT_TABLE_F_DORMANT: this table is not active
104 enum nft_table_flags {
105 NFT_TABLE_F_DORMANT = 0x1,
109 * enum nft_table_attributes - nf_tables table netlink attributes
111 * @NFTA_TABLE_NAME: name of the table (NLA_STRING)
112 * @NFTA_TABLE_FLAGS: bitmask of enum nft_table_flags (NLA_U32)
113 * @NFTA_TABLE_USE: number of chains in this table (NLA_U32)
115 enum nft_table_attributes {
122 #define NFTA_TABLE_MAX (__NFTA_TABLE_MAX - 1)
125 * enum nft_chain_attributes - nf_tables chain netlink attributes
127 * @NFTA_CHAIN_TABLE: name of the table containing the chain (NLA_STRING)
128 * @NFTA_CHAIN_HANDLE: numeric handle of the chain (NLA_U64)
129 * @NFTA_CHAIN_NAME: name of the chain (NLA_STRING)
130 * @NFTA_CHAIN_HOOK: hook specification for basechains (NLA_NESTED: nft_hook_attributes)
131 * @NFTA_CHAIN_POLICY: numeric policy of the chain (NLA_U32)
132 * @NFTA_CHAIN_USE: number of references to this chain (NLA_U32)
133 * @NFTA_CHAIN_TYPE: type name of the string (NLA_NUL_STRING)
134 * @NFTA_CHAIN_COUNTERS: counter specification of the chain (NLA_NESTED: nft_counter_attributes)
136 enum nft_chain_attributes {
148 #define NFTA_CHAIN_MAX (__NFTA_CHAIN_MAX - 1)
151 * enum nft_rule_attributes - nf_tables rule netlink attributes
153 * @NFTA_RULE_TABLE: name of the table containing the rule (NLA_STRING)
154 * @NFTA_RULE_CHAIN: name of the chain containing the rule (NLA_STRING)
155 * @NFTA_RULE_HANDLE: numeric handle of the rule (NLA_U64)
156 * @NFTA_RULE_EXPRESSIONS: list of expressions (NLA_NESTED: nft_expr_attributes)
157 * @NFTA_RULE_COMPAT: compatibility specifications of the rule (NLA_NESTED: nft_rule_compat_attributes)
158 * @NFTA_RULE_POSITION: numeric handle of the previous rule (NLA_U64)
160 enum nft_rule_attributes {
165 NFTA_RULE_EXPRESSIONS,
170 #define NFTA_RULE_MAX (__NFTA_RULE_MAX - 1)
173 * enum nft_rule_compat_flags - nf_tables rule compat flags
175 * @NFT_RULE_COMPAT_F_INV: invert the check result
177 enum nft_rule_compat_flags {
178 NFT_RULE_COMPAT_F_INV = (1 << 1),
179 NFT_RULE_COMPAT_F_MASK = NFT_RULE_COMPAT_F_INV,
183 * enum nft_rule_compat_attributes - nf_tables rule compat attributes
185 * @NFTA_RULE_COMPAT_PROTO: numerice value of handled protocol (NLA_U32)
186 * @NFTA_RULE_COMPAT_FLAGS: bitmask of enum nft_rule_compat_flags (NLA_U32)
188 enum nft_rule_compat_attributes {
189 NFTA_RULE_COMPAT_UNSPEC,
190 NFTA_RULE_COMPAT_PROTO,
191 NFTA_RULE_COMPAT_FLAGS,
192 __NFTA_RULE_COMPAT_MAX
194 #define NFTA_RULE_COMPAT_MAX (__NFTA_RULE_COMPAT_MAX - 1)
197 * enum nft_set_flags - nf_tables set flags
199 * @NFT_SET_ANONYMOUS: name allocation, automatic cleanup on unlink
200 * @NFT_SET_CONSTANT: set contents may not change while bound
201 * @NFT_SET_INTERVAL: set contains intervals
202 * @NFT_SET_MAP: set is used as a dictionary
205 NFT_SET_ANONYMOUS = 0x1,
206 NFT_SET_CONSTANT = 0x2,
207 NFT_SET_INTERVAL = 0x4,
212 * enum nft_set_attributes - nf_tables set netlink attributes
214 * @NFTA_SET_TABLE: table name (NLA_STRING)
215 * @NFTA_SET_NAME: set name (NLA_STRING)
216 * @NFTA_SET_FLAGS: bitmask of enum nft_set_flags (NLA_U32)
217 * @NFTA_SET_KEY_TYPE: key data type, informational purpose only (NLA_U32)
218 * @NFTA_SET_KEY_LEN: key data length (NLA_U32)
219 * @NFTA_SET_DATA_TYPE: mapping data type (NLA_U32)
220 * @NFTA_SET_DATA_LEN: mapping data length (NLA_U32)
222 enum nft_set_attributes {
233 #define NFTA_SET_MAX (__NFTA_SET_MAX - 1)
236 * enum nft_set_elem_flags - nf_tables set element flags
238 * @NFT_SET_ELEM_INTERVAL_END: element ends the previous interval
240 enum nft_set_elem_flags {
241 NFT_SET_ELEM_INTERVAL_END = 0x1,
245 * enum nft_set_elem_attributes - nf_tables set element netlink attributes
247 * @NFTA_SET_ELEM_KEY: key value (NLA_NESTED: nft_data)
248 * @NFTA_SET_ELEM_DATA: data value of mapping (NLA_NESTED: nft_data_attributes)
249 * @NFTA_SET_ELEM_FLAGS: bitmask of nft_set_elem_flags (NLA_U32)
251 enum nft_set_elem_attributes {
252 NFTA_SET_ELEM_UNSPEC,
258 #define NFTA_SET_ELEM_MAX (__NFTA_SET_ELEM_MAX - 1)
261 * enum nft_set_elem_list_attributes - nf_tables set element list netlink attributes
263 * @NFTA_SET_ELEM_LIST_TABLE: table of the set to be changed (NLA_STRING)
264 * @NFTA_SET_ELEM_LIST_SET: name of the set to be changed (NLA_STRING)
265 * @NFTA_SET_ELEM_LIST_ELEMENTS: list of set elements (NLA_NESTED: nft_set_elem_attributes)
267 enum nft_set_elem_list_attributes {
268 NFTA_SET_ELEM_LIST_UNSPEC,
269 NFTA_SET_ELEM_LIST_TABLE,
270 NFTA_SET_ELEM_LIST_SET,
271 NFTA_SET_ELEM_LIST_ELEMENTS,
272 __NFTA_SET_ELEM_LIST_MAX
274 #define NFTA_SET_ELEM_LIST_MAX (__NFTA_SET_ELEM_LIST_MAX - 1)
277 * enum nft_data_types - nf_tables data types
279 * @NFT_DATA_VALUE: generic data
280 * @NFT_DATA_VERDICT: netfilter verdict
282 * The type of data is usually determined by the kernel directly and is not
283 * explicitly specified by userspace. The only difference are sets, where
284 * userspace specifies the key and mapping data types.
286 * The values 0xffffff00-0xffffffff are reserved for internally used types.
287 * The remaining range can be freely used by userspace to encode types, all
288 * values are equivalent to NFT_DATA_VALUE.
290 enum nft_data_types {
292 NFT_DATA_VERDICT = 0xffffff00U,
295 #define NFT_DATA_RESERVED_MASK 0xffffff00U
298 * enum nft_data_attributes - nf_tables data netlink attributes
300 * @NFTA_DATA_VALUE: generic data (NLA_BINARY)
301 * @NFTA_DATA_VERDICT: nf_tables verdict (NLA_NESTED: nft_verdict_attributes)
303 enum nft_data_attributes {
309 #define NFTA_DATA_MAX (__NFTA_DATA_MAX - 1)
312 * enum nft_verdict_attributes - nf_tables verdict netlink attributes
314 * @NFTA_VERDICT_CODE: nf_tables verdict (NLA_U32: enum nft_verdicts)
315 * @NFTA_VERDICT_CHAIN: jump target chain name (NLA_STRING)
317 enum nft_verdict_attributes {
323 #define NFTA_VERDICT_MAX (__NFTA_VERDICT_MAX - 1)
326 * enum nft_expr_attributes - nf_tables expression netlink attributes
328 * @NFTA_EXPR_NAME: name of the expression type (NLA_STRING)
329 * @NFTA_EXPR_DATA: type specific data (NLA_NESTED)
331 enum nft_expr_attributes {
337 #define NFTA_EXPR_MAX (__NFTA_EXPR_MAX - 1)
340 * enum nft_immediate_attributes - nf_tables immediate expression netlink attributes
342 * @NFTA_IMMEDIATE_DREG: destination register to load data into (NLA_U32)
343 * @NFTA_IMMEDIATE_DATA: data to load (NLA_NESTED: nft_data_attributes)
345 enum nft_immediate_attributes {
346 NFTA_IMMEDIATE_UNSPEC,
351 #define NFTA_IMMEDIATE_MAX (__NFTA_IMMEDIATE_MAX - 1)
354 * enum nft_bitwise_attributes - nf_tables bitwise expression netlink attributes
356 * @NFTA_BITWISE_SREG: source register (NLA_U32: nft_registers)
357 * @NFTA_BITWISE_DREG: destination register (NLA_U32: nft_registers)
358 * @NFTA_BITWISE_LEN: length of operands (NLA_U32)
359 * @NFTA_BITWISE_MASK: mask value (NLA_NESTED: nft_data_attributes)
360 * @NFTA_BITWISE_XOR: xor value (NLA_NESTED: nft_data_attributes)
362 * The bitwise expression performs the following operation:
364 * dreg = (sreg & mask) ^ xor
366 * which allow to express all bitwise operations:
374 enum nft_bitwise_attributes {
383 #define NFTA_BITWISE_MAX (__NFTA_BITWISE_MAX - 1)
386 * enum nft_byteorder_ops - nf_tables byteorder operators
388 * @NFT_BYTEORDER_NTOH: network to host operator
389 * @NFT_BYTEORDER_HTON: host to network opertaor
391 enum nft_byteorder_ops {
397 * enum nft_byteorder_attributes - nf_tables byteorder expression netlink attributes
399 * @NFTA_BYTEORDER_SREG: source register (NLA_U32: nft_registers)
400 * @NFTA_BYTEORDER_DREG: destination register (NLA_U32: nft_registers)
401 * @NFTA_BYTEORDER_OP: operator (NLA_U32: enum nft_byteorder_ops)
402 * @NFTA_BYTEORDER_LEN: length of the data (NLA_U32)
403 * @NFTA_BYTEORDER_SIZE: data size in bytes (NLA_U32: 2 or 4)
405 enum nft_byteorder_attributes {
406 NFTA_BYTEORDER_UNSPEC,
414 #define NFTA_BYTEORDER_MAX (__NFTA_BYTEORDER_MAX - 1)
417 * enum nft_cmp_ops - nf_tables relational operator
420 * @NFT_CMP_NEQ: not equal
421 * @NFT_CMP_LT: less than
422 * @NFT_CMP_LTE: less than or equal to
423 * @NFT_CMP_GT: greater than
424 * @NFT_CMP_GTE: greater than or equal to
436 * enum nft_cmp_attributes - nf_tables cmp expression netlink attributes
438 * @NFTA_CMP_SREG: source register of data to compare (NLA_U32: nft_registers)
439 * @NFTA_CMP_OP: cmp operation (NLA_U32: nft_cmp_ops)
440 * @NFTA_CMP_DATA: data to compare against (NLA_NESTED: nft_data_attributes)
442 enum nft_cmp_attributes {
449 #define NFTA_CMP_MAX (__NFTA_CMP_MAX - 1)
452 * enum nft_lookup_attributes - nf_tables set lookup expression netlink attributes
454 * @NFTA_LOOKUP_SET: name of the set where to look for (NLA_STRING)
455 * @NFTA_LOOKUP_SREG: source register of the data to look for (NLA_U32: nft_registers)
456 * @NFTA_LOOKUP_DREG: destination register (NLA_U32: nft_registers)
458 enum nft_lookup_attributes {
465 #define NFTA_LOOKUP_MAX (__NFTA_LOOKUP_MAX - 1)
468 * enum nft_payload_bases - nf_tables payload expression offset bases
470 * @NFT_PAYLOAD_LL_HEADER: link layer header
471 * @NFT_PAYLOAD_NETWORK_HEADER: network header
472 * @NFT_PAYLOAD_TRANSPORT_HEADER: transport header
474 enum nft_payload_bases {
475 NFT_PAYLOAD_LL_HEADER,
476 NFT_PAYLOAD_NETWORK_HEADER,
477 NFT_PAYLOAD_TRANSPORT_HEADER,
481 * enum nft_payload_attributes - nf_tables payload expression netlink attributes
483 * @NFTA_PAYLOAD_DREG: destination register to load data into (NLA_U32: nft_registers)
484 * @NFTA_PAYLOAD_BASE: payload base (NLA_U32: nft_payload_bases)
485 * @NFTA_PAYLOAD_OFFSET: payload offset relative to base (NLA_U32)
486 * @NFTA_PAYLOAD_LEN: payload length (NLA_U32)
488 enum nft_payload_attributes {
496 #define NFTA_PAYLOAD_MAX (__NFTA_PAYLOAD_MAX - 1)
499 * enum nft_exthdr_attributes - nf_tables IPv6 extension header expression netlink attributes
501 * @NFTA_EXTHDR_DREG: destination register (NLA_U32: nft_registers)
502 * @NFTA_EXTHDR_TYPE: extension header type (NLA_U8)
503 * @NFTA_EXTHDR_OFFSET: extension header offset (NLA_U32)
504 * @NFTA_EXTHDR_LEN: extension header length (NLA_U32)
506 enum nft_exthdr_attributes {
514 #define NFTA_EXTHDR_MAX (__NFTA_EXTHDR_MAX - 1)
517 * enum nft_meta_keys - nf_tables meta expression keys
519 * @NFT_META_LEN: packet length (skb->len)
520 * @NFT_META_PROTOCOL: packet ethertype protocol (skb->protocol), invalid in OUTPUT
521 * @NFT_META_PRIORITY: packet priority (skb->priority)
522 * @NFT_META_MARK: packet mark (skb->mark)
523 * @NFT_META_IIF: packet input interface index (dev->ifindex)
524 * @NFT_META_OIF: packet output interface index (dev->ifindex)
525 * @NFT_META_IIFNAME: packet input interface name (dev->name)
526 * @NFT_META_OIFNAME: packet output interface name (dev->name)
527 * @NFT_META_IIFTYPE: packet input interface type (dev->type)
528 * @NFT_META_OIFTYPE: packet output interface type (dev->type)
529 * @NFT_META_SKUID: originating socket UID (fsuid)
530 * @NFT_META_SKGID: originating socket GID (fsgid)
531 * @NFT_META_NFTRACE: packet nftrace bit
532 * @NFT_META_RTCLASSID: realm value of packet's route (skb->dst->tclassid)
533 * @NFT_META_SECMARK: packet secmark (skb->secmark)
534 * @NFT_META_NFPROTO: netfilter protocol
556 * enum nft_meta_attributes - nf_tables meta expression netlink attributes
558 * @NFTA_META_DREG: destination register (NLA_U32)
559 * @NFTA_META_KEY: meta data item to load (NLA_U32: nft_meta_keys)
560 * @NFTA_META_SREG: source register (NLA_U32)
562 enum nft_meta_attributes {
569 #define NFTA_META_MAX (__NFTA_META_MAX - 1)
572 * enum nft_ct_keys - nf_tables ct expression keys
574 * @NFT_CT_STATE: conntrack state (bitmask of enum ip_conntrack_info)
575 * @NFT_CT_DIRECTION: conntrack direction (enum ip_conntrack_dir)
576 * @NFT_CT_STATUS: conntrack status (bitmask of enum ip_conntrack_status)
577 * @NFT_CT_MARK: conntrack mark value
578 * @NFT_CT_SECMARK: conntrack secmark value
579 * @NFT_CT_EXPIRATION: relative conntrack expiration time in ms
580 * @NFT_CT_HELPER: connection tracking helper assigned to conntrack
581 * @NFT_CT_L3PROTOCOL: conntrack layer 3 protocol
582 * @NFT_CT_SRC: conntrack layer 3 protocol source (IPv4/IPv6 address)
583 * @NFT_CT_DST: conntrack layer 3 protocol destination (IPv4/IPv6 address)
584 * @NFT_CT_PROTOCOL: conntrack layer 4 protocol
585 * @NFT_CT_PROTO_SRC: conntrack layer 4 protocol source
586 * @NFT_CT_PROTO_DST: conntrack layer 4 protocol destination
605 * enum nft_ct_attributes - nf_tables ct expression netlink attributes
607 * @NFTA_CT_DREG: destination register (NLA_U32)
608 * @NFTA_CT_KEY: conntrack data item to load (NLA_U32: nft_ct_keys)
609 * @NFTA_CT_DIRECTION: direction in case of directional keys (NLA_U8)
611 enum nft_ct_attributes {
618 #define NFTA_CT_MAX (__NFTA_CT_MAX - 1)
621 * enum nft_limit_attributes - nf_tables limit expression netlink attributes
623 * @NFTA_LIMIT_RATE: refill rate (NLA_U64)
624 * @NFTA_LIMIT_UNIT: refill unit (NLA_U64)
626 enum nft_limit_attributes {
632 #define NFTA_LIMIT_MAX (__NFTA_LIMIT_MAX - 1)
635 * enum nft_counter_attributes - nf_tables counter expression netlink attributes
637 * @NFTA_COUNTER_BYTES: number of bytes (NLA_U64)
638 * @NFTA_COUNTER_PACKETS: number of packets (NLA_U64)
640 enum nft_counter_attributes {
643 NFTA_COUNTER_PACKETS,
646 #define NFTA_COUNTER_MAX (__NFTA_COUNTER_MAX - 1)
649 * enum nft_log_attributes - nf_tables log expression netlink attributes
651 * @NFTA_LOG_GROUP: netlink group to send messages to (NLA_U32)
652 * @NFTA_LOG_PREFIX: prefix to prepend to log messages (NLA_STRING)
653 * @NFTA_LOG_SNAPLEN: length of payload to include in netlink message (NLA_U32)
654 * @NFTA_LOG_QTHRESHOLD: queue threshold (NLA_U32)
656 enum nft_log_attributes {
664 #define NFTA_LOG_MAX (__NFTA_LOG_MAX - 1)
667 * enum nft_queue_attributes - nf_tables queue expression netlink attributes
669 * @NFTA_QUEUE_NUM: netlink queue to send messages to (NLA_U16)
670 * @NFTA_QUEUE_TOTAL: number of queues to load balance packets on (NLA_U16)
671 * @NFTA_QUEUE_FLAGS: various flags (NLA_U16)
673 enum nft_queue_attributes {
680 #define NFTA_QUEUE_MAX (__NFTA_QUEUE_MAX - 1)
682 #define NFT_QUEUE_FLAG_BYPASS 0x01 /* for compatibility with v2 */
683 #define NFT_QUEUE_FLAG_CPU_FANOUT 0x02 /* use current CPU (no hashing) */
684 #define NFT_QUEUE_FLAG_MASK 0x03
687 * enum nft_reject_types - nf_tables reject expression reject types
689 * @NFT_REJECT_ICMP_UNREACH: reject using ICMP unreachable
690 * @NFT_REJECT_TCP_RST: reject using TCP RST
692 enum nft_reject_types {
693 NFT_REJECT_ICMP_UNREACH,
698 * enum nft_reject_attributes - nf_tables reject expression netlink attributes
700 * @NFTA_REJECT_TYPE: packet type to use (NLA_U32: nft_reject_types)
701 * @NFTA_REJECT_ICMP_CODE: ICMP code to use (NLA_U8)
703 enum nft_reject_attributes {
706 NFTA_REJECT_ICMP_CODE,
709 #define NFTA_REJECT_MAX (__NFTA_REJECT_MAX - 1)
712 * enum nft_nat_types - nf_tables nat expression NAT types
714 * @NFT_NAT_SNAT: source NAT
715 * @NFT_NAT_DNAT: destination NAT
723 * enum nft_nat_attributes - nf_tables nat expression netlink attributes
725 * @NFTA_NAT_TYPE: NAT type (NLA_U32: nft_nat_types)
726 * @NFTA_NAT_FAMILY: NAT family (NLA_U32)
727 * @NFTA_NAT_REG_ADDR_MIN: source register of address range start (NLA_U32: nft_registers)
728 * @NFTA_NAT_REG_ADDR_MAX: source register of address range end (NLA_U32: nft_registers)
729 * @NFTA_NAT_REG_PROTO_MIN: source register of proto range start (NLA_U32: nft_registers)
730 * @NFTA_NAT_REG_PROTO_MAX: source register of proto range end (NLA_U32: nft_registers)
732 enum nft_nat_attributes {
736 NFTA_NAT_REG_ADDR_MIN,
737 NFTA_NAT_REG_ADDR_MAX,
738 NFTA_NAT_REG_PROTO_MIN,
739 NFTA_NAT_REG_PROTO_MAX,
742 #define NFTA_NAT_MAX (__NFTA_NAT_MAX - 1)
744 #endif /* _LINUX_NF_TABLES_H */