1 /* SPDX-License-Identifier: GPL-2.0-only */
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-2013 Jozsef Kadlecsik <kadlec@netfilter.org>
11 #include <linux/ipv6.h>
12 #include <linux/netlink.h>
13 #include <linux/netfilter.h>
14 #include <linux/netfilter/x_tables.h>
15 #include <linux/stringify.h>
16 #include <linux/vmalloc.h>
17 #include <net/netlink.h>
18 #include <uapi/linux/netfilter/ipset/ip_set.h>
20 #define _IP_SET_MODULE_DESC(a, b, c) \
21 MODULE_DESCRIPTION(a " type of IP sets, revisions " b "-" c)
22 #define IP_SET_MODULE_DESC(a, b, c) \
23 _IP_SET_MODULE_DESC(a, __stringify(b), __stringify(c))
27 IPSET_TYPE_IP_FLAG
= 0,
28 IPSET_TYPE_IP
= (1 << IPSET_TYPE_IP_FLAG
),
29 IPSET_TYPE_PORT_FLAG
= 1,
30 IPSET_TYPE_PORT
= (1 << IPSET_TYPE_PORT_FLAG
),
31 IPSET_TYPE_MAC_FLAG
= 2,
32 IPSET_TYPE_MAC
= (1 << IPSET_TYPE_MAC_FLAG
),
33 IPSET_TYPE_IP2_FLAG
= 3,
34 IPSET_TYPE_IP2
= (1 << IPSET_TYPE_IP2_FLAG
),
35 IPSET_TYPE_NAME_FLAG
= 4,
36 IPSET_TYPE_NAME
= (1 << IPSET_TYPE_NAME_FLAG
),
37 IPSET_TYPE_IFACE_FLAG
= 5,
38 IPSET_TYPE_IFACE
= (1 << IPSET_TYPE_IFACE_FLAG
),
39 IPSET_TYPE_MARK_FLAG
= 6,
40 IPSET_TYPE_MARK
= (1 << IPSET_TYPE_MARK_FLAG
),
41 IPSET_TYPE_NOMATCH_FLAG
= 7,
42 IPSET_TYPE_NOMATCH
= (1 << IPSET_TYPE_NOMATCH_FLAG
),
43 /* Strictly speaking not a feature, but a flag for dumping:
44 * this settype must be dumped last */
45 IPSET_DUMP_LAST_FLAG
= 8,
46 IPSET_DUMP_LAST
= (1 << IPSET_DUMP_LAST_FLAG
),
50 enum ip_set_extension
{
51 IPSET_EXT_BIT_TIMEOUT
= 0,
52 IPSET_EXT_TIMEOUT
= (1 << IPSET_EXT_BIT_TIMEOUT
),
53 IPSET_EXT_BIT_COUNTER
= 1,
54 IPSET_EXT_COUNTER
= (1 << IPSET_EXT_BIT_COUNTER
),
55 IPSET_EXT_BIT_COMMENT
= 2,
56 IPSET_EXT_COMMENT
= (1 << IPSET_EXT_BIT_COMMENT
),
57 IPSET_EXT_BIT_SKBINFO
= 3,
58 IPSET_EXT_SKBINFO
= (1 << IPSET_EXT_BIT_SKBINFO
),
59 /* Mark set with an extension which needs to call destroy */
60 IPSET_EXT_BIT_DESTROY
= 7,
61 IPSET_EXT_DESTROY
= (1 << IPSET_EXT_BIT_DESTROY
),
64 #define SET_WITH_TIMEOUT(s) ((s)->extensions & IPSET_EXT_TIMEOUT)
65 #define SET_WITH_COUNTER(s) ((s)->extensions & IPSET_EXT_COUNTER)
66 #define SET_WITH_COMMENT(s) ((s)->extensions & IPSET_EXT_COMMENT)
67 #define SET_WITH_SKBINFO(s) ((s)->extensions & IPSET_EXT_SKBINFO)
68 #define SET_WITH_FORCEADD(s) ((s)->flags & IPSET_CREATE_FLAG_FORCEADD)
70 /* Extension id, in size order */
72 IPSET_EXT_ID_COUNTER
= 0,
82 struct ip_set_ext_type
{
83 /* Destroy extension private data (can be NULL) */
84 void (*destroy
)(struct ip_set
*set
, void *ext
);
85 enum ip_set_extension type
;
86 enum ipset_cadt_flags flag
;
87 /* Size and minimal alignment */
92 extern const struct ip_set_ext_type ip_set_extensions
[];
94 struct ip_set_counter
{
99 struct ip_set_comment_rcu
{
104 struct ip_set_comment
{
105 struct ip_set_comment_rcu __rcu
*c
;
108 struct ip_set_skbinfo
{
117 struct ip_set_skbinfo skbinfo
;
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]))
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
);
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 */
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
);
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
);
168 /* Low level add/del/test functions */
169 ipset_adtfn adt
[IPSET_ADT_MAX
];
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
);
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
,
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 /* Region-locking is used */
195 struct ip_set_region
{
196 spinlock_t lock
; /* Region lock */
197 size_t ext_size
; /* Size of the dynamic extensions */
198 u32 elements
; /* Number of elements vs timeout */
201 /* The core set type structure */
203 struct list_head list
;
206 char name
[IPSET_MAXNAMELEN
];
207 /* Protocol version */
209 /* Set type dimension */
212 * Supported family: may be NFPROTO_UNSPEC for both
213 * NFPROTO_IPV4/NFPROTO_IPV6.
217 u8 revision_min
, revision_max
;
218 /* Set features to control swapping */
222 int (*create
)(struct net
*net
, struct ip_set
*set
,
223 struct nlattr
*tb
[], u32 flags
);
225 /* Attribute policies */
226 const struct nla_policy create_policy
[IPSET_ATTR_CREATE_MAX
+ 1];
227 const struct nla_policy adt_policy
[IPSET_ATTR_ADT_MAX
+ 1];
229 /* Set this to THIS_MODULE if you are a module, otherwise NULL */
233 /* register and unregister set type */
234 extern int ip_set_type_register(struct ip_set_type
*set_type
);
235 extern void ip_set_type_unregister(struct ip_set_type
*set_type
);
237 /* A generic IP set */
239 /* The name of the set */
240 char name
[IPSET_MAXNAMELEN
];
241 /* Lock protecting the set data */
243 /* References to the set */
245 /* References to the set for netlink events like dump,
246 * ref can be swapped out by ip_set_swap
249 /* The core set type */
250 struct ip_set_type
*type
;
251 /* The type variant doing the real job */
252 const struct ip_set_type_variant
*variant
;
253 /* The actual INET family of the set */
255 /* The type revision */
261 /* Default timeout value, if enabled */
263 /* Number of elements (vs timeout) */
265 /* Size of the dynamic extensions (vs timeout) */
267 /* Element data size */
269 /* Offsets to extensions in elements */
270 size_t offset
[IPSET_EXT_ID_MAX
];
271 /* The type specific data */
276 ip_set_ext_destroy(struct ip_set
*set
, void *data
)
278 /* Check that the extension is enabled for the set and
279 * call it's destroy function for its extension part in data.
281 if (SET_WITH_COMMENT(set
)) {
282 struct ip_set_comment
*c
= ext_comment(data
, set
);
284 ip_set_extensions
[IPSET_EXT_ID_COMMENT
].destroy(set
, c
);
288 int ip_set_put_flags(struct sk_buff
*skb
, struct ip_set
*set
);
290 /* Netlink CB args */
292 IPSET_CB_NET
= 0, /* net namespace */
293 IPSET_CB_PROTO
, /* ipset protocol */
294 IPSET_CB_DUMP
, /* dump single set/all sets */
295 IPSET_CB_INDEX
, /* set index */
296 IPSET_CB_PRIVATE
, /* set private data */
297 IPSET_CB_ARG0
, /* type specific */
300 /* register and unregister set references */
301 extern ip_set_id_t
ip_set_get_byname(struct net
*net
,
302 const char *name
, struct ip_set
**set
);
303 extern void ip_set_put_byindex(struct net
*net
, ip_set_id_t index
);
304 extern void ip_set_name_byindex(struct net
*net
, ip_set_id_t index
, char *name
);
305 extern ip_set_id_t
ip_set_nfnl_get_byindex(struct net
*net
, ip_set_id_t index
);
306 extern void ip_set_nfnl_put(struct net
*net
, ip_set_id_t index
);
308 /* API for iptables set match, and SET target */
310 extern int ip_set_add(ip_set_id_t id
, const struct sk_buff
*skb
,
311 const struct xt_action_param
*par
,
312 struct ip_set_adt_opt
*opt
);
313 extern int ip_set_del(ip_set_id_t id
, const struct sk_buff
*skb
,
314 const struct xt_action_param
*par
,
315 struct ip_set_adt_opt
*opt
);
316 extern int ip_set_test(ip_set_id_t id
, const struct sk_buff
*skb
,
317 const struct xt_action_param
*par
,
318 struct ip_set_adt_opt
*opt
);
320 /* Utility functions */
321 extern void *ip_set_alloc(size_t size
);
322 extern void ip_set_free(void *members
);
323 extern int ip_set_get_ipaddr4(struct nlattr
*nla
, __be32
*ipaddr
);
324 extern int ip_set_get_ipaddr6(struct nlattr
*nla
, union nf_inet_addr
*ipaddr
);
325 extern size_t ip_set_elem_len(struct ip_set
*set
, struct nlattr
*tb
[],
326 size_t len
, size_t align
);
327 extern int ip_set_get_extensions(struct ip_set
*set
, struct nlattr
*tb
[],
328 struct ip_set_ext
*ext
);
329 extern int ip_set_put_extensions(struct sk_buff
*skb
, const struct ip_set
*set
,
330 const void *e
, bool active
);
331 extern bool ip_set_match_extensions(struct ip_set
*set
,
332 const struct ip_set_ext
*ext
,
333 struct ip_set_ext
*mext
,
334 u32 flags
, void *data
);
337 ip_set_get_hostipaddr4(struct nlattr
*nla
, u32
*ipaddr
)
340 int ret
= ip_set_get_ipaddr4(nla
, &ip
);
348 /* Ignore IPSET_ERR_EXIST errors if asked to do so? */
350 ip_set_eexist(int ret
, u32 flags
)
352 return ret
== -IPSET_ERR_EXIST
&& (flags
& IPSET_FLAG_EXIST
);
355 /* Match elements marked with nomatch */
357 ip_set_enomatch(int ret
, u32 flags
, enum ipset_adt adt
, struct ip_set
*set
)
359 return adt
== IPSET_TEST
&&
360 (set
->type
->features
& IPSET_TYPE_NOMATCH
) &&
361 ((flags
>> 16) & IPSET_FLAG_NOMATCH
) &&
362 (ret
> 0 || ret
== -ENOTEMPTY
);
365 /* Check the NLA_F_NET_BYTEORDER flag */
367 ip_set_attr_netorder(struct nlattr
*tb
[], int type
)
369 return tb
[type
] && (tb
[type
]->nla_type
& NLA_F_NET_BYTEORDER
);
373 ip_set_optattr_netorder(struct nlattr
*tb
[], int type
)
375 return !tb
[type
] || (tb
[type
]->nla_type
& NLA_F_NET_BYTEORDER
);
378 /* Useful converters */
380 ip_set_get_h32(const struct nlattr
*attr
)
382 return ntohl(nla_get_be32(attr
));
386 ip_set_get_h16(const struct nlattr
*attr
)
388 return ntohs(nla_get_be16(attr
));
391 static inline int nla_put_ipaddr4(struct sk_buff
*skb
, int type
, __be32 ipaddr
)
393 struct nlattr
*__nested
= nla_nest_start(skb
, type
);
398 ret
= nla_put_in_addr(skb
, IPSET_ATTR_IPADDR_IPV4
, ipaddr
);
400 nla_nest_end(skb
, __nested
);
404 static inline int nla_put_ipaddr6(struct sk_buff
*skb
, int type
,
405 const struct in6_addr
*ipaddrptr
)
407 struct nlattr
*__nested
= nla_nest_start(skb
, type
);
412 ret
= nla_put_in6_addr(skb
, IPSET_ATTR_IPADDR_IPV6
, ipaddrptr
);
414 nla_nest_end(skb
, __nested
);
418 /* Get address from skbuff */
420 ip4addr(const struct sk_buff
*skb
, bool src
)
422 return src
? ip_hdr(skb
)->saddr
: ip_hdr(skb
)->daddr
;
426 ip4addrptr(const struct sk_buff
*skb
, bool src
, __be32
*addr
)
428 *addr
= src
? ip_hdr(skb
)->saddr
: ip_hdr(skb
)->daddr
;
432 ip6addrptr(const struct sk_buff
*skb
, bool src
, struct in6_addr
*addr
)
434 memcpy(addr
, src
? &ipv6_hdr(skb
)->saddr
: &ipv6_hdr(skb
)->daddr
,
438 /* How often should the gc be run by default */
439 #define IPSET_GC_TIME (3 * 60)
441 /* Timeout period depending on the timeout value of the given set */
442 #define IPSET_GC_PERIOD(timeout) \
443 ((timeout/3) ? min_t(u32, (timeout)/3, IPSET_GC_TIME) : 1)
445 /* Entry is set with no timeout value */
446 #define IPSET_ELEM_PERMANENT 0
448 /* Set is defined with timeout support: timeout value may be 0 */
449 #define IPSET_NO_TIMEOUT UINT_MAX
451 /* Max timeout value, see msecs_to_jiffies() in jiffies.h */
452 #define IPSET_MAX_TIMEOUT (UINT_MAX >> 1)/MSEC_PER_SEC
454 #define ip_set_adt_opt_timeout(opt, set) \
455 ((opt)->ext.timeout != IPSET_NO_TIMEOUT ? (opt)->ext.timeout : (set)->timeout)
457 static inline unsigned int
458 ip_set_timeout_uget(struct nlattr
*tb
)
460 unsigned int timeout
= ip_set_get_h32(tb
);
462 /* Normalize to fit into jiffies */
463 if (timeout
> IPSET_MAX_TIMEOUT
)
464 timeout
= IPSET_MAX_TIMEOUT
;
470 ip_set_timeout_expired(const unsigned long *t
)
472 return *t
!= IPSET_ELEM_PERMANENT
&& time_is_before_jiffies(*t
);
476 ip_set_timeout_set(unsigned long *timeout
, u32 value
)
481 *timeout
= IPSET_ELEM_PERMANENT
;
485 t
= msecs_to_jiffies(value
* MSEC_PER_SEC
) + jiffies
;
486 if (t
== IPSET_ELEM_PERMANENT
)
492 void ip_set_init_comment(struct ip_set
*set
, struct ip_set_comment
*comment
,
493 const struct ip_set_ext
*ext
);
496 ip_set_init_counter(struct ip_set_counter
*counter
,
497 const struct ip_set_ext
*ext
)
499 if (ext
->bytes
!= ULLONG_MAX
)
500 atomic64_set(&(counter
)->bytes
, (long long)(ext
->bytes
));
501 if (ext
->packets
!= ULLONG_MAX
)
502 atomic64_set(&(counter
)->packets
, (long long)(ext
->packets
));
506 ip_set_init_skbinfo(struct ip_set_skbinfo
*skbinfo
,
507 const struct ip_set_ext
*ext
)
509 *skbinfo
= ext
->skbinfo
;
512 #define IP_SET_INIT_KEXT(skb, opt, set) \
513 { .bytes = (skb)->len, .packets = 1, .target = true,\
514 .timeout = ip_set_adt_opt_timeout(opt, set) }
516 #define IP_SET_INIT_UEXT(set) \
517 { .bytes = ULLONG_MAX, .packets = ULLONG_MAX, \
518 .timeout = (set)->timeout }
520 #define IPSET_CONCAT(a, b) a##b
521 #define IPSET_TOKEN(a, b) IPSET_CONCAT(a, b)
523 #endif /*_IP_SET_H */