1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * (C) 2012 by Vyatta Inc. <http://www.vyatta.com>
6 #include <linux/init.h>
7 #include <linux/module.h>
8 #include <linux/kernel.h>
9 #include <linux/rculist.h>
10 #include <linux/rculist_nulls.h>
11 #include <linux/types.h>
12 #include <linux/timer.h>
13 #include <linux/security.h>
14 #include <linux/skbuff.h>
15 #include <linux/errno.h>
16 #include <linux/netlink.h>
17 #include <linux/spinlock.h>
18 #include <linux/interrupt.h>
19 #include <linux/slab.h>
21 #include <linux/netfilter.h>
22 #include <net/netlink.h>
23 #include <net/netns/generic.h>
25 #include <net/netfilter/nf_conntrack.h>
26 #include <net/netfilter/nf_conntrack_core.h>
27 #include <net/netfilter/nf_conntrack_l4proto.h>
28 #include <net/netfilter/nf_conntrack_tuple.h>
29 #include <net/netfilter/nf_conntrack_timeout.h>
31 #include <linux/netfilter/nfnetlink.h>
32 #include <linux/netfilter/nfnetlink_cttimeout.h>
34 static unsigned int nfct_timeout_id __read_mostly;
37 struct list_head head;
38 struct list_head free_head;
39 struct rcu_head rcu_head;
41 char name[CTNL_TIMEOUT_NAME_MAX];
43 /* must be at the end */
44 struct nf_ct_timeout timeout;
47 struct nfct_timeout_pernet {
48 struct list_head nfct_timeout_list;
49 struct list_head nfct_timeout_freelist;
52 MODULE_LICENSE("GPL");
54 MODULE_DESCRIPTION("cttimeout: Extended Netfilter Connection Tracking timeout tuning");
56 static const struct nla_policy cttimeout_nla_policy[CTA_TIMEOUT_MAX+1] = {
57 [CTA_TIMEOUT_NAME] = { .type = NLA_NUL_STRING,
58 .len = CTNL_TIMEOUT_NAME_MAX - 1},
59 [CTA_TIMEOUT_L3PROTO] = { .type = NLA_U16 },
60 [CTA_TIMEOUT_L4PROTO] = { .type = NLA_U8 },
61 [CTA_TIMEOUT_DATA] = { .type = NLA_NESTED },
64 static struct nfct_timeout_pernet *nfct_timeout_pernet(struct net *net)
66 return net_generic(net, nfct_timeout_id);
70 ctnl_timeout_parse_policy(void *timeout,
71 const struct nf_conntrack_l4proto *l4proto,
72 struct net *net, const struct nlattr *attr)
77 tb = kcalloc(l4proto->ctnl_timeout.nlattr_max + 1, sizeof(*tb),
83 ret = nla_parse_nested_deprecated(tb,
84 l4proto->ctnl_timeout.nlattr_max,
86 l4proto->ctnl_timeout.nla_policy,
91 ret = l4proto->ctnl_timeout.nlattr_to_obj(tb, net, timeout);
98 static int cttimeout_new_timeout(struct sk_buff *skb,
99 const struct nfnl_info *info,
100 const struct nlattr * const cda[])
102 struct nfct_timeout_pernet *pernet = nfct_timeout_pernet(info->net);
105 const struct nf_conntrack_l4proto *l4proto;
106 struct ctnl_timeout *timeout, *matching = NULL;
110 if (!cda[CTA_TIMEOUT_NAME] ||
111 !cda[CTA_TIMEOUT_L3PROTO] ||
112 !cda[CTA_TIMEOUT_L4PROTO] ||
113 !cda[CTA_TIMEOUT_DATA])
116 name = nla_data(cda[CTA_TIMEOUT_NAME]);
117 l3num = ntohs(nla_get_be16(cda[CTA_TIMEOUT_L3PROTO]));
118 l4num = nla_get_u8(cda[CTA_TIMEOUT_L4PROTO]);
120 list_for_each_entry(timeout, &pernet->nfct_timeout_list, head) {
121 if (strncmp(timeout->name, name, CTNL_TIMEOUT_NAME_MAX) != 0)
124 if (info->nlh->nlmsg_flags & NLM_F_EXCL)
132 if (info->nlh->nlmsg_flags & NLM_F_REPLACE) {
133 /* You cannot replace one timeout policy by another of
134 * different kind, sorry.
136 if (matching->timeout.l3num != l3num ||
137 matching->timeout.l4proto->l4proto != l4num)
140 return ctnl_timeout_parse_policy(&matching->timeout.data,
141 matching->timeout.l4proto,
143 cda[CTA_TIMEOUT_DATA]);
149 l4proto = nf_ct_l4proto_find(l4num);
151 /* This protocol is not supportted, skip. */
152 if (l4proto->l4proto != l4num) {
157 timeout = kzalloc(sizeof(struct ctnl_timeout) +
158 l4proto->ctnl_timeout.obj_size, GFP_KERNEL);
159 if (timeout == NULL) {
164 ret = ctnl_timeout_parse_policy(&timeout->timeout.data, l4proto,
165 info->net, cda[CTA_TIMEOUT_DATA]);
169 strcpy(timeout->name, nla_data(cda[CTA_TIMEOUT_NAME]));
170 timeout->timeout.l3num = l3num;
171 timeout->timeout.l4proto = l4proto;
172 refcount_set(&timeout->refcnt, 1);
173 __module_get(THIS_MODULE);
174 list_add_tail_rcu(&timeout->head, &pernet->nfct_timeout_list);
184 ctnl_timeout_fill_info(struct sk_buff *skb, u32 portid, u32 seq, u32 type,
185 int event, struct ctnl_timeout *timeout)
187 struct nlmsghdr *nlh;
188 unsigned int flags = portid ? NLM_F_MULTI : 0;
189 const struct nf_conntrack_l4proto *l4proto = timeout->timeout.l4proto;
190 struct nlattr *nest_parms;
193 event = nfnl_msg_type(NFNL_SUBSYS_CTNETLINK_TIMEOUT, event);
194 nlh = nfnl_msg_put(skb, portid, seq, event, flags, AF_UNSPEC,
199 if (nla_put_string(skb, CTA_TIMEOUT_NAME, timeout->name) ||
200 nla_put_be16(skb, CTA_TIMEOUT_L3PROTO,
201 htons(timeout->timeout.l3num)) ||
202 nla_put_u8(skb, CTA_TIMEOUT_L4PROTO, l4proto->l4proto) ||
203 nla_put_be32(skb, CTA_TIMEOUT_USE,
204 htonl(refcount_read(&timeout->refcnt))))
205 goto nla_put_failure;
207 nest_parms = nla_nest_start(skb, CTA_TIMEOUT_DATA);
209 goto nla_put_failure;
211 ret = l4proto->ctnl_timeout.obj_to_nlattr(skb, &timeout->timeout.data);
213 goto nla_put_failure;
215 nla_nest_end(skb, nest_parms);
222 nlmsg_cancel(skb, nlh);
227 ctnl_timeout_dump(struct sk_buff *skb, struct netlink_callback *cb)
229 struct nfct_timeout_pernet *pernet;
230 struct net *net = sock_net(skb->sk);
231 struct ctnl_timeout *cur, *last;
236 last = (struct ctnl_timeout *)cb->args[1];
241 pernet = nfct_timeout_pernet(net);
242 list_for_each_entry_rcu(cur, &pernet->nfct_timeout_list, head) {
249 if (ctnl_timeout_fill_info(skb, NETLINK_CB(cb->skb).portid,
251 NFNL_MSG_TYPE(cb->nlh->nlmsg_type),
252 IPCTNL_MSG_TIMEOUT_NEW, cur) < 0) {
253 cb->args[1] = (unsigned long)cur;
263 static int cttimeout_get_timeout(struct sk_buff *skb,
264 const struct nfnl_info *info,
265 const struct nlattr * const cda[])
267 struct nfct_timeout_pernet *pernet = nfct_timeout_pernet(info->net);
270 struct ctnl_timeout *cur;
272 if (info->nlh->nlmsg_flags & NLM_F_DUMP) {
273 struct netlink_dump_control c = {
274 .dump = ctnl_timeout_dump,
276 return netlink_dump_start(info->sk, skb, info->nlh, &c);
279 if (!cda[CTA_TIMEOUT_NAME])
281 name = nla_data(cda[CTA_TIMEOUT_NAME]);
283 list_for_each_entry(cur, &pernet->nfct_timeout_list, head) {
284 struct sk_buff *skb2;
286 if (strncmp(cur->name, name, CTNL_TIMEOUT_NAME_MAX) != 0)
289 skb2 = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
295 ret = ctnl_timeout_fill_info(skb2, NETLINK_CB(skb).portid,
296 info->nlh->nlmsg_seq,
297 NFNL_MSG_TYPE(info->nlh->nlmsg_type),
298 IPCTNL_MSG_TIMEOUT_NEW, cur);
304 ret = nfnetlink_unicast(skb2, info->net, NETLINK_CB(skb).portid);
311 /* try to delete object, fail if it is still in use. */
312 static int ctnl_timeout_try_del(struct net *net, struct ctnl_timeout *timeout)
316 /* We want to avoid races with ctnl_timeout_put. So only when the
317 * current refcnt is 1, we decrease it to 0.
319 if (refcount_dec_if_one(&timeout->refcnt)) {
320 /* We are protected by nfnl mutex. */
321 list_del_rcu(&timeout->head);
322 nf_ct_untimeout(net, &timeout->timeout);
323 kfree_rcu(timeout, rcu_head);
330 static int cttimeout_del_timeout(struct sk_buff *skb,
331 const struct nfnl_info *info,
332 const struct nlattr * const cda[])
334 struct nfct_timeout_pernet *pernet = nfct_timeout_pernet(info->net);
335 struct ctnl_timeout *cur, *tmp;
339 if (!cda[CTA_TIMEOUT_NAME]) {
340 list_for_each_entry_safe(cur, tmp, &pernet->nfct_timeout_list,
342 ctnl_timeout_try_del(info->net, cur);
346 name = nla_data(cda[CTA_TIMEOUT_NAME]);
348 list_for_each_entry(cur, &pernet->nfct_timeout_list, head) {
349 if (strncmp(cur->name, name, CTNL_TIMEOUT_NAME_MAX) != 0)
352 ret = ctnl_timeout_try_del(info->net, cur);
361 static int cttimeout_default_set(struct sk_buff *skb,
362 const struct nfnl_info *info,
363 const struct nlattr * const cda[])
365 const struct nf_conntrack_l4proto *l4proto;
369 if (!cda[CTA_TIMEOUT_L3PROTO] ||
370 !cda[CTA_TIMEOUT_L4PROTO] ||
371 !cda[CTA_TIMEOUT_DATA])
374 l4num = nla_get_u8(cda[CTA_TIMEOUT_L4PROTO]);
375 l4proto = nf_ct_l4proto_find(l4num);
377 /* This protocol is not supported, skip. */
378 if (l4proto->l4proto != l4num) {
383 ret = ctnl_timeout_parse_policy(NULL, l4proto, info->net,
384 cda[CTA_TIMEOUT_DATA]);
394 cttimeout_default_fill_info(struct net *net, struct sk_buff *skb, u32 portid,
395 u32 seq, u32 type, int event, u16 l3num,
396 const struct nf_conntrack_l4proto *l4proto,
397 const unsigned int *timeouts)
399 struct nlmsghdr *nlh;
400 unsigned int flags = portid ? NLM_F_MULTI : 0;
401 struct nlattr *nest_parms;
404 event = nfnl_msg_type(NFNL_SUBSYS_CTNETLINK_TIMEOUT, event);
405 nlh = nfnl_msg_put(skb, portid, seq, event, flags, AF_UNSPEC,
410 if (nla_put_be16(skb, CTA_TIMEOUT_L3PROTO, htons(l3num)) ||
411 nla_put_u8(skb, CTA_TIMEOUT_L4PROTO, l4proto->l4proto))
412 goto nla_put_failure;
414 nest_parms = nla_nest_start(skb, CTA_TIMEOUT_DATA);
416 goto nla_put_failure;
418 ret = l4proto->ctnl_timeout.obj_to_nlattr(skb, timeouts);
420 goto nla_put_failure;
422 nla_nest_end(skb, nest_parms);
429 nlmsg_cancel(skb, nlh);
433 static int cttimeout_default_get(struct sk_buff *skb,
434 const struct nfnl_info *info,
435 const struct nlattr * const cda[])
437 const struct nf_conntrack_l4proto *l4proto;
438 unsigned int *timeouts = NULL;
439 struct sk_buff *skb2;
444 if (!cda[CTA_TIMEOUT_L3PROTO] || !cda[CTA_TIMEOUT_L4PROTO])
447 l3num = ntohs(nla_get_be16(cda[CTA_TIMEOUT_L3PROTO]));
448 l4num = nla_get_u8(cda[CTA_TIMEOUT_L4PROTO]);
449 l4proto = nf_ct_l4proto_find(l4num);
451 if (l4proto->l4proto != l4num)
454 switch (l4proto->l4proto) {
456 timeouts = &nf_icmp_pernet(info->net)->timeout;
459 timeouts = nf_tcp_pernet(info->net)->timeouts;
462 case IPPROTO_UDPLITE:
463 timeouts = nf_udp_pernet(info->net)->timeouts;
466 #ifdef CONFIG_NF_CT_PROTO_DCCP
467 timeouts = nf_dccp_pernet(info->net)->dccp_timeout;
471 timeouts = &nf_icmpv6_pernet(info->net)->timeout;
474 #ifdef CONFIG_NF_CT_PROTO_SCTP
475 timeouts = nf_sctp_pernet(info->net)->timeouts;
479 #ifdef CONFIG_NF_CT_PROTO_GRE
480 timeouts = nf_gre_pernet(info->net)->timeouts;
484 timeouts = &nf_generic_pernet(info->net)->timeout;
487 WARN_ONCE(1, "Missing timeouts for proto %d", l4proto->l4proto);
494 skb2 = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
498 ret = cttimeout_default_fill_info(info->net, skb2,
499 NETLINK_CB(skb).portid,
500 info->nlh->nlmsg_seq,
501 NFNL_MSG_TYPE(info->nlh->nlmsg_type),
502 IPCTNL_MSG_TIMEOUT_DEFAULT_SET,
503 l3num, l4proto, timeouts);
509 return nfnetlink_unicast(skb2, info->net, NETLINK_CB(skb).portid);
512 static struct nf_ct_timeout *ctnl_timeout_find_get(struct net *net,
515 struct nfct_timeout_pernet *pernet = nfct_timeout_pernet(net);
516 struct ctnl_timeout *timeout, *matching = NULL;
518 list_for_each_entry_rcu(timeout, &pernet->nfct_timeout_list, head) {
519 if (strncmp(timeout->name, name, CTNL_TIMEOUT_NAME_MAX) != 0)
522 if (!refcount_inc_not_zero(&timeout->refcnt))
528 return matching ? &matching->timeout : NULL;
531 static void ctnl_timeout_put(struct nf_ct_timeout *t)
533 struct ctnl_timeout *timeout =
534 container_of(t, struct ctnl_timeout, timeout);
536 if (refcount_dec_and_test(&timeout->refcnt)) {
537 kfree_rcu(timeout, rcu_head);
538 module_put(THIS_MODULE);
542 static const struct nfnl_callback cttimeout_cb[IPCTNL_MSG_TIMEOUT_MAX] = {
543 [IPCTNL_MSG_TIMEOUT_NEW] = {
544 .call = cttimeout_new_timeout,
545 .type = NFNL_CB_MUTEX,
546 .attr_count = CTA_TIMEOUT_MAX,
547 .policy = cttimeout_nla_policy
549 [IPCTNL_MSG_TIMEOUT_GET] = {
550 .call = cttimeout_get_timeout,
551 .type = NFNL_CB_MUTEX,
552 .attr_count = CTA_TIMEOUT_MAX,
553 .policy = cttimeout_nla_policy
555 [IPCTNL_MSG_TIMEOUT_DELETE] = {
556 .call = cttimeout_del_timeout,
557 .type = NFNL_CB_MUTEX,
558 .attr_count = CTA_TIMEOUT_MAX,
559 .policy = cttimeout_nla_policy
561 [IPCTNL_MSG_TIMEOUT_DEFAULT_SET] = {
562 .call = cttimeout_default_set,
563 .type = NFNL_CB_MUTEX,
564 .attr_count = CTA_TIMEOUT_MAX,
565 .policy = cttimeout_nla_policy
567 [IPCTNL_MSG_TIMEOUT_DEFAULT_GET] = {
568 .call = cttimeout_default_get,
569 .type = NFNL_CB_MUTEX,
570 .attr_count = CTA_TIMEOUT_MAX,
571 .policy = cttimeout_nla_policy
575 static const struct nfnetlink_subsystem cttimeout_subsys = {
576 .name = "conntrack_timeout",
577 .subsys_id = NFNL_SUBSYS_CTNETLINK_TIMEOUT,
578 .cb_count = IPCTNL_MSG_TIMEOUT_MAX,
582 MODULE_ALIAS_NFNL_SUBSYS(NFNL_SUBSYS_CTNETLINK_TIMEOUT);
584 static int __net_init cttimeout_net_init(struct net *net)
586 struct nfct_timeout_pernet *pernet = nfct_timeout_pernet(net);
588 INIT_LIST_HEAD(&pernet->nfct_timeout_list);
589 INIT_LIST_HEAD(&pernet->nfct_timeout_freelist);
594 static void __net_exit cttimeout_net_pre_exit(struct net *net)
596 struct nfct_timeout_pernet *pernet = nfct_timeout_pernet(net);
597 struct ctnl_timeout *cur, *tmp;
599 list_for_each_entry_safe(cur, tmp, &pernet->nfct_timeout_list, head) {
600 list_del_rcu(&cur->head);
601 list_add(&cur->free_head, &pernet->nfct_timeout_freelist);
604 /* core calls synchronize_rcu() after this */
607 static void __net_exit cttimeout_net_exit(struct net *net)
609 struct nfct_timeout_pernet *pernet = nfct_timeout_pernet(net);
610 struct ctnl_timeout *cur, *tmp;
612 if (list_empty(&pernet->nfct_timeout_freelist))
615 nf_ct_untimeout(net, NULL);
617 list_for_each_entry_safe(cur, tmp, &pernet->nfct_timeout_freelist, free_head) {
618 list_del(&cur->free_head);
620 if (refcount_dec_and_test(&cur->refcnt))
621 kfree_rcu(cur, rcu_head);
625 static struct pernet_operations cttimeout_ops = {
626 .init = cttimeout_net_init,
627 .pre_exit = cttimeout_net_pre_exit,
628 .exit = cttimeout_net_exit,
629 .id = &nfct_timeout_id,
630 .size = sizeof(struct nfct_timeout_pernet),
633 static const struct nf_ct_timeout_hooks hooks = {
634 .timeout_find_get = ctnl_timeout_find_get,
635 .timeout_put = ctnl_timeout_put,
638 static int __init cttimeout_init(void)
642 ret = register_pernet_subsys(&cttimeout_ops);
646 ret = nfnetlink_subsys_register(&cttimeout_subsys);
648 pr_err("cttimeout_init: cannot register cttimeout with "
652 RCU_INIT_POINTER(nf_ct_timeout_hook, &hooks);
656 unregister_pernet_subsys(&cttimeout_ops);
660 static int untimeout(struct nf_conn *ct, void *timeout)
662 struct nf_conn_timeout *timeout_ext = nf_ct_timeout_find(ct);
665 RCU_INIT_POINTER(timeout_ext->timeout, NULL);
670 static void __exit cttimeout_exit(void)
672 nfnetlink_subsys_unregister(&cttimeout_subsys);
674 unregister_pernet_subsys(&cttimeout_ops);
675 RCU_INIT_POINTER(nf_ct_timeout_hook, NULL);
677 nf_ct_iterate_destroy(untimeout, NULL);
680 module_init(cttimeout_init);
681 module_exit(cttimeout_exit);