include/linux/netfilter.h

   1 #ifndef __LINUX_NETFILTER_H
   2 #define __LINUX_NETFILTER_H
   3
   4 #include <linux/init.h>
   5 #include <linux/skbuff.h>
   6 #include <linux/net.h>
   7 #include <linux/if.h>
   8 #include <linux/in.h>
   9 #include <linux/in6.h>
  10 #include <linux/wait.h>
  11 #include <linux/list.h>
  12 #include <linux/static_key.h>
  13 #include <linux/netfilter_defs.h>
  14 #include <linux/netdevice.h>
  15 #include <net/net_namespace.h>
  16
  17 #ifdef CONFIG_NETFILTER
  18 static inline int NF_DROP_GETERR(int verdict)
  19 {
  20         return -(verdict >> NF_VERDICT_QBITS);
  21 }
  22
  23 static inline int nf_inet_addr_cmp(const union nf_inet_addr *a1,
  24                                    const union nf_inet_addr *a2)
  25 {
  26         return a1->all[0] == a2->all[0] &&
  27                a1->all[1] == a2->all[1] &&
  28                a1->all[2] == a2->all[2] &&
  29                a1->all[3] == a2->all[3];
  30 }
  31
  32 static inline void nf_inet_addr_mask(const union nf_inet_addr *a1,
  33                                      union nf_inet_addr *result,
  34                                      const union nf_inet_addr *mask)
  35 {
  36         result->all[0] = a1->all[0] & mask->all[0];
  37         result->all[1] = a1->all[1] & mask->all[1];
  38         result->all[2] = a1->all[2] & mask->all[2];
  39         result->all[3] = a1->all[3] & mask->all[3];
  40 }
  41
  42 int netfilter_init(void);
  43
  44 struct sk_buff;
  45
  46 struct nf_hook_ops;
  47
  48 struct sock;
  49
  50 struct nf_hook_state {
  51         unsigned int hook;
  52         int thresh;
  53         u_int8_t pf;
  54         struct net_device *in;
  55         struct net_device *out;
  56         struct sock *sk;
  57         struct net *net;
  58         struct list_head *hook_list;
  59         int (*okfn)(struct net *, struct sock *, struct sk_buff *);
  60 };
  61
  62 static inline void nf_hook_state_init(struct nf_hook_state *p,
  63                                       struct list_head *hook_list,
  64                                       unsigned int hook,
  65                                       int thresh, u_int8_t pf,
  66                                       struct net_device *indev,
  67                                       struct net_device *outdev,
  68                                       struct sock *sk,
  69                                       struct net *net,
  70                                       int (*okfn)(struct net *, struct sock *, struct sk_buff *))
  71 {
  72         p->hook = hook;
  73         p->thresh = thresh;
  74         p->pf = pf;
  75         p->in = indev;
  76         p->out = outdev;
  77         p->sk = sk;
  78         p->net = net;
  79         p->hook_list = hook_list;
  80         p->okfn = okfn;
  81 }
  82
  83 typedef unsigned int nf_hookfn(void *priv,
  84                                struct sk_buff *skb,
  85                                const struct nf_hook_state *state);
  86
  87 struct nf_hook_ops {
  88         struct list_head        list;
  89
  90         /* User fills in from here down. */
  91         nf_hookfn               *hook;
  92         struct net_device       *dev;
  93         void                    *priv;
  94         u_int8_t                pf;
  95         unsigned int            hooknum;
  96         /* Hooks are ordered in ascending priority. */
  97         int                     priority;
  98 };
  99
 100 struct nf_sockopt_ops {
 101         struct list_head list;
 102
 103         u_int8_t pf;
 104
 105         /* Non-inclusive ranges: use 0/0/NULL to never get called. */
 106         int set_optmin;
 107         int set_optmax;
 108         int (*set)(struct sock *sk, int optval, void __user *user, unsigned int len);
 109 #ifdef CONFIG_COMPAT
 110         int (*compat_set)(struct sock *sk, int optval,
 111                         void __user *user, unsigned int len);
 112 #endif
 113         int get_optmin;
 114         int get_optmax;
 115         int (*get)(struct sock *sk, int optval, void __user *user, int *len);
 116 #ifdef CONFIG_COMPAT
 117         int (*compat_get)(struct sock *sk, int optval,
 118                         void __user *user, int *len);
 119 #endif
 120         /* Use the module struct to lock set/get code in place */
 121         struct module *owner;
 122 };
 123
 124 /* Function to register/unregister hook points. */
 125 int nf_register_net_hook(struct net *net, const struct nf_hook_ops *ops);
 126 void nf_unregister_net_hook(struct net *net, const struct nf_hook_ops *ops);
 127 int nf_register_net_hooks(struct net *net, const struct nf_hook_ops *reg,
 128                           unsigned int n);
 129 void nf_unregister_net_hooks(struct net *net, const struct nf_hook_ops *reg,
 130                              unsigned int n);
 131
 132 int nf_register_hook(struct nf_hook_ops *reg);
 133 void nf_unregister_hook(struct nf_hook_ops *reg);
 134 int nf_register_hooks(struct nf_hook_ops *reg, unsigned int n);
 135 void nf_unregister_hooks(struct nf_hook_ops *reg, unsigned int n);
 136 int _nf_register_hooks(struct nf_hook_ops *reg, unsigned int n);
 137 void _nf_unregister_hooks(struct nf_hook_ops *reg, unsigned int n);
 138
 139 /* Functions to register get/setsockopt ranges (non-inclusive).  You
 140    need to check permissions yourself! */
 141 int nf_register_sockopt(struct nf_sockopt_ops *reg);
 142 void nf_unregister_sockopt(struct nf_sockopt_ops *reg);
 143
 144 #ifdef HAVE_JUMP_LABEL
 145 extern struct static_key nf_hooks_needed[NFPROTO_NUMPROTO][NF_MAX_HOOKS];
 146 #endif
 147
 148 int nf_hook_slow(struct sk_buff *skb, struct nf_hook_state *state);
 149
 150 /**
 151  *      nf_hook_thresh - call a netfilter hook
 152  *
 153  *      Returns 1 if the hook has allowed the packet to pass.  The function
 154  *      okfn must be invoked by the caller in this case.  Any other return
 155  *      value indicates the packet has been consumed by the hook.
 156  */
 157 static inline int nf_hook_thresh(u_int8_t pf, unsigned int hook,
 158                                  struct net *net,
 159                                  struct sock *sk,
 160                                  struct sk_buff *skb,
 161                                  struct net_device *indev,
 162                                  struct net_device *outdev,
 163                                  int (*okfn)(struct net *, struct sock *, struct sk_buff *),
 164                                  int thresh)
 165 {
 166         struct list_head *hook_list;
 167
 168 #ifdef HAVE_JUMP_LABEL
 169         if (__builtin_constant_p(pf) &&
 170             __builtin_constant_p(hook) &&
 171             !static_key_false(&nf_hooks_needed[pf][hook]))
 172                 return 1;
 173 #endif
 174
 175         hook_list = &net->nf.hooks[pf][hook];
 176
 177         if (!list_empty(hook_list)) {
 178                 struct nf_hook_state state;
 179
 180                 nf_hook_state_init(&state, hook_list, hook, thresh,
 181                                    pf, indev, outdev, sk, net, okfn);
 182                 return nf_hook_slow(skb, &state);
 183         }
 184         return 1;
 185 }
 186
 187 static inline int nf_hook(u_int8_t pf, unsigned int hook, struct net *net,
 188                           struct sock *sk, struct sk_buff *skb,
 189                           struct net_device *indev, struct net_device *outdev,
 190                           int (*okfn)(struct net *, struct sock *, struct sk_buff *))
 191 {
 192         return nf_hook_thresh(pf, hook, net, sk, skb, indev, outdev, okfn, INT_MIN);
 193 }
 194
 195 /* Activate hook; either okfn or kfree_skb called, unless a hook
 196    returns NF_STOLEN (in which case, it's up to the hook to deal with
 197    the consequences).
 198
 199    Returns -ERRNO if packet dropped.  Zero means queued, stolen or
 200    accepted.
 201 */
 202
 203 /* RR:
 204    > I don't want nf_hook to return anything because people might forget
 205    > about async and trust the return value to mean "packet was ok".
 206
 207    AK:
 208    Just document it clearly, then you can expect some sense from kernel
 209    coders :)
 210 */
 211
 212 static inline int
 213 NF_HOOK_THRESH(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk,
 214                struct sk_buff *skb, struct net_device *in,
 215                struct net_device *out,
 216                int (*okfn)(struct net *, struct sock *, struct sk_buff *),
 217                int thresh)
 218 {
 219         int ret = nf_hook_thresh(pf, hook, net, sk, skb, in, out, okfn, thresh);
 220         if (ret == 1)
 221                 ret = okfn(net, sk, skb);
 222         return ret;
 223 }
 224
 225 static inline int
 226 NF_HOOK_COND(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk,
 227              struct sk_buff *skb, struct net_device *in, struct net_device *out,
 228              int (*okfn)(struct net *, struct sock *, struct sk_buff *),
 229              bool cond)
 230 {
 231         int ret;
 232
 233         if (!cond ||
 234             ((ret = nf_hook_thresh(pf, hook, net, sk, skb, in, out, okfn, INT_MIN)) == 1))
 235                 ret = okfn(net, sk, skb);
 236         return ret;
 237 }
 238
 239 static inline int
 240 NF_HOOK(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk, struct sk_buff *skb,
 241         struct net_device *in, struct net_device *out,
 242         int (*okfn)(struct net *, struct sock *, struct sk_buff *))
 243 {
 244         return NF_HOOK_THRESH(pf, hook, net, sk, skb, in, out, okfn, INT_MIN);
 245 }
 246
 247 /* Call setsockopt() */
 248 int nf_setsockopt(struct sock *sk, u_int8_t pf, int optval, char __user *opt,
 249                   unsigned int len);
 250 int nf_getsockopt(struct sock *sk, u_int8_t pf, int optval, char __user *opt,
 251                   int *len);
 252 #ifdef CONFIG_COMPAT
 253 int compat_nf_setsockopt(struct sock *sk, u_int8_t pf, int optval,
 254                 char __user *opt, unsigned int len);
 255 int compat_nf_getsockopt(struct sock *sk, u_int8_t pf, int optval,
 256                 char __user *opt, int *len);
 257 #endif
 258
 259 /* Call this before modifying an existing packet: ensures it is
 260    modifiable and linear to the point you care about (writable_len).
 261    Returns true or false. */
 262 int skb_make_writable(struct sk_buff *skb, unsigned int writable_len);
 263
 264 struct flowi;
 265 struct nf_queue_entry;
 266
 267 struct nf_afinfo {
 268         unsigned short  family;
 269         __sum16         (*checksum)(struct sk_buff *skb, unsigned int hook,
 270                                     unsigned int dataoff, u_int8_t protocol);
 271         __sum16         (*checksum_partial)(struct sk_buff *skb,
 272                                             unsigned int hook,
 273                                             unsigned int dataoff,
 274                                             unsigned int len,
 275                                             u_int8_t protocol);
 276         int             (*route)(struct net *net, struct dst_entry **dst,
 277                                  struct flowi *fl, bool strict);
 278         void            (*saveroute)(const struct sk_buff *skb,
 279                                      struct nf_queue_entry *entry);
 280         int             (*reroute)(struct net *net, struct sk_buff *skb,
 281                                    const struct nf_queue_entry *entry);
 282         int             route_key_size;
 283 };
 284
 285 extern const struct nf_afinfo __rcu *nf_afinfo[NFPROTO_NUMPROTO];
 286 static inline const struct nf_afinfo *nf_get_afinfo(unsigned short family)
 287 {
 288         return rcu_dereference(nf_afinfo[family]);
 289 }
 290
 291 static inline __sum16
 292 nf_checksum(struct sk_buff *skb, unsigned int hook, unsigned int dataoff,
 293             u_int8_t protocol, unsigned short family)
 294 {
 295         const struct nf_afinfo *afinfo;
 296         __sum16 csum = 0;
 297
 298         rcu_read_lock();
 299         afinfo = nf_get_afinfo(family);
 300         if (afinfo)
 301                 csum = afinfo->checksum(skb, hook, dataoff, protocol);
 302         rcu_read_unlock();
 303         return csum;
 304 }
 305
 306 static inline __sum16
 307 nf_checksum_partial(struct sk_buff *skb, unsigned int hook,
 308                     unsigned int dataoff, unsigned int len,
 309                     u_int8_t protocol, unsigned short family)
 310 {
 311         const struct nf_afinfo *afinfo;
 312         __sum16 csum = 0;
 313
 314         rcu_read_lock();
 315         afinfo = nf_get_afinfo(family);
 316         if (afinfo)
 317                 csum = afinfo->checksum_partial(skb, hook, dataoff, len,
 318                                                 protocol);
 319         rcu_read_unlock();
 320         return csum;
 321 }
 322
 323 int nf_register_afinfo(const struct nf_afinfo *afinfo);
 324 void nf_unregister_afinfo(const struct nf_afinfo *afinfo);
 325
 326 #include <net/flow.h>
 327 extern void (*nf_nat_decode_session_hook)(struct sk_buff *, struct flowi *);
 328
 329 static inline void
 330 nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, u_int8_t family)
 331 {
 332 #ifdef CONFIG_NF_NAT_NEEDED
 333         void (*decodefn)(struct sk_buff *, struct flowi *);
 334
 335         rcu_read_lock();
 336         decodefn = rcu_dereference(nf_nat_decode_session_hook);
 337         if (decodefn)
 338                 decodefn(skb, fl);
 339         rcu_read_unlock();
 340 #endif
 341 }
 342
 343 #else /* !CONFIG_NETFILTER */
 344 static inline int
 345 NF_HOOK_COND(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk,
 346              struct sk_buff *skb, struct net_device *in, struct net_device *out,
 347              int (*okfn)(struct net *, struct sock *, struct sk_buff *),
 348              bool cond)
 349 {
 350         return okfn(net, sk, skb);
 351 }
 352
 353 static inline int
 354 NF_HOOK(uint8_t pf, unsigned int hook, struct net *net, struct sock *sk,
 355         struct sk_buff *skb, struct net_device *in, struct net_device *out,
 356         int (*okfn)(struct net *, struct sock *, struct sk_buff *))
 357 {
 358         return okfn(net, sk, skb);
 359 }
 360
 361 static inline int nf_hook(u_int8_t pf, unsigned int hook, struct net *net,
 362                           struct sock *sk, struct sk_buff *skb,
 363                           struct net_device *indev, struct net_device *outdev,
 364                           int (*okfn)(struct net *, struct sock *, struct sk_buff *))
 365 {
 366         return 1;
 367 }
 368 struct flowi;
 369 static inline void
 370 nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, u_int8_t family)
 371 {
 372 }
 373 #endif /*CONFIG_NETFILTER*/
 374
 375 #if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
 376 #include <linux/netfilter/nf_conntrack_zones_common.h>
 377
 378 extern void (*ip_ct_attach)(struct sk_buff *, const struct sk_buff *) __rcu;
 379 void nf_ct_attach(struct sk_buff *, const struct sk_buff *);
 380 extern void (*nf_ct_destroy)(struct nf_conntrack *) __rcu;
 381 #else
 382 static inline void nf_ct_attach(struct sk_buff *new, struct sk_buff *skb) {}
 383 #endif
 384
 385 struct nf_conn;
 386 enum ip_conntrack_info;
 387 struct nlattr;
 388
 389 struct nfnl_ct_hook {
 390         struct nf_conn *(*get_ct)(const struct sk_buff *skb,
 391                                   enum ip_conntrack_info *ctinfo);
 392         size_t (*build_size)(const struct nf_conn *ct);
 393         int (*build)(struct sk_buff *skb, struct nf_conn *ct,
 394                      enum ip_conntrack_info ctinfo,
 395                      u_int16_t ct_attr, u_int16_t ct_info_attr);
 396         int (*parse)(const struct nlattr *attr, struct nf_conn *ct);
 397         int (*attach_expect)(const struct nlattr *attr, struct nf_conn *ct,
 398                              u32 portid, u32 report);
 399         void (*seq_adjust)(struct sk_buff *skb, struct nf_conn *ct,
 400                            enum ip_conntrack_info ctinfo, s32 off);
 401 };
 402 extern struct nfnl_ct_hook __rcu *nfnl_ct_hook;
 403
 404 /**
 405  * nf_skb_duplicated - TEE target has sent a packet
 406  *
 407  * When a xtables target sends a packet, the OUTPUT and POSTROUTING
 408  * hooks are traversed again, i.e. nft and xtables are invoked recursively.
 409  *
 410  * This is used by xtables TEE target to prevent the duplicated skb from
 411  * being duplicated again.
 412  */
 413 DECLARE_PER_CPU(bool, nf_skb_duplicated);
 414
 415 #endif /*__LINUX_NETFILTER_H*/