1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Copyright (C) 2003-2013 Jozsef Kadlecsik <kadlec@netfilter.org> */
3 
4 /* Kernel module implementing an IP set type: the hash:ip,port type */
5 
6 #include <linux/jhash.h>
7 #include <linux/module.h>
8 #include <linux/ip.h>
9 #include <linux/skbuff.h>
10 #include <linux/errno.h>
11 #include <linux/random.h>
12 #include <net/ip.h>
13 #include <net/ipv6.h>
14 #include <net/netlink.h>
15 #include <net/tcp.h>
16 
17 #include <linux/netfilter.h>
18 #include <linux/netfilter/ipset/pfxlen.h>
19 #include <linux/netfilter/ipset/ip_set.h>
20 #include <linux/netfilter/ipset/ip_set_getport.h>
21 #include <linux/netfilter/ipset/ip_set_hash.h>
22 
23 #define IPSET_TYPE_REV_MIN	0
24 /*				1    SCTP and UDPLITE support added */
25 /*				2    Counters support added */
26 /*				3    Comments support added */
27 /*				4    Forceadd support added */
28 /*				5    skbinfo support added */
29 #define IPSET_TYPE_REV_MAX	6 /* bucketsize, initval support added */
30 
31 MODULE_LICENSE("GPL");
32 MODULE_AUTHOR("Jozsef Kadlecsik <kadlec@netfilter.org>");
33 IP_SET_MODULE_DESC("hash:ip,port", IPSET_TYPE_REV_MIN, IPSET_TYPE_REV_MAX);
34 MODULE_ALIAS("ip_set_hash:ip,port");
35 
36 /* Type specific function prefix */
37 #define HTYPE		hash_ipport
38 
39 /* IPv4 variant */
40 
41 /* Member elements */
42 struct hash_ipport4_elem {
43 	__be32 ip;
44 	__be16 port;
45 	u8 proto;
46 	u8 padding;
47 };
48 
49 /* Common functions */
50 
51 static bool
52 hash_ipport4_data_equal(const struct hash_ipport4_elem *ip1,
53 			const struct hash_ipport4_elem *ip2,
54 			u32 *multi)
55 {
56 	return ip1->ip == ip2->ip &&
57 	       ip1->port == ip2->port &&
58 	       ip1->proto == ip2->proto;
59 }
60 
61 static bool
62 hash_ipport4_data_list(struct sk_buff *skb,
63 		       const struct hash_ipport4_elem *data)
64 {
65 	if (nla_put_ipaddr4(skb, IPSET_ATTR_IP, data->ip) ||
66 	    nla_put_net16(skb, IPSET_ATTR_PORT, data->port) ||
67 	    nla_put_u8(skb, IPSET_ATTR_PROTO, data->proto))
68 		goto nla_put_failure;
69 	return false;
70 
71 nla_put_failure:
72 	return true;
73 }
74 
75 static void
76 hash_ipport4_data_next(struct hash_ipport4_elem *next,
77 		       const struct hash_ipport4_elem *d)
78 {
79 	next->ip = d->ip;
80 	next->port = d->port;
81 }
82 
83 #define MTYPE		hash_ipport4
84 #define HOST_MASK	32
85 #include "ip_set_hash_gen.h"
86 
87 static int
88 hash_ipport4_kadt(struct ip_set *set, const struct sk_buff *skb,
89 		  const struct xt_action_param *par,
90 		  enum ipset_adt adt, struct ip_set_adt_opt *opt)
91 {
92 	ipset_adtfn adtfn = set->variant->adt[adt];
93 	struct hash_ipport4_elem e = { .ip = 0 };
94 	struct ip_set_ext ext = IP_SET_INIT_KEXT(skb, opt, set);
95 
96 	if (!ip_set_get_ip4_port(skb, opt->flags & IPSET_DIM_TWO_SRC,
97 				 &e.port, &e.proto))
98 		return -EINVAL;
99 
100 	ip4addrptr(skb, opt->flags & IPSET_DIM_ONE_SRC, &e.ip);
101 	return adtfn(set, &e, &ext, &opt->ext, opt->cmdflags);
102 }
103 
104 static int
105 hash_ipport4_uadt(struct ip_set *set, struct nlattr *tb[],
106 		  enum ipset_adt adt, u32 *lineno, u32 flags, bool retried)
107 {
108 	const struct hash_ipport4 *h = set->data;
109 	ipset_adtfn adtfn = set->variant->adt[adt];
110 	struct hash_ipport4_elem e = { .ip = 0 };
111 	struct ip_set_ext ext = IP_SET_INIT_UEXT(set);
112 	u32 ip, ip_to = 0, p = 0, port, port_to;
113 	bool with_ports = false;
114 	int ret;
115 
116 	if (tb[IPSET_ATTR_LINENO])
117 		*lineno = nla_get_u32(tb[IPSET_ATTR_LINENO]);
118 
119 	if (unlikely(!tb[IPSET_ATTR_IP] ||
120 		     !ip_set_attr_netorder(tb, IPSET_ATTR_PORT) ||
121 		     !ip_set_optattr_netorder(tb, IPSET_ATTR_PORT_TO)))
122 		return -IPSET_ERR_PROTOCOL;
123 
124 	ret = ip_set_get_ipaddr4(tb[IPSET_ATTR_IP], &e.ip);
125 	if (ret)
126 		return ret;
127 
128 	ret = ip_set_get_extensions(set, tb, &ext);
129 	if (ret)
130 		return ret;
131 
132 	e.port = nla_get_be16(tb[IPSET_ATTR_PORT]);
133 
134 	if (tb[IPSET_ATTR_PROTO]) {
135 		e.proto = nla_get_u8(tb[IPSET_ATTR_PROTO]);
136 		with_ports = ip_set_proto_with_ports(e.proto);
137 
138 		if (e.proto == 0)
139 			return -IPSET_ERR_INVALID_PROTO;
140 	} else {
141 		return -IPSET_ERR_MISSING_PROTO;
142 	}
143 
144 	if (!(with_ports || e.proto == IPPROTO_ICMP))
145 		e.port = 0;
146 
147 	if (adt == IPSET_TEST ||
148 	    !(tb[IPSET_ATTR_IP_TO] || tb[IPSET_ATTR_CIDR] ||
149 	      tb[IPSET_ATTR_PORT_TO])) {
150 		ret = adtfn(set, &e, &ext, &ext, flags);
151 		return ip_set_eexist(ret, flags) ? 0 : ret;
152 	}
153 
154 	ip_to = ip = ntohl(e.ip);
155 	if (tb[IPSET_ATTR_IP_TO]) {
156 		ret = ip_set_get_hostipaddr4(tb[IPSET_ATTR_IP_TO], &ip_to);
157 		if (ret)
158 			return ret;
159 		if (ip > ip_to)
160 			swap(ip, ip_to);
161 	} else if (tb[IPSET_ATTR_CIDR]) {
162 		u8 cidr = nla_get_u8(tb[IPSET_ATTR_CIDR]);
163 
164 		if (!cidr || cidr > HOST_MASK)
165 			return -IPSET_ERR_INVALID_CIDR;
166 		ip_set_mask_from_to(ip, ip_to, cidr);
167 	}
168 
169 	port_to = port = ntohs(e.port);
170 	if (with_ports && tb[IPSET_ATTR_PORT_TO]) {
171 		port_to = ip_set_get_h16(tb[IPSET_ATTR_PORT_TO]);
172 		if (port > port_to)
173 			swap(port, port_to);
174 	}
175 
176 	if (((u64)ip_to - ip + 1)*(port_to - port + 1) > IPSET_MAX_RANGE)
177 		return -ERANGE;
178 
179 	if (retried)
180 		ip = ntohl(h->next.ip);
181 	for (; ip <= ip_to; ip++) {
182 		p = retried && ip == ntohl(h->next.ip) ? ntohs(h->next.port)
183 						       : port;
184 		for (; p <= port_to; p++) {
185 			e.ip = htonl(ip);
186 			e.port = htons(p);
187 			ret = adtfn(set, &e, &ext, &ext, flags);
188 
189 			if (ret && !ip_set_eexist(ret, flags))
190 				return ret;
191 
192 			ret = 0;
193 		}
194 	}
195 	return ret;
196 }
197 
198 /* IPv6 variant */
199 
200 struct hash_ipport6_elem {
201 	union nf_inet_addr ip;
202 	__be16 port;
203 	u8 proto;
204 	u8 padding;
205 };
206 
207 /* Common functions */
208 
209 static bool
210 hash_ipport6_data_equal(const struct hash_ipport6_elem *ip1,
211 			const struct hash_ipport6_elem *ip2,
212 			u32 *multi)
213 {
214 	return ipv6_addr_equal(&ip1->ip.in6, &ip2->ip.in6) &&
215 	       ip1->port == ip2->port &&
216 	       ip1->proto == ip2->proto;
217 }
218 
219 static bool
220 hash_ipport6_data_list(struct sk_buff *skb,
221 		       const struct hash_ipport6_elem *data)
222 {
223 	if (nla_put_ipaddr6(skb, IPSET_ATTR_IP, &data->ip.in6) ||
224 	    nla_put_net16(skb, IPSET_ATTR_PORT, data->port) ||
225 	    nla_put_u8(skb, IPSET_ATTR_PROTO, data->proto))
226 		goto nla_put_failure;
227 	return false;
228 
229 nla_put_failure:
230 	return true;
231 }
232 
233 static void
234 hash_ipport6_data_next(struct hash_ipport6_elem *next,
235 		       const struct hash_ipport6_elem *d)
236 {
237 	next->port = d->port;
238 }
239 
240 #undef MTYPE
241 #undef HOST_MASK
242 
243 #define MTYPE		hash_ipport6
244 #define HOST_MASK	128
245 #define IP_SET_EMIT_CREATE
246 #include "ip_set_hash_gen.h"
247 
248 static int
249 hash_ipport6_kadt(struct ip_set *set, const struct sk_buff *skb,
250 		  const struct xt_action_param *par,
251 		  enum ipset_adt adt, struct ip_set_adt_opt *opt)
252 {
253 	ipset_adtfn adtfn = set->variant->adt[adt];
254 	struct hash_ipport6_elem e = { .ip = { .all = { 0 } } };
255 	struct ip_set_ext ext = IP_SET_INIT_KEXT(skb, opt, set);
256 
257 	if (!ip_set_get_ip6_port(skb, opt->flags & IPSET_DIM_TWO_SRC,
258 				 &e.port, &e.proto))
259 		return -EINVAL;
260 
261 	ip6addrptr(skb, opt->flags & IPSET_DIM_ONE_SRC, &e.ip.in6);
262 	return adtfn(set, &e, &ext, &opt->ext, opt->cmdflags);
263 }
264 
265 static int
266 hash_ipport6_uadt(struct ip_set *set, struct nlattr *tb[],
267 		  enum ipset_adt adt, u32 *lineno, u32 flags, bool retried)
268 {
269 	const struct hash_ipport6 *h = set->data;
270 	ipset_adtfn adtfn = set->variant->adt[adt];
271 	struct hash_ipport6_elem e = { .ip = { .all = { 0 } } };
272 	struct ip_set_ext ext = IP_SET_INIT_UEXT(set);
273 	u32 port, port_to;
274 	bool with_ports = false;
275 	int ret;
276 
277 	if (tb[IPSET_ATTR_LINENO])
278 		*lineno = nla_get_u32(tb[IPSET_ATTR_LINENO]);
279 
280 	if (unlikely(!tb[IPSET_ATTR_IP] ||
281 		     !ip_set_attr_netorder(tb, IPSET_ATTR_PORT) ||
282 		     !ip_set_optattr_netorder(tb, IPSET_ATTR_PORT_TO)))
283 		return -IPSET_ERR_PROTOCOL;
284 	if (unlikely(tb[IPSET_ATTR_IP_TO]))
285 		return -IPSET_ERR_HASH_RANGE_UNSUPPORTED;
286 	if (unlikely(tb[IPSET_ATTR_CIDR])) {
287 		u8 cidr = nla_get_u8(tb[IPSET_ATTR_CIDR]);
288 
289 		if (cidr != HOST_MASK)
290 			return -IPSET_ERR_INVALID_CIDR;
291 	}
292 
293 	ret = ip_set_get_ipaddr6(tb[IPSET_ATTR_IP], &e.ip);
294 	if (ret)
295 		return ret;
296 
297 	ret = ip_set_get_extensions(set, tb, &ext);
298 	if (ret)
299 		return ret;
300 
301 	e.port = nla_get_be16(tb[IPSET_ATTR_PORT]);
302 
303 	if (tb[IPSET_ATTR_PROTO]) {
304 		e.proto = nla_get_u8(tb[IPSET_ATTR_PROTO]);
305 		with_ports = ip_set_proto_with_ports(e.proto);
306 
307 		if (e.proto == 0)
308 			return -IPSET_ERR_INVALID_PROTO;
309 	} else {
310 		return -IPSET_ERR_MISSING_PROTO;
311 	}
312 
313 	if (!(with_ports || e.proto == IPPROTO_ICMPV6))
314 		e.port = 0;
315 
316 	if (adt == IPSET_TEST || !with_ports || !tb[IPSET_ATTR_PORT_TO]) {
317 		ret = adtfn(set, &e, &ext, &ext, flags);
318 		return ip_set_eexist(ret, flags) ? 0 : ret;
319 	}
320 
321 	port = ntohs(e.port);
322 	port_to = ip_set_get_h16(tb[IPSET_ATTR_PORT_TO]);
323 	if (port > port_to)
324 		swap(port, port_to);
325 
326 	if (retried)
327 		port = ntohs(h->next.port);
328 	for (; port <= port_to; port++) {
329 		e.port = htons(port);
330 		ret = adtfn(set, &e, &ext, &ext, flags);
331 
332 		if (ret && !ip_set_eexist(ret, flags))
333 			return ret;
334 
335 		ret = 0;
336 	}
337 	return ret;
338 }
339 
340 static struct ip_set_type hash_ipport_type __read_mostly = {
341 	.name		= "hash:ip,port",
342 	.protocol	= IPSET_PROTOCOL,
343 	.features	= IPSET_TYPE_IP | IPSET_TYPE_PORT,
344 	.dimension	= IPSET_DIM_TWO,
345 	.family		= NFPROTO_UNSPEC,
346 	.revision_min	= IPSET_TYPE_REV_MIN,
347 	.revision_max	= IPSET_TYPE_REV_MAX,
348 	.create_flags[IPSET_TYPE_REV_MAX] = IPSET_CREATE_FLAG_BUCKETSIZE,
349 	.create		= hash_ipport_create,
350 	.create_policy	= {
351 		[IPSET_ATTR_HASHSIZE]	= { .type = NLA_U32 },
352 		[IPSET_ATTR_MAXELEM]	= { .type = NLA_U32 },
353 		[IPSET_ATTR_INITVAL]	= { .type = NLA_U32 },
354 		[IPSET_ATTR_BUCKETSIZE]	= { .type = NLA_U8 },
355 		[IPSET_ATTR_RESIZE]	= { .type = NLA_U8  },
356 		[IPSET_ATTR_PROTO]	= { .type = NLA_U8 },
357 		[IPSET_ATTR_TIMEOUT]	= { .type = NLA_U32 },
358 		[IPSET_ATTR_CADT_FLAGS]	= { .type = NLA_U32 },
359 	},
360 	.adt_policy	= {
361 		[IPSET_ATTR_IP]		= { .type = NLA_NESTED },
362 		[IPSET_ATTR_IP_TO]	= { .type = NLA_NESTED },
363 		[IPSET_ATTR_PORT]	= { .type = NLA_U16 },
364 		[IPSET_ATTR_PORT_TO]	= { .type = NLA_U16 },
365 		[IPSET_ATTR_CIDR]	= { .type = NLA_U8 },
366 		[IPSET_ATTR_PROTO]	= { .type = NLA_U8 },
367 		[IPSET_ATTR_TIMEOUT]	= { .type = NLA_U32 },
368 		[IPSET_ATTR_LINENO]	= { .type = NLA_U32 },
369 		[IPSET_ATTR_BYTES]	= { .type = NLA_U64 },
370 		[IPSET_ATTR_PACKETS]	= { .type = NLA_U64 },
371 		[IPSET_ATTR_COMMENT]	= { .type = NLA_NUL_STRING,
372 					    .len  = IPSET_MAX_COMMENT_SIZE },
373 		[IPSET_ATTR_SKBMARK]	= { .type = NLA_U64 },
374 		[IPSET_ATTR_SKBPRIO]	= { .type = NLA_U32 },
375 		[IPSET_ATTR_SKBQUEUE]	= { .type = NLA_U16 },
376 	},
377 	.me		= THIS_MODULE,
378 };
379 
380 static int __init
381 hash_ipport_init(void)
382 {
383 	return ip_set_type_register(&hash_ipport_type);
384 }
385 
386 static void __exit
387 hash_ipport_fini(void)
388 {
389 	rcu_barrier();
390 	ip_set_type_unregister(&hash_ipport_type);
391 }
392 
393 module_init(hash_ipport_init);
394 module_exit(hash_ipport_fini);
395