ip_set_hash_ipport.c

Go to the documentation of this file.

/* Copyright (C) 2003-2011 Jozsef Kadlecsik <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

/* Kernel module implementing an IP set type: the hash:ip,port type */

#include <linux/jhash.h>
#include <linux/module.h>
#include <linux/ip.h>
#include <linux/skbuff.h>
#include <linux/errno.h>
#include <linux/random.h>
#include <net/ip.h>
#include <net/ipv6.h>
#include <net/netlink.h>
#include <net/tcp.h>

#include <linux/netfilter.h>
#include <linux/netfilter/ipset/pfxlen.h>
#include <linux/netfilter/ipset/ip_set.h>
#include <linux/netfilter/ipset/ip_set_timeout.h>
#include <linux/netfilter/ipset/ip_set_getport.h>
#include <linux/netfilter/ipset/ip_set_hash.h>

#define REVISION_MIN    0
#define REVISION_MAX    1 /* SCTP and UDPLITE support added */

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Jozsef Kadlecsik <[email protected]>");
IP_SET_MODULE_DESC("hash:ip,port", REVISION_MIN, REVISION_MAX);
MODULE_ALIAS("ip_set_hash:ip,port");

/* Type specific function prefix */
#define TYPE        hash_ipport

static bool
hash_ipport_same_set(const struct ip_set *a, const struct ip_set *b);

#define hash_ipport4_same_set   hash_ipport_same_set
#define hash_ipport6_same_set   hash_ipport_same_set

/* The type variant functions: IPv4 */

/* Member elements without timeout */
struct hash_ipport4_elem {
    __be32 ip;
    __be16 port;
    u8 proto;
    u8 padding;
};

/* Member elements with timeout support */
struct hash_ipport4_telem {
    __be32 ip;
    __be16 port;
    u8 proto;
    u8 padding;
    unsigned long timeout;
};

static inline bool
hash_ipport4_data_equal(const struct hash_ipport4_elem *ip1,
            const struct hash_ipport4_elem *ip2,
            u32 *multi)
{
    return ip1->ip == ip2->ip &&
           ip1->port == ip2->port &&
           ip1->proto == ip2->proto;
}

static inline bool
hash_ipport4_data_isnull(const struct hash_ipport4_elem *elem)
{
    return elem->proto == 0;
}

static inline void
hash_ipport4_data_copy(struct hash_ipport4_elem *dst,
               const struct hash_ipport4_elem *src)
{
    dst->ip = src->ip;
    dst->port = src->port;
    dst->proto = src->proto;
}

static inline void
hash_ipport4_data_zero_out(struct hash_ipport4_elem *elem)
{
    elem->proto = 0;
}

static bool
hash_ipport4_data_list(struct sk_buff *skb,
               const struct hash_ipport4_elem *data)
{
    if (nla_put_ipaddr4(skb, IPSET_ATTR_IP, data->ip) ||
        nla_put_net16(skb, IPSET_ATTR_PORT, data->port) ||
        nla_put_u8(skb, IPSET_ATTR_PROTO, data->proto))
        goto nla_put_failure;
    return 0;

nla_put_failure:
    return 1;
}

static bool
hash_ipport4_data_tlist(struct sk_buff *skb,
            const struct hash_ipport4_elem *data)
{
    const struct hash_ipport4_telem *tdata =
        (const struct hash_ipport4_telem *)data;

    if (nla_put_ipaddr4(skb, IPSET_ATTR_IP, tdata->ip) ||
        nla_put_net16(skb, IPSET_ATTR_PORT, tdata->port) ||
        nla_put_u8(skb, IPSET_ATTR_PROTO, data->proto) ||
        nla_put_net32(skb, IPSET_ATTR_TIMEOUT,
              htonl(ip_set_timeout_get(tdata->timeout))))
        goto nla_put_failure;
    return 0;

nla_put_failure:
    return 1;
}

#define PF      4
#define HOST_MASK   32
#include <linux/netfilter/ipset/ip_set_ahash.h>

static inline void
hash_ipport4_data_next(struct ip_set_hash *h,
               const struct hash_ipport4_elem *d)
{
    h->next.ip = d->ip;
    h->next.port = d->port;
}

static int
hash_ipport4_kadt(struct ip_set *set, const struct sk_buff *skb,
          const struct xt_action_param *par,
          enum ipset_adt adt, const struct ip_set_adt_opt *opt)
{
    const struct ip_set_hash *h = set->data;
    ipset_adtfn adtfn = set->variant->adt[adt];
    struct hash_ipport4_elem data = { };

    if (!ip_set_get_ip4_port(skb, opt->flags & IPSET_DIM_TWO_SRC,
                 &data.port, &data.proto))
        return -EINVAL;

    ip4addrptr(skb, opt->flags & IPSET_DIM_ONE_SRC, &data.ip);

    return adtfn(set, &data, opt_timeout(opt, h), opt->cmdflags);
}

static int
hash_ipport4_uadt(struct ip_set *set, struct nlattr *tb[],
          enum ipset_adt adt, u32 *lineno, u32 flags, bool retried)
{
    const struct ip_set_hash *h = set->data;
    ipset_adtfn adtfn = set->variant->adt[adt];
    struct hash_ipport4_elem data = { };
    u32 ip, ip_to, p = 0, port, port_to;
    u32 timeout = h->timeout;
    bool with_ports = false;
    int ret;

    if (unlikely(!tb[IPSET_ATTR_IP] ||
             !ip_set_attr_netorder(tb, IPSET_ATTR_PORT) ||
             !ip_set_optattr_netorder(tb, IPSET_ATTR_PORT_TO) ||
             !ip_set_optattr_netorder(tb, IPSET_ATTR_TIMEOUT)))
        return -IPSET_ERR_PROTOCOL;

    if (tb[IPSET_ATTR_LINENO])
        *lineno = nla_get_u32(tb[IPSET_ATTR_LINENO]);

    ret = ip_set_get_ipaddr4(tb[IPSET_ATTR_IP], &data.ip);
    if (ret)
        return ret;

    if (tb[IPSET_ATTR_PORT])
        data.port = nla_get_be16(tb[IPSET_ATTR_PORT]);
    else
        return -IPSET_ERR_PROTOCOL;

    if (tb[IPSET_ATTR_PROTO]) {
        data.proto = nla_get_u8(tb[IPSET_ATTR_PROTO]);
        with_ports = ip_set_proto_with_ports(data.proto);

        if (data.proto == 0)
            return -IPSET_ERR_INVALID_PROTO;
    } else
        return -IPSET_ERR_MISSING_PROTO;

    if (!(with_ports || data.proto == IPPROTO_ICMP))
        data.port = 0;

    if (tb[IPSET_ATTR_TIMEOUT]) {
        if (!with_timeout(h->timeout))
            return -IPSET_ERR_TIMEOUT;
        timeout = ip_set_timeout_uget(tb[IPSET_ATTR_TIMEOUT]);
    }

    if (adt == IPSET_TEST ||
        !(tb[IPSET_ATTR_IP_TO] || tb[IPSET_ATTR_CIDR] ||
          tb[IPSET_ATTR_PORT_TO])) {
        ret = adtfn(set, &data, timeout, flags);
        return ip_set_eexist(ret, flags) ? 0 : ret;
    }

    ip_to = ip = ntohl(data.ip);
    if (tb[IPSET_ATTR_IP_TO]) {
        ret = ip_set_get_hostipaddr4(tb[IPSET_ATTR_IP_TO], &ip_to);
        if (ret)
            return ret;
        if (ip > ip_to)
            swap(ip, ip_to);
    } else if (tb[IPSET_ATTR_CIDR]) {
        u8 cidr = nla_get_u8(tb[IPSET_ATTR_CIDR]);

        if (!cidr || cidr > 32)
            return -IPSET_ERR_INVALID_CIDR;
        ip_set_mask_from_to(ip, ip_to, cidr);
    }

    port_to = port = ntohs(data.port);
    if (with_ports && tb[IPSET_ATTR_PORT_TO]) {
        port_to = ip_set_get_h16(tb[IPSET_ATTR_PORT_TO]);
        if (port > port_to)
            swap(port, port_to);
    }

    if (retried)
        ip = ntohl(h->next.ip);
    for (; !before(ip_to, ip); ip++) {
        p = retried && ip == ntohl(h->next.ip) ? ntohs(h->next.port)
                               : port;
        for (; p <= port_to; p++) {
            data.ip = htonl(ip);
            data.port = htons(p);
            ret = adtfn(set, &data, timeout, flags);

            if (ret && !ip_set_eexist(ret, flags))
                return ret;
            else
                ret = 0;
        }
    }
    return ret;
}

static bool
hash_ipport_same_set(const struct ip_set *a, const struct ip_set *b)
{
    const struct ip_set_hash *x = a->data;
    const struct ip_set_hash *y = b->data;

    /* Resizing changes htable_bits, so we ignore it */
    return x->maxelem == y->maxelem &&
           x->timeout == y->timeout;
}

/* The type variant functions: IPv6 */

struct hash_ipport6_elem {
    union nf_inet_addr ip;
    __be16 port;
    u8 proto;
    u8 padding;
};

struct hash_ipport6_telem {
    union nf_inet_addr ip;
    __be16 port;
    u8 proto;
    u8 padding;
    unsigned long timeout;
};

static inline bool
hash_ipport6_data_equal(const struct hash_ipport6_elem *ip1,
            const struct hash_ipport6_elem *ip2,
            u32 *multi)
{
    return ipv6_addr_cmp(&ip1->ip.in6, &ip2->ip.in6) == 0 &&
           ip1->port == ip2->port &&
           ip1->proto == ip2->proto;
}

static inline bool
hash_ipport6_data_isnull(const struct hash_ipport6_elem *elem)
{
    return elem->proto == 0;
}

static inline void
hash_ipport6_data_copy(struct hash_ipport6_elem *dst,
               const struct hash_ipport6_elem *src)
{
    memcpy(dst, src, sizeof(*dst));
}

static inline void
hash_ipport6_data_zero_out(struct hash_ipport6_elem *elem)
{
    elem->proto = 0;
}

static bool
hash_ipport6_data_list(struct sk_buff *skb,
               const struct hash_ipport6_elem *data)
{
    if (nla_put_ipaddr6(skb, IPSET_ATTR_IP, &data->ip.in6) ||
        nla_put_net16(skb, IPSET_ATTR_PORT, data->port) ||
        nla_put_u8(skb, IPSET_ATTR_PROTO, data->proto))
        goto nla_put_failure;
    return 0;

nla_put_failure:
    return 1;
}

static bool
hash_ipport6_data_tlist(struct sk_buff *skb,
            const struct hash_ipport6_elem *data)
{
    const struct hash_ipport6_telem *e =
        (const struct hash_ipport6_telem *)data;

    if (nla_put_ipaddr6(skb, IPSET_ATTR_IP, &e->ip.in6) ||
        nla_put_net16(skb, IPSET_ATTR_PORT, data->port) ||
        nla_put_u8(skb, IPSET_ATTR_PROTO, data->proto) ||
        nla_put_net32(skb, IPSET_ATTR_TIMEOUT,
              htonl(ip_set_timeout_get(e->timeout))))
        goto nla_put_failure;
    return 0;

nla_put_failure:
    return 1;
}

#undef PF
#undef HOST_MASK

#define PF      6
#define HOST_MASK   128
#include <linux/netfilter/ipset/ip_set_ahash.h>

static inline void
hash_ipport6_data_next(struct ip_set_hash *h,
               const struct hash_ipport6_elem *d)
{
    h->next.port = d->port;
}

static int
hash_ipport6_kadt(struct ip_set *set, const struct sk_buff *skb,
          const struct xt_action_param *par,
          enum ipset_adt adt, const struct ip_set_adt_opt *opt)
{
    const struct ip_set_hash *h = set->data;
    ipset_adtfn adtfn = set->variant->adt[adt];
    struct hash_ipport6_elem data = { };

    if (!ip_set_get_ip6_port(skb, opt->flags & IPSET_DIM_TWO_SRC,
                 &data.port, &data.proto))
        return -EINVAL;

    ip6addrptr(skb, opt->flags & IPSET_DIM_ONE_SRC, &data.ip.in6);

    return adtfn(set, &data, opt_timeout(opt, h), opt->cmdflags);
}

static int
hash_ipport6_uadt(struct ip_set *set, struct nlattr *tb[],
          enum ipset_adt adt, u32 *lineno, u32 flags, bool retried)
{
    const struct ip_set_hash *h = set->data;
    ipset_adtfn adtfn = set->variant->adt[adt];
    struct hash_ipport6_elem data = { };
    u32 port, port_to;
    u32 timeout = h->timeout;
    bool with_ports = false;
    int ret;

    if (unlikely(!tb[IPSET_ATTR_IP] ||
             !ip_set_attr_netorder(tb, IPSET_ATTR_PORT) ||
             !ip_set_optattr_netorder(tb, IPSET_ATTR_PORT_TO) ||
             !ip_set_optattr_netorder(tb, IPSET_ATTR_TIMEOUT) ||
             tb[IPSET_ATTR_IP_TO] ||
             tb[IPSET_ATTR_CIDR]))
        return -IPSET_ERR_PROTOCOL;

    if (tb[IPSET_ATTR_LINENO])
        *lineno = nla_get_u32(tb[IPSET_ATTR_LINENO]);

    ret = ip_set_get_ipaddr6(tb[IPSET_ATTR_IP], &data.ip);
    if (ret)
        return ret;

    if (tb[IPSET_ATTR_PORT])
        data.port = nla_get_be16(tb[IPSET_ATTR_PORT]);
    else
        return -IPSET_ERR_PROTOCOL;

    if (tb[IPSET_ATTR_PROTO]) {
        data.proto = nla_get_u8(tb[IPSET_ATTR_PROTO]);
        with_ports = ip_set_proto_with_ports(data.proto);

        if (data.proto == 0)
            return -IPSET_ERR_INVALID_PROTO;
    } else
        return -IPSET_ERR_MISSING_PROTO;

    if (!(with_ports || data.proto == IPPROTO_ICMPV6))
        data.port = 0;

    if (tb[IPSET_ATTR_TIMEOUT]) {
        if (!with_timeout(h->timeout))
            return -IPSET_ERR_TIMEOUT;
        timeout = ip_set_timeout_uget(tb[IPSET_ATTR_TIMEOUT]);
    }

    if (adt == IPSET_TEST || !with_ports || !tb[IPSET_ATTR_PORT_TO]) {
        ret = adtfn(set, &data, timeout, flags);
        return ip_set_eexist(ret, flags) ? 0 : ret;
    }

    port = ntohs(data.port);
    port_to = ip_set_get_h16(tb[IPSET_ATTR_PORT_TO]);
    if (port > port_to)
        swap(port, port_to);

    if (retried)
        port = ntohs(h->next.port);
    for (; port <= port_to; port++) {
        data.port = htons(port);
        ret = adtfn(set, &data, timeout, flags);

        if (ret && !ip_set_eexist(ret, flags))
            return ret;
        else
            ret = 0;
    }
    return ret;
}

/* Create hash:ip type of sets */

static int
hash_ipport_create(struct ip_set *set, struct nlattr *tb[], u32 flags)
{
    struct ip_set_hash *h;
    u32 hashsize = IPSET_DEFAULT_HASHSIZE, maxelem = IPSET_DEFAULT_MAXELEM;
    u8 hbits;
    size_t hsize;

    if (!(set->family == NFPROTO_IPV4 || set->family == NFPROTO_IPV6))
        return -IPSET_ERR_INVALID_FAMILY;

    if (unlikely(!ip_set_optattr_netorder(tb, IPSET_ATTR_HASHSIZE) ||
             !ip_set_optattr_netorder(tb, IPSET_ATTR_MAXELEM) ||
             !ip_set_optattr_netorder(tb, IPSET_ATTR_TIMEOUT)))
        return -IPSET_ERR_PROTOCOL;

    if (tb[IPSET_ATTR_HASHSIZE]) {
        hashsize = ip_set_get_h32(tb[IPSET_ATTR_HASHSIZE]);
        if (hashsize < IPSET_MIMINAL_HASHSIZE)
            hashsize = IPSET_MIMINAL_HASHSIZE;
    }

    if (tb[IPSET_ATTR_MAXELEM])
        maxelem = ip_set_get_h32(tb[IPSET_ATTR_MAXELEM]);

    h = kzalloc(sizeof(*h), GFP_KERNEL);
    if (!h)
        return -ENOMEM;

    h->maxelem = maxelem;
    get_random_bytes(&h->initval, sizeof(h->initval));
    h->timeout = IPSET_NO_TIMEOUT;

    hbits = htable_bits(hashsize);
    hsize = htable_size(hbits);
    if (hsize == 0) {
        kfree(h);
        return -ENOMEM;
    }
    h->table = ip_set_alloc(hsize);
    if (!h->table) {
        kfree(h);
        return -ENOMEM;
    }
    h->table->htable_bits = hbits;

    set->data = h;

    if (tb[IPSET_ATTR_TIMEOUT]) {
        h->timeout = ip_set_timeout_uget(tb[IPSET_ATTR_TIMEOUT]);

        set->variant = set->family == NFPROTO_IPV4
            ? &hash_ipport4_tvariant : &hash_ipport6_tvariant;

        if (set->family == NFPROTO_IPV4)
            hash_ipport4_gc_init(set);
        else
            hash_ipport6_gc_init(set);
    } else {
        set->variant = set->family == NFPROTO_IPV4
            ? &hash_ipport4_variant : &hash_ipport6_variant;
    }

    pr_debug("create %s hashsize %u (%u) maxelem %u: %p(%p)\n",
         set->name, jhash_size(h->table->htable_bits),
         h->table->htable_bits, h->maxelem, set->data, h->table);

    return 0;
}

static struct ip_set_type hash_ipport_type __read_mostly = {
    .name       = "hash:ip,port",
    .protocol   = IPSET_PROTOCOL,
    .features   = IPSET_TYPE_IP | IPSET_TYPE_PORT,
    .dimension  = IPSET_DIM_TWO,
    .family     = NFPROTO_UNSPEC,
    .revision_min   = REVISION_MIN,
    .revision_max   = REVISION_MAX,
    .create     = hash_ipport_create,
    .create_policy  = {
        [IPSET_ATTR_HASHSIZE]   = { .type = NLA_U32 },
        [IPSET_ATTR_MAXELEM]    = { .type = NLA_U32 },
        [IPSET_ATTR_PROBES] = { .type = NLA_U8 },
        [IPSET_ATTR_RESIZE] = { .type = NLA_U8  },
        [IPSET_ATTR_PROTO]  = { .type = NLA_U8 },
        [IPSET_ATTR_TIMEOUT]    = { .type = NLA_U32 },
    },
    .adt_policy = {
        [IPSET_ATTR_IP]     = { .type = NLA_NESTED },
        [IPSET_ATTR_IP_TO]  = { .type = NLA_NESTED },
        [IPSET_ATTR_PORT]   = { .type = NLA_U16 },
        [IPSET_ATTR_PORT_TO]    = { .type = NLA_U16 },
        [IPSET_ATTR_CIDR]   = { .type = NLA_U8 },
        [IPSET_ATTR_PROTO]  = { .type = NLA_U8 },
        [IPSET_ATTR_TIMEOUT]    = { .type = NLA_U32 },
        [IPSET_ATTR_LINENO] = { .type = NLA_U32 },
    },
    .me     = THIS_MODULE,
};

static int __init
hash_ipport_init(void)
{
    return ip_set_type_register(&hash_ipport_type);
}

static void __exit
hash_ipport_fini(void)
{
    ip_set_type_unregister(&hash_ipport_type);
}

module_init(hash_ipport_init);
module_exit(hash_ipport_fini);