2 * (C) 2012 Pablo Neira Ayuso <pablo@netfilter.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation (or any later at your option).
8 * This software has been sponsored by Vyatta Inc. <http://www.vyatta.com>
10 #include <linux/init.h>
11 #include <linux/module.h>
12 #include <linux/kernel.h>
13 #include <linux/skbuff.h>
14 #include <linux/netlink.h>
15 #include <linux/rculist.h>
16 #include <linux/slab.h>
17 #include <linux/types.h>
18 #include <linux/list.h>
19 #include <linux/errno.h>
20 #include <linux/capability.h>
21 #include <net/netlink.h>
24 #include <net/netfilter/nf_conntrack_helper.h>
25 #include <net/netfilter/nf_conntrack_expect.h>
26 #include <net/netfilter/nf_conntrack_ecache.h>
28 #include <linux/netfilter/nfnetlink.h>
29 #include <linux/netfilter/nfnetlink_conntrack.h>
30 #include <linux/netfilter/nfnetlink_cthelper.h>
32 MODULE_LICENSE("GPL");
33 MODULE_AUTHOR("Pablo Neira Ayuso <pablo@netfilter.org>");
34 MODULE_DESCRIPTION("nfnl_cthelper: User-space connection tracking helpers");
36 struct nfnl_cthelper {
37 struct list_head list;
38 struct nf_conntrack_helper helper;
41 static LIST_HEAD(nfnl_cthelper_list);
44 nfnl_userspace_cthelper(struct sk_buff *skb, unsigned int protoff,
45 struct nf_conn *ct, enum ip_conntrack_info ctinfo)
47 const struct nf_conn_help *help;
48 struct nf_conntrack_helper *helper;
54 /* rcu_read_lock()ed by nf_hook_thresh */
55 helper = rcu_dereference(help->helper);
59 /* This is a user-space helper not yet configured, skip. */
61 (NF_CT_HELPER_F_USERSPACE | NF_CT_HELPER_F_CONFIGURED)) ==
62 NF_CT_HELPER_F_USERSPACE)
65 /* If the user-space helper is not available, don't block traffic. */
66 return NF_QUEUE_NR(helper->queue_num) | NF_VERDICT_FLAG_QUEUE_BYPASS;
69 static const struct nla_policy nfnl_cthelper_tuple_pol[NFCTH_TUPLE_MAX+1] = {
70 [NFCTH_TUPLE_L3PROTONUM] = { .type = NLA_U16, },
71 [NFCTH_TUPLE_L4PROTONUM] = { .type = NLA_U8, },
75 nfnl_cthelper_parse_tuple(struct nf_conntrack_tuple *tuple,
76 const struct nlattr *attr)
79 struct nlattr *tb[NFCTH_TUPLE_MAX+1];
81 err = nla_parse_nested(tb, NFCTH_TUPLE_MAX, attr,
82 nfnl_cthelper_tuple_pol, NULL);
86 if (!tb[NFCTH_TUPLE_L3PROTONUM] || !tb[NFCTH_TUPLE_L4PROTONUM])
89 /* Not all fields are initialized so first zero the tuple */
90 memset(tuple, 0, sizeof(struct nf_conntrack_tuple));
92 tuple->src.l3num = ntohs(nla_get_be16(tb[NFCTH_TUPLE_L3PROTONUM]));
93 tuple->dst.protonum = nla_get_u8(tb[NFCTH_TUPLE_L4PROTONUM]);
99 nfnl_cthelper_from_nlattr(struct nlattr *attr, struct nf_conn *ct)
101 struct nf_conn_help *help = nfct_help(ct);
106 if (help->helper->data_len == 0)
109 nla_memcpy(help->data, attr, sizeof(help->data));
114 nfnl_cthelper_to_nlattr(struct sk_buff *skb, const struct nf_conn *ct)
116 const struct nf_conn_help *help = nfct_help(ct);
118 if (help->helper->data_len &&
119 nla_put(skb, CTA_HELP_INFO, help->helper->data_len, &help->data))
120 goto nla_put_failure;
128 static const struct nla_policy nfnl_cthelper_expect_pol[NFCTH_POLICY_MAX+1] = {
129 [NFCTH_POLICY_NAME] = { .type = NLA_NUL_STRING,
130 .len = NF_CT_HELPER_NAME_LEN-1 },
131 [NFCTH_POLICY_EXPECT_MAX] = { .type = NLA_U32, },
132 [NFCTH_POLICY_EXPECT_TIMEOUT] = { .type = NLA_U32, },
136 nfnl_cthelper_expect_policy(struct nf_conntrack_expect_policy *expect_policy,
137 const struct nlattr *attr)
140 struct nlattr *tb[NFCTH_POLICY_MAX+1];
142 err = nla_parse_nested(tb, NFCTH_POLICY_MAX, attr,
143 nfnl_cthelper_expect_pol, NULL);
147 if (!tb[NFCTH_POLICY_NAME] ||
148 !tb[NFCTH_POLICY_EXPECT_MAX] ||
149 !tb[NFCTH_POLICY_EXPECT_TIMEOUT])
152 strncpy(expect_policy->name,
153 nla_data(tb[NFCTH_POLICY_NAME]), NF_CT_HELPER_NAME_LEN);
154 expect_policy->max_expected =
155 ntohl(nla_get_be32(tb[NFCTH_POLICY_EXPECT_MAX]));
156 if (expect_policy->max_expected > NF_CT_EXPECT_MAX_CNT)
159 expect_policy->timeout =
160 ntohl(nla_get_be32(tb[NFCTH_POLICY_EXPECT_TIMEOUT]));
165 static const struct nla_policy
166 nfnl_cthelper_expect_policy_set[NFCTH_POLICY_SET_MAX+1] = {
167 [NFCTH_POLICY_SET_NUM] = { .type = NLA_U32, },
171 nfnl_cthelper_parse_expect_policy(struct nf_conntrack_helper *helper,
172 const struct nlattr *attr)
175 struct nf_conntrack_expect_policy *expect_policy;
176 struct nlattr *tb[NFCTH_POLICY_SET_MAX+1];
177 unsigned int class_max;
179 ret = nla_parse_nested(tb, NFCTH_POLICY_SET_MAX, attr,
180 nfnl_cthelper_expect_policy_set, NULL);
184 if (!tb[NFCTH_POLICY_SET_NUM])
187 class_max = ntohl(nla_get_be32(tb[NFCTH_POLICY_SET_NUM]));
190 if (class_max > NF_CT_MAX_EXPECT_CLASSES)
193 expect_policy = kzalloc(sizeof(struct nf_conntrack_expect_policy) *
194 class_max, GFP_KERNEL);
195 if (expect_policy == NULL)
198 for (i = 0; i < class_max; i++) {
199 if (!tb[NFCTH_POLICY_SET+i])
202 ret = nfnl_cthelper_expect_policy(&expect_policy[i],
203 tb[NFCTH_POLICY_SET+i]);
208 helper->expect_class_max = class_max - 1;
209 helper->expect_policy = expect_policy;
212 kfree(expect_policy);
217 nfnl_cthelper_create(const struct nlattr * const tb[],
218 struct nf_conntrack_tuple *tuple)
220 struct nf_conntrack_helper *helper;
221 struct nfnl_cthelper *nfcth;
225 if (!tb[NFCTH_TUPLE] || !tb[NFCTH_POLICY] || !tb[NFCTH_PRIV_DATA_LEN])
228 nfcth = kzalloc(sizeof(*nfcth), GFP_KERNEL);
231 helper = &nfcth->helper;
233 ret = nfnl_cthelper_parse_expect_policy(helper, tb[NFCTH_POLICY]);
237 strncpy(helper->name, nla_data(tb[NFCTH_NAME]), NF_CT_HELPER_NAME_LEN);
238 size = ntohl(nla_get_be32(tb[NFCTH_PRIV_DATA_LEN]));
239 if (size > FIELD_SIZEOF(struct nf_conn_help, data)) {
243 helper->data_len = size;
245 helper->flags |= NF_CT_HELPER_F_USERSPACE;
246 memcpy(&helper->tuple, tuple, sizeof(struct nf_conntrack_tuple));
248 helper->me = THIS_MODULE;
249 helper->help = nfnl_userspace_cthelper;
250 helper->from_nlattr = nfnl_cthelper_from_nlattr;
251 helper->to_nlattr = nfnl_cthelper_to_nlattr;
253 /* Default to queue number zero, this can be updated at any time. */
254 if (tb[NFCTH_QUEUE_NUM])
255 helper->queue_num = ntohl(nla_get_be32(tb[NFCTH_QUEUE_NUM]));
257 if (tb[NFCTH_STATUS]) {
258 int status = ntohl(nla_get_be32(tb[NFCTH_STATUS]));
261 case NFCT_HELPER_STATUS_ENABLED:
262 helper->flags |= NF_CT_HELPER_F_CONFIGURED;
264 case NFCT_HELPER_STATUS_DISABLED:
265 helper->flags &= ~NF_CT_HELPER_F_CONFIGURED;
270 ret = nf_conntrack_helper_register(helper);
274 list_add_tail(&nfcth->list, &nfnl_cthelper_list);
277 kfree(helper->expect_policy);
284 nfnl_cthelper_update_policy_one(const struct nf_conntrack_expect_policy *policy,
285 struct nf_conntrack_expect_policy *new_policy,
286 const struct nlattr *attr)
288 struct nlattr *tb[NFCTH_POLICY_MAX + 1];
291 err = nla_parse_nested(tb, NFCTH_POLICY_MAX, attr,
292 nfnl_cthelper_expect_pol, NULL);
296 if (!tb[NFCTH_POLICY_NAME] ||
297 !tb[NFCTH_POLICY_EXPECT_MAX] ||
298 !tb[NFCTH_POLICY_EXPECT_TIMEOUT])
301 if (nla_strcmp(tb[NFCTH_POLICY_NAME], policy->name))
304 new_policy->max_expected =
305 ntohl(nla_get_be32(tb[NFCTH_POLICY_EXPECT_MAX]));
306 if (new_policy->max_expected > NF_CT_EXPECT_MAX_CNT)
309 new_policy->timeout =
310 ntohl(nla_get_be32(tb[NFCTH_POLICY_EXPECT_TIMEOUT]));
315 static int nfnl_cthelper_update_policy_all(struct nlattr *tb[],
316 struct nf_conntrack_helper *helper)
318 struct nf_conntrack_expect_policy new_policy[helper->expect_class_max + 1];
319 struct nf_conntrack_expect_policy *policy;
322 /* Check first that all policy attributes are well-formed, so we don't
323 * leave things in inconsistent state on errors.
325 for (i = 0; i < helper->expect_class_max + 1; i++) {
327 if (!tb[NFCTH_POLICY_SET + i])
330 err = nfnl_cthelper_update_policy_one(&helper->expect_policy[i],
332 tb[NFCTH_POLICY_SET + i]);
336 /* Now we can safely update them. */
337 for (i = 0; i < helper->expect_class_max + 1; i++) {
338 policy = (struct nf_conntrack_expect_policy *)
339 &helper->expect_policy[i];
340 policy->max_expected = new_policy->max_expected;
341 policy->timeout = new_policy->timeout;
347 static int nfnl_cthelper_update_policy(struct nf_conntrack_helper *helper,
348 const struct nlattr *attr)
350 struct nlattr *tb[NFCTH_POLICY_SET_MAX + 1];
351 unsigned int class_max;
354 err = nla_parse_nested(tb, NFCTH_POLICY_SET_MAX, attr,
355 nfnl_cthelper_expect_policy_set, NULL);
359 if (!tb[NFCTH_POLICY_SET_NUM])
362 class_max = ntohl(nla_get_be32(tb[NFCTH_POLICY_SET_NUM]));
363 if (helper->expect_class_max + 1 != class_max)
366 return nfnl_cthelper_update_policy_all(tb, helper);
370 nfnl_cthelper_update(const struct nlattr * const tb[],
371 struct nf_conntrack_helper *helper)
376 if (tb[NFCTH_PRIV_DATA_LEN]) {
377 size = ntohl(nla_get_be32(tb[NFCTH_PRIV_DATA_LEN]));
378 if (size != helper->data_len)
382 if (tb[NFCTH_POLICY]) {
383 ret = nfnl_cthelper_update_policy(helper, tb[NFCTH_POLICY]);
387 if (tb[NFCTH_QUEUE_NUM])
388 helper->queue_num = ntohl(nla_get_be32(tb[NFCTH_QUEUE_NUM]));
390 if (tb[NFCTH_STATUS]) {
391 int status = ntohl(nla_get_be32(tb[NFCTH_STATUS]));
394 case NFCT_HELPER_STATUS_ENABLED:
395 helper->flags |= NF_CT_HELPER_F_CONFIGURED;
397 case NFCT_HELPER_STATUS_DISABLED:
398 helper->flags &= ~NF_CT_HELPER_F_CONFIGURED;
405 static int nfnl_cthelper_new(struct net *net, struct sock *nfnl,
406 struct sk_buff *skb, const struct nlmsghdr *nlh,
407 const struct nlattr * const tb[],
408 struct netlink_ext_ack *extack)
410 const char *helper_name;
411 struct nf_conntrack_helper *cur, *helper = NULL;
412 struct nf_conntrack_tuple tuple;
413 struct nfnl_cthelper *nlcth;
416 if (!capable(CAP_NET_ADMIN))
419 if (!tb[NFCTH_NAME] || !tb[NFCTH_TUPLE])
422 helper_name = nla_data(tb[NFCTH_NAME]);
424 ret = nfnl_cthelper_parse_tuple(&tuple, tb[NFCTH_TUPLE]);
428 list_for_each_entry(nlcth, &nfnl_cthelper_list, list) {
429 cur = &nlcth->helper;
431 if (strncmp(cur->name, helper_name, NF_CT_HELPER_NAME_LEN))
434 if ((tuple.src.l3num != cur->tuple.src.l3num ||
435 tuple.dst.protonum != cur->tuple.dst.protonum))
438 if (nlh->nlmsg_flags & NLM_F_EXCL)
446 ret = nfnl_cthelper_create(tb, &tuple);
448 ret = nfnl_cthelper_update(tb, helper);
454 nfnl_cthelper_dump_tuple(struct sk_buff *skb,
455 struct nf_conntrack_helper *helper)
457 struct nlattr *nest_parms;
459 nest_parms = nla_nest_start(skb, NFCTH_TUPLE | NLA_F_NESTED);
460 if (nest_parms == NULL)
461 goto nla_put_failure;
463 if (nla_put_be16(skb, NFCTH_TUPLE_L3PROTONUM,
464 htons(helper->tuple.src.l3num)))
465 goto nla_put_failure;
467 if (nla_put_u8(skb, NFCTH_TUPLE_L4PROTONUM, helper->tuple.dst.protonum))
468 goto nla_put_failure;
470 nla_nest_end(skb, nest_parms);
478 nfnl_cthelper_dump_policy(struct sk_buff *skb,
479 struct nf_conntrack_helper *helper)
482 struct nlattr *nest_parms1, *nest_parms2;
484 nest_parms1 = nla_nest_start(skb, NFCTH_POLICY | NLA_F_NESTED);
485 if (nest_parms1 == NULL)
486 goto nla_put_failure;
488 if (nla_put_be32(skb, NFCTH_POLICY_SET_NUM,
489 htonl(helper->expect_class_max + 1)))
490 goto nla_put_failure;
492 for (i = 0; i < helper->expect_class_max + 1; i++) {
493 nest_parms2 = nla_nest_start(skb,
494 (NFCTH_POLICY_SET+i) | NLA_F_NESTED);
495 if (nest_parms2 == NULL)
496 goto nla_put_failure;
498 if (nla_put_string(skb, NFCTH_POLICY_NAME,
499 helper->expect_policy[i].name))
500 goto nla_put_failure;
502 if (nla_put_be32(skb, NFCTH_POLICY_EXPECT_MAX,
503 htonl(helper->expect_policy[i].max_expected)))
504 goto nla_put_failure;
506 if (nla_put_be32(skb, NFCTH_POLICY_EXPECT_TIMEOUT,
507 htonl(helper->expect_policy[i].timeout)))
508 goto nla_put_failure;
510 nla_nest_end(skb, nest_parms2);
512 nla_nest_end(skb, nest_parms1);
520 nfnl_cthelper_fill_info(struct sk_buff *skb, u32 portid, u32 seq, u32 type,
521 int event, struct nf_conntrack_helper *helper)
523 struct nlmsghdr *nlh;
524 struct nfgenmsg *nfmsg;
525 unsigned int flags = portid ? NLM_F_MULTI : 0;
528 event = nfnl_msg_type(NFNL_SUBSYS_CTHELPER, event);
529 nlh = nlmsg_put(skb, portid, seq, event, sizeof(*nfmsg), flags);
533 nfmsg = nlmsg_data(nlh);
534 nfmsg->nfgen_family = AF_UNSPEC;
535 nfmsg->version = NFNETLINK_V0;
538 if (nla_put_string(skb, NFCTH_NAME, helper->name))
539 goto nla_put_failure;
541 if (nla_put_be32(skb, NFCTH_QUEUE_NUM, htonl(helper->queue_num)))
542 goto nla_put_failure;
544 if (nfnl_cthelper_dump_tuple(skb, helper) < 0)
545 goto nla_put_failure;
547 if (nfnl_cthelper_dump_policy(skb, helper) < 0)
548 goto nla_put_failure;
550 if (nla_put_be32(skb, NFCTH_PRIV_DATA_LEN, htonl(helper->data_len)))
551 goto nla_put_failure;
553 if (helper->flags & NF_CT_HELPER_F_CONFIGURED)
554 status = NFCT_HELPER_STATUS_ENABLED;
556 status = NFCT_HELPER_STATUS_DISABLED;
558 if (nla_put_be32(skb, NFCTH_STATUS, htonl(status)))
559 goto nla_put_failure;
566 nlmsg_cancel(skb, nlh);
571 nfnl_cthelper_dump_table(struct sk_buff *skb, struct netlink_callback *cb)
573 struct nf_conntrack_helper *cur, *last;
576 last = (struct nf_conntrack_helper *)cb->args[1];
577 for (; cb->args[0] < nf_ct_helper_hsize; cb->args[0]++) {
579 hlist_for_each_entry_rcu(cur,
580 &nf_ct_helper_hash[cb->args[0]], hnode) {
582 /* skip non-userspace conntrack helpers. */
583 if (!(cur->flags & NF_CT_HELPER_F_USERSPACE))
591 if (nfnl_cthelper_fill_info(skb,
592 NETLINK_CB(cb->skb).portid,
594 NFNL_MSG_TYPE(cb->nlh->nlmsg_type),
595 NFNL_MSG_CTHELPER_NEW, cur) < 0) {
596 cb->args[1] = (unsigned long)cur;
610 static int nfnl_cthelper_get(struct net *net, struct sock *nfnl,
611 struct sk_buff *skb, const struct nlmsghdr *nlh,
612 const struct nlattr * const tb[],
613 struct netlink_ext_ack *extack)
616 struct nf_conntrack_helper *cur;
617 struct sk_buff *skb2;
618 char *helper_name = NULL;
619 struct nf_conntrack_tuple tuple;
620 struct nfnl_cthelper *nlcth;
621 bool tuple_set = false;
623 if (!capable(CAP_NET_ADMIN))
626 if (nlh->nlmsg_flags & NLM_F_DUMP) {
627 struct netlink_dump_control c = {
628 .dump = nfnl_cthelper_dump_table,
630 return netlink_dump_start(nfnl, skb, nlh, &c);
634 helper_name = nla_data(tb[NFCTH_NAME]);
636 if (tb[NFCTH_TUPLE]) {
637 ret = nfnl_cthelper_parse_tuple(&tuple, tb[NFCTH_TUPLE]);
644 list_for_each_entry(nlcth, &nfnl_cthelper_list, list) {
645 cur = &nlcth->helper;
647 strncmp(cur->name, helper_name, NF_CT_HELPER_NAME_LEN))
651 (tuple.src.l3num != cur->tuple.src.l3num ||
652 tuple.dst.protonum != cur->tuple.dst.protonum))
655 skb2 = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
661 ret = nfnl_cthelper_fill_info(skb2, NETLINK_CB(skb).portid,
663 NFNL_MSG_TYPE(nlh->nlmsg_type),
664 NFNL_MSG_CTHELPER_NEW, cur);
670 ret = netlink_unicast(nfnl, skb2, NETLINK_CB(skb).portid,
675 /* this avoids a loop in nfnetlink. */
676 return ret == -EAGAIN ? -ENOBUFS : ret;
681 static int nfnl_cthelper_del(struct net *net, struct sock *nfnl,
682 struct sk_buff *skb, const struct nlmsghdr *nlh,
683 const struct nlattr * const tb[],
684 struct netlink_ext_ack *extack)
686 char *helper_name = NULL;
687 struct nf_conntrack_helper *cur;
688 struct nf_conntrack_tuple tuple;
689 bool tuple_set = false, found = false;
690 struct nfnl_cthelper *nlcth, *n;
693 if (!capable(CAP_NET_ADMIN))
697 helper_name = nla_data(tb[NFCTH_NAME]);
699 if (tb[NFCTH_TUPLE]) {
700 ret = nfnl_cthelper_parse_tuple(&tuple, tb[NFCTH_TUPLE]);
708 list_for_each_entry_safe(nlcth, n, &nfnl_cthelper_list, list) {
709 cur = &nlcth->helper;
713 strncmp(cur->name, helper_name, NF_CT_HELPER_NAME_LEN))
717 (tuple.src.l3num != cur->tuple.src.l3num ||
718 tuple.dst.protonum != cur->tuple.dst.protonum))
721 if (refcount_dec_if_one(&cur->refcnt)) {
723 nf_conntrack_helper_unregister(cur);
724 kfree(cur->expect_policy);
726 list_del(&nlcth->list);
733 /* Make sure we return success if we flush and there is no helpers */
734 return (found || j == 0) ? 0 : ret;
737 static const struct nla_policy nfnl_cthelper_policy[NFCTH_MAX+1] = {
738 [NFCTH_NAME] = { .type = NLA_NUL_STRING,
739 .len = NF_CT_HELPER_NAME_LEN-1 },
740 [NFCTH_QUEUE_NUM] = { .type = NLA_U32, },
741 [NFCTH_PRIV_DATA_LEN] = { .type = NLA_U32, },
742 [NFCTH_STATUS] = { .type = NLA_U32, },
745 static const struct nfnl_callback nfnl_cthelper_cb[NFNL_MSG_CTHELPER_MAX] = {
746 [NFNL_MSG_CTHELPER_NEW] = { .call = nfnl_cthelper_new,
747 .attr_count = NFCTH_MAX,
748 .policy = nfnl_cthelper_policy },
749 [NFNL_MSG_CTHELPER_GET] = { .call = nfnl_cthelper_get,
750 .attr_count = NFCTH_MAX,
751 .policy = nfnl_cthelper_policy },
752 [NFNL_MSG_CTHELPER_DEL] = { .call = nfnl_cthelper_del,
753 .attr_count = NFCTH_MAX,
754 .policy = nfnl_cthelper_policy },
757 static const struct nfnetlink_subsystem nfnl_cthelper_subsys = {
759 .subsys_id = NFNL_SUBSYS_CTHELPER,
760 .cb_count = NFNL_MSG_CTHELPER_MAX,
761 .cb = nfnl_cthelper_cb,
764 MODULE_ALIAS_NFNL_SUBSYS(NFNL_SUBSYS_CTHELPER);
766 static int __init nfnl_cthelper_init(void)
770 ret = nfnetlink_subsys_register(&nfnl_cthelper_subsys);
772 pr_err("nfnl_cthelper: cannot register with nfnetlink.\n");
780 static void __exit nfnl_cthelper_exit(void)
782 struct nf_conntrack_helper *cur;
783 struct nfnl_cthelper *nlcth, *n;
785 nfnetlink_subsys_unregister(&nfnl_cthelper_subsys);
787 list_for_each_entry_safe(nlcth, n, &nfnl_cthelper_list, list) {
788 cur = &nlcth->helper;
790 nf_conntrack_helper_unregister(cur);
791 kfree(cur->expect_policy);
796 module_init(nfnl_cthelper_init);
797 module_exit(nfnl_cthelper_exit);