net/ipv4/netfilter/ipt_ULOG.c

   1 /*
   2  * netfilter module for userspace packet logging daemons
   3  *
   4  * (C) 2000-2004 by Harald Welte <laforge@netfilter.org>
   5  * (C) 1999-2001 Paul `Rusty' Russell
   6  * (C) 2002-2004 Netfilter Core Team <coreteam@netfilter.org>
   7  * (C) 2005-2007 Patrick McHardy <kaber@trash.net>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  *
  13  * This module accepts two parameters:
  14  *
  15  * nlbufsiz:
  16  *   The parameter specifies how big the buffer for each netlink multicast
  17  * group is. e.g. If you say nlbufsiz=8192, up to eight kb of packets will
  18  * get accumulated in the kernel until they are sent to userspace. It is
  19  * NOT possible to allocate more than 128kB, and it is strongly discouraged,
  20  * because atomically allocating 128kB inside the network rx softirq is not
  21  * reliable. Please also keep in mind that this buffer size is allocated for
  22  * each nlgroup you are using, so the total kernel memory usage increases
  23  * by that factor.
  24  *
  25  * Actually you should use nlbufsiz a bit smaller than PAGE_SIZE, since
  26  * nlbufsiz is used with alloc_skb, which adds another
  27  * sizeof(struct skb_shared_info).  Use NLMSG_GOODSIZE instead.
  28  *
  29  * flushtimeout:
  30  *   Specify, after how many hundredths of a second the queue should be
  31  *   flushed even if it is not full yet.
  32  */
  33 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  34 #include <linux/module.h>
  35 #include <linux/spinlock.h>
  36 #include <linux/socket.h>
  37 #include <linux/slab.h>
  38 #include <linux/skbuff.h>
  39 #include <linux/kernel.h>
  40 #include <linux/timer.h>
  41 #include <net/netlink.h>
  42 #include <linux/netdevice.h>
  43 #include <linux/mm.h>
  44 #include <linux/moduleparam.h>
  45 #include <linux/netfilter.h>
  46 #include <linux/netfilter/x_tables.h>
  47 #include <linux/netfilter_ipv4/ipt_ULOG.h>
  48 #include <net/netfilter/nf_log.h>
  49 #include <net/netns/generic.h>
  50 #include <net/sock.h>
  51 #include <linux/bitops.h>
  52 #include <asm/unaligned.h>
  53
  54 MODULE_LICENSE("GPL");
  55 MODULE_AUTHOR("Harald Welte <laforge@gnumonks.org>");
  56 MODULE_DESCRIPTION("Xtables: packet logging to netlink using ULOG");
  57 MODULE_ALIAS_NET_PF_PROTO(PF_NETLINK, NETLINK_NFLOG);
  58
  59 #define ULOG_NL_EVENT           111             /* Harald's favorite number */
  60 #define ULOG_MAXNLGROUPS        32              /* numer of nlgroups */
  61
  62 static unsigned int nlbufsiz = NLMSG_GOODSIZE;
  63 module_param(nlbufsiz, uint, 0400);
  64 MODULE_PARM_DESC(nlbufsiz, "netlink buffer size");
  65
  66 static unsigned int flushtimeout = 10;
  67 module_param(flushtimeout, uint, 0600);
  68 MODULE_PARM_DESC(flushtimeout, "buffer flush timeout (hundredths of a second)");
  69
  70 static bool nflog = true;
  71 module_param(nflog, bool, 0400);
  72 MODULE_PARM_DESC(nflog, "register as internal netfilter logging module");
  73
  74 /* global data structures */
  75
  76 typedef struct {
  77         unsigned int qlen;              /* number of nlmsgs' in the skb */
  78         struct nlmsghdr *lastnlh;       /* netlink header of last msg in skb */
  79         struct sk_buff *skb;            /* the pre-allocated skb */
  80         struct timer_list timer;        /* the timer function */
  81 } ulog_buff_t;
  82
  83 static int ulog_net_id __read_mostly;
  84 struct ulog_net {
  85         unsigned int nlgroup[ULOG_MAXNLGROUPS];
  86         ulog_buff_t ulog_buffers[ULOG_MAXNLGROUPS];
  87         struct sock *nflognl;
  88         spinlock_t lock;
  89 };
  90
  91 static struct ulog_net *ulog_pernet(struct net *net)
  92 {
  93         return net_generic(net, ulog_net_id);
  94 }
  95
  96 /* send one ulog_buff_t to userspace */
  97 static void ulog_send(struct ulog_net *ulog, unsigned int nlgroupnum)
  98 {
  99         ulog_buff_t *ub = &ulog->ulog_buffers[nlgroupnum];
 100
 101         pr_debug("ulog_send: timer is deleting\n");
 102         del_timer(&ub->timer);
 103
 104         if (!ub->skb) {
 105                 pr_debug("ulog_send: nothing to send\n");
 106                 return;
 107         }
 108
 109         /* last nlmsg needs NLMSG_DONE */
 110         if (ub->qlen > 1)
 111                 ub->lastnlh->nlmsg_type = NLMSG_DONE;
 112
 113         NETLINK_CB(ub->skb).dst_group = nlgroupnum + 1;
 114         pr_debug("throwing %d packets to netlink group %u\n",
 115                  ub->qlen, nlgroupnum + 1);
 116         netlink_broadcast(ulog->nflognl, ub->skb, 0, nlgroupnum + 1,
 117                           GFP_ATOMIC);
 118
 119         ub->qlen = 0;
 120         ub->skb = NULL;
 121         ub->lastnlh = NULL;
 122 }
 123
 124
 125 /* timer function to flush queue in flushtimeout time */
 126 static void ulog_timer(unsigned long data)
 127 {
 128         struct ulog_net *ulog = container_of((void *)data,
 129                                              struct ulog_net,
 130                                              nlgroup[*(unsigned int *)data]);
 131         pr_debug("timer function called, calling ulog_send\n");
 132
 133         /* lock to protect against somebody modifying our structure
 134          * from ipt_ulog_target at the same time */
 135         spin_lock_bh(&ulog->lock);
 136         ulog_send(ulog, data);
 137         spin_unlock_bh(&ulog->lock);
 138 }
 139
 140 static struct sk_buff *ulog_alloc_skb(unsigned int size)
 141 {
 142         struct sk_buff *skb;
 143         unsigned int n;
 144
 145         /* alloc skb which should be big enough for a whole
 146          * multipart message. WARNING: has to be <= 131000
 147          * due to slab allocator restrictions */
 148
 149         n = max(size, nlbufsiz);
 150         skb = alloc_skb(n, GFP_ATOMIC | __GFP_NOWARN);
 151         if (!skb) {
 152                 if (n > size) {
 153                         /* try to allocate only as much as we need for
 154                          * current packet */
 155
 156                         skb = alloc_skb(size, GFP_ATOMIC);
 157                         if (!skb)
 158                                 pr_debug("cannot even allocate %ub\n", size);
 159                 }
 160         }
 161
 162         return skb;
 163 }
 164
 165 static void ipt_ulog_packet(struct net *net,
 166                             unsigned int hooknum,
 167                             const struct sk_buff *skb,
 168                             const struct net_device *in,
 169                             const struct net_device *out,
 170                             const struct ipt_ulog_info *loginfo,
 171                             const char *prefix)
 172 {
 173         ulog_buff_t *ub;
 174         ulog_packet_msg_t *pm;
 175         size_t size, copy_len;
 176         struct nlmsghdr *nlh;
 177         struct timeval tv;
 178         struct ulog_net *ulog = ulog_pernet(net);
 179
 180         /* ffs == find first bit set, necessary because userspace
 181          * is already shifting groupnumber, but we need unshifted.
 182          * ffs() returns [1..32], we need [0..31] */
 183         unsigned int groupnum = ffs(loginfo->nl_group) - 1;
 184
 185         /* calculate the size of the skb needed */
 186         if (loginfo->copy_range == 0 || loginfo->copy_range > skb->len)
 187                 copy_len = skb->len;
 188         else
 189                 copy_len = loginfo->copy_range;
 190
 191         size = nlmsg_total_size(sizeof(*pm) + copy_len);
 192
 193         ub = &ulog->ulog_buffers[groupnum];
 194
 195         spin_lock_bh(&ulog->lock);
 196
 197         if (!ub->skb) {
 198                 if (!(ub->skb = ulog_alloc_skb(size)))
 199                         goto alloc_failure;
 200         } else if (ub->qlen >= loginfo->qthreshold ||
 201                    size > skb_tailroom(ub->skb)) {
 202                 /* either the queue len is too high or we don't have
 203                  * enough room in nlskb left. send it to userspace. */
 204
 205                 ulog_send(ulog, groupnum);
 206
 207                 if (!(ub->skb = ulog_alloc_skb(size)))
 208                         goto alloc_failure;
 209         }
 210
 211         pr_debug("qlen %d, qthreshold %Zu\n", ub->qlen, loginfo->qthreshold);
 212
 213         nlh = nlmsg_put(ub->skb, 0, ub->qlen, ULOG_NL_EVENT,
 214                         sizeof(*pm)+copy_len, 0);
 215         if (!nlh) {
 216                 pr_debug("error during nlmsg_put\n");
 217                 goto out_unlock;
 218         }
 219         ub->qlen++;
 220
 221         pm = nlmsg_data(nlh);
 222
 223         /* We might not have a timestamp, get one */
 224         if (skb->tstamp.tv64 == 0)
 225                 __net_timestamp((struct sk_buff *)skb);
 226
 227         /* copy hook, prefix, timestamp, payload, etc. */
 228         pm->data_len = copy_len;
 229         tv = ktime_to_timeval(skb->tstamp);
 230         put_unaligned(tv.tv_sec, &pm->timestamp_sec);
 231         put_unaligned(tv.tv_usec, &pm->timestamp_usec);
 232         put_unaligned(skb->mark, &pm->mark);
 233         pm->hook = hooknum;
 234         if (prefix != NULL) {
 235                 strncpy(pm->prefix, prefix, sizeof(pm->prefix) - 1);
 236                 pm->prefix[sizeof(pm->prefix) - 1] = '\0';
 237         }
 238         else if (loginfo->prefix[0] != '\0')
 239                 strncpy(pm->prefix, loginfo->prefix, sizeof(pm->prefix));
 240         else
 241                 *(pm->prefix) = '\0';
 242
 243         if (in && in->hard_header_len > 0 &&
 244             skb->mac_header != skb->network_header &&
 245             in->hard_header_len <= ULOG_MAC_LEN) {
 246                 memcpy(pm->mac, skb_mac_header(skb), in->hard_header_len);
 247                 pm->mac_len = in->hard_header_len;
 248         } else
 249                 pm->mac_len = 0;
 250
 251         if (in)
 252                 strncpy(pm->indev_name, in->name, sizeof(pm->indev_name));
 253         else
 254                 pm->indev_name[0] = '\0';
 255
 256         if (out)
 257                 strncpy(pm->outdev_name, out->name, sizeof(pm->outdev_name));
 258         else
 259                 pm->outdev_name[0] = '\0';
 260
 261         /* copy_len <= skb->len, so can't fail. */
 262         if (skb_copy_bits(skb, 0, pm->payload, copy_len) < 0)
 263                 BUG();
 264
 265         /* check if we are building multi-part messages */
 266         if (ub->qlen > 1)
 267                 ub->lastnlh->nlmsg_flags |= NLM_F_MULTI;
 268
 269         ub->lastnlh = nlh;
 270
 271         /* if timer isn't already running, start it */
 272         if (!timer_pending(&ub->timer)) {
 273                 ub->timer.expires = jiffies + flushtimeout * HZ / 100;
 274                 add_timer(&ub->timer);
 275         }
 276
 277         /* if threshold is reached, send message to userspace */
 278         if (ub->qlen >= loginfo->qthreshold) {
 279                 if (loginfo->qthreshold > 1)
 280                         nlh->nlmsg_type = NLMSG_DONE;
 281                 ulog_send(ulog, groupnum);
 282         }
 283 out_unlock:
 284         spin_unlock_bh(&ulog->lock);
 285
 286         return;
 287
 288 alloc_failure:
 289         pr_debug("Error building netlink message\n");
 290         spin_unlock_bh(&ulog->lock);
 291 }
 292
 293 static unsigned int
 294 ulog_tg(struct sk_buff *skb, const struct xt_action_param *par)
 295 {
 296         struct net *net = dev_net(par->in ? par->in : par->out);
 297
 298         ipt_ulog_packet(net, par->hooknum, skb, par->in, par->out,
 299                         par->targinfo, NULL);
 300         return XT_CONTINUE;
 301 }
 302
 303 static void ipt_logfn(struct net *net,
 304                       u_int8_t pf,
 305                       unsigned int hooknum,
 306                       const struct sk_buff *skb,
 307                       const struct net_device *in,
 308                       const struct net_device *out,
 309                       const struct nf_loginfo *li,
 310                       const char *prefix)
 311 {
 312         struct ipt_ulog_info loginfo;
 313
 314         if (!li || li->type != NF_LOG_TYPE_ULOG) {
 315                 loginfo.nl_group = ULOG_DEFAULT_NLGROUP;
 316                 loginfo.copy_range = 0;
 317                 loginfo.qthreshold = ULOG_DEFAULT_QTHRESHOLD;
 318                 loginfo.prefix[0] = '\0';
 319         } else {
 320                 loginfo.nl_group = li->u.ulog.group;
 321                 loginfo.copy_range = li->u.ulog.copy_len;
 322                 loginfo.qthreshold = li->u.ulog.qthreshold;
 323                 strlcpy(loginfo.prefix, prefix, sizeof(loginfo.prefix));
 324         }
 325
 326         ipt_ulog_packet(net, hooknum, skb, in, out, &loginfo, prefix);
 327 }
 328
 329 static int ulog_tg_check(const struct xt_tgchk_param *par)
 330 {
 331         const struct ipt_ulog_info *loginfo = par->targinfo;
 332
 333         if (!par->net->xt.ulog_warn_deprecated) {
 334                 pr_info("ULOG is deprecated and it will be removed soon, "
 335                         "use NFLOG instead\n");
 336                 par->net->xt.ulog_warn_deprecated = true;
 337         }
 338
 339         if (loginfo->prefix[sizeof(loginfo->prefix) - 1] != '\0') {
 340                 pr_debug("prefix not null-terminated\n");
 341                 return -EINVAL;
 342         }
 343         if (loginfo->qthreshold > ULOG_MAX_QLEN) {
 344                 pr_debug("queue threshold %Zu > MAX_QLEN\n",
 345                          loginfo->qthreshold);
 346                 return -EINVAL;
 347         }
 348         return 0;
 349 }
 350
 351 #ifdef CONFIG_COMPAT
 352 struct compat_ipt_ulog_info {
 353         compat_uint_t   nl_group;
 354         compat_size_t   copy_range;
 355         compat_size_t   qthreshold;
 356         char            prefix[ULOG_PREFIX_LEN];
 357 };
 358
 359 static void ulog_tg_compat_from_user(void *dst, const void *src)
 360 {
 361         const struct compat_ipt_ulog_info *cl = src;
 362         struct ipt_ulog_info l = {
 363                 .nl_group       = cl->nl_group,
 364                 .copy_range     = cl->copy_range,
 365                 .qthreshold     = cl->qthreshold,
 366         };
 367
 368         memcpy(l.prefix, cl->prefix, sizeof(l.prefix));
 369         memcpy(dst, &l, sizeof(l));
 370 }
 371
 372 static int ulog_tg_compat_to_user(void __user *dst, const void *src)
 373 {
 374         const struct ipt_ulog_info *l = src;
 375         struct compat_ipt_ulog_info cl = {
 376                 .nl_group       = l->nl_group,
 377                 .copy_range     = l->copy_range,
 378                 .qthreshold     = l->qthreshold,
 379         };
 380
 381         memcpy(cl.prefix, l->prefix, sizeof(cl.prefix));
 382         return copy_to_user(dst, &cl, sizeof(cl)) ? -EFAULT : 0;
 383 }
 384 #endif /* CONFIG_COMPAT */
 385
 386 static struct xt_target ulog_tg_reg __read_mostly = {
 387         .name           = "ULOG",
 388         .family         = NFPROTO_IPV4,
 389         .target         = ulog_tg,
 390         .targetsize     = sizeof(struct ipt_ulog_info),
 391         .checkentry     = ulog_tg_check,
 392 #ifdef CONFIG_COMPAT
 393         .compatsize     = sizeof(struct compat_ipt_ulog_info),
 394         .compat_from_user = ulog_tg_compat_from_user,
 395         .compat_to_user = ulog_tg_compat_to_user,
 396 #endif
 397         .me             = THIS_MODULE,
 398 };
 399
 400 static struct nf_logger ipt_ulog_logger __read_mostly = {
 401         .name           = "ipt_ULOG",
 402         .logfn          = ipt_logfn,
 403         .me             = THIS_MODULE,
 404 };
 405
 406 static int __net_init ulog_tg_net_init(struct net *net)
 407 {
 408         int i;
 409         struct ulog_net *ulog = ulog_pernet(net);
 410         struct netlink_kernel_cfg cfg = {
 411                 .groups = ULOG_MAXNLGROUPS,
 412         };
 413
 414         spin_lock_init(&ulog->lock);
 415         /* initialize ulog_buffers */
 416         for (i = 0; i < ULOG_MAXNLGROUPS; i++)
 417                 setup_timer(&ulog->ulog_buffers[i].timer, ulog_timer, i);
 418
 419         ulog->nflognl = netlink_kernel_create(net, NETLINK_NFLOG, &cfg);
 420         if (!ulog->nflognl)
 421                 return -ENOMEM;
 422
 423         if (nflog)
 424                 nf_log_set(net, NFPROTO_IPV4, &ipt_ulog_logger);
 425
 426         return 0;
 427 }
 428
 429 static void __net_exit ulog_tg_net_exit(struct net *net)
 430 {
 431         ulog_buff_t *ub;
 432         int i;
 433         struct ulog_net *ulog = ulog_pernet(net);
 434
 435         if (nflog)
 436                 nf_log_unset(net, &ipt_ulog_logger);
 437
 438         netlink_kernel_release(ulog->nflognl);
 439
 440         /* remove pending timers and free allocated skb's */
 441         for (i = 0; i < ULOG_MAXNLGROUPS; i++) {
 442                 ub = &ulog->ulog_buffers[i];
 443                 pr_debug("timer is deleting\n");
 444                 del_timer(&ub->timer);
 445
 446                 if (ub->skb) {
 447                         kfree_skb(ub->skb);
 448                         ub->skb = NULL;
 449                 }
 450         }
 451 }
 452
 453 static struct pernet_operations ulog_tg_net_ops = {
 454         .init = ulog_tg_net_init,
 455         .exit = ulog_tg_net_exit,
 456         .id   = &ulog_net_id,
 457         .size = sizeof(struct ulog_net),
 458 };
 459
 460 static int __init ulog_tg_init(void)
 461 {
 462         int ret;
 463         pr_debug("init module\n");
 464
 465         if (nlbufsiz > 128*1024) {
 466                 pr_warn("Netlink buffer has to be <= 128kB\n");
 467                 return -EINVAL;
 468         }
 469
 470         ret = register_pernet_subsys(&ulog_tg_net_ops);
 471         if (ret)
 472                 goto out_pernet;
 473
 474         ret = xt_register_target(&ulog_tg_reg);
 475         if (ret < 0)
 476                 goto out_target;
 477
 478         if (nflog)
 479                 nf_log_register(NFPROTO_IPV4, &ipt_ulog_logger);
 480
 481         return 0;
 482
 483 out_target:
 484         unregister_pernet_subsys(&ulog_tg_net_ops);
 485 out_pernet:
 486         return ret;
 487 }
 488
 489 static void __exit ulog_tg_exit(void)
 490 {
 491         pr_debug("cleanup_module\n");
 492         if (nflog)
 493                 nf_log_unregister(&ipt_ulog_logger);
 494         xt_unregister_target(&ulog_tg_reg);
 495         unregister_pernet_subsys(&ulog_tg_net_ops);
 496 }
 497
 498 module_init(ulog_tg_init);
 499 module_exit(ulog_tg_exit);