net/bridge/netfilter/ebt_ulog.c

   1 /*
   2  * netfilter module for userspace bridged Ethernet frames logging daemons
   3  *
   4  *      Authors:
   5  *      Bart De Schuymer <bdschuym@pandora.be>
   6  *      Harald Welte <laforge@netfilter.org>
   7  *
   8  *  November, 2004
   9  *
  10  * Based on ipt_ULOG.c, which is
  11  * (C) 2000-2002 by Harald Welte <laforge@netfilter.org>
  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  * flushtimeout:
  26  *   Specify, after how many hundredths of a second the queue should be
  27  *   flushed even if it is not full yet.
  28  *
  29  */
  30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  31 #include <linux/module.h>
  32 #include <linux/slab.h>
  33 #include <linux/spinlock.h>
  34 #include <linux/socket.h>
  35 #include <linux/skbuff.h>
  36 #include <linux/kernel.h>
  37 #include <linux/timer.h>
  38 #include <net/netlink.h>
  39 #include <linux/netdevice.h>
  40 #include <linux/netfilter/x_tables.h>
  41 #include <linux/netfilter_bridge/ebtables.h>
  42 #include <linux/netfilter_bridge/ebt_ulog.h>
  43 #include <net/netfilter/nf_log.h>
  44 #include <net/netns/generic.h>
  45 #include <net/sock.h>
  46 #include "../br_private.h"
  47
  48 static unsigned int nlbufsiz = NLMSG_GOODSIZE;
  49 module_param(nlbufsiz, uint, 0600);
  50 MODULE_PARM_DESC(nlbufsiz, "netlink buffer size (number of bytes) "
  51                            "(defaults to 4096)");
  52
  53 static unsigned int flushtimeout = 10;
  54 module_param(flushtimeout, uint, 0600);
  55 MODULE_PARM_DESC(flushtimeout, "buffer flush timeout (hundredths ofa second) "
  56                                "(defaults to 10)");
  57
  58 typedef struct {
  59         unsigned int qlen;              /* number of nlmsgs' in the skb */
  60         struct nlmsghdr *lastnlh;       /* netlink header of last msg in skb */
  61         struct sk_buff *skb;            /* the pre-allocated skb */
  62         struct timer_list timer;        /* the timer function */
  63         spinlock_t lock;                /* the per-queue lock */
  64 } ebt_ulog_buff_t;
  65
  66 static int ebt_ulog_net_id __read_mostly;
  67 struct ebt_ulog_net {
  68         unsigned int nlgroup[EBT_ULOG_MAXNLGROUPS];
  69         ebt_ulog_buff_t ulog_buffers[EBT_ULOG_MAXNLGROUPS];
  70         struct sock *ebtulognl;
  71 };
  72
  73 static struct ebt_ulog_net *ebt_ulog_pernet(struct net *net)
  74 {
  75         return net_generic(net, ebt_ulog_net_id);
  76 }
  77
  78 /* send one ulog_buff_t to userspace */
  79 static void ulog_send(struct ebt_ulog_net *ebt, unsigned int nlgroup)
  80 {
  81         ebt_ulog_buff_t *ub = &ebt->ulog_buffers[nlgroup];
  82
  83         del_timer(&ub->timer);
  84
  85         if (!ub->skb)
  86                 return;
  87
  88         /* last nlmsg needs NLMSG_DONE */
  89         if (ub->qlen > 1)
  90                 ub->lastnlh->nlmsg_type = NLMSG_DONE;
  91
  92         NETLINK_CB(ub->skb).dst_group = nlgroup + 1;
  93         netlink_broadcast(ebt->ebtulognl, ub->skb, 0, nlgroup + 1, GFP_ATOMIC);
  94
  95         ub->qlen = 0;
  96         ub->skb = NULL;
  97 }
  98
  99 /* timer function to flush queue in flushtimeout time */
 100 static void ulog_timer(unsigned long data)
 101 {
 102         struct ebt_ulog_net *ebt = container_of((void *)data,
 103                                                 struct ebt_ulog_net,
 104                                                 nlgroup[*(unsigned int *)data]);
 105
 106         ebt_ulog_buff_t *ub = &ebt->ulog_buffers[*(unsigned int *)data];
 107         spin_lock_bh(&ub->lock);
 108         if (ub->skb)
 109                 ulog_send(ebt, *(unsigned int *)data);
 110         spin_unlock_bh(&ub->lock);
 111 }
 112
 113 static struct sk_buff *ulog_alloc_skb(unsigned int size)
 114 {
 115         struct sk_buff *skb;
 116         unsigned int n;
 117
 118         n = max(size, nlbufsiz);
 119         skb = alloc_skb(n, GFP_ATOMIC | __GFP_NOWARN);
 120         if (!skb) {
 121                 if (n > size) {
 122                         /* try to allocate only as much as we need for
 123                          * current packet */
 124                         skb = alloc_skb(size, GFP_ATOMIC);
 125                         if (!skb)
 126                                 pr_debug("cannot even allocate buffer of size %ub\n",
 127                                          size);
 128                 }
 129         }
 130
 131         return skb;
 132 }
 133
 134 static void ebt_ulog_packet(struct net *net, unsigned int hooknr,
 135                             const struct sk_buff *skb,
 136                             const struct net_device *in,
 137                             const struct net_device *out,
 138                             const struct ebt_ulog_info *uloginfo,
 139                             const char *prefix)
 140 {
 141         ebt_ulog_packet_msg_t *pm;
 142         size_t size, copy_len;
 143         struct nlmsghdr *nlh;
 144         struct ebt_ulog_net *ebt = ebt_ulog_pernet(net);
 145         unsigned int group = uloginfo->nlgroup;
 146         ebt_ulog_buff_t *ub = &ebt->ulog_buffers[group];
 147         spinlock_t *lock = &ub->lock;
 148         ktime_t kt;
 149
 150         if ((uloginfo->cprange == 0) ||
 151             (uloginfo->cprange > skb->len + ETH_HLEN))
 152                 copy_len = skb->len + ETH_HLEN;
 153         else
 154                 copy_len = uloginfo->cprange;
 155
 156         size = nlmsg_total_size(sizeof(*pm) + copy_len);
 157         if (size > nlbufsiz) {
 158                 pr_debug("Size %Zd needed, but nlbufsiz=%d\n", size, nlbufsiz);
 159                 return;
 160         }
 161
 162         spin_lock_bh(lock);
 163
 164         if (!ub->skb) {
 165                 if (!(ub->skb = ulog_alloc_skb(size)))
 166                         goto unlock;
 167         } else if (size > skb_tailroom(ub->skb)) {
 168                 ulog_send(ebt, group);
 169
 170                 if (!(ub->skb = ulog_alloc_skb(size)))
 171                         goto unlock;
 172         }
 173
 174         nlh = nlmsg_put(ub->skb, 0, ub->qlen, 0,
 175                         size - NLMSG_ALIGN(sizeof(*nlh)), 0);
 176         if (!nlh) {
 177                 kfree_skb(ub->skb);
 178                 ub->skb = NULL;
 179                 goto unlock;
 180         }
 181         ub->qlen++;
 182
 183         pm = nlmsg_data(nlh);
 184
 185         /* Fill in the ulog data */
 186         pm->version = EBT_ULOG_VERSION;
 187         kt = ktime_get_real();
 188         pm->stamp = ktime_to_timeval(kt);
 189         if (ub->qlen == 1)
 190                 ub->skb->tstamp = kt;
 191         pm->data_len = copy_len;
 192         pm->mark = skb->mark;
 193         pm->hook = hooknr;
 194         if (uloginfo->prefix != NULL)
 195                 strcpy(pm->prefix, uloginfo->prefix);
 196         else
 197                 *(pm->prefix) = '\0';
 198
 199         if (in) {
 200                 strcpy(pm->physindev, in->name);
 201                 /* If in isn't a bridge, then physindev==indev */
 202                 if (br_port_exists(in))
 203                         /* rcu_read_lock()ed by nf_hook_slow */
 204                         strcpy(pm->indev, br_port_get_rcu(in)->br->dev->name);
 205                 else
 206                         strcpy(pm->indev, in->name);
 207         } else
 208                 pm->indev[0] = pm->physindev[0] = '\0';
 209
 210         if (out) {
 211                 /* If out exists, then out is a bridge port */
 212                 strcpy(pm->physoutdev, out->name);
 213                 /* rcu_read_lock()ed by nf_hook_slow */
 214                 strcpy(pm->outdev, br_port_get_rcu(out)->br->dev->name);
 215         } else
 216                 pm->outdev[0] = pm->physoutdev[0] = '\0';
 217
 218         if (skb_copy_bits(skb, -ETH_HLEN, pm->data, copy_len) < 0)
 219                 BUG();
 220
 221         if (ub->qlen > 1)
 222                 ub->lastnlh->nlmsg_flags |= NLM_F_MULTI;
 223
 224         ub->lastnlh = nlh;
 225
 226         if (ub->qlen >= uloginfo->qthreshold)
 227                 ulog_send(ebt, group);
 228         else if (!timer_pending(&ub->timer)) {
 229                 ub->timer.expires = jiffies + flushtimeout * HZ / 100;
 230                 add_timer(&ub->timer);
 231         }
 232
 233 unlock:
 234         spin_unlock_bh(lock);
 235 }
 236
 237 /* this function is registered with the netfilter core */
 238 static void ebt_log_packet(struct net *net, u_int8_t pf, unsigned int hooknum,
 239    const struct sk_buff *skb, const struct net_device *in,
 240    const struct net_device *out, const struct nf_loginfo *li,
 241    const char *prefix)
 242 {
 243         struct ebt_ulog_info loginfo;
 244
 245         if (!li || li->type != NF_LOG_TYPE_ULOG) {
 246                 loginfo.nlgroup = EBT_ULOG_DEFAULT_NLGROUP;
 247                 loginfo.cprange = 0;
 248                 loginfo.qthreshold = EBT_ULOG_DEFAULT_QTHRESHOLD;
 249                 loginfo.prefix[0] = '\0';
 250         } else {
 251                 loginfo.nlgroup = li->u.ulog.group;
 252                 loginfo.cprange = li->u.ulog.copy_len;
 253                 loginfo.qthreshold = li->u.ulog.qthreshold;
 254                 strlcpy(loginfo.prefix, prefix, sizeof(loginfo.prefix));
 255         }
 256
 257         ebt_ulog_packet(net, hooknum, skb, in, out, &loginfo, prefix);
 258 }
 259
 260 static unsigned int
 261 ebt_ulog_tg(struct sk_buff *skb, const struct xt_action_param *par)
 262 {
 263         struct net *net = dev_net(par->in ? par->in : par->out);
 264
 265         ebt_ulog_packet(net, par->hooknum, skb, par->in, par->out,
 266                         par->targinfo, NULL);
 267         return EBT_CONTINUE;
 268 }
 269
 270 static int ebt_ulog_tg_check(const struct xt_tgchk_param *par)
 271 {
 272         struct ebt_ulog_info *uloginfo = par->targinfo;
 273
 274         if (!par->net->xt.ebt_ulog_warn_deprecated) {
 275                 pr_info("ebt_ulog is deprecated and it will be removed soon, "
 276                         "use ebt_nflog instead\n");
 277                 par->net->xt.ebt_ulog_warn_deprecated = true;
 278         }
 279
 280         if (uloginfo->nlgroup > 31)
 281                 return -EINVAL;
 282
 283         uloginfo->prefix[EBT_ULOG_PREFIX_LEN - 1] = '\0';
 284
 285         if (uloginfo->qthreshold > EBT_ULOG_MAX_QLEN)
 286                 uloginfo->qthreshold = EBT_ULOG_MAX_QLEN;
 287
 288         return 0;
 289 }
 290
 291 static struct xt_target ebt_ulog_tg_reg __read_mostly = {
 292         .name           = "ulog",
 293         .revision       = 0,
 294         .family         = NFPROTO_BRIDGE,
 295         .target         = ebt_ulog_tg,
 296         .checkentry     = ebt_ulog_tg_check,
 297         .targetsize     = sizeof(struct ebt_ulog_info),
 298         .me             = THIS_MODULE,
 299 };
 300
 301 static struct nf_logger ebt_ulog_logger __read_mostly = {
 302         .name           = "ebt_ulog",
 303         .logfn          = &ebt_log_packet,
 304         .me             = THIS_MODULE,
 305 };
 306
 307 static int __net_init ebt_ulog_net_init(struct net *net)
 308 {
 309         int i;
 310         struct ebt_ulog_net *ebt = ebt_ulog_pernet(net);
 311
 312         struct netlink_kernel_cfg cfg = {
 313                 .groups = EBT_ULOG_MAXNLGROUPS,
 314         };
 315
 316         /* initialize ulog_buffers */
 317         for (i = 0; i < EBT_ULOG_MAXNLGROUPS; i++) {
 318                 ebt->nlgroup[i] = i;
 319                 setup_timer(&ebt->ulog_buffers[i].timer, ulog_timer,
 320                             (unsigned long)&ebt->nlgroup[i]);
 321                 spin_lock_init(&ebt->ulog_buffers[i].lock);
 322         }
 323
 324         ebt->ebtulognl = netlink_kernel_create(net, NETLINK_NFLOG, &cfg);
 325         if (!ebt->ebtulognl)
 326                 return -ENOMEM;
 327
 328         nf_log_set(net, NFPROTO_BRIDGE, &ebt_ulog_logger);
 329         return 0;
 330 }
 331
 332 static void __net_exit ebt_ulog_net_fini(struct net *net)
 333 {
 334         int i;
 335         struct ebt_ulog_net *ebt = ebt_ulog_pernet(net);
 336
 337         nf_log_unset(net, &ebt_ulog_logger);
 338         for (i = 0; i < EBT_ULOG_MAXNLGROUPS; i++) {
 339                 ebt_ulog_buff_t *ub = &ebt->ulog_buffers[i];
 340                 del_timer(&ub->timer);
 341
 342                 if (ub->skb) {
 343                         kfree_skb(ub->skb);
 344                         ub->skb = NULL;
 345                 }
 346         }
 347         netlink_kernel_release(ebt->ebtulognl);
 348 }
 349
 350 static struct pernet_operations ebt_ulog_net_ops = {
 351         .init = ebt_ulog_net_init,
 352         .exit = ebt_ulog_net_fini,
 353         .id   = &ebt_ulog_net_id,
 354         .size = sizeof(struct ebt_ulog_net),
 355 };
 356
 357 static int __init ebt_ulog_init(void)
 358 {
 359         int ret;
 360
 361         if (nlbufsiz >= 128*1024) {
 362                 pr_warn("Netlink buffer has to be <= 128kB,"
 363                         "please try a smaller nlbufsiz parameter.\n");
 364                 return -EINVAL;
 365         }
 366
 367         ret = register_pernet_subsys(&ebt_ulog_net_ops);
 368         if (ret)
 369                 goto out_pernet;
 370
 371         ret = xt_register_target(&ebt_ulog_tg_reg);
 372         if (ret)
 373                 goto out_target;
 374
 375         nf_log_register(NFPROTO_BRIDGE, &ebt_ulog_logger);
 376
 377         return 0;
 378
 379 out_target:
 380         unregister_pernet_subsys(&ebt_ulog_net_ops);
 381 out_pernet:
 382         return ret;
 383 }
 384
 385 static void __exit ebt_ulog_fini(void)
 386 {
 387         nf_log_unregister(&ebt_ulog_logger);
 388         xt_unregister_target(&ebt_ulog_tg_reg);
 389         unregister_pernet_subsys(&ebt_ulog_net_ops);
 390 }
 391
 392 module_init(ebt_ulog_init);
 393 module_exit(ebt_ulog_fini);
 394 MODULE_LICENSE("GPL");
 395 MODULE_AUTHOR("Bart De Schuymer <bdschuym@pandora.be>");
 396 MODULE_DESCRIPTION("Ebtables: Packet logging to netlink using ULOG");