root/net/netfilter/ipset/ip_set_hash_ipmark.c
// SPDX-License-Identifier: GPL-2.0-only
/* Copyright (C) 2003-2013 Jozsef Kadlecsik <kadlec@netfilter.org> */

/* Kernel module implementing an IP set type: the hash:ip,mark 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_hash.h>

#define IPSET_TYPE_REV_MIN      0
/*                              1          Forceadd support */
/*                              2          skbinfo support */
#define IPSET_TYPE_REV_MAX      3       /* bucketsize, initval support  */

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Vytas Dauksa <vytas.dauksa@smoothwall.net>");
IP_SET_MODULE_DESC("hash:ip,mark", IPSET_TYPE_REV_MIN, IPSET_TYPE_REV_MAX);
MODULE_ALIAS("ip_set_hash:ip,mark");

/* Type specific function prefix */
#define HTYPE           hash_ipmark
#define IP_SET_HASH_WITH_MARKMASK

/* IPv4 variant */

/* Member elements */
struct hash_ipmark4_elem {
        __be32 ip;
        __u32 mark;
};

/* Common functions */

static bool
hash_ipmark4_data_equal(const struct hash_ipmark4_elem *ip1,
                        const struct hash_ipmark4_elem *ip2,
                        u32 *multi)
{
        return ip1->ip == ip2->ip &&
               ip1->mark == ip2->mark;
}

static bool
hash_ipmark4_data_list(struct sk_buff *skb,
                       const struct hash_ipmark4_elem *data)
{
        if (nla_put_ipaddr4(skb, IPSET_ATTR_IP, data->ip) ||
            nla_put_net32(skb, IPSET_ATTR_MARK, htonl(data->mark)))
                goto nla_put_failure;
        return false;

nla_put_failure:
        return true;
}

static void
hash_ipmark4_data_next(struct hash_ipmark4_elem *next,
                       const struct hash_ipmark4_elem *d)
{
        next->ip = d->ip;
}

#define MTYPE           hash_ipmark4
#define HOST_MASK       32
#include "ip_set_hash_gen.h"

static int
hash_ipmark4_kadt(struct ip_set *set, const struct sk_buff *skb,
                  const struct xt_action_param *par,
                  enum ipset_adt adt, struct ip_set_adt_opt *opt)
{
        const struct hash_ipmark4 *h = set->data;
        ipset_adtfn adtfn = set->variant->adt[adt];
        struct hash_ipmark4_elem e = { };
        struct ip_set_ext ext = IP_SET_INIT_KEXT(skb, opt, set);

        e.mark = skb->mark;
        e.mark &= h->markmask;

        ip4addrptr(skb, opt->flags & IPSET_DIM_ONE_SRC, &e.ip);
        return adtfn(set, &e, &ext, &opt->ext, opt->cmdflags);
}

static int
hash_ipmark4_uadt(struct ip_set *set, struct nlattr *tb[],
                  enum ipset_adt adt, u32 *lineno, u32 flags, bool retried)
{
        struct hash_ipmark4 *h = set->data;
        ipset_adtfn adtfn = set->variant->adt[adt];
        struct hash_ipmark4_elem e = { };
        struct ip_set_ext ext = IP_SET_INIT_UEXT(set);
        u32 ip, ip_to = 0, i = 0;
        int ret;

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

        if (unlikely(!tb[IPSET_ATTR_IP] ||
                     !ip_set_attr_netorder(tb, IPSET_ATTR_MARK)))
                return -IPSET_ERR_PROTOCOL;

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

        ret = ip_set_get_extensions(set, tb, &ext);
        if (ret)
                return ret;

        e.mark = ntohl(nla_get_be32(tb[IPSET_ATTR_MARK]));
        e.mark &= h->markmask;
        if (e.mark == 0 && e.ip == 0)
                return -IPSET_ERR_HASH_ELEM;

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

        ip_to = ip = ntohl(e.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) {
                        if (e.mark == 0 && ip_to == 0)
                                return -IPSET_ERR_HASH_ELEM;
                        swap(ip, ip_to);
                }
        } else if (tb[IPSET_ATTR_CIDR]) {
                u8 cidr = nla_get_u8(tb[IPSET_ATTR_CIDR]);

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

        if (retried)
                ip = ntohl(h->next.ip);
        for (; ip <= ip_to; ip++, i++) {
                e.ip = htonl(ip);
                if (i > IPSET_MAX_RANGE) {
                        hash_ipmark4_data_next(&h->next, &e);
                        return -ERANGE;
                }
                ret = adtfn(set, &e, &ext, &ext, flags);

                if (ret && !ip_set_eexist(ret, flags))
                        return ret;

                ret = 0;
        }
        return ret;
}

/* IPv6 variant */

struct hash_ipmark6_elem {
        union nf_inet_addr ip;
        __u32 mark;
};

/* Common functions */

static bool
hash_ipmark6_data_equal(const struct hash_ipmark6_elem *ip1,
                        const struct hash_ipmark6_elem *ip2,
                        u32 *multi)
{
        return ipv6_addr_equal(&ip1->ip.in6, &ip2->ip.in6) &&
               ip1->mark == ip2->mark;
}

static bool
hash_ipmark6_data_list(struct sk_buff *skb,
                       const struct hash_ipmark6_elem *data)
{
        if (nla_put_ipaddr6(skb, IPSET_ATTR_IP, &data->ip.in6) ||
            nla_put_net32(skb, IPSET_ATTR_MARK, htonl(data->mark)))
                goto nla_put_failure;
        return false;

nla_put_failure:
        return true;
}

static void
hash_ipmark6_data_next(struct hash_ipmark6_elem *next,
                       const struct hash_ipmark6_elem *d)
{
}

#undef MTYPE
#undef HOST_MASK

#define MTYPE           hash_ipmark6
#define HOST_MASK       128
#define IP_SET_EMIT_CREATE
#include "ip_set_hash_gen.h"

static int
hash_ipmark6_kadt(struct ip_set *set, const struct sk_buff *skb,
                  const struct xt_action_param *par,
                  enum ipset_adt adt, struct ip_set_adt_opt *opt)
{
        const struct hash_ipmark6 *h = set->data;
        ipset_adtfn adtfn = set->variant->adt[adt];
        struct hash_ipmark6_elem e = { };
        struct ip_set_ext ext = IP_SET_INIT_KEXT(skb, opt, set);

        e.mark = skb->mark;
        e.mark &= h->markmask;

        ip6addrptr(skb, opt->flags & IPSET_DIM_ONE_SRC, &e.ip.in6);
        return adtfn(set, &e, &ext, &opt->ext, opt->cmdflags);
}

static int
hash_ipmark6_uadt(struct ip_set *set, struct nlattr *tb[],
                  enum ipset_adt adt, u32 *lineno, u32 flags, bool retried)
{
        const struct hash_ipmark6 *h = set->data;
        ipset_adtfn adtfn = set->variant->adt[adt];
        struct hash_ipmark6_elem e = { };
        struct ip_set_ext ext = IP_SET_INIT_UEXT(set);
        int ret;

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

        if (unlikely(!tb[IPSET_ATTR_IP] ||
                     !ip_set_attr_netorder(tb, IPSET_ATTR_MARK)))
                return -IPSET_ERR_PROTOCOL;
        if (unlikely(tb[IPSET_ATTR_IP_TO]))
                return -IPSET_ERR_HASH_RANGE_UNSUPPORTED;
        if (unlikely(tb[IPSET_ATTR_CIDR])) {
                u8 cidr = nla_get_u8(tb[IPSET_ATTR_CIDR]);

                if (cidr != HOST_MASK)
                        return -IPSET_ERR_INVALID_CIDR;
        }

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

        ret = ip_set_get_extensions(set, tb, &ext);
        if (ret)
                return ret;

        e.mark = ntohl(nla_get_be32(tb[IPSET_ATTR_MARK]));
        e.mark &= h->markmask;

        if (adt == IPSET_TEST) {
                ret = adtfn(set, &e, &ext, &ext, flags);
                return ip_set_eexist(ret, flags) ? 0 : ret;
        }

        ret = adtfn(set, &e, &ext, &ext, flags);
        if (ret && !ip_set_eexist(ret, flags))
                return ret;

        return 0;
}

static struct ip_set_type hash_ipmark_type __read_mostly = {
        .name           = "hash:ip,mark",
        .protocol       = IPSET_PROTOCOL,
        .features       = IPSET_TYPE_IP | IPSET_TYPE_MARK,
        .dimension      = IPSET_DIM_TWO,
        .family         = NFPROTO_UNSPEC,
        .revision_min   = IPSET_TYPE_REV_MIN,
        .revision_max   = IPSET_TYPE_REV_MAX,
        .create_flags[IPSET_TYPE_REV_MAX] = IPSET_CREATE_FLAG_BUCKETSIZE,
        .create         = hash_ipmark_create,
        .create_policy  = {
                [IPSET_ATTR_MARKMASK]   = { .type = NLA_U32 },
                [IPSET_ATTR_HASHSIZE]   = { .type = NLA_U32 },
                [IPSET_ATTR_MAXELEM]    = { .type = NLA_U32 },
                [IPSET_ATTR_INITVAL]    = { .type = NLA_U32 },
                [IPSET_ATTR_BUCKETSIZE] = { .type = NLA_U8 },
                [IPSET_ATTR_RESIZE]     = { .type = NLA_U8  },
                [IPSET_ATTR_TIMEOUT]    = { .type = NLA_U32 },
                [IPSET_ATTR_CADT_FLAGS] = { .type = NLA_U32 },
        },
        .adt_policy     = {
                [IPSET_ATTR_IP]         = { .type = NLA_NESTED },
                [IPSET_ATTR_IP_TO]      = { .type = NLA_NESTED },
                [IPSET_ATTR_MARK]       = { .type = NLA_U32 },
                [IPSET_ATTR_CIDR]       = { .type = NLA_U8 },
                [IPSET_ATTR_TIMEOUT]    = { .type = NLA_U32 },
                [IPSET_ATTR_LINENO]     = { .type = NLA_U32 },
                [IPSET_ATTR_BYTES]      = { .type = NLA_U64 },
                [IPSET_ATTR_PACKETS]    = { .type = NLA_U64 },
                [IPSET_ATTR_COMMENT]    = { .type = NLA_NUL_STRING,
                                            .len  = IPSET_MAX_COMMENT_SIZE },
                [IPSET_ATTR_SKBMARK]    = { .type = NLA_U64 },
                [IPSET_ATTR_SKBPRIO]    = { .type = NLA_U32 },
                [IPSET_ATTR_SKBQUEUE]   = { .type = NLA_U16 },
        },
        .me             = THIS_MODULE,
};

static int __init
hash_ipmark_init(void)
{
        return ip_set_type_register(&hash_ipmark_type);
}

static void __exit
hash_ipmark_fini(void)
{
        rcu_barrier();
        ip_set_type_unregister(&hash_ipmark_type);
}

module_init(hash_ipmark_init);
module_exit(hash_ipmark_fini);