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