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
))
144 if (h
->tuple
.src
.l3num
!= NFPROTO_UNSPEC
&&
145 h
->tuple
.src
.l3num
!= l3num
)
148 if (h
->tuple
.dst
.protonum
== protonum
)
154 EXPORT_SYMBOL_GPL(__nf_conntrack_helper_find
);
156 struct nf_conntrack_helper
*
157 nf_conntrack_helper_try_module_get(const char *name
, u16 l3num
, u8 protonum
)
159 struct nf_conntrack_helper
*h
;
161 h
= __nf_conntrack_helper_find(name
, l3num
, protonum
);
162 #ifdef CONFIG_MODULES
164 if (request_module("nfct-helper-%s", name
) == 0)
165 h
= __nf_conntrack_helper_find(name
, l3num
, protonum
);
168 if (h
!= NULL
&& !try_module_get(h
->me
))
173 EXPORT_SYMBOL_GPL(nf_conntrack_helper_try_module_get
);
175 struct nf_conn_help
*
176 nf_ct_helper_ext_add(struct nf_conn
*ct
,
177 struct nf_conntrack_helper
*helper
, gfp_t gfp
)
179 struct nf_conn_help
*help
;
181 help
= nf_ct_ext_add_length(ct
, NF_CT_EXT_HELPER
,
182 helper
->data_len
, 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
;
196 struct net
*net
= nf_ct_net(ct
);
198 /* We already got a helper explicitly attached. The function
199 * nf_conntrack_alter_reply - in case NAT is in use - asks for looking
200 * the helper up again. Since now the user is in full control of
201 * making consistent helper configurations, skip this automatic
202 * re-lookup, otherwise we'll lose the helper.
204 if (test_bit(IPS_HELPER_BIT
, &ct
->status
))
208 help
= nfct_help(tmpl
);
210 helper
= help
->helper
;
211 set_bit(IPS_HELPER_BIT
, &ct
->status
);
215 help
= nfct_help(ct
);
216 if (net
->ct
.sysctl_auto_assign_helper
&& helper
== NULL
) {
217 helper
= __nf_ct_helper_find(&ct
->tuplehash
[IP_CT_DIR_REPLY
].tuple
);
218 if (unlikely(!net
->ct
.auto_assign_helper_warned
&& helper
)) {
219 pr_info("nf_conntrack: automatic helper "
220 "assignment is deprecated and it will "
221 "be removed soon. Use the iptables CT target "
222 "to attach helpers instead.\n");
223 net
->ct
.auto_assign_helper_warned
= true;
227 if (helper
== NULL
) {
229 RCU_INIT_POINTER(help
->helper
, NULL
);
234 help
= nf_ct_helper_ext_add(ct
, helper
, flags
);
238 /* We only allow helper re-assignment of the same sort since
239 * we cannot reallocate the helper extension area.
241 struct nf_conntrack_helper
*tmp
= rcu_dereference(help
->helper
);
243 if (tmp
&& tmp
->help
!= helper
->help
) {
244 RCU_INIT_POINTER(help
->helper
, NULL
);
249 rcu_assign_pointer(help
->helper
, helper
);
253 EXPORT_SYMBOL_GPL(__nf_ct_try_assign_helper
);
255 /* appropriate ct lock protecting must be taken by caller */
256 static inline int unhelp(struct nf_conntrack_tuple_hash
*i
,
257 const struct nf_conntrack_helper
*me
)
259 struct nf_conn
*ct
= nf_ct_tuplehash_to_ctrack(i
);
260 struct nf_conn_help
*help
= nfct_help(ct
);
262 if (help
&& rcu_dereference_raw(help
->helper
) == me
) {
263 nf_conntrack_event(IPCT_HELPER
, ct
);
264 RCU_INIT_POINTER(help
->helper
, NULL
);
269 void nf_ct_helper_destroy(struct nf_conn
*ct
)
271 struct nf_conn_help
*help
= nfct_help(ct
);
272 struct nf_conntrack_helper
*helper
;
276 helper
= rcu_dereference(help
->helper
);
277 if (helper
&& helper
->destroy
)
283 static LIST_HEAD(nf_ct_helper_expectfn_list
);
285 void nf_ct_helper_expectfn_register(struct nf_ct_helper_expectfn
*n
)
287 spin_lock_bh(&nf_conntrack_expect_lock
);
288 list_add_rcu(&n
->head
, &nf_ct_helper_expectfn_list
);
289 spin_unlock_bh(&nf_conntrack_expect_lock
);
291 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_register
);
293 void nf_ct_helper_expectfn_unregister(struct nf_ct_helper_expectfn
*n
)
295 spin_lock_bh(&nf_conntrack_expect_lock
);
296 list_del_rcu(&n
->head
);
297 spin_unlock_bh(&nf_conntrack_expect_lock
);
299 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_unregister
);
301 struct nf_ct_helper_expectfn
*
302 nf_ct_helper_expectfn_find_by_name(const char *name
)
304 struct nf_ct_helper_expectfn
*cur
;
308 list_for_each_entry_rcu(cur
, &nf_ct_helper_expectfn_list
, head
) {
309 if (!strcmp(cur
->name
, name
)) {
315 return found
? cur
: NULL
;
317 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_name
);
319 struct nf_ct_helper_expectfn
*
320 nf_ct_helper_expectfn_find_by_symbol(const void *symbol
)
322 struct nf_ct_helper_expectfn
*cur
;
326 list_for_each_entry_rcu(cur
, &nf_ct_helper_expectfn_list
, head
) {
327 if (cur
->expectfn
== symbol
) {
333 return found
? cur
: NULL
;
335 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_symbol
);
338 void nf_ct_helper_log(struct sk_buff
*skb
, const struct nf_conn
*ct
,
339 const char *fmt
, ...)
341 const struct nf_conn_help
*help
;
342 const struct nf_conntrack_helper
*helper
;
343 struct va_format vaf
;
351 /* Called from the helper function, this call never fails */
352 help
= nfct_help(ct
);
354 /* rcu_read_lock()ed by nf_hook_thresh */
355 helper
= rcu_dereference(help
->helper
);
357 nf_log_packet(nf_ct_net(ct
), nf_ct_l3num(ct
), 0, skb
, NULL
, NULL
, NULL
,
358 "nf_ct_%s: dropping packet: %pV ", helper
->name
, &vaf
);
362 EXPORT_SYMBOL_GPL(nf_ct_helper_log
);
364 int nf_conntrack_helper_register(struct nf_conntrack_helper
*me
)
366 struct nf_conntrack_tuple_mask mask
= { .src
.u
.all
= htons(0xFFFF) };
367 unsigned int h
= helper_hash(&me
->tuple
);
368 struct nf_conntrack_helper
*cur
;
371 BUG_ON(me
->expect_policy
== NULL
);
372 BUG_ON(me
->expect_class_max
>= NF_CT_MAX_EXPECT_CLASSES
);
373 BUG_ON(strlen(me
->name
) > NF_CT_HELPER_NAME_LEN
- 1);
375 mutex_lock(&nf_ct_helper_mutex
);
376 hlist_for_each_entry(cur
, &nf_ct_helper_hash
[h
], hnode
) {
377 if (nf_ct_tuple_src_mask_cmp(&cur
->tuple
, &me
->tuple
, &mask
)) {
382 hlist_add_head_rcu(&me
->hnode
, &nf_ct_helper_hash
[h
]);
383 nf_ct_helper_count
++;
385 mutex_unlock(&nf_ct_helper_mutex
);
388 EXPORT_SYMBOL_GPL(nf_conntrack_helper_register
);
390 static void __nf_conntrack_helper_unregister(struct nf_conntrack_helper
*me
,
393 struct nf_conntrack_tuple_hash
*h
;
394 const struct hlist_nulls_node
*nn
;
397 /* Get rid of expecteds, set helpers to NULL. */
398 for_each_possible_cpu(cpu
) {
399 struct ct_pcpu
*pcpu
= per_cpu_ptr(net
->ct
.pcpu_lists
, cpu
);
401 spin_lock_bh(&pcpu
->lock
);
402 hlist_nulls_for_each_entry(h
, nn
, &pcpu
->unconfirmed
, hnnode
)
404 spin_unlock_bh(&pcpu
->lock
);
408 void nf_conntrack_helper_unregister(struct nf_conntrack_helper
*me
)
410 struct nf_conntrack_tuple_hash
*h
;
411 struct nf_conntrack_expect
*exp
;
412 const struct hlist_node
*next
;
413 const struct hlist_nulls_node
*nn
;
414 unsigned int last_hsize
;
419 mutex_lock(&nf_ct_helper_mutex
);
420 hlist_del_rcu(&me
->hnode
);
421 nf_ct_helper_count
--;
422 mutex_unlock(&nf_ct_helper_mutex
);
424 /* Make sure every nothing is still using the helper unless its a
425 * connection in the hash.
429 /* Get rid of expectations */
430 spin_lock_bh(&nf_conntrack_expect_lock
);
431 for (i
= 0; i
< nf_ct_expect_hsize
; i
++) {
432 hlist_for_each_entry_safe(exp
, next
,
433 &nf_ct_expect_hash
[i
], hnode
) {
434 struct nf_conn_help
*help
= nfct_help(exp
->master
);
435 if ((rcu_dereference_protected(
437 lockdep_is_held(&nf_conntrack_expect_lock
)
438 ) == me
|| exp
->helper
== me
) &&
439 del_timer(&exp
->timeout
)) {
440 nf_ct_unlink_expect(exp
);
441 nf_ct_expect_put(exp
);
445 spin_unlock_bh(&nf_conntrack_expect_lock
);
449 __nf_conntrack_helper_unregister(me
, net
);
454 last_hsize
= nf_conntrack_htable_size
;
455 for (i
= 0; i
< last_hsize
; i
++) {
456 lock
= &nf_conntrack_locks
[i
% CONNTRACK_LOCKS
];
457 nf_conntrack_lock(lock
);
458 if (last_hsize
!= nf_conntrack_htable_size
) {
462 hlist_nulls_for_each_entry(h
, nn
, &nf_conntrack_hash
[i
], hnnode
)
468 EXPORT_SYMBOL_GPL(nf_conntrack_helper_unregister
);
470 void nf_ct_helper_init(struct nf_conntrack_helper
*helper
,
471 u16 l3num
, u16 protonum
, const char *name
,
472 u16 default_port
, u16 spec_port
, u32 id
,
473 const struct nf_conntrack_expect_policy
*exp_pol
,
474 u32 expect_class_max
, u32 data_len
,
475 int (*help
)(struct sk_buff
*skb
, unsigned int protoff
,
477 enum ip_conntrack_info ctinfo
),
478 int (*from_nlattr
)(struct nlattr
*attr
,
480 struct module
*module
)
482 helper
->tuple
.src
.l3num
= l3num
;
483 helper
->tuple
.dst
.protonum
= protonum
;
484 helper
->tuple
.src
.u
.all
= htons(spec_port
);
485 helper
->expect_policy
= exp_pol
;
486 helper
->expect_class_max
= expect_class_max
;
487 helper
->data_len
= data_len
;
489 helper
->from_nlattr
= from_nlattr
;
492 if (spec_port
== default_port
)
493 snprintf(helper
->name
, sizeof(helper
->name
), "%s", name
);
495 snprintf(helper
->name
, sizeof(helper
->name
), "%s-%u", name
, id
);
497 EXPORT_SYMBOL_GPL(nf_ct_helper_init
);
499 int nf_conntrack_helpers_register(struct nf_conntrack_helper
*helper
,
505 for (i
= 0; i
< n
; i
++) {
506 err
= nf_conntrack_helper_register(&helper
[i
]);
514 nf_conntrack_helpers_unregister(helper
, i
);
517 EXPORT_SYMBOL_GPL(nf_conntrack_helpers_register
);
519 void nf_conntrack_helpers_unregister(struct nf_conntrack_helper
*helper
,
523 nf_conntrack_helper_unregister(&helper
[n
]);
525 EXPORT_SYMBOL_GPL(nf_conntrack_helpers_unregister
);
527 static struct nf_ct_ext_type helper_extend __read_mostly
= {
528 .len
= sizeof(struct nf_conn_help
),
529 .align
= __alignof__(struct nf_conn_help
),
530 .id
= NF_CT_EXT_HELPER
,
533 int nf_conntrack_helper_pernet_init(struct net
*net
)
535 net
->ct
.auto_assign_helper_warned
= false;
536 net
->ct
.sysctl_auto_assign_helper
= nf_ct_auto_assign_helper
;
537 return nf_conntrack_helper_init_sysctl(net
);
540 void nf_conntrack_helper_pernet_fini(struct net
*net
)
542 nf_conntrack_helper_fini_sysctl(net
);
545 int nf_conntrack_helper_init(void)
548 nf_ct_helper_hsize
= 1; /* gets rounded up to use one page */
550 nf_ct_alloc_hashtable(&nf_ct_helper_hsize
, 0);
551 if (!nf_ct_helper_hash
)
554 ret
= nf_ct_extend_register(&helper_extend
);
556 pr_err("nf_ct_helper: Unable to register helper extension.\n");
562 nf_ct_free_hashtable(nf_ct_helper_hash
, nf_ct_helper_hsize
);
566 void nf_conntrack_helper_fini(void)
568 nf_ct_extend_unregister(&helper_extend
);
569 nf_ct_free_hashtable(nf_ct_helper_hash
, nf_ct_helper_hsize
);