1 /* netfilter.c: look after the filters for various protocols.
2 * Heavily influenced by the old firewall.c by David Bonn and Alan Cox.
4 * Thanks to Rob `CmdrTaco' Malda for not influencing this code in any
9 #include <linux/kernel.h>
10 #include <linux/netfilter.h>
11 #include <net/protocol.h>
12 #include <linux/init.h>
13 #include <linux/skbuff.h>
14 #include <linux/wait.h>
15 #include <linux/module.h>
16 #include <linux/interrupt.h>
18 #include <linux/netdevice.h>
19 #include <linux/netfilter_ipv6.h>
20 #include <linux/inetdevice.h>
21 #include <linux/proc_fs.h>
22 #include <linux/mutex.h>
24 #include <linux/rcupdate.h>
25 #include <net/net_namespace.h>
26 #include <net/netfilter/nf_queue.h>
29 #include "nf_internals.h"
31 const struct nf_ipv6_ops __rcu *nf_ipv6_ops __read_mostly;
32 EXPORT_SYMBOL_GPL(nf_ipv6_ops);
34 DEFINE_PER_CPU(bool, nf_skb_duplicated);
35 EXPORT_SYMBOL_GPL(nf_skb_duplicated);
37 #ifdef CONFIG_JUMP_LABEL
38 struct static_key nf_hooks_needed[NFPROTO_NUMPROTO][NF_MAX_HOOKS];
39 EXPORT_SYMBOL(nf_hooks_needed);
42 static DEFINE_MUTEX(nf_hook_mutex);
44 /* max hooks per family/hooknum */
45 #define MAX_HOOK_COUNT 1024
47 #define nf_entry_dereference(e) \
48 rcu_dereference_protected(e, lockdep_is_held(&nf_hook_mutex))
50 static struct nf_hook_entries *allocate_hook_entries_size(u16 num)
52 struct nf_hook_entries *e;
53 size_t alloc = sizeof(*e) +
54 sizeof(struct nf_hook_entry) * num +
55 sizeof(struct nf_hook_ops *) * num +
56 sizeof(struct nf_hook_entries_rcu_head);
61 e = kvzalloc(alloc, GFP_KERNEL_ACCOUNT);
63 e->num_hook_entries = num;
67 static void __nf_hook_entries_free(struct rcu_head *h)
69 struct nf_hook_entries_rcu_head *head;
71 head = container_of(h, struct nf_hook_entries_rcu_head, head);
72 kvfree(head->allocation);
75 static void nf_hook_entries_free(struct nf_hook_entries *e)
77 struct nf_hook_entries_rcu_head *head;
78 struct nf_hook_ops **ops;
84 num = e->num_hook_entries;
85 ops = nf_hook_entries_get_hook_ops(e);
86 head = (void *)&ops[num];
88 call_rcu(&head->head, __nf_hook_entries_free);
91 static unsigned int accept_all(void *priv,
93 const struct nf_hook_state *state)
95 return NF_ACCEPT; /* ACCEPT makes nf_hook_slow call next hook */
98 static const struct nf_hook_ops dummy_ops = {
103 static struct nf_hook_entries *
104 nf_hook_entries_grow(const struct nf_hook_entries *old,
105 const struct nf_hook_ops *reg)
107 unsigned int i, alloc_entries, nhooks, old_entries;
108 struct nf_hook_ops **orig_ops = NULL;
109 struct nf_hook_ops **new_ops;
110 struct nf_hook_entries *new;
111 bool inserted = false;
114 old_entries = old ? old->num_hook_entries : 0;
117 orig_ops = nf_hook_entries_get_hook_ops(old);
119 for (i = 0; i < old_entries; i++) {
120 if (orig_ops[i] != &dummy_ops)
125 if (alloc_entries > MAX_HOOK_COUNT)
126 return ERR_PTR(-E2BIG);
128 new = allocate_hook_entries_size(alloc_entries);
130 return ERR_PTR(-ENOMEM);
132 new_ops = nf_hook_entries_get_hook_ops(new);
136 while (i < old_entries) {
137 if (orig_ops[i] == &dummy_ops) {
142 if (inserted || reg->priority > orig_ops[i]->priority) {
143 new_ops[nhooks] = (void *)orig_ops[i];
144 new->hooks[nhooks] = old->hooks[i];
147 new_ops[nhooks] = (void *)reg;
148 new->hooks[nhooks].hook = reg->hook;
149 new->hooks[nhooks].priv = reg->priv;
156 new_ops[nhooks] = (void *)reg;
157 new->hooks[nhooks].hook = reg->hook;
158 new->hooks[nhooks].priv = reg->priv;
164 static void hooks_validate(const struct nf_hook_entries *hooks)
166 #ifdef CONFIG_DEBUG_MISC
167 struct nf_hook_ops **orig_ops;
171 orig_ops = nf_hook_entries_get_hook_ops(hooks);
173 for (i = 0; i < hooks->num_hook_entries; i++) {
174 if (orig_ops[i] == &dummy_ops)
177 WARN_ON(orig_ops[i]->priority < prio);
179 if (orig_ops[i]->priority > prio)
180 prio = orig_ops[i]->priority;
185 int nf_hook_entries_insert_raw(struct nf_hook_entries __rcu **pp,
186 const struct nf_hook_ops *reg)
188 struct nf_hook_entries *new_hooks;
189 struct nf_hook_entries *p;
191 p = rcu_dereference_raw(*pp);
192 new_hooks = nf_hook_entries_grow(p, reg);
193 if (IS_ERR(new_hooks))
194 return PTR_ERR(new_hooks);
196 hooks_validate(new_hooks);
198 rcu_assign_pointer(*pp, new_hooks);
200 BUG_ON(p == new_hooks);
201 nf_hook_entries_free(p);
204 EXPORT_SYMBOL_GPL(nf_hook_entries_insert_raw);
207 * __nf_hook_entries_try_shrink - try to shrink hook array
209 * @old -- current hook blob at @pp
210 * @pp -- location of hook blob
212 * Hook unregistration must always succeed, so to-be-removed hooks
213 * are replaced by a dummy one that will just move to next hook.
215 * This counts the current dummy hooks, attempts to allocate new blob,
216 * copies the live hooks, then replaces and discards old one.
220 * Returns address to free, or NULL.
222 static void *__nf_hook_entries_try_shrink(struct nf_hook_entries *old,
223 struct nf_hook_entries __rcu **pp)
225 unsigned int i, j, skip = 0, hook_entries;
226 struct nf_hook_entries *new = NULL;
227 struct nf_hook_ops **orig_ops;
228 struct nf_hook_ops **new_ops;
230 if (WARN_ON_ONCE(!old))
233 orig_ops = nf_hook_entries_get_hook_ops(old);
234 for (i = 0; i < old->num_hook_entries; i++) {
235 if (orig_ops[i] == &dummy_ops)
239 /* if skip == hook_entries all hooks have been removed */
240 hook_entries = old->num_hook_entries;
241 if (skip == hook_entries)
247 hook_entries -= skip;
248 new = allocate_hook_entries_size(hook_entries);
252 new_ops = nf_hook_entries_get_hook_ops(new);
253 for (i = 0, j = 0; i < old->num_hook_entries; i++) {
254 if (orig_ops[i] == &dummy_ops)
256 new->hooks[j] = old->hooks[i];
257 new_ops[j] = (void *)orig_ops[i];
262 rcu_assign_pointer(*pp, new);
266 static struct nf_hook_entries __rcu **
267 nf_hook_entry_head(struct net *net, int pf, unsigned int hooknum,
268 struct net_device *dev)
273 #ifdef CONFIG_NETFILTER_FAMILY_ARP
275 if (WARN_ON_ONCE(ARRAY_SIZE(net->nf.hooks_arp) <= hooknum))
277 return net->nf.hooks_arp + hooknum;
279 #ifdef CONFIG_NETFILTER_FAMILY_BRIDGE
281 if (WARN_ON_ONCE(ARRAY_SIZE(net->nf.hooks_bridge) <= hooknum))
283 return net->nf.hooks_bridge + hooknum;
285 #ifdef CONFIG_NETFILTER_INGRESS
287 if (WARN_ON_ONCE(hooknum != NF_INET_INGRESS))
289 if (!dev || dev_net(dev) != net) {
293 return &dev->nf_hooks_ingress;
296 if (WARN_ON_ONCE(ARRAY_SIZE(net->nf.hooks_ipv4) <= hooknum))
298 return net->nf.hooks_ipv4 + hooknum;
300 if (WARN_ON_ONCE(ARRAY_SIZE(net->nf.hooks_ipv6) <= hooknum))
302 return net->nf.hooks_ipv6 + hooknum;
308 #ifdef CONFIG_NETFILTER_INGRESS
309 if (hooknum == NF_NETDEV_INGRESS) {
310 if (dev && dev_net(dev) == net)
311 return &dev->nf_hooks_ingress;
314 #ifdef CONFIG_NETFILTER_EGRESS
315 if (hooknum == NF_NETDEV_EGRESS) {
316 if (dev && dev_net(dev) == net)
317 return &dev->nf_hooks_egress;
324 static int nf_ingress_check(struct net *net, const struct nf_hook_ops *reg,
327 #ifndef CONFIG_NETFILTER_INGRESS
328 if (reg->hooknum == hooknum)
331 if (reg->hooknum != hooknum ||
332 !reg->dev || dev_net(reg->dev) != net)
338 static inline bool __maybe_unused nf_ingress_hook(const struct nf_hook_ops *reg,
341 if ((pf == NFPROTO_NETDEV && reg->hooknum == NF_NETDEV_INGRESS) ||
342 (pf == NFPROTO_INET && reg->hooknum == NF_INET_INGRESS))
348 static inline bool __maybe_unused nf_egress_hook(const struct nf_hook_ops *reg,
351 return pf == NFPROTO_NETDEV && reg->hooknum == NF_NETDEV_EGRESS;
354 static void nf_static_key_inc(const struct nf_hook_ops *reg, int pf)
356 #ifdef CONFIG_JUMP_LABEL
359 if (pf == NFPROTO_INET && reg->hooknum == NF_INET_INGRESS) {
361 hooknum = NF_NETDEV_INGRESS;
363 hooknum = reg->hooknum;
365 static_key_slow_inc(&nf_hooks_needed[pf][hooknum]);
369 static void nf_static_key_dec(const struct nf_hook_ops *reg, int pf)
371 #ifdef CONFIG_JUMP_LABEL
374 if (pf == NFPROTO_INET && reg->hooknum == NF_INET_INGRESS) {
376 hooknum = NF_NETDEV_INGRESS;
378 hooknum = reg->hooknum;
380 static_key_slow_dec(&nf_hooks_needed[pf][hooknum]);
384 static int __nf_register_net_hook(struct net *net, int pf,
385 const struct nf_hook_ops *reg)
387 struct nf_hook_entries *p, *new_hooks;
388 struct nf_hook_entries __rcu **pp;
393 #ifndef CONFIG_NETFILTER_INGRESS
394 if (reg->hooknum == NF_NETDEV_INGRESS)
397 #ifndef CONFIG_NETFILTER_EGRESS
398 if (reg->hooknum == NF_NETDEV_EGRESS)
401 if ((reg->hooknum != NF_NETDEV_INGRESS &&
402 reg->hooknum != NF_NETDEV_EGRESS) ||
403 !reg->dev || dev_net(reg->dev) != net)
407 if (reg->hooknum != NF_INET_INGRESS)
410 err = nf_ingress_check(net, reg, NF_INET_INGRESS);
416 pp = nf_hook_entry_head(net, pf, reg->hooknum, reg->dev);
420 mutex_lock(&nf_hook_mutex);
422 p = nf_entry_dereference(*pp);
423 new_hooks = nf_hook_entries_grow(p, reg);
425 if (!IS_ERR(new_hooks)) {
426 hooks_validate(new_hooks);
427 rcu_assign_pointer(*pp, new_hooks);
430 mutex_unlock(&nf_hook_mutex);
431 if (IS_ERR(new_hooks))
432 return PTR_ERR(new_hooks);
434 #ifdef CONFIG_NETFILTER_INGRESS
435 if (nf_ingress_hook(reg, pf))
436 net_inc_ingress_queue();
438 #ifdef CONFIG_NETFILTER_EGRESS
439 if (nf_egress_hook(reg, pf))
440 net_inc_egress_queue();
442 nf_static_key_inc(reg, pf);
444 BUG_ON(p == new_hooks);
445 nf_hook_entries_free(p);
450 * nf_remove_net_hook - remove a hook from blob
452 * @oldp: current address of hook blob
453 * @unreg: hook to unregister
455 * This cannot fail, hook unregistration must always succeed.
456 * Therefore replace the to-be-removed hook with a dummy hook.
458 static bool nf_remove_net_hook(struct nf_hook_entries *old,
459 const struct nf_hook_ops *unreg)
461 struct nf_hook_ops **orig_ops;
464 orig_ops = nf_hook_entries_get_hook_ops(old);
465 for (i = 0; i < old->num_hook_entries; i++) {
466 if (orig_ops[i] != unreg)
468 WRITE_ONCE(old->hooks[i].hook, accept_all);
469 WRITE_ONCE(orig_ops[i], (void *)&dummy_ops);
476 static void __nf_unregister_net_hook(struct net *net, int pf,
477 const struct nf_hook_ops *reg)
479 struct nf_hook_entries __rcu **pp;
480 struct nf_hook_entries *p;
482 pp = nf_hook_entry_head(net, pf, reg->hooknum, reg->dev);
486 mutex_lock(&nf_hook_mutex);
488 p = nf_entry_dereference(*pp);
489 if (WARN_ON_ONCE(!p)) {
490 mutex_unlock(&nf_hook_mutex);
494 if (nf_remove_net_hook(p, reg)) {
495 #ifdef CONFIG_NETFILTER_INGRESS
496 if (nf_ingress_hook(reg, pf))
497 net_dec_ingress_queue();
499 #ifdef CONFIG_NETFILTER_EGRESS
500 if (nf_egress_hook(reg, pf))
501 net_dec_egress_queue();
503 nf_static_key_dec(reg, pf);
505 WARN_ONCE(1, "hook not found, pf %d num %d", pf, reg->hooknum);
508 p = __nf_hook_entries_try_shrink(p, pp);
509 mutex_unlock(&nf_hook_mutex);
513 nf_queue_nf_hook_drop(net);
514 nf_hook_entries_free(p);
517 void nf_unregister_net_hook(struct net *net, const struct nf_hook_ops *reg)
519 if (reg->pf == NFPROTO_INET) {
520 if (reg->hooknum == NF_INET_INGRESS) {
521 __nf_unregister_net_hook(net, NFPROTO_INET, reg);
523 __nf_unregister_net_hook(net, NFPROTO_IPV4, reg);
524 __nf_unregister_net_hook(net, NFPROTO_IPV6, reg);
527 __nf_unregister_net_hook(net, reg->pf, reg);
530 EXPORT_SYMBOL(nf_unregister_net_hook);
532 void nf_hook_entries_delete_raw(struct nf_hook_entries __rcu **pp,
533 const struct nf_hook_ops *reg)
535 struct nf_hook_entries *p;
537 p = rcu_dereference_raw(*pp);
538 if (nf_remove_net_hook(p, reg)) {
539 p = __nf_hook_entries_try_shrink(p, pp);
540 nf_hook_entries_free(p);
543 EXPORT_SYMBOL_GPL(nf_hook_entries_delete_raw);
545 int nf_register_net_hook(struct net *net, const struct nf_hook_ops *reg)
549 if (reg->pf == NFPROTO_INET) {
550 if (reg->hooknum == NF_INET_INGRESS) {
551 err = __nf_register_net_hook(net, NFPROTO_INET, reg);
555 err = __nf_register_net_hook(net, NFPROTO_IPV4, reg);
559 err = __nf_register_net_hook(net, NFPROTO_IPV6, reg);
561 __nf_unregister_net_hook(net, NFPROTO_IPV4, reg);
566 err = __nf_register_net_hook(net, reg->pf, reg);
573 EXPORT_SYMBOL(nf_register_net_hook);
575 int nf_register_net_hooks(struct net *net, const struct nf_hook_ops *reg,
581 for (i = 0; i < n; i++) {
582 err = nf_register_net_hook(net, ®[i]);
590 nf_unregister_net_hooks(net, reg, i);
593 EXPORT_SYMBOL(nf_register_net_hooks);
595 void nf_unregister_net_hooks(struct net *net, const struct nf_hook_ops *reg,
596 unsigned int hookcount)
600 for (i = 0; i < hookcount; i++)
601 nf_unregister_net_hook(net, ®[i]);
603 EXPORT_SYMBOL(nf_unregister_net_hooks);
605 /* Returns 1 if okfn() needs to be executed by the caller,
606 * -EPERM for NF_DROP, 0 otherwise. Caller must hold rcu_read_lock. */
607 int nf_hook_slow(struct sk_buff *skb, struct nf_hook_state *state,
608 const struct nf_hook_entries *e, unsigned int s)
610 unsigned int verdict;
613 for (; s < e->num_hook_entries; s++) {
614 verdict = nf_hook_entry_hookfn(&e->hooks[s], skb, state);
615 switch (verdict & NF_VERDICT_MASK) {
619 kfree_skb_reason(skb,
620 SKB_DROP_REASON_NETFILTER_DROP);
621 ret = NF_DROP_GETERR(verdict);
626 ret = nf_queue(skb, state, s, verdict);
631 /* Implicit handling for NF_STOLEN, as well as any other
632 * non conventional verdicts.
640 EXPORT_SYMBOL(nf_hook_slow);
642 void nf_hook_slow_list(struct list_head *head, struct nf_hook_state *state,
643 const struct nf_hook_entries *e)
645 struct sk_buff *skb, *next;
646 struct list_head sublist;
649 INIT_LIST_HEAD(&sublist);
651 list_for_each_entry_safe(skb, next, head, list) {
652 skb_list_del_init(skb);
653 ret = nf_hook_slow(skb, state, e, 0);
655 list_add_tail(&skb->list, &sublist);
657 /* Put passed packets back on main list */
658 list_splice(&sublist, head);
660 EXPORT_SYMBOL(nf_hook_slow_list);
662 /* This needs to be compiled in any case to avoid dependencies between the
663 * nfnetlink_queue code and nf_conntrack.
665 const struct nfnl_ct_hook __rcu *nfnl_ct_hook __read_mostly;
666 EXPORT_SYMBOL_GPL(nfnl_ct_hook);
668 const struct nf_ct_hook __rcu *nf_ct_hook __read_mostly;
669 EXPORT_SYMBOL_GPL(nf_ct_hook);
671 #if IS_ENABLED(CONFIG_NF_CONNTRACK)
672 const struct nf_nat_hook __rcu *nf_nat_hook __read_mostly;
673 EXPORT_SYMBOL_GPL(nf_nat_hook);
675 /* This does not belong here, but locally generated errors need it if connection
676 * tracking in use: without this, connection may not be in hash table, and hence
677 * manufactured ICMP or RST packets will not be associated with it.
679 void nf_ct_attach(struct sk_buff *new, const struct sk_buff *skb)
681 const struct nf_ct_hook *ct_hook;
685 ct_hook = rcu_dereference(nf_ct_hook);
687 ct_hook->attach(new, skb);
691 EXPORT_SYMBOL(nf_ct_attach);
693 void nf_conntrack_destroy(struct nf_conntrack *nfct)
695 const struct nf_ct_hook *ct_hook;
698 ct_hook = rcu_dereference(nf_ct_hook);
699 BUG_ON(ct_hook == NULL);
700 ct_hook->destroy(nfct);
703 EXPORT_SYMBOL(nf_conntrack_destroy);
705 void nf_ct_set_closing(struct nf_conntrack *nfct)
707 const struct nf_ct_hook *ct_hook;
713 ct_hook = rcu_dereference(nf_ct_hook);
715 ct_hook->set_closing(nfct);
719 EXPORT_SYMBOL_GPL(nf_ct_set_closing);
721 bool nf_ct_get_tuple_skb(struct nf_conntrack_tuple *dst_tuple,
722 const struct sk_buff *skb)
724 const struct nf_ct_hook *ct_hook;
728 ct_hook = rcu_dereference(nf_ct_hook);
730 ret = ct_hook->get_tuple_skb(dst_tuple, skb);
734 EXPORT_SYMBOL(nf_ct_get_tuple_skb);
736 /* Built-in default zone used e.g. by modules. */
737 const struct nf_conntrack_zone nf_ct_zone_dflt = {
738 .id = NF_CT_DEFAULT_ZONE_ID,
739 .dir = NF_CT_DEFAULT_ZONE_DIR,
741 EXPORT_SYMBOL_GPL(nf_ct_zone_dflt);
742 #endif /* CONFIG_NF_CONNTRACK */
744 static void __net_init
745 __netfilter_net_init(struct nf_hook_entries __rcu **e, int max)
749 for (h = 0; h < max; h++)
750 RCU_INIT_POINTER(e[h], NULL);
753 static int __net_init netfilter_net_init(struct net *net)
755 __netfilter_net_init(net->nf.hooks_ipv4, ARRAY_SIZE(net->nf.hooks_ipv4));
756 __netfilter_net_init(net->nf.hooks_ipv6, ARRAY_SIZE(net->nf.hooks_ipv6));
757 #ifdef CONFIG_NETFILTER_FAMILY_ARP
758 __netfilter_net_init(net->nf.hooks_arp, ARRAY_SIZE(net->nf.hooks_arp));
760 #ifdef CONFIG_NETFILTER_FAMILY_BRIDGE
761 __netfilter_net_init(net->nf.hooks_bridge, ARRAY_SIZE(net->nf.hooks_bridge));
763 #ifdef CONFIG_PROC_FS
764 net->nf.proc_netfilter = proc_net_mkdir(net, "netfilter",
766 if (!net->nf.proc_netfilter) {
767 if (!net_eq(net, &init_net))
768 pr_err("cannot create netfilter proc entry");
777 static void __net_exit netfilter_net_exit(struct net *net)
779 remove_proc_entry("netfilter", net->proc_net);
782 static struct pernet_operations netfilter_net_ops = {
783 .init = netfilter_net_init,
784 .exit = netfilter_net_exit,
787 int __init netfilter_init(void)
791 ret = register_pernet_subsys(&netfilter_net_ops);
795 ret = netfilter_log_init();
801 unregister_pernet_subsys(&netfilter_net_ops);