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>
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.
10 #ifndef _UAPI_IP_SET_H
11 #define _UAPI_IP_SET_H
13 #include <linux/types.h>
15 /* The protocol version */
16 #define IPSET_PROTOCOL 6
18 /* The max length of strings including NUL: set and type identifiers */
19 #define IPSET_MAXNAMELEN 32
21 /* The maximum permissible comment length we will accept over netlink */
22 #define IPSET_MAX_COMMENT_SIZE 255
24 /* Message types and commands */
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 */
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 */
50 IPSET_CMD_COMMIT = IPSET_CMD_MAX, /* 18: Commit buffered commands */
53 /* Attributes at command level */
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 */
70 #define IPSET_ATTR_CMD_MAX (__IPSET_ATTR_CMD_MAX - 1)
72 /* CADT specific attributes */
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 */
99 IPSET_ATTR_REFERENCES,
102 __IPSET_ATTR_CREATE_MAX,
104 #define IPSET_ATTR_CREATE_MAX (__IPSET_ATTR_CREATE_MAX - 1)
106 /* ADT specific attributes */
108 IPSET_ATTR_ETHER = IPSET_ATTR_CADT_MAX + 1,
122 __IPSET_ATTR_ADT_MAX,
124 #define IPSET_ATTR_ADT_MAX (__IPSET_ATTR_ADT_MAX - 1)
126 /* IP specific attributes */
128 IPSET_ATTR_IPADDR_IPV4 = IPSET_ATTR_UNSPEC + 1,
129 IPSET_ATTR_IPADDR_IPV6,
130 __IPSET_ATTR_IPADDR_MAX,
132 #define IPSET_ATTR_IPADDR_MAX (__IPSET_ATTR_IPADDR_MAX - 1)
136 IPSET_ERR_PRIVATE = 4096,
141 IPSET_ERR_EXIST_SETNAME2,
142 IPSET_ERR_TYPE_MISMATCH,
144 IPSET_ERR_INVALID_CIDR,
145 IPSET_ERR_INVALID_NETMASK,
146 IPSET_ERR_INVALID_FAMILY,
148 IPSET_ERR_REFERENCED,
149 IPSET_ERR_IPADDR_IPV4,
150 IPSET_ERR_IPADDR_IPV6,
153 IPSET_ERR_INVALID_MARKMASK,
156 /* Type specific error codes */
157 IPSET_ERR_TYPE_SPECIFIC = 4352,
160 /* Flags at command level or match/target flags, lower half of cmdattrs*/
161 enum ipset_cmd_flags {
162 IPSET_FLAG_BIT_EXIST = 0,
163 IPSET_FLAG_EXIST = (1 << IPSET_FLAG_BIT_EXIST),
164 IPSET_FLAG_BIT_LIST_SETNAME = 1,
165 IPSET_FLAG_LIST_SETNAME = (1 << IPSET_FLAG_BIT_LIST_SETNAME),
166 IPSET_FLAG_BIT_LIST_HEADER = 2,
167 IPSET_FLAG_LIST_HEADER = (1 << IPSET_FLAG_BIT_LIST_HEADER),
168 IPSET_FLAG_BIT_SKIP_COUNTER_UPDATE = 3,
169 IPSET_FLAG_SKIP_COUNTER_UPDATE =
170 (1 << IPSET_FLAG_BIT_SKIP_COUNTER_UPDATE),
171 IPSET_FLAG_BIT_SKIP_SUBCOUNTER_UPDATE = 4,
172 IPSET_FLAG_SKIP_SUBCOUNTER_UPDATE =
173 (1 << IPSET_FLAG_BIT_SKIP_SUBCOUNTER_UPDATE),
174 IPSET_FLAG_BIT_MATCH_COUNTERS = 5,
175 IPSET_FLAG_MATCH_COUNTERS = (1 << IPSET_FLAG_BIT_MATCH_COUNTERS),
176 IPSET_FLAG_BIT_RETURN_NOMATCH = 7,
177 IPSET_FLAG_RETURN_NOMATCH = (1 << IPSET_FLAG_BIT_RETURN_NOMATCH),
178 IPSET_FLAG_BIT_MAP_SKBMARK = 8,
179 IPSET_FLAG_MAP_SKBMARK = (1 << IPSET_FLAG_BIT_MAP_SKBMARK),
180 IPSET_FLAG_BIT_MAP_SKBPRIO = 9,
181 IPSET_FLAG_MAP_SKBPRIO = (1 << IPSET_FLAG_BIT_MAP_SKBPRIO),
182 IPSET_FLAG_BIT_MAP_SKBQUEUE = 10,
183 IPSET_FLAG_MAP_SKBQUEUE = (1 << IPSET_FLAG_BIT_MAP_SKBQUEUE),
184 IPSET_FLAG_CMD_MAX = 15,
187 /* Flags at CADT attribute level, upper half of cmdattrs */
188 enum ipset_cadt_flags {
189 IPSET_FLAG_BIT_BEFORE = 0,
190 IPSET_FLAG_BEFORE = (1 << IPSET_FLAG_BIT_BEFORE),
191 IPSET_FLAG_BIT_PHYSDEV = 1,
192 IPSET_FLAG_PHYSDEV = (1 << IPSET_FLAG_BIT_PHYSDEV),
193 IPSET_FLAG_BIT_NOMATCH = 2,
194 IPSET_FLAG_NOMATCH = (1 << IPSET_FLAG_BIT_NOMATCH),
195 IPSET_FLAG_BIT_WITH_COUNTERS = 3,
196 IPSET_FLAG_WITH_COUNTERS = (1 << IPSET_FLAG_BIT_WITH_COUNTERS),
197 IPSET_FLAG_BIT_WITH_COMMENT = 4,
198 IPSET_FLAG_WITH_COMMENT = (1 << IPSET_FLAG_BIT_WITH_COMMENT),
199 IPSET_FLAG_BIT_WITH_FORCEADD = 5,
200 IPSET_FLAG_WITH_FORCEADD = (1 << IPSET_FLAG_BIT_WITH_FORCEADD),
201 IPSET_FLAG_BIT_WITH_SKBINFO = 6,
202 IPSET_FLAG_WITH_SKBINFO = (1 << IPSET_FLAG_BIT_WITH_SKBINFO),
203 IPSET_FLAG_CADT_MAX = 15,
206 /* The flag bits which correspond to the non-extension create flags */
207 enum ipset_create_flags {
208 IPSET_CREATE_FLAG_BIT_FORCEADD = 0,
209 IPSET_CREATE_FLAG_FORCEADD = (1 << IPSET_CREATE_FLAG_BIT_FORCEADD),
210 IPSET_CREATE_FLAG_BIT_MAX = 7,
213 /* Commands with settype-specific attributes */
219 IPSET_CREATE = IPSET_ADT_MAX,
223 /* Sets are identified by an index in kernel space. Tweak with ip_set_id_t
224 * and IPSET_INVALID_ID if you want to increase the max number of sets.
226 typedef __u16 ip_set_id_t;
228 #define IPSET_INVALID_ID 65535
235 /* Max dimension in elements.
236 * If changed, new revision of iptables match/target is required.
239 /* Backward compatibility: set match revision 2 */
240 IPSET_BIT_RETURN_NOMATCH = 7,
243 /* Option flags for kernel operations */
245 IPSET_INV_MATCH = (1 << IPSET_DIM_ZERO),
246 IPSET_DIM_ONE_SRC = (1 << IPSET_DIM_ONE),
247 IPSET_DIM_TWO_SRC = (1 << IPSET_DIM_TWO),
248 IPSET_DIM_THREE_SRC = (1 << IPSET_DIM_THREE),
249 IPSET_RETURN_NOMATCH = (1 << IPSET_BIT_RETURN_NOMATCH),
253 IPSET_COUNTER_NONE = 0,
260 /* Backward compatibility for set match v3 */
261 struct ip_set_counter_match0 {
266 struct ip_set_counter_match {
271 /* Interface to iptables/ip6tables */
275 union ip_set_name_index {
276 char name[IPSET_MAXNAMELEN];
280 #define IP_SET_OP_GET_BYNAME 0x00000006 /* Get set index by name */
281 struct ip_set_req_get_set {
283 unsigned int version;
284 union ip_set_name_index set;
287 #define IP_SET_OP_GET_BYINDEX 0x00000007 /* Get set name by index */
288 /* Uses ip_set_req_get_set */
290 #define IP_SET_OP_GET_FNAME 0x00000008 /* Get set index and family */
291 struct ip_set_req_get_set_family {
293 unsigned int version;
295 union ip_set_name_index set;
298 #define IP_SET_OP_VERSION 0x00000100 /* Ask kernel version */
299 struct ip_set_req_version {
301 unsigned int version;
304 #endif /* _UAPI_IP_SET_H */