1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2 /* Copyright (C) 2000-2002 Joakim Axelsson <gozem@linux.nu> 3 * Patrick Schaaf <bof@bof.de> 4 * Martin Josefsson <gandalf@wlug.westbo.se> 5 * Copyright (C) 2003-2011 Jozsef Kadlecsik <kadlec@netfilter.org> 6 */ 7 #ifndef _UAPI_IP_SET_H 8 #define _UAPI_IP_SET_H 9 10 #include <linux/types.h> 11 12 /* The protocol versions */ 13 #define IPSET_PROTOCOL 7 14 #define IPSET_PROTOCOL_MIN 6 15 16 /* The max length of strings including NUL: set and type identifiers */ 17 #define IPSET_MAXNAMELEN 32 18 19 /* The maximum permissible comment length we will accept over netlink */ 20 #define IPSET_MAX_COMMENT_SIZE 255 21 22 /* Message types and commands */ 23 enum ipset_cmd { 24 IPSET_CMD_NONE, 25 IPSET_CMD_PROTOCOL, /* 1: Return protocol version */ 26 IPSET_CMD_CREATE, /* 2: Create a new (empty) set */ 27 IPSET_CMD_DESTROY, /* 3: Destroy a (empty) set */ 28 IPSET_CMD_FLUSH, /* 4: Remove all elements from a set */ 29 IPSET_CMD_RENAME, /* 5: Rename a set */ 30 IPSET_CMD_SWAP, /* 6: Swap two sets */ 31 IPSET_CMD_LIST, /* 7: List sets */ 32 IPSET_CMD_SAVE, /* 8: Save sets */ 33 IPSET_CMD_ADD, /* 9: Add an element to a set */ 34 IPSET_CMD_DEL, /* 10: Delete an element from a set */ 35 IPSET_CMD_TEST, /* 11: Test an element in a set */ 36 IPSET_CMD_HEADER, /* 12: Get set header data only */ 37 IPSET_CMD_TYPE, /* 13: Get set type */ 38 IPSET_CMD_GET_BYNAME, /* 14: Get set index by name */ 39 IPSET_CMD_GET_BYINDEX, /* 15: Get set name by index */ 40 IPSET_MSG_MAX, /* Netlink message commands */ 41 42 /* Commands in userspace: */ 43 IPSET_CMD_RESTORE = IPSET_MSG_MAX, /* 16: Enter restore mode */ 44 IPSET_CMD_HELP, /* 17: Get help */ 45 IPSET_CMD_VERSION, /* 18: Get program version */ 46 IPSET_CMD_QUIT, /* 19: Quit from interactive mode */ 47 48 IPSET_CMD_MAX, 49 50 IPSET_CMD_COMMIT = IPSET_CMD_MAX, /* 20: Commit buffered commands */ 51 }; 52 53 /* Attributes at command level */ 54 enum { 55 IPSET_ATTR_UNSPEC, 56 IPSET_ATTR_PROTOCOL, /* 1: Protocol version */ 57 IPSET_ATTR_SETNAME, /* 2: Name of the set */ 58 IPSET_ATTR_TYPENAME, /* 3: Typename */ 59 IPSET_ATTR_SETNAME2 = IPSET_ATTR_TYPENAME, /* Setname at rename/swap */ 60 IPSET_ATTR_REVISION, /* 4: Settype revision */ 61 IPSET_ATTR_FAMILY, /* 5: Settype family */ 62 IPSET_ATTR_FLAGS, /* 6: Flags at command level */ 63 IPSET_ATTR_DATA, /* 7: Nested attributes */ 64 IPSET_ATTR_ADT, /* 8: Multiple data containers */ 65 IPSET_ATTR_LINENO, /* 9: Restore lineno */ 66 IPSET_ATTR_PROTOCOL_MIN, /* 10: Minimal supported version number */ 67 IPSET_ATTR_REVISION_MIN = IPSET_ATTR_PROTOCOL_MIN, /* type rev min */ 68 IPSET_ATTR_INDEX, /* 11: Kernel index of set */ 69 __IPSET_ATTR_CMD_MAX, 70 }; 71 #define IPSET_ATTR_CMD_MAX (__IPSET_ATTR_CMD_MAX - 1) 72 73 /* CADT specific attributes */ 74 enum { 75 IPSET_ATTR_IP = IPSET_ATTR_UNSPEC + 1, 76 IPSET_ATTR_IP_FROM = IPSET_ATTR_IP, 77 IPSET_ATTR_IP_TO, /* 2 */ 78 IPSET_ATTR_CIDR, /* 3 */ 79 IPSET_ATTR_PORT, /* 4 */ 80 IPSET_ATTR_PORT_FROM = IPSET_ATTR_PORT, 81 IPSET_ATTR_PORT_TO, /* 5 */ 82 IPSET_ATTR_TIMEOUT, /* 6 */ 83 IPSET_ATTR_PROTO, /* 7 */ 84 IPSET_ATTR_CADT_FLAGS, /* 8 */ 85 IPSET_ATTR_CADT_LINENO = IPSET_ATTR_LINENO, /* 9 */ 86 IPSET_ATTR_MARK, /* 10 */ 87 IPSET_ATTR_MARKMASK, /* 11 */ 88 /* Reserve empty slots */ 89 IPSET_ATTR_CADT_MAX = 16, 90 /* Create-only specific attributes */ 91 IPSET_ATTR_INITVAL, /* was unused IPSET_ATTR_GC */ 92 IPSET_ATTR_HASHSIZE, 93 IPSET_ATTR_MAXELEM, 94 IPSET_ATTR_NETMASK, 95 IPSET_ATTR_BUCKETSIZE, /* was unused IPSET_ATTR_PROBES */ 96 IPSET_ATTR_RESIZE, 97 IPSET_ATTR_SIZE, 98 /* Kernel-only */ 99 IPSET_ATTR_ELEMENTS, 100 IPSET_ATTR_REFERENCES, 101 IPSET_ATTR_MEMSIZE, 102 103 __IPSET_ATTR_CREATE_MAX, 104 }; 105 #define IPSET_ATTR_CREATE_MAX (__IPSET_ATTR_CREATE_MAX - 1) 106 107 /* ADT specific attributes */ 108 enum { 109 IPSET_ATTR_ETHER = IPSET_ATTR_CADT_MAX + 1, 110 IPSET_ATTR_NAME, 111 IPSET_ATTR_NAMEREF, 112 IPSET_ATTR_IP2, 113 IPSET_ATTR_CIDR2, 114 IPSET_ATTR_IP2_TO, 115 IPSET_ATTR_IFACE, 116 IPSET_ATTR_BYTES, 117 IPSET_ATTR_PACKETS, 118 IPSET_ATTR_COMMENT, 119 IPSET_ATTR_SKBMARK, 120 IPSET_ATTR_SKBPRIO, 121 IPSET_ATTR_SKBQUEUE, 122 IPSET_ATTR_PAD, 123 __IPSET_ATTR_ADT_MAX, 124 }; 125 #define IPSET_ATTR_ADT_MAX (__IPSET_ATTR_ADT_MAX - 1) 126 127 /* IP specific attributes */ 128 enum { 129 IPSET_ATTR_IPADDR_IPV4 = IPSET_ATTR_UNSPEC + 1, 130 IPSET_ATTR_IPADDR_IPV6, 131 __IPSET_ATTR_IPADDR_MAX, 132 }; 133 #define IPSET_ATTR_IPADDR_MAX (__IPSET_ATTR_IPADDR_MAX - 1) 134 135 /* Error codes */ 136 enum ipset_errno { 137 IPSET_ERR_PRIVATE = 4096, 138 IPSET_ERR_PROTOCOL, 139 IPSET_ERR_FIND_TYPE, 140 IPSET_ERR_MAX_SETS, 141 IPSET_ERR_BUSY, 142 IPSET_ERR_EXIST_SETNAME2, 143 IPSET_ERR_TYPE_MISMATCH, 144 IPSET_ERR_EXIST, 145 IPSET_ERR_INVALID_CIDR, 146 IPSET_ERR_INVALID_NETMASK, 147 IPSET_ERR_INVALID_FAMILY, 148 IPSET_ERR_TIMEOUT, 149 IPSET_ERR_REFERENCED, 150 IPSET_ERR_IPADDR_IPV4, 151 IPSET_ERR_IPADDR_IPV6, 152 IPSET_ERR_COUNTER, 153 IPSET_ERR_COMMENT, 154 IPSET_ERR_INVALID_MARKMASK, 155 IPSET_ERR_SKBINFO, 156 157 /* Type specific error codes */ 158 IPSET_ERR_TYPE_SPECIFIC = 4352, 159 }; 160 161 /* Flags at command level or match/target flags, lower half of cmdattrs*/ 162 enum ipset_cmd_flags { 163 IPSET_FLAG_BIT_EXIST = 0, 164 IPSET_FLAG_EXIST = (1 << IPSET_FLAG_BIT_EXIST), 165 IPSET_FLAG_BIT_LIST_SETNAME = 1, 166 IPSET_FLAG_LIST_SETNAME = (1 << IPSET_FLAG_BIT_LIST_SETNAME), 167 IPSET_FLAG_BIT_LIST_HEADER = 2, 168 IPSET_FLAG_LIST_HEADER = (1 << IPSET_FLAG_BIT_LIST_HEADER), 169 IPSET_FLAG_BIT_SKIP_COUNTER_UPDATE = 3, 170 IPSET_FLAG_SKIP_COUNTER_UPDATE = 171 (1 << IPSET_FLAG_BIT_SKIP_COUNTER_UPDATE), 172 IPSET_FLAG_BIT_SKIP_SUBCOUNTER_UPDATE = 4, 173 IPSET_FLAG_SKIP_SUBCOUNTER_UPDATE = 174 (1 << IPSET_FLAG_BIT_SKIP_SUBCOUNTER_UPDATE), 175 IPSET_FLAG_BIT_MATCH_COUNTERS = 5, 176 IPSET_FLAG_MATCH_COUNTERS = (1 << IPSET_FLAG_BIT_MATCH_COUNTERS), 177 IPSET_FLAG_BIT_RETURN_NOMATCH = 7, 178 IPSET_FLAG_RETURN_NOMATCH = (1 << IPSET_FLAG_BIT_RETURN_NOMATCH), 179 IPSET_FLAG_BIT_MAP_SKBMARK = 8, 180 IPSET_FLAG_MAP_SKBMARK = (1 << IPSET_FLAG_BIT_MAP_SKBMARK), 181 IPSET_FLAG_BIT_MAP_SKBPRIO = 9, 182 IPSET_FLAG_MAP_SKBPRIO = (1 << IPSET_FLAG_BIT_MAP_SKBPRIO), 183 IPSET_FLAG_BIT_MAP_SKBQUEUE = 10, 184 IPSET_FLAG_MAP_SKBQUEUE = (1 << IPSET_FLAG_BIT_MAP_SKBQUEUE), 185 IPSET_FLAG_CMD_MAX = 15, 186 }; 187 188 /* Flags at CADT attribute level, upper half of cmdattrs */ 189 enum ipset_cadt_flags { 190 IPSET_FLAG_BIT_BEFORE = 0, 191 IPSET_FLAG_BEFORE = (1 << IPSET_FLAG_BIT_BEFORE), 192 IPSET_FLAG_BIT_PHYSDEV = 1, 193 IPSET_FLAG_PHYSDEV = (1 << IPSET_FLAG_BIT_PHYSDEV), 194 IPSET_FLAG_BIT_NOMATCH = 2, 195 IPSET_FLAG_NOMATCH = (1 << IPSET_FLAG_BIT_NOMATCH), 196 IPSET_FLAG_BIT_WITH_COUNTERS = 3, 197 IPSET_FLAG_WITH_COUNTERS = (1 << IPSET_FLAG_BIT_WITH_COUNTERS), 198 IPSET_FLAG_BIT_WITH_COMMENT = 4, 199 IPSET_FLAG_WITH_COMMENT = (1 << IPSET_FLAG_BIT_WITH_COMMENT), 200 IPSET_FLAG_BIT_WITH_FORCEADD = 5, 201 IPSET_FLAG_WITH_FORCEADD = (1 << IPSET_FLAG_BIT_WITH_FORCEADD), 202 IPSET_FLAG_BIT_WITH_SKBINFO = 6, 203 IPSET_FLAG_WITH_SKBINFO = (1 << IPSET_FLAG_BIT_WITH_SKBINFO), 204 IPSET_FLAG_BIT_IFACE_WILDCARD = 7, 205 IPSET_FLAG_IFACE_WILDCARD = (1 << IPSET_FLAG_BIT_IFACE_WILDCARD), 206 IPSET_FLAG_CADT_MAX = 15, 207 }; 208 209 /* The flag bits which correspond to the non-extension create flags */ 210 enum ipset_create_flags { 211 IPSET_CREATE_FLAG_BIT_FORCEADD = 0, 212 IPSET_CREATE_FLAG_FORCEADD = (1 << IPSET_CREATE_FLAG_BIT_FORCEADD), 213 IPSET_CREATE_FLAG_BIT_BUCKETSIZE = 1, 214 IPSET_CREATE_FLAG_BUCKETSIZE = (1 << IPSET_CREATE_FLAG_BIT_BUCKETSIZE), 215 IPSET_CREATE_FLAG_BIT_MAX = 7, 216 }; 217 218 /* Commands with settype-specific attributes */ 219 enum ipset_adt { 220 IPSET_ADD, 221 IPSET_DEL, 222 IPSET_TEST, 223 IPSET_ADT_MAX, 224 IPSET_CREATE = IPSET_ADT_MAX, 225 IPSET_CADT_MAX, 226 }; 227 228 /* Sets are identified by an index in kernel space. Tweak with ip_set_id_t 229 * and IPSET_INVALID_ID if you want to increase the max number of sets. 230 * Also, IPSET_ATTR_INDEX must be changed. 231 */ 232 typedef __u16 ip_set_id_t; 233 234 #define IPSET_INVALID_ID 65535 235 236 enum ip_set_dim { 237 IPSET_DIM_ZERO = 0, 238 IPSET_DIM_ONE, 239 IPSET_DIM_TWO, 240 IPSET_DIM_THREE, 241 /* Max dimension in elements. 242 * If changed, new revision of iptables match/target is required. 243 */ 244 IPSET_DIM_MAX = 6, 245 /* Backward compatibility: set match revision 2 */ 246 IPSET_BIT_RETURN_NOMATCH = 7, 247 }; 248 249 /* Option flags for kernel operations */ 250 enum ip_set_kopt { 251 IPSET_INV_MATCH = (1 << IPSET_DIM_ZERO), 252 IPSET_DIM_ONE_SRC = (1 << IPSET_DIM_ONE), 253 IPSET_DIM_TWO_SRC = (1 << IPSET_DIM_TWO), 254 IPSET_DIM_THREE_SRC = (1 << IPSET_DIM_THREE), 255 IPSET_RETURN_NOMATCH = (1 << IPSET_BIT_RETURN_NOMATCH), 256 }; 257 258 enum { 259 IPSET_COUNTER_NONE = 0, 260 IPSET_COUNTER_EQ, 261 IPSET_COUNTER_NE, 262 IPSET_COUNTER_LT, 263 IPSET_COUNTER_GT, 264 }; 265 266 /* Backward compatibility for set match v3 */ 267 struct ip_set_counter_match0 { 268 __u8 op; 269 __u64 value; 270 }; 271 272 struct ip_set_counter_match { 273 __aligned_u64 value; 274 __u8 op; 275 }; 276 277 /* Interface to iptables/ip6tables */ 278 279 #define SO_IP_SET 83 280 281 union ip_set_name_index { 282 char name[IPSET_MAXNAMELEN]; 283 ip_set_id_t index; 284 }; 285 286 #define IP_SET_OP_GET_BYNAME 0x00000006 /* Get set index by name */ 287 struct ip_set_req_get_set { 288 unsigned int op; 289 unsigned int version; 290 union ip_set_name_index set; 291 }; 292 293 #define IP_SET_OP_GET_BYINDEX 0x00000007 /* Get set name by index */ 294 /* Uses ip_set_req_get_set */ 295 296 #define IP_SET_OP_GET_FNAME 0x00000008 /* Get set index and family */ 297 struct ip_set_req_get_set_family { 298 unsigned int op; 299 unsigned int version; 300 unsigned int family; 301 union ip_set_name_index set; 302 }; 303 304 #define IP_SET_OP_VERSION 0x00000100 /* Ask kernel version */ 305 struct ip_set_req_version { 306 unsigned int op; 307 unsigned int version; 308 }; 309 310 #endif /* _UAPI_IP_SET_H */ 311