2 * Copyright (c) 2006 Patrick McHardy <kaber@trash.net>
3 * Copyright © CC Computer Consultants GmbH, 2007 - 2008
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * This is a replacement of the old ipt_recent module, which carried the
10 * following copyright notice:
12 * Author: Stephen Frost <sfrost@snowman.net>
13 * Copyright 2002-2003, Stephen Frost, 2.5.x port by laforge@netfilter.org
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/init.h>
18 #include <linux/ipv6.h>
19 #include <linux/module.h>
20 #include <linux/moduleparam.h>
21 #include <linux/proc_fs.h>
22 #include <linux/seq_file.h>
23 #include <linux/string.h>
24 #include <linux/ctype.h>
25 #include <linux/list.h>
26 #include <linux/random.h>
27 #include <linux/jhash.h>
28 #include <linux/bitops.h>
29 #include <linux/skbuff.h>
30 #include <linux/inet.h>
31 #include <linux/slab.h>
32 #include <linux/vmalloc.h>
33 #include <net/net_namespace.h>
34 #include <net/netns/generic.h>
36 #include <linux/netfilter/x_tables.h>
37 #include <linux/netfilter/xt_recent.h>
39 MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
40 MODULE_AUTHOR("Jan Engelhardt <jengelh@medozas.de>");
41 MODULE_DESCRIPTION("Xtables: \"recently-seen\" host matching");
42 MODULE_LICENSE("GPL");
43 MODULE_ALIAS("ipt_recent");
44 MODULE_ALIAS("ip6t_recent");
46 static unsigned int ip_list_tot
= 100;
47 static unsigned int ip_pkt_list_tot
= 20;
48 static unsigned int ip_list_hash_size
= 0;
49 static unsigned int ip_list_perms
= 0644;
50 static unsigned int ip_list_uid
= 0;
51 static unsigned int ip_list_gid
= 0;
52 module_param(ip_list_tot
, uint
, 0400);
53 module_param(ip_pkt_list_tot
, uint
, 0400);
54 module_param(ip_list_hash_size
, uint
, 0400);
55 module_param(ip_list_perms
, uint
, 0400);
56 module_param(ip_list_uid
, uint
, S_IRUGO
| S_IWUSR
);
57 module_param(ip_list_gid
, uint
, S_IRUGO
| S_IWUSR
);
58 MODULE_PARM_DESC(ip_list_tot
, "number of IPs to remember per list");
59 MODULE_PARM_DESC(ip_pkt_list_tot
, "number of packets per IP address to remember (max. 255)");
60 MODULE_PARM_DESC(ip_list_hash_size
, "size of hash table used to look up IPs");
61 MODULE_PARM_DESC(ip_list_perms
, "permissions on /proc/net/xt_recent/* files");
62 MODULE_PARM_DESC(ip_list_uid
, "default owner of /proc/net/xt_recent/* files");
63 MODULE_PARM_DESC(ip_list_gid
, "default owning group of /proc/net/xt_recent/* files");
66 struct list_head list
;
67 struct list_head lru_list
;
68 union nf_inet_addr addr
;
73 unsigned long stamps
[0];
77 struct list_head list
;
78 char name
[XT_RECENT_NAME_LEN
];
79 union nf_inet_addr mask
;
82 struct list_head lru_list
;
83 struct list_head iphash
[0];
87 struct list_head tables
;
89 struct proc_dir_entry
*xt_recent
;
93 static int recent_net_id
;
94 static inline struct recent_net
*recent_pernet(struct net
*net
)
96 return net_generic(net
, recent_net_id
);
99 static DEFINE_SPINLOCK(recent_lock
);
100 static DEFINE_MUTEX(recent_mutex
);
102 #ifdef CONFIG_PROC_FS
103 static const struct file_operations recent_old_fops
, recent_mt_fops
;
106 static u_int32_t hash_rnd __read_mostly
;
107 static bool hash_rnd_inited __read_mostly
;
109 static inline unsigned int recent_entry_hash4(const union nf_inet_addr
*addr
)
111 return jhash_1word((__force u32
)addr
->ip
, hash_rnd
) &
112 (ip_list_hash_size
- 1);
115 static inline unsigned int recent_entry_hash6(const union nf_inet_addr
*addr
)
117 return jhash2((u32
*)addr
->ip6
, ARRAY_SIZE(addr
->ip6
), hash_rnd
) &
118 (ip_list_hash_size
- 1);
121 static struct recent_entry
*
122 recent_entry_lookup(const struct recent_table
*table
,
123 const union nf_inet_addr
*addrp
, u_int16_t family
,
126 struct recent_entry
*e
;
129 if (family
== NFPROTO_IPV4
)
130 h
= recent_entry_hash4(addrp
);
132 h
= recent_entry_hash6(addrp
);
134 list_for_each_entry(e
, &table
->iphash
[h
], list
)
135 if (e
->family
== family
&&
136 memcmp(&e
->addr
, addrp
, sizeof(e
->addr
)) == 0 &&
137 (ttl
== e
->ttl
|| ttl
== 0 || e
->ttl
== 0))
142 static void recent_entry_remove(struct recent_table
*t
, struct recent_entry
*e
)
145 list_del(&e
->lru_list
);
151 * Drop entries with timestamps older then 'time'.
153 static void recent_entry_reap(struct recent_table
*t
, unsigned long time
)
155 struct recent_entry
*e
;
158 * The head of the LRU list is always the oldest entry.
160 e
= list_entry(t
->lru_list
.next
, struct recent_entry
, lru_list
);
163 * The last time stamp is the most recent.
165 if (time_after(time
, e
->stamps
[e
->index
-1]))
166 recent_entry_remove(t
, e
);
169 static struct recent_entry
*
170 recent_entry_init(struct recent_table
*t
, const union nf_inet_addr
*addr
,
171 u_int16_t family
, u_int8_t ttl
)
173 struct recent_entry
*e
;
175 if (t
->entries
>= ip_list_tot
) {
176 e
= list_entry(t
->lru_list
.next
, struct recent_entry
, lru_list
);
177 recent_entry_remove(t
, e
);
179 e
= kmalloc(sizeof(*e
) + sizeof(e
->stamps
[0]) * ip_pkt_list_tot
,
183 memcpy(&e
->addr
, addr
, sizeof(e
->addr
));
185 e
->stamps
[0] = jiffies
;
189 if (family
== NFPROTO_IPV4
)
190 list_add_tail(&e
->list
, &t
->iphash
[recent_entry_hash4(addr
)]);
192 list_add_tail(&e
->list
, &t
->iphash
[recent_entry_hash6(addr
)]);
193 list_add_tail(&e
->lru_list
, &t
->lru_list
);
198 static void recent_entry_update(struct recent_table
*t
, struct recent_entry
*e
)
200 e
->index
%= ip_pkt_list_tot
;
201 e
->stamps
[e
->index
++] = jiffies
;
202 if (e
->index
> e
->nstamps
)
203 e
->nstamps
= e
->index
;
204 list_move_tail(&e
->lru_list
, &t
->lru_list
);
207 static struct recent_table
*recent_table_lookup(struct recent_net
*recent_net
,
210 struct recent_table
*t
;
212 list_for_each_entry(t
, &recent_net
->tables
, list
)
213 if (!strcmp(t
->name
, name
))
218 static void recent_table_flush(struct recent_table
*t
)
220 struct recent_entry
*e
, *next
;
223 for (i
= 0; i
< ip_list_hash_size
; i
++)
224 list_for_each_entry_safe(e
, next
, &t
->iphash
[i
], list
)
225 recent_entry_remove(t
, e
);
229 recent_mt(const struct sk_buff
*skb
, struct xt_action_param
*par
)
231 struct net
*net
= dev_net(par
->in
? par
->in
: par
->out
);
232 struct recent_net
*recent_net
= recent_pernet(net
);
233 const struct xt_recent_mtinfo_v1
*info
= par
->matchinfo
;
234 struct recent_table
*t
;
235 struct recent_entry
*e
;
236 union nf_inet_addr addr
= {}, addr_mask
;
238 bool ret
= info
->invert
;
240 if (par
->family
== NFPROTO_IPV4
) {
241 const struct iphdr
*iph
= ip_hdr(skb
);
243 if (info
->side
== XT_RECENT_DEST
)
244 addr
.ip
= iph
->daddr
;
246 addr
.ip
= iph
->saddr
;
250 const struct ipv6hdr
*iph
= ipv6_hdr(skb
);
252 if (info
->side
== XT_RECENT_DEST
)
253 memcpy(&addr
.in6
, &iph
->daddr
, sizeof(addr
.in6
));
255 memcpy(&addr
.in6
, &iph
->saddr
, sizeof(addr
.in6
));
257 ttl
= iph
->hop_limit
;
260 /* use TTL as seen before forwarding */
261 if (par
->out
!= NULL
&& skb
->sk
== NULL
)
264 spin_lock_bh(&recent_lock
);
265 t
= recent_table_lookup(recent_net
, info
->name
);
267 nf_inet_addr_mask(&addr
, &addr_mask
, &t
->mask
);
269 e
= recent_entry_lookup(t
, &addr_mask
, par
->family
,
270 (info
->check_set
& XT_RECENT_TTL
) ? ttl
: 0);
272 if (!(info
->check_set
& XT_RECENT_SET
))
274 e
= recent_entry_init(t
, &addr_mask
, par
->family
, ttl
);
281 if (info
->check_set
& XT_RECENT_SET
)
283 else if (info
->check_set
& XT_RECENT_REMOVE
) {
284 recent_entry_remove(t
, e
);
286 } else if (info
->check_set
& (XT_RECENT_CHECK
| XT_RECENT_UPDATE
)) {
287 unsigned long time
= jiffies
- info
->seconds
* HZ
;
288 unsigned int i
, hits
= 0;
290 for (i
= 0; i
< e
->nstamps
; i
++) {
291 if (info
->seconds
&& time_after(time
, e
->stamps
[i
]))
293 if (!info
->hit_count
|| ++hits
>= info
->hit_count
) {
299 /* info->seconds must be non-zero */
300 if (info
->check_set
& XT_RECENT_REAP
)
301 recent_entry_reap(t
, time
);
304 if (info
->check_set
& XT_RECENT_SET
||
305 (info
->check_set
& XT_RECENT_UPDATE
&& ret
)) {
306 recent_entry_update(t
, e
);
310 spin_unlock_bh(&recent_lock
);
314 static void recent_table_free(void *addr
)
319 static int recent_mt_check(const struct xt_mtchk_param
*par
,
320 const struct xt_recent_mtinfo_v1
*info
)
322 struct recent_net
*recent_net
= recent_pernet(par
->net
);
323 struct recent_table
*t
;
324 #ifdef CONFIG_PROC_FS
325 struct proc_dir_entry
*pde
;
333 if (unlikely(!hash_rnd_inited
)) {
334 get_random_bytes(&hash_rnd
, sizeof(hash_rnd
));
335 hash_rnd_inited
= true;
337 if (info
->check_set
& ~XT_RECENT_VALID_FLAGS
) {
338 pr_info("Unsupported user space flags (%08x)\n",
342 if (hweight8(info
->check_set
&
343 (XT_RECENT_SET
| XT_RECENT_REMOVE
|
344 XT_RECENT_CHECK
| XT_RECENT_UPDATE
)) != 1)
346 if ((info
->check_set
& (XT_RECENT_SET
| XT_RECENT_REMOVE
)) &&
347 (info
->seconds
|| info
->hit_count
||
348 (info
->check_set
& XT_RECENT_MODIFIERS
)))
350 if ((info
->check_set
& XT_RECENT_REAP
) && !info
->seconds
)
352 if (info
->hit_count
> ip_pkt_list_tot
) {
353 pr_info("hitcount (%u) is larger than "
354 "packets to be remembered (%u)\n",
355 info
->hit_count
, ip_pkt_list_tot
);
358 if (info
->name
[0] == '\0' ||
359 strnlen(info
->name
, XT_RECENT_NAME_LEN
) == XT_RECENT_NAME_LEN
)
362 mutex_lock(&recent_mutex
);
363 t
= recent_table_lookup(recent_net
, info
->name
);
370 sz
= sizeof(*t
) + sizeof(t
->iphash
[0]) * ip_list_hash_size
;
372 t
= kzalloc(sz
, GFP_KERNEL
);
381 memcpy(&t
->mask
, &info
->mask
, sizeof(t
->mask
));
382 strcpy(t
->name
, info
->name
);
383 INIT_LIST_HEAD(&t
->lru_list
);
384 for (i
= 0; i
< ip_list_hash_size
; i
++)
385 INIT_LIST_HEAD(&t
->iphash
[i
]);
386 #ifdef CONFIG_PROC_FS
387 uid
= make_kuid(&init_user_ns
, ip_list_uid
);
388 gid
= make_kgid(&init_user_ns
, ip_list_gid
);
389 if (!uid_valid(uid
) || !gid_valid(gid
)) {
390 recent_table_free(t
);
394 pde
= proc_create_data(t
->name
, ip_list_perms
, recent_net
->xt_recent
,
397 recent_table_free(t
);
401 proc_set_user(pde
, uid
, gid
);
403 spin_lock_bh(&recent_lock
);
404 list_add_tail(&t
->list
, &recent_net
->tables
);
405 spin_unlock_bh(&recent_lock
);
408 mutex_unlock(&recent_mutex
);
412 static int recent_mt_check_v0(const struct xt_mtchk_param
*par
)
414 const struct xt_recent_mtinfo_v0
*info_v0
= par
->matchinfo
;
415 struct xt_recent_mtinfo_v1 info_v1
;
417 /* Copy revision 0 structure to revision 1 */
418 memcpy(&info_v1
, info_v0
, sizeof(struct xt_recent_mtinfo
));
419 /* Set default mask to ensure backward compatible behaviour */
420 memset(info_v1
.mask
.all
, 0xFF, sizeof(info_v1
.mask
.all
));
422 return recent_mt_check(par
, &info_v1
);
425 static int recent_mt_check_v1(const struct xt_mtchk_param
*par
)
427 return recent_mt_check(par
, par
->matchinfo
);
430 static void recent_mt_destroy(const struct xt_mtdtor_param
*par
)
432 struct recent_net
*recent_net
= recent_pernet(par
->net
);
433 const struct xt_recent_mtinfo_v1
*info
= par
->matchinfo
;
434 struct recent_table
*t
;
436 mutex_lock(&recent_mutex
);
437 t
= recent_table_lookup(recent_net
, info
->name
);
438 if (--t
->refcnt
== 0) {
439 spin_lock_bh(&recent_lock
);
441 spin_unlock_bh(&recent_lock
);
442 #ifdef CONFIG_PROC_FS
443 if (recent_net
->xt_recent
!= NULL
)
444 remove_proc_entry(t
->name
, recent_net
->xt_recent
);
446 recent_table_flush(t
);
447 recent_table_free(t
);
449 mutex_unlock(&recent_mutex
);
452 #ifdef CONFIG_PROC_FS
453 struct recent_iter_state
{
454 const struct recent_table
*table
;
458 static void *recent_seq_start(struct seq_file
*seq
, loff_t
*pos
)
459 __acquires(recent_lock
)
461 struct recent_iter_state
*st
= seq
->private;
462 const struct recent_table
*t
= st
->table
;
463 struct recent_entry
*e
;
466 spin_lock_bh(&recent_lock
);
468 for (st
->bucket
= 0; st
->bucket
< ip_list_hash_size
; st
->bucket
++)
469 list_for_each_entry(e
, &t
->iphash
[st
->bucket
], list
)
475 static void *recent_seq_next(struct seq_file
*seq
, void *v
, loff_t
*pos
)
477 struct recent_iter_state
*st
= seq
->private;
478 const struct recent_table
*t
= st
->table
;
479 const struct recent_entry
*e
= v
;
480 const struct list_head
*head
= e
->list
.next
;
482 while (head
== &t
->iphash
[st
->bucket
]) {
483 if (++st
->bucket
>= ip_list_hash_size
)
485 head
= t
->iphash
[st
->bucket
].next
;
488 return list_entry(head
, struct recent_entry
, list
);
491 static void recent_seq_stop(struct seq_file
*s
, void *v
)
492 __releases(recent_lock
)
494 spin_unlock_bh(&recent_lock
);
497 static int recent_seq_show(struct seq_file
*seq
, void *v
)
499 const struct recent_entry
*e
= v
;
502 i
= (e
->index
- 1) % ip_pkt_list_tot
;
503 if (e
->family
== NFPROTO_IPV4
)
504 seq_printf(seq
, "src=%pI4 ttl: %u last_seen: %lu oldest_pkt: %u",
505 &e
->addr
.ip
, e
->ttl
, e
->stamps
[i
], e
->index
);
507 seq_printf(seq
, "src=%pI6 ttl: %u last_seen: %lu oldest_pkt: %u",
508 &e
->addr
.in6
, e
->ttl
, e
->stamps
[i
], e
->index
);
509 for (i
= 0; i
< e
->nstamps
; i
++)
510 seq_printf(seq
, "%s %lu", i
? "," : "", e
->stamps
[i
]);
511 seq_printf(seq
, "\n");
515 static const struct seq_operations recent_seq_ops
= {
516 .start
= recent_seq_start
,
517 .next
= recent_seq_next
,
518 .stop
= recent_seq_stop
,
519 .show
= recent_seq_show
,
522 static int recent_seq_open(struct inode
*inode
, struct file
*file
)
524 struct recent_iter_state
*st
;
526 st
= __seq_open_private(file
, &recent_seq_ops
, sizeof(*st
));
530 st
->table
= PDE_DATA(inode
);
535 recent_mt_proc_write(struct file
*file
, const char __user
*input
,
536 size_t size
, loff_t
*loff
)
538 struct recent_table
*t
= PDE_DATA(file_inode(file
));
539 struct recent_entry
*e
;
540 char buf
[sizeof("+b335:1d35:1e55:dead:c0de:1715:5afe:c0de")];
542 union nf_inet_addr addr
= {};
548 if (size
> sizeof(buf
))
550 if (copy_from_user(buf
, input
, size
) != 0)
553 /* Strict protocol! */
557 case '/': /* flush table */
558 spin_lock_bh(&recent_lock
);
559 recent_table_flush(t
);
560 spin_unlock_bh(&recent_lock
);
562 case '-': /* remove address */
565 case '+': /* add address */
569 pr_info("Need \"+ip\", \"-ip\" or \"/\"\n");
575 if (strnchr(c
, size
, ':') != NULL
) {
576 family
= NFPROTO_IPV6
;
577 succ
= in6_pton(c
, size
, (void *)&addr
, '\n', NULL
);
579 family
= NFPROTO_IPV4
;
580 succ
= in4_pton(c
, size
, (void *)&addr
, '\n', NULL
);
584 pr_info("illegal address written to procfs\n");
588 spin_lock_bh(&recent_lock
);
589 e
= recent_entry_lookup(t
, &addr
, family
, 0);
592 recent_entry_init(t
, &addr
, family
, 0);
595 recent_entry_update(t
, e
);
597 recent_entry_remove(t
, e
);
599 spin_unlock_bh(&recent_lock
);
600 /* Note we removed one above */
605 static const struct file_operations recent_mt_fops
= {
606 .open
= recent_seq_open
,
608 .write
= recent_mt_proc_write
,
609 .release
= seq_release_private
,
610 .owner
= THIS_MODULE
,
614 static int __net_init
recent_proc_net_init(struct net
*net
)
616 struct recent_net
*recent_net
= recent_pernet(net
);
618 recent_net
->xt_recent
= proc_mkdir("xt_recent", net
->proc_net
);
619 if (!recent_net
->xt_recent
)
624 static void __net_exit
recent_proc_net_exit(struct net
*net
)
626 struct recent_net
*recent_net
= recent_pernet(net
);
627 struct recent_table
*t
;
629 /* recent_net_exit() is called before recent_mt_destroy(). Make sure
630 * that the parent xt_recent proc entry is is empty before trying to
633 spin_lock_bh(&recent_lock
);
634 list_for_each_entry(t
, &recent_net
->tables
, list
)
635 remove_proc_entry(t
->name
, recent_net
->xt_recent
);
637 recent_net
->xt_recent
= NULL
;
638 spin_unlock_bh(&recent_lock
);
640 remove_proc_entry("xt_recent", net
->proc_net
);
643 static inline int recent_proc_net_init(struct net
*net
)
648 static inline void recent_proc_net_exit(struct net
*net
)
651 #endif /* CONFIG_PROC_FS */
653 static int __net_init
recent_net_init(struct net
*net
)
655 struct recent_net
*recent_net
= recent_pernet(net
);
657 INIT_LIST_HEAD(&recent_net
->tables
);
658 return recent_proc_net_init(net
);
661 static void __net_exit
recent_net_exit(struct net
*net
)
663 recent_proc_net_exit(net
);
666 static struct pernet_operations recent_net_ops
= {
667 .init
= recent_net_init
,
668 .exit
= recent_net_exit
,
669 .id
= &recent_net_id
,
670 .size
= sizeof(struct recent_net
),
673 static struct xt_match recent_mt_reg
[] __read_mostly
= {
677 .family
= NFPROTO_IPV4
,
679 .matchsize
= sizeof(struct xt_recent_mtinfo
),
680 .checkentry
= recent_mt_check_v0
,
681 .destroy
= recent_mt_destroy
,
687 .family
= NFPROTO_IPV6
,
689 .matchsize
= sizeof(struct xt_recent_mtinfo
),
690 .checkentry
= recent_mt_check_v0
,
691 .destroy
= recent_mt_destroy
,
697 .family
= NFPROTO_IPV4
,
699 .matchsize
= sizeof(struct xt_recent_mtinfo_v1
),
700 .checkentry
= recent_mt_check_v1
,
701 .destroy
= recent_mt_destroy
,
707 .family
= NFPROTO_IPV6
,
709 .matchsize
= sizeof(struct xt_recent_mtinfo_v1
),
710 .checkentry
= recent_mt_check_v1
,
711 .destroy
= recent_mt_destroy
,
716 static int __init
recent_mt_init(void)
720 if (!ip_list_tot
|| !ip_pkt_list_tot
|| ip_pkt_list_tot
> 255)
722 ip_list_hash_size
= 1 << fls(ip_list_tot
);
724 err
= register_pernet_subsys(&recent_net_ops
);
727 err
= xt_register_matches(recent_mt_reg
, ARRAY_SIZE(recent_mt_reg
));
729 unregister_pernet_subsys(&recent_net_ops
);
733 static void __exit
recent_mt_exit(void)
735 xt_unregister_matches(recent_mt_reg
, ARRAY_SIZE(recent_mt_reg
));
736 unregister_pernet_subsys(&recent_net_ops
);
739 module_init(recent_mt_init
);
740 module_exit(recent_mt_exit
);