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/net.h>
28 #include <linux/mutex.h>
29 #include <linux/slab.h>
30 #include <net/net_namespace.h>
32 #include <net/route.h>
33 #include <net/netfilter/nf_queue.h>
36 #define IPQ_QMAX_DEFAULT 1024
37 #define IPQ_PROC_FS_NAME "ip_queue"
38 #define NET_IPQ_QMAX 2088
39 #define NET_IPQ_QMAX_NAME "ip_queue_maxlen"
41 typedef int (*ipq_cmpfn)(struct nf_queue_entry *, unsigned long);
43 static unsigned char copy_mode __read_mostly = IPQ_COPY_NONE;
44 static unsigned int queue_maxlen __read_mostly = IPQ_QMAX_DEFAULT;
45 static DEFINE_SPINLOCK(queue_lock);
46 static int peer_pid __read_mostly;
47 static unsigned int copy_range __read_mostly;
48 static unsigned int queue_total;
49 static unsigned int queue_dropped = 0;
50 static unsigned int queue_user_dropped = 0;
51 static struct sock *ipqnl __read_mostly;
52 static LIST_HEAD(queue_list);
53 static DEFINE_MUTEX(ipqnl_mutex);
56 __ipq_enqueue_entry(struct nf_queue_entry *entry)
58 list_add_tail(&entry->list, &queue_list);
63 __ipq_set_mode(unsigned char mode, unsigned int range)
88 static void __ipq_flush(ipq_cmpfn cmpfn, unsigned long data);
94 net_disable_timestamp();
95 __ipq_set_mode(IPQ_COPY_NONE, 0);
99 static struct nf_queue_entry *
100 ipq_find_dequeue_entry(unsigned long id)
102 struct nf_queue_entry *entry = NULL, *i;
104 spin_lock_bh(&queue_lock);
106 list_for_each_entry(i, &queue_list, list) {
107 if ((unsigned long)i == id) {
114 list_del(&entry->list);
118 spin_unlock_bh(&queue_lock);
123 __ipq_flush(ipq_cmpfn cmpfn, unsigned long data)
125 struct nf_queue_entry *entry, *next;
127 list_for_each_entry_safe(entry, next, &queue_list, list) {
128 if (!cmpfn || cmpfn(entry, data)) {
129 list_del(&entry->list);
131 nf_reinject(entry, NF_DROP);
137 ipq_flush(ipq_cmpfn cmpfn, unsigned long data)
139 spin_lock_bh(&queue_lock);
140 __ipq_flush(cmpfn, data);
141 spin_unlock_bh(&queue_lock);
144 static struct sk_buff *
145 ipq_build_packet_message(struct nf_queue_entry *entry, int *errp)
147 sk_buff_data_t old_tail;
151 struct ipq_packet_msg *pmsg;
152 struct nlmsghdr *nlh;
155 switch (ACCESS_ONCE(copy_mode)) {
158 size = NLMSG_SPACE(sizeof(*pmsg));
161 case IPQ_COPY_PACKET:
162 if (entry->skb->ip_summed == CHECKSUM_PARTIAL &&
163 (*errp = skb_checksum_help(entry->skb)))
166 data_len = ACCESS_ONCE(copy_range);
167 if (data_len == 0 || data_len > entry->skb->len)
168 data_len = entry->skb->len;
170 size = NLMSG_SPACE(sizeof(*pmsg) + data_len);
178 skb = alloc_skb(size, GFP_ATOMIC);
182 old_tail = skb->tail;
183 nlh = NLMSG_PUT(skb, 0, 0, IPQM_PACKET, size - sizeof(*nlh));
184 pmsg = NLMSG_DATA(nlh);
185 memset(pmsg, 0, sizeof(*pmsg));
187 pmsg->packet_id = (unsigned long )entry;
188 pmsg->data_len = data_len;
189 tv = ktime_to_timeval(entry->skb->tstamp);
190 pmsg->timestamp_sec = tv.tv_sec;
191 pmsg->timestamp_usec = tv.tv_usec;
192 pmsg->mark = entry->skb->mark;
193 pmsg->hook = entry->hook;
194 pmsg->hw_protocol = entry->skb->protocol;
197 strcpy(pmsg->indev_name, entry->indev->name);
199 pmsg->indev_name[0] = '\0';
202 strcpy(pmsg->outdev_name, entry->outdev->name);
204 pmsg->outdev_name[0] = '\0';
206 if (entry->indev && entry->skb->dev) {
207 pmsg->hw_type = entry->skb->dev->type;
208 pmsg->hw_addrlen = dev_parse_header(entry->skb,
213 if (skb_copy_bits(entry->skb, 0, pmsg->payload, data_len))
216 nlh->nlmsg_len = skb->tail - old_tail;
221 printk(KERN_ERR "ip_queue: error creating packet message\n");
226 ipq_enqueue_packet(struct nf_queue_entry *entry, unsigned int queuenum)
228 int status = -EINVAL;
229 struct sk_buff *nskb;
231 if (copy_mode == IPQ_COPY_NONE)
234 nskb = ipq_build_packet_message(entry, &status);
238 spin_lock_bh(&queue_lock);
241 goto err_out_free_nskb;
243 if (queue_total >= queue_maxlen) {
247 printk (KERN_WARNING "ip_queue: full at %d entries, "
248 "dropping packets(s). Dropped: %d\n", queue_total,
250 goto err_out_free_nskb;
253 /* netlink_unicast will either free the nskb or attach it to a socket */
254 status = netlink_unicast(ipqnl, nskb, peer_pid, MSG_DONTWAIT);
256 queue_user_dropped++;
260 __ipq_enqueue_entry(entry);
262 spin_unlock_bh(&queue_lock);
269 spin_unlock_bh(&queue_lock);
274 ipq_mangle_ipv4(ipq_verdict_msg_t *v, struct nf_queue_entry *e)
277 struct iphdr *user_iph = (struct iphdr *)v->payload;
278 struct sk_buff *nskb;
280 if (v->data_len < sizeof(*user_iph))
282 diff = v->data_len - e->skb->len;
284 if (pskb_trim(e->skb, v->data_len))
286 } else if (diff > 0) {
287 if (v->data_len > 0xFFFF)
289 if (diff > skb_tailroom(e->skb)) {
290 nskb = skb_copy_expand(e->skb, skb_headroom(e->skb),
293 printk(KERN_WARNING "ip_queue: error "
294 "in mangle, dropping packet\n");
300 skb_put(e->skb, diff);
302 if (!skb_make_writable(e->skb, v->data_len))
304 skb_copy_to_linear_data(e->skb, v->payload, v->data_len);
305 e->skb->ip_summed = CHECKSUM_NONE;
311 ipq_set_verdict(struct ipq_verdict_msg *vmsg, unsigned int len)
313 struct nf_queue_entry *entry;
315 if (vmsg->value > NF_MAX_VERDICT)
318 entry = ipq_find_dequeue_entry(vmsg->id);
322 int verdict = vmsg->value;
324 if (vmsg->data_len && vmsg->data_len == len)
325 if (ipq_mangle_ipv4(vmsg, entry) < 0)
328 nf_reinject(entry, verdict);
334 ipq_set_mode(unsigned char mode, unsigned int range)
338 spin_lock_bh(&queue_lock);
339 status = __ipq_set_mode(mode, range);
340 spin_unlock_bh(&queue_lock);
345 ipq_receive_peer(struct ipq_peer_msg *pmsg,
346 unsigned char type, unsigned int len)
350 if (len < sizeof(*pmsg))
355 status = ipq_set_mode(pmsg->msg.mode.value,
356 pmsg->msg.mode.range);
360 if (pmsg->msg.verdict.value > NF_MAX_VERDICT)
363 status = ipq_set_verdict(&pmsg->msg.verdict,
364 len - sizeof(*pmsg));
373 dev_cmp(struct nf_queue_entry *entry, unsigned long ifindex)
376 if (entry->indev->ifindex == ifindex)
379 if (entry->outdev->ifindex == ifindex)
381 #ifdef CONFIG_BRIDGE_NETFILTER
382 if (entry->skb->nf_bridge) {
383 if (entry->skb->nf_bridge->physindev &&
384 entry->skb->nf_bridge->physindev->ifindex == ifindex)
386 if (entry->skb->nf_bridge->physoutdev &&
387 entry->skb->nf_bridge->physoutdev->ifindex == ifindex)
395 ipq_dev_drop(int ifindex)
397 ipq_flush(dev_cmp, ifindex);
400 #define RCV_SKB_FAIL(err) do { netlink_ack(skb, nlh, (err)); return; } while (0)
403 __ipq_rcv_skb(struct sk_buff *skb)
405 int status, type, pid, flags;
406 unsigned int nlmsglen, skblen;
407 struct nlmsghdr *nlh;
410 if (skblen < sizeof(*nlh))
413 nlh = nlmsg_hdr(skb);
414 nlmsglen = nlh->nlmsg_len;
415 if (nlmsglen < sizeof(*nlh) || skblen < nlmsglen)
418 pid = nlh->nlmsg_pid;
419 flags = nlh->nlmsg_flags;
421 if(pid <= 0 || !(flags & NLM_F_REQUEST) || flags & NLM_F_MULTI)
422 RCV_SKB_FAIL(-EINVAL);
424 if (flags & MSG_TRUNC)
425 RCV_SKB_FAIL(-ECOMM);
427 type = nlh->nlmsg_type;
428 if (type < NLMSG_NOOP || type >= IPQM_MAX)
429 RCV_SKB_FAIL(-EINVAL);
431 if (type <= IPQM_BASE)
434 if (security_netlink_recv(skb, CAP_NET_ADMIN))
435 RCV_SKB_FAIL(-EPERM);
437 spin_lock_bh(&queue_lock);
440 if (peer_pid != pid) {
441 spin_unlock_bh(&queue_lock);
442 RCV_SKB_FAIL(-EBUSY);
445 net_enable_timestamp();
449 spin_unlock_bh(&queue_lock);
451 status = ipq_receive_peer(NLMSG_DATA(nlh), type,
452 nlmsglen - NLMSG_LENGTH(0));
454 RCV_SKB_FAIL(status);
456 if (flags & NLM_F_ACK)
457 netlink_ack(skb, nlh, 0);
461 ipq_rcv_skb(struct sk_buff *skb)
463 mutex_lock(&ipqnl_mutex);
465 mutex_unlock(&ipqnl_mutex);
469 ipq_rcv_dev_event(struct notifier_block *this,
470 unsigned long event, void *ptr)
472 struct net_device *dev = ptr;
474 if (!net_eq(dev_net(dev), &init_net))
477 /* Drop any packets associated with the downed device */
478 if (event == NETDEV_DOWN)
479 ipq_dev_drop(dev->ifindex);
483 static struct notifier_block ipq_dev_notifier = {
484 .notifier_call = ipq_rcv_dev_event,
488 ipq_rcv_nl_event(struct notifier_block *this,
489 unsigned long event, void *ptr)
491 struct netlink_notify *n = ptr;
493 if (event == NETLINK_URELEASE && n->protocol == NETLINK_FIREWALL) {
494 spin_lock_bh(&queue_lock);
495 if ((net_eq(n->net, &init_net)) && (n->pid == peer_pid))
497 spin_unlock_bh(&queue_lock);
502 static struct notifier_block ipq_nl_notifier = {
503 .notifier_call = ipq_rcv_nl_event,
507 static struct ctl_table_header *ipq_sysctl_header;
509 static ctl_table ipq_table[] = {
511 .procname = NET_IPQ_QMAX_NAME,
512 .data = &queue_maxlen,
513 .maxlen = sizeof(queue_maxlen),
515 .proc_handler = proc_dointvec
521 #ifdef CONFIG_PROC_FS
522 static int ip_queue_show(struct seq_file *m, void *v)
524 spin_lock_bh(&queue_lock);
530 "Queue length : %u\n"
531 "Queue max. length : %u\n"
532 "Queue dropped : %u\n"
533 "Netlink dropped : %u\n",
542 spin_unlock_bh(&queue_lock);
546 static int ip_queue_open(struct inode *inode, struct file *file)
548 return single_open(file, ip_queue_show, NULL);
551 static const struct file_operations ip_queue_proc_fops = {
552 .open = ip_queue_open,
555 .release = single_release,
556 .owner = THIS_MODULE,
560 static const struct nf_queue_handler nfqh = {
562 .outfn = &ipq_enqueue_packet,
565 static int __init ip_queue_init(void)
567 int status = -ENOMEM;
568 struct proc_dir_entry *proc __maybe_unused;
570 netlink_register_notifier(&ipq_nl_notifier);
571 ipqnl = netlink_kernel_create(&init_net, NETLINK_FIREWALL, 0,
572 ipq_rcv_skb, NULL, THIS_MODULE);
574 printk(KERN_ERR "ip_queue: failed to create netlink socket\n");
575 goto cleanup_netlink_notifier;
578 #ifdef CONFIG_PROC_FS
579 proc = proc_create(IPQ_PROC_FS_NAME, 0, init_net.proc_net,
580 &ip_queue_proc_fops);
582 printk(KERN_ERR "ip_queue: failed to create proc entry\n");
586 register_netdevice_notifier(&ipq_dev_notifier);
588 ipq_sysctl_header = register_sysctl_paths(net_ipv4_ctl_path, ipq_table);
590 status = nf_register_queue_handler(NFPROTO_IPV4, &nfqh);
592 printk(KERN_ERR "ip_queue: failed to register queue handler\n");
599 unregister_sysctl_table(ipq_sysctl_header);
601 unregister_netdevice_notifier(&ipq_dev_notifier);
602 proc_net_remove(&init_net, IPQ_PROC_FS_NAME);
603 cleanup_ipqnl: __maybe_unused
604 netlink_kernel_release(ipqnl);
605 mutex_lock(&ipqnl_mutex);
606 mutex_unlock(&ipqnl_mutex);
608 cleanup_netlink_notifier:
609 netlink_unregister_notifier(&ipq_nl_notifier);
613 static void __exit ip_queue_fini(void)
615 nf_unregister_queue_handlers(&nfqh);
620 unregister_sysctl_table(ipq_sysctl_header);
622 unregister_netdevice_notifier(&ipq_dev_notifier);
623 proc_net_remove(&init_net, IPQ_PROC_FS_NAME);
625 netlink_kernel_release(ipqnl);
626 mutex_lock(&ipqnl_mutex);
627 mutex_unlock(&ipqnl_mutex);
629 netlink_unregister_notifier(&ipq_nl_notifier);
632 MODULE_DESCRIPTION("IPv4 packet queue handler");
633 MODULE_AUTHOR("James Morris <jmorris@intercode.com.au>");
634 MODULE_LICENSE("GPL");
635 MODULE_ALIAS_NET_PF_PROTO(PF_NETLINK, NETLINK_FIREWALL);
637 module_init(ip_queue_init);
638 module_exit(ip_queue_fini);