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 <linux/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/sock.h>
  45 #include "../br_private.h"
  46
  47 static unsigned int nlbufsiz = NLMSG_GOODSIZE;
  48 module_param(nlbufsiz, uint, 0600);
  49 MODULE_PARM_DESC(nlbufsiz, "netlink buffer size (number of bytes) "
  50                            "(defaults to 4096)");
  51
  52 static unsigned int flushtimeout = 10;
  53 module_param(flushtimeout, uint, 0600);
  54 MODULE_PARM_DESC(flushtimeout, "buffer flush timeout (hundredths ofa second) "
  55                                "(defaults to 10)");
  56
  57 typedef struct {
  58         unsigned int qlen;              /* number of nlmsgs' in the skb */
  59         struct nlmsghdr *lastnlh;       /* netlink header of last msg in skb */
  60         struct sk_buff *skb;            /* the pre-allocated skb */
  61         struct timer_list timer;        /* the timer function */
  62         spinlock_t lock;                /* the per-queue lock */
  63 } ebt_ulog_buff_t;
  64
  65 static ebt_ulog_buff_t ulog_buffers[EBT_ULOG_MAXNLGROUPS];
  66 static struct sock *ebtulognl;
  67
  68 /* send one ulog_buff_t to userspace */
  69 static void ulog_send(unsigned int nlgroup)
  70 {
  71         ebt_ulog_buff_t *ub = &ulog_buffers[nlgroup];
  72
  73         del_timer(&ub->timer);
  74
  75         if (!ub->skb)
  76                 return;
  77
  78         /* last nlmsg needs NLMSG_DONE */
  79         if (ub->qlen > 1)
  80                 ub->lastnlh->nlmsg_type = NLMSG_DONE;
  81
  82         NETLINK_CB(ub->skb).dst_group = nlgroup + 1;
  83         netlink_broadcast(ebtulognl, ub->skb, 0, nlgroup + 1, GFP_ATOMIC);
  84
  85         ub->qlen = 0;
  86         ub->skb = NULL;
  87 }
  88
  89 /* timer function to flush queue in flushtimeout time */
  90 static void ulog_timer(unsigned long data)
  91 {
  92         spin_lock_bh(&ulog_buffers[data].lock);
  93         if (ulog_buffers[data].skb)
  94                 ulog_send(data);
  95         spin_unlock_bh(&ulog_buffers[data].lock);
  96 }
  97
  98 static struct sk_buff *ulog_alloc_skb(unsigned int size)
  99 {
 100         struct sk_buff *skb;
 101         unsigned int n;
 102
 103         n = max(size, nlbufsiz);
 104         skb = alloc_skb(n, GFP_ATOMIC | __GFP_NOWARN);
 105         if (!skb) {
 106                 if (n > size) {
 107                         /* try to allocate only as much as we need for
 108                          * current packet */
 109                         skb = alloc_skb(size, GFP_ATOMIC);
 110                         if (!skb)
 111                                 pr_debug("cannot even allocate buffer of size %ub\n",
 112                                          size);
 113                 }
 114         }
 115
 116         return skb;
 117 }
 118
 119 static void ebt_ulog_packet(unsigned int hooknr, const struct sk_buff *skb,
 120    const struct net_device *in, const struct net_device *out,
 121    const struct ebt_ulog_info *uloginfo, const char *prefix)
 122 {
 123         ebt_ulog_packet_msg_t *pm;
 124         size_t size, copy_len;
 125         struct nlmsghdr *nlh;
 126         unsigned int group = uloginfo->nlgroup;
 127         ebt_ulog_buff_t *ub = &ulog_buffers[group];
 128         spinlock_t *lock = &ub->lock;
 129         ktime_t kt;
 130
 131         if ((uloginfo->cprange == 0) ||
 132             (uloginfo->cprange > skb->len + ETH_HLEN))
 133                 copy_len = skb->len + ETH_HLEN;
 134         else
 135                 copy_len = uloginfo->cprange;
 136
 137         size = NLMSG_SPACE(sizeof(*pm) + copy_len);
 138         if (size > nlbufsiz) {
 139                 pr_debug("Size %Zd needed, but nlbufsiz=%d\n", size, nlbufsiz);
 140                 return;
 141         }
 142
 143         spin_lock_bh(lock);
 144
 145         if (!ub->skb) {
 146                 if (!(ub->skb = ulog_alloc_skb(size)))
 147                         goto unlock;
 148         } else if (size > skb_tailroom(ub->skb)) {
 149                 ulog_send(group);
 150
 151                 if (!(ub->skb = ulog_alloc_skb(size)))
 152                         goto unlock;
 153         }
 154
 155         nlh = nlmsg_put(ub->skb, 0, ub->qlen, 0,
 156                         size - NLMSG_ALIGN(sizeof(*nlh)), 0);
 157         if (!nlh) {
 158                 kfree_skb(ub->skb);
 159                 ub->skb = NULL;
 160                 goto unlock;
 161         }
 162         ub->qlen++;
 163
 164         pm = nlmsg_data(nlh);
 165
 166         /* Fill in the ulog data */
 167         pm->version = EBT_ULOG_VERSION;
 168         kt = ktime_get_real();
 169         pm->stamp = ktime_to_timeval(kt);
 170         if (ub->qlen == 1)
 171                 ub->skb->tstamp = kt;
 172         pm->data_len = copy_len;
 173         pm->mark = skb->mark;
 174         pm->hook = hooknr;
 175         if (uloginfo->prefix != NULL)
 176                 strcpy(pm->prefix, uloginfo->prefix);
 177         else
 178                 *(pm->prefix) = '\0';
 179
 180         if (in) {
 181                 strcpy(pm->physindev, in->name);
 182                 /* If in isn't a bridge, then physindev==indev */
 183                 if (br_port_exists(in))
 184                         /* rcu_read_lock()ed by nf_hook_slow */
 185                         strcpy(pm->indev, br_port_get_rcu(in)->br->dev->name);
 186                 else
 187                         strcpy(pm->indev, in->name);
 188         } else
 189                 pm->indev[0] = pm->physindev[0] = '\0';
 190
 191         if (out) {
 192                 /* If out exists, then out is a bridge port */
 193                 strcpy(pm->physoutdev, out->name);
 194                 /* rcu_read_lock()ed by nf_hook_slow */
 195                 strcpy(pm->outdev, br_port_get_rcu(out)->br->dev->name);
 196         } else
 197                 pm->outdev[0] = pm->physoutdev[0] = '\0';
 198
 199         if (skb_copy_bits(skb, -ETH_HLEN, pm->data, copy_len) < 0)
 200                 BUG();
 201
 202         if (ub->qlen > 1)
 203                 ub->lastnlh->nlmsg_flags |= NLM_F_MULTI;
 204
 205         ub->lastnlh = nlh;
 206
 207         if (ub->qlen >= uloginfo->qthreshold)
 208                 ulog_send(group);
 209         else if (!timer_pending(&ub->timer)) {
 210                 ub->timer.expires = jiffies + flushtimeout * HZ / 100;
 211                 add_timer(&ub->timer);
 212         }
 213
 214 unlock:
 215         spin_unlock_bh(lock);
 216 }
 217
 218 /* this function is registered with the netfilter core */
 219 static void ebt_log_packet(u_int8_t pf, unsigned int hooknum,
 220    const struct sk_buff *skb, const struct net_device *in,
 221    const struct net_device *out, const struct nf_loginfo *li,
 222    const char *prefix)
 223 {
 224         struct ebt_ulog_info loginfo;
 225
 226         if (!li || li->type != NF_LOG_TYPE_ULOG) {
 227                 loginfo.nlgroup = EBT_ULOG_DEFAULT_NLGROUP;
 228                 loginfo.cprange = 0;
 229                 loginfo.qthreshold = EBT_ULOG_DEFAULT_QTHRESHOLD;
 230                 loginfo.prefix[0] = '\0';
 231         } else {
 232                 loginfo.nlgroup = li->u.ulog.group;
 233                 loginfo.cprange = li->u.ulog.copy_len;
 234                 loginfo.qthreshold = li->u.ulog.qthreshold;
 235                 strlcpy(loginfo.prefix, prefix, sizeof(loginfo.prefix));
 236         }
 237
 238         ebt_ulog_packet(hooknum, skb, in, out, &loginfo, prefix);
 239 }
 240
 241 static unsigned int
 242 ebt_ulog_tg(struct sk_buff *skb, const struct xt_action_param *par)
 243 {
 244         ebt_ulog_packet(par->hooknum, skb, par->in, par->out,
 245                         par->targinfo, NULL);
 246         return EBT_CONTINUE;
 247 }
 248
 249 static int ebt_ulog_tg_check(const struct xt_tgchk_param *par)
 250 {
 251         struct ebt_ulog_info *uloginfo = par->targinfo;
 252
 253         if (uloginfo->nlgroup > 31)
 254                 return -EINVAL;
 255
 256         uloginfo->prefix[EBT_ULOG_PREFIX_LEN - 1] = '\0';
 257
 258         if (uloginfo->qthreshold > EBT_ULOG_MAX_QLEN)
 259                 uloginfo->qthreshold = EBT_ULOG_MAX_QLEN;
 260
 261         return 0;
 262 }
 263
 264 static struct xt_target ebt_ulog_tg_reg __read_mostly = {
 265         .name           = "ulog",
 266         .revision       = 0,
 267         .family         = NFPROTO_BRIDGE,
 268         .target         = ebt_ulog_tg,
 269         .checkentry     = ebt_ulog_tg_check,
 270         .targetsize     = sizeof(struct ebt_ulog_info),
 271         .me             = THIS_MODULE,
 272 };
 273
 274 static struct nf_logger ebt_ulog_logger __read_mostly = {
 275         .name           = "ebt_ulog",
 276         .logfn          = &ebt_log_packet,
 277         .me             = THIS_MODULE,
 278 };
 279
 280 static int __init ebt_ulog_init(void)
 281 {
 282         int ret;
 283         int i;
 284         struct netlink_kernel_cfg cfg = {
 285                 .groups = EBT_ULOG_MAXNLGROUPS,
 286         };
 287
 288         if (nlbufsiz >= 128*1024) {
 289                 pr_warning("Netlink buffer has to be <= 128kB,"
 290                            " please try a smaller nlbufsiz parameter.\n");
 291                 return -EINVAL;
 292         }
 293
 294         /* initialize ulog_buffers */
 295         for (i = 0; i < EBT_ULOG_MAXNLGROUPS; i++) {
 296                 setup_timer(&ulog_buffers[i].timer, ulog_timer, i);
 297                 spin_lock_init(&ulog_buffers[i].lock);
 298         }
 299
 300         ebtulognl = netlink_kernel_create(&init_net, NETLINK_NFLOG, &cfg);
 301         if (!ebtulognl)
 302                 ret = -ENOMEM;
 303         else if ((ret = xt_register_target(&ebt_ulog_tg_reg)) != 0)
 304                 netlink_kernel_release(ebtulognl);
 305
 306         if (ret == 0)
 307                 nf_log_register(NFPROTO_BRIDGE, &ebt_ulog_logger);
 308
 309         return ret;
 310 }
 311
 312 static void __exit ebt_ulog_fini(void)
 313 {
 314         ebt_ulog_buff_t *ub;
 315         int i;
 316
 317         nf_log_unregister(&ebt_ulog_logger);
 318         xt_unregister_target(&ebt_ulog_tg_reg);
 319         for (i = 0; i < EBT_ULOG_MAXNLGROUPS; i++) {
 320                 ub = &ulog_buffers[i];
 321                 del_timer(&ub->timer);
 322                 spin_lock_bh(&ub->lock);
 323                 if (ub->skb) {
 324                         kfree_skb(ub->skb);
 325                         ub->skb = NULL;
 326                 }
 327                 spin_unlock_bh(&ub->lock);
 328         }
 329         netlink_kernel_release(ebtulognl);
 330 }
 331
 332 module_init(ebt_ulog_init);
 333 module_exit(ebt_ulog_fini);
 334 MODULE_LICENSE("GPL");
 335 MODULE_AUTHOR("Bart De Schuymer <bdschuym@pandora.be>");
 336 MODULE_DESCRIPTION("Ebtables: Packet logging to netlink using ULOG");