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-2013 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 _IP_SET_H
11 #define _IP_SET_H
12
13 #include <linux/ip.h>
14 #include <linux/ipv6.h>
15 #include <linux/netlink.h>
16 #include <linux/netfilter.h>
17 #include <linux/netfilter/x_tables.h>
18 #include <linux/stringify.h>
19 #include <linux/vmalloc.h>
20 #include <net/netlink.h>
21 #include <uapi/linux/netfilter/ipset/ip_set.h>
22
23 #define _IP_SET_MODULE_DESC(a, b, c) \
24 MODULE_DESCRIPTION(a " type of IP sets, revisions " b "-" c)
25 #define IP_SET_MODULE_DESC(a, b, c) \
26 _IP_SET_MODULE_DESC(a, __stringify(b), __stringify(c))
27
28 /* Set features */
29 enum ip_set_feature {
30 IPSET_TYPE_IP_FLAG = 0,
31 IPSET_TYPE_IP = (1 << IPSET_TYPE_IP_FLAG),
32 IPSET_TYPE_PORT_FLAG = 1,
33 IPSET_TYPE_PORT = (1 << IPSET_TYPE_PORT_FLAG),
34 IPSET_TYPE_MAC_FLAG = 2,
35 IPSET_TYPE_MAC = (1 << IPSET_TYPE_MAC_FLAG),
36 IPSET_TYPE_IP2_FLAG = 3,
37 IPSET_TYPE_IP2 = (1 << IPSET_TYPE_IP2_FLAG),
38 IPSET_TYPE_NAME_FLAG = 4,
39 IPSET_TYPE_NAME = (1 << IPSET_TYPE_NAME_FLAG),
40 IPSET_TYPE_IFACE_FLAG = 5,
41 IPSET_TYPE_IFACE = (1 << IPSET_TYPE_IFACE_FLAG),
42 IPSET_TYPE_MARK_FLAG = 6,
43 IPSET_TYPE_MARK = (1 << IPSET_TYPE_MARK_FLAG),
44 IPSET_TYPE_NOMATCH_FLAG = 7,
45 IPSET_TYPE_NOMATCH = (1 << IPSET_TYPE_NOMATCH_FLAG),
46 /* Strictly speaking not a feature, but a flag for dumping:
47 * this settype must be dumped last */
48 IPSET_DUMP_LAST_FLAG = 8,
49 IPSET_DUMP_LAST = (1 << IPSET_DUMP_LAST_FLAG),
50 };
51
52 /* Set extensions */
53 enum ip_set_extension {
54 IPSET_EXT_BIT_TIMEOUT = 0,
55 IPSET_EXT_TIMEOUT = (1 << IPSET_EXT_BIT_TIMEOUT),
56 IPSET_EXT_BIT_COUNTER = 1,
57 IPSET_EXT_COUNTER = (1 << IPSET_EXT_BIT_COUNTER),
58 IPSET_EXT_BIT_COMMENT = 2,
59 IPSET_EXT_COMMENT = (1 << IPSET_EXT_BIT_COMMENT),
60 IPSET_EXT_BIT_SKBINFO = 3,
61 IPSET_EXT_SKBINFO = (1 << IPSET_EXT_BIT_SKBINFO),
62 /* Mark set with an extension which needs to call destroy */
63 IPSET_EXT_BIT_DESTROY = 7,
64 IPSET_EXT_DESTROY = (1 << IPSET_EXT_BIT_DESTROY),
65 };
66
67 #define SET_WITH_TIMEOUT(s) ((s)->extensions & IPSET_EXT_TIMEOUT)
68 #define SET_WITH_COUNTER(s) ((s)->extensions & IPSET_EXT_COUNTER)
69 #define SET_WITH_COMMENT(s) ((s)->extensions & IPSET_EXT_COMMENT)
70 #define SET_WITH_SKBINFO(s) ((s)->extensions & IPSET_EXT_SKBINFO)
71 #define SET_WITH_FORCEADD(s) ((s)->flags & IPSET_CREATE_FLAG_FORCEADD)
72
73 /* Extension id, in size order */
74 enum ip_set_ext_id {
75 IPSET_EXT_ID_COUNTER = 0,
76 IPSET_EXT_ID_TIMEOUT,
77 IPSET_EXT_ID_SKBINFO,
78 IPSET_EXT_ID_COMMENT,
79 IPSET_EXT_ID_MAX,
80 };
81
82 struct ip_set;
83
84 /* Extension type */
85 struct ip_set_ext_type {
86 /* Destroy extension private data (can be NULL) */
87 void (*destroy)(struct ip_set *set, void *ext);
88 enum ip_set_extension type;
89 enum ipset_cadt_flags flag;
90 /* Size and minimal alignment */
91 u8 len;
92 u8 align;
93 };
94
95 extern const struct ip_set_ext_type ip_set_extensions[];
96
97 struct ip_set_counter {
98 atomic64_t bytes;
99 atomic64_t packets;
100 };
101
102 struct ip_set_comment_rcu {
103 struct rcu_head rcu;
104 char str[0];
105 };
106
107 struct ip_set_comment {
108 struct ip_set_comment_rcu __rcu *c;
109 };
110
111 struct ip_set_skbinfo {
112 u32 skbmark;
113 u32 skbmarkmask;
114 u32 skbprio;
115 u16 skbqueue;
116 u16 __pad;
117 };
118
119 struct ip_set_ext {
120 struct ip_set_skbinfo skbinfo;
121 u64 packets;
122 u64 bytes;
123 char *comment;
124 u32 timeout;
125 };
126
127 struct ip_set;
128
129 #define ext_timeout(e, s) \
130 ((unsigned long *)(((void *)(e)) + (s)->offset[IPSET_EXT_ID_TIMEOUT]))
131 #define ext_counter(e, s) \
132 ((struct ip_set_counter *)(((void *)(e)) + (s)->offset[IPSET_EXT_ID_COUNTER]))
133 #define ext_comment(e, s) \
134 ((struct ip_set_comment *)(((void *)(e)) + (s)->offset[IPSET_EXT_ID_COMMENT]))
135 #define ext_skbinfo(e, s) \
136 ((struct ip_set_skbinfo *)(((void *)(e)) + (s)->offset[IPSET_EXT_ID_SKBINFO]))
137
138 typedef int (*ipset_adtfn)(struct ip_set *set, void *value,
139 const struct ip_set_ext *ext,
140 struct ip_set_ext *mext, u32 cmdflags);
141
142 /* Kernel API function options */
143 struct ip_set_adt_opt {
144 u8 family; /* Actual protocol family */
145 u8 dim; /* Dimension of match/target */
146 u8 flags; /* Direction and negation flags */
147 u32 cmdflags; /* Command-like flags */
148 struct ip_set_ext ext; /* Extensions */
149 };
150
151 /* Set type, variant-specific part */
152 struct ip_set_type_variant {
153 /* Kernelspace: test/add/del entries
154 * returns negative error code,
155 * zero for no match/success to add/delete
156 * positive for matching element */
157 int (*kadt)(struct ip_set *set, const struct sk_buff *skb,
158 const struct xt_action_param *par,
159 enum ipset_adt adt, struct ip_set_adt_opt *opt);
160
161 /* Userspace: test/add/del entries
162 * returns negative error code,
163 * zero for no match/success to add/delete
164 * positive for matching element */
165 int (*uadt)(struct ip_set *set, struct nlattr *tb[],
166 enum ipset_adt adt, u32 *lineno, u32 flags, bool retried);
167
168 /* Low level add/del/test functions */
169 ipset_adtfn adt[IPSET_ADT_MAX];
170
171 /* When adding entries and set is full, try to resize the set */
172 int (*resize)(struct ip_set *set, bool retried);
173 /* Destroy the set */
174 void (*destroy)(struct ip_set *set);
175 /* Flush the elements */
176 void (*flush)(struct ip_set *set);
177 /* Expire entries before listing */
178 void (*expire)(struct ip_set *set);
179 /* List set header data */
180 int (*head)(struct ip_set *set, struct sk_buff *skb);
181 /* List elements */
182 int (*list)(const struct ip_set *set, struct sk_buff *skb,
183 struct netlink_callback *cb);
184 /* Keep listing private when resizing runs parallel */
185 void (*uref)(struct ip_set *set, struct netlink_callback *cb,
186 bool start);
187
188 /* Return true if "b" set is the same as "a"
189 * according to the create set parameters */
190 bool (*same_set)(const struct ip_set *a, const struct ip_set *b);
191 };
192
193 /* The core set type structure */
194 struct ip_set_type {
195 struct list_head list;
196
197 /* Typename */
198 char name[IPSET_MAXNAMELEN];
199 /* Protocol version */
200 u8 protocol;
201 /* Set type dimension */
202 u8 dimension;
203 /*
204 * Supported family: may be NFPROTO_UNSPEC for both
205 * NFPROTO_IPV4/NFPROTO_IPV6.
206 */
207 u8 family;
208 /* Type revisions */
209 u8 revision_min, revision_max;
210 /* Set features to control swapping */
211 u16 features;
212
213 /* Create set */
214 int (*create)(struct net *net, struct ip_set *set,
215 struct nlattr *tb[], u32 flags);
216
217 /* Attribute policies */
218 const struct nla_policy create_policy[IPSET_ATTR_CREATE_MAX + 1];
219 const struct nla_policy adt_policy[IPSET_ATTR_ADT_MAX + 1];
220
221 /* Set this to THIS_MODULE if you are a module, otherwise NULL */
222 struct module *me;
223 };
224
225 /* register and unregister set type */
226 extern int ip_set_type_register(struct ip_set_type *set_type);
227 extern void ip_set_type_unregister(struct ip_set_type *set_type);
228
229 /* A generic IP set */
230 struct ip_set {
231 /* The name of the set */
232 char name[IPSET_MAXNAMELEN];
233 /* Lock protecting the set data */
234 spinlock_t lock;
235 /* References to the set */
236 u32 ref;
237 /* References to the set for netlink events like dump,
238 * ref can be swapped out by ip_set_swap
239 */
240 u32 ref_netlink;
241 /* The core set type */
242 struct ip_set_type *type;
243 /* The type variant doing the real job */
244 const struct ip_set_type_variant *variant;
245 /* The actual INET family of the set */
246 u8 family;
247 /* The type revision */
248 u8 revision;
249 /* Extensions */
250 u8 extensions;
251 /* Create flags */
252 u8 flags;
253 /* Default timeout value, if enabled */
254 u32 timeout;
255 /* Number of elements (vs timeout) */
256 u32 elements;
257 /* Size of the dynamic extensions (vs timeout) */
258 size_t ext_size;
259 /* Element data size */
260 size_t dsize;
261 /* Offsets to extensions in elements */
262 size_t offset[IPSET_EXT_ID_MAX];
263 /* The type specific data */
264 void *data;
265 };
266
267 static inline void
ip_set_ext_destroy(struct ip_set * set,void * data)268 ip_set_ext_destroy(struct ip_set *set, void *data)
269 {
270 /* Check that the extension is enabled for the set and
271 * call it's destroy function for its extension part in data.
272 */
273 if (SET_WITH_COMMENT(set))
274 ip_set_extensions[IPSET_EXT_ID_COMMENT].destroy(
275 set, ext_comment(data, set));
276 }
277
278 static inline int
ip_set_put_flags(struct sk_buff * skb,struct ip_set * set)279 ip_set_put_flags(struct sk_buff *skb, struct ip_set *set)
280 {
281 u32 cadt_flags = 0;
282
283 if (SET_WITH_TIMEOUT(set))
284 if (unlikely(nla_put_net32(skb, IPSET_ATTR_TIMEOUT,
285 htonl(set->timeout))))
286 return -EMSGSIZE;
287 if (SET_WITH_COUNTER(set))
288 cadt_flags |= IPSET_FLAG_WITH_COUNTERS;
289 if (SET_WITH_COMMENT(set))
290 cadt_flags |= IPSET_FLAG_WITH_COMMENT;
291 if (SET_WITH_SKBINFO(set))
292 cadt_flags |= IPSET_FLAG_WITH_SKBINFO;
293 if (SET_WITH_FORCEADD(set))
294 cadt_flags |= IPSET_FLAG_WITH_FORCEADD;
295
296 if (!cadt_flags)
297 return 0;
298 return nla_put_net32(skb, IPSET_ATTR_CADT_FLAGS, htonl(cadt_flags));
299 }
300
301 /* Netlink CB args */
302 enum {
303 IPSET_CB_NET = 0, /* net namespace */
304 IPSET_CB_DUMP, /* dump single set/all sets */
305 IPSET_CB_INDEX, /* set index */
306 IPSET_CB_PRIVATE, /* set private data */
307 IPSET_CB_ARG0, /* type specific */
308 IPSET_CB_ARG1,
309 };
310
311 /* register and unregister set references */
312 extern ip_set_id_t ip_set_get_byname(struct net *net,
313 const char *name, struct ip_set **set);
314 extern void ip_set_put_byindex(struct net *net, ip_set_id_t index);
315 extern void ip_set_name_byindex(struct net *net, ip_set_id_t index, char *name);
316 extern ip_set_id_t ip_set_nfnl_get_byindex(struct net *net, ip_set_id_t index);
317 extern void ip_set_nfnl_put(struct net *net, ip_set_id_t index);
318
319 /* API for iptables set match, and SET target */
320
321 extern int ip_set_add(ip_set_id_t id, const struct sk_buff *skb,
322 const struct xt_action_param *par,
323 struct ip_set_adt_opt *opt);
324 extern int ip_set_del(ip_set_id_t id, const struct sk_buff *skb,
325 const struct xt_action_param *par,
326 struct ip_set_adt_opt *opt);
327 extern int ip_set_test(ip_set_id_t id, const struct sk_buff *skb,
328 const struct xt_action_param *par,
329 struct ip_set_adt_opt *opt);
330
331 /* Utility functions */
332 extern void *ip_set_alloc(size_t size);
333 extern void ip_set_free(void *members);
334 extern int ip_set_get_ipaddr4(struct nlattr *nla, __be32 *ipaddr);
335 extern int ip_set_get_ipaddr6(struct nlattr *nla, union nf_inet_addr *ipaddr);
336 extern size_t ip_set_elem_len(struct ip_set *set, struct nlattr *tb[],
337 size_t len, size_t align);
338 extern int ip_set_get_extensions(struct ip_set *set, struct nlattr *tb[],
339 struct ip_set_ext *ext);
340 extern int ip_set_put_extensions(struct sk_buff *skb, const struct ip_set *set,
341 const void *e, bool active);
342
343 static inline int
ip_set_get_hostipaddr4(struct nlattr * nla,u32 * ipaddr)344 ip_set_get_hostipaddr4(struct nlattr *nla, u32 *ipaddr)
345 {
346 __be32 ip;
347 int ret = ip_set_get_ipaddr4(nla, &ip);
348
349 if (ret)
350 return ret;
351 *ipaddr = ntohl(ip);
352 return 0;
353 }
354
355 /* Ignore IPSET_ERR_EXIST errors if asked to do so? */
356 static inline bool
ip_set_eexist(int ret,u32 flags)357 ip_set_eexist(int ret, u32 flags)
358 {
359 return ret == -IPSET_ERR_EXIST && (flags & IPSET_FLAG_EXIST);
360 }
361
362 /* Match elements marked with nomatch */
363 static inline bool
ip_set_enomatch(int ret,u32 flags,enum ipset_adt adt,struct ip_set * set)364 ip_set_enomatch(int ret, u32 flags, enum ipset_adt adt, struct ip_set *set)
365 {
366 return adt == IPSET_TEST &&
367 (set->type->features & IPSET_TYPE_NOMATCH) &&
368 ((flags >> 16) & IPSET_FLAG_NOMATCH) &&
369 (ret > 0 || ret == -ENOTEMPTY);
370 }
371
372 /* Check the NLA_F_NET_BYTEORDER flag */
373 static inline bool
ip_set_attr_netorder(struct nlattr * tb[],int type)374 ip_set_attr_netorder(struct nlattr *tb[], int type)
375 {
376 return tb[type] && (tb[type]->nla_type & NLA_F_NET_BYTEORDER);
377 }
378
379 static inline bool
ip_set_optattr_netorder(struct nlattr * tb[],int type)380 ip_set_optattr_netorder(struct nlattr *tb[], int type)
381 {
382 return !tb[type] || (tb[type]->nla_type & NLA_F_NET_BYTEORDER);
383 }
384
385 /* Useful converters */
386 static inline u32
ip_set_get_h32(const struct nlattr * attr)387 ip_set_get_h32(const struct nlattr *attr)
388 {
389 return ntohl(nla_get_be32(attr));
390 }
391
392 static inline u16
ip_set_get_h16(const struct nlattr * attr)393 ip_set_get_h16(const struct nlattr *attr)
394 {
395 return ntohs(nla_get_be16(attr));
396 }
397
398 #define ipset_nest_start(skb, attr) nla_nest_start(skb, attr | NLA_F_NESTED)
399 #define ipset_nest_end(skb, start) nla_nest_end(skb, start)
400
nla_put_ipaddr4(struct sk_buff * skb,int type,__be32 ipaddr)401 static inline int nla_put_ipaddr4(struct sk_buff *skb, int type, __be32 ipaddr)
402 {
403 struct nlattr *__nested = ipset_nest_start(skb, type);
404 int ret;
405
406 if (!__nested)
407 return -EMSGSIZE;
408 ret = nla_put_in_addr(skb, IPSET_ATTR_IPADDR_IPV4, ipaddr);
409 if (!ret)
410 ipset_nest_end(skb, __nested);
411 return ret;
412 }
413
nla_put_ipaddr6(struct sk_buff * skb,int type,const struct in6_addr * ipaddrptr)414 static inline int nla_put_ipaddr6(struct sk_buff *skb, int type,
415 const struct in6_addr *ipaddrptr)
416 {
417 struct nlattr *__nested = ipset_nest_start(skb, type);
418 int ret;
419
420 if (!__nested)
421 return -EMSGSIZE;
422 ret = nla_put_in6_addr(skb, IPSET_ATTR_IPADDR_IPV6, ipaddrptr);
423 if (!ret)
424 ipset_nest_end(skb, __nested);
425 return ret;
426 }
427
428 /* Get address from skbuff */
429 static inline __be32
ip4addr(const struct sk_buff * skb,bool src)430 ip4addr(const struct sk_buff *skb, bool src)
431 {
432 return src ? ip_hdr(skb)->saddr : ip_hdr(skb)->daddr;
433 }
434
435 static inline void
ip4addrptr(const struct sk_buff * skb,bool src,__be32 * addr)436 ip4addrptr(const struct sk_buff *skb, bool src, __be32 *addr)
437 {
438 *addr = src ? ip_hdr(skb)->saddr : ip_hdr(skb)->daddr;
439 }
440
441 static inline void
ip6addrptr(const struct sk_buff * skb,bool src,struct in6_addr * addr)442 ip6addrptr(const struct sk_buff *skb, bool src, struct in6_addr *addr)
443 {
444 memcpy(addr, src ? &ipv6_hdr(skb)->saddr : &ipv6_hdr(skb)->daddr,
445 sizeof(*addr));
446 }
447
448 #include <linux/netfilter/ipset/ip_set_timeout.h>
449 #include <linux/netfilter/ipset/ip_set_comment.h>
450 #include <linux/netfilter/ipset/ip_set_counter.h>
451 #include <linux/netfilter/ipset/ip_set_skbinfo.h>
452
453 #define IP_SET_INIT_KEXT(skb, opt, set) \
454 { .bytes = (skb)->len, .packets = 1, \
455 .timeout = ip_set_adt_opt_timeout(opt, set) }
456
457 #define IP_SET_INIT_UEXT(set) \
458 { .bytes = ULLONG_MAX, .packets = ULLONG_MAX, \
459 .timeout = (set)->timeout }
460
461 #define IPSET_CONCAT(a, b) a##b
462 #define IPSET_TOKEN(a, b) IPSET_CONCAT(a, b)
463
464 #endif /*_IP_SET_H */
465