1 /* Helper handling for netfilter. */
3 /* (C) 1999-2001 Paul `Rusty' Russell
4 * (C) 2002-2006 Netfilter Core Team <coreteam@netfilter.org>
5 * (C) 2003,2004 USAGI/WIDE Project <http://www.linux-ipv6.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/types.h>
13 #include <linux/netfilter.h>
14 #include <linux/module.h>
15 #include <linux/skbuff.h>
16 #include <linux/vmalloc.h>
17 #include <linux/stddef.h>
18 #include <linux/random.h>
19 #include <linux/err.h>
20 #include <linux/kernel.h>
21 #include <linux/netdevice.h>
22 #include <linux/rculist.h>
23 #include <linux/rtnetlink.h>
25 #include <net/netfilter/nf_conntrack.h>
26 #include <net/netfilter/nf_conntrack_l3proto.h>
27 #include <net/netfilter/nf_conntrack_l4proto.h>
28 #include <net/netfilter/nf_conntrack_helper.h>
29 #include <net/netfilter/nf_conntrack_core.h>
30 #include <net/netfilter/nf_conntrack_extend.h>
32 static DEFINE_MUTEX(nf_ct_helper_mutex);
33 static struct hlist_head *nf_ct_helper_hash __read_mostly;
34 static unsigned int nf_ct_helper_hsize __read_mostly;
35 static unsigned int nf_ct_helper_count __read_mostly;
38 /* Stupid hash, but collision free for the default registrations of the
39 * helpers currently in the kernel. */
40 static unsigned int helper_hash(const struct nf_conntrack_tuple *tuple)
42 return (((tuple->src.l3num << 8) | tuple->dst.protonum) ^
43 (__force __u16)tuple->src.u.all) % nf_ct_helper_hsize;
46 static struct nf_conntrack_helper *
47 __nf_ct_helper_find(const struct nf_conntrack_tuple *tuple)
49 struct nf_conntrack_helper *helper;
50 struct nf_conntrack_tuple_mask mask = { .src.u.all = htons(0xFFFF) };
54 if (!nf_ct_helper_count)
57 h = helper_hash(tuple);
58 hlist_for_each_entry_rcu(helper, n, &nf_ct_helper_hash[h], hnode) {
59 if (nf_ct_tuple_src_mask_cmp(tuple, &helper->tuple, &mask))
65 struct nf_conntrack_helper *
66 __nf_conntrack_helper_find(const char *name, u16 l3num, u8 protonum)
68 struct nf_conntrack_helper *h;
72 for (i = 0; i < nf_ct_helper_hsize; i++) {
73 hlist_for_each_entry_rcu(h, n, &nf_ct_helper_hash[i], hnode) {
74 if (!strcmp(h->name, name) &&
75 h->tuple.src.l3num == l3num &&
76 h->tuple.dst.protonum == protonum)
82 EXPORT_SYMBOL_GPL(__nf_conntrack_helper_find);
84 struct nf_conntrack_helper *
85 nf_conntrack_helper_try_module_get(const char *name, u16 l3num, u8 protonum)
87 struct nf_conntrack_helper *h;
89 h = __nf_conntrack_helper_find(name, l3num, protonum);
92 if (request_module("nfct-helper-%s", name) == 0)
93 h = __nf_conntrack_helper_find(name, l3num, protonum);
96 if (h != NULL && !try_module_get(h->me))
101 EXPORT_SYMBOL_GPL(nf_conntrack_helper_try_module_get);
103 struct nf_conn_help *nf_ct_helper_ext_add(struct nf_conn *ct, gfp_t gfp)
105 struct nf_conn_help *help;
107 help = nf_ct_ext_add(ct, NF_CT_EXT_HELPER, gfp);
109 INIT_HLIST_HEAD(&help->expectations);
111 pr_debug("failed to add helper extension area");
114 EXPORT_SYMBOL_GPL(nf_ct_helper_ext_add);
116 int __nf_ct_try_assign_helper(struct nf_conn *ct, struct nf_conn *tmpl,
119 struct nf_conntrack_helper *helper = NULL;
120 struct nf_conn_help *help;
124 help = nfct_help(tmpl);
126 helper = help->helper;
129 help = nfct_help(ct);
131 helper = __nf_ct_helper_find(&ct->tuplehash[IP_CT_DIR_REPLY].tuple);
132 if (helper == NULL) {
134 RCU_INIT_POINTER(help->helper, NULL);
139 help = nf_ct_helper_ext_add(ct, flags);
145 memset(&help->help, 0, sizeof(help->help));
148 rcu_assign_pointer(help->helper, helper);
152 EXPORT_SYMBOL_GPL(__nf_ct_try_assign_helper);
154 static inline int unhelp(struct nf_conntrack_tuple_hash *i,
155 const struct nf_conntrack_helper *me)
157 struct nf_conn *ct = nf_ct_tuplehash_to_ctrack(i);
158 struct nf_conn_help *help = nfct_help(ct);
160 if (help && rcu_dereference_protected(
162 lockdep_is_held(&nf_conntrack_lock)
164 nf_conntrack_event(IPCT_HELPER, ct);
165 RCU_INIT_POINTER(help->helper, NULL);
170 void nf_ct_helper_destroy(struct nf_conn *ct)
172 struct nf_conn_help *help = nfct_help(ct);
173 struct nf_conntrack_helper *helper;
177 helper = rcu_dereference(help->helper);
178 if (helper && helper->destroy)
184 static LIST_HEAD(nf_ct_helper_expectfn_list);
186 void nf_ct_helper_expectfn_register(struct nf_ct_helper_expectfn *n)
188 spin_lock_bh(&nf_conntrack_lock);
189 list_add_rcu(&n->head, &nf_ct_helper_expectfn_list);
190 spin_unlock_bh(&nf_conntrack_lock);
192 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_register);
194 void nf_ct_helper_expectfn_unregister(struct nf_ct_helper_expectfn *n)
196 spin_lock_bh(&nf_conntrack_lock);
197 list_del_rcu(&n->head);
198 spin_unlock_bh(&nf_conntrack_lock);
200 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_unregister);
202 struct nf_ct_helper_expectfn *
203 nf_ct_helper_expectfn_find_by_name(const char *name)
205 struct nf_ct_helper_expectfn *cur;
209 list_for_each_entry_rcu(cur, &nf_ct_helper_expectfn_list, head) {
210 if (!strcmp(cur->name, name)) {
216 return found ? cur : NULL;
218 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_name);
220 struct nf_ct_helper_expectfn *
221 nf_ct_helper_expectfn_find_by_symbol(const void *symbol)
223 struct nf_ct_helper_expectfn *cur;
227 list_for_each_entry_rcu(cur, &nf_ct_helper_expectfn_list, head) {
228 if (cur->expectfn == symbol) {
234 return found ? cur : NULL;
236 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_symbol);
238 int nf_conntrack_helper_register(struct nf_conntrack_helper *me)
240 unsigned int h = helper_hash(&me->tuple);
242 BUG_ON(me->expect_policy == NULL);
243 BUG_ON(me->expect_class_max >= NF_CT_MAX_EXPECT_CLASSES);
244 BUG_ON(strlen(me->name) > NF_CT_HELPER_NAME_LEN - 1);
246 mutex_lock(&nf_ct_helper_mutex);
247 hlist_add_head_rcu(&me->hnode, &nf_ct_helper_hash[h]);
248 nf_ct_helper_count++;
249 mutex_unlock(&nf_ct_helper_mutex);
253 EXPORT_SYMBOL_GPL(nf_conntrack_helper_register);
255 static void __nf_conntrack_helper_unregister(struct nf_conntrack_helper *me,
258 struct nf_conntrack_tuple_hash *h;
259 struct nf_conntrack_expect *exp;
260 const struct hlist_node *n, *next;
261 const struct hlist_nulls_node *nn;
264 /* Get rid of expectations */
265 for (i = 0; i < nf_ct_expect_hsize; i++) {
266 hlist_for_each_entry_safe(exp, n, next,
267 &net->ct.expect_hash[i], hnode) {
268 struct nf_conn_help *help = nfct_help(exp->master);
269 if ((rcu_dereference_protected(
271 lockdep_is_held(&nf_conntrack_lock)
272 ) == me || exp->helper == me) &&
273 del_timer(&exp->timeout)) {
274 nf_ct_unlink_expect(exp);
275 nf_ct_expect_put(exp);
280 /* Get rid of expecteds, set helpers to NULL. */
281 hlist_nulls_for_each_entry(h, nn, &net->ct.unconfirmed, hnnode)
283 for (i = 0; i < net->ct.htable_size; i++) {
284 hlist_nulls_for_each_entry(h, nn, &net->ct.hash[i], hnnode)
289 void nf_conntrack_helper_unregister(struct nf_conntrack_helper *me)
293 mutex_lock(&nf_ct_helper_mutex);
294 hlist_del_rcu(&me->hnode);
295 nf_ct_helper_count--;
296 mutex_unlock(&nf_ct_helper_mutex);
298 /* Make sure every nothing is still using the helper unless its a
299 * connection in the hash.
304 spin_lock_bh(&nf_conntrack_lock);
306 __nf_conntrack_helper_unregister(me, net);
307 spin_unlock_bh(&nf_conntrack_lock);
310 EXPORT_SYMBOL_GPL(nf_conntrack_helper_unregister);
312 static struct nf_ct_ext_type helper_extend __read_mostly = {
313 .len = sizeof(struct nf_conn_help),
314 .align = __alignof__(struct nf_conn_help),
315 .id = NF_CT_EXT_HELPER,
318 int nf_conntrack_helper_init(void)
322 nf_ct_helper_hsize = 1; /* gets rounded up to use one page */
323 nf_ct_helper_hash = nf_ct_alloc_hashtable(&nf_ct_helper_hsize, 0);
324 if (!nf_ct_helper_hash)
327 err = nf_ct_extend_register(&helper_extend);
334 nf_ct_free_hashtable(nf_ct_helper_hash, nf_ct_helper_hsize);
338 void nf_conntrack_helper_fini(void)
340 nf_ct_extend_unregister(&helper_extend);
341 nf_ct_free_hashtable(nf_ct_helper_hash, nf_ct_helper_hsize);