1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Helper handling for netfilter. */
4 /* (C) 1999-2001 Paul `Rusty' Russell
5 * (C) 2002-2006 Netfilter Core Team <coreteam@netfilter.org>
6 * (C) 2003,2004 USAGI/WIDE Project <http://www.linux-ipv6.org>
7 * (C) 2006-2012 Patrick McHardy <kaber@trash.net>
10 #include <linux/types.h>
11 #include <linux/netfilter.h>
12 #include <linux/module.h>
13 #include <linux/skbuff.h>
14 #include <linux/vmalloc.h>
15 #include <linux/stddef.h>
16 #include <linux/random.h>
17 #include <linux/err.h>
18 #include <linux/kernel.h>
19 #include <linux/netdevice.h>
20 #include <linux/rculist.h>
21 #include <linux/rtnetlink.h>
23 #include <net/netfilter/nf_conntrack.h>
24 #include <net/netfilter/nf_conntrack_core.h>
25 #include <net/netfilter/nf_conntrack_ecache.h>
26 #include <net/netfilter/nf_conntrack_extend.h>
27 #include <net/netfilter/nf_conntrack_helper.h>
28 #include <net/netfilter/nf_conntrack_l4proto.h>
29 #include <net/netfilter/nf_conntrack_seqadj.h>
30 #include <net/netfilter/nf_log.h>
33 static DEFINE_MUTEX(nf_ct_helper_mutex);
34 struct hlist_head *nf_ct_helper_hash __read_mostly;
35 EXPORT_SYMBOL_GPL(nf_ct_helper_hash);
36 unsigned int nf_ct_helper_hsize __read_mostly;
37 EXPORT_SYMBOL_GPL(nf_ct_helper_hsize);
38 static unsigned int nf_ct_helper_count __read_mostly;
40 static DEFINE_MUTEX(nf_ct_nat_helpers_mutex);
41 static struct list_head nf_ct_nat_helpers __read_mostly;
43 /* Stupid hash, but collision free for the default registrations of the
44 * helpers currently in the kernel. */
45 static unsigned int helper_hash(const struct nf_conntrack_tuple *tuple)
47 return (((tuple->src.l3num << 8) | tuple->dst.protonum) ^
48 (__force __u16)tuple->src.u.all) % nf_ct_helper_hsize;
51 struct nf_conntrack_helper *
52 __nf_conntrack_helper_find(const char *name, u16 l3num, u8 protonum)
54 struct nf_conntrack_helper *h;
57 for (i = 0; i < nf_ct_helper_hsize; i++) {
58 hlist_for_each_entry_rcu(h, &nf_ct_helper_hash[i], hnode) {
59 if (strcmp(h->name, name))
62 if (h->tuple.src.l3num != NFPROTO_UNSPEC &&
63 h->tuple.src.l3num != l3num)
66 if (h->tuple.dst.protonum == protonum)
72 EXPORT_SYMBOL_GPL(__nf_conntrack_helper_find);
74 struct nf_conntrack_helper *
75 nf_conntrack_helper_try_module_get(const char *name, u16 l3num, u8 protonum)
77 struct nf_conntrack_helper *h;
81 h = __nf_conntrack_helper_find(name, l3num, protonum);
85 if (request_module("nfct-helper-%s", name) == 0) {
87 h = __nf_conntrack_helper_find(name, l3num, protonum);
93 if (h != NULL && !try_module_get(h->me))
95 if (h != NULL && !refcount_inc_not_zero(&h->refcnt)) {
104 EXPORT_SYMBOL_GPL(nf_conntrack_helper_try_module_get);
106 void nf_conntrack_helper_put(struct nf_conntrack_helper *helper)
108 refcount_dec(&helper->refcnt);
109 module_put(helper->me);
111 EXPORT_SYMBOL_GPL(nf_conntrack_helper_put);
113 static struct nf_conntrack_nat_helper *
114 nf_conntrack_nat_helper_find(const char *mod_name)
116 struct nf_conntrack_nat_helper *cur;
119 list_for_each_entry_rcu(cur, &nf_ct_nat_helpers, list) {
120 if (!strcmp(cur->mod_name, mod_name)) {
125 return found ? cur : NULL;
129 nf_nat_helper_try_module_get(const char *name, u16 l3num, u8 protonum)
131 struct nf_conntrack_helper *h;
132 struct nf_conntrack_nat_helper *nat;
133 char mod_name[NF_CT_HELPER_NAME_LEN];
137 h = __nf_conntrack_helper_find(name, l3num, protonum);
143 nat = nf_conntrack_nat_helper_find(h->nat_mod_name);
145 snprintf(mod_name, sizeof(mod_name), "%s", h->nat_mod_name);
147 request_module("%s", mod_name);
150 nat = nf_conntrack_nat_helper_find(mod_name);
157 if (!try_module_get(nat->module))
163 EXPORT_SYMBOL_GPL(nf_nat_helper_try_module_get);
165 void nf_nat_helper_put(struct nf_conntrack_helper *helper)
167 struct nf_conntrack_nat_helper *nat;
169 nat = nf_conntrack_nat_helper_find(helper->nat_mod_name);
170 if (WARN_ON_ONCE(!nat))
173 module_put(nat->module);
175 EXPORT_SYMBOL_GPL(nf_nat_helper_put);
177 struct nf_conn_help *
178 nf_ct_helper_ext_add(struct nf_conn *ct, gfp_t gfp)
180 struct nf_conn_help *help;
182 help = nf_ct_ext_add(ct, NF_CT_EXT_HELPER, gfp);
184 INIT_HLIST_HEAD(&help->expectations);
186 pr_debug("failed to add helper extension area");
189 EXPORT_SYMBOL_GPL(nf_ct_helper_ext_add);
191 int __nf_ct_try_assign_helper(struct nf_conn *ct, struct nf_conn *tmpl,
194 struct nf_conntrack_helper *helper = NULL;
195 struct nf_conn_help *help;
197 /* We already got a helper explicitly attached (e.g. nft_ct) */
198 if (test_bit(IPS_HELPER_BIT, &ct->status))
201 if (WARN_ON_ONCE(!tmpl))
204 help = nfct_help(tmpl);
206 helper = rcu_dereference(help->helper);
207 set_bit(IPS_HELPER_BIT, &ct->status);
210 help = nfct_help(ct);
212 if (helper == NULL) {
214 RCU_INIT_POINTER(help->helper, NULL);
219 help = nf_ct_helper_ext_add(ct, flags);
223 /* We only allow helper re-assignment of the same sort since
224 * we cannot reallocate the helper extension area.
226 struct nf_conntrack_helper *tmp = rcu_dereference(help->helper);
228 if (tmp && tmp->help != helper->help) {
229 RCU_INIT_POINTER(help->helper, NULL);
234 rcu_assign_pointer(help->helper, helper);
238 EXPORT_SYMBOL_GPL(__nf_ct_try_assign_helper);
240 /* appropriate ct lock protecting must be taken by caller */
241 static int unhelp(struct nf_conn *ct, void *me)
243 struct nf_conn_help *help = nfct_help(ct);
245 if (help && rcu_dereference_raw(help->helper) == me) {
246 nf_conntrack_event(IPCT_HELPER, ct);
247 RCU_INIT_POINTER(help->helper, NULL);
250 /* We are not intended to delete this conntrack. */
254 void nf_ct_helper_destroy(struct nf_conn *ct)
256 struct nf_conn_help *help = nfct_help(ct);
257 struct nf_conntrack_helper *helper;
261 helper = rcu_dereference(help->helper);
262 if (helper && helper->destroy)
268 static LIST_HEAD(nf_ct_helper_expectfn_list);
270 void nf_ct_helper_expectfn_register(struct nf_ct_helper_expectfn *n)
272 spin_lock_bh(&nf_conntrack_expect_lock);
273 list_add_rcu(&n->head, &nf_ct_helper_expectfn_list);
274 spin_unlock_bh(&nf_conntrack_expect_lock);
276 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_register);
278 void nf_ct_helper_expectfn_unregister(struct nf_ct_helper_expectfn *n)
280 spin_lock_bh(&nf_conntrack_expect_lock);
281 list_del_rcu(&n->head);
282 spin_unlock_bh(&nf_conntrack_expect_lock);
284 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_unregister);
286 /* Caller should hold the rcu lock */
287 struct nf_ct_helper_expectfn *
288 nf_ct_helper_expectfn_find_by_name(const char *name)
290 struct nf_ct_helper_expectfn *cur;
293 list_for_each_entry_rcu(cur, &nf_ct_helper_expectfn_list, head) {
294 if (!strcmp(cur->name, name)) {
299 return found ? cur : NULL;
301 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_name);
303 /* Caller should hold the rcu lock */
304 struct nf_ct_helper_expectfn *
305 nf_ct_helper_expectfn_find_by_symbol(const void *symbol)
307 struct nf_ct_helper_expectfn *cur;
310 list_for_each_entry_rcu(cur, &nf_ct_helper_expectfn_list, head) {
311 if (cur->expectfn == symbol) {
316 return found ? cur : NULL;
318 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_symbol);
321 void nf_ct_helper_log(struct sk_buff *skb, const struct nf_conn *ct,
322 const char *fmt, ...)
324 const struct nf_conn_help *help;
325 const struct nf_conntrack_helper *helper;
326 struct va_format vaf;
334 /* Called from the helper function, this call never fails */
335 help = nfct_help(ct);
337 /* rcu_read_lock()ed by nf_hook_thresh */
338 helper = rcu_dereference(help->helper);
340 nf_log_packet(nf_ct_net(ct), nf_ct_l3num(ct), 0, skb, NULL, NULL, NULL,
341 "nf_ct_%s: dropping packet: %pV ", helper->name, &vaf);
345 EXPORT_SYMBOL_GPL(nf_ct_helper_log);
347 int nf_conntrack_helper_register(struct nf_conntrack_helper *me)
349 struct nf_conntrack_tuple_mask mask = { .src.u.all = htons(0xFFFF) };
350 unsigned int h = helper_hash(&me->tuple);
351 struct nf_conntrack_helper *cur;
354 BUG_ON(me->expect_policy == NULL);
355 BUG_ON(me->expect_class_max >= NF_CT_MAX_EXPECT_CLASSES);
356 BUG_ON(strlen(me->name) > NF_CT_HELPER_NAME_LEN - 1);
358 if (!nf_ct_helper_hash)
361 if (me->expect_policy->max_expected > NF_CT_EXPECT_MAX_CNT)
364 mutex_lock(&nf_ct_helper_mutex);
365 for (i = 0; i < nf_ct_helper_hsize; i++) {
366 hlist_for_each_entry(cur, &nf_ct_helper_hash[i], hnode) {
367 if (!strcmp(cur->name, me->name) &&
368 (cur->tuple.src.l3num == NFPROTO_UNSPEC ||
369 cur->tuple.src.l3num == me->tuple.src.l3num) &&
370 cur->tuple.dst.protonum == me->tuple.dst.protonum) {
377 /* avoid unpredictable behaviour for auto_assign_helper */
378 if (!(me->flags & NF_CT_HELPER_F_USERSPACE)) {
379 hlist_for_each_entry(cur, &nf_ct_helper_hash[h], hnode) {
380 if (nf_ct_tuple_src_mask_cmp(&cur->tuple, &me->tuple,
387 refcount_set(&me->refcnt, 1);
388 hlist_add_head_rcu(&me->hnode, &nf_ct_helper_hash[h]);
389 nf_ct_helper_count++;
391 mutex_unlock(&nf_ct_helper_mutex);
394 EXPORT_SYMBOL_GPL(nf_conntrack_helper_register);
396 static bool expect_iter_me(struct nf_conntrack_expect *exp, void *data)
398 struct nf_conn_help *help = nfct_help(exp->master);
399 const struct nf_conntrack_helper *me = data;
400 const struct nf_conntrack_helper *this;
402 if (exp->helper == me)
405 this = rcu_dereference_protected(help->helper,
406 lockdep_is_held(&nf_conntrack_expect_lock));
410 void nf_conntrack_helper_unregister(struct nf_conntrack_helper *me)
412 mutex_lock(&nf_ct_helper_mutex);
413 hlist_del_rcu(&me->hnode);
414 nf_ct_helper_count--;
415 mutex_unlock(&nf_ct_helper_mutex);
417 /* Make sure every nothing is still using the helper unless its a
418 * connection in the hash.
422 nf_ct_expect_iterate_destroy(expect_iter_me, NULL);
423 nf_ct_iterate_destroy(unhelp, me);
425 EXPORT_SYMBOL_GPL(nf_conntrack_helper_unregister);
427 void nf_ct_helper_init(struct nf_conntrack_helper *helper,
428 u16 l3num, u16 protonum, const char *name,
429 u16 default_port, u16 spec_port, u32 id,
430 const struct nf_conntrack_expect_policy *exp_pol,
431 u32 expect_class_max,
432 int (*help)(struct sk_buff *skb, unsigned int protoff,
434 enum ip_conntrack_info ctinfo),
435 int (*from_nlattr)(struct nlattr *attr,
437 struct module *module)
439 helper->tuple.src.l3num = l3num;
440 helper->tuple.dst.protonum = protonum;
441 helper->tuple.src.u.all = htons(spec_port);
442 helper->expect_policy = exp_pol;
443 helper->expect_class_max = expect_class_max;
445 helper->from_nlattr = from_nlattr;
447 snprintf(helper->nat_mod_name, sizeof(helper->nat_mod_name),
448 NF_NAT_HELPER_PREFIX "%s", name);
450 if (spec_port == default_port)
451 snprintf(helper->name, sizeof(helper->name), "%s", name);
453 snprintf(helper->name, sizeof(helper->name), "%s-%u", name, id);
455 EXPORT_SYMBOL_GPL(nf_ct_helper_init);
457 int nf_conntrack_helpers_register(struct nf_conntrack_helper *helper,
463 for (i = 0; i < n; i++) {
464 err = nf_conntrack_helper_register(&helper[i]);
472 nf_conntrack_helpers_unregister(helper, i);
475 EXPORT_SYMBOL_GPL(nf_conntrack_helpers_register);
477 void nf_conntrack_helpers_unregister(struct nf_conntrack_helper *helper,
481 nf_conntrack_helper_unregister(&helper[n]);
483 EXPORT_SYMBOL_GPL(nf_conntrack_helpers_unregister);
485 void nf_nat_helper_register(struct nf_conntrack_nat_helper *nat)
487 mutex_lock(&nf_ct_nat_helpers_mutex);
488 list_add_rcu(&nat->list, &nf_ct_nat_helpers);
489 mutex_unlock(&nf_ct_nat_helpers_mutex);
491 EXPORT_SYMBOL_GPL(nf_nat_helper_register);
493 void nf_nat_helper_unregister(struct nf_conntrack_nat_helper *nat)
495 mutex_lock(&nf_ct_nat_helpers_mutex);
496 list_del_rcu(&nat->list);
497 mutex_unlock(&nf_ct_nat_helpers_mutex);
499 EXPORT_SYMBOL_GPL(nf_nat_helper_unregister);
501 int nf_conntrack_helper_init(void)
503 nf_ct_helper_hsize = 1; /* gets rounded up to use one page */
505 nf_ct_alloc_hashtable(&nf_ct_helper_hsize, 0);
506 if (!nf_ct_helper_hash)
509 INIT_LIST_HEAD(&nf_ct_nat_helpers);
513 void nf_conntrack_helper_fini(void)
515 kvfree(nf_ct_helper_hash);
516 nf_ct_helper_hash = NULL;