include/net/netfilter/nf_tables.h

   1 #ifndef _NET_NF_TABLES_H
   2 #define _NET_NF_TABLES_H
   3
   4 #include <linux/list.h>
   5 #include <linux/netfilter.h>
   6 #include <linux/netfilter/nfnetlink.h>
   7 #include <linux/netfilter/x_tables.h>
   8 #include <linux/netfilter/nf_tables.h>
   9 #include <net/netlink.h>
  10
  11 #define NFT_JUMP_STACK_SIZE     16
  12
  13 struct nft_pktinfo {
  14         struct sk_buff                  *skb;
  15         const struct net_device         *in;
  16         const struct net_device         *out;
  17         const struct nf_hook_ops        *ops;
  18         u8                              nhoff;
  19         u8                              thoff;
  20         u8                              tprot;
  21         /* for x_tables compatibility */
  22         struct xt_action_param          xt;
  23 };
  24
  25 static inline void nft_set_pktinfo(struct nft_pktinfo *pkt,
  26                                    const struct nf_hook_ops *ops,
  27                                    struct sk_buff *skb,
  28                                    const struct net_device *in,
  29                                    const struct net_device *out)
  30 {
  31         pkt->skb = skb;
  32         pkt->in = pkt->xt.in = in;
  33         pkt->out = pkt->xt.out = out;
  34         pkt->ops = ops;
  35         pkt->xt.hooknum = ops->hooknum;
  36         pkt->xt.family = ops->pf;
  37 }
  38
  39 struct nft_data {
  40         union {
  41                 u32                             data[4];
  42                 struct {
  43                         u32                     verdict;
  44                         struct nft_chain        *chain;
  45                 };
  46         };
  47 } __attribute__((aligned(__alignof__(u64))));
  48
  49 static inline int nft_data_cmp(const struct nft_data *d1,
  50                                const struct nft_data *d2,
  51                                unsigned int len)
  52 {
  53         return memcmp(d1->data, d2->data, len);
  54 }
  55
  56 static inline void nft_data_copy(struct nft_data *dst,
  57                                  const struct nft_data *src)
  58 {
  59         BUILD_BUG_ON(__alignof__(*dst) != __alignof__(u64));
  60         *(u64 *)&dst->data[0] = *(u64 *)&src->data[0];
  61         *(u64 *)&dst->data[2] = *(u64 *)&src->data[2];
  62 }
  63
  64 static inline void nft_data_debug(const struct nft_data *data)
  65 {
  66         pr_debug("data[0]=%x data[1]=%x data[2]=%x data[3]=%x\n",
  67                  data->data[0], data->data[1],
  68                  data->data[2], data->data[3]);
  69 }
  70
  71 /**
  72  *      struct nft_ctx - nf_tables rule/set context
  73  *
  74  *      @net: net namespace
  75  *      @skb: netlink skb
  76  *      @nlh: netlink message header
  77  *      @afi: address family info
  78  *      @table: the table the chain is contained in
  79  *      @chain: the chain the rule is contained in
  80  *      @nla: netlink attributes
  81  */
  82 struct nft_ctx {
  83         struct net                      *net;
  84         const struct sk_buff            *skb;
  85         const struct nlmsghdr           *nlh;
  86         const struct nft_af_info        *afi;
  87         const struct nft_table          *table;
  88         const struct nft_chain          *chain;
  89         const struct nlattr * const     *nla;
  90 };
  91
  92 struct nft_data_desc {
  93         enum nft_data_types             type;
  94         unsigned int                    len;
  95 };
  96
  97 int nft_data_init(const struct nft_ctx *ctx, struct nft_data *data,
  98                   struct nft_data_desc *desc, const struct nlattr *nla);
  99 void nft_data_uninit(const struct nft_data *data, enum nft_data_types type);
 100 int nft_data_dump(struct sk_buff *skb, int attr, const struct nft_data *data,
 101                   enum nft_data_types type, unsigned int len);
 102
 103 static inline enum nft_data_types nft_dreg_to_type(enum nft_registers reg)
 104 {
 105         return reg == NFT_REG_VERDICT ? NFT_DATA_VERDICT : NFT_DATA_VALUE;
 106 }
 107
 108 static inline enum nft_registers nft_type_to_reg(enum nft_data_types type)
 109 {
 110         return type == NFT_DATA_VERDICT ? NFT_REG_VERDICT : NFT_REG_1;
 111 }
 112
 113 int nft_validate_input_register(enum nft_registers reg);
 114 int nft_validate_output_register(enum nft_registers reg);
 115 int nft_validate_data_load(const struct nft_ctx *ctx, enum nft_registers reg,
 116                            const struct nft_data *data,
 117                            enum nft_data_types type);
 118
 119 /**
 120  *      struct nft_set_elem - generic representation of set elements
 121  *
 122  *      @cookie: implementation specific element cookie
 123  *      @key: element key
 124  *      @data: element data (maps only)
 125  *      @flags: element flags (end of interval)
 126  *
 127  *      The cookie can be used to store a handle to the element for subsequent
 128  *      removal.
 129  */
 130 struct nft_set_elem {
 131         void                    *cookie;
 132         struct nft_data         key;
 133         struct nft_data         data;
 134         u32                     flags;
 135 };
 136
 137 struct nft_set;
 138 struct nft_set_iter {
 139         unsigned int    count;
 140         unsigned int    skip;
 141         int             err;
 142         int             (*fn)(const struct nft_ctx *ctx,
 143                               const struct nft_set *set,
 144                               const struct nft_set_iter *iter,
 145                               const struct nft_set_elem *elem);
 146 };
 147
 148 /**
 149  *      struct nft_set_desc - description of set elements
 150  *
 151  *      @klen: key length
 152  *      @dlen: data length
 153  *      @size: number of set elements
 154  */
 155 struct nft_set_desc {
 156         unsigned int            klen;
 157         unsigned int            dlen;
 158         unsigned int            size;
 159 };
 160
 161 /**
 162  *      enum nft_set_class - performance class
 163  *
 164  *      @NFT_LOOKUP_O_1: constant, O(1)
 165  *      @NFT_LOOKUP_O_LOG_N: logarithmic, O(log N)
 166  *      @NFT_LOOKUP_O_N: linear, O(N)
 167  */
 168 enum nft_set_class {
 169         NFT_SET_CLASS_O_1,
 170         NFT_SET_CLASS_O_LOG_N,
 171         NFT_SET_CLASS_O_N,
 172 };
 173
 174 /**
 175  *      struct nft_set_estimate - estimation of memory and performance
 176  *                                characteristics
 177  *
 178  *      @size: required memory
 179  *      @class: lookup performance class
 180  */
 181 struct nft_set_estimate {
 182         unsigned int            size;
 183         enum nft_set_class      class;
 184 };
 185
 186 /**
 187  *      struct nft_set_ops - nf_tables set operations
 188  *
 189  *      @lookup: look up an element within the set
 190  *      @insert: insert new element into set
 191  *      @remove: remove element from set
 192  *      @walk: iterate over all set elemeennts
 193  *      @privsize: function to return size of set private data
 194  *      @init: initialize private data of new set instance
 195  *      @destroy: destroy private data of set instance
 196  *      @list: nf_tables_set_ops list node
 197  *      @owner: module reference
 198  *      @features: features supported by the implementation
 199  */
 200 struct nft_set_ops {
 201         bool                            (*lookup)(const struct nft_set *set,
 202                                                   const struct nft_data *key,
 203                                                   struct nft_data *data);
 204         int                             (*get)(const struct nft_set *set,
 205                                                struct nft_set_elem *elem);
 206         int                             (*insert)(const struct nft_set *set,
 207                                                   const struct nft_set_elem *elem);
 208         void                            (*remove)(const struct nft_set *set,
 209                                                   const struct nft_set_elem *elem);
 210         void                            (*walk)(const struct nft_ctx *ctx,
 211                                                 const struct nft_set *set,
 212                                                 struct nft_set_iter *iter);
 213
 214         unsigned int                    (*privsize)(const struct nlattr * const nla[]);
 215         bool                            (*estimate)(const struct nft_set_desc *desc,
 216                                                     u32 features,
 217                                                     struct nft_set_estimate *est);
 218         int                             (*init)(const struct nft_set *set,
 219                                                 const struct nft_set_desc *desc,
 220                                                 const struct nlattr * const nla[]);
 221         void                            (*destroy)(const struct nft_set *set);
 222
 223         struct list_head                list;
 224         struct module                   *owner;
 225         u32                             features;
 226 };
 227
 228 int nft_register_set(struct nft_set_ops *ops);
 229 void nft_unregister_set(struct nft_set_ops *ops);
 230
 231 /**
 232  *      struct nft_set - nf_tables set instance
 233  *
 234  *      @list: table set list node
 235  *      @bindings: list of set bindings
 236  *      @name: name of the set
 237  *      @ktype: key type (numeric type defined by userspace, not used in the kernel)
 238  *      @dtype: data type (verdict or numeric type defined by userspace)
 239  *      @size: maximum set size
 240  *      @nelems: number of elements
 241  *      @ops: set ops
 242  *      @flags: set flags
 243  *      @klen: key length
 244  *      @dlen: data length
 245  *      @data: private set data
 246  */
 247 struct nft_set {
 248         struct list_head                list;
 249         struct list_head                bindings;
 250         char                            name[IFNAMSIZ];
 251         u32                             ktype;
 252         u32                             dtype;
 253         u32                             size;
 254         u32                             nelems;
 255         /* runtime data below here */
 256         const struct nft_set_ops        *ops ____cacheline_aligned;
 257         u16                             flags;
 258         u8                              klen;
 259         u8                              dlen;
 260         unsigned char                   data[]
 261                 __attribute__((aligned(__alignof__(u64))));
 262 };
 263
 264 static inline void *nft_set_priv(const struct nft_set *set)
 265 {
 266         return (void *)set->data;
 267 }
 268
 269 struct nft_set *nf_tables_set_lookup(const struct nft_table *table,
 270                                      const struct nlattr *nla);
 271
 272 /**
 273  *      struct nft_set_binding - nf_tables set binding
 274  *
 275  *      @list: set bindings list node
 276  *      @chain: chain containing the rule bound to the set
 277  *
 278  *      A set binding contains all information necessary for validation
 279  *      of new elements added to a bound set.
 280  */
 281 struct nft_set_binding {
 282         struct list_head                list;
 283         const struct nft_chain          *chain;
 284 };
 285
 286 int nf_tables_bind_set(const struct nft_ctx *ctx, struct nft_set *set,
 287                        struct nft_set_binding *binding);
 288 void nf_tables_unbind_set(const struct nft_ctx *ctx, struct nft_set *set,
 289                           struct nft_set_binding *binding);
 290
 291
 292 /**
 293  *      struct nft_expr_type - nf_tables expression type
 294  *
 295  *      @select_ops: function to select nft_expr_ops
 296  *      @ops: default ops, used when no select_ops functions is present
 297  *      @list: used internally
 298  *      @name: Identifier
 299  *      @owner: module reference
 300  *      @policy: netlink attribute policy
 301  *      @maxattr: highest netlink attribute number
 302  *      @family: address family for AF-specific types
 303  */
 304 struct nft_expr_type {
 305         const struct nft_expr_ops       *(*select_ops)(const struct nft_ctx *,
 306                                                        const struct nlattr * const tb[]);
 307         const struct nft_expr_ops       *ops;
 308         struct list_head                list;
 309         const char                      *name;
 310         struct module                   *owner;
 311         const struct nla_policy         *policy;
 312         unsigned int                    maxattr;
 313         u8                              family;
 314 };
 315
 316 /**
 317  *      struct nft_expr_ops - nf_tables expression operations
 318  *
 319  *      @eval: Expression evaluation function
 320  *      @size: full expression size, including private data size
 321  *      @init: initialization function
 322  *      @destroy: destruction function
 323  *      @dump: function to dump parameters
 324  *      @type: expression type
 325  *      @validate: validate expression, called during loop detection
 326  *      @data: extra data to attach to this expression operation
 327  */
 328 struct nft_expr;
 329 struct nft_expr_ops {
 330         void                            (*eval)(const struct nft_expr *expr,
 331                                                 struct nft_data data[NFT_REG_MAX + 1],
 332                                                 const struct nft_pktinfo *pkt);
 333         unsigned int                    size;
 334
 335         int                             (*init)(const struct nft_ctx *ctx,
 336                                                 const struct nft_expr *expr,
 337                                                 const struct nlattr * const tb[]);
 338         void                            (*destroy)(const struct nft_ctx *ctx,
 339                                                    const struct nft_expr *expr);
 340         int                             (*dump)(struct sk_buff *skb,
 341                                                 const struct nft_expr *expr);
 342         int                             (*validate)(const struct nft_ctx *ctx,
 343                                                     const struct nft_expr *expr,
 344                                                     const struct nft_data **data);
 345         const struct nft_expr_type      *type;
 346         void                            *data;
 347 };
 348
 349 #define NFT_EXPR_MAXATTR                16
 350 #define NFT_EXPR_SIZE(size)             (sizeof(struct nft_expr) + \
 351                                          ALIGN(size, __alignof__(struct nft_expr)))
 352
 353 /**
 354  *      struct nft_expr - nf_tables expression
 355  *
 356  *      @ops: expression ops
 357  *      @data: expression private data
 358  */
 359 struct nft_expr {
 360         const struct nft_expr_ops       *ops;
 361         unsigned char                   data[];
 362 };
 363
 364 static inline void *nft_expr_priv(const struct nft_expr *expr)
 365 {
 366         return (void *)expr->data;
 367 }
 368
 369 /**
 370  *      struct nft_rule - nf_tables rule
 371  *
 372  *      @list: used internally
 373  *      @handle: rule handle
 374  *      @genmask: generation mask
 375  *      @dlen: length of expression data
 376  *      @ulen: length of user data (used for comments)
 377  *      @data: expression data
 378  */
 379 struct nft_rule {
 380         struct list_head                list;
 381         u64                             handle:42,
 382                                         genmask:2,
 383                                         dlen:12,
 384                                         ulen:8;
 385         unsigned char                   data[]
 386                 __attribute__((aligned(__alignof__(struct nft_expr))));
 387 };
 388
 389 /**
 390  *      struct nft_rule_trans - nf_tables rule update in transaction
 391  *
 392  *      @list: used internally
 393  *      @ctx: rule context
 394  *      @rule: rule that needs to be updated
 395  */
 396 struct nft_rule_trans {
 397         struct list_head                list;
 398         struct nft_ctx                  ctx;
 399         struct nft_rule                 *rule;
 400 };
 401
 402 static inline struct nft_expr *nft_expr_first(const struct nft_rule *rule)
 403 {
 404         return (struct nft_expr *)&rule->data[0];
 405 }
 406
 407 static inline struct nft_expr *nft_expr_next(const struct nft_expr *expr)
 408 {
 409         return ((void *)expr) + expr->ops->size;
 410 }
 411
 412 static inline struct nft_expr *nft_expr_last(const struct nft_rule *rule)
 413 {
 414         return (struct nft_expr *)&rule->data[rule->dlen];
 415 }
 416
 417 static inline void *nft_userdata(const struct nft_rule *rule)
 418 {
 419         return (void *)&rule->data[rule->dlen];
 420 }
 421
 422 /*
 423  * The last pointer isn't really necessary, but the compiler isn't able to
 424  * determine that the result of nft_expr_last() is always the same since it
 425  * can't assume that the dlen value wasn't changed within calls in the loop.
 426  */
 427 #define nft_rule_for_each_expr(expr, last, rule) \
 428         for ((expr) = nft_expr_first(rule), (last) = nft_expr_last(rule); \
 429              (expr) != (last); \
 430              (expr) = nft_expr_next(expr))
 431
 432 enum nft_chain_flags {
 433         NFT_BASE_CHAIN                  = 0x1,
 434 };
 435
 436 /**
 437  *      struct nft_chain - nf_tables chain
 438  *
 439  *      @rules: list of rules in the chain
 440  *      @list: used internally
 441  *      @net: net namespace that this chain belongs to
 442  *      @table: table that this chain belongs to
 443  *      @handle: chain handle
 444  *      @flags: bitmask of enum nft_chain_flags
 445  *      @use: number of jump references to this chain
 446  *      @level: length of longest path to this chain
 447  *      @name: name of the chain
 448  */
 449 struct nft_chain {
 450         struct list_head                rules;
 451         struct list_head                list;
 452         struct net                      *net;
 453         struct nft_table                *table;
 454         u64                             handle;
 455         u8                              flags;
 456         u16                             use;
 457         u16                             level;
 458         char                            name[NFT_CHAIN_MAXNAMELEN];
 459 };
 460
 461 enum nft_chain_type {
 462         NFT_CHAIN_T_DEFAULT = 0,
 463         NFT_CHAIN_T_ROUTE,
 464         NFT_CHAIN_T_NAT,
 465         NFT_CHAIN_T_MAX
 466 };
 467
 468 struct nft_stats {
 469         u64 bytes;
 470         u64 pkts;
 471 };
 472
 473 #define NFT_HOOK_OPS_MAX                2
 474
 475 /**
 476  *      struct nft_base_chain - nf_tables base chain
 477  *
 478  *      @ops: netfilter hook ops
 479  *      @type: chain type
 480  *      @policy: default policy
 481  *      @stats: per-cpu chain stats
 482  *      @chain: the chain
 483  */
 484 struct nft_base_chain {
 485         struct nf_hook_ops              ops[NFT_HOOK_OPS_MAX];
 486         const struct nf_chain_type      *type;
 487         u8                              policy;
 488         struct nft_stats __percpu       *stats;
 489         struct nft_chain                chain;
 490 };
 491
 492 static inline struct nft_base_chain *nft_base_chain(const struct nft_chain *chain)
 493 {
 494         return container_of(chain, struct nft_base_chain, chain);
 495 }
 496
 497 unsigned int nft_do_chain(struct nft_pktinfo *pkt,
 498                           const struct nf_hook_ops *ops);
 499
 500 /**
 501  *      struct nft_table - nf_tables table
 502  *
 503  *      @list: used internally
 504  *      @chains: chains in the table
 505  *      @sets: sets in the table
 506  *      @hgenerator: handle generator state
 507  *      @use: number of chain references to this table
 508  *      @flags: table flag (see enum nft_table_flags)
 509  *      @name: name of the table
 510  */
 511 struct nft_table {
 512         struct list_head                list;
 513         struct list_head                chains;
 514         struct list_head                sets;
 515         u64                             hgenerator;
 516         u32                             use;
 517         u16                             flags;
 518         char                            name[];
 519 };
 520
 521 /**
 522  *      struct nft_af_info - nf_tables address family info
 523  *
 524  *      @list: used internally
 525  *      @family: address family
 526  *      @nhooks: number of hooks in this family
 527  *      @owner: module owner
 528  *      @tables: used internally
 529  *      @nops: number of hook ops in this family
 530  *      @hook_ops_init: initialization function for chain hook ops
 531  *      @hooks: hookfn overrides for packet validation
 532  */
 533 struct nft_af_info {
 534         struct list_head                list;
 535         int                             family;
 536         unsigned int                    nhooks;
 537         struct module                   *owner;
 538         struct list_head                tables;
 539         unsigned int                    nops;
 540         void                            (*hook_ops_init)(struct nf_hook_ops *,
 541                                                          unsigned int);
 542         nf_hookfn                       *hooks[NF_MAX_HOOKS];
 543 };
 544
 545 int nft_register_afinfo(struct net *, struct nft_af_info *);
 546 void nft_unregister_afinfo(struct nft_af_info *);
 547
 548 /**
 549  *      struct nf_chain_type - nf_tables chain type info
 550  *
 551  *      @name: name of the type
 552  *      @type: numeric identifier
 553  *      @family: address family
 554  *      @owner: module owner
 555  *      @hook_mask: mask of valid hooks
 556  *      @hooks: hookfn overrides
 557  */
 558 struct nf_chain_type {
 559         const char                      *name;
 560         enum nft_chain_type             type;
 561         int                             family;
 562         struct module                   *owner;
 563         unsigned int                    hook_mask;
 564         nf_hookfn                       *hooks[NF_MAX_HOOKS];
 565 };
 566
 567 int nft_register_chain_type(const struct nf_chain_type *);
 568 void nft_unregister_chain_type(const struct nf_chain_type *);
 569
 570 int nft_register_expr(struct nft_expr_type *);
 571 void nft_unregister_expr(struct nft_expr_type *);
 572
 573 #define nft_dereference(p)                                      \
 574         nfnl_dereference(p, NFNL_SUBSYS_NFTABLES)
 575
 576 #define MODULE_ALIAS_NFT_FAMILY(family) \
 577         MODULE_ALIAS("nft-afinfo-" __stringify(family))
 578
 579 #define MODULE_ALIAS_NFT_CHAIN(family, name) \
 580         MODULE_ALIAS("nft-chain-" __stringify(family) "-" name)
 581
 582 #define MODULE_ALIAS_NFT_AF_EXPR(family, name) \
 583         MODULE_ALIAS("nft-expr-" __stringify(family) "-" name)
 584
 585 #define MODULE_ALIAS_NFT_EXPR(name) \
 586         MODULE_ALIAS("nft-expr-" name)
 587
 588 #define MODULE_ALIAS_NFT_SET() \
 589         MODULE_ALIAS("nft-set")
 590
 591 #endif /* _NET_NF_TABLES_H */