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