blob: 02d05e2a94af11ee15570bb94ebaac1dd728b978 [file] [log] [blame]
Harald Welte468b6432014-09-11 13:05:51 +08001/*
Harald Welte48f55832017-01-26 00:03:10 +01002 * (C) 2011-2017 by Harald Welte <laforge@gnumonks.org>
Harald Welte468b6432014-09-11 13:05:51 +08003 *
4 * All Rights Reserved
5 *
Harald Weltee08da972017-11-13 01:00:26 +09006 * SPDX-License-Identifier: GPL-2.0+
7 *
Harald Welte468b6432014-09-11 13:05:51 +08008 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
Harald Welte468b6432014-09-11 13:05:51 +080018 */
19
Pau Espin Pedrol88955fb2023-01-18 18:54:00 +010020#include "config.h"
Harald Welte33cb71a2011-05-21 18:54:32 +020021
Harald Welteba6988b2011-08-17 12:46:48 +020022/*! \addtogroup socket
23 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020024 * Osmocom socket convenience functions.
25 *
26 * \file socket.c */
Harald Welte96e2a002017-06-12 21:44:18 +020027
Harald Weltee4764422011-05-22 12:25:57 +020028#ifdef HAVE_SYS_SOCKET_H
29
Harald Welte33cb71a2011-05-21 18:54:32 +020030#include <osmocom/core/logging.h>
31#include <osmocom/core/select.h>
32#include <osmocom/core/socket.h>
Alexander Couzens43957e62020-08-01 21:56:45 +020033#include <osmocom/core/sockaddr_str.h>
Harald Welte48f55832017-01-26 00:03:10 +010034#include <osmocom/core/talloc.h>
Neels Hofmeyr59f4caf2018-07-19 22:13:19 +020035#include <osmocom/core/utils.h>
Harald Welte33cb71a2011-05-21 18:54:32 +020036
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +020037#include <sys/ioctl.h>
Harald Welte33cb71a2011-05-21 18:54:32 +020038#include <sys/socket.h>
39#include <sys/types.h>
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +010040#include <sys/un.h>
Harald Welte44b99262020-03-07 14:59:05 +010041#include <net/if.h>
Harald Welte33cb71a2011-05-21 18:54:32 +020042
Holger Hans Peter Freyther47723482011-11-09 11:26:15 +010043#include <netinet/in.h>
Harald Weltee30d7e62017-07-13 16:02:50 +020044#include <arpa/inet.h>
Holger Hans Peter Freyther47723482011-11-09 11:26:15 +010045
Harald Welte33cb71a2011-05-21 18:54:32 +020046#include <stdio.h>
47#include <unistd.h>
48#include <stdint.h>
49#include <string.h>
50#include <errno.h>
51#include <netdb.h>
52#include <ifaddrs.h>
53
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +020054#ifdef HAVE_LIBSCTP
55#include <netinet/sctp.h>
56#endif
57
Harald Weltedda70fc2017-04-08 20:52:33 +020058static struct addrinfo *addrinfo_helper(uint16_t family, uint16_t type, uint8_t proto,
59 const char *host, uint16_t port, bool passive)
60{
Pau Espin Pedrolff428522019-10-10 17:38:16 +020061 struct addrinfo hints, *result, *rp;
Oliver Smith860651e2018-10-30 14:31:57 +010062 char portbuf[6];
Harald Weltedda70fc2017-04-08 20:52:33 +020063 int rc;
64
65 snprintf(portbuf, sizeof(portbuf), "%u", port);
66 memset(&hints, 0, sizeof(struct addrinfo));
67 hints.ai_family = family;
68 if (type == SOCK_RAW) {
69 /* Workaround for glibc, that returns EAI_SERVICE (-8) if
70 * SOCK_RAW and IPPROTO_GRE is used.
Pau Espin Pedrolff428522019-10-10 17:38:16 +020071 * http://sourceware.org/bugzilla/show_bug.cgi?id=15015
Harald Weltedda70fc2017-04-08 20:52:33 +020072 */
73 hints.ai_socktype = SOCK_DGRAM;
74 hints.ai_protocol = IPPROTO_UDP;
75 } else {
76 hints.ai_socktype = type;
77 hints.ai_protocol = proto;
78 }
Pau Espin Pedrol3119d472020-08-25 12:30:55 +020079
Harald Weltedda70fc2017-04-08 20:52:33 +020080 if (passive)
81 hints.ai_flags |= AI_PASSIVE;
82
83 rc = getaddrinfo(host, portbuf, &hints, &result);
84 if (rc != 0) {
Pau Espin Pedrolba828c32020-08-20 18:28:10 +020085 LOGP(DLGLOBAL, LOGL_ERROR, "getaddrinfo(%s, %u) failed: %s\n",
86 host, port, gai_strerror(rc));
Harald Weltedda70fc2017-04-08 20:52:33 +020087 return NULL;
88 }
89
Pau Espin Pedrolff428522019-10-10 17:38:16 +020090 for (rp = result; rp != NULL; rp = rp->ai_next) {
91 /* Workaround for glibc again */
92 if (type == SOCK_RAW) {
93 rp->ai_socktype = SOCK_RAW;
94 rp->ai_protocol = proto;
95 }
96 }
97
Harald Weltedda70fc2017-04-08 20:52:33 +020098 return result;
99}
100
Pau Espin Pedrol8fac5112019-10-24 15:39:25 +0200101#ifdef HAVE_LIBSCTP
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200102/*! Retrieve an array of addrinfo with specified hints, one for each host in the hosts array.
103 * \param[out] addrinfo array of addrinfo pointers, will be filled by the function on success.
104 * Its size must be at least the one of hosts.
105 * \param[in] family Socket family like AF_INET, AF_INET6.
106 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM.
107 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP.
108 * \param[in] hosts array of char pointers (strings) containing the addresses to query.
109 * \param[in] host_cnt length of the hosts array (in items).
110 * \param[in] port port number in host byte order.
111 * \param[in] passive whether to include the AI_PASSIVE flag in getaddrinfo() hints.
112 * \returns 0 is returned on success together with a filled addrinfo array; negative on error
113 */
114static int addrinfo_helper_multi(struct addrinfo **addrinfo, uint16_t family, uint16_t type, uint8_t proto,
115 const char **hosts, size_t host_cnt, uint16_t port, bool passive)
116{
Harald Welte0b08d512022-01-09 12:03:12 +0100117 unsigned int i, j;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200118
119 for (i = 0; i < host_cnt; i++) {
120 addrinfo[i] = addrinfo_helper(family, type, proto, hosts[i], port, passive);
121 if (!addrinfo[i]) {
122 for (j = 0; j < i; j++)
123 freeaddrinfo(addrinfo[j]);
124 return -EINVAL;
125 }
126 }
127 return 0;
128}
Pau Espin Pedrol8fac5112019-10-24 15:39:25 +0200129#endif /* HAVE_LIBSCTP*/
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200130
Harald Weltefaf6b702021-04-28 13:04:59 +0200131static int socket_helper_tail(int sfd, unsigned int flags)
132{
Harald Weltec545ff62021-04-28 13:09:49 +0200133 int rc, on = 1;
134 uint8_t dscp = GET_OSMO_SOCK_F_DSCP(flags);
135 uint8_t prio = GET_OSMO_SOCK_F_PRIO(flags);
Harald Weltefaf6b702021-04-28 13:04:59 +0200136
137 if (flags & OSMO_SOCK_F_NONBLOCK) {
138 if (ioctl(sfd, FIONBIO, (unsigned char *)&on) < 0) {
139 LOGP(DLGLOBAL, LOGL_ERROR,
140 "cannot set this socket unblocking: %s\n",
141 strerror(errno));
142 close(sfd);
143 return -EINVAL;
144 }
145 }
146
Harald Weltec545ff62021-04-28 13:09:49 +0200147 if (dscp) {
148 rc = osmo_sock_set_dscp(sfd, dscp);
149 if (rc) {
150 LOGP(DLGLOBAL, LOGL_ERROR, "cannot set IP DSCP of socket to %u: %s\n",
151 dscp, strerror(errno));
152 /* we consider this a non-fatal error */
153 }
154 }
155
156 if (prio) {
157 rc = osmo_sock_set_priority(sfd, prio);
158 if (rc) {
159 LOGP(DLGLOBAL, LOGL_ERROR, "cannot set priority of socket to %u: %s\n",
160 prio, strerror(errno));
161 /* we consider this a non-fatal error */
162 }
163 }
164
Harald Weltefaf6b702021-04-28 13:04:59 +0200165 return 0;
166}
167
Harald Weltedda70fc2017-04-08 20:52:33 +0200168static int socket_helper(const struct addrinfo *rp, unsigned int flags)
169{
Harald Weltefaf6b702021-04-28 13:04:59 +0200170 int sfd, rc;
Harald Weltedda70fc2017-04-08 20:52:33 +0200171
172 sfd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
Pau Espin Pedrol5d50fa52018-04-05 17:00:22 +0200173 if (sfd == -1) {
174 LOGP(DLGLOBAL, LOGL_ERROR,
175 "unable to create socket: %s\n", strerror(errno));
Harald Weltedda70fc2017-04-08 20:52:33 +0200176 return sfd;
Pau Espin Pedrol5d50fa52018-04-05 17:00:22 +0200177 }
Harald Weltefaf6b702021-04-28 13:04:59 +0200178
179 rc = socket_helper_tail(sfd, flags);
180 if (rc < 0)
181 return rc;
182
Harald Weltedda70fc2017-04-08 20:52:33 +0200183 return sfd;
184}
185
Alexander Couzens43957e62020-08-01 21:56:45 +0200186static int socket_helper_osa(const struct osmo_sockaddr *addr, uint16_t type, uint8_t proto, unsigned int flags)
187{
Harald Weltefaf6b702021-04-28 13:04:59 +0200188 int sfd, rc;
Alexander Couzens43957e62020-08-01 21:56:45 +0200189
190 sfd = socket(addr->u.sa.sa_family, type, proto);
191 if (sfd == -1) {
192 LOGP(DLGLOBAL, LOGL_ERROR,
193 "unable to create socket: %s\n", strerror(errno));
194 return sfd;
195 }
Harald Weltefaf6b702021-04-28 13:04:59 +0200196
197 rc = socket_helper_tail(sfd, flags);
198 if (rc < 0)
199 return rc;
200
Alexander Couzens43957e62020-08-01 21:56:45 +0200201 return sfd;
202}
203
Pau Espin Pedrol8fac5112019-10-24 15:39:25 +0200204#ifdef HAVE_LIBSCTP
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200205/* Fill buf with a string representation of the address set, in the form:
206 * buf_len == 0: "()"
207 * buf_len == 1: "hostA"
208 * buf_len >= 2: (hostA|hostB|...|...)
209 */
210static int multiaddr_snprintf(char* buf, size_t buf_len, const char **hosts, size_t host_cnt)
211{
212 int len = 0, offset = 0, rem = buf_len;
Harald Welte0b08d512022-01-09 12:03:12 +0100213 size_t i;
214 int ret;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200215 char *after;
216
217 if (buf_len < 3)
218 return -EINVAL;
219
220 if (host_cnt != 1) {
221 ret = snprintf(buf, rem, "(");
222 if (ret < 0)
223 return ret;
224 OSMO_SNPRINTF_RET(ret, rem, offset, len);
225 }
226 for (i = 0; i < host_cnt; i++) {
227 if (host_cnt == 1)
228 after = "";
229 else
230 after = (i == (host_cnt - 1)) ? ")" : "|";
231 ret = snprintf(buf + offset, rem, "%s%s", hosts[i] ? : "0.0.0.0", after);
232 OSMO_SNPRINTF_RET(ret, rem, offset, len);
233 }
234
235 return len;
236}
Pau Espin Pedrol8fac5112019-10-24 15:39:25 +0200237#endif /* HAVE_LIBSCTP */
Harald Weltedda70fc2017-04-08 20:52:33 +0200238
Harald Weltec47bbda2017-07-13 16:13:26 +0200239static int osmo_sock_init_tail(int fd, uint16_t type, unsigned int flags)
240{
Harald Weltebc43a622017-07-13 16:20:21 +0200241 int rc;
Harald Weltec47bbda2017-07-13 16:13:26 +0200242
243 /* Make sure to call 'listen' on a bound, connection-oriented sock */
244 if ((flags & (OSMO_SOCK_F_BIND|OSMO_SOCK_F_CONNECT)) == OSMO_SOCK_F_BIND) {
245 switch (type) {
246 case SOCK_STREAM:
247 case SOCK_SEQPACKET:
248 rc = listen(fd, 10);
Harald Weltebc43a622017-07-13 16:20:21 +0200249 if (rc < 0) {
250 LOGP(DLGLOBAL, LOGL_ERROR, "unable to listen on socket: %s\n",
251 strerror(errno));
Maxdb7cb692023-02-11 21:35:21 +0300252 return -errno;
Harald Weltebc43a622017-07-13 16:20:21 +0200253 }
254 break;
Harald Weltec47bbda2017-07-13 16:13:26 +0200255 }
256 }
257
Harald Weltebc43a622017-07-13 16:20:21 +0200258 if (flags & OSMO_SOCK_F_NO_MCAST_LOOP) {
259 rc = osmo_sock_mcast_loop_set(fd, false);
260 if (rc < 0) {
261 LOGP(DLGLOBAL, LOGL_ERROR, "unable to disable multicast loop: %s\n",
262 strerror(errno));
263 return rc;
264 }
265 }
Harald Weltec47bbda2017-07-13 16:13:26 +0200266
Harald Welte37d204a2017-07-13 16:33:16 +0200267 if (flags & OSMO_SOCK_F_NO_MCAST_ALL) {
268 rc = osmo_sock_mcast_all_set(fd, false);
269 if (rc < 0) {
270 LOGP(DLGLOBAL, LOGL_ERROR, "unable to disable receive of all multicast: %s\n",
271 strerror(errno));
272 /* do not abort here, as this is just an
273 * optional additional optimization that only
274 * exists on Linux only */
275 }
276 }
Harald Weltebc43a622017-07-13 16:20:21 +0200277 return 0;
Harald Weltec47bbda2017-07-13 16:13:26 +0200278}
279
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200280/*! Initialize a socket (including bind and/or connect)
Harald Weltedda70fc2017-04-08 20:52:33 +0200281 * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
282 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
283 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
284 * \param[in] local_host local host name or IP address in string form
285 * \param[in] local_port local port number in host byte order
286 * \param[in] remote_host remote host name or IP address in string form
287 * \param[in] remote_port remote port number in host byte order
288 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
289 * \returns socket file descriptor on success; negative on error
290 *
291 * This function creates a new socket of the designated \a family, \a
292 * type and \a proto and optionally binds it to the \a local_host and \a
293 * local_port as well as optionally connects it to the \a remote_host
294 * and \q remote_port, depending on the value * of \a flags parameter.
295 *
296 * As opposed to \ref osmo_sock_init(), this function allows to combine
297 * the \ref OSMO_SOCK_F_BIND and \ref OSMO_SOCK_F_CONNECT flags. This
298 * is useful if you want to connect to a remote host/port, but still
299 * want to bind that socket to either a specific local alias IP and/or a
300 * specific local source port.
301 *
302 * You must specify either \ref OSMO_SOCK_F_BIND, or \ref
303 * OSMO_SOCK_F_CONNECT, or both.
304 *
305 * If \ref OSMO_SOCK_F_NONBLOCK is specified, the socket will be set to
306 * non-blocking mode.
307 */
308int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto,
309 const char *local_host, uint16_t local_port,
310 const char *remote_host, uint16_t remote_port, unsigned int flags)
311{
Alexander Couzens2c962f52020-06-03 00:28:02 +0200312 struct addrinfo *local = NULL, *remote = NULL, *rp;
Harald Weltedda70fc2017-04-08 20:52:33 +0200313 int sfd = -1, rc, on = 1;
314
Alexander Couzens2c962f52020-06-03 00:28:02 +0200315 bool local_ipv4 = false, local_ipv6 = false;
316 bool remote_ipv4 = false, remote_ipv6 = false;
317
Harald Weltedda70fc2017-04-08 20:52:33 +0200318 if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) == 0) {
319 LOGP(DLGLOBAL, LOGL_ERROR, "invalid: you have to specify either "
320 "BIND or CONNECT flags\n");
321 return -EINVAL;
322 }
323
Alexander Couzens2c962f52020-06-03 00:28:02 +0200324 /* figure out local address infos */
325 if (flags & OSMO_SOCK_F_BIND) {
326 local = addrinfo_helper(family, type, proto, local_host, local_port, true);
327 if (!local)
328 return -EINVAL;
329 }
330
331 /* figure out remote address infos */
332 if (flags & OSMO_SOCK_F_CONNECT) {
333 remote = addrinfo_helper(family, type, proto, remote_host, remote_port, false);
334 if (!remote) {
335 if (local)
336 freeaddrinfo(local);
337
338 return -EINVAL;
339 }
340 }
341
342 /* It must do a full run to ensure AF_UNSPEC does not fail.
343 * In case first local valid entry is IPv4 and only remote valid entry
344 * is IPv6 or vice versa */
345 if (family == AF_UNSPEC) {
346 for (rp = local; rp != NULL; rp = rp->ai_next) {
347 switch (rp->ai_family) {
348 case AF_INET:
349 local_ipv4 = true;
350 break;
351 case AF_INET6:
352 local_ipv6 = true;
353 break;
354 }
355 }
356
357 for (rp = remote; rp != NULL; rp = rp->ai_next) {
358 switch (rp->ai_family) {
359 case AF_INET:
360 remote_ipv4 = true;
361 break;
362 case AF_INET6:
363 remote_ipv6 = true;
364 break;
365 }
366 }
367
Pau Espin Pedrold8cf52b2020-08-31 19:00:59 +0200368 if ((flags & OSMO_SOCK_F_BIND) && (flags & OSMO_SOCK_F_CONNECT)) {
369 /* prioritize ipv6 as per RFC */
370 if (local_ipv6 && remote_ipv6)
371 family = AF_INET6;
372 else if (local_ipv4 && remote_ipv4)
373 family = AF_INET;
374 else {
375 if (local)
376 freeaddrinfo(local);
377 if (remote)
378 freeaddrinfo(remote);
379 LOGP(DLGLOBAL, LOGL_ERROR,
380 "Unable to find a common protocol (IPv4 or IPv6) "
381 "for local host: %s and remote host: %s.\n",
382 local_host, remote_host);
383 return -ENODEV;
384 }
385 } else if ((flags & OSMO_SOCK_F_BIND)) {
386 family = local_ipv6 ? AF_INET6 : AF_INET;
387 } else if ((flags & OSMO_SOCK_F_CONNECT)) {
388 family = remote_ipv6 ? AF_INET6 : AF_INET;
Alexander Couzens2c962f52020-06-03 00:28:02 +0200389 }
390 }
391
Harald Weltedda70fc2017-04-08 20:52:33 +0200392 /* figure out local side of socket */
393 if (flags & OSMO_SOCK_F_BIND) {
Alexander Couzens2c962f52020-06-03 00:28:02 +0200394 for (rp = local; rp != NULL; rp = rp->ai_next) {
395 /* When called with AF_UNSPEC, family will set to IPv4 or IPv6 */
396 if (rp->ai_family != family)
397 continue;
Harald Weltedda70fc2017-04-08 20:52:33 +0200398
Harald Weltedda70fc2017-04-08 20:52:33 +0200399 sfd = socket_helper(rp, flags);
400 if (sfd < 0)
401 continue;
402
Philipp Maier73196e72018-08-23 20:11:50 +0200403 if (proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR) {
Philipp Maier99f706d2018-08-01 12:40:36 +0200404 rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR,
405 &on, sizeof(on));
406 if (rc < 0) {
407 LOGP(DLGLOBAL, LOGL_ERROR,
408 "cannot setsockopt socket:"
409 " %s:%u: %s\n",
410 local_host, local_port,
411 strerror(errno));
412 close(sfd);
413 continue;
414 }
Harald Weltedda70fc2017-04-08 20:52:33 +0200415 }
Philipp Maier99f706d2018-08-01 12:40:36 +0200416
Pau Espin Pedrol5d50fa52018-04-05 17:00:22 +0200417 if (bind(sfd, rp->ai_addr, rp->ai_addrlen) == -1) {
418 LOGP(DLGLOBAL, LOGL_ERROR, "unable to bind socket: %s:%u: %s\n",
419 local_host, local_port, strerror(errno));
420 close(sfd);
421 continue;
422 }
423 break;
Harald Weltedda70fc2017-04-08 20:52:33 +0200424 }
Alexander Couzens2c962f52020-06-03 00:28:02 +0200425
426 freeaddrinfo(local);
Harald Weltedda70fc2017-04-08 20:52:33 +0200427 if (rp == NULL) {
Alexander Couzens2c962f52020-06-03 00:28:02 +0200428 if (remote)
429 freeaddrinfo(remote);
Pau Espin Pedrol5d50fa52018-04-05 17:00:22 +0200430 LOGP(DLGLOBAL, LOGL_ERROR, "no suitable local addr found for: %s:%u\n",
431 local_host, local_port);
Harald Weltedda70fc2017-04-08 20:52:33 +0200432 return -ENODEV;
433 }
434 }
435
Pau Espin Pedrol5d50fa52018-04-05 17:00:22 +0200436 /* Reached this point, if OSMO_SOCK_F_BIND then sfd is valid (>=0) or it
437 was already closed and func returned. If OSMO_SOCK_F_BIND is not
438 set, then sfd = -1 */
439
Harald Weltedda70fc2017-04-08 20:52:33 +0200440 /* figure out remote side of socket */
441 if (flags & OSMO_SOCK_F_CONNECT) {
Alexander Couzens2c962f52020-06-03 00:28:02 +0200442 for (rp = remote; rp != NULL; rp = rp->ai_next) {
443 /* When called with AF_UNSPEC, family will set to IPv4 or IPv6 */
444 if (rp->ai_family != family)
445 continue;
Harald Weltedda70fc2017-04-08 20:52:33 +0200446
Harald Welte5cfa6dc2017-07-21 16:52:29 +0200447 if (sfd < 0) {
Harald Weltedda70fc2017-04-08 20:52:33 +0200448 sfd = socket_helper(rp, flags);
449 if (sfd < 0)
450 continue;
451 }
452
453 rc = connect(sfd, rp->ai_addr, rp->ai_addrlen);
Pau Espin Pedrol27cf8df2018-04-05 17:49:08 +0200454 if (rc != 0 && errno != EINPROGRESS) {
455 LOGP(DLGLOBAL, LOGL_ERROR, "unable to connect socket: %s:%u: %s\n",
456 remote_host, remote_port, strerror(errno));
457 /* We want to maintain the bind socket if bind was enabled */
458 if (!(flags & OSMO_SOCK_F_BIND)) {
459 close(sfd);
460 sfd = -1;
461 }
462 continue;
463 }
464 break;
Harald Weltedda70fc2017-04-08 20:52:33 +0200465 }
Alexander Couzens2c962f52020-06-03 00:28:02 +0200466
467 freeaddrinfo(remote);
Harald Weltedda70fc2017-04-08 20:52:33 +0200468 if (rp == NULL) {
Pau Espin Pedrol27cf8df2018-04-05 17:49:08 +0200469 LOGP(DLGLOBAL, LOGL_ERROR, "no suitable remote addr found for: %s:%u\n",
470 remote_host, remote_port);
471 if (sfd >= 0)
472 close(sfd);
Harald Weltedda70fc2017-04-08 20:52:33 +0200473 return -ENODEV;
474 }
475 }
476
Harald Weltec47bbda2017-07-13 16:13:26 +0200477 rc = osmo_sock_init_tail(sfd, type, flags);
478 if (rc < 0) {
479 close(sfd);
480 sfd = -1;
Harald Weltedda70fc2017-04-08 20:52:33 +0200481 }
Harald Weltec47bbda2017-07-13 16:13:26 +0200482
Harald Weltedda70fc2017-04-08 20:52:33 +0200483 return sfd;
484}
485
Alexander Couzens43957e62020-08-01 21:56:45 +0200486#define _SOCKADDR_TO_STR(dest, sockaddr) do { \
Neels Hofmeyrf3270f22021-12-17 14:21:29 +0100487 if (osmo_sockaddr_str_from_sockaddr(dest, &sockaddr->u.sas)) \
488 osmo_strlcpy((dest)->ip, "Invalid IP", 11); \
Alexander Couzens43957e62020-08-01 21:56:45 +0200489 } while (0)
490
491/*! Initialize a socket (including bind and/or connect)
492 * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
493 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
494 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
495 * \param[in] local local address
496 * \param[in] remote remote address
497 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
498 * \returns socket file descriptor on success; negative on error
499 *
500 * This function creates a new socket of the
501 * \a type and \a proto and optionally binds it to the \a local
502 * as well as optionally connects it to the \a remote
503 * depending on the value * of \a flags parameter.
504 *
505 * As opposed to \ref osmo_sock_init(), this function allows to combine
506 * the \ref OSMO_SOCK_F_BIND and \ref OSMO_SOCK_F_CONNECT flags. This
507 * is useful if you want to connect to a remote host/port, but still
508 * want to bind that socket to either a specific local alias IP and/or a
509 * specific local source port.
510 *
511 * You must specify either \ref OSMO_SOCK_F_BIND, or \ref
512 * OSMO_SOCK_F_CONNECT, or both.
513 *
514 * If \ref OSMO_SOCK_F_NONBLOCK is specified, the socket will be set to
515 * non-blocking mode.
516 */
517int osmo_sock_init_osa(uint16_t type, uint8_t proto,
518 const struct osmo_sockaddr *local,
519 const struct osmo_sockaddr *remote,
520 unsigned int flags)
521{
522 int sfd = -1, rc, on = 1;
Neels Hofmeyrf3270f22021-12-17 14:21:29 +0100523 struct osmo_sockaddr_str _sastr = {};
524 struct osmo_sockaddr_str *sastr = &_sastr;
Alexander Couzens43957e62020-08-01 21:56:45 +0200525
526 if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) == 0) {
527 LOGP(DLGLOBAL, LOGL_ERROR, "invalid: you have to specify either "
528 "BIND or CONNECT flags\n");
529 return -EINVAL;
530 }
531
532 if ((flags & OSMO_SOCK_F_BIND) && !local) {
533 LOGP(DLGLOBAL, LOGL_ERROR, "invalid argument. Cannot BIND when local is NULL\n");
534 return -EINVAL;
535 }
536
537 if ((flags & OSMO_SOCK_F_CONNECT) && !remote) {
538 LOGP(DLGLOBAL, LOGL_ERROR, "invalid argument. Cannot CONNECT when remote is NULL\n");
539 return -EINVAL;
540 }
541
542 if ((flags & OSMO_SOCK_F_BIND) &&
543 (flags & OSMO_SOCK_F_CONNECT) &&
544 local->u.sa.sa_family != remote->u.sa.sa_family) {
545 LOGP(DLGLOBAL, LOGL_ERROR, "invalid: the family for "
546 "local and remote endpoint must be same.\n");
547 return -EINVAL;
548 }
549
550 /* figure out local side of socket */
551 if (flags & OSMO_SOCK_F_BIND) {
552 sfd = socket_helper_osa(local, type, proto, flags);
553 if (sfd < 0) {
554 _SOCKADDR_TO_STR(sastr, local);
Neels Hofmeyrf3270f22021-12-17 14:21:29 +0100555 LOGP(DLGLOBAL, LOGL_ERROR, "no suitable local addr found for: " OSMO_SOCKADDR_STR_FMT "\n",
556 OSMO_SOCKADDR_STR_FMT_ARGS(sastr));
Alexander Couzens43957e62020-08-01 21:56:45 +0200557 return -ENODEV;
558 }
559
560 if (proto != IPPROTO_UDP || (flags & OSMO_SOCK_F_UDP_REUSEADDR)) {
561 rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR,
562 &on, sizeof(on));
563 if (rc < 0) {
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200564 int err = errno;
Alexander Couzens43957e62020-08-01 21:56:45 +0200565 _SOCKADDR_TO_STR(sastr, local);
566 LOGP(DLGLOBAL, LOGL_ERROR,
Neels Hofmeyrf3270f22021-12-17 14:21:29 +0100567 "cannot setsockopt socket: " OSMO_SOCKADDR_STR_FMT ": %s\n",
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200568 OSMO_SOCKADDR_STR_FMT_ARGS(sastr), strerror(err));
Alexander Couzens43957e62020-08-01 21:56:45 +0200569 close(sfd);
570 return rc;
571 }
572 }
573
574 if (bind(sfd, &local->u.sa, sizeof(struct osmo_sockaddr)) == -1) {
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200575 int err = errno;
Alexander Couzens43957e62020-08-01 21:56:45 +0200576 _SOCKADDR_TO_STR(sastr, local);
Neels Hofmeyrf3270f22021-12-17 14:21:29 +0100577 LOGP(DLGLOBAL, LOGL_ERROR, "unable to bind socket: " OSMO_SOCKADDR_STR_FMT ": %s\n",
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200578 OSMO_SOCKADDR_STR_FMT_ARGS(sastr), strerror(err));
Alexander Couzens43957e62020-08-01 21:56:45 +0200579 close(sfd);
580 return -1;
581 }
582 }
583
584 /* Reached this point, if OSMO_SOCK_F_BIND then sfd is valid (>=0) or it
585 was already closed and func returned. If OSMO_SOCK_F_BIND is not
586 set, then sfd = -1 */
587
588 /* figure out remote side of socket */
589 if (flags & OSMO_SOCK_F_CONNECT) {
590 if (sfd < 0) {
591 sfd = socket_helper_osa(remote, type, proto, flags);
592 if (sfd < 0) {
593 return sfd;
594 }
595 }
596
597 rc = connect(sfd, &remote->u.sa, sizeof(struct osmo_sockaddr));
598 if (rc != 0 && errno != EINPROGRESS) {
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200599 int err = errno;
Alexander Couzens43957e62020-08-01 21:56:45 +0200600 _SOCKADDR_TO_STR(sastr, remote);
Neels Hofmeyrf3270f22021-12-17 14:21:29 +0100601 LOGP(DLGLOBAL, LOGL_ERROR, "unable to connect socket: " OSMO_SOCKADDR_STR_FMT ": %s\n",
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200602 OSMO_SOCKADDR_STR_FMT_ARGS(sastr), strerror(err));
Alexander Couzens43957e62020-08-01 21:56:45 +0200603 close(sfd);
604 return rc;
605 }
606 }
607
608 rc = osmo_sock_init_tail(sfd, type, flags);
609 if (rc < 0) {
610 close(sfd);
611 sfd = -1;
612 }
613
614 return sfd;
615}
616
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200617#ifdef HAVE_LIBSCTP
618
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200619/* Check whether there's an IPv6 Addr as first option of any addrinfo item in the addrinfo set */
620static void addrinfo_has_v4v6addr(const struct addrinfo **result, size_t result_count, bool *has_v4, bool *has_v6)
621{
622 size_t host_idx;
623 *has_v4 = false;
624 *has_v6 = false;
625
626 for (host_idx = 0; host_idx < result_count; host_idx++) {
627 if (result[host_idx]->ai_family == AF_INET)
628 *has_v4 = true;
629 else if (result[host_idx]->ai_family == AF_INET6)
630 *has_v6 = true;
631 }
632}
633
Pau Espin Pedrol4f463c52020-08-28 14:32:02 +0200634/* Check whether there's an IPv6 with IN6ADDR_ANY_INIT ("::") */
635static bool addrinfo_has_in6addr_any(const struct addrinfo **result, size_t result_count)
636{
637 size_t host_idx;
638 struct in6_addr in6addr_any = IN6ADDR_ANY_INIT;
639
640 for (host_idx = 0; host_idx < result_count; host_idx++) {
641 if (result[host_idx]->ai_family != AF_INET6)
642 continue;
643 if (memcmp(&((struct sockaddr_in6 *)result[host_idx]->ai_addr)->sin6_addr,
644 &in6addr_any, sizeof(in6addr_any)) == 0)
645 return true;
646 }
647 return false;
648}
649
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200650static int socket_helper_multiaddr(uint16_t family, uint16_t type, uint8_t proto, unsigned int flags)
651{
Harald Weltefaf6b702021-04-28 13:04:59 +0200652 int sfd, rc;
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200653
654 sfd = socket(family, type, proto);
655 if (sfd == -1) {
656 LOGP(DLGLOBAL, LOGL_ERROR,
657 "Unable to create socket: %s\n", strerror(errno));
658 return sfd;
659 }
Harald Weltefaf6b702021-04-28 13:04:59 +0200660
661 rc = socket_helper_tail(sfd, flags);
662 if (rc < 0)
663 return rc;
664
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200665 return sfd;
666}
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200667
668/* Build array of addresses taking first addrinfo result of the requested family
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200669 * for each host in addrs_buf. */
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200670static int addrinfo_to_sockaddr(uint16_t family, const struct addrinfo **result,
Harald Welte0b08d512022-01-09 12:03:12 +0100671 const char **hosts, unsigned int host_cont,
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200672 uint8_t *addrs_buf, size_t addrs_buf_len) {
673 size_t host_idx, offset = 0;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200674 const struct addrinfo *rp;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200675
676 for (host_idx = 0; host_idx < host_cont; host_idx++) {
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200677 /* Addresses are ordered based on RFC 3484, see man getaddrinfo */
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200678 for (rp = result[host_idx]; rp != NULL; rp = rp->ai_next) {
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200679 if (family != AF_UNSPEC && rp->ai_family != family)
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200680 continue;
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200681 if (offset + rp->ai_addrlen > addrs_buf_len) {
682 LOGP(DLGLOBAL, LOGL_ERROR, "Output buffer to small: %zu\n",
683 addrs_buf_len);
684 return -ENOSPC;
685 }
686 memcpy(addrs_buf + offset, rp->ai_addr, rp->ai_addrlen);
687 offset += rp->ai_addrlen;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200688 break;
689 }
690 if (!rp) { /* No addr could be bound for this host! */
691 LOGP(DLGLOBAL, LOGL_ERROR, "No suitable remote address found for host: %s\n",
692 hosts[host_idx]);
693 return -ENODEV;
694 }
695 }
696 return 0;
697}
698
Pau Espin Pedrole83227f2023-08-08 19:32:56 +0200699static int setsockopt_sctp_auth_supported(int fd)
700{
701#ifdef SCTP_AUTH_SUPPORTED
702 struct sctp_assoc_value assoc_val = {
703 .assoc_id = SCTP_FUTURE_ASSOC,
704 .assoc_value = 1,
705 };
706 return setsockopt(fd, IPPROTO_SCTP, SCTP_AUTH_SUPPORTED, &assoc_val, sizeof(assoc_val));
707#else
708#pragma message "setsockopt(SCTP_AUTH_SUPPORTED) not supported! some SCTP features may not be available!"
709 LOGP(DLGLOBAL, LOGL_NOTICE, "Built without support for setsockopt(SCTP_AUTH_SUPPORTED), skipping\n");
710 return 0;
711#endif
712}
713
714static int setsockopt_sctp_asconf_supported(int fd)
715{
716#ifdef SCTP_ASCONF_SUPPORTED
717 struct sctp_assoc_value assoc_val = {
718 .assoc_id = SCTP_FUTURE_ASSOC,
719 .assoc_value = 1,
720 };
721 return setsockopt(fd, IPPROTO_SCTP, SCTP_ASCONF_SUPPORTED, &assoc_val, sizeof(assoc_val));
722#else
723#pragma message "setsockopt(SCTP_ASCONF_SUPPORTED) not supported! some SCTP features may not be available!"
724 LOGP(DLGLOBAL, LOGL_NOTICE, "Built without support for setsockopt(SCTP_ASCONF_SUPPORTED), skipping\n");
725 return 0;
726#endif
727}
728
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200729/*! Initialize a socket (including bind and/or connect) with multiple local or remote addresses.
730 * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
731 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
732 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
733 * \param[in] local_hosts array of char pointers (strings), each containing local host name or IP address in string form
734 * \param[in] local_hosts_cnt length of local_hosts (in items)
735 * \param[in] local_port local port number in host byte order
736 * \param[in] remote_host array of char pointers (strings), each containing remote host name or IP address in string form
737 * \param[in] remote_hosts_cnt length of remote_hosts (in items)
738 * \param[in] remote_port remote port number in host byte order
739 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
740 * \returns socket file descriptor on success; negative on error
741 *
742 * This function is similar to \ref osmo_sock_init2(), but can be passed an
743 * array of local or remote addresses for protocols supporting multiple
744 * addresses per socket, like SCTP (currently only one supported). This function
745 * should not be used by protocols not supporting this kind of features, but
746 * rather \ref osmo_sock_init2() should be used instead.
747 * See \ref osmo_sock_init2() for more information on flags and general behavior.
748 */
749int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto,
750 const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port,
751 const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port,
752 unsigned int flags)
753
754{
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200755 struct addrinfo *res_loc[OSMO_SOCK_MAX_ADDRS], *res_rem[OSMO_SOCK_MAX_ADDRS];
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200756 int sfd = -1, rc, on = 1;
Harald Welte0b08d512022-01-09 12:03:12 +0100757 unsigned int i;
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200758 bool loc_has_v4addr, rem_has_v4addr;
759 bool loc_has_v6addr, rem_has_v6addr;
760 struct sockaddr_in6 addrs_buf[OSMO_SOCK_MAX_ADDRS];
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200761 char strbuf[512];
762
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200763 /* updated later in case of AF_UNSPEC */
764 loc_has_v4addr = rem_has_v4addr = (family == AF_INET);
765 loc_has_v6addr = rem_has_v6addr = (family == AF_INET6);
766
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200767 /* TODO: So far this function is only aimed for SCTP, but could be
768 reused in the future for other protocols with multi-addr support */
769 if (proto != IPPROTO_SCTP)
770 return -ENOTSUP;
771
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200772 if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) == 0) {
773 LOGP(DLGLOBAL, LOGL_ERROR, "invalid: you have to specify either "
774 "BIND or CONNECT flags\n");
775 return -EINVAL;
776 }
777
778 if (((flags & OSMO_SOCK_F_BIND) && !local_hosts_cnt) ||
779 ((flags & OSMO_SOCK_F_CONNECT) && !remote_hosts_cnt) ||
780 local_hosts_cnt > OSMO_SOCK_MAX_ADDRS ||
781 remote_hosts_cnt > OSMO_SOCK_MAX_ADDRS)
782 return -EINVAL;
783
784 /* figure out local side of socket */
785 if (flags & OSMO_SOCK_F_BIND) {
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200786 rc = addrinfo_helper_multi(res_loc, family, type, proto, local_hosts,
787 local_hosts_cnt, local_port, true);
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200788 if (rc < 0)
789 return -EINVAL;
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200790 /* Figure out if there's any IPV4 or IPv6 addr in the set */
791 if (family == AF_UNSPEC)
792 addrinfo_has_v4v6addr((const struct addrinfo **)res_loc, local_hosts_cnt,
793 &loc_has_v4addr, &loc_has_v6addr);
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200794 }
795 /* figure out remote side of socket */
796 if (flags & OSMO_SOCK_F_CONNECT) {
797 rc = addrinfo_helper_multi(res_rem, family, type, proto, remote_hosts,
798 remote_hosts_cnt, remote_port, false);
Pau Espin Pedrol4541cf22020-08-25 11:22:09 +0200799 if (rc < 0) {
800 rc = -EINVAL;
801 goto ret_freeaddrinfo_loc;
802 }
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200803 /* Figure out if there's any IPv4 or IPv6 addr in the set */
804 if (family == AF_UNSPEC)
805 addrinfo_has_v4v6addr((const struct addrinfo **)res_rem, remote_hosts_cnt,
806 &rem_has_v4addr, &rem_has_v6addr);
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200807 }
808
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200809 if (((flags & OSMO_SOCK_F_BIND) && (flags & OSMO_SOCK_F_CONNECT)) &&
Pau Espin Pedrol4f463c52020-08-28 14:32:02 +0200810 !addrinfo_has_in6addr_any((const struct addrinfo **)res_loc, local_hosts_cnt) &&
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200811 (loc_has_v4addr != rem_has_v4addr || loc_has_v6addr != rem_has_v6addr)) {
Neels Hofmeyr5761c442020-09-22 00:24:06 +0000812 LOGP(DLGLOBAL, LOGL_ERROR, "Invalid v4 vs v6 in local vs remote addresses: "
813 "local:%s%s remote:%s%s\n",
814 loc_has_v4addr ? " v4" : "", loc_has_v6addr ? " v6" : "",
815 rem_has_v4addr ? " v4" : "", rem_has_v6addr ? " v6" : ""
816 );
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200817 rc = -EINVAL;
818 goto ret_freeaddrinfo;
819 }
820
821 sfd = socket_helper_multiaddr(loc_has_v6addr ? AF_INET6 : AF_INET,
822 type, proto, flags);
823 if (sfd < 0) {
824 rc = sfd;
825 goto ret_freeaddrinfo;
826 }
827
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200828 if (flags & OSMO_SOCK_F_BIND) {
Pau Espin Pedrol272dfc12019-10-21 11:11:27 +0200829 /* Since so far we only allow IPPROTO_SCTP in this function,
830 no need to check below for "proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR" */
831 rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR,
832 &on, sizeof(on));
833 if (rc < 0) {
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200834 int err = errno;
Pau Espin Pedrol272dfc12019-10-21 11:11:27 +0200835 multiaddr_snprintf(strbuf, sizeof(strbuf), local_hosts, local_hosts_cnt);
836 LOGP(DLGLOBAL, LOGL_ERROR,
837 "cannot setsockopt socket:"
838 " %s:%u: %s\n",
839 strbuf, local_port,
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200840 strerror(err));
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200841 goto ret_close;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200842 }
843
Pau Espin Pedrole83227f2023-08-08 19:32:56 +0200844 if (flags & OSMO_SOCK_F_SCTP_ASCONF_SUPPORTED) {
845 /* RFC 5061 4.2.7: ASCONF also requires AUTH feature. */
846 rc = setsockopt_sctp_auth_supported(sfd);
847 if (rc < 0) {
848 int err = errno;
849 multiaddr_snprintf(strbuf, sizeof(strbuf), local_hosts, local_hosts_cnt);
850 LOGP(DLGLOBAL, LOGL_ERROR,
851 "cannot setsockopt(SCTP_AUTH_SUPPORTED) socket: %s:%u: %s\n",
852 strbuf, local_port, strerror(err));
853 goto ret_close;
854 }
855
856 rc = setsockopt_sctp_asconf_supported(sfd);
857 if (rc < 0) {
858 int err = errno;
859 multiaddr_snprintf(strbuf, sizeof(strbuf), local_hosts, local_hosts_cnt);
860 LOGP(DLGLOBAL, LOGL_ERROR,
861 "cannot setsockopt(SCTP_ASCONF_SUPPORTED) socket: %s:%u: %s\n",
862 strbuf, local_port, strerror(err));
863 goto ret_close;
864 }
865 }
866
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200867 /* Build array of addresses taking first entry for each host.
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200868 TODO: Ideally we should use backtracking storing last used
869 indexes and trying next combination if connect() fails .*/
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200870 /* We could alternatively use v4v6 mapped addresses and call sctp_bindx once with an array od sockaddr_in6 */
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200871 rc = addrinfo_to_sockaddr(family, (const struct addrinfo **)res_loc,
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200872 local_hosts, local_hosts_cnt,
873 (uint8_t*)addrs_buf, sizeof(addrs_buf));
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200874 if (rc < 0) {
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200875 rc = -ENODEV;
876 goto ret_close;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200877 }
878
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200879 rc = sctp_bindx(sfd, (struct sockaddr *)addrs_buf, local_hosts_cnt, SCTP_BINDX_ADD_ADDR);
880 if (rc == -1) {
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200881 int err = errno;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200882 multiaddr_snprintf(strbuf, sizeof(strbuf), local_hosts, local_hosts_cnt);
883 LOGP(DLGLOBAL, LOGL_NOTICE, "unable to bind socket: %s:%u: %s\n",
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200884 strbuf, local_port, strerror(err));
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200885 rc = -ENODEV;
886 goto ret_close;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200887 }
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200888 }
889
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200890 if (flags & OSMO_SOCK_F_CONNECT) {
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200891 /* Build array of addresses taking first of same family for each host.
892 TODO: Ideally we should use backtracking storing last used
893 indexes and trying next combination if connect() fails .*/
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200894 rc = addrinfo_to_sockaddr(family, (const struct addrinfo **)res_rem,
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200895 remote_hosts, remote_hosts_cnt,
896 (uint8_t*)addrs_buf, sizeof(addrs_buf));
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200897 if (rc < 0) {
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200898 rc = -ENODEV;
899 goto ret_close;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200900 }
901
Pau Espin Pedrolcd133312020-08-19 17:25:04 +0200902 rc = sctp_connectx(sfd, (struct sockaddr *)addrs_buf, remote_hosts_cnt, NULL);
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200903 if (rc != 0 && errno != EINPROGRESS) {
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200904 int err = errno;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200905 multiaddr_snprintf(strbuf, sizeof(strbuf), remote_hosts, remote_hosts_cnt);
906 LOGP(DLGLOBAL, LOGL_ERROR, "unable to connect socket: %s:%u: %s\n",
Pau Espin Pedrolc3b772b2023-07-06 12:25:26 +0200907 strbuf, remote_port, strerror(err));
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200908 rc = -ENODEV;
909 goto ret_close;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200910 }
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200911 }
912
913 rc = osmo_sock_init_tail(sfd, type, flags);
914 if (rc < 0) {
915 close(sfd);
916 sfd = -1;
917 }
918
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200919 rc = sfd;
920 goto ret_freeaddrinfo;
921
922ret_close:
923 if (sfd >= 0)
924 close(sfd);
925ret_freeaddrinfo:
Pau Espin Pedrol4541cf22020-08-25 11:22:09 +0200926 if (flags & OSMO_SOCK_F_CONNECT) {
927 for (i = 0; i < remote_hosts_cnt; i++)
928 freeaddrinfo(res_rem[i]);
929 }
930ret_freeaddrinfo_loc:
931 if (flags & OSMO_SOCK_F_BIND) {
932 for (i = 0; i < local_hosts_cnt; i++)
933 freeaddrinfo(res_loc[i]);
934 }
Pau Espin Pedrol796c6512020-08-19 12:03:25 +0200935 return rc;
Pau Espin Pedrol3f464fc2019-10-10 17:38:35 +0200936}
937#endif /* HAVE_LIBSCTP */
Harald Weltedda70fc2017-04-08 20:52:33 +0200938
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200939/*! Initialize a socket (including bind/connect)
Harald Welteba6988b2011-08-17 12:46:48 +0200940 * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
941 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
942 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
943 * \param[in] host remote host name or IP address in string form
944 * \param[in] port remote port number in host byte order
945 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
Harald Welte2d2e2cc2016-04-25 12:11:20 +0200946 * \returns socket file descriptor on success; negative on error
Harald Welteba6988b2011-08-17 12:46:48 +0200947 *
948 * This function creates a new socket of the designated \a family, \a
949 * type and \a proto and optionally binds or connects it, depending on
950 * the value of \a flags parameter.
951 */
Harald Welte33cb71a2011-05-21 18:54:32 +0200952int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto,
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +0200953 const char *host, uint16_t port, unsigned int flags)
Harald Welte33cb71a2011-05-21 18:54:32 +0200954{
Harald Weltedda70fc2017-04-08 20:52:33 +0200955 struct addrinfo *result, *rp;
Pau Espin Pedrol6fe865d2021-07-15 13:08:08 +0200956 int sfd = -1; /* initialize to avoid uninitialized false warnings on some gcc versions (11.1.0) */
957 int on = 1;
958 int rc;
Harald Welte33cb71a2011-05-21 18:54:32 +0200959
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +0200960 if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) ==
Neels Hofmeyrf0f07d92016-08-22 13:34:23 +0200961 (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) {
Philipp Maier6f0f5602017-02-09 14:09:06 +0100962 LOGP(DLGLOBAL, LOGL_ERROR, "invalid: both bind and connect flags set:"
Neels Hofmeyrb7f191f2016-08-29 11:22:03 +0200963 " %s:%u\n", host, port);
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +0200964 return -EINVAL;
Neels Hofmeyrf0f07d92016-08-22 13:34:23 +0200965 }
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +0200966
Harald Weltedda70fc2017-04-08 20:52:33 +0200967 result = addrinfo_helper(family, type, proto, host, port, flags & OSMO_SOCK_F_BIND);
Pau Espin Pedrolba828c32020-08-20 18:28:10 +0200968 if (!result)
Harald Welte33cb71a2011-05-21 18:54:32 +0200969 return -EINVAL;
Harald Welte33cb71a2011-05-21 18:54:32 +0200970
971 for (rp = result; rp != NULL; rp = rp->ai_next) {
Harald Weltedda70fc2017-04-08 20:52:33 +0200972 sfd = socket_helper(rp, flags);
Harald Welte33cb71a2011-05-21 18:54:32 +0200973 if (sfd == -1)
974 continue;
Harald Weltedda70fc2017-04-08 20:52:33 +0200975
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +0200976 if (flags & OSMO_SOCK_F_CONNECT) {
977 rc = connect(sfd, rp->ai_addr, rp->ai_addrlen);
Pau Espin Pedrol3a321472018-04-05 17:49:40 +0200978 if (rc != 0 && errno != EINPROGRESS) {
979 close(sfd);
980 continue;
981 }
Harald Welte33cb71a2011-05-21 18:54:32 +0200982 } else {
Philipp Maier73196e72018-08-23 20:11:50 +0200983 if (proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR) {
Philipp Maier99f706d2018-08-01 12:40:36 +0200984 rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR,
985 &on, sizeof(on));
986 if (rc < 0) {
987 LOGP(DLGLOBAL, LOGL_ERROR,
988 "cannot setsockopt socket:"
989 " %s:%u: %s\n",
990 host, port, strerror(errno));
991 close(sfd);
992 continue;
993 }
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +0200994 }
Pau Espin Pedrol3a321472018-04-05 17:49:40 +0200995 if (bind(sfd, rp->ai_addr, rp->ai_addrlen) == -1) {
996 LOGP(DLGLOBAL, LOGL_ERROR, "unable to bind socket:"
997 "%s:%u: %s\n",
998 host, port, strerror(errno));
999 close(sfd);
1000 continue;
1001 }
Harald Welte33cb71a2011-05-21 18:54:32 +02001002 }
Pau Espin Pedrol3a321472018-04-05 17:49:40 +02001003 break;
Harald Welte33cb71a2011-05-21 18:54:32 +02001004 }
1005 freeaddrinfo(result);
1006
1007 if (rp == NULL) {
Pau Espin Pedrol3a321472018-04-05 17:49:40 +02001008 LOGP(DLGLOBAL, LOGL_ERROR, "no suitable addr found for: %s:%u\n",
1009 host, port);
Harald Welte33cb71a2011-05-21 18:54:32 +02001010 return -ENODEV;
1011 }
Harald Welte68b15742011-05-22 21:47:29 +02001012
Philipp Maier73196e72018-08-23 20:11:50 +02001013 if (proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR) {
Philipp Maier99f706d2018-08-01 12:40:36 +02001014 rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on));
1015 if (rc < 0) {
1016 LOGP(DLGLOBAL, LOGL_ERROR,
1017 "cannot setsockopt socket: %s:%u: %s\n", host,
1018 port, strerror(errno));
1019 close(sfd);
1020 sfd = -1;
1021 }
Philipp Maier0659c5d2018-08-01 12:43:08 +02001022 }
Harald Welte68b15742011-05-22 21:47:29 +02001023
Harald Weltec47bbda2017-07-13 16:13:26 +02001024 rc = osmo_sock_init_tail(sfd, type, flags);
1025 if (rc < 0) {
1026 close(sfd);
1027 sfd = -1;
Harald Welte68b15742011-05-22 21:47:29 +02001028 }
Harald Weltec47bbda2017-07-13 16:13:26 +02001029
Harald Welte68b15742011-05-22 21:47:29 +02001030 return sfd;
1031}
1032
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001033/*! fill \ref osmo_fd for a give sfd
Max862ba652014-10-13 14:54:25 +02001034 * \param[out] ofd file descriptor (will be filled in)
1035 * \param[in] sfd socket file descriptor
Harald Welte24980ba2021-04-23 14:07:18 +02001036 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001037 * \returns socket fd on success; negative on error
Max862ba652014-10-13 14:54:25 +02001038 *
1039 * This function fills the \a ofd structure.
1040 */
Harald Welte24980ba2021-04-23 14:07:18 +02001041static inline int osmo_fd_init_ofd(struct osmo_fd *ofd, int sfd, unsigned int flags)
Max862ba652014-10-13 14:54:25 +02001042{
1043 int rc;
1044
1045 if (sfd < 0)
1046 return sfd;
1047
1048 ofd->fd = sfd;
Harald Welte16886992019-03-20 10:26:39 +01001049 ofd->when = OSMO_FD_READ;
Max862ba652014-10-13 14:54:25 +02001050
Harald Welte24980ba2021-04-23 14:07:18 +02001051 /* if we're doing a non-blocking connect, the completion will be signaled
1052 * by marking the fd as WRITE-able. So in this exceptional case, we're
1053 * also interested in when the socket becomes write-able */
1054 if ((flags & (OSMO_SOCK_F_CONNECT|OSMO_SOCK_F_NONBLOCK)) ==
1055 (OSMO_SOCK_F_CONNECT|OSMO_SOCK_F_NONBLOCK)) {
1056 ofd->when |= OSMO_FD_WRITE;
1057 }
1058
Max862ba652014-10-13 14:54:25 +02001059 rc = osmo_fd_register(ofd);
1060 if (rc < 0) {
1061 close(sfd);
1062 return rc;
1063 }
1064
1065 return sfd;
1066}
1067
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001068/*! Initialize a socket and fill \ref osmo_fd
Katerina Barone-Adesic28c6a02013-02-15 13:27:59 +01001069 * \param[out] ofd file descriptor (will be filled in)
Harald Welteba6988b2011-08-17 12:46:48 +02001070 * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
1071 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
1072 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
1073 * \param[in] host remote host name or IP address in string form
1074 * \param[in] port remote port number in host byte order
1075 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001076 * \returns socket fd on success; negative on error
Harald Welteba6988b2011-08-17 12:46:48 +02001077 *
1078 * This function creates (and optionall binds/connects) a socket using
1079 * \ref osmo_sock_init, but also fills the \a ofd structure.
1080 */
Harald Welte68b15742011-05-22 21:47:29 +02001081int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto,
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +02001082 const char *host, uint16_t port, unsigned int flags)
Harald Welte68b15742011-05-22 21:47:29 +02001083{
Harald Welte24980ba2021-04-23 14:07:18 +02001084 return osmo_fd_init_ofd(ofd, osmo_sock_init(family, type, proto, host, port, flags), flags);
Harald Welte33cb71a2011-05-21 18:54:32 +02001085}
1086
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001087/*! Initialize a socket and fill \ref osmo_fd
Pau Espin Pedrol75989e62017-05-26 12:39:53 +02001088 * \param[out] ofd file descriptor (will be filled in)
1089 * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC
1090 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
1091 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
1092 * \param[in] local_host local host name or IP address in string form
1093 * \param[in] local_port local port number in host byte order
1094 * \param[in] remote_host remote host name or IP address in string form
1095 * \param[in] remote_port remote port number in host byte order
1096 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
1097 * \returns socket fd on success; negative on error
1098 *
1099 * This function creates (and optionall binds/connects) a socket using
1100 * \ref osmo_sock_init2, but also fills the \a ofd structure.
1101 */
1102int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto,
1103 const char *local_host, uint16_t local_port,
1104 const char *remote_host, uint16_t remote_port, unsigned int flags)
1105{
1106 return osmo_fd_init_ofd(ofd, osmo_sock_init2(family, type, proto, local_host,
Harald Welte24980ba2021-04-23 14:07:18 +02001107 local_port, remote_host, remote_port, flags), flags);
Pau Espin Pedrol75989e62017-05-26 12:39:53 +02001108}
1109
Alexander Couzens43957e62020-08-01 21:56:45 +02001110int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto,
1111 const struct osmo_sockaddr *local,
1112 const struct osmo_sockaddr *remote, unsigned int flags)
1113{
Harald Welte24980ba2021-04-23 14:07:18 +02001114 return osmo_fd_init_ofd(ofd, osmo_sock_init_osa(type, proto, local, remote, flags), flags);
Alexander Couzens43957e62020-08-01 21:56:45 +02001115}
1116
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001117/*! Initialize a socket and fill \ref sockaddr
Harald Welteba6988b2011-08-17 12:46:48 +02001118 * \param[out] ss socket address (will be filled in)
1119 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
1120 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
1121 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001122 * \returns socket fd on success; negative on error
Harald Welteba6988b2011-08-17 12:46:48 +02001123 *
1124 * This function creates (and optionall binds/connects) a socket using
1125 * \ref osmo_sock_init, but also fills the \a ss structure.
1126 */
Harald Welte33cb71a2011-05-21 18:54:32 +02001127int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type,
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +02001128 uint8_t proto, unsigned int flags)
Harald Welte33cb71a2011-05-21 18:54:32 +02001129{
1130 char host[NI_MAXHOST];
1131 uint16_t port;
1132 struct sockaddr_in *sin;
1133 struct sockaddr_in6 *sin6;
1134 int s, sa_len;
1135
1136 /* determine port and host from ss */
1137 switch (ss->sa_family) {
1138 case AF_INET:
1139 sin = (struct sockaddr_in *) ss;
1140 sa_len = sizeof(struct sockaddr_in);
1141 port = ntohs(sin->sin_port);
1142 break;
1143 case AF_INET6:
1144 sin6 = (struct sockaddr_in6 *) ss;
1145 sa_len = sizeof(struct sockaddr_in6);
1146 port = ntohs(sin6->sin6_port);
1147 break;
1148 default:
1149 return -EINVAL;
1150 }
Harald Welte33cb71a2011-05-21 18:54:32 +02001151
1152 s = getnameinfo(ss, sa_len, host, NI_MAXHOST,
1153 NULL, 0, NI_NUMERICHOST);
1154 if (s != 0) {
Philipp Maier6f0f5602017-02-09 14:09:06 +01001155 LOGP(DLGLOBAL, LOGL_ERROR, "getnameinfo failed:"
1156 " %s\n", strerror(errno));
Harald Welte33cb71a2011-05-21 18:54:32 +02001157 return s;
1158 }
1159
Pablo Neira Ayuso0849c9a2011-06-09 15:04:30 +02001160 return osmo_sock_init(ss->sa_family, type, proto, host, port, flags);
Harald Welte33cb71a2011-05-21 18:54:32 +02001161}
1162
1163static int sockaddr_equal(const struct sockaddr *a,
Harald Weltee4764422011-05-22 12:25:57 +02001164 const struct sockaddr *b, unsigned int len)
Harald Welte33cb71a2011-05-21 18:54:32 +02001165{
1166 struct sockaddr_in *sin_a, *sin_b;
1167 struct sockaddr_in6 *sin6_a, *sin6_b;
1168
1169 if (a->sa_family != b->sa_family)
1170 return 0;
1171
1172 switch (a->sa_family) {
1173 case AF_INET:
1174 sin_a = (struct sockaddr_in *)a;
1175 sin_b = (struct sockaddr_in *)b;
1176 if (!memcmp(&sin_a->sin_addr, &sin_b->sin_addr,
1177 sizeof(struct in_addr)))
1178 return 1;
1179 break;
1180 case AF_INET6:
1181 sin6_a = (struct sockaddr_in6 *)a;
1182 sin6_b = (struct sockaddr_in6 *)b;
1183 if (!memcmp(&sin6_a->sin6_addr, &sin6_b->sin6_addr,
1184 sizeof(struct in6_addr)))
1185 return 1;
1186 break;
1187 }
1188 return 0;
1189}
1190
Eric8ae40cb2021-09-27 22:10:01 +02001191/* linux has a default route:
1192local 127.0.0.0/8 dev lo proto kernel scope host src 127.0.0.1
1193*/
1194static int sockaddr_is_local_routed(const struct sockaddr *a)
1195{
1196#if __linux__
1197 if (a->sa_family != AF_INET)
1198 return 0;
1199
1200 uint32_t address = ((struct sockaddr_in *)a)->sin_addr.s_addr; /* already BE */
1201 uint32_t eightmask = htonl(0xff000000); /* /8 mask */
1202 uint32_t local_prefix_127 = htonl(0x7f000000); /* 127.0.0.0 */
1203
1204 if ((address & eightmask) == local_prefix_127)
1205 return 1;
1206#endif
1207 return 0;
1208}
1209
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001210/*! Determine if the given address is a local address
Harald Welteba6988b2011-08-17 12:46:48 +02001211 * \param[in] addr Socket Address
1212 * \param[in] addrlen Length of socket address in bytes
1213 * \returns 1 if address is local, 0 otherwise.
1214 */
Harald Weltebc32d052012-04-08 11:31:32 +02001215int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen)
Harald Welte33cb71a2011-05-21 18:54:32 +02001216{
1217 struct ifaddrs *ifaddr, *ifa;
1218
Eric8ae40cb2021-09-27 22:10:01 +02001219 if (sockaddr_is_local_routed(addr))
1220 return 1;
1221
Harald Welte33cb71a2011-05-21 18:54:32 +02001222 if (getifaddrs(&ifaddr) == -1) {
Philipp Maier6f0f5602017-02-09 14:09:06 +01001223 LOGP(DLGLOBAL, LOGL_ERROR, "getifaddrs:"
1224 " %s\n", strerror(errno));
Harald Welte33cb71a2011-05-21 18:54:32 +02001225 return -EIO;
1226 }
1227
1228 for (ifa = ifaddr; ifa != NULL; ifa = ifa->ifa_next) {
Harald Welte4d3a7b12011-05-24 21:31:53 +02001229 if (!ifa->ifa_addr)
1230 continue;
Pau Espin Pedrol15753e92018-04-18 19:57:41 +02001231 if (sockaddr_equal(ifa->ifa_addr, addr, addrlen)) {
1232 freeifaddrs(ifaddr);
Harald Welte33cb71a2011-05-21 18:54:32 +02001233 return 1;
Pau Espin Pedrol15753e92018-04-18 19:57:41 +02001234 }
Harald Welte33cb71a2011-05-21 18:54:32 +02001235 }
1236
Pau Espin Pedrol15753e92018-04-18 19:57:41 +02001237 freeifaddrs(ifaddr);
Harald Welte33cb71a2011-05-21 18:54:32 +02001238 return 0;
1239}
Harald Weltee4764422011-05-22 12:25:57 +02001240
Pau Espin Pedrol3b3955b2022-10-04 12:38:49 +02001241/*! Determine if the given address is an ANY address ("0.0.0.0", "::"). Port is not checked.
1242 * \param[in] addr Socket Address
1243 * \param[in] addrlen Length of socket address in bytes
1244 * \returns 1 if address is ANY, 0 otherwise. -1 is address family not supported/detected.
1245 */
1246int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr)
1247{
1248 switch (addr->u.sa.sa_family) {
1249 case AF_INET6: {
1250 struct in6_addr ip6_any = IN6ADDR_ANY_INIT;
1251 return memcmp(&addr->u.sin6.sin6_addr,
1252 &ip6_any, sizeof(ip6_any)) == 0;
1253 }
1254 case AF_INET:
1255 return addr->u.sin.sin_addr.s_addr == INADDR_ANY;
1256 default:
1257 return -1;
1258 }
1259}
1260
Max9d7a2472018-11-20 15:18:31 +01001261/*! Convert sockaddr_in to IP address as char string and port as uint16_t.
1262 * \param[out] addr String buffer to write IP address to, or NULL.
1263 * \param[out] addr_len Size of \a addr.
1264 * \param[out] port Pointer to uint16_t to write the port number to, or NULL.
1265 * \param[in] sin Sockaddr to convert.
1266 * \returns the required string buffer size, like osmo_strlcpy(), or 0 if \a addr is NULL.
1267 */
1268size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
1269 const struct sockaddr_in *sin)
1270{
1271 if (port)
1272 *port = ntohs(sin->sin_port);
1273
1274 if (addr)
1275 return osmo_strlcpy(addr, inet_ntoa(sin->sin_addr), addr_len);
1276
1277 return 0;
1278}
1279
Neels Hofmeyr59f4caf2018-07-19 22:13:19 +02001280/*! Convert sockaddr to IP address as char string and port as uint16_t.
1281 * \param[out] addr String buffer to write IP address to, or NULL.
1282 * \param[out] addr_len Size of \a addr.
1283 * \param[out] port Pointer to uint16_t to write the port number to, or NULL.
1284 * \param[in] sa Sockaddr to convert.
1285 * \returns the required string buffer size, like osmo_strlcpy(), or 0 if \a addr is NULL.
1286 */
1287unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port,
1288 const struct sockaddr *sa)
1289{
Neels Hofmeyr59f4caf2018-07-19 22:13:19 +02001290
Pau Espin Pedrol1a3d24e2020-08-28 18:31:32 +02001291 const struct sockaddr_in6 *sin6;
1292
1293 switch (sa->sa_family) {
1294 case AF_INET:
1295 return osmo_sockaddr_in_to_str_and_uint(addr, addr_len, port,
1296 (const struct sockaddr_in *)sa);
1297 case AF_INET6:
1298 sin6 = (const struct sockaddr_in6 *)sa;
1299 if (port)
1300 *port = ntohs(sin6->sin6_port);
1301 if (addr && inet_ntop(sa->sa_family, &sin6->sin6_addr, addr, addr_len))
1302 return strlen(addr);
1303 break;
1304 }
1305 return 0;
Neels Hofmeyr59f4caf2018-07-19 22:13:19 +02001306}
1307
Pau Espin Pedrol5cc4fe42020-08-31 12:52:06 +02001308/*! inet_ntop() wrapper for a struct sockaddr.
1309 * \param[in] sa source sockaddr to get the address from.
1310 * \param[out] dst string buffer of at least INET6_ADDRSTRLEN size.
1311 * \returns returns a non-null pointer to dst. NULL is returned if there was an
1312 * error, with errno set to indicate the error.
1313 */
1314const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst)
1315{
1316 const struct osmo_sockaddr *osa = (const struct osmo_sockaddr *)sa;
1317 return inet_ntop(osa->u.sa.sa_family,
1318 osa->u.sa.sa_family == AF_INET6 ?
1319 (const void *)&osa->u.sin6.sin6_addr :
1320 (const void *)&osa->u.sin.sin_addr,
1321 dst, INET6_ADDRSTRLEN);
1322}
1323
1324/*! Get sockaddr port content (in host byte order)
1325 * \param[in] sa source sockaddr to get the port from.
1326 * \returns returns the sockaddr port in host byte order
1327 */
1328uint16_t osmo_sockaddr_port(const struct sockaddr *sa)
1329{
1330 const struct osmo_sockaddr *osa = (const struct osmo_sockaddr *)sa;
1331 switch (osa->u.sa.sa_family) {
1332 case AF_INET6:
1333 return ntohs(osa->u.sin6.sin6_port);
1334 case AF_INET:
1335 return ntohs(osa->u.sin.sin_port);
1336 }
1337 return 0;
1338}
1339
Neels Hofmeyr9c7f7f82022-01-11 19:25:40 +01001340/*! Set sockaddr port content (to network byte order).
1341 * \param[out] sa sockaddr to set the port of.
1342 * \param[in] port port nr to set.
1343 */
1344void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port)
1345{
1346 struct osmo_sockaddr *osa = (struct osmo_sockaddr *)sa;
1347 switch (osa->u.sa.sa_family) {
1348 case AF_INET6:
1349 osa->u.sin6.sin6_port = htons(port);
1350 return;
1351 case AF_INET:
1352 osa->u.sin.sin_port = htons(port);
1353 return;
1354 }
1355}
1356
Pau Espin Pedrolcc296c92023-01-16 14:54:55 +01001357static unsigned int in6_addr_netmask_to_prefixlen(const struct in6_addr *netmask)
1358{
1359 #if defined(__linux__)
1360 #define ADDRFIELD(i) s6_addr32[i]
1361 #else
1362 #define ADDRFIELD(i) __u6_addr.__u6_addr32[i]
1363 #endif
1364
1365 unsigned int i, j, prefix = 0;
1366
1367 for (j = 0; j < 4; j++) {
1368 uint32_t bits = netmask->ADDRFIELD(j);
1369 uint8_t *b = (uint8_t *)&bits;
1370 for (i = 0; i < 4; i++) {
1371 while (b[i] & 0x80) {
1372 prefix++;
1373 b[i] = b[i] << 1;
1374 }
1375 }
1376 }
1377
1378 #undef ADDRFIELD
1379
1380 return prefix;
1381}
1382
1383static unsigned int in_addr_netmask_to_prefixlen(const struct in_addr *netmask)
1384{
1385 uint32_t bits = netmask->s_addr;
1386 uint8_t *b = (uint8_t *)&bits;
1387 unsigned int i, prefix = 0;
1388
1389 for (i = 0; i < 4; i++) {
1390 while (b[i] & 0x80) {
1391 prefix++;
1392 b[i] = b[i] << 1;
1393 }
1394 }
1395 return prefix;
1396}
1397
1398/*! Convert netmask to prefix length representation
1399 * \param[in] netmask sockaddr containing a netmask (consecutive list of 1-bit followed by consecutive list of 0-bit)
1400 * \returns prefix length representation of the netmask (count of 1-bit from the start of the netmask), negative on error.
1401 */
1402int osmo_sockaddr_netmask_to_prefixlen(const struct osmo_sockaddr *netmask)
1403{
1404 switch (netmask->u.sa.sa_family) {
1405 case AF_INET6:
1406 return in6_addr_netmask_to_prefixlen(&netmask->u.sin6.sin6_addr);
1407 case AF_INET:
1408 return in_addr_netmask_to_prefixlen(&netmask->u.sin.sin_addr);
1409 default:
1410 return -ENOTSUP;
1411 }
1412}
1413
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001414/*! Initialize a unix domain socket (including bind/connect)
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001415 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
1416 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
1417 * \param[in] socket_path path to identify the socket
1418 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001419 * \returns socket fd on success; negative on error
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001420 *
1421 * This function creates a new unix domain socket, \a
1422 * type and \a proto and optionally binds or connects it, depending on
1423 * the value of \a flags parameter.
1424 */
Eric Wildeb5769b2019-06-27 15:31:17 +02001425#if defined(__clang__) && defined(SUN_LEN)
1426__attribute__((no_sanitize("undefined")))
1427#endif
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001428int osmo_sock_unix_init(uint16_t type, uint8_t proto,
1429 const char *socket_path, unsigned int flags)
1430{
1431 struct sockaddr_un local;
Harald Weltefaf6b702021-04-28 13:04:59 +02001432 int sfd, rc;
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001433 unsigned int namelen;
1434
1435 if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) ==
1436 (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT))
1437 return -EINVAL;
1438
1439 local.sun_family = AF_UNIX;
Stefan Sperling6afb3f52018-09-20 17:21:05 +02001440 /* When an AF_UNIX socket is bound, sun_path should be NUL-terminated. See unix(7) man page. */
1441 if (osmo_strlcpy(local.sun_path, socket_path, sizeof(local.sun_path)) >= sizeof(local.sun_path)) {
Stefan Sperling896ff6d2018-08-28 14:34:17 +02001442 LOGP(DLGLOBAL, LOGL_ERROR, "Socket path exceeds maximum length of %zd bytes: %s\n",
1443 sizeof(local.sun_path), socket_path);
1444 return -ENOSPC;
1445 }
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001446
1447#if defined(BSD44SOCKETS) || defined(__UNIXWARE__)
Stefan Sperling6afb3f52018-09-20 17:21:05 +02001448 local.sun_len = strlen(local.sun_path);
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001449#endif
1450#if defined(BSD44SOCKETS) || defined(SUN_LEN)
1451 namelen = SUN_LEN(&local);
1452#else
Stefan Sperling6afb3f52018-09-20 17:21:05 +02001453 namelen = strlen(local.sun_path) +
1454 offsetof(struct sockaddr_un, sun_path);
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001455#endif
1456
1457 sfd = socket(AF_UNIX, type, proto);
1458 if (sfd < 0)
Maxdb7cb692023-02-11 21:35:21 +03001459 return -errno;
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001460
1461 if (flags & OSMO_SOCK_F_CONNECT) {
1462 rc = connect(sfd, (struct sockaddr *)&local, namelen);
1463 if (rc < 0)
1464 goto err;
1465 } else {
1466 unlink(local.sun_path);
1467 rc = bind(sfd, (struct sockaddr *)&local, namelen);
1468 if (rc < 0)
1469 goto err;
1470 }
1471
Harald Weltefaf6b702021-04-28 13:04:59 +02001472 rc = socket_helper_tail(sfd, flags);
1473 if (rc < 0)
1474 return rc;
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001475
Harald Weltec47bbda2017-07-13 16:13:26 +02001476 rc = osmo_sock_init_tail(sfd, type, flags);
1477 if (rc < 0) {
1478 close(sfd);
Maxdb7cb692023-02-11 21:35:21 +03001479 sfd = rc;
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001480 }
1481
1482 return sfd;
1483err:
1484 close(sfd);
Maxdb7cb692023-02-11 21:35:21 +03001485 return -errno;
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001486}
1487
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001488/*! Initialize a unix domain socket and fill \ref osmo_fd
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001489 * \param[out] ofd file descriptor (will be filled in)
1490 * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM
1491 * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP
1492 * \param[in] socket_path path to identify the socket
1493 * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT
Harald Welte2d2e2cc2016-04-25 12:11:20 +02001494 * \returns socket fd on success; negative on error
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001495 *
Vadim Yanitskiyb606d762019-06-01 19:02:47 +07001496 * This function creates (and optionally binds/connects) a socket
1497 * using osmo_sock_unix_init, but also fills the ofd structure.
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001498 */
1499int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto,
1500 const char *socket_path, unsigned int flags)
1501{
Harald Welte24980ba2021-04-23 14:07:18 +02001502 return osmo_fd_init_ofd(ofd, osmo_sock_unix_init(type, proto, socket_path, flags), flags);
Álvaro Neira Ayuso5ade61a2014-03-24 13:02:00 +01001503}
1504
Neels Hofmeyr01457512018-12-12 01:48:54 +01001505/*! Get the IP and/or port number on socket in separate string buffers.
Oliver Smith7acd5d02018-10-25 11:16:36 +02001506 * \param[in] fd file descriptor of socket
1507 * \param[out] ip IP address (will be filled in when not NULL)
1508 * \param[in] ip_len length of the ip buffer
1509 * \param[out] port number (will be filled in when not NULL)
1510 * \param[in] port_len length of the port buffer
1511 * \param[in] local (true) or remote (false) name will get looked at
1512 * \returns 0 on success; negative otherwise
1513 */
Neels Hofmeyr01457512018-12-12 01:48:54 +01001514int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local)
Oliver Smith7acd5d02018-10-25 11:16:36 +02001515{
Pau Espin Pedroled42a882020-08-21 15:39:17 +02001516 struct sockaddr_storage sa;
Oliver Smith7acd5d02018-10-25 11:16:36 +02001517 socklen_t len = sizeof(sa);
Oliver Smith860651e2018-10-30 14:31:57 +01001518 char ipbuf[INET6_ADDRSTRLEN], portbuf[6];
Oliver Smith7acd5d02018-10-25 11:16:36 +02001519 int rc;
1520
Pau Espin Pedroled42a882020-08-21 15:39:17 +02001521 rc = local ? getsockname(fd, (struct sockaddr*)&sa, &len) : getpeername(fd, (struct sockaddr*)&sa, &len);
Oliver Smith7acd5d02018-10-25 11:16:36 +02001522 if (rc < 0)
1523 return rc;
1524
Pau Espin Pedroled42a882020-08-21 15:39:17 +02001525 rc = getnameinfo((const struct sockaddr*)&sa, len, ipbuf, sizeof(ipbuf),
Oliver Smith7acd5d02018-10-25 11:16:36 +02001526 portbuf, sizeof(portbuf),
1527 NI_NUMERICHOST | NI_NUMERICSERV);
1528 if (rc < 0)
1529 return rc;
1530
1531 if (ip)
1532 strncpy(ip, ipbuf, ip_len);
1533 if (port)
1534 strncpy(port, portbuf, port_len);
1535 return 0;
1536}
1537
1538/*! Get local IP address on socket
1539 * \param[in] fd file descriptor of socket
1540 * \param[out] ip IP address (will be filled in)
1541 * \param[in] len length of the output buffer
1542 * \returns 0 on success; negative otherwise
1543 */
1544int osmo_sock_get_local_ip(int fd, char *ip, size_t len)
1545{
Neels Hofmeyr01457512018-12-12 01:48:54 +01001546 return osmo_sock_get_ip_and_port(fd, ip, len, NULL, 0, true);
Oliver Smith7acd5d02018-10-25 11:16:36 +02001547}
1548
1549/*! Get local port on socket
1550 * \param[in] fd file descriptor of socket
1551 * \param[out] port number (will be filled in)
1552 * \param[in] len length of the output buffer
1553 * \returns 0 on success; negative otherwise
1554 */
1555int osmo_sock_get_local_ip_port(int fd, char *port, size_t len)
1556{
Neels Hofmeyr01457512018-12-12 01:48:54 +01001557 return osmo_sock_get_ip_and_port(fd, NULL, 0, port, len, true);
Oliver Smith7acd5d02018-10-25 11:16:36 +02001558}
1559
1560/*! Get remote IP address on socket
1561 * \param[in] fd file descriptor of socket
1562 * \param[out] ip IP address (will be filled in)
1563 * \param[in] len length of the output buffer
1564 * \returns 0 on success; negative otherwise
1565 */
1566int osmo_sock_get_remote_ip(int fd, char *ip, size_t len)
1567{
Neels Hofmeyr01457512018-12-12 01:48:54 +01001568 return osmo_sock_get_ip_and_port(fd, ip, len, NULL, 0, false);
Oliver Smith7acd5d02018-10-25 11:16:36 +02001569}
1570
1571/*! Get remote port on socket
1572 * \param[in] fd file descriptor of socket
1573 * \param[out] port number (will be filled in)
1574 * \param[in] len length of the output buffer
1575 * \returns 0 on success; negative otherwise
1576 */
1577int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len)
1578{
Neels Hofmeyr01457512018-12-12 01:48:54 +01001579 return osmo_sock_get_ip_and_port(fd, NULL, 0, port, len, false);
Oliver Smith7acd5d02018-10-25 11:16:36 +02001580}
1581
Neels Hofmeyr01457512018-12-12 01:48:54 +01001582/*! Get address/port information on socket in dyn-alloc string like "(r=1.2.3.4:5<->l=6.7.8.9:10)".
1583 * Usually, it is better to use osmo_sock_get_name2() for a static string buffer or osmo_sock_get_name_buf() for a
1584 * caller provided string buffer, to avoid the dynamic talloc allocation.
Harald Welte48f55832017-01-26 00:03:10 +01001585 * \param[in] ctx talloc context from which to allocate string buffer
1586 * \param[in] fd file descriptor of socket
Neels Hofmeyr01457512018-12-12 01:48:54 +01001587 * \returns string identifying the connection of this socket, talloc'd from ctx.
Harald Welte48f55832017-01-26 00:03:10 +01001588 */
Harald Weltec0dfc9d2019-03-18 18:29:43 +01001589char *osmo_sock_get_name(const void *ctx, int fd)
Harald Welte48f55832017-01-26 00:03:10 +01001590{
Philipp Maier64b51eb2019-01-14 11:59:11 +01001591 char str[OSMO_SOCK_NAME_MAXLEN];
Neels Hofmeyr01457512018-12-12 01:48:54 +01001592 int rc;
1593 rc = osmo_sock_get_name_buf(str, sizeof(str), fd);
1594 if (rc <= 0)
1595 return NULL;
1596 return talloc_asprintf(ctx, "(%s)", str);
1597}
1598
1599/*! Get address/port information on socket in provided string buffer, like "r=1.2.3.4:5<->l=6.7.8.9:10".
1600 * This does not include braces like osmo_sock_get_name().
1601 * \param[out] str Destination string buffer.
1602 * \param[in] str_len sizeof(str).
1603 * \param[in] fd File descriptor of socket.
1604 * \return String length as returned by snprintf(), or negative on error.
1605 */
1606int osmo_sock_get_name_buf(char *str, size_t str_len, int fd)
1607{
Oliver Smith860651e2018-10-30 14:31:57 +01001608 char hostbuf_l[INET6_ADDRSTRLEN], hostbuf_r[INET6_ADDRSTRLEN];
1609 char portbuf_l[6], portbuf_r[6];
Neels Hofmeyr01457512018-12-12 01:48:54 +01001610 int rc;
Harald Welte48f55832017-01-26 00:03:10 +01001611
Daniel Willmann7052cc62023-06-16 09:53:15 +02001612 if (fd < 0) {
1613 osmo_strlcpy(str, "<error-bad-fd>", str_len);
1614 return -EBADF;
1615 }
1616
Oliver Smith7acd5d02018-10-25 11:16:36 +02001617 /* get local */
Harald Welteea9ea522019-05-10 09:28:24 +02001618 if ((rc = osmo_sock_get_ip_and_port(fd, hostbuf_l, sizeof(hostbuf_l), portbuf_l, sizeof(portbuf_l), true))) {
1619 osmo_strlcpy(str, "<error-in-getsockname>", str_len);
Neels Hofmeyr01457512018-12-12 01:48:54 +01001620 return rc;
Harald Welteea9ea522019-05-10 09:28:24 +02001621 }
Harald Welte48f55832017-01-26 00:03:10 +01001622
Oliver Smith7acd5d02018-10-25 11:16:36 +02001623 /* get remote */
Neels Hofmeyr01457512018-12-12 01:48:54 +01001624 if (osmo_sock_get_ip_and_port(fd, hostbuf_r, sizeof(hostbuf_r), portbuf_r, sizeof(portbuf_r), false) != 0)
1625 return snprintf(str, str_len, "r=NULL<->l=%s:%s", hostbuf_l, portbuf_l);
Harald Welte48f55832017-01-26 00:03:10 +01001626
Neels Hofmeyr01457512018-12-12 01:48:54 +01001627 return snprintf(str, str_len, "r=%s:%s<->l=%s:%s", hostbuf_r, portbuf_r, hostbuf_l, portbuf_l);
1628}
1629
1630/*! Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10".
1631 * This does not include braces like osmo_sock_get_name().
1632 * \param[in] fd File descriptor of socket.
1633 * \return Static string buffer containing the result.
1634 */
1635const char *osmo_sock_get_name2(int fd)
1636{
Harald Welte171ef822019-03-28 10:49:05 +01001637 static __thread char str[OSMO_SOCK_NAME_MAXLEN];
Neels Hofmeyr01457512018-12-12 01:48:54 +01001638 osmo_sock_get_name_buf(str, sizeof(str), fd);
1639 return str;
Harald Welte48f55832017-01-26 00:03:10 +01001640}
1641
Harald Welte179f3572019-03-18 18:38:47 +01001642/*! Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10".
1643 * This does not include braces like osmo_sock_get_name().
1644 * \param[in] fd File descriptor of socket.
1645 * \return Static string buffer containing the result.
1646 */
1647char *osmo_sock_get_name2_c(const void *ctx, int fd)
1648{
1649 char *str = talloc_size(ctx, OSMO_SOCK_NAME_MAXLEN);
1650 if (!str)
1651 return NULL;
Vadim Yanitskiy4f619c22019-04-12 21:48:07 +07001652 osmo_sock_get_name_buf(str, OSMO_SOCK_NAME_MAXLEN, fd);
Harald Welte179f3572019-03-18 18:38:47 +01001653 return str;
1654}
1655
Harald Weltee30d7e62017-07-13 16:02:50 +02001656static int sock_get_domain(int fd)
1657{
1658 int domain;
1659#ifdef SO_DOMAIN
1660 socklen_t dom_len = sizeof(domain);
1661 int rc;
1662
1663 rc = getsockopt(fd, SOL_SOCKET, SO_DOMAIN, &domain, &dom_len);
1664 if (rc < 0)
1665 return rc;
1666#else
1667 /* This of course sucks, but what shall we do on OSs like
1668 * FreeBSD that don't seem to expose a method by which one can
1669 * learn the address family of a socket? */
1670 domain = AF_INET;
1671#endif
1672 return domain;
1673}
1674
1675
1676/*! Activate or de-activate local loop-back of transmitted multicast packets
1677 * \param[in] fd file descriptor of related socket
1678 * \param[in] enable Enable (true) or disable (false) loop-back
1679 * \returns 0 on success; negative otherwise */
1680int osmo_sock_mcast_loop_set(int fd, bool enable)
1681{
1682 int domain, loop = 0;
1683
1684 if (enable)
1685 loop = 1;
1686
1687 domain = sock_get_domain(fd);
1688 if (domain < 0)
1689 return domain;
1690
1691 switch (domain) {
1692 case AF_INET:
1693 return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop));
1694 case AF_INET6:
1695 return setsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, &loop, sizeof(loop));
1696 default:
1697 return -EINVAL;
1698 }
1699}
1700
1701/*! Set the TTL of outbound multicast packets
1702 * \param[in] fd file descriptor of related socket
1703 * \param[in] ttl TTL of to-be-sent multicast packets
1704 * \returns 0 on success; negative otherwise */
1705int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl)
1706{
1707 int domain, ttli = ttl;
1708
1709 domain = sock_get_domain(fd);
1710 if (domain < 0)
1711 return domain;
1712
1713 switch (domain) {
1714 case AF_INET:
1715 return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_TTL, &ttli, sizeof(ttli));
1716 case AF_INET6:
1717 return setsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &ttli, sizeof(ttli));
1718 default:
1719 return -EINVAL;
1720 }
1721}
1722
Harald Welte44b99262020-03-07 14:59:05 +01001723/*! Set the network device to which we should bind the multicast socket
1724 * \param[in] fd file descriptor of related socket
1725 * \param[in] ifname name of network interface to user for multicast
1726 * \returns 0 on success; negative otherwise */
1727int osmo_sock_mcast_iface_set(int fd, const char *ifname)
1728{
1729 unsigned int ifindex;
1730 struct ip_mreqn mr;
1731
1732 /* first, resolve interface name to ifindex */
1733 ifindex = if_nametoindex(ifname);
1734 if (ifindex == 0)
1735 return -errno;
1736
1737 /* next, configure kernel to use that ifindex for this sockets multicast traffic */
1738 memset(&mr, 0, sizeof(mr));
1739 mr.imr_ifindex = ifindex;
1740 return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_IF, &mr, sizeof(mr));
1741}
1742
1743
Harald Weltee30d7e62017-07-13 16:02:50 +02001744/*! Enable/disable receiving all multicast packets, even for non-subscribed groups
1745 * \param[in] fd file descriptor of related socket
1746 * \param[in] enable Enable or Disable receiving of all packets
1747 * \returns 0 on success; negative otherwise */
1748int osmo_sock_mcast_all_set(int fd, bool enable)
1749{
1750 int domain, all = 0;
1751
1752 if (enable)
1753 all = 1;
1754
1755 domain = sock_get_domain(fd);
1756 if (domain < 0)
1757 return domain;
1758
1759 switch (domain) {
1760 case AF_INET:
1761#ifdef IP_MULTICAST_ALL
1762 return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_ALL, &all, sizeof(all));
1763#endif
1764 case AF_INET6:
1765 /* there seems no equivalent ?!? */
1766 default:
1767 return -EINVAL;
1768 }
1769}
1770
1771/* FreeBSD calls the socket option differently */
1772#if !defined(IPV6_ADD_MEMBERSHIP) && defined(IPV6_JOIN_GROUP)
1773#define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP
1774#endif
1775
1776/*! Subscribe to the given IP multicast group
1777 * \param[in] fd file descriptor of related scoket
1778 * \param[in] grp_addr ASCII representation of the multicast group address
1779 * \returns 0 on success; negative otherwise */
1780int osmo_sock_mcast_subscribe(int fd, const char *grp_addr)
1781{
1782 int rc, domain;
1783 struct ip_mreq mreq;
1784 struct ipv6_mreq mreq6;
1785 struct in6_addr i6a;
1786
1787 domain = sock_get_domain(fd);
1788 if (domain < 0)
1789 return domain;
1790
1791 switch (domain) {
1792 case AF_INET:
1793 memset(&mreq, 0, sizeof(mreq));
1794 mreq.imr_multiaddr.s_addr = inet_addr(grp_addr);
1795 mreq.imr_interface.s_addr = htonl(INADDR_ANY);
1796 return setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq));
1797#ifdef IPV6_ADD_MEMBERSHIP
1798 case AF_INET6:
1799 memset(&mreq6, 0, sizeof(mreq6));
1800 rc = inet_pton(AF_INET6, grp_addr, (void *)&i6a);
1801 if (rc < 0)
1802 return -EINVAL;
1803 mreq6.ipv6mr_multiaddr = i6a;
1804 return setsockopt(fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6));
1805#endif
1806 default:
1807 return -EINVAL;
1808 }
1809}
1810
Philipp Maier2d2490e2017-10-20 19:41:26 +02001811/*! Determine the matching local IP-address for a given remote IP-Address.
1812 * \param[out] local_ip caller provided memory for resulting local IP-address
1813 * \param[in] remote_ip remote IP-address
Philipp Maier2d2490e2017-10-20 19:41:26 +02001814 * \returns 0 on success; negative otherwise
1815 *
1816 * The function accepts IPv4 and IPv6 address strings. The caller must provide
1817 * at least INET6_ADDRSTRLEN bytes for local_ip if an IPv6 is expected as
1818 * as result. For IPv4 addresses the required amount is INET_ADDRSTRLEN. */
1819int osmo_sock_local_ip(char *local_ip, const char *remote_ip)
1820{
1821 int sfd;
1822 int rc;
1823 struct addrinfo addrinfo_hint;
1824 struct addrinfo *addrinfo = NULL;
Pau Espin Pedrol81e7a6c2020-08-28 20:44:26 +02001825 struct sockaddr_storage local_addr;
1826 struct sockaddr_in *sin;
1827 struct sockaddr_in6 *sin6;
Philipp Maier2d2490e2017-10-20 19:41:26 +02001828 socklen_t local_addr_len;
1829 uint16_t family;
1830
1831 /* Find out the address family (AF_INET or AF_INET6?) */
1832 memset(&addrinfo_hint, '\0', sizeof(addrinfo_hint));
Pau Espin Pedrol308ab792020-08-28 19:47:25 +02001833 addrinfo_hint.ai_family = AF_UNSPEC;
Philipp Maier2d2490e2017-10-20 19:41:26 +02001834 addrinfo_hint.ai_flags = AI_NUMERICHOST;
1835 rc = getaddrinfo(remote_ip, NULL, &addrinfo_hint, &addrinfo);
1836 if (rc)
1837 return -EINVAL;
1838 family = addrinfo->ai_family;
1839 freeaddrinfo(addrinfo);
1840
1841 /* Connect a dummy socket to trick the kernel into determining the
1842 * ip-address of the interface that would be used if we would send
1843 * out an actual packet */
1844 sfd = osmo_sock_init2(family, SOCK_DGRAM, IPPROTO_UDP, NULL, 0, remote_ip, 0, OSMO_SOCK_F_CONNECT);
1845 if (sfd < 0)
1846 return -EINVAL;
1847
1848 /* Request the IP address of the interface that the kernel has
1849 * actually choosen. */
1850 memset(&local_addr, 0, sizeof(local_addr));
1851 local_addr_len = sizeof(local_addr);
1852 rc = getsockname(sfd, (struct sockaddr *)&local_addr, &local_addr_len);
Philipp Maier8b7975b2018-01-22 15:38:07 +01001853 close(sfd);
Philipp Maier2d2490e2017-10-20 19:41:26 +02001854 if (rc < 0)
1855 return -EINVAL;
Pau Espin Pedrol81e7a6c2020-08-28 20:44:26 +02001856
1857 switch (local_addr.ss_family) {
1858 case AF_INET:
1859 sin = (struct sockaddr_in*)&local_addr;
1860 if (!inet_ntop(AF_INET, &sin->sin_addr, local_ip, INET_ADDRSTRLEN))
1861 return -EINVAL;
1862 break;
1863 case AF_INET6:
1864 sin6 = (struct sockaddr_in6*)&local_addr;
Pau Espin Pedrol7bda8542020-08-31 11:21:30 +02001865 if (!inet_ntop(AF_INET6, &sin6->sin6_addr, local_ip, INET6_ADDRSTRLEN))
Pau Espin Pedrol81e7a6c2020-08-28 20:44:26 +02001866 return -EINVAL;
1867 break;
1868 default:
Philipp Maier2d2490e2017-10-20 19:41:26 +02001869 return -EINVAL;
Pau Espin Pedrol81e7a6c2020-08-28 20:44:26 +02001870 }
Philipp Maier2d2490e2017-10-20 19:41:26 +02001871
1872 return 0;
1873}
1874
Alexander Couzens0f364212020-07-27 22:33:01 +02001875/*! Determine the matching local address for a given remote address.
1876 * \param[out] local_ip caller provided memory for resulting local address
1877 * \param[in] remote_ip remote address
1878 * \returns 0 on success; negative otherwise
1879 */
1880int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip, const struct osmo_sockaddr *remote_ip)
1881{
1882 int sfd;
1883 int rc;
1884 socklen_t local_ip_len;
1885
1886 sfd = osmo_sock_init_osa(SOCK_DGRAM, IPPROTO_UDP, NULL, remote_ip, OSMO_SOCK_F_CONNECT);
1887 if (sfd < 0)
1888 return -EINVAL;
1889
1890 memset(local_ip, 0, sizeof(*local_ip));
1891 local_ip_len = sizeof(*local_ip);
1892 rc = getsockname(sfd, (struct sockaddr *)local_ip, &local_ip_len);
1893 close(sfd);
1894
1895 return rc;
1896}
1897
Neels Hofmeyrcf7f7922022-02-02 03:08:40 +01001898/*! Copy the addr part, the IP address octets in network byte order, to a buffer.
1899 * Useful for encoding network protocols.
1900 * \param[out] dst Write octets to this buffer.
1901 * \param[in] dst_maxlen Space available in buffer.
1902 * \param[in] os Sockaddr to copy IP of.
1903 * \return nr of octets written on success, negative on error.
1904 */
1905int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os)
1906{
1907 const void *addr;
1908 size_t len;
Neels Hofmeyr1790f172022-02-02 03:08:40 +01001909 switch (os->u.sa.sa_family) {
Neels Hofmeyrcf7f7922022-02-02 03:08:40 +01001910 case AF_INET:
1911 addr = &os->u.sin.sin_addr;
1912 len = sizeof(os->u.sin.sin_addr);
1913 break;
1914 case AF_INET6:
1915 addr = &os->u.sin6.sin6_addr;
1916 len = sizeof(os->u.sin6.sin6_addr);
1917 break;
1918 default:
1919 return -ENOTSUP;
1920 }
1921 if (dst_maxlen < len)
1922 return -ENOSPC;
1923 memcpy(dst, addr, len);
1924 return len;
1925}
1926
1927/*! Copy the addr part, the IP address octets in network byte order, from a buffer.
1928 * Useful for decoding network protocols.
1929 * \param[out] os Write IP address to this sockaddr.
1930 * \param[in] src Source buffer to read IP address octets from.
1931 * \param[in] src_len Number of octets to copy.
1932 * \return number of octets read on success, negative on error.
1933 */
1934int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len)
1935{
1936 void *addr;
1937 size_t len;
1938 *os = (struct osmo_sockaddr){0};
1939 switch (src_len) {
1940 case sizeof(os->u.sin.sin_addr):
Neels Hofmeyr1790f172022-02-02 03:08:40 +01001941 os->u.sa.sa_family = AF_INET;
Neels Hofmeyrcf7f7922022-02-02 03:08:40 +01001942 addr = &os->u.sin.sin_addr;
1943 len = sizeof(os->u.sin.sin_addr);
1944 break;
1945 case sizeof(os->u.sin6.sin6_addr):
1946 os->u.sin6.sin6_family = AF_INET6;
1947 addr = &os->u.sin6.sin6_addr;
1948 len = sizeof(os->u.sin6.sin6_addr);
1949 break;
1950 default:
1951 return -ENOTSUP;
1952 }
1953 memcpy(addr, src, len);
1954 return len;
1955}
1956
Alexander Couzense4181ea2020-07-20 00:03:16 +02001957/*! Compare two osmo_sockaddr.
1958 * \param[in] a
1959 * \param[in] b
1960 * \return 0 if a and b are equal. Otherwise it follows memcmp()
1961 */
Vadim Yanitskiydef5a402020-10-09 21:40:47 +07001962int osmo_sockaddr_cmp(const struct osmo_sockaddr *a,
1963 const struct osmo_sockaddr *b)
Alexander Couzense4181ea2020-07-20 00:03:16 +02001964{
1965 if (a == b)
1966 return 0;
1967 if (!a)
1968 return 1;
1969 if (!b)
1970 return -1;
1971
1972 if (a->u.sa.sa_family != b->u.sa.sa_family) {
1973 return OSMO_CMP(a->u.sa.sa_family, b->u.sa.sa_family);
1974 }
1975
1976 switch (a->u.sa.sa_family) {
1977 case AF_INET:
1978 return memcmp(&a->u.sin, &b->u.sin, sizeof(struct sockaddr_in));
1979 case AF_INET6:
1980 return memcmp(&a->u.sin6, &b->u.sin6, sizeof(struct sockaddr_in6));
1981 default:
1982 /* fallback to memcmp for remaining AF over the full osmo_sockaddr length */
1983 return memcmp(a, b, sizeof(struct osmo_sockaddr));
1984 }
1985}
1986
Alexander Couzens80788fa2020-10-12 01:11:20 +02001987/*! string-format a given osmo_sockaddr address
1988 * \param[in] sockaddr the osmo_sockaddr to print
1989 * \return pointer to the string on success; NULL on error
1990 */
1991const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr)
1992{
1993 /* INET6_ADDRSTRLEN contains already a null termination,
1994 * adding '[' ']' ':' '16 bit port' */
1995 static __thread char buf[INET6_ADDRSTRLEN + 8];
1996 return osmo_sockaddr_to_str_buf(buf, sizeof(buf), sockaddr);
1997}
1998
Neels Hofmeyr09d65742021-12-01 10:25:02 +01001999/*! string-format a given osmo_sockaddr address into a user-supplied buffer.
2000 * Same as osmo_sockaddr_to_str_buf() but returns a would-be length in snprintf() style.
2001 * \param[in] buf user-supplied output buffer
2002 * \param[in] buf_len size of the user-supplied output buffer in bytes
2003 * \param[in] sockaddr the osmo_sockaddr to print
2004 * \return number of characters that would be written if the buffer is large enough, like snprintf().
2005 */
2006int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr)
2007{
2008 struct osmo_strbuf sb = { .buf = buf, .len = buf_len };
2009 uint16_t port = 0;
2010
2011 if (!sockaddr) {
2012 OSMO_STRBUF_PRINTF(sb, "NULL");
2013 return sb.chars_needed;
2014 }
2015
2016 switch (sockaddr->u.sa.sa_family) {
2017 case AF_INET:
2018 OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_and_uint, &port, &sockaddr->u.sa);
2019 if (port)
2020 OSMO_STRBUF_PRINTF(sb, ":%u", port);
2021 break;
2022 case AF_INET6:
2023 OSMO_STRBUF_PRINTF(sb, "[");
2024 OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_and_uint, &port, &sockaddr->u.sa);
2025 OSMO_STRBUF_PRINTF(sb, "]");
2026 if (port)
2027 OSMO_STRBUF_PRINTF(sb, ":%u", port);
2028 break;
2029 default:
2030 OSMO_STRBUF_PRINTF(sb, "unsupported family %d", sockaddr->u.sa.sa_family);
2031 break;
2032 }
2033
2034 return sb.chars_needed;
2035}
2036
2037/*! string-format a given osmo_sockaddr address into a talloc allocated buffer.
2038 * Like osmo_sockaddr_to_str_buf2() but returns a talloc allocated string.
2039 * \param[in] ctx talloc context to allocate from, e.g. OTC_SELECT.
2040 * \param[in] sockaddr the osmo_sockaddr to print.
2041 * \return human readable string.
2042 */
2043char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr)
2044{
2045 OSMO_NAME_C_IMPL(ctx, 64, "ERROR", osmo_sockaddr_to_str_buf2, sockaddr)
2046}
2047
2048/*! string-format a given osmo_sockaddr address into a user-supplied buffer.
2049 * Like osmo_sockaddr_to_str_buf2() but returns buf, or NULL if too short.
Alexander Couzens80788fa2020-10-12 01:11:20 +02002050 * \param[in] buf user-supplied output buffer
2051 * \param[in] buf_len size of the user-supplied output buffer in bytes
2052 * \param[in] sockaddr the osmo_sockaddr to print
2053 * \return pointer to the string on success; NULL on error
2054 */
2055char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len,
2056 const struct osmo_sockaddr *sockaddr)
2057{
Neels Hofmeyr09d65742021-12-01 10:25:02 +01002058 int chars_needed = osmo_sockaddr_to_str_buf2(buf, buf_len, sockaddr);
2059 if (chars_needed >= buf_len)
Alexander Couzens80788fa2020-10-12 01:11:20 +02002060 return NULL;
Alexander Couzens80788fa2020-10-12 01:11:20 +02002061 return buf;
2062}
2063
Harald Weltece53e032021-04-27 21:44:34 +02002064/*! Set the DSCP (differentiated services code point) of a socket.
2065 * \param[in] dscp DSCP value in range 0..63
2066 * \returns 0 on success; negative on error. */
2067int osmo_sock_set_dscp(int fd, uint8_t dscp)
2068{
Harald Welte903e6702021-04-28 13:27:12 +02002069 struct sockaddr_storage local_addr;
2070 socklen_t local_addr_len = sizeof(local_addr);
Harald Weltece53e032021-04-27 21:44:34 +02002071 uint8_t tos;
2072 socklen_t tos_len = sizeof(tos);
Harald Welte903e6702021-04-28 13:27:12 +02002073 int tclass;
2074 socklen_t tclass_len = sizeof(tclass);
Harald Weltece53e032021-04-27 21:44:34 +02002075 int rc;
2076
2077 /* DSCP is a 6-bit value stored in the upper 6 bits of the 8-bit TOS */
2078 if (dscp > 63)
2079 return -EINVAL;
2080
Harald Welte903e6702021-04-28 13:27:12 +02002081 rc = getsockname(fd, (struct sockaddr *)&local_addr, &local_addr_len);
Harald Weltece53e032021-04-27 21:44:34 +02002082 if (rc < 0)
2083 return rc;
2084
Harald Welte903e6702021-04-28 13:27:12 +02002085 switch (local_addr.ss_family) {
2086 case AF_INET:
2087 /* read the original value */
2088 rc = getsockopt(fd, IPPROTO_IP, IP_TOS, &tos, &tos_len);
2089 if (rc < 0)
2090 return rc;
2091 /* mask-in the DSCP into the upper 6 bits */
2092 tos &= 0x03;
2093 tos |= dscp << 2;
2094 /* and write it back to the kernel */
2095 rc = setsockopt(fd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos));
2096 break;
2097 case AF_INET6:
2098 /* read the original value */
2099 rc = getsockopt(fd, IPPROTO_IPV6, IPV6_TCLASS, &tclass, &tclass_len);
2100 if (rc < 0)
2101 return rc;
2102 /* mask-in the DSCP into the upper 6 bits */
2103 tclass &= 0x03;
2104 tclass |= dscp << 2;
2105 /* and write it back to the kernel */
2106 rc = setsockopt(fd, IPPROTO_IPV6, IPV6_TCLASS, &tclass, sizeof(tclass));
2107 break;
2108 case AF_UNSPEC:
2109 default:
2110 LOGP(DLGLOBAL, LOGL_ERROR, "No DSCP support for socket family %u\n",
2111 local_addr.ss_family);
2112 rc = -1;
2113 break;
2114 }
Harald Weltece53e032021-04-27 21:44:34 +02002115
Harald Welte903e6702021-04-28 13:27:12 +02002116 return rc;
Harald Weltece53e032021-04-27 21:44:34 +02002117}
2118
Harald Welteecc0bd82021-04-27 22:24:08 +02002119/*! Set the priority value of a socket.
2120 * \param[in] prio priority value. Values outside 0..6 require CAP_NET_ADMIN.
2121 * \returns 0 on success; negative on error. */
2122int osmo_sock_set_priority(int fd, int prio)
2123{
2124 /* and write it back to the kernel */
2125 return setsockopt(fd, SOL_SOCKET, SO_PRIORITY, &prio, sizeof(prio));
2126}
Alexander Couzens80788fa2020-10-12 01:11:20 +02002127
Harald Weltee4764422011-05-22 12:25:57 +02002128#endif /* HAVE_SYS_SOCKET_H */
Harald Welteba6988b2011-08-17 12:46:48 +02002129
Sylvain Munautdca7d2c2012-04-18 21:53:23 +02002130/*! @} */