xref: /openbmc/linux/net/tipc/udp_media.c (revision 029f7f3b8701cc7aca8bdb31f0c7edd6a479e357)
1 /* net/tipc/udp_media.c: IP bearer support for TIPC
2  *
3  * Copyright (c) 2015, Ericsson AB
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. Neither the names of the copyright holders nor the names of its
15  *    contributors may be used to endorse or promote products derived from
16  *    this software without specific prior written permission.
17  *
18  * Alternatively, this software may be distributed under the terms of the
19  * GNU General Public License ("GPL") version 2 as published by the Free
20  * Software Foundation.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #include <linux/socket.h>
36 #include <linux/ip.h>
37 #include <linux/udp.h>
38 #include <linux/inet.h>
39 #include <linux/inetdevice.h>
40 #include <linux/igmp.h>
41 #include <linux/kernel.h>
42 #include <linux/workqueue.h>
43 #include <linux/list.h>
44 #include <net/sock.h>
45 #include <net/ip.h>
46 #include <net/udp_tunnel.h>
47 #include <net/addrconf.h>
48 #include <linux/tipc_netlink.h>
49 #include "core.h"
50 #include "bearer.h"
51 
52 /* IANA assigned UDP port */
53 #define UDP_PORT_DEFAULT	6118
54 
55 #define UDP_MIN_HEADROOM        28
56 
57 static const struct nla_policy tipc_nl_udp_policy[TIPC_NLA_UDP_MAX + 1] = {
58 	[TIPC_NLA_UDP_UNSPEC]	= {.type = NLA_UNSPEC},
59 	[TIPC_NLA_UDP_LOCAL]	= {.type = NLA_BINARY,
60 				   .len = sizeof(struct sockaddr_storage)},
61 	[TIPC_NLA_UDP_REMOTE]	= {.type = NLA_BINARY,
62 				   .len = sizeof(struct sockaddr_storage)},
63 };
64 
65 /**
66  * struct udp_media_addr - IP/UDP addressing information
67  *
68  * This is the bearer level originating address used in neighbor discovery
69  * messages, and all fields should be in network byte order
70  */
71 struct udp_media_addr {
72 	__be16	proto;
73 	__be16	udp_port;
74 	union {
75 		struct in_addr ipv4;
76 		struct in6_addr ipv6;
77 	};
78 };
79 
80 /**
81  * struct udp_bearer - ip/udp bearer data structure
82  * @bearer:	associated generic tipc bearer
83  * @ubsock:	bearer associated socket
84  * @ifindex:	local address scope
85  * @work:	used to schedule deferred work on a bearer
86  */
87 struct udp_bearer {
88 	struct tipc_bearer __rcu *bearer;
89 	struct socket *ubsock;
90 	u32 ifindex;
91 	struct work_struct work;
92 };
93 
94 /* udp_media_addr_set - convert a ip/udp address to a TIPC media address */
95 static void tipc_udp_media_addr_set(struct tipc_media_addr *addr,
96 				    struct udp_media_addr *ua)
97 {
98 	memset(addr, 0, sizeof(struct tipc_media_addr));
99 	addr->media_id = TIPC_MEDIA_TYPE_UDP;
100 	memcpy(addr->value, ua, sizeof(struct udp_media_addr));
101 	if (ntohs(ua->proto) == ETH_P_IP) {
102 		if (ipv4_is_multicast(ua->ipv4.s_addr))
103 			addr->broadcast = 1;
104 	} else if (ntohs(ua->proto) == ETH_P_IPV6) {
105 		if (ipv6_addr_type(&ua->ipv6) & IPV6_ADDR_MULTICAST)
106 			addr->broadcast = 1;
107 	} else {
108 		pr_err("Invalid UDP media address\n");
109 	}
110 }
111 
112 /* tipc_udp_addr2str - convert ip/udp address to string */
113 static int tipc_udp_addr2str(struct tipc_media_addr *a, char *buf, int size)
114 {
115 	struct udp_media_addr *ua = (struct udp_media_addr *)&a->value;
116 
117 	if (ntohs(ua->proto) == ETH_P_IP)
118 		snprintf(buf, size, "%pI4:%u", &ua->ipv4, ntohs(ua->udp_port));
119 	else if (ntohs(ua->proto) == ETH_P_IPV6)
120 		snprintf(buf, size, "%pI6:%u", &ua->ipv6, ntohs(ua->udp_port));
121 	else
122 		pr_err("Invalid UDP media address\n");
123 	return 0;
124 }
125 
126 /* tipc_udp_msg2addr - extract an ip/udp address from a TIPC ndisc message */
127 static int tipc_udp_msg2addr(struct tipc_bearer *b, struct tipc_media_addr *a,
128 			     char *msg)
129 {
130 	struct udp_media_addr *ua;
131 
132 	ua = (struct udp_media_addr *) (msg + TIPC_MEDIA_ADDR_OFFSET);
133 	if (msg[TIPC_MEDIA_TYPE_OFFSET] != TIPC_MEDIA_TYPE_UDP)
134 		return -EINVAL;
135 	tipc_udp_media_addr_set(a, ua);
136 	return 0;
137 }
138 
139 /* tipc_udp_addr2msg - write an ip/udp address to a TIPC ndisc message */
140 static int tipc_udp_addr2msg(char *msg, struct tipc_media_addr *a)
141 {
142 	memset(msg, 0, TIPC_MEDIA_INFO_SIZE);
143 	msg[TIPC_MEDIA_TYPE_OFFSET] = TIPC_MEDIA_TYPE_UDP;
144 	memcpy(msg + TIPC_MEDIA_ADDR_OFFSET, a->value,
145 	       sizeof(struct udp_media_addr));
146 	return 0;
147 }
148 
149 /* tipc_send_msg - enqueue a send request */
150 static int tipc_udp_send_msg(struct net *net, struct sk_buff *skb,
151 			     struct tipc_bearer *b,
152 			     struct tipc_media_addr *dest)
153 {
154 	int ttl, err = 0;
155 	struct udp_bearer *ub;
156 	struct udp_media_addr *dst = (struct udp_media_addr *)&dest->value;
157 	struct udp_media_addr *src = (struct udp_media_addr *)&b->addr.value;
158 	struct rtable *rt;
159 
160 	if (skb_headroom(skb) < UDP_MIN_HEADROOM)
161 		pskb_expand_head(skb, UDP_MIN_HEADROOM, 0, GFP_ATOMIC);
162 
163 	skb_set_inner_protocol(skb, htons(ETH_P_TIPC));
164 	ub = rcu_dereference_rtnl(b->media_ptr);
165 	if (!ub) {
166 		err = -ENODEV;
167 		goto tx_error;
168 	}
169 	if (dst->proto == htons(ETH_P_IP)) {
170 		struct flowi4 fl = {
171 			.daddr = dst->ipv4.s_addr,
172 			.saddr = src->ipv4.s_addr,
173 			.flowi4_mark = skb->mark,
174 			.flowi4_proto = IPPROTO_UDP
175 		};
176 		rt = ip_route_output_key(net, &fl);
177 		if (IS_ERR(rt)) {
178 			err = PTR_ERR(rt);
179 			goto tx_error;
180 		}
181 		ttl = ip4_dst_hoplimit(&rt->dst);
182 		err = udp_tunnel_xmit_skb(rt, ub->ubsock->sk, skb,
183 					  src->ipv4.s_addr,
184 					  dst->ipv4.s_addr, 0, ttl, 0,
185 					  src->udp_port, dst->udp_port,
186 					  false, true);
187 		if (err < 0) {
188 			ip_rt_put(rt);
189 			goto tx_error;
190 		}
191 #if IS_ENABLED(CONFIG_IPV6)
192 	} else {
193 		struct dst_entry *ndst;
194 		struct flowi6 fl6 = {
195 			.flowi6_oif = ub->ifindex,
196 			.daddr = dst->ipv6,
197 			.saddr = src->ipv6,
198 			.flowi6_proto = IPPROTO_UDP
199 		};
200 		err = ipv6_stub->ipv6_dst_lookup(net, ub->ubsock->sk, &ndst,
201 						 &fl6);
202 		if (err)
203 			goto tx_error;
204 		ttl = ip6_dst_hoplimit(ndst);
205 		err = udp_tunnel6_xmit_skb(ndst, ub->ubsock->sk, skb,
206 					   ndst->dev, &src->ipv6,
207 					   &dst->ipv6, 0, ttl, src->udp_port,
208 					   dst->udp_port, false);
209 #endif
210 	}
211 	return err;
212 
213 tx_error:
214 	kfree_skb(skb);
215 	return err;
216 }
217 
218 /* tipc_udp_recv - read data from bearer socket */
219 static int tipc_udp_recv(struct sock *sk, struct sk_buff *skb)
220 {
221 	struct udp_bearer *ub;
222 	struct tipc_bearer *b;
223 
224 	ub = rcu_dereference_sk_user_data(sk);
225 	if (!ub) {
226 		pr_err_ratelimited("Failed to get UDP bearer reference");
227 		kfree_skb(skb);
228 		return 0;
229 	}
230 
231 	skb_pull(skb, sizeof(struct udphdr));
232 	rcu_read_lock();
233 	b = rcu_dereference_rtnl(ub->bearer);
234 
235 	if (b) {
236 		tipc_rcv(sock_net(sk), skb, b);
237 		rcu_read_unlock();
238 		return 0;
239 	}
240 	rcu_read_unlock();
241 	kfree_skb(skb);
242 	return 0;
243 }
244 
245 static int enable_mcast(struct udp_bearer *ub, struct udp_media_addr *remote)
246 {
247 	int err = 0;
248 	struct ip_mreqn mreqn;
249 	struct sock *sk = ub->ubsock->sk;
250 
251 	if (ntohs(remote->proto) == ETH_P_IP) {
252 		if (!ipv4_is_multicast(remote->ipv4.s_addr))
253 			return 0;
254 		mreqn.imr_multiaddr = remote->ipv4;
255 		mreqn.imr_ifindex = ub->ifindex;
256 		err = ip_mc_join_group(sk, &mreqn);
257 #if IS_ENABLED(CONFIG_IPV6)
258 	} else {
259 		if (!ipv6_addr_is_multicast(&remote->ipv6))
260 			return 0;
261 		err = ipv6_stub->ipv6_sock_mc_join(sk, ub->ifindex,
262 						   &remote->ipv6);
263 #endif
264 	}
265 	return err;
266 }
267 
268 /**
269  * parse_options - build local/remote addresses from configuration
270  * @attrs:	netlink config data
271  * @ub:		UDP bearer instance
272  * @local:	local bearer IP address/port
273  * @remote:	peer or multicast IP/port
274  */
275 static int parse_options(struct nlattr *attrs[], struct udp_bearer *ub,
276 			 struct udp_media_addr *local,
277 			 struct udp_media_addr *remote)
278 {
279 	struct nlattr *opts[TIPC_NLA_UDP_MAX + 1];
280 	struct sockaddr_storage *sa_local, *sa_remote;
281 
282 	if (!attrs[TIPC_NLA_BEARER_UDP_OPTS])
283 		goto err;
284 	if (nla_parse_nested(opts, TIPC_NLA_UDP_MAX,
285 			     attrs[TIPC_NLA_BEARER_UDP_OPTS],
286 			     tipc_nl_udp_policy))
287 		goto err;
288 	if (opts[TIPC_NLA_UDP_LOCAL] && opts[TIPC_NLA_UDP_REMOTE]) {
289 		sa_local = nla_data(opts[TIPC_NLA_UDP_LOCAL]);
290 		sa_remote = nla_data(opts[TIPC_NLA_UDP_REMOTE]);
291 	} else {
292 err:
293 		pr_err("Invalid UDP bearer configuration");
294 		return -EINVAL;
295 	}
296 	if ((sa_local->ss_family & sa_remote->ss_family) == AF_INET) {
297 		struct sockaddr_in *ip4;
298 
299 		ip4 = (struct sockaddr_in *)sa_local;
300 		local->proto = htons(ETH_P_IP);
301 		local->udp_port = ip4->sin_port;
302 		local->ipv4.s_addr = ip4->sin_addr.s_addr;
303 
304 		ip4 = (struct sockaddr_in *)sa_remote;
305 		remote->proto = htons(ETH_P_IP);
306 		remote->udp_port = ip4->sin_port;
307 		remote->ipv4.s_addr = ip4->sin_addr.s_addr;
308 		return 0;
309 
310 #if IS_ENABLED(CONFIG_IPV6)
311 	} else if ((sa_local->ss_family & sa_remote->ss_family) == AF_INET6) {
312 		struct sockaddr_in6 *ip6;
313 
314 		ip6 = (struct sockaddr_in6 *)sa_local;
315 		local->proto = htons(ETH_P_IPV6);
316 		local->udp_port = ip6->sin6_port;
317 		local->ipv6 = ip6->sin6_addr;
318 		ub->ifindex = ip6->sin6_scope_id;
319 
320 		ip6 = (struct sockaddr_in6 *)sa_remote;
321 		remote->proto = htons(ETH_P_IPV6);
322 		remote->udp_port = ip6->sin6_port;
323 		remote->ipv6 = ip6->sin6_addr;
324 		return 0;
325 #endif
326 	}
327 	return -EADDRNOTAVAIL;
328 }
329 
330 /**
331  * tipc_udp_enable - callback to create a new udp bearer instance
332  * @net:	network namespace
333  * @b:		pointer to generic tipc_bearer
334  * @attrs:	netlink bearer configuration
335  *
336  * validate the bearer parameters and initialize the udp bearer
337  * rtnl_lock should be held
338  */
339 static int tipc_udp_enable(struct net *net, struct tipc_bearer *b,
340 			   struct nlattr *attrs[])
341 {
342 	int err = -EINVAL;
343 	struct udp_bearer *ub;
344 	struct udp_media_addr *remote;
345 	struct udp_media_addr local = {0};
346 	struct udp_port_cfg udp_conf = {0};
347 	struct udp_tunnel_sock_cfg tuncfg = {NULL};
348 
349 	ub = kzalloc(sizeof(*ub), GFP_ATOMIC);
350 	if (!ub)
351 		return -ENOMEM;
352 
353 	remote = (struct udp_media_addr *)&b->bcast_addr.value;
354 	memset(remote, 0, sizeof(struct udp_media_addr));
355 	err = parse_options(attrs, ub, &local, remote);
356 	if (err)
357 		goto err;
358 
359 	b->bcast_addr.media_id = TIPC_MEDIA_TYPE_UDP;
360 	b->bcast_addr.broadcast = 1;
361 	rcu_assign_pointer(b->media_ptr, ub);
362 	rcu_assign_pointer(ub->bearer, b);
363 	tipc_udp_media_addr_set(&b->addr, &local);
364 	if (local.proto == htons(ETH_P_IP)) {
365 		struct net_device *dev;
366 
367 		dev = __ip_dev_find(net, local.ipv4.s_addr, false);
368 		if (!dev) {
369 			err = -ENODEV;
370 			goto err;
371 		}
372 		udp_conf.family = AF_INET;
373 		udp_conf.local_ip.s_addr = htonl(INADDR_ANY);
374 		udp_conf.use_udp_checksums = false;
375 		ub->ifindex = dev->ifindex;
376 		b->mtu = dev->mtu - sizeof(struct iphdr)
377 			- sizeof(struct udphdr);
378 #if IS_ENABLED(CONFIG_IPV6)
379 	} else if (local.proto == htons(ETH_P_IPV6)) {
380 		udp_conf.family = AF_INET6;
381 		udp_conf.use_udp6_tx_checksums = true;
382 		udp_conf.use_udp6_rx_checksums = true;
383 		udp_conf.local_ip6 = in6addr_any;
384 		b->mtu = 1280;
385 #endif
386 	} else {
387 		err = -EAFNOSUPPORT;
388 		goto err;
389 	}
390 	udp_conf.local_udp_port = local.udp_port;
391 	err = udp_sock_create(net, &udp_conf, &ub->ubsock);
392 	if (err)
393 		goto err;
394 	tuncfg.sk_user_data = ub;
395 	tuncfg.encap_type = 1;
396 	tuncfg.encap_rcv = tipc_udp_recv;
397 	tuncfg.encap_destroy = NULL;
398 	setup_udp_tunnel_sock(net, ub->ubsock, &tuncfg);
399 
400 	if (enable_mcast(ub, remote))
401 		goto err;
402 	return 0;
403 err:
404 	kfree(ub);
405 	return err;
406 }
407 
408 /* cleanup_bearer - break the socket/bearer association */
409 static void cleanup_bearer(struct work_struct *work)
410 {
411 	struct udp_bearer *ub = container_of(work, struct udp_bearer, work);
412 
413 	if (ub->ubsock)
414 		udp_tunnel_sock_release(ub->ubsock);
415 	synchronize_net();
416 	kfree(ub);
417 }
418 
419 /* tipc_udp_disable - detach bearer from socket */
420 static void tipc_udp_disable(struct tipc_bearer *b)
421 {
422 	struct udp_bearer *ub;
423 
424 	ub = rcu_dereference_rtnl(b->media_ptr);
425 	if (!ub) {
426 		pr_err("UDP bearer instance not found\n");
427 		return;
428 	}
429 	if (ub->ubsock)
430 		sock_set_flag(ub->ubsock->sk, SOCK_DEAD);
431 	RCU_INIT_POINTER(ub->bearer, NULL);
432 
433 	/* sock_release need to be done outside of rtnl lock */
434 	INIT_WORK(&ub->work, cleanup_bearer);
435 	schedule_work(&ub->work);
436 }
437 
438 struct tipc_media udp_media_info = {
439 	.send_msg	= tipc_udp_send_msg,
440 	.enable_media	= tipc_udp_enable,
441 	.disable_media	= tipc_udp_disable,
442 	.addr2str	= tipc_udp_addr2str,
443 	.addr2msg	= tipc_udp_addr2msg,
444 	.msg2addr	= tipc_udp_msg2addr,
445 	.priority	= TIPC_DEF_LINK_PRI,
446 	.tolerance	= TIPC_DEF_LINK_TOL,
447 	.window		= TIPC_DEF_LINK_WIN,
448 	.type_id	= TIPC_MEDIA_TYPE_UDP,
449 	.hwaddr_len	= 0,
450 	.name		= "udp"
451 };
452