2 * Copyright (c) 2006 Patrick McHardy <kaber@trash.net>
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.
8 * This is a replacement of the old ipt_recent module, which carried the
9 * following copyright notice:
11 * Author: Stephen Frost <sfrost@snowman.net>
12 * Copyright 2002-2003, Stephen Frost, 2.5.x port by laforge@netfilter.org
14 #include <linux/init.h>
16 #include <linux/moduleparam.h>
17 #include <linux/proc_fs.h>
18 #include <linux/seq_file.h>
19 #include <linux/string.h>
20 #include <linux/ctype.h>
21 #include <linux/list.h>
22 #include <linux/random.h>
23 #include <linux/jhash.h>
24 #include <linux/bitops.h>
25 #include <linux/skbuff.h>
26 #include <linux/inet.h>
28 #include <linux/netfilter/x_tables.h>
29 #include <linux/netfilter_ipv4/ipt_recent.h>
31 MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
32 MODULE_DESCRIPTION("IP tables recently seen matching module");
33 MODULE_LICENSE("GPL");
35 static unsigned int ip_list_tot = 100;
36 static unsigned int ip_pkt_list_tot = 20;
37 static unsigned int ip_list_hash_size = 0;
38 static unsigned int ip_list_perms = 0644;
39 static unsigned int ip_list_uid = 0;
40 static unsigned int ip_list_gid = 0;
41 module_param(ip_list_tot, uint, 0400);
42 module_param(ip_pkt_list_tot, uint, 0400);
43 module_param(ip_list_hash_size, uint, 0400);
44 module_param(ip_list_perms, uint, 0400);
45 module_param(ip_list_uid, uint, 0400);
46 module_param(ip_list_gid, uint, 0400);
47 MODULE_PARM_DESC(ip_list_tot, "number of IPs to remember per list");
48 MODULE_PARM_DESC(ip_pkt_list_tot, "number of packets per IP to remember (max. 255)");
49 MODULE_PARM_DESC(ip_list_hash_size, "size of hash table used to look up IPs");
50 MODULE_PARM_DESC(ip_list_perms, "permissions on /proc/net/ipt_recent/* files");
51 MODULE_PARM_DESC(ip_list_uid,"owner of /proc/net/ipt_recent/* files");
52 MODULE_PARM_DESC(ip_list_gid,"owning group of /proc/net/ipt_recent/* files");
55 struct list_head list;
56 struct list_head lru_list;
61 unsigned long stamps[0];
65 struct list_head list;
66 char name[IPT_RECENT_NAME_LEN];
68 struct proc_dir_entry *proc;
72 struct list_head lru_list;
73 struct list_head iphash[0];
76 static LIST_HEAD(tables);
77 static DEFINE_SPINLOCK(recent_lock);
78 static DEFINE_MUTEX(recent_mutex);
81 static struct proc_dir_entry *proc_dir;
82 static const struct file_operations recent_fops;
85 static u_int32_t hash_rnd;
86 static int hash_rnd_initted;
88 static unsigned int recent_entry_hash(__be32 addr)
90 if (!hash_rnd_initted) {
91 get_random_bytes(&hash_rnd, 4);
94 return jhash_1word((__force u32)addr, hash_rnd) & (ip_list_hash_size - 1);
97 static struct recent_entry *
98 recent_entry_lookup(const struct recent_table *table, __be32 addr, u_int8_t ttl)
100 struct recent_entry *e;
103 h = recent_entry_hash(addr);
104 list_for_each_entry(e, &table->iphash[h], list)
105 if (e->addr == addr && (ttl == e->ttl || !ttl || !e->ttl))
110 static void recent_entry_remove(struct recent_table *t, struct recent_entry *e)
113 list_del(&e->lru_list);
118 static struct recent_entry *
119 recent_entry_init(struct recent_table *t, __be32 addr, u_int8_t ttl)
121 struct recent_entry *e;
123 if (t->entries >= ip_list_tot) {
124 e = list_entry(t->lru_list.next, struct recent_entry, lru_list);
125 recent_entry_remove(t, e);
127 e = kmalloc(sizeof(*e) + sizeof(e->stamps[0]) * ip_pkt_list_tot,
133 e->stamps[0] = jiffies;
136 list_add_tail(&e->list, &t->iphash[recent_entry_hash(addr)]);
137 list_add_tail(&e->lru_list, &t->lru_list);
142 static void recent_entry_update(struct recent_table *t, struct recent_entry *e)
144 e->stamps[e->index++] = jiffies;
145 if (e->index > e->nstamps)
146 e->nstamps = e->index;
147 e->index %= ip_pkt_list_tot;
148 list_move_tail(&e->lru_list, &t->lru_list);
151 static struct recent_table *recent_table_lookup(const char *name)
153 struct recent_table *t;
155 list_for_each_entry(t, &tables, list)
156 if (!strcmp(t->name, name))
161 static void recent_table_flush(struct recent_table *t)
163 struct recent_entry *e, *next;
166 for (i = 0; i < ip_list_hash_size; i++)
167 list_for_each_entry_safe(e, next, &t->iphash[i], list)
168 recent_entry_remove(t, e);
172 ipt_recent_match(const struct sk_buff *skb,
173 const struct net_device *in, const struct net_device *out,
174 const struct xt_match *match, const void *matchinfo,
175 int offset, unsigned int protoff, bool *hotdrop)
177 const struct ipt_recent_info *info = matchinfo;
178 struct recent_table *t;
179 struct recent_entry *e;
182 bool ret = info->invert;
184 if (info->side == IPT_RECENT_DEST)
185 addr = ip_hdr(skb)->daddr;
187 addr = ip_hdr(skb)->saddr;
189 ttl = ip_hdr(skb)->ttl;
190 /* use TTL as seen before forwarding */
194 spin_lock_bh(&recent_lock);
195 t = recent_table_lookup(info->name);
196 e = recent_entry_lookup(t, addr,
197 info->check_set & IPT_RECENT_TTL ? ttl : 0);
199 if (!(info->check_set & IPT_RECENT_SET))
201 e = recent_entry_init(t, addr, ttl);
208 if (info->check_set & IPT_RECENT_SET)
210 else if (info->check_set & IPT_RECENT_REMOVE) {
211 recent_entry_remove(t, e);
213 } else if (info->check_set & (IPT_RECENT_CHECK | IPT_RECENT_UPDATE)) {
214 unsigned long t = jiffies - info->seconds * HZ;
215 unsigned int i, hits = 0;
217 for (i = 0; i < e->nstamps; i++) {
218 if (info->seconds && time_after(t, e->stamps[i]))
220 if (++hits >= info->hit_count) {
227 if (info->check_set & IPT_RECENT_SET ||
228 (info->check_set & IPT_RECENT_UPDATE && ret)) {
229 recent_entry_update(t, e);
233 spin_unlock_bh(&recent_lock);
238 ipt_recent_checkentry(const char *tablename, const void *ip,
239 const struct xt_match *match, void *matchinfo,
240 unsigned int hook_mask)
242 const struct ipt_recent_info *info = matchinfo;
243 struct recent_table *t;
247 if (hweight8(info->check_set &
248 (IPT_RECENT_SET | IPT_RECENT_REMOVE |
249 IPT_RECENT_CHECK | IPT_RECENT_UPDATE)) != 1)
251 if ((info->check_set & (IPT_RECENT_SET | IPT_RECENT_REMOVE)) &&
252 (info->seconds || info->hit_count))
254 if (info->name[0] == '\0' ||
255 strnlen(info->name, IPT_RECENT_NAME_LEN) == IPT_RECENT_NAME_LEN)
258 mutex_lock(&recent_mutex);
259 t = recent_table_lookup(info->name);
266 t = kzalloc(sizeof(*t) + sizeof(t->iphash[0]) * ip_list_hash_size,
271 strcpy(t->name, info->name);
272 INIT_LIST_HEAD(&t->lru_list);
273 for (i = 0; i < ip_list_hash_size; i++)
274 INIT_LIST_HEAD(&t->iphash[i]);
275 #ifdef CONFIG_PROC_FS
276 t->proc = create_proc_entry(t->name, ip_list_perms, proc_dir);
277 if (t->proc == NULL) {
281 t->proc->proc_fops = &recent_fops;
282 t->proc->uid = ip_list_uid;
283 t->proc->gid = ip_list_gid;
286 spin_lock_bh(&recent_lock);
287 list_add_tail(&t->list, &tables);
288 spin_unlock_bh(&recent_lock);
291 mutex_unlock(&recent_mutex);
296 ipt_recent_destroy(const struct xt_match *match, void *matchinfo)
298 const struct ipt_recent_info *info = matchinfo;
299 struct recent_table *t;
301 mutex_lock(&recent_mutex);
302 t = recent_table_lookup(info->name);
303 if (--t->refcnt == 0) {
304 spin_lock_bh(&recent_lock);
306 spin_unlock_bh(&recent_lock);
307 recent_table_flush(t);
308 #ifdef CONFIG_PROC_FS
309 remove_proc_entry(t->name, proc_dir);
313 mutex_unlock(&recent_mutex);
316 #ifdef CONFIG_PROC_FS
317 struct recent_iter_state {
318 struct recent_table *table;
322 static void *recent_seq_start(struct seq_file *seq, loff_t *pos)
324 struct recent_iter_state *st = seq->private;
325 const struct recent_table *t = st->table;
326 struct recent_entry *e;
329 spin_lock_bh(&recent_lock);
331 for (st->bucket = 0; st->bucket < ip_list_hash_size; st->bucket++)
332 list_for_each_entry(e, &t->iphash[st->bucket], list)
338 static void *recent_seq_next(struct seq_file *seq, void *v, loff_t *pos)
340 struct recent_iter_state *st = seq->private;
341 struct recent_table *t = st->table;
342 struct recent_entry *e = v;
343 struct list_head *head = e->list.next;
345 while (head == &t->iphash[st->bucket]) {
346 if (++st->bucket >= ip_list_hash_size)
348 head = t->iphash[st->bucket].next;
351 return list_entry(head, struct recent_entry, list);
354 static void recent_seq_stop(struct seq_file *s, void *v)
356 spin_unlock_bh(&recent_lock);
359 static int recent_seq_show(struct seq_file *seq, void *v)
361 struct recent_entry *e = v;
364 i = (e->index - 1) % ip_pkt_list_tot;
365 seq_printf(seq, "src=%u.%u.%u.%u ttl: %u last_seen: %lu oldest_pkt: %u",
366 NIPQUAD(e->addr), e->ttl, e->stamps[i], e->index);
367 for (i = 0; i < e->nstamps; i++)
368 seq_printf(seq, "%s %lu", i ? "," : "", e->stamps[i]);
369 seq_printf(seq, "\n");
373 static const struct seq_operations recent_seq_ops = {
374 .start = recent_seq_start,
375 .next = recent_seq_next,
376 .stop = recent_seq_stop,
377 .show = recent_seq_show,
380 static int recent_seq_open(struct inode *inode, struct file *file)
382 struct proc_dir_entry *pde = PDE(inode);
383 struct seq_file *seq;
384 struct recent_iter_state *st;
387 st = kzalloc(sizeof(*st), GFP_KERNEL);
391 ret = seq_open(file, &recent_seq_ops);
397 st->table = pde->data;
398 seq = file->private_data;
404 static ssize_t recent_proc_write(struct file *file, const char __user *input,
405 size_t size, loff_t *loff)
407 struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
408 struct recent_table *t = pde->data;
409 struct recent_entry *e;
410 char buf[sizeof("+255.255.255.255")], *c = buf;
414 if (size > sizeof(buf))
416 if (copy_from_user(buf, input, size))
421 if (size - (c - buf) < 5)
423 if (!strncmp(c, "clear", 5)) {
425 spin_lock_bh(&recent_lock);
426 recent_table_flush(t);
427 spin_unlock_bh(&recent_lock);
444 spin_lock_bh(&recent_lock);
445 e = recent_entry_lookup(t, addr, 0);
448 recent_entry_init(t, addr, 0);
451 recent_entry_update(t, e);
453 recent_entry_remove(t, e);
455 spin_unlock_bh(&recent_lock);
459 static const struct file_operations recent_fops = {
460 .open = recent_seq_open,
462 .write = recent_proc_write,
463 .release = seq_release_private,
464 .owner = THIS_MODULE,
466 #endif /* CONFIG_PROC_FS */
468 static struct xt_match recent_match __read_mostly = {
471 .match = ipt_recent_match,
472 .matchsize = sizeof(struct ipt_recent_info),
473 .checkentry = ipt_recent_checkentry,
474 .destroy = ipt_recent_destroy,
478 static int __init ipt_recent_init(void)
482 if (!ip_list_tot || !ip_pkt_list_tot || ip_pkt_list_tot > 255)
484 ip_list_hash_size = 1 << fls(ip_list_tot);
486 err = xt_register_match(&recent_match);
487 #ifdef CONFIG_PROC_FS
490 proc_dir = proc_mkdir("ipt_recent", proc_net);
491 if (proc_dir == NULL) {
492 xt_unregister_match(&recent_match);
499 static void __exit ipt_recent_exit(void)
501 BUG_ON(!list_empty(&tables));
502 xt_unregister_match(&recent_match);
503 #ifdef CONFIG_PROC_FS
504 remove_proc_entry("ipt_recent", proc_net);
508 module_init(ipt_recent_init);
509 module_exit(ipt_recent_exit);