2 * netfilter module for userspace packet logging daemons
4 * (C) 2000-2004 by Harald Welte <laforge@netfilter.org>
6 * 2000/09/22 ulog-cprange feature added
7 * 2001/01/04 in-kernel queue as proposed by Sebastian Zander
8 * <zander@fokus.gmd.de>
9 * 2001/01/30 per-rule nlgroup conflicts with global queue.
10 * nlgroup now global (sysctl)
11 * 2001/04/19 ulog-queue reworked, now fixed buffer size specified at
13 * 2002/07/07 remove broken nflog_rcv() function -HW
14 * 2002/08/29 fix shifted/unshifted nlgroup bug -HW
15 * 2002/10/30 fix uninitialized mac_len field - <Anders K. Pedersen>
16 * 2004/10/25 fix erroneous calculation of 'len' parameter to NLMSG_PUT
17 * resulting in bogus 'error during NLMSG_PUT' messages.
19 * (C) 1999-2001 Paul `Rusty' Russell
20 * (C) 2002-2004 Netfilter Core Team <coreteam@netfilter.org>
22 * This program is free software; you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License version 2 as
24 * published by the Free Software Foundation.
26 * This module accepts two parameters:
29 * The parameter specifies how big the buffer for each netlink multicast
30 * group is. e.g. If you say nlbufsiz=8192, up to eight kb of packets will
31 * get accumulated in the kernel until they are sent to userspace. It is
32 * NOT possible to allocate more than 128kB, and it is strongly discouraged,
33 * because atomically allocating 128kB inside the network rx softirq is not
34 * reliable. Please also keep in mind that this buffer size is allocated for
35 * each nlgroup you are using, so the total kernel memory usage increases
38 * Actually you should use nlbufsiz a bit smaller than PAGE_SIZE, since
39 * nlbufsiz is used with alloc_skb, which adds another
40 * sizeof(struct skb_shared_info). Use NLMSG_GOODSIZE instead.
43 * Specify, after how many hundredths of a second the queue should be
44 * flushed even if it is not full yet.
46 * ipt_ULOG.c,v 1.22 2002/10/30 09:07:31 laforge Exp
49 #include <linux/module.h>
50 #include <linux/spinlock.h>
51 #include <linux/socket.h>
52 #include <linux/skbuff.h>
53 #include <linux/kernel.h>
54 #include <linux/timer.h>
55 #include <linux/netlink.h>
56 #include <linux/netdevice.h>
58 #include <linux/moduleparam.h>
59 #include <linux/netfilter.h>
60 #include <linux/netfilter/x_tables.h>
61 #include <linux/netfilter_ipv4/ipt_ULOG.h>
63 #include <linux/bitops.h>
64 #include <asm/unaligned.h>
66 MODULE_LICENSE("GPL");
67 MODULE_AUTHOR("Harald Welte <laforge@gnumonks.org>");
68 MODULE_DESCRIPTION("iptables userspace logging module");
69 MODULE_ALIAS_NET_PF_PROTO(PF_NETLINK
, NETLINK_NFLOG
);
71 #define ULOG_NL_EVENT 111 /* Harald's favorite number */
72 #define ULOG_MAXNLGROUPS 32 /* numer of nlgroups */
75 #define DEBUGP(format, args...) printk("%s:%s:" format, \
76 __FILE__, __FUNCTION__ , ## args)
78 #define DEBUGP(format, args...)
81 #define PRINTR(format, args...) do { if (net_ratelimit()) printk(format , ## args); } while (0)
83 static unsigned int nlbufsiz
= NLMSG_GOODSIZE
;
84 module_param(nlbufsiz
, uint
, 0400);
85 MODULE_PARM_DESC(nlbufsiz
, "netlink buffer size");
87 static unsigned int flushtimeout
= 10;
88 module_param(flushtimeout
, uint
, 0600);
89 MODULE_PARM_DESC(flushtimeout
, "buffer flush timeout (hundredths of a second)");
92 module_param(nflog
, bool, 0400);
93 MODULE_PARM_DESC(nflog
, "register as internal netfilter logging module");
95 /* global data structures */
98 unsigned int qlen
; /* number of nlmsgs' in the skb */
99 struct nlmsghdr
*lastnlh
; /* netlink header of last msg in skb */
100 struct sk_buff
*skb
; /* the pre-allocated skb */
101 struct timer_list timer
; /* the timer function */
104 static ulog_buff_t ulog_buffers
[ULOG_MAXNLGROUPS
]; /* array of buffers */
106 static struct sock
*nflognl
; /* our socket */
107 static DEFINE_SPINLOCK(ulog_lock
); /* spinlock */
109 /* send one ulog_buff_t to userspace */
110 static void ulog_send(unsigned int nlgroupnum
)
112 ulog_buff_t
*ub
= &ulog_buffers
[nlgroupnum
];
114 if (timer_pending(&ub
->timer
)) {
115 DEBUGP("ipt_ULOG: ulog_send: timer was pending, deleting\n");
116 del_timer(&ub
->timer
);
120 DEBUGP("ipt_ULOG: ulog_send: nothing to send\n");
124 /* last nlmsg needs NLMSG_DONE */
126 ub
->lastnlh
->nlmsg_type
= NLMSG_DONE
;
128 NETLINK_CB(ub
->skb
).dst_group
= nlgroupnum
+ 1;
129 DEBUGP("ipt_ULOG: throwing %d packets to netlink group %u\n",
130 ub
->qlen
, nlgroupnum
+ 1);
131 netlink_broadcast(nflognl
, ub
->skb
, 0, nlgroupnum
+ 1, GFP_ATOMIC
);
139 /* timer function to flush queue in flushtimeout time */
140 static void ulog_timer(unsigned long data
)
142 DEBUGP("ipt_ULOG: timer function called, calling ulog_send\n");
144 /* lock to protect against somebody modifying our structure
145 * from ipt_ulog_target at the same time */
146 spin_lock_bh(&ulog_lock
);
148 spin_unlock_bh(&ulog_lock
);
151 static struct sk_buff
*ulog_alloc_skb(unsigned int size
)
156 /* alloc skb which should be big enough for a whole
157 * multipart message. WARNING: has to be <= 131000
158 * due to slab allocator restrictions */
160 n
= max(size
, nlbufsiz
);
161 skb
= alloc_skb(n
, GFP_ATOMIC
);
163 PRINTR("ipt_ULOG: can't alloc whole buffer %ub!\n", n
);
166 /* try to allocate only as much as we need for
169 skb
= alloc_skb(size
, GFP_ATOMIC
);
171 PRINTR("ipt_ULOG: can't even allocate %ub\n",
179 static void ipt_ulog_packet(unsigned int hooknum
,
180 const struct sk_buff
*skb
,
181 const struct net_device
*in
,
182 const struct net_device
*out
,
183 const struct ipt_ulog_info
*loginfo
,
187 ulog_packet_msg_t
*pm
;
188 size_t size
, copy_len
;
189 struct nlmsghdr
*nlh
;
192 /* ffs == find first bit set, necessary because userspace
193 * is already shifting groupnumber, but we need unshifted.
194 * ffs() returns [1..32], we need [0..31] */
195 unsigned int groupnum
= ffs(loginfo
->nl_group
) - 1;
197 /* calculate the size of the skb needed */
198 if ((loginfo
->copy_range
== 0) ||
199 (loginfo
->copy_range
> skb
->len
)) {
202 copy_len
= loginfo
->copy_range
;
205 size
= NLMSG_SPACE(sizeof(*pm
) + copy_len
);
207 ub
= &ulog_buffers
[groupnum
];
209 spin_lock_bh(&ulog_lock
);
212 if (!(ub
->skb
= ulog_alloc_skb(size
)))
214 } else if (ub
->qlen
>= loginfo
->qthreshold
||
215 size
> skb_tailroom(ub
->skb
)) {
216 /* either the queue len is too high or we don't have
217 * enough room in nlskb left. send it to userspace. */
221 if (!(ub
->skb
= ulog_alloc_skb(size
)))
225 DEBUGP("ipt_ULOG: qlen %d, qthreshold %d\n", ub
->qlen
,
226 loginfo
->qthreshold
);
228 /* NLMSG_PUT contains a hidden goto nlmsg_failure !!! */
229 nlh
= NLMSG_PUT(ub
->skb
, 0, ub
->qlen
, ULOG_NL_EVENT
,
230 sizeof(*pm
)+copy_len
);
233 pm
= NLMSG_DATA(nlh
);
235 /* We might not have a timestamp, get one */
236 if (skb
->tstamp
.tv64
== 0)
237 __net_timestamp((struct sk_buff
*)skb
);
239 /* copy hook, prefix, timestamp, payload, etc. */
240 pm
->data_len
= copy_len
;
241 tv
= ktime_to_timeval(skb
->tstamp
);
242 put_unaligned(tv
.tv_sec
, &pm
->timestamp_sec
);
243 put_unaligned(tv
.tv_usec
, &pm
->timestamp_usec
);
244 put_unaligned(skb
->mark
, &pm
->mark
);
247 strncpy(pm
->prefix
, prefix
, sizeof(pm
->prefix
));
248 else if (loginfo
->prefix
[0] != '\0')
249 strncpy(pm
->prefix
, loginfo
->prefix
, sizeof(pm
->prefix
));
251 *(pm
->prefix
) = '\0';
253 if (in
&& in
->hard_header_len
> 0
254 && skb
->mac
.raw
!= skb
->nh
.raw
255 && in
->hard_header_len
<= ULOG_MAC_LEN
) {
256 memcpy(pm
->mac
, skb_mac_header(skb
), in
->hard_header_len
);
257 pm
->mac_len
= in
->hard_header_len
;
262 strncpy(pm
->indev_name
, in
->name
, sizeof(pm
->indev_name
));
264 pm
->indev_name
[0] = '\0';
267 strncpy(pm
->outdev_name
, out
->name
, sizeof(pm
->outdev_name
));
269 pm
->outdev_name
[0] = '\0';
271 /* copy_len <= skb->len, so can't fail. */
272 if (skb_copy_bits(skb
, 0, pm
->payload
, copy_len
) < 0)
275 /* check if we are building multi-part messages */
277 ub
->lastnlh
->nlmsg_flags
|= NLM_F_MULTI
;
282 /* if timer isn't already running, start it */
283 if (!timer_pending(&ub
->timer
)) {
284 ub
->timer
.expires
= jiffies
+ flushtimeout
* HZ
/ 100;
285 add_timer(&ub
->timer
);
288 /* if threshold is reached, send message to userspace */
289 if (ub
->qlen
>= loginfo
->qthreshold
) {
290 if (loginfo
->qthreshold
> 1)
291 nlh
->nlmsg_type
= NLMSG_DONE
;
295 spin_unlock_bh(&ulog_lock
);
300 PRINTR("ipt_ULOG: error during NLMSG_PUT\n");
303 PRINTR("ipt_ULOG: Error building netlink message\n");
305 spin_unlock_bh(&ulog_lock
);
308 static unsigned int ipt_ulog_target(struct sk_buff
**pskb
,
309 const struct net_device
*in
,
310 const struct net_device
*out
,
311 unsigned int hooknum
,
312 const struct xt_target
*target
,
313 const void *targinfo
)
315 struct ipt_ulog_info
*loginfo
= (struct ipt_ulog_info
*) targinfo
;
317 ipt_ulog_packet(hooknum
, *pskb
, in
, out
, loginfo
, NULL
);
322 static void ipt_logfn(unsigned int pf
,
323 unsigned int hooknum
,
324 const struct sk_buff
*skb
,
325 const struct net_device
*in
,
326 const struct net_device
*out
,
327 const struct nf_loginfo
*li
,
330 struct ipt_ulog_info loginfo
;
332 if (!li
|| li
->type
!= NF_LOG_TYPE_ULOG
) {
333 loginfo
.nl_group
= ULOG_DEFAULT_NLGROUP
;
334 loginfo
.copy_range
= 0;
335 loginfo
.qthreshold
= ULOG_DEFAULT_QTHRESHOLD
;
336 loginfo
.prefix
[0] = '\0';
338 loginfo
.nl_group
= li
->u
.ulog
.group
;
339 loginfo
.copy_range
= li
->u
.ulog
.copy_len
;
340 loginfo
.qthreshold
= li
->u
.ulog
.qthreshold
;
341 strlcpy(loginfo
.prefix
, prefix
, sizeof(loginfo
.prefix
));
344 ipt_ulog_packet(hooknum
, skb
, in
, out
, &loginfo
, prefix
);
347 static int ipt_ulog_checkentry(const char *tablename
,
349 const struct xt_target
*target
,
351 unsigned int hookmask
)
353 struct ipt_ulog_info
*loginfo
= (struct ipt_ulog_info
*) targinfo
;
355 if (loginfo
->prefix
[sizeof(loginfo
->prefix
) - 1] != '\0') {
356 DEBUGP("ipt_ULOG: prefix term %i\n",
357 loginfo
->prefix
[sizeof(loginfo
->prefix
) - 1]);
360 if (loginfo
->qthreshold
> ULOG_MAX_QLEN
) {
361 DEBUGP("ipt_ULOG: queue threshold %i > MAX_QLEN\n",
362 loginfo
->qthreshold
);
368 static struct xt_target ipt_ulog_reg
= {
371 .target
= ipt_ulog_target
,
372 .targetsize
= sizeof(struct ipt_ulog_info
),
373 .checkentry
= ipt_ulog_checkentry
,
377 static struct nf_logger ipt_ulog_logger
= {
383 static int __init
ipt_ulog_init(void)
387 DEBUGP("ipt_ULOG: init module\n");
389 if (nlbufsiz
> 128*1024) {
390 printk("Netlink buffer has to be <= 128kB\n");
394 /* initialize ulog_buffers */
395 for (i
= 0; i
< ULOG_MAXNLGROUPS
; i
++) {
396 init_timer(&ulog_buffers
[i
].timer
);
397 ulog_buffers
[i
].timer
.function
= ulog_timer
;
398 ulog_buffers
[i
].timer
.data
= i
;
401 nflognl
= netlink_kernel_create(NETLINK_NFLOG
, ULOG_MAXNLGROUPS
, NULL
,
406 ret
= xt_register_target(&ipt_ulog_reg
);
408 sock_release(nflognl
->sk_socket
);
412 nf_log_register(PF_INET
, &ipt_ulog_logger
);
417 static void __exit
ipt_ulog_fini(void)
422 DEBUGP("ipt_ULOG: cleanup_module\n");
425 nf_log_unregister(&ipt_ulog_logger
);
426 xt_unregister_target(&ipt_ulog_reg
);
427 sock_release(nflognl
->sk_socket
);
429 /* remove pending timers and free allocated skb's */
430 for (i
= 0; i
< ULOG_MAXNLGROUPS
; i
++) {
431 ub
= &ulog_buffers
[i
];
432 if (timer_pending(&ub
->timer
)) {
433 DEBUGP("timer was pending, deleting\n");
434 del_timer(&ub
->timer
);
444 module_init(ipt_ulog_init
);
445 module_exit(ipt_ulog_fini
);