ip_set.h

Go to the documentation of this file.

/* Copyright (C) 2000-2002 Joakim Axelsson <[email protected]>
 *                         Patrick Schaaf <[email protected]>
 *                         Martin Josefsson <[email protected]>
 * 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.
 */
#ifndef _UAPI_IP_SET_H
#define _UAPI_IP_SET_H


#include <linux/types.h>

/* The protocol version */
#define IPSET_PROTOCOL      6

/* The max length of strings including NUL: set and type identifiers */
#define IPSET_MAXNAMELEN    32

/* Message types and commands */
enum ipset_cmd {
    IPSET_CMD_NONE,
    IPSET_CMD_PROTOCOL, /* 1: Return protocol version */
    IPSET_CMD_CREATE,   /* 2: Create a new (empty) set */
    IPSET_CMD_DESTROY,  /* 3: Destroy a (empty) set */
    IPSET_CMD_FLUSH,    /* 4: Remove all elements from a set */
    IPSET_CMD_RENAME,   /* 5: Rename a set */
    IPSET_CMD_SWAP,     /* 6: Swap two sets */
    IPSET_CMD_LIST,     /* 7: List sets */
    IPSET_CMD_SAVE,     /* 8: Save sets */
    IPSET_CMD_ADD,      /* 9: Add an element to a set */
    IPSET_CMD_DEL,      /* 10: Delete an element from a set */
    IPSET_CMD_TEST,     /* 11: Test an element in a set */
    IPSET_CMD_HEADER,   /* 12: Get set header data only */
    IPSET_CMD_TYPE,     /* 13: Get set type */
    IPSET_MSG_MAX,      /* Netlink message commands */

    /* Commands in userspace: */
    IPSET_CMD_RESTORE = IPSET_MSG_MAX, /* 14: Enter restore mode */
    IPSET_CMD_HELP,     /* 15: Get help */
    IPSET_CMD_VERSION,  /* 16: Get program version */
    IPSET_CMD_QUIT,     /* 17: Quit from interactive mode */

    IPSET_CMD_MAX,

    IPSET_CMD_COMMIT = IPSET_CMD_MAX, /* 18: Commit buffered commands */
};

/* Attributes at command level */
enum {
    IPSET_ATTR_UNSPEC,
    IPSET_ATTR_PROTOCOL,    /* 1: Protocol version */
    IPSET_ATTR_SETNAME, /* 2: Name of the set */
    IPSET_ATTR_TYPENAME,    /* 3: Typename */
    IPSET_ATTR_SETNAME2 = IPSET_ATTR_TYPENAME, /* Setname at rename/swap */
    IPSET_ATTR_REVISION,    /* 4: Settype revision */
    IPSET_ATTR_FAMILY,  /* 5: Settype family */
    IPSET_ATTR_FLAGS,   /* 6: Flags at command level */
    IPSET_ATTR_DATA,    /* 7: Nested attributes */
    IPSET_ATTR_ADT,     /* 8: Multiple data containers */
    IPSET_ATTR_LINENO,  /* 9: Restore lineno */
    IPSET_ATTR_PROTOCOL_MIN, /* 10: Minimal supported version number */
    IPSET_ATTR_REVISION_MIN = IPSET_ATTR_PROTOCOL_MIN, /* type rev min */
    __IPSET_ATTR_CMD_MAX,
};
#define IPSET_ATTR_CMD_MAX  (__IPSET_ATTR_CMD_MAX - 1)

/* CADT specific attributes */
enum {
    IPSET_ATTR_IP = IPSET_ATTR_UNSPEC + 1,
    IPSET_ATTR_IP_FROM = IPSET_ATTR_IP,
    IPSET_ATTR_IP_TO,   /* 2 */
    IPSET_ATTR_CIDR,    /* 3 */
    IPSET_ATTR_PORT,    /* 4 */
    IPSET_ATTR_PORT_FROM = IPSET_ATTR_PORT,
    IPSET_ATTR_PORT_TO, /* 5 */
    IPSET_ATTR_TIMEOUT, /* 6 */
    IPSET_ATTR_PROTO,   /* 7 */
    IPSET_ATTR_CADT_FLAGS,  /* 8 */
    IPSET_ATTR_CADT_LINENO = IPSET_ATTR_LINENO, /* 9 */
    /* Reserve empty slots */
    IPSET_ATTR_CADT_MAX = 16,
    /* Create-only specific attributes */
    IPSET_ATTR_GC,
    IPSET_ATTR_HASHSIZE,
    IPSET_ATTR_MAXELEM,
    IPSET_ATTR_NETMASK,
    IPSET_ATTR_PROBES,
    IPSET_ATTR_RESIZE,
    IPSET_ATTR_SIZE,
    /* Kernel-only */
    IPSET_ATTR_ELEMENTS,
    IPSET_ATTR_REFERENCES,
    IPSET_ATTR_MEMSIZE,

    __IPSET_ATTR_CREATE_MAX,
};
#define IPSET_ATTR_CREATE_MAX   (__IPSET_ATTR_CREATE_MAX - 1)

/* ADT specific attributes */
enum {
    IPSET_ATTR_ETHER = IPSET_ATTR_CADT_MAX + 1,
    IPSET_ATTR_NAME,
    IPSET_ATTR_NAMEREF,
    IPSET_ATTR_IP2,
    IPSET_ATTR_CIDR2,
    IPSET_ATTR_IP2_TO,
    IPSET_ATTR_IFACE,
    __IPSET_ATTR_ADT_MAX,
};
#define IPSET_ATTR_ADT_MAX  (__IPSET_ATTR_ADT_MAX - 1)

/* IP specific attributes */
enum {
    IPSET_ATTR_IPADDR_IPV4 = IPSET_ATTR_UNSPEC + 1,
    IPSET_ATTR_IPADDR_IPV6,
    __IPSET_ATTR_IPADDR_MAX,
};
#define IPSET_ATTR_IPADDR_MAX   (__IPSET_ATTR_IPADDR_MAX - 1)

/* Error codes */
enum ipset_errno {
    IPSET_ERR_PRIVATE = 4096,
    IPSET_ERR_PROTOCOL,
    IPSET_ERR_FIND_TYPE,
    IPSET_ERR_MAX_SETS,
    IPSET_ERR_BUSY,
    IPSET_ERR_EXIST_SETNAME2,
    IPSET_ERR_TYPE_MISMATCH,
    IPSET_ERR_EXIST,
    IPSET_ERR_INVALID_CIDR,
    IPSET_ERR_INVALID_NETMASK,
    IPSET_ERR_INVALID_FAMILY,
    IPSET_ERR_TIMEOUT,
    IPSET_ERR_REFERENCED,
    IPSET_ERR_IPADDR_IPV4,
    IPSET_ERR_IPADDR_IPV6,

    /* Type specific error codes */
    IPSET_ERR_TYPE_SPECIFIC = 4352,
};

/* Flags at command level */
enum ipset_cmd_flags {
    IPSET_FLAG_BIT_EXIST    = 0,
    IPSET_FLAG_EXIST    = (1 << IPSET_FLAG_BIT_EXIST),
    IPSET_FLAG_BIT_LIST_SETNAME = 1,
    IPSET_FLAG_LIST_SETNAME = (1 << IPSET_FLAG_BIT_LIST_SETNAME),
    IPSET_FLAG_BIT_LIST_HEADER = 2,
    IPSET_FLAG_LIST_HEADER  = (1 << IPSET_FLAG_BIT_LIST_HEADER),
    IPSET_FLAG_CMD_MAX = 15,    /* Lower half */
};

/* Flags at CADT attribute level */
enum ipset_cadt_flags {
    IPSET_FLAG_BIT_BEFORE   = 0,
    IPSET_FLAG_BEFORE   = (1 << IPSET_FLAG_BIT_BEFORE),
    IPSET_FLAG_BIT_PHYSDEV  = 1,
    IPSET_FLAG_PHYSDEV  = (1 << IPSET_FLAG_BIT_PHYSDEV),
    IPSET_FLAG_BIT_NOMATCH  = 2,
    IPSET_FLAG_NOMATCH  = (1 << IPSET_FLAG_BIT_NOMATCH),
    IPSET_FLAG_CADT_MAX = 15,   /* Upper half */
};

/* Commands with settype-specific attributes */
enum ipset_adt {
    IPSET_ADD,
    IPSET_DEL,
    IPSET_TEST,
    IPSET_ADT_MAX,
    IPSET_CREATE = IPSET_ADT_MAX,
    IPSET_CADT_MAX,
};

/* Sets are identified by an index in kernel space. Tweak with ip_set_id_t
 * and IPSET_INVALID_ID if you want to increase the max number of sets.
 */
typedef __u16 ip_set_id_t;

#define IPSET_INVALID_ID        65535

enum ip_set_dim {
    IPSET_DIM_ZERO = 0,
    IPSET_DIM_ONE,
    IPSET_DIM_TWO,
    IPSET_DIM_THREE,
    /* Max dimension in elements.
     * If changed, new revision of iptables match/target is required.
     */
    IPSET_DIM_MAX = 6,
    IPSET_BIT_RETURN_NOMATCH = 7,
};

/* Option flags for kernel operations */
enum ip_set_kopt {
    IPSET_INV_MATCH = (1 << IPSET_DIM_ZERO),
    IPSET_DIM_ONE_SRC = (1 << IPSET_DIM_ONE),
    IPSET_DIM_TWO_SRC = (1 << IPSET_DIM_TWO),
    IPSET_DIM_THREE_SRC = (1 << IPSET_DIM_THREE),
    IPSET_RETURN_NOMATCH = (1 << IPSET_BIT_RETURN_NOMATCH),
};


/* Interface to iptables/ip6tables */

#define SO_IP_SET       83

union ip_set_name_index {
    char name[IPSET_MAXNAMELEN];
    ip_set_id_t index;
};

#define IP_SET_OP_GET_BYNAME    0x00000006  /* Get set index by name */
struct ip_set_req_get_set {
    unsigned int op;
    unsigned int version;
    union ip_set_name_index set;
};

#define IP_SET_OP_GET_BYINDEX   0x00000007  /* Get set name by index */
/* Uses ip_set_req_get_set */

#define IP_SET_OP_VERSION   0x00000100  /* Ask kernel version */
struct ip_set_req_version {
    unsigned int op;
    unsigned int version;
};

#endif /* _UAPI_IP_SET_H */