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>
6 * (C) 2006-2012 Patrick McHardy <kaber@trash.net>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/types.h>
14 #include <linux/netfilter.h>
15 #include <linux/module.h>
16 #include <linux/skbuff.h>
17 #include <linux/vmalloc.h>
18 #include <linux/stddef.h>
19 #include <linux/random.h>
20 #include <linux/err.h>
21 #include <linux/kernel.h>
22 #include <linux/netdevice.h>
23 #include <linux/rculist.h>
24 #include <linux/rtnetlink.h>
26 #include <net/netfilter/nf_conntrack.h>
27 #include <net/netfilter/nf_conntrack_l3proto.h>
28 #include <net/netfilter/nf_conntrack_l4proto.h>
29 #include <net/netfilter/nf_conntrack_helper.h>
30 #include <net/netfilter/nf_conntrack_core.h>
31 #include <net/netfilter/nf_conntrack_extend.h>
32 #include <net/netfilter/nf_log.h>
34 static DEFINE_MUTEX(nf_ct_helper_mutex
);
35 struct hlist_head
*nf_ct_helper_hash __read_mostly
;
36 EXPORT_SYMBOL_GPL(nf_ct_helper_hash
);
37 unsigned int nf_ct_helper_hsize __read_mostly
;
38 EXPORT_SYMBOL_GPL(nf_ct_helper_hsize
);
39 static unsigned int nf_ct_helper_count __read_mostly
;
41 static bool nf_ct_auto_assign_helper __read_mostly
= false;
42 module_param_named(nf_conntrack_helper
, nf_ct_auto_assign_helper
, bool, 0644);
43 MODULE_PARM_DESC(nf_conntrack_helper
,
44 "Enable automatic conntrack helper assignment (default 0)");
47 static struct ctl_table helper_sysctl_table
[] = {
49 .procname
= "nf_conntrack_helper",
50 .data
= &init_net
.ct
.sysctl_auto_assign_helper
,
51 .maxlen
= sizeof(unsigned int),
53 .proc_handler
= proc_dointvec
,
58 static int nf_conntrack_helper_init_sysctl(struct net
*net
)
60 struct ctl_table
*table
;
62 table
= kmemdup(helper_sysctl_table
, sizeof(helper_sysctl_table
),
67 table
[0].data
= &net
->ct
.sysctl_auto_assign_helper
;
69 /* Don't export sysctls to unprivileged users */
70 if (net
->user_ns
!= &init_user_ns
)
71 table
[0].procname
= NULL
;
73 net
->ct
.helper_sysctl_header
=
74 register_net_sysctl(net
, "net/netfilter", table
);
76 if (!net
->ct
.helper_sysctl_header
) {
77 pr_err("nf_conntrack_helper: can't register to sysctl.\n");
88 static void nf_conntrack_helper_fini_sysctl(struct net
*net
)
90 struct ctl_table
*table
;
92 table
= net
->ct
.helper_sysctl_header
->ctl_table_arg
;
93 unregister_net_sysctl_table(net
->ct
.helper_sysctl_header
);
97 static int nf_conntrack_helper_init_sysctl(struct net
*net
)
102 static void nf_conntrack_helper_fini_sysctl(struct net
*net
)
105 #endif /* CONFIG_SYSCTL */
107 /* Stupid hash, but collision free for the default registrations of the
108 * helpers currently in the kernel. */
109 static unsigned int helper_hash(const struct nf_conntrack_tuple
*tuple
)
111 return (((tuple
->src
.l3num
<< 8) | tuple
->dst
.protonum
) ^
112 (__force __u16
)tuple
->src
.u
.all
) % nf_ct_helper_hsize
;
115 static struct nf_conntrack_helper
*
116 __nf_ct_helper_find(const struct nf_conntrack_tuple
*tuple
)
118 struct nf_conntrack_helper
*helper
;
119 struct nf_conntrack_tuple_mask mask
= { .src
.u
.all
= htons(0xFFFF) };
122 if (!nf_ct_helper_count
)
125 h
= helper_hash(tuple
);
126 hlist_for_each_entry_rcu(helper
, &nf_ct_helper_hash
[h
], hnode
) {
127 if (nf_ct_tuple_src_mask_cmp(tuple
, &helper
->tuple
, &mask
))
133 struct nf_conntrack_helper
*
134 __nf_conntrack_helper_find(const char *name
, u16 l3num
, u8 protonum
)
136 struct nf_conntrack_helper
*h
;
139 for (i
= 0; i
< nf_ct_helper_hsize
; i
++) {
140 hlist_for_each_entry_rcu(h
, &nf_ct_helper_hash
[i
], hnode
) {
141 if (!strcmp(h
->name
, name
) &&
142 h
->tuple
.src
.l3num
== l3num
&&
143 h
->tuple
.dst
.protonum
== protonum
)
149 EXPORT_SYMBOL_GPL(__nf_conntrack_helper_find
);
151 struct nf_conntrack_helper
*
152 nf_conntrack_helper_try_module_get(const char *name
, u16 l3num
, u8 protonum
)
154 struct nf_conntrack_helper
*h
;
156 h
= __nf_conntrack_helper_find(name
, l3num
, protonum
);
157 #ifdef CONFIG_MODULES
159 if (request_module("nfct-helper-%s", name
) == 0)
160 h
= __nf_conntrack_helper_find(name
, l3num
, protonum
);
163 if (h
!= NULL
&& !try_module_get(h
->me
))
168 EXPORT_SYMBOL_GPL(nf_conntrack_helper_try_module_get
);
170 struct nf_conn_help
*
171 nf_ct_helper_ext_add(struct nf_conn
*ct
,
172 struct nf_conntrack_helper
*helper
, gfp_t gfp
)
174 struct nf_conn_help
*help
;
176 help
= nf_ct_ext_add_length(ct
, NF_CT_EXT_HELPER
,
177 helper
->data_len
, gfp
);
179 INIT_HLIST_HEAD(&help
->expectations
);
181 pr_debug("failed to add helper extension area");
184 EXPORT_SYMBOL_GPL(nf_ct_helper_ext_add
);
186 int __nf_ct_try_assign_helper(struct nf_conn
*ct
, struct nf_conn
*tmpl
,
189 struct nf_conntrack_helper
*helper
= NULL
;
190 struct nf_conn_help
*help
;
191 struct net
*net
= nf_ct_net(ct
);
193 /* We already got a helper explicitly attached. The function
194 * nf_conntrack_alter_reply - in case NAT is in use - asks for looking
195 * the helper up again. Since now the user is in full control of
196 * making consistent helper configurations, skip this automatic
197 * re-lookup, otherwise we'll lose the helper.
199 if (test_bit(IPS_HELPER_BIT
, &ct
->status
))
203 help
= nfct_help(tmpl
);
205 helper
= help
->helper
;
206 set_bit(IPS_HELPER_BIT
, &ct
->status
);
210 help
= nfct_help(ct
);
211 if (net
->ct
.sysctl_auto_assign_helper
&& helper
== NULL
) {
212 helper
= __nf_ct_helper_find(&ct
->tuplehash
[IP_CT_DIR_REPLY
].tuple
);
213 if (unlikely(!net
->ct
.auto_assign_helper_warned
&& helper
)) {
214 pr_info("nf_conntrack: automatic helper "
215 "assignment is deprecated and it will "
216 "be removed soon. Use the iptables CT target "
217 "to attach helpers instead.\n");
218 net
->ct
.auto_assign_helper_warned
= true;
222 if (helper
== NULL
) {
224 RCU_INIT_POINTER(help
->helper
, NULL
);
229 help
= nf_ct_helper_ext_add(ct
, helper
, flags
);
233 /* We only allow helper re-assignment of the same sort since
234 * we cannot reallocate the helper extension area.
236 struct nf_conntrack_helper
*tmp
= rcu_dereference(help
->helper
);
238 if (tmp
&& tmp
->help
!= helper
->help
) {
239 RCU_INIT_POINTER(help
->helper
, NULL
);
244 rcu_assign_pointer(help
->helper
, helper
);
248 EXPORT_SYMBOL_GPL(__nf_ct_try_assign_helper
);
250 /* appropriate ct lock protecting must be taken by caller */
251 static inline int unhelp(struct nf_conntrack_tuple_hash
*i
,
252 const struct nf_conntrack_helper
*me
)
254 struct nf_conn
*ct
= nf_ct_tuplehash_to_ctrack(i
);
255 struct nf_conn_help
*help
= nfct_help(ct
);
257 if (help
&& rcu_dereference_raw(help
->helper
) == me
) {
258 nf_conntrack_event(IPCT_HELPER
, ct
);
259 RCU_INIT_POINTER(help
->helper
, NULL
);
264 void nf_ct_helper_destroy(struct nf_conn
*ct
)
266 struct nf_conn_help
*help
= nfct_help(ct
);
267 struct nf_conntrack_helper
*helper
;
271 helper
= rcu_dereference(help
->helper
);
272 if (helper
&& helper
->destroy
)
278 static LIST_HEAD(nf_ct_helper_expectfn_list
);
280 void nf_ct_helper_expectfn_register(struct nf_ct_helper_expectfn
*n
)
282 spin_lock_bh(&nf_conntrack_expect_lock
);
283 list_add_rcu(&n
->head
, &nf_ct_helper_expectfn_list
);
284 spin_unlock_bh(&nf_conntrack_expect_lock
);
286 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_register
);
288 void nf_ct_helper_expectfn_unregister(struct nf_ct_helper_expectfn
*n
)
290 spin_lock_bh(&nf_conntrack_expect_lock
);
291 list_del_rcu(&n
->head
);
292 spin_unlock_bh(&nf_conntrack_expect_lock
);
294 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_unregister
);
296 struct nf_ct_helper_expectfn
*
297 nf_ct_helper_expectfn_find_by_name(const char *name
)
299 struct nf_ct_helper_expectfn
*cur
;
303 list_for_each_entry_rcu(cur
, &nf_ct_helper_expectfn_list
, head
) {
304 if (!strcmp(cur
->name
, name
)) {
310 return found
? cur
: NULL
;
312 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_name
);
314 struct nf_ct_helper_expectfn
*
315 nf_ct_helper_expectfn_find_by_symbol(const void *symbol
)
317 struct nf_ct_helper_expectfn
*cur
;
321 list_for_each_entry_rcu(cur
, &nf_ct_helper_expectfn_list
, head
) {
322 if (cur
->expectfn
== symbol
) {
328 return found
? cur
: NULL
;
330 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_symbol
);
333 void nf_ct_helper_log(struct sk_buff
*skb
, const struct nf_conn
*ct
,
334 const char *fmt
, ...)
336 const struct nf_conn_help
*help
;
337 const struct nf_conntrack_helper
*helper
;
338 struct va_format vaf
;
346 /* Called from the helper function, this call never fails */
347 help
= nfct_help(ct
);
349 /* rcu_read_lock()ed by nf_hook_slow */
350 helper
= rcu_dereference(help
->helper
);
352 nf_log_packet(nf_ct_net(ct
), nf_ct_l3num(ct
), 0, skb
, NULL
, NULL
, NULL
,
353 "nf_ct_%s: dropping packet: %pV ", helper
->name
, &vaf
);
357 EXPORT_SYMBOL_GPL(nf_ct_helper_log
);
359 int nf_conntrack_helper_register(struct nf_conntrack_helper
*me
)
361 struct nf_conntrack_tuple_mask mask
= { .src
.u
.all
= htons(0xFFFF) };
362 unsigned int h
= helper_hash(&me
->tuple
);
363 struct nf_conntrack_helper
*cur
;
366 BUG_ON(me
->expect_policy
== NULL
);
367 BUG_ON(me
->expect_class_max
>= NF_CT_MAX_EXPECT_CLASSES
);
368 BUG_ON(strlen(me
->name
) > NF_CT_HELPER_NAME_LEN
- 1);
370 mutex_lock(&nf_ct_helper_mutex
);
371 hlist_for_each_entry(cur
, &nf_ct_helper_hash
[h
], hnode
) {
372 if (nf_ct_tuple_src_mask_cmp(&cur
->tuple
, &me
->tuple
, &mask
)) {
377 hlist_add_head_rcu(&me
->hnode
, &nf_ct_helper_hash
[h
]);
378 nf_ct_helper_count
++;
380 mutex_unlock(&nf_ct_helper_mutex
);
383 EXPORT_SYMBOL_GPL(nf_conntrack_helper_register
);
385 static void __nf_conntrack_helper_unregister(struct nf_conntrack_helper
*me
,
388 struct nf_conntrack_tuple_hash
*h
;
389 const struct hlist_nulls_node
*nn
;
392 /* Get rid of expecteds, set helpers to NULL. */
393 for_each_possible_cpu(cpu
) {
394 struct ct_pcpu
*pcpu
= per_cpu_ptr(net
->ct
.pcpu_lists
, cpu
);
396 spin_lock_bh(&pcpu
->lock
);
397 hlist_nulls_for_each_entry(h
, nn
, &pcpu
->unconfirmed
, hnnode
)
399 spin_unlock_bh(&pcpu
->lock
);
403 void nf_conntrack_helper_unregister(struct nf_conntrack_helper
*me
)
405 struct nf_conntrack_tuple_hash
*h
;
406 struct nf_conntrack_expect
*exp
;
407 const struct hlist_node
*next
;
408 const struct hlist_nulls_node
*nn
;
409 unsigned int last_hsize
;
414 mutex_lock(&nf_ct_helper_mutex
);
415 hlist_del_rcu(&me
->hnode
);
416 nf_ct_helper_count
--;
417 mutex_unlock(&nf_ct_helper_mutex
);
419 /* Make sure every nothing is still using the helper unless its a
420 * connection in the hash.
424 /* Get rid of expectations */
425 spin_lock_bh(&nf_conntrack_expect_lock
);
426 for (i
= 0; i
< nf_ct_expect_hsize
; i
++) {
427 hlist_for_each_entry_safe(exp
, next
,
428 &nf_ct_expect_hash
[i
], hnode
) {
429 struct nf_conn_help
*help
= nfct_help(exp
->master
);
430 if ((rcu_dereference_protected(
432 lockdep_is_held(&nf_conntrack_expect_lock
)
433 ) == me
|| exp
->helper
== me
) &&
434 del_timer(&exp
->timeout
)) {
435 nf_ct_unlink_expect(exp
);
436 nf_ct_expect_put(exp
);
440 spin_unlock_bh(&nf_conntrack_expect_lock
);
444 __nf_conntrack_helper_unregister(me
, net
);
449 last_hsize
= nf_conntrack_htable_size
;
450 for (i
= 0; i
< last_hsize
; i
++) {
451 lock
= &nf_conntrack_locks
[i
% CONNTRACK_LOCKS
];
452 nf_conntrack_lock(lock
);
453 if (last_hsize
!= nf_conntrack_htable_size
) {
457 hlist_nulls_for_each_entry(h
, nn
, &nf_conntrack_hash
[i
], hnnode
)
463 EXPORT_SYMBOL_GPL(nf_conntrack_helper_unregister
);
465 void nf_ct_helper_init(struct nf_conntrack_helper
*helper
,
466 u16 l3num
, u16 protonum
, const char *name
,
467 u16 default_port
, u16 spec_port
, u32 id
,
468 const struct nf_conntrack_expect_policy
*exp_pol
,
469 u32 expect_class_max
, u32 data_len
,
470 int (*help
)(struct sk_buff
*skb
, unsigned int protoff
,
472 enum ip_conntrack_info ctinfo
),
473 int (*from_nlattr
)(struct nlattr
*attr
,
475 struct module
*module
)
477 helper
->tuple
.src
.l3num
= l3num
;
478 helper
->tuple
.dst
.protonum
= protonum
;
479 helper
->tuple
.src
.u
.all
= htons(spec_port
);
480 helper
->expect_policy
= exp_pol
;
481 helper
->expect_class_max
= expect_class_max
;
482 helper
->data_len
= data_len
;
484 helper
->from_nlattr
= from_nlattr
;
487 if (spec_port
== default_port
)
488 snprintf(helper
->name
, sizeof(helper
->name
), "%s", name
);
490 snprintf(helper
->name
, sizeof(helper
->name
), "%s-%u", name
, id
);
492 EXPORT_SYMBOL_GPL(nf_ct_helper_init
);
494 int nf_conntrack_helpers_register(struct nf_conntrack_helper
*helper
,
500 for (i
= 0; i
< n
; i
++) {
501 err
= nf_conntrack_helper_register(&helper
[i
]);
509 nf_conntrack_helpers_unregister(helper
, i
);
512 EXPORT_SYMBOL_GPL(nf_conntrack_helpers_register
);
514 void nf_conntrack_helpers_unregister(struct nf_conntrack_helper
*helper
,
518 nf_conntrack_helper_unregister(&helper
[n
]);
520 EXPORT_SYMBOL_GPL(nf_conntrack_helpers_unregister
);
522 static struct nf_ct_ext_type helper_extend __read_mostly
= {
523 .len
= sizeof(struct nf_conn_help
),
524 .align
= __alignof__(struct nf_conn_help
),
525 .id
= NF_CT_EXT_HELPER
,
528 int nf_conntrack_helper_pernet_init(struct net
*net
)
530 net
->ct
.auto_assign_helper_warned
= false;
531 net
->ct
.sysctl_auto_assign_helper
= nf_ct_auto_assign_helper
;
532 return nf_conntrack_helper_init_sysctl(net
);
535 void nf_conntrack_helper_pernet_fini(struct net
*net
)
537 nf_conntrack_helper_fini_sysctl(net
);
540 int nf_conntrack_helper_init(void)
543 nf_ct_helper_hsize
= 1; /* gets rounded up to use one page */
545 nf_ct_alloc_hashtable(&nf_ct_helper_hsize
, 0);
546 if (!nf_ct_helper_hash
)
549 ret
= nf_ct_extend_register(&helper_extend
);
551 pr_err("nf_ct_helper: Unable to register helper extension.\n");
557 nf_ct_free_hashtable(nf_ct_helper_hash
, nf_ct_helper_hsize
);
561 void nf_conntrack_helper_fini(void)
563 nf_ct_extend_unregister(&helper_extend
);
564 nf_ct_free_hashtable(nf_ct_helper_hash
, nf_ct_helper_hsize
);