2 * This is a module which is used for queueing IPv4 packets and
3 * communicating with userspace via netlink.
5 * (C) 2000-2002 James Morris <jmorris@intercode.com.au>
6 * (C) 2003-2005 Netfilter Core Team <coreteam@netfilter.org>
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.
12 #include <linux/module.h>
13 #include <linux/skbuff.h>
14 #include <linux/init.h>
16 #include <linux/notifier.h>
17 #include <linux/netdevice.h>
18 #include <linux/netfilter.h>
19 #include <linux/netfilter_ipv4/ip_queue.h>
20 #include <linux/netfilter_ipv4/ip_tables.h>
21 #include <linux/netlink.h>
22 #include <linux/spinlock.h>
23 #include <linux/sysctl.h>
24 #include <linux/proc_fs.h>
25 #include <linux/seq_file.h>
26 #include <linux/security.h>
27 #include <linux/mutex.h>
28 #include <net/net_namespace.h>
30 #include <net/route.h>
31 #include <net/netfilter/nf_queue.h>
34 #define IPQ_QMAX_DEFAULT 1024
35 #define IPQ_PROC_FS_NAME "ip_queue"
36 #define NET_IPQ_QMAX 2088
37 #define NET_IPQ_QMAX_NAME "ip_queue_maxlen"
39 typedef int (*ipq_cmpfn)(struct nf_queue_entry *, unsigned long);
41 static unsigned char copy_mode __read_mostly = IPQ_COPY_NONE;
42 static unsigned int queue_maxlen __read_mostly = IPQ_QMAX_DEFAULT;
43 static DEFINE_RWLOCK(queue_lock);
44 static int peer_pid __read_mostly;
45 static unsigned int copy_range __read_mostly;
46 static unsigned int queue_total;
47 static unsigned int queue_dropped = 0;
48 static unsigned int queue_user_dropped = 0;
49 static struct sock *ipqnl __read_mostly;
50 static LIST_HEAD(queue_list);
51 static DEFINE_MUTEX(ipqnl_mutex);
54 __ipq_enqueue_entry(struct nf_queue_entry *entry)
56 list_add_tail(&entry->list, &queue_list);
61 __ipq_set_mode(unsigned char mode, unsigned int range)
75 if (copy_range > 0xFFFF)
86 static void __ipq_flush(ipq_cmpfn cmpfn, unsigned long data);
92 net_disable_timestamp();
93 __ipq_set_mode(IPQ_COPY_NONE, 0);
97 static struct nf_queue_entry *
98 ipq_find_dequeue_entry(unsigned long id)
100 struct nf_queue_entry *entry = NULL, *i;
102 write_lock_bh(&queue_lock);
104 list_for_each_entry(i, &queue_list, list) {
105 if ((unsigned long)i == id) {
112 list_del(&entry->list);
116 write_unlock_bh(&queue_lock);
121 __ipq_flush(ipq_cmpfn cmpfn, unsigned long data)
123 struct nf_queue_entry *entry, *next;
125 list_for_each_entry_safe(entry, next, &queue_list, list) {
126 if (!cmpfn || cmpfn(entry, data)) {
127 list_del(&entry->list);
129 nf_reinject(entry, NF_DROP);
135 ipq_flush(ipq_cmpfn cmpfn, unsigned long data)
137 write_lock_bh(&queue_lock);
138 __ipq_flush(cmpfn, data);
139 write_unlock_bh(&queue_lock);
142 static struct sk_buff *
143 ipq_build_packet_message(struct nf_queue_entry *entry, int *errp)
145 sk_buff_data_t old_tail;
149 struct ipq_packet_msg *pmsg;
150 struct nlmsghdr *nlh;
153 read_lock_bh(&queue_lock);
158 size = NLMSG_SPACE(sizeof(*pmsg));
161 case IPQ_COPY_PACKET:
162 if ((entry->skb->ip_summed == CHECKSUM_PARTIAL ||
163 entry->skb->ip_summed == CHECKSUM_COMPLETE) &&
164 (*errp = skb_checksum_help(entry->skb))) {
165 read_unlock_bh(&queue_lock);
168 if (copy_range == 0 || copy_range > entry->skb->len)
169 data_len = entry->skb->len;
171 data_len = copy_range;
173 size = NLMSG_SPACE(sizeof(*pmsg) + data_len);
178 read_unlock_bh(&queue_lock);
182 read_unlock_bh(&queue_lock);
184 skb = alloc_skb(size, GFP_ATOMIC);
188 old_tail = skb->tail;
189 nlh = NLMSG_PUT(skb, 0, 0, IPQM_PACKET, size - sizeof(*nlh));
190 pmsg = NLMSG_DATA(nlh);
191 memset(pmsg, 0, sizeof(*pmsg));
193 pmsg->packet_id = (unsigned long )entry;
194 pmsg->data_len = data_len;
195 tv = ktime_to_timeval(entry->skb->tstamp);
196 pmsg->timestamp_sec = tv.tv_sec;
197 pmsg->timestamp_usec = tv.tv_usec;
198 pmsg->mark = entry->skb->mark;
199 pmsg->hook = entry->hook;
200 pmsg->hw_protocol = entry->skb->protocol;
203 strcpy(pmsg->indev_name, entry->indev->name);
205 pmsg->indev_name[0] = '\0';
208 strcpy(pmsg->outdev_name, entry->outdev->name);
210 pmsg->outdev_name[0] = '\0';
212 if (entry->indev && entry->skb->dev) {
213 pmsg->hw_type = entry->skb->dev->type;
214 pmsg->hw_addrlen = dev_parse_header(entry->skb,
219 if (skb_copy_bits(entry->skb, 0, pmsg->payload, data_len))
222 nlh->nlmsg_len = skb->tail - old_tail;
227 printk(KERN_ERR "ip_queue: error creating packet message\n");
232 ipq_enqueue_packet(struct nf_queue_entry *entry, unsigned int queuenum)
234 int status = -EINVAL;
235 struct sk_buff *nskb;
237 if (copy_mode == IPQ_COPY_NONE)
240 nskb = ipq_build_packet_message(entry, &status);
244 write_lock_bh(&queue_lock);
247 goto err_out_free_nskb;
249 if (queue_total >= queue_maxlen) {
253 printk (KERN_WARNING "ip_queue: full at %d entries, "
254 "dropping packets(s). Dropped: %d\n", queue_total,
256 goto err_out_free_nskb;
259 /* netlink_unicast will either free the nskb or attach it to a socket */
260 status = netlink_unicast(ipqnl, nskb, peer_pid, MSG_DONTWAIT);
262 queue_user_dropped++;
266 __ipq_enqueue_entry(entry);
268 write_unlock_bh(&queue_lock);
275 write_unlock_bh(&queue_lock);
280 ipq_mangle_ipv4(ipq_verdict_msg_t *v, struct nf_queue_entry *e)
283 struct iphdr *user_iph = (struct iphdr *)v->payload;
284 struct sk_buff *nskb;
286 if (v->data_len < sizeof(*user_iph))
288 diff = v->data_len - e->skb->len;
290 if (pskb_trim(e->skb, v->data_len))
292 } else if (diff > 0) {
293 if (v->data_len > 0xFFFF)
295 if (diff > skb_tailroom(e->skb)) {
296 nskb = skb_copy_expand(e->skb, skb_headroom(e->skb),
299 printk(KERN_WARNING "ip_queue: error "
300 "in mangle, dropping packet\n");
306 skb_put(e->skb, diff);
308 if (!skb_make_writable(e->skb, v->data_len))
310 skb_copy_to_linear_data(e->skb, v->payload, v->data_len);
311 e->skb->ip_summed = CHECKSUM_NONE;
317 ipq_set_verdict(struct ipq_verdict_msg *vmsg, unsigned int len)
319 struct nf_queue_entry *entry;
321 if (vmsg->value > NF_MAX_VERDICT)
324 entry = ipq_find_dequeue_entry(vmsg->id);
328 int verdict = vmsg->value;
330 if (vmsg->data_len && vmsg->data_len == len)
331 if (ipq_mangle_ipv4(vmsg, entry) < 0)
334 nf_reinject(entry, verdict);
340 ipq_set_mode(unsigned char mode, unsigned int range)
344 write_lock_bh(&queue_lock);
345 status = __ipq_set_mode(mode, range);
346 write_unlock_bh(&queue_lock);
351 ipq_receive_peer(struct ipq_peer_msg *pmsg,
352 unsigned char type, unsigned int len)
356 if (len < sizeof(*pmsg))
361 status = ipq_set_mode(pmsg->msg.mode.value,
362 pmsg->msg.mode.range);
366 if (pmsg->msg.verdict.value > NF_MAX_VERDICT)
369 status = ipq_set_verdict(&pmsg->msg.verdict,
370 len - sizeof(*pmsg));
379 dev_cmp(struct nf_queue_entry *entry, unsigned long ifindex)
382 if (entry->indev->ifindex == ifindex)
385 if (entry->outdev->ifindex == ifindex)
387 #ifdef CONFIG_BRIDGE_NETFILTER
388 if (entry->skb->nf_bridge) {
389 if (entry->skb->nf_bridge->physindev &&
390 entry->skb->nf_bridge->physindev->ifindex == ifindex)
392 if (entry->skb->nf_bridge->physoutdev &&
393 entry->skb->nf_bridge->physoutdev->ifindex == ifindex)
401 ipq_dev_drop(int ifindex)
403 ipq_flush(dev_cmp, ifindex);
406 #define RCV_SKB_FAIL(err) do { netlink_ack(skb, nlh, (err)); return; } while (0)
409 __ipq_rcv_skb(struct sk_buff *skb)
411 int status, type, pid, flags, nlmsglen, skblen;
412 struct nlmsghdr *nlh;
415 if (skblen < sizeof(*nlh))
418 nlh = nlmsg_hdr(skb);
419 nlmsglen = nlh->nlmsg_len;
420 if (nlmsglen < sizeof(*nlh) || skblen < nlmsglen)
423 pid = nlh->nlmsg_pid;
424 flags = nlh->nlmsg_flags;
426 if(pid <= 0 || !(flags & NLM_F_REQUEST) || flags & NLM_F_MULTI)
427 RCV_SKB_FAIL(-EINVAL);
429 if (flags & MSG_TRUNC)
430 RCV_SKB_FAIL(-ECOMM);
432 type = nlh->nlmsg_type;
433 if (type < NLMSG_NOOP || type >= IPQM_MAX)
434 RCV_SKB_FAIL(-EINVAL);
436 if (type <= IPQM_BASE)
439 if (security_netlink_recv(skb, CAP_NET_ADMIN))
440 RCV_SKB_FAIL(-EPERM);
442 write_lock_bh(&queue_lock);
445 if (peer_pid != pid) {
446 write_unlock_bh(&queue_lock);
447 RCV_SKB_FAIL(-EBUSY);
450 net_enable_timestamp();
454 write_unlock_bh(&queue_lock);
456 status = ipq_receive_peer(NLMSG_DATA(nlh), type,
457 nlmsglen - NLMSG_LENGTH(0));
459 RCV_SKB_FAIL(status);
461 if (flags & NLM_F_ACK)
462 netlink_ack(skb, nlh, 0);
467 ipq_rcv_skb(struct sk_buff *skb)
469 mutex_lock(&ipqnl_mutex);
471 mutex_unlock(&ipqnl_mutex);
475 ipq_rcv_dev_event(struct notifier_block *this,
476 unsigned long event, void *ptr)
478 struct net_device *dev = ptr;
480 if (!net_eq(dev_net(dev), &init_net))
483 /* Drop any packets associated with the downed device */
484 if (event == NETDEV_DOWN)
485 ipq_dev_drop(dev->ifindex);
489 static struct notifier_block ipq_dev_notifier = {
490 .notifier_call = ipq_rcv_dev_event,
494 ipq_rcv_nl_event(struct notifier_block *this,
495 unsigned long event, void *ptr)
497 struct netlink_notify *n = ptr;
499 if (event == NETLINK_URELEASE &&
500 n->protocol == NETLINK_FIREWALL && n->pid) {
501 write_lock_bh(&queue_lock);
502 if ((n->net == &init_net) && (n->pid == peer_pid))
504 write_unlock_bh(&queue_lock);
509 static struct notifier_block ipq_nl_notifier = {
510 .notifier_call = ipq_rcv_nl_event,
514 static struct ctl_table_header *ipq_sysctl_header;
516 static ctl_table ipq_table[] = {
518 .ctl_name = NET_IPQ_QMAX,
519 .procname = NET_IPQ_QMAX_NAME,
520 .data = &queue_maxlen,
521 .maxlen = sizeof(queue_maxlen),
523 .proc_handler = proc_dointvec
529 #ifdef CONFIG_PROC_FS
530 static int ip_queue_show(struct seq_file *m, void *v)
532 read_lock_bh(&queue_lock);
538 "Queue length : %u\n"
539 "Queue max. length : %u\n"
540 "Queue dropped : %u\n"
541 "Netlink dropped : %u\n",
550 read_unlock_bh(&queue_lock);
554 static int ip_queue_open(struct inode *inode, struct file *file)
556 return single_open(file, ip_queue_show, NULL);
559 static const struct file_operations ip_queue_proc_fops = {
560 .open = ip_queue_open,
563 .release = single_release,
564 .owner = THIS_MODULE,
568 static const struct nf_queue_handler nfqh = {
570 .outfn = &ipq_enqueue_packet,
573 static int __init ip_queue_init(void)
575 int status = -ENOMEM;
576 struct proc_dir_entry *proc __maybe_unused;
578 netlink_register_notifier(&ipq_nl_notifier);
579 ipqnl = netlink_kernel_create(&init_net, NETLINK_FIREWALL, 0,
580 ipq_rcv_skb, NULL, THIS_MODULE);
582 printk(KERN_ERR "ip_queue: failed to create netlink socket\n");
583 goto cleanup_netlink_notifier;
586 #ifdef CONFIG_PROC_FS
587 proc = proc_create(IPQ_PROC_FS_NAME, 0, init_net.proc_net,
588 &ip_queue_proc_fops);
590 printk(KERN_ERR "ip_queue: failed to create proc entry\n");
594 register_netdevice_notifier(&ipq_dev_notifier);
596 ipq_sysctl_header = register_sysctl_paths(net_ipv4_ctl_path, ipq_table);
598 status = nf_register_queue_handler(PF_INET, &nfqh);
600 printk(KERN_ERR "ip_queue: failed to register queue handler\n");
607 unregister_sysctl_table(ipq_sysctl_header);
609 unregister_netdevice_notifier(&ipq_dev_notifier);
610 proc_net_remove(&init_net, IPQ_PROC_FS_NAME);
611 cleanup_ipqnl: __maybe_unused
612 netlink_kernel_release(ipqnl);
613 mutex_lock(&ipqnl_mutex);
614 mutex_unlock(&ipqnl_mutex);
616 cleanup_netlink_notifier:
617 netlink_unregister_notifier(&ipq_nl_notifier);
621 static void __exit ip_queue_fini(void)
623 nf_unregister_queue_handlers(&nfqh);
628 unregister_sysctl_table(ipq_sysctl_header);
630 unregister_netdevice_notifier(&ipq_dev_notifier);
631 proc_net_remove(&init_net, IPQ_PROC_FS_NAME);
633 netlink_kernel_release(ipqnl);
634 mutex_lock(&ipqnl_mutex);
635 mutex_unlock(&ipqnl_mutex);
637 netlink_unregister_notifier(&ipq_nl_notifier);
640 MODULE_DESCRIPTION("IPv4 packet queue handler");
641 MODULE_AUTHOR("James Morris <jmorris@intercode.com.au>");
642 MODULE_LICENSE("GPL");
644 module_init(ip_queue_init);
645 module_exit(ip_queue_fini);