Harald Welte | 468b643 | 2014-09-11 13:05:51 +0800 | [diff] [blame] | 1 | /* |
Harald Welte | 48f5583 | 2017-01-26 00:03:10 +0100 | [diff] [blame] | 2 | * (C) 2011-2017 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | 468b643 | 2014-09-11 13:05:51 +0800 | [diff] [blame] | 3 | * |
| 4 | * All Rights Reserved |
| 5 | * |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 6 | * SPDX-License-Identifier: GPL-2.0+ |
| 7 | * |
Harald Welte | 468b643 | 2014-09-11 13:05:51 +0800 | [diff] [blame] | 8 | * 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 Welte | 468b643 | 2014-09-11 13:05:51 +0800 | [diff] [blame] | 18 | */ |
| 19 | |
Pau Espin Pedrol | 88955fb | 2023-01-18 18:54:00 +0100 | [diff] [blame] | 20 | #include "config.h" |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 21 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 22 | /*! \addtogroup socket |
| 23 | * @{ |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 24 | * Osmocom socket convenience functions. |
| 25 | * |
| 26 | * \file socket.c */ |
Harald Welte | 96e2a00 | 2017-06-12 21:44:18 +0200 | [diff] [blame] | 27 | |
Harald Welte | e476442 | 2011-05-22 12:25:57 +0200 | [diff] [blame] | 28 | #ifdef HAVE_SYS_SOCKET_H |
Pau Espin Pedrol | c9ad345 | 2024-03-12 14:04:55 +0100 | [diff] [blame] | 29 | #define _GNU_SOURCE /* for struct ucred on glibc >= 2.8 */ |
Harald Welte | e476442 | 2011-05-22 12:25:57 +0200 | [diff] [blame] | 30 | |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 31 | #include <osmocom/core/logging.h> |
| 32 | #include <osmocom/core/select.h> |
| 33 | #include <osmocom/core/socket.h> |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 34 | #include <osmocom/core/sockaddr_str.h> |
Harald Welte | 48f5583 | 2017-01-26 00:03:10 +0100 | [diff] [blame] | 35 | #include <osmocom/core/talloc.h> |
Neels Hofmeyr | 59f4caf | 2018-07-19 22:13:19 +0200 | [diff] [blame] | 36 | #include <osmocom/core/utils.h> |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 37 | |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 38 | #include <sys/ioctl.h> |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 39 | #include <sys/socket.h> |
| 40 | #include <sys/types.h> |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 41 | #include <sys/un.h> |
Harald Welte | 44b9926 | 2020-03-07 14:59:05 +0100 | [diff] [blame] | 42 | #include <net/if.h> |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 43 | |
Holger Hans Peter Freyther | 4772348 | 2011-11-09 11:26:15 +0100 | [diff] [blame] | 44 | #include <netinet/in.h> |
Harald Welte | e30d7e6 | 2017-07-13 16:02:50 +0200 | [diff] [blame] | 45 | #include <arpa/inet.h> |
Holger Hans Peter Freyther | 4772348 | 2011-11-09 11:26:15 +0100 | [diff] [blame] | 46 | |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 47 | #include <stdio.h> |
| 48 | #include <unistd.h> |
| 49 | #include <stdint.h> |
| 50 | #include <string.h> |
| 51 | #include <errno.h> |
| 52 | #include <netdb.h> |
| 53 | #include <ifaddrs.h> |
| 54 | |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 55 | #ifdef HAVE_LIBSCTP |
| 56 | #include <netinet/sctp.h> |
| 57 | #endif |
| 58 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 59 | static struct addrinfo *addrinfo_helper(uint16_t family, uint16_t type, uint8_t proto, |
| 60 | const char *host, uint16_t port, bool passive) |
| 61 | { |
Pau Espin Pedrol | ff42852 | 2019-10-10 17:38:16 +0200 | [diff] [blame] | 62 | struct addrinfo hints, *result, *rp; |
Oliver Smith | 860651e | 2018-10-30 14:31:57 +0100 | [diff] [blame] | 63 | char portbuf[6]; |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 64 | int rc; |
| 65 | |
| 66 | snprintf(portbuf, sizeof(portbuf), "%u", port); |
| 67 | memset(&hints, 0, sizeof(struct addrinfo)); |
| 68 | hints.ai_family = family; |
| 69 | if (type == SOCK_RAW) { |
| 70 | /* Workaround for glibc, that returns EAI_SERVICE (-8) if |
| 71 | * SOCK_RAW and IPPROTO_GRE is used. |
Pau Espin Pedrol | ff42852 | 2019-10-10 17:38:16 +0200 | [diff] [blame] | 72 | * http://sourceware.org/bugzilla/show_bug.cgi?id=15015 |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 73 | */ |
| 74 | hints.ai_socktype = SOCK_DGRAM; |
| 75 | hints.ai_protocol = IPPROTO_UDP; |
| 76 | } else { |
| 77 | hints.ai_socktype = type; |
| 78 | hints.ai_protocol = proto; |
| 79 | } |
Pau Espin Pedrol | 3119d47 | 2020-08-25 12:30:55 +0200 | [diff] [blame] | 80 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 81 | if (passive) |
| 82 | hints.ai_flags |= AI_PASSIVE; |
| 83 | |
| 84 | rc = getaddrinfo(host, portbuf, &hints, &result); |
| 85 | if (rc != 0) { |
Pau Espin Pedrol | ba828c3 | 2020-08-20 18:28:10 +0200 | [diff] [blame] | 86 | LOGP(DLGLOBAL, LOGL_ERROR, "getaddrinfo(%s, %u) failed: %s\n", |
| 87 | host, port, gai_strerror(rc)); |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 88 | return NULL; |
| 89 | } |
| 90 | |
Pau Espin Pedrol | ff42852 | 2019-10-10 17:38:16 +0200 | [diff] [blame] | 91 | for (rp = result; rp != NULL; rp = rp->ai_next) { |
| 92 | /* Workaround for glibc again */ |
| 93 | if (type == SOCK_RAW) { |
| 94 | rp->ai_socktype = SOCK_RAW; |
| 95 | rp->ai_protocol = proto; |
| 96 | } |
| 97 | } |
| 98 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 99 | return result; |
| 100 | } |
| 101 | |
Pau Espin Pedrol | 8fac511 | 2019-10-24 15:39:25 +0200 | [diff] [blame] | 102 | #ifdef HAVE_LIBSCTP |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 103 | /*! Retrieve an array of addrinfo with specified hints, one for each host in the hosts array. |
| 104 | * \param[out] addrinfo array of addrinfo pointers, will be filled by the function on success. |
| 105 | * Its size must be at least the one of hosts. |
| 106 | * \param[in] family Socket family like AF_INET, AF_INET6. |
| 107 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM. |
| 108 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP. |
| 109 | * \param[in] hosts array of char pointers (strings) containing the addresses to query. |
| 110 | * \param[in] host_cnt length of the hosts array (in items). |
| 111 | * \param[in] port port number in host byte order. |
| 112 | * \param[in] passive whether to include the AI_PASSIVE flag in getaddrinfo() hints. |
| 113 | * \returns 0 is returned on success together with a filled addrinfo array; negative on error |
| 114 | */ |
| 115 | static int addrinfo_helper_multi(struct addrinfo **addrinfo, uint16_t family, uint16_t type, uint8_t proto, |
| 116 | const char **hosts, size_t host_cnt, uint16_t port, bool passive) |
| 117 | { |
Harald Welte | 0b08d51 | 2022-01-09 12:03:12 +0100 | [diff] [blame] | 118 | unsigned int i, j; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 119 | |
| 120 | for (i = 0; i < host_cnt; i++) { |
| 121 | addrinfo[i] = addrinfo_helper(family, type, proto, hosts[i], port, passive); |
| 122 | if (!addrinfo[i]) { |
| 123 | for (j = 0; j < i; j++) |
| 124 | freeaddrinfo(addrinfo[j]); |
| 125 | return -EINVAL; |
| 126 | } |
| 127 | } |
| 128 | return 0; |
| 129 | } |
Pau Espin Pedrol | 8fac511 | 2019-10-24 15:39:25 +0200 | [diff] [blame] | 130 | #endif /* HAVE_LIBSCTP*/ |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 131 | |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 132 | static int socket_helper_tail(int sfd, unsigned int flags) |
| 133 | { |
Harald Welte | c545ff6 | 2021-04-28 13:09:49 +0200 | [diff] [blame] | 134 | int rc, on = 1; |
| 135 | uint8_t dscp = GET_OSMO_SOCK_F_DSCP(flags); |
| 136 | uint8_t prio = GET_OSMO_SOCK_F_PRIO(flags); |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 137 | |
| 138 | if (flags & OSMO_SOCK_F_NONBLOCK) { |
| 139 | if (ioctl(sfd, FIONBIO, (unsigned char *)&on) < 0) { |
| 140 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 141 | "cannot set this socket unblocking: %s\n", |
| 142 | strerror(errno)); |
| 143 | close(sfd); |
| 144 | return -EINVAL; |
| 145 | } |
| 146 | } |
| 147 | |
Harald Welte | c545ff6 | 2021-04-28 13:09:49 +0200 | [diff] [blame] | 148 | if (dscp) { |
| 149 | rc = osmo_sock_set_dscp(sfd, dscp); |
| 150 | if (rc) { |
| 151 | LOGP(DLGLOBAL, LOGL_ERROR, "cannot set IP DSCP of socket to %u: %s\n", |
| 152 | dscp, strerror(errno)); |
| 153 | /* we consider this a non-fatal error */ |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | if (prio) { |
| 158 | rc = osmo_sock_set_priority(sfd, prio); |
| 159 | if (rc) { |
| 160 | LOGP(DLGLOBAL, LOGL_ERROR, "cannot set priority of socket to %u: %s\n", |
| 161 | prio, strerror(errno)); |
| 162 | /* we consider this a non-fatal error */ |
| 163 | } |
| 164 | } |
| 165 | |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 166 | return 0; |
| 167 | } |
| 168 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 169 | static int socket_helper(const struct addrinfo *rp, unsigned int flags) |
| 170 | { |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 171 | int sfd, rc; |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 172 | |
| 173 | sfd = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol); |
Pau Espin Pedrol | 5d50fa5 | 2018-04-05 17:00:22 +0200 | [diff] [blame] | 174 | if (sfd == -1) { |
| 175 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 176 | "unable to create socket: %s\n", strerror(errno)); |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 177 | return sfd; |
Pau Espin Pedrol | 5d50fa5 | 2018-04-05 17:00:22 +0200 | [diff] [blame] | 178 | } |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 179 | |
| 180 | rc = socket_helper_tail(sfd, flags); |
| 181 | if (rc < 0) |
| 182 | return rc; |
| 183 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 184 | return sfd; |
| 185 | } |
| 186 | |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 187 | static int socket_helper_osa(const struct osmo_sockaddr *addr, uint16_t type, uint8_t proto, unsigned int flags) |
| 188 | { |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 189 | int sfd, rc; |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 190 | |
| 191 | sfd = socket(addr->u.sa.sa_family, type, proto); |
| 192 | if (sfd == -1) { |
| 193 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 194 | "unable to create socket: %s\n", strerror(errno)); |
| 195 | return sfd; |
| 196 | } |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 197 | |
| 198 | rc = socket_helper_tail(sfd, flags); |
| 199 | if (rc < 0) |
| 200 | return rc; |
| 201 | |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 202 | return sfd; |
| 203 | } |
| 204 | |
Pau Espin Pedrol | 8fac511 | 2019-10-24 15:39:25 +0200 | [diff] [blame] | 205 | #ifdef HAVE_LIBSCTP |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 206 | /* Fill buf with a string representation of the address set, in the form: |
| 207 | * buf_len == 0: "()" |
| 208 | * buf_len == 1: "hostA" |
| 209 | * buf_len >= 2: (hostA|hostB|...|...) |
| 210 | */ |
| 211 | static int multiaddr_snprintf(char* buf, size_t buf_len, const char **hosts, size_t host_cnt) |
| 212 | { |
| 213 | int len = 0, offset = 0, rem = buf_len; |
Harald Welte | 0b08d51 | 2022-01-09 12:03:12 +0100 | [diff] [blame] | 214 | size_t i; |
| 215 | int ret; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 216 | char *after; |
| 217 | |
| 218 | if (buf_len < 3) |
| 219 | return -EINVAL; |
| 220 | |
| 221 | if (host_cnt != 1) { |
| 222 | ret = snprintf(buf, rem, "("); |
| 223 | if (ret < 0) |
| 224 | return ret; |
| 225 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
| 226 | } |
| 227 | for (i = 0; i < host_cnt; i++) { |
| 228 | if (host_cnt == 1) |
| 229 | after = ""; |
| 230 | else |
| 231 | after = (i == (host_cnt - 1)) ? ")" : "|"; |
| 232 | ret = snprintf(buf + offset, rem, "%s%s", hosts[i] ? : "0.0.0.0", after); |
| 233 | OSMO_SNPRINTF_RET(ret, rem, offset, len); |
| 234 | } |
| 235 | |
| 236 | return len; |
| 237 | } |
Pau Espin Pedrol | 8fac511 | 2019-10-24 15:39:25 +0200 | [diff] [blame] | 238 | #endif /* HAVE_LIBSCTP */ |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 239 | |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 240 | static int osmo_sock_init_tail(int fd, uint16_t type, unsigned int flags) |
| 241 | { |
Harald Welte | bc43a62 | 2017-07-13 16:20:21 +0200 | [diff] [blame] | 242 | int rc; |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 243 | |
| 244 | /* Make sure to call 'listen' on a bound, connection-oriented sock */ |
| 245 | if ((flags & (OSMO_SOCK_F_BIND|OSMO_SOCK_F_CONNECT)) == OSMO_SOCK_F_BIND) { |
| 246 | switch (type) { |
| 247 | case SOCK_STREAM: |
| 248 | case SOCK_SEQPACKET: |
| 249 | rc = listen(fd, 10); |
Harald Welte | bc43a62 | 2017-07-13 16:20:21 +0200 | [diff] [blame] | 250 | if (rc < 0) { |
| 251 | LOGP(DLGLOBAL, LOGL_ERROR, "unable to listen on socket: %s\n", |
| 252 | strerror(errno)); |
Max | db7cb69 | 2023-02-11 21:35:21 +0300 | [diff] [blame] | 253 | return -errno; |
Harald Welte | bc43a62 | 2017-07-13 16:20:21 +0200 | [diff] [blame] | 254 | } |
| 255 | break; |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 256 | } |
| 257 | } |
| 258 | |
Harald Welte | bc43a62 | 2017-07-13 16:20:21 +0200 | [diff] [blame] | 259 | if (flags & OSMO_SOCK_F_NO_MCAST_LOOP) { |
| 260 | rc = osmo_sock_mcast_loop_set(fd, false); |
| 261 | if (rc < 0) { |
| 262 | LOGP(DLGLOBAL, LOGL_ERROR, "unable to disable multicast loop: %s\n", |
| 263 | strerror(errno)); |
| 264 | return rc; |
| 265 | } |
| 266 | } |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 267 | |
Harald Welte | 37d204a | 2017-07-13 16:33:16 +0200 | [diff] [blame] | 268 | if (flags & OSMO_SOCK_F_NO_MCAST_ALL) { |
| 269 | rc = osmo_sock_mcast_all_set(fd, false); |
| 270 | if (rc < 0) { |
| 271 | LOGP(DLGLOBAL, LOGL_ERROR, "unable to disable receive of all multicast: %s\n", |
| 272 | strerror(errno)); |
| 273 | /* do not abort here, as this is just an |
| 274 | * optional additional optimization that only |
| 275 | * exists on Linux only */ |
| 276 | } |
| 277 | } |
Harald Welte | bc43a62 | 2017-07-13 16:20:21 +0200 | [diff] [blame] | 278 | return 0; |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 279 | } |
| 280 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 281 | /*! Initialize a socket (including bind and/or connect) |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 282 | * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC |
| 283 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 284 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 285 | * \param[in] local_host local host name or IP address in string form |
| 286 | * \param[in] local_port local port number in host byte order |
| 287 | * \param[in] remote_host remote host name or IP address in string form |
| 288 | * \param[in] remote_port remote port number in host byte order |
| 289 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
| 290 | * \returns socket file descriptor on success; negative on error |
| 291 | * |
| 292 | * This function creates a new socket of the designated \a family, \a |
| 293 | * type and \a proto and optionally binds it to the \a local_host and \a |
| 294 | * local_port as well as optionally connects it to the \a remote_host |
| 295 | * and \q remote_port, depending on the value * of \a flags parameter. |
| 296 | * |
| 297 | * As opposed to \ref osmo_sock_init(), this function allows to combine |
| 298 | * the \ref OSMO_SOCK_F_BIND and \ref OSMO_SOCK_F_CONNECT flags. This |
| 299 | * is useful if you want to connect to a remote host/port, but still |
| 300 | * want to bind that socket to either a specific local alias IP and/or a |
| 301 | * specific local source port. |
| 302 | * |
| 303 | * You must specify either \ref OSMO_SOCK_F_BIND, or \ref |
| 304 | * OSMO_SOCK_F_CONNECT, or both. |
| 305 | * |
| 306 | * If \ref OSMO_SOCK_F_NONBLOCK is specified, the socket will be set to |
| 307 | * non-blocking mode. |
| 308 | */ |
| 309 | int osmo_sock_init2(uint16_t family, uint16_t type, uint8_t proto, |
| 310 | const char *local_host, uint16_t local_port, |
| 311 | const char *remote_host, uint16_t remote_port, unsigned int flags) |
| 312 | { |
Alexander Couzens | 2c962f5 | 2020-06-03 00:28:02 +0200 | [diff] [blame] | 313 | struct addrinfo *local = NULL, *remote = NULL, *rp; |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 314 | int sfd = -1, rc, on = 1; |
| 315 | |
Alexander Couzens | 2c962f5 | 2020-06-03 00:28:02 +0200 | [diff] [blame] | 316 | bool local_ipv4 = false, local_ipv6 = false; |
| 317 | bool remote_ipv4 = false, remote_ipv6 = false; |
| 318 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 319 | if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) == 0) { |
| 320 | LOGP(DLGLOBAL, LOGL_ERROR, "invalid: you have to specify either " |
| 321 | "BIND or CONNECT flags\n"); |
| 322 | return -EINVAL; |
| 323 | } |
| 324 | |
Alexander Couzens | 2c962f5 | 2020-06-03 00:28:02 +0200 | [diff] [blame] | 325 | /* figure out local address infos */ |
| 326 | if (flags & OSMO_SOCK_F_BIND) { |
| 327 | local = addrinfo_helper(family, type, proto, local_host, local_port, true); |
| 328 | if (!local) |
| 329 | return -EINVAL; |
| 330 | } |
| 331 | |
| 332 | /* figure out remote address infos */ |
| 333 | if (flags & OSMO_SOCK_F_CONNECT) { |
| 334 | remote = addrinfo_helper(family, type, proto, remote_host, remote_port, false); |
| 335 | if (!remote) { |
| 336 | if (local) |
| 337 | freeaddrinfo(local); |
| 338 | |
| 339 | return -EINVAL; |
| 340 | } |
| 341 | } |
| 342 | |
| 343 | /* It must do a full run to ensure AF_UNSPEC does not fail. |
| 344 | * In case first local valid entry is IPv4 and only remote valid entry |
| 345 | * is IPv6 or vice versa */ |
| 346 | if (family == AF_UNSPEC) { |
| 347 | for (rp = local; rp != NULL; rp = rp->ai_next) { |
| 348 | switch (rp->ai_family) { |
| 349 | case AF_INET: |
| 350 | local_ipv4 = true; |
| 351 | break; |
| 352 | case AF_INET6: |
| 353 | local_ipv6 = true; |
| 354 | break; |
| 355 | } |
| 356 | } |
| 357 | |
| 358 | for (rp = remote; rp != NULL; rp = rp->ai_next) { |
| 359 | switch (rp->ai_family) { |
| 360 | case AF_INET: |
| 361 | remote_ipv4 = true; |
| 362 | break; |
| 363 | case AF_INET6: |
| 364 | remote_ipv6 = true; |
| 365 | break; |
| 366 | } |
| 367 | } |
| 368 | |
Pau Espin Pedrol | d8cf52b | 2020-08-31 19:00:59 +0200 | [diff] [blame] | 369 | if ((flags & OSMO_SOCK_F_BIND) && (flags & OSMO_SOCK_F_CONNECT)) { |
| 370 | /* prioritize ipv6 as per RFC */ |
| 371 | if (local_ipv6 && remote_ipv6) |
| 372 | family = AF_INET6; |
| 373 | else if (local_ipv4 && remote_ipv4) |
| 374 | family = AF_INET; |
| 375 | else { |
| 376 | if (local) |
| 377 | freeaddrinfo(local); |
| 378 | if (remote) |
| 379 | freeaddrinfo(remote); |
| 380 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 381 | "Unable to find a common protocol (IPv4 or IPv6) " |
| 382 | "for local host: %s and remote host: %s.\n", |
| 383 | local_host, remote_host); |
| 384 | return -ENODEV; |
| 385 | } |
| 386 | } else if ((flags & OSMO_SOCK_F_BIND)) { |
| 387 | family = local_ipv6 ? AF_INET6 : AF_INET; |
| 388 | } else if ((flags & OSMO_SOCK_F_CONNECT)) { |
| 389 | family = remote_ipv6 ? AF_INET6 : AF_INET; |
Alexander Couzens | 2c962f5 | 2020-06-03 00:28:02 +0200 | [diff] [blame] | 390 | } |
| 391 | } |
| 392 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 393 | /* figure out local side of socket */ |
| 394 | if (flags & OSMO_SOCK_F_BIND) { |
Alexander Couzens | 2c962f5 | 2020-06-03 00:28:02 +0200 | [diff] [blame] | 395 | for (rp = local; rp != NULL; rp = rp->ai_next) { |
| 396 | /* When called with AF_UNSPEC, family will set to IPv4 or IPv6 */ |
| 397 | if (rp->ai_family != family) |
| 398 | continue; |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 399 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 400 | sfd = socket_helper(rp, flags); |
| 401 | if (sfd < 0) |
| 402 | continue; |
| 403 | |
Philipp Maier | 73196e7 | 2018-08-23 20:11:50 +0200 | [diff] [blame] | 404 | if (proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR) { |
Philipp Maier | 99f706d | 2018-08-01 12:40:36 +0200 | [diff] [blame] | 405 | rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR, |
| 406 | &on, sizeof(on)); |
| 407 | if (rc < 0) { |
| 408 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 409 | "cannot setsockopt socket:" |
| 410 | " %s:%u: %s\n", |
| 411 | local_host, local_port, |
| 412 | strerror(errno)); |
| 413 | close(sfd); |
| 414 | continue; |
| 415 | } |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 416 | } |
Philipp Maier | 99f706d | 2018-08-01 12:40:36 +0200 | [diff] [blame] | 417 | |
Pau Espin Pedrol | 5d50fa5 | 2018-04-05 17:00:22 +0200 | [diff] [blame] | 418 | if (bind(sfd, rp->ai_addr, rp->ai_addrlen) == -1) { |
| 419 | LOGP(DLGLOBAL, LOGL_ERROR, "unable to bind socket: %s:%u: %s\n", |
| 420 | local_host, local_port, strerror(errno)); |
| 421 | close(sfd); |
| 422 | continue; |
| 423 | } |
| 424 | break; |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 425 | } |
Alexander Couzens | 2c962f5 | 2020-06-03 00:28:02 +0200 | [diff] [blame] | 426 | |
| 427 | freeaddrinfo(local); |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 428 | if (rp == NULL) { |
Alexander Couzens | 2c962f5 | 2020-06-03 00:28:02 +0200 | [diff] [blame] | 429 | if (remote) |
| 430 | freeaddrinfo(remote); |
Pau Espin Pedrol | 5d50fa5 | 2018-04-05 17:00:22 +0200 | [diff] [blame] | 431 | LOGP(DLGLOBAL, LOGL_ERROR, "no suitable local addr found for: %s:%u\n", |
| 432 | local_host, local_port); |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 433 | return -ENODEV; |
| 434 | } |
| 435 | } |
| 436 | |
Pau Espin Pedrol | 5d50fa5 | 2018-04-05 17:00:22 +0200 | [diff] [blame] | 437 | /* Reached this point, if OSMO_SOCK_F_BIND then sfd is valid (>=0) or it |
| 438 | was already closed and func returned. If OSMO_SOCK_F_BIND is not |
| 439 | set, then sfd = -1 */ |
| 440 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 441 | /* figure out remote side of socket */ |
| 442 | if (flags & OSMO_SOCK_F_CONNECT) { |
Alexander Couzens | 2c962f5 | 2020-06-03 00:28:02 +0200 | [diff] [blame] | 443 | for (rp = remote; rp != NULL; rp = rp->ai_next) { |
| 444 | /* When called with AF_UNSPEC, family will set to IPv4 or IPv6 */ |
| 445 | if (rp->ai_family != family) |
| 446 | continue; |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 447 | |
Harald Welte | 5cfa6dc | 2017-07-21 16:52:29 +0200 | [diff] [blame] | 448 | if (sfd < 0) { |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 449 | sfd = socket_helper(rp, flags); |
| 450 | if (sfd < 0) |
| 451 | continue; |
| 452 | } |
| 453 | |
| 454 | rc = connect(sfd, rp->ai_addr, rp->ai_addrlen); |
Pau Espin Pedrol | 27cf8df | 2018-04-05 17:49:08 +0200 | [diff] [blame] | 455 | if (rc != 0 && errno != EINPROGRESS) { |
| 456 | LOGP(DLGLOBAL, LOGL_ERROR, "unable to connect socket: %s:%u: %s\n", |
| 457 | remote_host, remote_port, strerror(errno)); |
| 458 | /* We want to maintain the bind socket if bind was enabled */ |
| 459 | if (!(flags & OSMO_SOCK_F_BIND)) { |
| 460 | close(sfd); |
| 461 | sfd = -1; |
| 462 | } |
| 463 | continue; |
| 464 | } |
| 465 | break; |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 466 | } |
Alexander Couzens | 2c962f5 | 2020-06-03 00:28:02 +0200 | [diff] [blame] | 467 | |
| 468 | freeaddrinfo(remote); |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 469 | if (rp == NULL) { |
Pau Espin Pedrol | 27cf8df | 2018-04-05 17:49:08 +0200 | [diff] [blame] | 470 | LOGP(DLGLOBAL, LOGL_ERROR, "no suitable remote addr found for: %s:%u\n", |
| 471 | remote_host, remote_port); |
| 472 | if (sfd >= 0) |
| 473 | close(sfd); |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 474 | return -ENODEV; |
| 475 | } |
| 476 | } |
| 477 | |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 478 | rc = osmo_sock_init_tail(sfd, type, flags); |
| 479 | if (rc < 0) { |
| 480 | close(sfd); |
| 481 | sfd = -1; |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 482 | } |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 483 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 484 | return sfd; |
| 485 | } |
| 486 | |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 487 | #define _SOCKADDR_TO_STR(dest, sockaddr) do { \ |
Neels Hofmeyr | f3270f2 | 2021-12-17 14:21:29 +0100 | [diff] [blame] | 488 | if (osmo_sockaddr_str_from_sockaddr(dest, &sockaddr->u.sas)) \ |
| 489 | osmo_strlcpy((dest)->ip, "Invalid IP", 11); \ |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 490 | } while (0) |
| 491 | |
| 492 | /*! Initialize a socket (including bind and/or connect) |
| 493 | * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC |
| 494 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 495 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 496 | * \param[in] local local address |
| 497 | * \param[in] remote remote address |
| 498 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
| 499 | * \returns socket file descriptor on success; negative on error |
| 500 | * |
| 501 | * This function creates a new socket of the |
| 502 | * \a type and \a proto and optionally binds it to the \a local |
| 503 | * as well as optionally connects it to the \a remote |
| 504 | * depending on the value * of \a flags parameter. |
| 505 | * |
| 506 | * As opposed to \ref osmo_sock_init(), this function allows to combine |
| 507 | * the \ref OSMO_SOCK_F_BIND and \ref OSMO_SOCK_F_CONNECT flags. This |
| 508 | * is useful if you want to connect to a remote host/port, but still |
| 509 | * want to bind that socket to either a specific local alias IP and/or a |
| 510 | * specific local source port. |
| 511 | * |
| 512 | * You must specify either \ref OSMO_SOCK_F_BIND, or \ref |
| 513 | * OSMO_SOCK_F_CONNECT, or both. |
| 514 | * |
| 515 | * If \ref OSMO_SOCK_F_NONBLOCK is specified, the socket will be set to |
| 516 | * non-blocking mode. |
| 517 | */ |
| 518 | int osmo_sock_init_osa(uint16_t type, uint8_t proto, |
| 519 | const struct osmo_sockaddr *local, |
| 520 | const struct osmo_sockaddr *remote, |
| 521 | unsigned int flags) |
| 522 | { |
| 523 | int sfd = -1, rc, on = 1; |
Neels Hofmeyr | f3270f2 | 2021-12-17 14:21:29 +0100 | [diff] [blame] | 524 | struct osmo_sockaddr_str _sastr = {}; |
| 525 | struct osmo_sockaddr_str *sastr = &_sastr; |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 526 | |
| 527 | if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) == 0) { |
| 528 | LOGP(DLGLOBAL, LOGL_ERROR, "invalid: you have to specify either " |
| 529 | "BIND or CONNECT flags\n"); |
| 530 | return -EINVAL; |
| 531 | } |
| 532 | |
| 533 | if ((flags & OSMO_SOCK_F_BIND) && !local) { |
| 534 | LOGP(DLGLOBAL, LOGL_ERROR, "invalid argument. Cannot BIND when local is NULL\n"); |
| 535 | return -EINVAL; |
| 536 | } |
| 537 | |
| 538 | if ((flags & OSMO_SOCK_F_CONNECT) && !remote) { |
| 539 | LOGP(DLGLOBAL, LOGL_ERROR, "invalid argument. Cannot CONNECT when remote is NULL\n"); |
| 540 | return -EINVAL; |
| 541 | } |
| 542 | |
| 543 | if ((flags & OSMO_SOCK_F_BIND) && |
| 544 | (flags & OSMO_SOCK_F_CONNECT) && |
| 545 | local->u.sa.sa_family != remote->u.sa.sa_family) { |
| 546 | LOGP(DLGLOBAL, LOGL_ERROR, "invalid: the family for " |
| 547 | "local and remote endpoint must be same.\n"); |
| 548 | return -EINVAL; |
| 549 | } |
| 550 | |
| 551 | /* figure out local side of socket */ |
| 552 | if (flags & OSMO_SOCK_F_BIND) { |
| 553 | sfd = socket_helper_osa(local, type, proto, flags); |
| 554 | if (sfd < 0) { |
| 555 | _SOCKADDR_TO_STR(sastr, local); |
Neels Hofmeyr | f3270f2 | 2021-12-17 14:21:29 +0100 | [diff] [blame] | 556 | LOGP(DLGLOBAL, LOGL_ERROR, "no suitable local addr found for: " OSMO_SOCKADDR_STR_FMT "\n", |
| 557 | OSMO_SOCKADDR_STR_FMT_ARGS(sastr)); |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 558 | return -ENODEV; |
| 559 | } |
| 560 | |
| 561 | if (proto != IPPROTO_UDP || (flags & OSMO_SOCK_F_UDP_REUSEADDR)) { |
| 562 | rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR, |
| 563 | &on, sizeof(on)); |
| 564 | if (rc < 0) { |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 565 | int err = errno; |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 566 | _SOCKADDR_TO_STR(sastr, local); |
| 567 | LOGP(DLGLOBAL, LOGL_ERROR, |
Neels Hofmeyr | f3270f2 | 2021-12-17 14:21:29 +0100 | [diff] [blame] | 568 | "cannot setsockopt socket: " OSMO_SOCKADDR_STR_FMT ": %s\n", |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 569 | OSMO_SOCKADDR_STR_FMT_ARGS(sastr), strerror(err)); |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 570 | close(sfd); |
| 571 | return rc; |
| 572 | } |
| 573 | } |
| 574 | |
| 575 | if (bind(sfd, &local->u.sa, sizeof(struct osmo_sockaddr)) == -1) { |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 576 | int err = errno; |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 577 | _SOCKADDR_TO_STR(sastr, local); |
Neels Hofmeyr | f3270f2 | 2021-12-17 14:21:29 +0100 | [diff] [blame] | 578 | LOGP(DLGLOBAL, LOGL_ERROR, "unable to bind socket: " OSMO_SOCKADDR_STR_FMT ": %s\n", |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 579 | OSMO_SOCKADDR_STR_FMT_ARGS(sastr), strerror(err)); |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 580 | close(sfd); |
| 581 | return -1; |
| 582 | } |
| 583 | } |
| 584 | |
| 585 | /* Reached this point, if OSMO_SOCK_F_BIND then sfd is valid (>=0) or it |
| 586 | was already closed and func returned. If OSMO_SOCK_F_BIND is not |
| 587 | set, then sfd = -1 */ |
| 588 | |
| 589 | /* figure out remote side of socket */ |
| 590 | if (flags & OSMO_SOCK_F_CONNECT) { |
| 591 | if (sfd < 0) { |
| 592 | sfd = socket_helper_osa(remote, type, proto, flags); |
| 593 | if (sfd < 0) { |
| 594 | return sfd; |
| 595 | } |
| 596 | } |
| 597 | |
| 598 | rc = connect(sfd, &remote->u.sa, sizeof(struct osmo_sockaddr)); |
| 599 | if (rc != 0 && errno != EINPROGRESS) { |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 600 | int err = errno; |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 601 | _SOCKADDR_TO_STR(sastr, remote); |
Neels Hofmeyr | f3270f2 | 2021-12-17 14:21:29 +0100 | [diff] [blame] | 602 | LOGP(DLGLOBAL, LOGL_ERROR, "unable to connect socket: " OSMO_SOCKADDR_STR_FMT ": %s\n", |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 603 | OSMO_SOCKADDR_STR_FMT_ARGS(sastr), strerror(err)); |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 604 | close(sfd); |
| 605 | return rc; |
| 606 | } |
| 607 | } |
| 608 | |
| 609 | rc = osmo_sock_init_tail(sfd, type, flags); |
| 610 | if (rc < 0) { |
| 611 | close(sfd); |
| 612 | sfd = -1; |
| 613 | } |
| 614 | |
| 615 | return sfd; |
| 616 | } |
| 617 | |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 618 | #ifdef HAVE_LIBSCTP |
| 619 | |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 620 | /* Check whether there's an addrinfo item in the addrinfo set with an IPv4 or IPv6 option */ |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 621 | static void addrinfo_has_v4v6addr(const struct addrinfo **result, size_t result_count, bool *has_v4, bool *has_v6) |
| 622 | { |
| 623 | size_t host_idx; |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 624 | const struct addrinfo *rp; |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 625 | *has_v4 = false; |
| 626 | *has_v6 = false; |
| 627 | |
| 628 | for (host_idx = 0; host_idx < result_count; host_idx++) { |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 629 | for (rp = result[host_idx]; rp != NULL; rp = rp->ai_next) { |
| 630 | if (result[host_idx]->ai_family == AF_INET) |
| 631 | *has_v4 = true; |
| 632 | else if (result[host_idx]->ai_family == AF_INET6) |
| 633 | *has_v6 = true; |
| 634 | } |
| 635 | } |
| 636 | } |
| 637 | |
| 638 | /* Check whether there's an addrinfo item in the addrinfo set with only an IPv4 or IPv6 option */ |
| 639 | static void addrinfo_has_v4v6only_addr(const struct addrinfo **result, size_t result_count, bool *has_v4only, bool *has_v6only) |
| 640 | { |
| 641 | size_t host_idx; |
| 642 | const struct addrinfo *rp; |
| 643 | *has_v4only = false; |
| 644 | *has_v6only = false; |
| 645 | |
| 646 | for (host_idx = 0; host_idx < result_count; host_idx++) { |
| 647 | bool has_v4 = false; |
| 648 | bool has_v6 = false; |
| 649 | for (rp = result[host_idx]; rp != NULL; rp = rp->ai_next) { |
| 650 | if (rp->ai_family == AF_INET6) |
| 651 | has_v6 = true; |
| 652 | else |
| 653 | has_v4 = true; |
| 654 | } |
| 655 | if (has_v4 && !has_v6) |
| 656 | *has_v4only = true; |
| 657 | else if (has_v6 && !has_v4) |
| 658 | *has_v6only = true; |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 659 | } |
| 660 | } |
| 661 | |
Pau Espin Pedrol | 4f463c5 | 2020-08-28 14:32:02 +0200 | [diff] [blame] | 662 | /* Check whether there's an IPv6 with IN6ADDR_ANY_INIT ("::") */ |
| 663 | static bool addrinfo_has_in6addr_any(const struct addrinfo **result, size_t result_count) |
| 664 | { |
| 665 | size_t host_idx; |
| 666 | struct in6_addr in6addr_any = IN6ADDR_ANY_INIT; |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 667 | const struct addrinfo *rp; |
Pau Espin Pedrol | 4f463c5 | 2020-08-28 14:32:02 +0200 | [diff] [blame] | 668 | |
| 669 | for (host_idx = 0; host_idx < result_count; host_idx++) { |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 670 | for (rp = result[host_idx]; rp != NULL; rp = rp->ai_next) { |
| 671 | if (rp->ai_family != AF_INET6) |
| 672 | continue; |
| 673 | if (memcmp(&((struct sockaddr_in6 *)rp->ai_addr)->sin6_addr, |
| 674 | &in6addr_any, sizeof(in6addr_any)) == 0) |
| 675 | return true; |
| 676 | } |
Pau Espin Pedrol | 4f463c5 | 2020-08-28 14:32:02 +0200 | [diff] [blame] | 677 | } |
| 678 | return false; |
| 679 | } |
| 680 | |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 681 | static int socket_helper_multiaddr(uint16_t family, uint16_t type, uint8_t proto, unsigned int flags) |
| 682 | { |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 683 | int sfd, rc; |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 684 | |
| 685 | sfd = socket(family, type, proto); |
| 686 | if (sfd == -1) { |
| 687 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 688 | "Unable to create socket: %s\n", strerror(errno)); |
| 689 | return sfd; |
| 690 | } |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 691 | |
| 692 | rc = socket_helper_tail(sfd, flags); |
| 693 | if (rc < 0) |
| 694 | return rc; |
| 695 | |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 696 | return sfd; |
| 697 | } |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 698 | |
| 699 | /* Build array of addresses taking first addrinfo result of the requested family |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 700 | * for each host in addrs_buf. */ |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 701 | static int addrinfo_to_sockaddr(uint16_t family, const struct addrinfo **result, |
Harald Welte | 0b08d51 | 2022-01-09 12:03:12 +0100 | [diff] [blame] | 702 | const char **hosts, unsigned int host_cont, |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 703 | uint8_t *addrs_buf, size_t addrs_buf_len) { |
| 704 | size_t host_idx, offset = 0; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 705 | const struct addrinfo *rp; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 706 | |
| 707 | for (host_idx = 0; host_idx < host_cont; host_idx++) { |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 708 | /* Addresses are ordered based on RFC 3484, see man getaddrinfo */ |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 709 | for (rp = result[host_idx]; rp != NULL; rp = rp->ai_next) { |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 710 | if (family == AF_UNSPEC || rp->ai_family == family) |
| 711 | break; |
| 712 | } |
| 713 | if (!rp && family == AF_INET6) { |
| 714 | /* See if we can find an AF_INET addr for the AF_INET6 socket instead: */ |
| 715 | for (rp = result[host_idx]; rp != NULL; rp = rp->ai_next) { |
| 716 | if (rp->ai_family == AF_INET) |
| 717 | break; |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 718 | } |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 719 | } |
| 720 | if (!rp) { /* No addr could be bound for this host! */ |
| 721 | LOGP(DLGLOBAL, LOGL_ERROR, "No suitable remote address found for host: %s\n", |
| 722 | hosts[host_idx]); |
| 723 | return -ENODEV; |
| 724 | } |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 725 | if (offset + rp->ai_addrlen > addrs_buf_len) { |
| 726 | LOGP(DLGLOBAL, LOGL_ERROR, "Output buffer to small: %zu\n", |
| 727 | addrs_buf_len); |
| 728 | return -ENOSPC; |
| 729 | } |
| 730 | memcpy(addrs_buf + offset, rp->ai_addr, rp->ai_addrlen); |
| 731 | offset += rp->ai_addrlen; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 732 | } |
| 733 | return 0; |
| 734 | } |
| 735 | |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 736 | static int setsockopt_sctp_auth_supported(int fd, uint32_t val) |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 737 | { |
| 738 | #ifdef SCTP_AUTH_SUPPORTED |
| 739 | struct sctp_assoc_value assoc_val = { |
| 740 | .assoc_id = SCTP_FUTURE_ASSOC, |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 741 | .assoc_value = val, |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 742 | }; |
| 743 | return setsockopt(fd, IPPROTO_SCTP, SCTP_AUTH_SUPPORTED, &assoc_val, sizeof(assoc_val)); |
| 744 | #else |
| 745 | #pragma message "setsockopt(SCTP_AUTH_SUPPORTED) not supported! some SCTP features may not be available!" |
| 746 | LOGP(DLGLOBAL, LOGL_NOTICE, "Built without support for setsockopt(SCTP_AUTH_SUPPORTED), skipping\n"); |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 747 | return -ENOTSUP; |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 748 | #endif |
| 749 | } |
| 750 | |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 751 | static int setsockopt_sctp_asconf_supported(int fd, uint32_t val) |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 752 | { |
| 753 | #ifdef SCTP_ASCONF_SUPPORTED |
| 754 | struct sctp_assoc_value assoc_val = { |
| 755 | .assoc_id = SCTP_FUTURE_ASSOC, |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 756 | .assoc_value = val, |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 757 | }; |
| 758 | return setsockopt(fd, IPPROTO_SCTP, SCTP_ASCONF_SUPPORTED, &assoc_val, sizeof(assoc_val)); |
| 759 | #else |
| 760 | #pragma message "setsockopt(SCTP_ASCONF_SUPPORTED) not supported! some SCTP features may not be available!" |
| 761 | LOGP(DLGLOBAL, LOGL_NOTICE, "Built without support for setsockopt(SCTP_ASCONF_SUPPORTED), skipping\n"); |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 762 | return -ENOTSUP; |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 763 | #endif |
| 764 | } |
| 765 | |
Pau Espin Pedrol | a45b0be | 2023-09-08 13:42:50 +0200 | [diff] [blame] | 766 | static int setsockopt_sctp_initmsg(int fd, const struct osmo_sock_init2_multiaddr_pars *pars) |
| 767 | { |
| 768 | if (!pars->sctp.sockopt_initmsg.num_ostreams_present && |
| 769 | !pars->sctp.sockopt_initmsg.max_instreams_present && |
| 770 | !pars->sctp.sockopt_initmsg.max_attempts_present && |
| 771 | !pars->sctp.sockopt_initmsg.max_init_timeo_present) |
| 772 | return 0; /* nothing to set/do */ |
| 773 | |
| 774 | #ifdef SCTP_INITMSG |
| 775 | struct sctp_initmsg si = {0}; |
| 776 | socklen_t si_len = sizeof(si); |
| 777 | int rc; |
| 778 | |
| 779 | /* If at least one field not present, obtain current value from kernel: */ |
| 780 | if (!pars->sctp.sockopt_initmsg.num_ostreams_present || |
| 781 | !pars->sctp.sockopt_initmsg.max_instreams_present || |
| 782 | !pars->sctp.sockopt_initmsg.max_attempts_present || |
| 783 | !pars->sctp.sockopt_initmsg.max_init_timeo_present) { |
| 784 | rc = getsockopt(fd, IPPROTO_SCTP, SCTP_INITMSG, &si, &si_len); |
| 785 | if (rc < 0) |
| 786 | return rc; |
| 787 | } |
| 788 | |
| 789 | if (pars->sctp.sockopt_initmsg.num_ostreams_present) |
| 790 | si.sinit_num_ostreams = pars->sctp.sockopt_initmsg.num_ostreams_value; |
| 791 | if (pars->sctp.sockopt_initmsg.max_instreams_present) |
| 792 | si.sinit_max_instreams = pars->sctp.sockopt_initmsg.max_instreams_value; |
| 793 | if (pars->sctp.sockopt_initmsg.max_attempts_present) |
| 794 | si.sinit_max_attempts = pars->sctp.sockopt_initmsg.max_attempts_value; |
| 795 | if (pars->sctp.sockopt_initmsg.max_init_timeo_present) |
| 796 | si.sinit_max_init_timeo = pars->sctp.sockopt_initmsg.max_init_timeo_value; |
| 797 | |
| 798 | return setsockopt(fd, IPPROTO_SCTP, SCTP_INITMSG, &si, sizeof(si)); |
| 799 | #else |
| 800 | #pragma message "setsockopt(SCTP_INITMSG) not supported! some SCTP features may not be available!" |
| 801 | LOGP(DLGLOBAL, LOGL_NOTICE, "Built without support for setsockopt(SCTP_INITMSG), skipping\n"); |
| 802 | return -ENOTSUP |
| 803 | #endif |
| 804 | } |
| 805 | |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 806 | /*! Initialize a socket (including bind and/or connect) with multiple local or remote addresses. |
| 807 | * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC |
| 808 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 809 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 810 | * \param[in] local_hosts array of char pointers (strings), each containing local host name or IP address in string form |
| 811 | * \param[in] local_hosts_cnt length of local_hosts (in items) |
| 812 | * \param[in] local_port local port number in host byte order |
| 813 | * \param[in] remote_host array of char pointers (strings), each containing remote host name or IP address in string form |
| 814 | * \param[in] remote_hosts_cnt length of remote_hosts (in items) |
| 815 | * \param[in] remote_port remote port number in host byte order |
| 816 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
| 817 | * \returns socket file descriptor on success; negative on error |
| 818 | * |
| 819 | * This function is similar to \ref osmo_sock_init2(), but can be passed an |
| 820 | * array of local or remote addresses for protocols supporting multiple |
| 821 | * addresses per socket, like SCTP (currently only one supported). This function |
| 822 | * should not be used by protocols not supporting this kind of features, but |
| 823 | * rather \ref osmo_sock_init2() should be used instead. |
| 824 | * See \ref osmo_sock_init2() for more information on flags and general behavior. |
| 825 | */ |
| 826 | int osmo_sock_init2_multiaddr(uint16_t family, uint16_t type, uint8_t proto, |
| 827 | const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port, |
| 828 | const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, |
| 829 | unsigned int flags) |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 830 | { |
| 831 | return osmo_sock_init2_multiaddr2(family, type, proto, local_hosts, local_hosts_cnt, local_port, |
| 832 | remote_hosts, remote_hosts_cnt, remote_port, flags, NULL); |
| 833 | } |
| 834 | |
| 835 | /*! Initialize a socket (including bind and/or connect) with multiple local or remote addresses. |
| 836 | * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC |
| 837 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 838 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 839 | * \param[in] local_hosts array of char pointers (strings), each containing local host name or IP address in string form |
| 840 | * \param[in] local_hosts_cnt length of local_hosts (in items) |
| 841 | * \param[in] local_port local port number in host byte order |
| 842 | * \param[in] remote_host array of char pointers (strings), each containing remote host name or IP address in string form |
| 843 | * \param[in] remote_hosts_cnt length of remote_hosts (in items) |
| 844 | * \param[in] remote_port remote port number in host byte order |
| 845 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
| 846 | * \param[in] pars Extra parameters for multi-address specific protocols, such as SCTP. Can be NULL. |
| 847 | * \returns socket file descriptor on success; negative on error |
| 848 | * |
| 849 | * This function is similar to \ref osmo_sock_init2(), but can be passed an |
| 850 | * array of local or remote addresses for protocols supporting multiple |
| 851 | * addresses per socket, like SCTP (currently only one supported). This function |
| 852 | * should not be used by protocols not supporting this kind of features, but |
| 853 | * rather \ref osmo_sock_init2() should be used instead. |
| 854 | * See \ref osmo_sock_init2() for more information on flags and general behavior. |
| 855 | * |
| 856 | * pars: If "pars" parameter is passed to the function, sctp.version shall be set to 0. |
| 857 | */ |
| 858 | int osmo_sock_init2_multiaddr2(uint16_t family, uint16_t type, uint8_t proto, |
| 859 | const char **local_hosts, size_t local_hosts_cnt, uint16_t local_port, |
| 860 | const char **remote_hosts, size_t remote_hosts_cnt, uint16_t remote_port, |
| 861 | unsigned int flags, struct osmo_sock_init2_multiaddr_pars *pars) |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 862 | |
| 863 | { |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 864 | struct addrinfo *res_loc[OSMO_SOCK_MAX_ADDRS], *res_rem[OSMO_SOCK_MAX_ADDRS]; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 865 | int sfd = -1, rc, on = 1; |
Harald Welte | 0b08d51 | 2022-01-09 12:03:12 +0100 | [diff] [blame] | 866 | unsigned int i; |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 867 | bool loc_has_v4addr = false, loc_has_v6addr = false; |
| 868 | bool rem_has_v4addr = false, rem_has_v6addr = false; |
| 869 | bool loc_has_v4only_addr, rem_has_v4only_addr; |
| 870 | bool loc_has_v6only_addr, rem_has_v6only_addr; |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 871 | struct sockaddr_in6 addrs_buf[OSMO_SOCK_MAX_ADDRS]; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 872 | char strbuf[512]; |
| 873 | |
| 874 | /* TODO: So far this function is only aimed for SCTP, but could be |
| 875 | reused in the future for other protocols with multi-addr support */ |
| 876 | if (proto != IPPROTO_SCTP) |
| 877 | return -ENOTSUP; |
| 878 | |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 879 | if (pars && pars->sctp.version != 0) |
| 880 | return -EINVAL; |
| 881 | |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 882 | if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) == 0) { |
| 883 | LOGP(DLGLOBAL, LOGL_ERROR, "invalid: you have to specify either " |
| 884 | "BIND or CONNECT flags\n"); |
| 885 | return -EINVAL; |
| 886 | } |
| 887 | |
| 888 | if (((flags & OSMO_SOCK_F_BIND) && !local_hosts_cnt) || |
| 889 | ((flags & OSMO_SOCK_F_CONNECT) && !remote_hosts_cnt) || |
| 890 | local_hosts_cnt > OSMO_SOCK_MAX_ADDRS || |
| 891 | remote_hosts_cnt > OSMO_SOCK_MAX_ADDRS) |
| 892 | return -EINVAL; |
| 893 | |
| 894 | /* figure out local side of socket */ |
| 895 | if (flags & OSMO_SOCK_F_BIND) { |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 896 | rc = addrinfo_helper_multi(res_loc, family, type, proto, local_hosts, |
| 897 | local_hosts_cnt, local_port, true); |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 898 | if (rc < 0) |
| 899 | return -EINVAL; |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 900 | /* Figure out if there's any IPv4 or IPv6 entry in the result set */ |
| 901 | addrinfo_has_v4v6addr((const struct addrinfo **)res_loc, local_hosts_cnt, |
| 902 | &loc_has_v4addr, &loc_has_v6addr); |
| 903 | /* Figure out if there's any IPv4-only or IPv6-only addr in the result set */ |
| 904 | addrinfo_has_v4v6only_addr((const struct addrinfo **)res_loc, local_hosts_cnt, |
| 905 | &loc_has_v4only_addr, &loc_has_v6only_addr); |
| 906 | if (family == AF_INET && loc_has_v6only_addr) { |
| 907 | LOGP(DLGLOBAL, LOGL_ERROR, "Cannot bind an IPv6 address to an AF_INET socket\n"); |
| 908 | rc = -EINVAL; |
Pau Espin Pedrol | d2e8f67 | 2023-12-08 20:07:38 +0100 | [diff] [blame] | 909 | goto ret_freeaddrinfo_loc; |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 910 | } |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 911 | } |
| 912 | /* figure out remote side of socket */ |
| 913 | if (flags & OSMO_SOCK_F_CONNECT) { |
| 914 | rc = addrinfo_helper_multi(res_rem, family, type, proto, remote_hosts, |
| 915 | remote_hosts_cnt, remote_port, false); |
Pau Espin Pedrol | 4541cf2 | 2020-08-25 11:22:09 +0200 | [diff] [blame] | 916 | if (rc < 0) { |
| 917 | rc = -EINVAL; |
| 918 | goto ret_freeaddrinfo_loc; |
| 919 | } |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 920 | /* Figure out if there's any IPv4 or IPv6 entry in the result set */ |
| 921 | addrinfo_has_v4v6addr((const struct addrinfo **)res_rem, remote_hosts_cnt, |
| 922 | &rem_has_v4addr, &rem_has_v6addr); |
| 923 | /* Figure out if there's any IPv4-only or IPv6-only addr in the result set */ |
| 924 | addrinfo_has_v4v6only_addr((const struct addrinfo **)res_rem, remote_hosts_cnt, |
| 925 | &rem_has_v4only_addr, &rem_has_v6only_addr); |
| 926 | if (family == AF_INET && rem_has_v6only_addr) { |
| 927 | LOGP(DLGLOBAL, LOGL_ERROR, "Cannot connect to an IPv6 address in an AF_INET socket\n"); |
| 928 | rc = -EINVAL; |
| 929 | goto ret_freeaddrinfo; |
| 930 | } |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 931 | } |
| 932 | |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 933 | /* Find out the socket family now if not established by caller: |
| 934 | * Both are checked here through "or" here to account for "bind flag set, |
| 935 | * connect flag not set" and viceversa. */ |
| 936 | if (family == AF_UNSPEC) { |
| 937 | if (!loc_has_v6addr && !rem_has_v6addr) |
| 938 | family = AF_INET; |
| 939 | else |
| 940 | family = AF_INET6; |
| 941 | } |
| 942 | |
| 943 | /* if both sets are used, make sure there's at least 1 address of the |
| 944 | * same type on each set so that SCTP INIT/INIT-ACK can work. */ |
| 945 | if (family == AF_INET6 && ((flags & OSMO_SOCK_F_BIND) && (flags & OSMO_SOCK_F_CONNECT)) && |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 946 | (loc_has_v4addr != rem_has_v4addr || loc_has_v6addr != rem_has_v6addr)) { |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 947 | if (!addrinfo_has_in6addr_any((const struct addrinfo **)res_loc, local_hosts_cnt)) { |
| 948 | LOGP(DLGLOBAL, LOGL_ERROR, "Invalid v4 vs v6 in local vs remote addresses: " |
| 949 | "local:%s%s remote:%s%s\n", |
| 950 | loc_has_v4addr ? " v4" : "", loc_has_v6addr ? " v6" : "", |
| 951 | rem_has_v4addr ? " v4" : "", rem_has_v6addr ? " v6" : ""); |
| 952 | rc = -EINVAL; |
| 953 | goto ret_freeaddrinfo; |
| 954 | } |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 955 | } |
| 956 | |
Pau Espin Pedrol | 1c797fc | 2023-12-05 18:28:28 +0100 | [diff] [blame] | 957 | sfd = socket_helper_multiaddr(family, type, proto, flags); |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 958 | if (sfd < 0) { |
| 959 | rc = sfd; |
| 960 | goto ret_freeaddrinfo; |
| 961 | } |
| 962 | |
Pau Espin Pedrol | cb5cec2 | 2023-12-05 19:57:03 +0100 | [diff] [blame] | 963 | if (pars) { |
| 964 | if (pars->sctp.sockopt_auth_supported.set) { |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 965 | /* RFC 5061 4.2.7: ASCONF also requires AUTH feature. */ |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 966 | rc = setsockopt_sctp_auth_supported(sfd, pars->sctp.sockopt_auth_supported.value); |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 967 | if (rc < 0) { |
| 968 | int err = errno; |
| 969 | multiaddr_snprintf(strbuf, sizeof(strbuf), local_hosts, local_hosts_cnt); |
| 970 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 971 | "cannot setsockopt(SCTP_AUTH_SUPPORTED) socket: %s:%u: %s\n", |
| 972 | strbuf, local_port, strerror(err)); |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 973 | if (pars->sctp.sockopt_auth_supported.abort_on_failure) |
| 974 | goto ret_close; |
Pau Espin Pedrol | b437f80 | 2023-08-28 13:56:25 +0200 | [diff] [blame] | 975 | /* do not fail, some features such as Peer Primary Address won't be available |
| 976 | * unless configured system-wide through sysctl */ |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 977 | } |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 978 | } |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 979 | |
Pau Espin Pedrol | cb5cec2 | 2023-12-05 19:57:03 +0100 | [diff] [blame] | 980 | if (pars->sctp.sockopt_asconf_supported.set) { |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 981 | rc = setsockopt_sctp_asconf_supported(sfd, pars->sctp.sockopt_asconf_supported.value); |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 982 | if (rc < 0) { |
| 983 | int err = errno; |
| 984 | multiaddr_snprintf(strbuf, sizeof(strbuf), local_hosts, local_hosts_cnt); |
| 985 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 986 | "cannot setsockopt(SCTP_ASCONF_SUPPORTED) socket: %s:%u: %s\n", |
| 987 | strbuf, local_port, strerror(err)); |
Pau Espin Pedrol | 658c509 | 2023-09-08 13:02:14 +0200 | [diff] [blame] | 988 | if (pars->sctp.sockopt_asconf_supported.abort_on_failure) |
| 989 | goto ret_close; |
Pau Espin Pedrol | b437f80 | 2023-08-28 13:56:25 +0200 | [diff] [blame] | 990 | /* do not fail, some features such as Peer Primary Address won't be available |
| 991 | * unless configured system-wide through sysctl */ |
Pau Espin Pedrol | e83227f | 2023-08-08 19:32:56 +0200 | [diff] [blame] | 992 | } |
| 993 | } |
| 994 | |
Pau Espin Pedrol | cb5cec2 | 2023-12-05 19:57:03 +0100 | [diff] [blame] | 995 | if (pars->sctp.sockopt_initmsg.set) { |
Pau Espin Pedrol | a45b0be | 2023-09-08 13:42:50 +0200 | [diff] [blame] | 996 | rc = setsockopt_sctp_initmsg(sfd, pars); |
| 997 | if (rc < 0) { |
| 998 | int err = errno; |
| 999 | multiaddr_snprintf(strbuf, sizeof(strbuf), local_hosts, local_hosts_cnt); |
| 1000 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 1001 | "cannot setsockopt(SCTP_INITMSG) socket: %s:%u: %s\n", |
| 1002 | strbuf, local_port, strerror(err)); |
| 1003 | if (pars->sctp.sockopt_initmsg.abort_on_failure) |
| 1004 | goto ret_close; |
| 1005 | /* do not fail, some parameters will be left as the global default */ |
| 1006 | } |
| 1007 | } |
Pau Espin Pedrol | cb5cec2 | 2023-12-05 19:57:03 +0100 | [diff] [blame] | 1008 | } |
| 1009 | |
| 1010 | if (flags & OSMO_SOCK_F_BIND) { |
| 1011 | /* Since so far we only allow IPPROTO_SCTP in this function, |
| 1012 | no need to check below for "proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR" */ |
| 1013 | rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR, |
| 1014 | &on, sizeof(on)); |
| 1015 | if (rc < 0) { |
| 1016 | int err = errno; |
| 1017 | multiaddr_snprintf(strbuf, sizeof(strbuf), local_hosts, local_hosts_cnt); |
| 1018 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 1019 | "cannot setsockopt socket:" |
| 1020 | " %s:%u: %s\n", |
| 1021 | strbuf, local_port, |
| 1022 | strerror(err)); |
| 1023 | goto ret_close; |
| 1024 | } |
Pau Espin Pedrol | a45b0be | 2023-09-08 13:42:50 +0200 | [diff] [blame] | 1025 | |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 1026 | /* Build array of addresses taking first entry for each host. |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1027 | TODO: Ideally we should use backtracking storing last used |
| 1028 | indexes and trying next combination if connect() fails .*/ |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 1029 | /* We could alternatively use v4v6 mapped addresses and call sctp_bindx once with an array od sockaddr_in6 */ |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 1030 | rc = addrinfo_to_sockaddr(family, (const struct addrinfo **)res_loc, |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 1031 | local_hosts, local_hosts_cnt, |
| 1032 | (uint8_t*)addrs_buf, sizeof(addrs_buf)); |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1033 | if (rc < 0) { |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 1034 | rc = -ENODEV; |
| 1035 | goto ret_close; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1036 | } |
| 1037 | |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 1038 | rc = sctp_bindx(sfd, (struct sockaddr *)addrs_buf, local_hosts_cnt, SCTP_BINDX_ADD_ADDR); |
| 1039 | if (rc == -1) { |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 1040 | int err = errno; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1041 | multiaddr_snprintf(strbuf, sizeof(strbuf), local_hosts, local_hosts_cnt); |
| 1042 | LOGP(DLGLOBAL, LOGL_NOTICE, "unable to bind socket: %s:%u: %s\n", |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 1043 | strbuf, local_port, strerror(err)); |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 1044 | rc = -ENODEV; |
| 1045 | goto ret_close; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1046 | } |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1047 | } |
| 1048 | |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1049 | if (flags & OSMO_SOCK_F_CONNECT) { |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1050 | /* Build array of addresses taking first of same family for each host. |
| 1051 | TODO: Ideally we should use backtracking storing last used |
| 1052 | indexes and trying next combination if connect() fails .*/ |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 1053 | rc = addrinfo_to_sockaddr(family, (const struct addrinfo **)res_rem, |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 1054 | remote_hosts, remote_hosts_cnt, |
| 1055 | (uint8_t*)addrs_buf, sizeof(addrs_buf)); |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1056 | if (rc < 0) { |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 1057 | rc = -ENODEV; |
| 1058 | goto ret_close; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1059 | } |
| 1060 | |
Pau Espin Pedrol | cd13331 | 2020-08-19 17:25:04 +0200 | [diff] [blame] | 1061 | rc = sctp_connectx(sfd, (struct sockaddr *)addrs_buf, remote_hosts_cnt, NULL); |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1062 | if (rc != 0 && errno != EINPROGRESS) { |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 1063 | int err = errno; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1064 | multiaddr_snprintf(strbuf, sizeof(strbuf), remote_hosts, remote_hosts_cnt); |
| 1065 | LOGP(DLGLOBAL, LOGL_ERROR, "unable to connect socket: %s:%u: %s\n", |
Pau Espin Pedrol | c3b772b | 2023-07-06 12:25:26 +0200 | [diff] [blame] | 1066 | strbuf, remote_port, strerror(err)); |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 1067 | rc = -ENODEV; |
| 1068 | goto ret_close; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1069 | } |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1070 | } |
| 1071 | |
| 1072 | rc = osmo_sock_init_tail(sfd, type, flags); |
| 1073 | if (rc < 0) { |
| 1074 | close(sfd); |
| 1075 | sfd = -1; |
| 1076 | } |
| 1077 | |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 1078 | rc = sfd; |
| 1079 | goto ret_freeaddrinfo; |
| 1080 | |
| 1081 | ret_close: |
| 1082 | if (sfd >= 0) |
| 1083 | close(sfd); |
| 1084 | ret_freeaddrinfo: |
Pau Espin Pedrol | 4541cf2 | 2020-08-25 11:22:09 +0200 | [diff] [blame] | 1085 | if (flags & OSMO_SOCK_F_CONNECT) { |
| 1086 | for (i = 0; i < remote_hosts_cnt; i++) |
| 1087 | freeaddrinfo(res_rem[i]); |
| 1088 | } |
| 1089 | ret_freeaddrinfo_loc: |
| 1090 | if (flags & OSMO_SOCK_F_BIND) { |
| 1091 | for (i = 0; i < local_hosts_cnt; i++) |
| 1092 | freeaddrinfo(res_loc[i]); |
| 1093 | } |
Pau Espin Pedrol | 796c651 | 2020-08-19 12:03:25 +0200 | [diff] [blame] | 1094 | return rc; |
Pau Espin Pedrol | 3f464fc | 2019-10-10 17:38:35 +0200 | [diff] [blame] | 1095 | } |
| 1096 | #endif /* HAVE_LIBSCTP */ |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 1097 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1098 | /*! Initialize a socket (including bind/connect) |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 1099 | * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC |
| 1100 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 1101 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 1102 | * \param[in] host remote host name or IP address in string form |
| 1103 | * \param[in] port remote port number in host byte order |
| 1104 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 1105 | * \returns socket file descriptor on success; negative on error |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 1106 | * |
| 1107 | * This function creates a new socket of the designated \a family, \a |
| 1108 | * type and \a proto and optionally binds or connects it, depending on |
| 1109 | * the value of \a flags parameter. |
| 1110 | */ |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1111 | int osmo_sock_init(uint16_t family, uint16_t type, uint8_t proto, |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 1112 | const char *host, uint16_t port, unsigned int flags) |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1113 | { |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 1114 | struct addrinfo *result, *rp; |
Pau Espin Pedrol | 6fe865d | 2021-07-15 13:08:08 +0200 | [diff] [blame] | 1115 | int sfd = -1; /* initialize to avoid uninitialized false warnings on some gcc versions (11.1.0) */ |
| 1116 | int on = 1; |
| 1117 | int rc; |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1118 | |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 1119 | if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) == |
Neels Hofmeyr | f0f07d9 | 2016-08-22 13:34:23 +0200 | [diff] [blame] | 1120 | (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) { |
Philipp Maier | 6f0f560 | 2017-02-09 14:09:06 +0100 | [diff] [blame] | 1121 | LOGP(DLGLOBAL, LOGL_ERROR, "invalid: both bind and connect flags set:" |
Neels Hofmeyr | b7f191f | 2016-08-29 11:22:03 +0200 | [diff] [blame] | 1122 | " %s:%u\n", host, port); |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 1123 | return -EINVAL; |
Neels Hofmeyr | f0f07d9 | 2016-08-22 13:34:23 +0200 | [diff] [blame] | 1124 | } |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 1125 | |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 1126 | result = addrinfo_helper(family, type, proto, host, port, flags & OSMO_SOCK_F_BIND); |
Pau Espin Pedrol | ba828c3 | 2020-08-20 18:28:10 +0200 | [diff] [blame] | 1127 | if (!result) |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1128 | return -EINVAL; |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1129 | |
| 1130 | for (rp = result; rp != NULL; rp = rp->ai_next) { |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 1131 | sfd = socket_helper(rp, flags); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1132 | if (sfd == -1) |
| 1133 | continue; |
Harald Welte | dda70fc | 2017-04-08 20:52:33 +0200 | [diff] [blame] | 1134 | |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 1135 | if (flags & OSMO_SOCK_F_CONNECT) { |
| 1136 | rc = connect(sfd, rp->ai_addr, rp->ai_addrlen); |
Pau Espin Pedrol | 3a32147 | 2018-04-05 17:49:40 +0200 | [diff] [blame] | 1137 | if (rc != 0 && errno != EINPROGRESS) { |
| 1138 | close(sfd); |
| 1139 | continue; |
| 1140 | } |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1141 | } else { |
Philipp Maier | 73196e7 | 2018-08-23 20:11:50 +0200 | [diff] [blame] | 1142 | if (proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR) { |
Philipp Maier | 99f706d | 2018-08-01 12:40:36 +0200 | [diff] [blame] | 1143 | rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR, |
| 1144 | &on, sizeof(on)); |
| 1145 | if (rc < 0) { |
| 1146 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 1147 | "cannot setsockopt socket:" |
| 1148 | " %s:%u: %s\n", |
| 1149 | host, port, strerror(errno)); |
| 1150 | close(sfd); |
| 1151 | continue; |
| 1152 | } |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 1153 | } |
Pau Espin Pedrol | 3a32147 | 2018-04-05 17:49:40 +0200 | [diff] [blame] | 1154 | if (bind(sfd, rp->ai_addr, rp->ai_addrlen) == -1) { |
| 1155 | LOGP(DLGLOBAL, LOGL_ERROR, "unable to bind socket:" |
| 1156 | "%s:%u: %s\n", |
| 1157 | host, port, strerror(errno)); |
| 1158 | close(sfd); |
| 1159 | continue; |
| 1160 | } |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1161 | } |
Pau Espin Pedrol | 3a32147 | 2018-04-05 17:49:40 +0200 | [diff] [blame] | 1162 | break; |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1163 | } |
| 1164 | freeaddrinfo(result); |
| 1165 | |
| 1166 | if (rp == NULL) { |
Pau Espin Pedrol | 3a32147 | 2018-04-05 17:49:40 +0200 | [diff] [blame] | 1167 | LOGP(DLGLOBAL, LOGL_ERROR, "no suitable addr found for: %s:%u\n", |
| 1168 | host, port); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1169 | return -ENODEV; |
| 1170 | } |
Harald Welte | 68b1574 | 2011-05-22 21:47:29 +0200 | [diff] [blame] | 1171 | |
Philipp Maier | 73196e7 | 2018-08-23 20:11:50 +0200 | [diff] [blame] | 1172 | if (proto != IPPROTO_UDP || flags & OSMO_SOCK_F_UDP_REUSEADDR) { |
Philipp Maier | 99f706d | 2018-08-01 12:40:36 +0200 | [diff] [blame] | 1173 | rc = setsockopt(sfd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)); |
| 1174 | if (rc < 0) { |
| 1175 | LOGP(DLGLOBAL, LOGL_ERROR, |
| 1176 | "cannot setsockopt socket: %s:%u: %s\n", host, |
| 1177 | port, strerror(errno)); |
| 1178 | close(sfd); |
| 1179 | sfd = -1; |
| 1180 | } |
Philipp Maier | 0659c5d | 2018-08-01 12:43:08 +0200 | [diff] [blame] | 1181 | } |
Harald Welte | 68b1574 | 2011-05-22 21:47:29 +0200 | [diff] [blame] | 1182 | |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 1183 | rc = osmo_sock_init_tail(sfd, type, flags); |
| 1184 | if (rc < 0) { |
| 1185 | close(sfd); |
| 1186 | sfd = -1; |
Harald Welte | 68b1574 | 2011-05-22 21:47:29 +0200 | [diff] [blame] | 1187 | } |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 1188 | |
Harald Welte | 68b1574 | 2011-05-22 21:47:29 +0200 | [diff] [blame] | 1189 | return sfd; |
| 1190 | } |
| 1191 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1192 | /*! fill \ref osmo_fd for a give sfd |
Max | 862ba65 | 2014-10-13 14:54:25 +0200 | [diff] [blame] | 1193 | * \param[out] ofd file descriptor (will be filled in) |
| 1194 | * \param[in] sfd socket file descriptor |
Harald Welte | 24980ba | 2021-04-23 14:07:18 +0200 | [diff] [blame] | 1195 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 1196 | * \returns socket fd on success; negative on error |
Max | 862ba65 | 2014-10-13 14:54:25 +0200 | [diff] [blame] | 1197 | * |
| 1198 | * This function fills the \a ofd structure. |
| 1199 | */ |
Harald Welte | 24980ba | 2021-04-23 14:07:18 +0200 | [diff] [blame] | 1200 | static inline int osmo_fd_init_ofd(struct osmo_fd *ofd, int sfd, unsigned int flags) |
Max | 862ba65 | 2014-10-13 14:54:25 +0200 | [diff] [blame] | 1201 | { |
| 1202 | int rc; |
| 1203 | |
| 1204 | if (sfd < 0) |
| 1205 | return sfd; |
| 1206 | |
| 1207 | ofd->fd = sfd; |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 1208 | ofd->when = OSMO_FD_READ; |
Max | 862ba65 | 2014-10-13 14:54:25 +0200 | [diff] [blame] | 1209 | |
Harald Welte | 24980ba | 2021-04-23 14:07:18 +0200 | [diff] [blame] | 1210 | /* if we're doing a non-blocking connect, the completion will be signaled |
| 1211 | * by marking the fd as WRITE-able. So in this exceptional case, we're |
| 1212 | * also interested in when the socket becomes write-able */ |
| 1213 | if ((flags & (OSMO_SOCK_F_CONNECT|OSMO_SOCK_F_NONBLOCK)) == |
| 1214 | (OSMO_SOCK_F_CONNECT|OSMO_SOCK_F_NONBLOCK)) { |
| 1215 | ofd->when |= OSMO_FD_WRITE; |
| 1216 | } |
| 1217 | |
Max | 862ba65 | 2014-10-13 14:54:25 +0200 | [diff] [blame] | 1218 | rc = osmo_fd_register(ofd); |
| 1219 | if (rc < 0) { |
| 1220 | close(sfd); |
| 1221 | return rc; |
| 1222 | } |
| 1223 | |
| 1224 | return sfd; |
| 1225 | } |
| 1226 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1227 | /*! Initialize a socket and fill \ref osmo_fd |
Katerina Barone-Adesi | c28c6a0 | 2013-02-15 13:27:59 +0100 | [diff] [blame] | 1228 | * \param[out] ofd file descriptor (will be filled in) |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 1229 | * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC |
| 1230 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 1231 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 1232 | * \param[in] host remote host name or IP address in string form |
| 1233 | * \param[in] port remote port number in host byte order |
| 1234 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 1235 | * \returns socket fd on success; negative on error |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 1236 | * |
| 1237 | * This function creates (and optionall binds/connects) a socket using |
| 1238 | * \ref osmo_sock_init, but also fills the \a ofd structure. |
| 1239 | */ |
Harald Welte | 68b1574 | 2011-05-22 21:47:29 +0200 | [diff] [blame] | 1240 | int osmo_sock_init_ofd(struct osmo_fd *ofd, int family, int type, int proto, |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 1241 | const char *host, uint16_t port, unsigned int flags) |
Harald Welte | 68b1574 | 2011-05-22 21:47:29 +0200 | [diff] [blame] | 1242 | { |
Harald Welte | 24980ba | 2021-04-23 14:07:18 +0200 | [diff] [blame] | 1243 | return osmo_fd_init_ofd(ofd, osmo_sock_init(family, type, proto, host, port, flags), flags); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1244 | } |
| 1245 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1246 | /*! Initialize a socket and fill \ref osmo_fd |
Pau Espin Pedrol | 75989e6 | 2017-05-26 12:39:53 +0200 | [diff] [blame] | 1247 | * \param[out] ofd file descriptor (will be filled in) |
| 1248 | * \param[in] family Address Family like AF_INET, AF_INET6, AF_UNSPEC |
| 1249 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 1250 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 1251 | * \param[in] local_host local host name or IP address in string form |
| 1252 | * \param[in] local_port local port number in host byte order |
| 1253 | * \param[in] remote_host remote host name or IP address in string form |
| 1254 | * \param[in] remote_port remote port number in host byte order |
| 1255 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
| 1256 | * \returns socket fd on success; negative on error |
| 1257 | * |
| 1258 | * This function creates (and optionall binds/connects) a socket using |
| 1259 | * \ref osmo_sock_init2, but also fills the \a ofd structure. |
| 1260 | */ |
| 1261 | int osmo_sock_init2_ofd(struct osmo_fd *ofd, int family, int type, int proto, |
| 1262 | const char *local_host, uint16_t local_port, |
| 1263 | const char *remote_host, uint16_t remote_port, unsigned int flags) |
| 1264 | { |
| 1265 | return osmo_fd_init_ofd(ofd, osmo_sock_init2(family, type, proto, local_host, |
Harald Welte | 24980ba | 2021-04-23 14:07:18 +0200 | [diff] [blame] | 1266 | local_port, remote_host, remote_port, flags), flags); |
Pau Espin Pedrol | 75989e6 | 2017-05-26 12:39:53 +0200 | [diff] [blame] | 1267 | } |
| 1268 | |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 1269 | int osmo_sock_init_osa_ofd(struct osmo_fd *ofd, int type, int proto, |
| 1270 | const struct osmo_sockaddr *local, |
| 1271 | const struct osmo_sockaddr *remote, unsigned int flags) |
| 1272 | { |
Harald Welte | 24980ba | 2021-04-23 14:07:18 +0200 | [diff] [blame] | 1273 | return osmo_fd_init_ofd(ofd, osmo_sock_init_osa(type, proto, local, remote, flags), flags); |
Alexander Couzens | 43957e6 | 2020-08-01 21:56:45 +0200 | [diff] [blame] | 1274 | } |
| 1275 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1276 | /*! Initialize a socket and fill \ref sockaddr |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 1277 | * \param[out] ss socket address (will be filled in) |
| 1278 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 1279 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 1280 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 1281 | * \returns socket fd on success; negative on error |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 1282 | * |
| 1283 | * This function creates (and optionall binds/connects) a socket using |
| 1284 | * \ref osmo_sock_init, but also fills the \a ss structure. |
| 1285 | */ |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1286 | int osmo_sock_init_sa(struct sockaddr *ss, uint16_t type, |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 1287 | uint8_t proto, unsigned int flags) |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1288 | { |
| 1289 | char host[NI_MAXHOST]; |
| 1290 | uint16_t port; |
| 1291 | struct sockaddr_in *sin; |
| 1292 | struct sockaddr_in6 *sin6; |
| 1293 | int s, sa_len; |
| 1294 | |
| 1295 | /* determine port and host from ss */ |
| 1296 | switch (ss->sa_family) { |
| 1297 | case AF_INET: |
| 1298 | sin = (struct sockaddr_in *) ss; |
| 1299 | sa_len = sizeof(struct sockaddr_in); |
| 1300 | port = ntohs(sin->sin_port); |
| 1301 | break; |
| 1302 | case AF_INET6: |
| 1303 | sin6 = (struct sockaddr_in6 *) ss; |
| 1304 | sa_len = sizeof(struct sockaddr_in6); |
| 1305 | port = ntohs(sin6->sin6_port); |
| 1306 | break; |
| 1307 | default: |
| 1308 | return -EINVAL; |
| 1309 | } |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1310 | |
| 1311 | s = getnameinfo(ss, sa_len, host, NI_MAXHOST, |
| 1312 | NULL, 0, NI_NUMERICHOST); |
| 1313 | if (s != 0) { |
Philipp Maier | 6f0f560 | 2017-02-09 14:09:06 +0100 | [diff] [blame] | 1314 | LOGP(DLGLOBAL, LOGL_ERROR, "getnameinfo failed:" |
| 1315 | " %s\n", strerror(errno)); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1316 | return s; |
| 1317 | } |
| 1318 | |
Pablo Neira Ayuso | 0849c9a | 2011-06-09 15:04:30 +0200 | [diff] [blame] | 1319 | return osmo_sock_init(ss->sa_family, type, proto, host, port, flags); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1320 | } |
| 1321 | |
Pau Espin Pedrol | e4f34d8 | 2023-10-23 11:23:45 +0200 | [diff] [blame] | 1322 | #ifdef HAVE_LIBSCTP |
Pau Espin Pedrol | 64ba9ed | 2023-09-29 19:21:10 +0200 | [diff] [blame] | 1323 | /*! Add addresses to the multi-address (SCTP) socket active binding set |
| 1324 | * \param[in] sfd The multi-address (SCTP) socket |
| 1325 | * \param[in] addrs array of char pointers (strings), each containing local host name or IP address in string form |
| 1326 | * \param[in] addrs_cnt length of addrs_hosts (in items) |
| 1327 | * \returns 0 on success; negative on error |
| 1328 | * |
| 1329 | * This function only supports SCTP sockets so far, and hence it should be |
| 1330 | * called only on socket file descriptions referencing that kind of sockets. |
| 1331 | */ |
| 1332 | int osmo_sock_multiaddr_add_local_addr(int sfd, const char **addrs, size_t addrs_cnt) |
| 1333 | { |
| 1334 | struct osmo_sockaddr osa; |
| 1335 | socklen_t slen = sizeof(osa); |
| 1336 | uint16_t sfd_family; |
| 1337 | uint16_t type = SOCK_STREAM ;/* Fixme: we assume fd is SOCK_STREAM */ |
| 1338 | uint8_t proto = IPPROTO_SCTP; /* Fixme: we assume fd is IPPROTO_SCTP */ |
| 1339 | struct addrinfo *res[OSMO_SOCK_MAX_ADDRS]; |
| 1340 | uint16_t port; |
| 1341 | struct sockaddr_in6 addrs_buf[OSMO_SOCK_MAX_ADDRS]; |
| 1342 | unsigned int i; |
| 1343 | int rc; |
| 1344 | bool res_has_v4addr = false, res_has_v6addr = false; |
| 1345 | |
| 1346 | rc = getsockname(sfd, &osa.u.sa, &slen); |
| 1347 | if (rc < 0) |
| 1348 | return rc; /* TODO: log error? */ |
| 1349 | sfd_family = osa.u.sa.sa_family; |
| 1350 | port = osmo_sockaddr_port(&osa.u.sa); |
| 1351 | |
| 1352 | if (sfd_family != AF_INET && sfd_family != AF_INET6) |
| 1353 | return -EINVAL; |
| 1354 | |
| 1355 | rc = addrinfo_helper_multi(res, AF_UNSPEC, type, proto, addrs, |
| 1356 | addrs_cnt, port, true); |
| 1357 | if (rc < 0) |
| 1358 | return -EINVAL; |
| 1359 | |
| 1360 | addrinfo_has_v4v6addr((const struct addrinfo **)res, addrs_cnt, |
| 1361 | &res_has_v4addr, &res_has_v6addr); |
| 1362 | if (sfd_family == AF_INET && !res_has_v4addr) { |
| 1363 | rc = -EINVAL; |
| 1364 | goto ret_free; |
| 1365 | } |
| 1366 | |
| 1367 | uint16_t new_addr_family; |
| 1368 | if (sfd_family == AF_INET) |
| 1369 | new_addr_family = AF_INET; |
| 1370 | else if (sfd_family == AF_INET6 && !res_has_v4addr) |
| 1371 | new_addr_family = AF_INET6; |
| 1372 | else |
| 1373 | new_addr_family = AF_UNSPEC; |
| 1374 | rc = addrinfo_to_sockaddr(new_addr_family, (const struct addrinfo **)res, |
| 1375 | addrs, addrs_cnt, |
| 1376 | (uint8_t *)addrs_buf, sizeof(addrs_buf)); |
| 1377 | if (rc < 0) { |
| 1378 | rc = -ENODEV; |
| 1379 | goto ret_free; |
| 1380 | } |
| 1381 | |
| 1382 | rc = sctp_bindx(sfd, (struct sockaddr *)addrs_buf, addrs_cnt, SCTP_BINDX_ADD_ADDR); |
| 1383 | if (rc == -1) { |
| 1384 | int err = errno; |
| 1385 | char strbuf[512]; |
| 1386 | multiaddr_snprintf(strbuf, sizeof(strbuf), addrs, addrs_cnt); |
| 1387 | LOGP(DLGLOBAL, LOGL_NOTICE, "Unable to bind socket to new addresses: %s:%u: %s\n", |
| 1388 | strbuf, port, strerror(err)); |
| 1389 | rc = -ENODEV; |
| 1390 | goto ret_free; |
| 1391 | } |
| 1392 | |
| 1393 | ret_free: |
| 1394 | for (i = 0; i < addrs_cnt; i++) |
| 1395 | freeaddrinfo(res[i]); |
| 1396 | return rc; |
| 1397 | } |
| 1398 | |
| 1399 | /*! Remove addresses from the multi-address (SCTP) socket active binding set |
| 1400 | * \param[in] sfd The multi-address (SCTP) socket |
| 1401 | * \param[in] addrs array of char pointers (strings), each containing local host name or IP address in string form |
| 1402 | * \param[in] addrs_cnt length of addrs_hosts (in items) |
| 1403 | * \returns 0 on success; negative on error |
| 1404 | * |
| 1405 | * This function only supports SCTP sockets so far, and hence it should be |
| 1406 | * called only on socket file descriptions referencing that kind of sockets. |
| 1407 | */ |
| 1408 | int osmo_sock_multiaddr_del_local_addr(int sfd, const char **addrs, size_t addrs_cnt) |
| 1409 | { |
| 1410 | struct osmo_sockaddr osa; |
| 1411 | socklen_t slen = sizeof(osa); |
| 1412 | uint16_t sfd_family; |
| 1413 | uint16_t type = SOCK_STREAM ;/* Fixme: we assume fd is SOCK_STREAM */ |
| 1414 | uint8_t proto = IPPROTO_SCTP; /* Fixme: we assume fd is IPPROTO_SCTP */ |
| 1415 | struct addrinfo *res[OSMO_SOCK_MAX_ADDRS]; |
| 1416 | uint16_t port; |
| 1417 | struct sockaddr_in6 addrs_buf[OSMO_SOCK_MAX_ADDRS]; |
| 1418 | unsigned int i; |
| 1419 | int rc; |
| 1420 | bool res_has_v4addr = false, res_has_v6addr = false; |
| 1421 | |
| 1422 | rc = getsockname(sfd, &osa.u.sa, &slen); |
| 1423 | if (rc < 0) |
| 1424 | return rc; /* TODO: log error? */ |
| 1425 | sfd_family = osa.u.sa.sa_family; |
| 1426 | port = osmo_sockaddr_port(&osa.u.sa); |
| 1427 | |
| 1428 | if (sfd_family != AF_INET && sfd_family != AF_INET6) |
| 1429 | return -EINVAL; |
| 1430 | |
| 1431 | rc = addrinfo_helper_multi(res, AF_UNSPEC, type, proto, addrs, |
| 1432 | addrs_cnt, port, true); |
| 1433 | if (rc < 0) |
| 1434 | return -EINVAL; |
| 1435 | |
| 1436 | addrinfo_has_v4v6addr((const struct addrinfo **)res, addrs_cnt, |
| 1437 | &res_has_v4addr, &res_has_v6addr); |
| 1438 | if (sfd_family == AF_INET && !res_has_v4addr) { |
| 1439 | rc = -EINVAL; |
| 1440 | goto ret_free; |
| 1441 | } |
| 1442 | |
| 1443 | uint16_t del_addr_family; |
| 1444 | if (sfd_family == AF_INET) |
| 1445 | del_addr_family = AF_INET; |
| 1446 | else if (sfd_family == AF_INET6 && !res_has_v4addr) |
| 1447 | del_addr_family = AF_INET6; |
| 1448 | else |
| 1449 | del_addr_family = AF_UNSPEC; |
| 1450 | rc = addrinfo_to_sockaddr(del_addr_family, (const struct addrinfo **)res, |
| 1451 | addrs, addrs_cnt, |
| 1452 | (uint8_t *)addrs_buf, sizeof(addrs_buf)); |
| 1453 | if (rc < 0) { |
| 1454 | rc = -ENODEV; |
| 1455 | goto ret_free; |
| 1456 | } |
| 1457 | |
| 1458 | rc = sctp_bindx(sfd, (struct sockaddr *)addrs_buf, addrs_cnt, SCTP_BINDX_REM_ADDR); |
| 1459 | if (rc == -1) { |
| 1460 | int err = errno; |
| 1461 | char strbuf[512]; |
| 1462 | multiaddr_snprintf(strbuf, sizeof(strbuf), addrs, addrs_cnt); |
| 1463 | LOGP(DLGLOBAL, LOGL_NOTICE, "Unable to unbind socket from addresses: %s:%u: %s\n", |
| 1464 | strbuf, port, strerror(err)); |
| 1465 | rc = -ENODEV; |
| 1466 | goto ret_free; |
| 1467 | } |
| 1468 | |
| 1469 | ret_free: |
| 1470 | for (i = 0; i < addrs_cnt; i++) |
| 1471 | freeaddrinfo(res[i]); |
| 1472 | return rc; |
| 1473 | } |
Pau Espin Pedrol | e4f34d8 | 2023-10-23 11:23:45 +0200 | [diff] [blame] | 1474 | #endif /* HAVE_LIBSCTP */ |
Pau Espin Pedrol | 64ba9ed | 2023-09-29 19:21:10 +0200 | [diff] [blame] | 1475 | |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1476 | static int sockaddr_equal(const struct sockaddr *a, |
Harald Welte | e476442 | 2011-05-22 12:25:57 +0200 | [diff] [blame] | 1477 | const struct sockaddr *b, unsigned int len) |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1478 | { |
| 1479 | struct sockaddr_in *sin_a, *sin_b; |
| 1480 | struct sockaddr_in6 *sin6_a, *sin6_b; |
| 1481 | |
| 1482 | if (a->sa_family != b->sa_family) |
| 1483 | return 0; |
| 1484 | |
| 1485 | switch (a->sa_family) { |
| 1486 | case AF_INET: |
| 1487 | sin_a = (struct sockaddr_in *)a; |
| 1488 | sin_b = (struct sockaddr_in *)b; |
| 1489 | if (!memcmp(&sin_a->sin_addr, &sin_b->sin_addr, |
| 1490 | sizeof(struct in_addr))) |
| 1491 | return 1; |
| 1492 | break; |
| 1493 | case AF_INET6: |
| 1494 | sin6_a = (struct sockaddr_in6 *)a; |
| 1495 | sin6_b = (struct sockaddr_in6 *)b; |
| 1496 | if (!memcmp(&sin6_a->sin6_addr, &sin6_b->sin6_addr, |
| 1497 | sizeof(struct in6_addr))) |
| 1498 | return 1; |
| 1499 | break; |
| 1500 | } |
| 1501 | return 0; |
| 1502 | } |
| 1503 | |
Eric | 8ae40cb | 2021-09-27 22:10:01 +0200 | [diff] [blame] | 1504 | /* linux has a default route: |
| 1505 | local 127.0.0.0/8 dev lo proto kernel scope host src 127.0.0.1 |
| 1506 | */ |
| 1507 | static int sockaddr_is_local_routed(const struct sockaddr *a) |
| 1508 | { |
| 1509 | #if __linux__ |
| 1510 | if (a->sa_family != AF_INET) |
| 1511 | return 0; |
| 1512 | |
| 1513 | uint32_t address = ((struct sockaddr_in *)a)->sin_addr.s_addr; /* already BE */ |
| 1514 | uint32_t eightmask = htonl(0xff000000); /* /8 mask */ |
| 1515 | uint32_t local_prefix_127 = htonl(0x7f000000); /* 127.0.0.0 */ |
| 1516 | |
| 1517 | if ((address & eightmask) == local_prefix_127) |
| 1518 | return 1; |
| 1519 | #endif |
| 1520 | return 0; |
| 1521 | } |
| 1522 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1523 | /*! Determine if the given address is a local address |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 1524 | * \param[in] addr Socket Address |
| 1525 | * \param[in] addrlen Length of socket address in bytes |
| 1526 | * \returns 1 if address is local, 0 otherwise. |
| 1527 | */ |
Harald Welte | bc32d05 | 2012-04-08 11:31:32 +0200 | [diff] [blame] | 1528 | int osmo_sockaddr_is_local(struct sockaddr *addr, unsigned int addrlen) |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1529 | { |
| 1530 | struct ifaddrs *ifaddr, *ifa; |
| 1531 | |
Eric | 8ae40cb | 2021-09-27 22:10:01 +0200 | [diff] [blame] | 1532 | if (sockaddr_is_local_routed(addr)) |
| 1533 | return 1; |
| 1534 | |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1535 | if (getifaddrs(&ifaddr) == -1) { |
Philipp Maier | 6f0f560 | 2017-02-09 14:09:06 +0100 | [diff] [blame] | 1536 | LOGP(DLGLOBAL, LOGL_ERROR, "getifaddrs:" |
| 1537 | " %s\n", strerror(errno)); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1538 | return -EIO; |
| 1539 | } |
| 1540 | |
| 1541 | for (ifa = ifaddr; ifa != NULL; ifa = ifa->ifa_next) { |
Harald Welte | 4d3a7b1 | 2011-05-24 21:31:53 +0200 | [diff] [blame] | 1542 | if (!ifa->ifa_addr) |
| 1543 | continue; |
Pau Espin Pedrol | 15753e9 | 2018-04-18 19:57:41 +0200 | [diff] [blame] | 1544 | if (sockaddr_equal(ifa->ifa_addr, addr, addrlen)) { |
| 1545 | freeifaddrs(ifaddr); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1546 | return 1; |
Pau Espin Pedrol | 15753e9 | 2018-04-18 19:57:41 +0200 | [diff] [blame] | 1547 | } |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1548 | } |
| 1549 | |
Pau Espin Pedrol | 15753e9 | 2018-04-18 19:57:41 +0200 | [diff] [blame] | 1550 | freeifaddrs(ifaddr); |
Harald Welte | 33cb71a | 2011-05-21 18:54:32 +0200 | [diff] [blame] | 1551 | return 0; |
| 1552 | } |
Harald Welte | e476442 | 2011-05-22 12:25:57 +0200 | [diff] [blame] | 1553 | |
Pau Espin Pedrol | 3b3955b | 2022-10-04 12:38:49 +0200 | [diff] [blame] | 1554 | /*! Determine if the given address is an ANY address ("0.0.0.0", "::"). Port is not checked. |
| 1555 | * \param[in] addr Socket Address |
| 1556 | * \param[in] addrlen Length of socket address in bytes |
| 1557 | * \returns 1 if address is ANY, 0 otherwise. -1 is address family not supported/detected. |
| 1558 | */ |
| 1559 | int osmo_sockaddr_is_any(const struct osmo_sockaddr *addr) |
| 1560 | { |
| 1561 | switch (addr->u.sa.sa_family) { |
| 1562 | case AF_INET6: { |
| 1563 | struct in6_addr ip6_any = IN6ADDR_ANY_INIT; |
| 1564 | return memcmp(&addr->u.sin6.sin6_addr, |
| 1565 | &ip6_any, sizeof(ip6_any)) == 0; |
| 1566 | } |
| 1567 | case AF_INET: |
| 1568 | return addr->u.sin.sin_addr.s_addr == INADDR_ANY; |
| 1569 | default: |
| 1570 | return -1; |
| 1571 | } |
| 1572 | } |
| 1573 | |
Max | 9d7a247 | 2018-11-20 15:18:31 +0100 | [diff] [blame] | 1574 | /*! Convert sockaddr_in to IP address as char string and port as uint16_t. |
| 1575 | * \param[out] addr String buffer to write IP address to, or NULL. |
| 1576 | * \param[out] addr_len Size of \a addr. |
| 1577 | * \param[out] port Pointer to uint16_t to write the port number to, or NULL. |
| 1578 | * \param[in] sin Sockaddr to convert. |
| 1579 | * \returns the required string buffer size, like osmo_strlcpy(), or 0 if \a addr is NULL. |
| 1580 | */ |
| 1581 | size_t osmo_sockaddr_in_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port, |
| 1582 | const struct sockaddr_in *sin) |
| 1583 | { |
| 1584 | if (port) |
| 1585 | *port = ntohs(sin->sin_port); |
| 1586 | |
| 1587 | if (addr) |
| 1588 | return osmo_strlcpy(addr, inet_ntoa(sin->sin_addr), addr_len); |
| 1589 | |
| 1590 | return 0; |
| 1591 | } |
| 1592 | |
Neels Hofmeyr | 59f4caf | 2018-07-19 22:13:19 +0200 | [diff] [blame] | 1593 | /*! Convert sockaddr to IP address as char string and port as uint16_t. |
| 1594 | * \param[out] addr String buffer to write IP address to, or NULL. |
| 1595 | * \param[out] addr_len Size of \a addr. |
| 1596 | * \param[out] port Pointer to uint16_t to write the port number to, or NULL. |
| 1597 | * \param[in] sa Sockaddr to convert. |
| 1598 | * \returns the required string buffer size, like osmo_strlcpy(), or 0 if \a addr is NULL. |
| 1599 | */ |
| 1600 | unsigned int osmo_sockaddr_to_str_and_uint(char *addr, unsigned int addr_len, uint16_t *port, |
| 1601 | const struct sockaddr *sa) |
| 1602 | { |
Neels Hofmeyr | 59f4caf | 2018-07-19 22:13:19 +0200 | [diff] [blame] | 1603 | |
Pau Espin Pedrol | 1a3d24e | 2020-08-28 18:31:32 +0200 | [diff] [blame] | 1604 | const struct sockaddr_in6 *sin6; |
| 1605 | |
| 1606 | switch (sa->sa_family) { |
| 1607 | case AF_INET: |
| 1608 | return osmo_sockaddr_in_to_str_and_uint(addr, addr_len, port, |
| 1609 | (const struct sockaddr_in *)sa); |
| 1610 | case AF_INET6: |
| 1611 | sin6 = (const struct sockaddr_in6 *)sa; |
| 1612 | if (port) |
| 1613 | *port = ntohs(sin6->sin6_port); |
| 1614 | if (addr && inet_ntop(sa->sa_family, &sin6->sin6_addr, addr, addr_len)) |
| 1615 | return strlen(addr); |
| 1616 | break; |
| 1617 | } |
| 1618 | return 0; |
Neels Hofmeyr | 59f4caf | 2018-07-19 22:13:19 +0200 | [diff] [blame] | 1619 | } |
| 1620 | |
Pau Espin Pedrol | 5cc4fe4 | 2020-08-31 12:52:06 +0200 | [diff] [blame] | 1621 | /*! inet_ntop() wrapper for a struct sockaddr. |
| 1622 | * \param[in] sa source sockaddr to get the address from. |
| 1623 | * \param[out] dst string buffer of at least INET6_ADDRSTRLEN size. |
| 1624 | * \returns returns a non-null pointer to dst. NULL is returned if there was an |
| 1625 | * error, with errno set to indicate the error. |
| 1626 | */ |
| 1627 | const char *osmo_sockaddr_ntop(const struct sockaddr *sa, char *dst) |
| 1628 | { |
| 1629 | const struct osmo_sockaddr *osa = (const struct osmo_sockaddr *)sa; |
| 1630 | return inet_ntop(osa->u.sa.sa_family, |
| 1631 | osa->u.sa.sa_family == AF_INET6 ? |
| 1632 | (const void *)&osa->u.sin6.sin6_addr : |
| 1633 | (const void *)&osa->u.sin.sin_addr, |
| 1634 | dst, INET6_ADDRSTRLEN); |
| 1635 | } |
| 1636 | |
| 1637 | /*! Get sockaddr port content (in host byte order) |
| 1638 | * \param[in] sa source sockaddr to get the port from. |
| 1639 | * \returns returns the sockaddr port in host byte order |
| 1640 | */ |
| 1641 | uint16_t osmo_sockaddr_port(const struct sockaddr *sa) |
| 1642 | { |
| 1643 | const struct osmo_sockaddr *osa = (const struct osmo_sockaddr *)sa; |
| 1644 | switch (osa->u.sa.sa_family) { |
| 1645 | case AF_INET6: |
| 1646 | return ntohs(osa->u.sin6.sin6_port); |
| 1647 | case AF_INET: |
| 1648 | return ntohs(osa->u.sin.sin_port); |
| 1649 | } |
| 1650 | return 0; |
| 1651 | } |
| 1652 | |
Neels Hofmeyr | 9c7f7f8 | 2022-01-11 19:25:40 +0100 | [diff] [blame] | 1653 | /*! Set sockaddr port content (to network byte order). |
| 1654 | * \param[out] sa sockaddr to set the port of. |
| 1655 | * \param[in] port port nr to set. |
| 1656 | */ |
| 1657 | void osmo_sockaddr_set_port(struct sockaddr *sa, uint16_t port) |
| 1658 | { |
| 1659 | struct osmo_sockaddr *osa = (struct osmo_sockaddr *)sa; |
| 1660 | switch (osa->u.sa.sa_family) { |
| 1661 | case AF_INET6: |
| 1662 | osa->u.sin6.sin6_port = htons(port); |
| 1663 | return; |
| 1664 | case AF_INET: |
| 1665 | osa->u.sin.sin_port = htons(port); |
| 1666 | return; |
| 1667 | } |
| 1668 | } |
| 1669 | |
Pau Espin Pedrol | cc296c9 | 2023-01-16 14:54:55 +0100 | [diff] [blame] | 1670 | static unsigned int in6_addr_netmask_to_prefixlen(const struct in6_addr *netmask) |
| 1671 | { |
| 1672 | #if defined(__linux__) |
| 1673 | #define ADDRFIELD(i) s6_addr32[i] |
| 1674 | #else |
| 1675 | #define ADDRFIELD(i) __u6_addr.__u6_addr32[i] |
| 1676 | #endif |
| 1677 | |
| 1678 | unsigned int i, j, prefix = 0; |
| 1679 | |
| 1680 | for (j = 0; j < 4; j++) { |
| 1681 | uint32_t bits = netmask->ADDRFIELD(j); |
| 1682 | uint8_t *b = (uint8_t *)&bits; |
| 1683 | for (i = 0; i < 4; i++) { |
| 1684 | while (b[i] & 0x80) { |
| 1685 | prefix++; |
| 1686 | b[i] = b[i] << 1; |
| 1687 | } |
| 1688 | } |
| 1689 | } |
| 1690 | |
| 1691 | #undef ADDRFIELD |
| 1692 | |
| 1693 | return prefix; |
| 1694 | } |
| 1695 | |
| 1696 | static unsigned int in_addr_netmask_to_prefixlen(const struct in_addr *netmask) |
| 1697 | { |
| 1698 | uint32_t bits = netmask->s_addr; |
| 1699 | uint8_t *b = (uint8_t *)&bits; |
| 1700 | unsigned int i, prefix = 0; |
| 1701 | |
| 1702 | for (i = 0; i < 4; i++) { |
| 1703 | while (b[i] & 0x80) { |
| 1704 | prefix++; |
| 1705 | b[i] = b[i] << 1; |
| 1706 | } |
| 1707 | } |
| 1708 | return prefix; |
| 1709 | } |
| 1710 | |
| 1711 | /*! Convert netmask to prefix length representation |
| 1712 | * \param[in] netmask sockaddr containing a netmask (consecutive list of 1-bit followed by consecutive list of 0-bit) |
| 1713 | * \returns prefix length representation of the netmask (count of 1-bit from the start of the netmask), negative on error. |
| 1714 | */ |
| 1715 | int osmo_sockaddr_netmask_to_prefixlen(const struct osmo_sockaddr *netmask) |
| 1716 | { |
| 1717 | switch (netmask->u.sa.sa_family) { |
| 1718 | case AF_INET6: |
| 1719 | return in6_addr_netmask_to_prefixlen(&netmask->u.sin6.sin6_addr); |
| 1720 | case AF_INET: |
| 1721 | return in_addr_netmask_to_prefixlen(&netmask->u.sin.sin_addr); |
| 1722 | default: |
| 1723 | return -ENOTSUP; |
| 1724 | } |
| 1725 | } |
| 1726 | |
Harald Welte | 641cc3c | 2023-11-21 19:45:57 +0100 | [diff] [blame] | 1727 | /*! Convert an IP address string (and port number) into a 'struct osmo_sockaddr'. |
| 1728 | * \param[out] osa_out caller-allocated osmo_sockaddr storage |
| 1729 | * \param[in] ipstr IP[v4,v6] address in string format |
| 1730 | * \param[in] port port number (host byte order) |
| 1731 | * \returns 0 on success; negative on error. */ |
| 1732 | int osmo_sockaddr_from_str_and_uint(struct osmo_sockaddr *osa_out, const char *ipstr, uint16_t port) |
| 1733 | { |
| 1734 | struct addrinfo *ai = addrinfo_helper(AF_UNSPEC, 0, 0, ipstr, port, true); |
| 1735 | |
| 1736 | if (!ai) |
| 1737 | return -EIO; |
| 1738 | |
| 1739 | if (ai->ai_addrlen > sizeof(*osa_out)) |
| 1740 | return -ENOSPC; |
| 1741 | |
| 1742 | memcpy(&osa_out->u.sa, ai->ai_addr, ai->ai_addrlen); |
| 1743 | freeaddrinfo(ai); |
| 1744 | |
| 1745 | return 0; |
| 1746 | } |
| 1747 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1748 | /*! Initialize a unix domain socket (including bind/connect) |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1749 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 1750 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 1751 | * \param[in] socket_path path to identify the socket |
| 1752 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 1753 | * \returns socket fd on success; negative on error |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1754 | * |
| 1755 | * This function creates a new unix domain socket, \a |
| 1756 | * type and \a proto and optionally binds or connects it, depending on |
| 1757 | * the value of \a flags parameter. |
| 1758 | */ |
Eric Wild | eb5769b | 2019-06-27 15:31:17 +0200 | [diff] [blame] | 1759 | #if defined(__clang__) && defined(SUN_LEN) |
| 1760 | __attribute__((no_sanitize("undefined"))) |
| 1761 | #endif |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1762 | int osmo_sock_unix_init(uint16_t type, uint8_t proto, |
| 1763 | const char *socket_path, unsigned int flags) |
| 1764 | { |
| 1765 | struct sockaddr_un local; |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 1766 | int sfd, rc; |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1767 | unsigned int namelen; |
| 1768 | |
| 1769 | if ((flags & (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) == |
| 1770 | (OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT)) |
| 1771 | return -EINVAL; |
| 1772 | |
| 1773 | local.sun_family = AF_UNIX; |
Stefan Sperling | 6afb3f5 | 2018-09-20 17:21:05 +0200 | [diff] [blame] | 1774 | /* When an AF_UNIX socket is bound, sun_path should be NUL-terminated. See unix(7) man page. */ |
| 1775 | if (osmo_strlcpy(local.sun_path, socket_path, sizeof(local.sun_path)) >= sizeof(local.sun_path)) { |
Stefan Sperling | 896ff6d | 2018-08-28 14:34:17 +0200 | [diff] [blame] | 1776 | LOGP(DLGLOBAL, LOGL_ERROR, "Socket path exceeds maximum length of %zd bytes: %s\n", |
| 1777 | sizeof(local.sun_path), socket_path); |
| 1778 | return -ENOSPC; |
| 1779 | } |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1780 | |
| 1781 | #if defined(BSD44SOCKETS) || defined(__UNIXWARE__) |
Stefan Sperling | 6afb3f5 | 2018-09-20 17:21:05 +0200 | [diff] [blame] | 1782 | local.sun_len = strlen(local.sun_path); |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1783 | #endif |
| 1784 | #if defined(BSD44SOCKETS) || defined(SUN_LEN) |
| 1785 | namelen = SUN_LEN(&local); |
| 1786 | #else |
Stefan Sperling | 6afb3f5 | 2018-09-20 17:21:05 +0200 | [diff] [blame] | 1787 | namelen = strlen(local.sun_path) + |
| 1788 | offsetof(struct sockaddr_un, sun_path); |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1789 | #endif |
| 1790 | |
| 1791 | sfd = socket(AF_UNIX, type, proto); |
| 1792 | if (sfd < 0) |
Max | db7cb69 | 2023-02-11 21:35:21 +0300 | [diff] [blame] | 1793 | return -errno; |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1794 | |
| 1795 | if (flags & OSMO_SOCK_F_CONNECT) { |
| 1796 | rc = connect(sfd, (struct sockaddr *)&local, namelen); |
| 1797 | if (rc < 0) |
| 1798 | goto err; |
| 1799 | } else { |
| 1800 | unlink(local.sun_path); |
| 1801 | rc = bind(sfd, (struct sockaddr *)&local, namelen); |
| 1802 | if (rc < 0) |
| 1803 | goto err; |
| 1804 | } |
| 1805 | |
Harald Welte | faf6b70 | 2021-04-28 13:04:59 +0200 | [diff] [blame] | 1806 | rc = socket_helper_tail(sfd, flags); |
| 1807 | if (rc < 0) |
| 1808 | return rc; |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1809 | |
Harald Welte | c47bbda | 2017-07-13 16:13:26 +0200 | [diff] [blame] | 1810 | rc = osmo_sock_init_tail(sfd, type, flags); |
| 1811 | if (rc < 0) { |
| 1812 | close(sfd); |
Max | db7cb69 | 2023-02-11 21:35:21 +0300 | [diff] [blame] | 1813 | sfd = rc; |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1814 | } |
| 1815 | |
| 1816 | return sfd; |
| 1817 | err: |
| 1818 | close(sfd); |
Max | db7cb69 | 2023-02-11 21:35:21 +0300 | [diff] [blame] | 1819 | return -errno; |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1820 | } |
| 1821 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1822 | /*! Initialize a unix domain socket and fill \ref osmo_fd |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1823 | * \param[out] ofd file descriptor (will be filled in) |
| 1824 | * \param[in] type Socket type like SOCK_DGRAM, SOCK_STREAM |
| 1825 | * \param[in] proto Protocol like IPPROTO_TCP, IPPROTO_UDP |
| 1826 | * \param[in] socket_path path to identify the socket |
| 1827 | * \param[in] flags flags like \ref OSMO_SOCK_F_CONNECT |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 1828 | * \returns socket fd on success; negative on error |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1829 | * |
Vadim Yanitskiy | b606d76 | 2019-06-01 19:02:47 +0700 | [diff] [blame] | 1830 | * This function creates (and optionally binds/connects) a socket |
| 1831 | * using osmo_sock_unix_init, but also fills the ofd structure. |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1832 | */ |
| 1833 | int osmo_sock_unix_init_ofd(struct osmo_fd *ofd, uint16_t type, uint8_t proto, |
| 1834 | const char *socket_path, unsigned int flags) |
| 1835 | { |
Harald Welte | 24980ba | 2021-04-23 14:07:18 +0200 | [diff] [blame] | 1836 | return osmo_fd_init_ofd(ofd, osmo_sock_unix_init(type, proto, socket_path, flags), flags); |
Álvaro Neira Ayuso | 5ade61a | 2014-03-24 13:02:00 +0100 | [diff] [blame] | 1837 | } |
| 1838 | |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 1839 | /*! Get the IP and/or port number on socket in separate string buffers. |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1840 | * \param[in] fd file descriptor of socket |
| 1841 | * \param[out] ip IP address (will be filled in when not NULL) |
| 1842 | * \param[in] ip_len length of the ip buffer |
| 1843 | * \param[out] port number (will be filled in when not NULL) |
| 1844 | * \param[in] port_len length of the port buffer |
| 1845 | * \param[in] local (true) or remote (false) name will get looked at |
| 1846 | * \returns 0 on success; negative otherwise |
| 1847 | */ |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 1848 | int osmo_sock_get_ip_and_port(int fd, char *ip, size_t ip_len, char *port, size_t port_len, bool local) |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1849 | { |
Pau Espin Pedrol | ed42a88 | 2020-08-21 15:39:17 +0200 | [diff] [blame] | 1850 | struct sockaddr_storage sa; |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1851 | socklen_t len = sizeof(sa); |
Oliver Smith | 860651e | 2018-10-30 14:31:57 +0100 | [diff] [blame] | 1852 | char ipbuf[INET6_ADDRSTRLEN], portbuf[6]; |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1853 | int rc; |
| 1854 | |
Pau Espin Pedrol | ed42a88 | 2020-08-21 15:39:17 +0200 | [diff] [blame] | 1855 | rc = local ? getsockname(fd, (struct sockaddr*)&sa, &len) : getpeername(fd, (struct sockaddr*)&sa, &len); |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1856 | if (rc < 0) |
| 1857 | return rc; |
| 1858 | |
Pau Espin Pedrol | ed42a88 | 2020-08-21 15:39:17 +0200 | [diff] [blame] | 1859 | rc = getnameinfo((const struct sockaddr*)&sa, len, ipbuf, sizeof(ipbuf), |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1860 | portbuf, sizeof(portbuf), |
| 1861 | NI_NUMERICHOST | NI_NUMERICSERV); |
| 1862 | if (rc < 0) |
| 1863 | return rc; |
| 1864 | |
| 1865 | if (ip) |
| 1866 | strncpy(ip, ipbuf, ip_len); |
| 1867 | if (port) |
| 1868 | strncpy(port, portbuf, port_len); |
| 1869 | return 0; |
| 1870 | } |
| 1871 | |
Andreas Eversberg | e8ab1b7 | 2024-02-22 15:38:47 +0100 | [diff] [blame] | 1872 | #ifdef HAVE_LIBSCTP |
Pau Espin Pedrol | 6a2975c | 2023-11-30 18:15:30 +0100 | [diff] [blame] | 1873 | /*! Get multiple IP addresses and/or port number on socket in separate string buffers |
| 1874 | * \param[in] fd file descriptor of socket. |
| 1875 | * \param[out] ip_proto IPPROTO of the socket, eg: IPPROTO_SCTP. |
| 1876 | * \param[out] ip Pointer to memory holding consecutive buffers of size ip_len. |
| 1877 | * \param[out] ip_cnt length ip array pointer. on return it contains the number of addresses found. |
| 1878 | * \param[in] ip_len length of each of the string buffer in the the ip array. |
| 1879 | * \param[out] port number (will be filled in when not NULL). |
| 1880 | * \param[in] port_len length of the port buffer. |
| 1881 | * \param[in] local (true) or remote (false) name will get looked at. |
| 1882 | * \returns 0 on success; negative otherwise. |
| 1883 | * |
| 1884 | * Upon return, ip_cnt can be set to a higher value than the one set by the |
| 1885 | * caller. This can be used by the caller to find out the required array length |
| 1886 | * and then obtaining by calling the function twice. Only up to ip_cnt addresses |
| 1887 | * are filed in, as per the value provided by the caller. |
| 1888 | * |
| 1889 | * Usage example retrieving all (up to OSMO_SOCK_MAX_ADDRS, 32) bound IP addresses and bound port: |
| 1890 | * char hostbuf[OSMO_SOCK_MAX_ADDRS][INET6_ADDRSTRLEN]; |
| 1891 | * size_t num_hostbuf = ARRAY_SIZE(hostbuf); |
| 1892 | * char portbuf[6]; |
| 1893 | * rc = osmo_sock_multiaddr_get_ip_and_port(fd, IPPROTO_SCTP, &hostbuf[0][0], &num_hostbuf, |
| 1894 | * sizeof(hostbuf[0]), portbuf, sizeof(portbuf), true); |
| 1895 | * if (rc < 0) |
| 1896 | * goto error; |
| 1897 | * if (num_hostbuf > ARRAY_SIZE(hostbuf)) |
| 1898 | * goto not_enough_buffers; |
| 1899 | */ |
| 1900 | int osmo_sock_multiaddr_get_ip_and_port(int fd, int ip_proto, char *ip, size_t *ip_cnt, size_t ip_len, |
| 1901 | char *port, size_t port_len, bool local) |
| 1902 | { |
| 1903 | struct sockaddr *addrs = NULL; |
| 1904 | unsigned int n_addrs, i; |
| 1905 | void *addr_buf; |
| 1906 | int rc; |
| 1907 | |
| 1908 | switch (ip_proto) { |
| 1909 | case IPPROTO_SCTP: |
| 1910 | break; /* continue below */ |
| 1911 | default: |
| 1912 | if (*ip_cnt == 0) { |
| 1913 | *ip_cnt = 1; |
| 1914 | return 0; |
| 1915 | } |
| 1916 | *ip_cnt = 1; |
| 1917 | return osmo_sock_get_ip_and_port(fd, ip, ip_len, port, port_len, local); |
| 1918 | } |
| 1919 | |
| 1920 | rc = local ? sctp_getladdrs(fd, 0, &addrs) : sctp_getpaddrs(fd, 0, &addrs); |
| 1921 | if (rc < 0) |
| 1922 | return rc; |
| 1923 | if (rc == 0) |
| 1924 | return -ENOTCONN; |
| 1925 | |
| 1926 | n_addrs = rc; |
| 1927 | addr_buf = (void *)addrs; |
| 1928 | for (i = 0; i < n_addrs; i++) { |
| 1929 | struct sockaddr *sa_addr = (struct sockaddr *)addr_buf; |
| 1930 | size_t addrlen; |
| 1931 | |
| 1932 | if (i >= *ip_cnt) |
| 1933 | break; |
| 1934 | |
| 1935 | switch (sa_addr->sa_family) { |
| 1936 | case AF_INET: |
| 1937 | addrlen = sizeof(struct sockaddr_in); |
| 1938 | break; |
| 1939 | case AF_INET6: |
| 1940 | addrlen = sizeof(struct sockaddr_in6); |
| 1941 | break; |
| 1942 | default: |
| 1943 | rc = -EINVAL; |
| 1944 | goto free_addrs_ret; |
| 1945 | } |
| 1946 | |
| 1947 | rc = getnameinfo(sa_addr, addrlen, &ip[i * ip_len], ip_len, |
| 1948 | port, port_len, |
| 1949 | NI_NUMERICHOST | NI_NUMERICSERV); |
| 1950 | if (rc < 0) |
| 1951 | goto free_addrs_ret; |
| 1952 | addr_buf += addrlen; |
| 1953 | } |
| 1954 | |
| 1955 | *ip_cnt = n_addrs; |
| 1956 | rc = 0; |
| 1957 | free_addrs_ret: |
| 1958 | local ? sctp_freeladdrs(addrs) : sctp_freepaddrs(addrs); |
| 1959 | return rc; |
| 1960 | } |
Andreas Eversberg | e8ab1b7 | 2024-02-22 15:38:47 +0100 | [diff] [blame] | 1961 | #endif |
Pau Espin Pedrol | 6a2975c | 2023-11-30 18:15:30 +0100 | [diff] [blame] | 1962 | |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1963 | /*! Get local IP address on socket |
| 1964 | * \param[in] fd file descriptor of socket |
| 1965 | * \param[out] ip IP address (will be filled in) |
| 1966 | * \param[in] len length of the output buffer |
| 1967 | * \returns 0 on success; negative otherwise |
| 1968 | */ |
| 1969 | int osmo_sock_get_local_ip(int fd, char *ip, size_t len) |
| 1970 | { |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 1971 | return osmo_sock_get_ip_and_port(fd, ip, len, NULL, 0, true); |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1972 | } |
| 1973 | |
| 1974 | /*! Get local port on socket |
| 1975 | * \param[in] fd file descriptor of socket |
| 1976 | * \param[out] port number (will be filled in) |
| 1977 | * \param[in] len length of the output buffer |
| 1978 | * \returns 0 on success; negative otherwise |
| 1979 | */ |
| 1980 | int osmo_sock_get_local_ip_port(int fd, char *port, size_t len) |
| 1981 | { |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 1982 | return osmo_sock_get_ip_and_port(fd, NULL, 0, port, len, true); |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1983 | } |
| 1984 | |
| 1985 | /*! Get remote IP address on socket |
| 1986 | * \param[in] fd file descriptor of socket |
| 1987 | * \param[out] ip IP address (will be filled in) |
| 1988 | * \param[in] len length of the output buffer |
| 1989 | * \returns 0 on success; negative otherwise |
| 1990 | */ |
| 1991 | int osmo_sock_get_remote_ip(int fd, char *ip, size_t len) |
| 1992 | { |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 1993 | return osmo_sock_get_ip_and_port(fd, ip, len, NULL, 0, false); |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 1994 | } |
| 1995 | |
| 1996 | /*! Get remote port on socket |
| 1997 | * \param[in] fd file descriptor of socket |
| 1998 | * \param[out] port number (will be filled in) |
| 1999 | * \param[in] len length of the output buffer |
| 2000 | * \returns 0 on success; negative otherwise |
| 2001 | */ |
| 2002 | int osmo_sock_get_remote_ip_port(int fd, char *port, size_t len) |
| 2003 | { |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 2004 | return osmo_sock_get_ip_and_port(fd, NULL, 0, port, len, false); |
Oliver Smith | 7acd5d0 | 2018-10-25 11:16:36 +0200 | [diff] [blame] | 2005 | } |
| 2006 | |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 2007 | /*! Get address/port information on socket in dyn-alloc string like "(r=1.2.3.4:5<->l=6.7.8.9:10)". |
| 2008 | * Usually, it is better to use osmo_sock_get_name2() for a static string buffer or osmo_sock_get_name_buf() for a |
| 2009 | * caller provided string buffer, to avoid the dynamic talloc allocation. |
Harald Welte | 48f5583 | 2017-01-26 00:03:10 +0100 | [diff] [blame] | 2010 | * \param[in] ctx talloc context from which to allocate string buffer |
| 2011 | * \param[in] fd file descriptor of socket |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 2012 | * \returns string identifying the connection of this socket, talloc'd from ctx. |
Harald Welte | 48f5583 | 2017-01-26 00:03:10 +0100 | [diff] [blame] | 2013 | */ |
Harald Welte | c0dfc9d | 2019-03-18 18:29:43 +0100 | [diff] [blame] | 2014 | char *osmo_sock_get_name(const void *ctx, int fd) |
Harald Welte | 48f5583 | 2017-01-26 00:03:10 +0100 | [diff] [blame] | 2015 | { |
Philipp Maier | 64b51eb | 2019-01-14 11:59:11 +0100 | [diff] [blame] | 2016 | char str[OSMO_SOCK_NAME_MAXLEN]; |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 2017 | int rc; |
| 2018 | rc = osmo_sock_get_name_buf(str, sizeof(str), fd); |
| 2019 | if (rc <= 0) |
| 2020 | return NULL; |
| 2021 | return talloc_asprintf(ctx, "(%s)", str); |
| 2022 | } |
| 2023 | |
Andreas Eversberg | e8ab1b7 | 2024-02-22 15:38:47 +0100 | [diff] [blame] | 2024 | #ifdef HAVE_LIBSCTP |
Pau Espin Pedrol | 5ac8aa5 | 2023-11-30 19:12:16 +0100 | [diff] [blame] | 2025 | /*! Format multiple IP addresses and/or port number into a combined string buffer |
| 2026 | * \param[out] str Destination string buffer. |
Pau Espin Pedrol | a37921a | 2023-12-12 14:00:10 +0100 | [diff] [blame] | 2027 | * \param[in] str_len sizeof(str), usually OSMO_SOCK_MULTIADDR_PEER_STR_MAXLEN. |
Pau Espin Pedrol | 5ac8aa5 | 2023-11-30 19:12:16 +0100 | [diff] [blame] | 2028 | * \param[out] ip Pointer to memory holding ip_cnt consecutive buffers of size ip_len. |
| 2029 | * \param[out] ip_cnt length ip array pointer. on return it contains the number of addresses found. |
| 2030 | * \param[in] ip_len length of each of the string buffer in the the ip array. |
| 2031 | * \param[out] port number (will be printed in when not NULL). |
| 2032 | * \return String length as returned by snprintf(), or negative on error. |
| 2033 | * |
Pau Espin Pedrol | a37921a | 2023-12-12 14:00:10 +0100 | [diff] [blame] | 2034 | * This API expects an ip array as the one filled in by |
Pau Espin Pedrol | 5ac8aa5 | 2023-11-30 19:12:16 +0100 | [diff] [blame] | 2035 | * osmo_sock_multiaddr_get_ip_and_port(), and hence it's a good companion for |
| 2036 | * that API. |
| 2037 | */ |
| 2038 | int osmo_multiaddr_ip_and_port_snprintf(char *str, size_t str_len, |
| 2039 | const char *ip, size_t ip_cnt, size_t ip_len, |
| 2040 | const char *portbuf) |
| 2041 | { |
| 2042 | struct osmo_strbuf sb = { .buf = str, .len = str_len }; |
| 2043 | bool is_v6 = false; |
| 2044 | unsigned int i; |
| 2045 | |
| 2046 | if (ip_cnt == 0) { |
| 2047 | OSMO_STRBUF_PRINTF(sb, "NULL:%s", portbuf); |
| 2048 | return sb.chars_needed; |
| 2049 | } |
| 2050 | if (ip_cnt > 1) |
| 2051 | OSMO_STRBUF_PRINTF(sb, "("); |
| 2052 | else if ((is_v6 = !!strchr(&ip[0], ':'))) /* IPv6, add [] to separate from port. */ |
| 2053 | OSMO_STRBUF_PRINTF(sb, "["); |
| 2054 | |
| 2055 | for (i = 0; i < ip_cnt - 1; i++) |
| 2056 | OSMO_STRBUF_PRINTF(sb, "%s|", &ip[i * ip_len]); |
| 2057 | OSMO_STRBUF_PRINTF(sb, "%s", &ip[i * ip_len]); |
| 2058 | |
| 2059 | if (ip_cnt > 1) |
| 2060 | OSMO_STRBUF_PRINTF(sb, ")"); |
| 2061 | else if (is_v6) |
| 2062 | OSMO_STRBUF_PRINTF(sb, "]"); |
| 2063 | if (portbuf) |
| 2064 | OSMO_STRBUF_PRINTF(sb, ":%s", portbuf); |
| 2065 | |
| 2066 | return sb.chars_needed; |
| 2067 | } |
| 2068 | |
| 2069 | /*! Get address/port information on socket in provided string buffer, like "r=1.2.3.4:5<->l=6.7.8.9:10". |
| 2070 | * This does not include braces like osmo_sock_get_name(). |
| 2071 | * \param[out] str Destination string buffer. |
Pau Espin Pedrol | a37921a | 2023-12-12 14:00:10 +0100 | [diff] [blame] | 2072 | * \param[in] str_len sizeof(str), usually OSMO_SOCK_MULTIADDR_NAME_MAXLEN. |
Pau Espin Pedrol | 5ac8aa5 | 2023-11-30 19:12:16 +0100 | [diff] [blame] | 2073 | * \param[in] fd File descriptor of socket. |
| 2074 | * \param[in] fd IPPROTO of the socket, eg: IPPROTO_SCTP. |
| 2075 | * \return String length as returned by snprintf(), or negative on error. |
| 2076 | */ |
| 2077 | int osmo_sock_multiaddr_get_name_buf(char *str, size_t str_len, int fd, int sk_proto) |
| 2078 | { |
| 2079 | char hostbuf[OSMO_SOCK_MAX_ADDRS][INET6_ADDRSTRLEN]; |
| 2080 | size_t num_hostbuf = ARRAY_SIZE(hostbuf); |
| 2081 | char portbuf[6]; |
| 2082 | struct osmo_strbuf sb = { .buf = str, .len = str_len }; |
| 2083 | |
| 2084 | if (fd < 0) { |
| 2085 | osmo_strlcpy(str, "<error-bad-fd>", str_len); |
| 2086 | return sb.chars_needed; |
| 2087 | } |
| 2088 | |
| 2089 | switch (sk_proto) { |
| 2090 | case IPPROTO_SCTP: |
| 2091 | break; /* continue below */ |
| 2092 | default: |
| 2093 | return osmo_sock_get_name_buf(str, str_len, fd); |
| 2094 | } |
| 2095 | |
| 2096 | /* get remote */ |
| 2097 | OSMO_STRBUF_PRINTF(sb, "r="); |
| 2098 | if (osmo_sock_multiaddr_get_ip_and_port(fd, sk_proto, &hostbuf[0][0], &num_hostbuf, |
| 2099 | sizeof(hostbuf[0]), portbuf, sizeof(portbuf), false) != 0) { |
| 2100 | OSMO_STRBUF_PRINTF(sb, "NULL"); |
| 2101 | } else { |
| 2102 | const bool need_more_bufs = num_hostbuf > ARRAY_SIZE(hostbuf); |
| 2103 | if (need_more_bufs) |
| 2104 | num_hostbuf = ARRAY_SIZE(hostbuf); |
| 2105 | OSMO_STRBUF_APPEND(sb, osmo_multiaddr_ip_and_port_snprintf, |
| 2106 | &hostbuf[0][0], num_hostbuf, sizeof(hostbuf[0]), portbuf); |
| 2107 | if (need_more_bufs) |
| 2108 | OSMO_STRBUF_PRINTF(sb, "<need-more-bufs!>"); |
| 2109 | } |
| 2110 | |
| 2111 | OSMO_STRBUF_PRINTF(sb, "<->l="); |
| 2112 | |
| 2113 | /* get local */ |
| 2114 | num_hostbuf = ARRAY_SIZE(hostbuf); |
| 2115 | if (osmo_sock_multiaddr_get_ip_and_port(fd, sk_proto, &hostbuf[0][0], &num_hostbuf, |
| 2116 | sizeof(hostbuf[0]), portbuf, sizeof(portbuf), true) != 0) { |
| 2117 | OSMO_STRBUF_PRINTF(sb, "NULL"); |
| 2118 | } else { |
| 2119 | const bool need_more_bufs = num_hostbuf > ARRAY_SIZE(hostbuf); |
| 2120 | if (need_more_bufs) |
| 2121 | num_hostbuf = ARRAY_SIZE(hostbuf); |
| 2122 | OSMO_STRBUF_APPEND(sb, osmo_multiaddr_ip_and_port_snprintf, |
| 2123 | &hostbuf[0][0], num_hostbuf, sizeof(hostbuf[0]), portbuf); |
| 2124 | if (need_more_bufs) |
| 2125 | OSMO_STRBUF_PRINTF(sb, "<need-more-bufs!>"); |
| 2126 | } |
| 2127 | |
| 2128 | return sb.chars_needed; |
| 2129 | } |
Andreas Eversberg | e8ab1b7 | 2024-02-22 15:38:47 +0100 | [diff] [blame] | 2130 | #endif |
Pau Espin Pedrol | 5ac8aa5 | 2023-11-30 19:12:16 +0100 | [diff] [blame] | 2131 | |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 2132 | /*! Get address/port information on socket in provided string buffer, like "r=1.2.3.4:5<->l=6.7.8.9:10". |
| 2133 | * This does not include braces like osmo_sock_get_name(). |
| 2134 | * \param[out] str Destination string buffer. |
| 2135 | * \param[in] str_len sizeof(str). |
| 2136 | * \param[in] fd File descriptor of socket. |
| 2137 | * \return String length as returned by snprintf(), or negative on error. |
| 2138 | */ |
| 2139 | int osmo_sock_get_name_buf(char *str, size_t str_len, int fd) |
| 2140 | { |
Pau Espin Pedrol | 9a7b2c9 | 2024-03-12 13:05:31 +0100 | [diff] [blame] | 2141 | struct osmo_strbuf sb = { .buf = str, .len = str_len }; |
| 2142 | struct osmo_sockaddr osa; |
| 2143 | struct sockaddr_un *sun; |
| 2144 | socklen_t len; |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 2145 | int rc; |
Harald Welte | 48f5583 | 2017-01-26 00:03:10 +0100 | [diff] [blame] | 2146 | |
Daniel Willmann | 7052cc6 | 2023-06-16 09:53:15 +0200 | [diff] [blame] | 2147 | if (fd < 0) { |
| 2148 | osmo_strlcpy(str, "<error-bad-fd>", str_len); |
| 2149 | return -EBADF; |
| 2150 | } |
| 2151 | |
Pau Espin Pedrol | 9a7b2c9 | 2024-03-12 13:05:31 +0100 | [diff] [blame] | 2152 | |
| 2153 | len = sizeof(osa.u.sas); |
| 2154 | rc = getsockname(fd, &osa.u.sa, &len); |
| 2155 | if (rc < 0) { |
Harald Welte | ea9ea52 | 2019-05-10 09:28:24 +0200 | [diff] [blame] | 2156 | osmo_strlcpy(str, "<error-in-getsockname>", str_len); |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 2157 | return rc; |
Harald Welte | ea9ea52 | 2019-05-10 09:28:24 +0200 | [diff] [blame] | 2158 | } |
Harald Welte | 48f5583 | 2017-01-26 00:03:10 +0100 | [diff] [blame] | 2159 | |
Pau Espin Pedrol | 9a7b2c9 | 2024-03-12 13:05:31 +0100 | [diff] [blame] | 2160 | switch (osa.u.sa.sa_family) { |
| 2161 | case AF_INET: |
| 2162 | case AF_INET6: |
Pau Espin Pedrol | c9ad345 | 2024-03-12 14:04:55 +0100 | [diff] [blame] | 2163 | { |
| 2164 | char hostbuf_l[INET6_ADDRSTRLEN], hostbuf_r[INET6_ADDRSTRLEN]; |
| 2165 | char portbuf_l[6], portbuf_r[6]; |
| 2166 | |
Pau Espin Pedrol | 9a7b2c9 | 2024-03-12 13:05:31 +0100 | [diff] [blame] | 2167 | len = sizeof(osa.u.sas); |
| 2168 | rc = getnameinfo(&osa.u.sa, len, hostbuf_l, sizeof(hostbuf_l), |
| 2169 | portbuf_l, sizeof(portbuf_l), |
| 2170 | NI_NUMERICHOST | NI_NUMERICSERV); |
| 2171 | if (rc < 0) { |
| 2172 | osmo_strlcpy(str, "<error-in-getnameinfo>", str_len); |
| 2173 | return rc; |
| 2174 | } |
| 2175 | /* Now attempt to get remote: */ |
| 2176 | len = sizeof(osa.u.sas); |
| 2177 | rc = getpeername(fd, &osa.u.sa, &len); |
| 2178 | if (rc < 0) { |
| 2179 | OSMO_STRBUF_PRINTF(sb, "r=NULL<->l=%s:%s", hostbuf_l, portbuf_l); |
| 2180 | return sb.chars_needed; |
| 2181 | } |
| 2182 | len = sizeof(osa.u.sas); |
| 2183 | rc = getnameinfo(&osa.u.sa, len, hostbuf_r, sizeof(hostbuf_r), |
| 2184 | portbuf_r, sizeof(portbuf_r), |
| 2185 | NI_NUMERICHOST | NI_NUMERICSERV); |
| 2186 | if (rc < 0) { |
| 2187 | OSMO_STRBUF_PRINTF(sb, "r=NULL<->l=%s:%s", hostbuf_l, portbuf_l); |
| 2188 | return sb.chars_needed; |
| 2189 | } |
| 2190 | OSMO_STRBUF_PRINTF(sb, "r=%s:%s<->l=%s:%s", hostbuf_r, portbuf_r, hostbuf_l, portbuf_l); |
| 2191 | return sb.chars_needed; |
Pau Espin Pedrol | c9ad345 | 2024-03-12 14:04:55 +0100 | [diff] [blame] | 2192 | } |
Pau Espin Pedrol | 9a7b2c9 | 2024-03-12 13:05:31 +0100 | [diff] [blame] | 2193 | case AF_UNIX: |
Pau Espin Pedrol | c9ad345 | 2024-03-12 14:04:55 +0100 | [diff] [blame] | 2194 | { |
| 2195 | unsigned long long remote_pid; |
| 2196 | bool have_remote_pid; |
| 2197 | #if defined(SO_PEERCRED) |
| 2198 | struct ucred ucred; |
| 2199 | len = sizeof(struct ucred); |
| 2200 | if (getsockopt(fd, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == -1) { |
| 2201 | have_remote_pid = false; |
| 2202 | } else { |
| 2203 | have_remote_pid = true; |
| 2204 | remote_pid = (unsigned long long)ucred.pid; |
| 2205 | } |
| 2206 | #else |
| 2207 | #pragma message "SO_PEERCRED not available" |
| 2208 | have_remote_pid = false; |
| 2209 | #endif |
Pau Espin Pedrol | 9a7b2c9 | 2024-03-12 13:05:31 +0100 | [diff] [blame] | 2210 | /* Make sure sun_path is NULL terminated: */ |
| 2211 | sun = (struct sockaddr_un *)&osa.u.sa; |
| 2212 | sun->sun_path[sizeof(sun->sun_path) - 1] = '\0'; |
Pau Espin Pedrol | c9ad345 | 2024-03-12 14:04:55 +0100 | [diff] [blame] | 2213 | if (have_remote_pid) |
| 2214 | OSMO_STRBUF_PRINTF(sb, "r=%llu<->", remote_pid); |
| 2215 | else |
| 2216 | OSMO_STRBUF_PRINTF(sb, "r=NULL<->"); |
| 2217 | OSMO_STRBUF_PRINTF(sb, "l=%s:%d", sun->sun_path, fd); |
Pau Espin Pedrol | 9a7b2c9 | 2024-03-12 13:05:31 +0100 | [diff] [blame] | 2218 | return sb.chars_needed; |
Pau Espin Pedrol | c9ad345 | 2024-03-12 14:04:55 +0100 | [diff] [blame] | 2219 | } |
Pau Espin Pedrol | 9a7b2c9 | 2024-03-12 13:05:31 +0100 | [diff] [blame] | 2220 | default: |
| 2221 | osmo_strlcpy(str, "<socket-family-no-supported>", str_len); |
| 2222 | return -ENOTSUP; |
| 2223 | } |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 2224 | } |
| 2225 | |
| 2226 | /*! Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10". |
| 2227 | * This does not include braces like osmo_sock_get_name(). |
| 2228 | * \param[in] fd File descriptor of socket. |
| 2229 | * \return Static string buffer containing the result. |
| 2230 | */ |
| 2231 | const char *osmo_sock_get_name2(int fd) |
| 2232 | { |
Harald Welte | 171ef82 | 2019-03-28 10:49:05 +0100 | [diff] [blame] | 2233 | static __thread char str[OSMO_SOCK_NAME_MAXLEN]; |
Neels Hofmeyr | 0145751 | 2018-12-12 01:48:54 +0100 | [diff] [blame] | 2234 | osmo_sock_get_name_buf(str, sizeof(str), fd); |
| 2235 | return str; |
Harald Welte | 48f5583 | 2017-01-26 00:03:10 +0100 | [diff] [blame] | 2236 | } |
| 2237 | |
Harald Welte | 179f357 | 2019-03-18 18:38:47 +0100 | [diff] [blame] | 2238 | /*! Get address/port information on socket in static string, like "r=1.2.3.4:5<->l=6.7.8.9:10". |
| 2239 | * This does not include braces like osmo_sock_get_name(). |
| 2240 | * \param[in] fd File descriptor of socket. |
| 2241 | * \return Static string buffer containing the result. |
| 2242 | */ |
| 2243 | char *osmo_sock_get_name2_c(const void *ctx, int fd) |
| 2244 | { |
| 2245 | char *str = talloc_size(ctx, OSMO_SOCK_NAME_MAXLEN); |
| 2246 | if (!str) |
| 2247 | return NULL; |
Vadim Yanitskiy | 4f619c2 | 2019-04-12 21:48:07 +0700 | [diff] [blame] | 2248 | osmo_sock_get_name_buf(str, OSMO_SOCK_NAME_MAXLEN, fd); |
Harald Welte | 179f357 | 2019-03-18 18:38:47 +0100 | [diff] [blame] | 2249 | return str; |
| 2250 | } |
| 2251 | |
Harald Welte | e30d7e6 | 2017-07-13 16:02:50 +0200 | [diff] [blame] | 2252 | static int sock_get_domain(int fd) |
| 2253 | { |
| 2254 | int domain; |
| 2255 | #ifdef SO_DOMAIN |
| 2256 | socklen_t dom_len = sizeof(domain); |
| 2257 | int rc; |
| 2258 | |
| 2259 | rc = getsockopt(fd, SOL_SOCKET, SO_DOMAIN, &domain, &dom_len); |
| 2260 | if (rc < 0) |
| 2261 | return rc; |
| 2262 | #else |
| 2263 | /* This of course sucks, but what shall we do on OSs like |
| 2264 | * FreeBSD that don't seem to expose a method by which one can |
| 2265 | * learn the address family of a socket? */ |
| 2266 | domain = AF_INET; |
| 2267 | #endif |
| 2268 | return domain; |
| 2269 | } |
| 2270 | |
| 2271 | |
| 2272 | /*! Activate or de-activate local loop-back of transmitted multicast packets |
| 2273 | * \param[in] fd file descriptor of related socket |
| 2274 | * \param[in] enable Enable (true) or disable (false) loop-back |
| 2275 | * \returns 0 on success; negative otherwise */ |
| 2276 | int osmo_sock_mcast_loop_set(int fd, bool enable) |
| 2277 | { |
| 2278 | int domain, loop = 0; |
| 2279 | |
| 2280 | if (enable) |
| 2281 | loop = 1; |
| 2282 | |
| 2283 | domain = sock_get_domain(fd); |
| 2284 | if (domain < 0) |
| 2285 | return domain; |
| 2286 | |
| 2287 | switch (domain) { |
| 2288 | case AF_INET: |
| 2289 | return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop)); |
| 2290 | case AF_INET6: |
| 2291 | return setsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_LOOP, &loop, sizeof(loop)); |
| 2292 | default: |
| 2293 | return -EINVAL; |
| 2294 | } |
| 2295 | } |
| 2296 | |
| 2297 | /*! Set the TTL of outbound multicast packets |
| 2298 | * \param[in] fd file descriptor of related socket |
| 2299 | * \param[in] ttl TTL of to-be-sent multicast packets |
| 2300 | * \returns 0 on success; negative otherwise */ |
| 2301 | int osmo_sock_mcast_ttl_set(int fd, uint8_t ttl) |
| 2302 | { |
| 2303 | int domain, ttli = ttl; |
| 2304 | |
| 2305 | domain = sock_get_domain(fd); |
| 2306 | if (domain < 0) |
| 2307 | return domain; |
| 2308 | |
| 2309 | switch (domain) { |
| 2310 | case AF_INET: |
| 2311 | return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_TTL, &ttli, sizeof(ttli)); |
| 2312 | case AF_INET6: |
| 2313 | return setsockopt(fd, IPPROTO_IPV6, IPV6_MULTICAST_HOPS, &ttli, sizeof(ttli)); |
| 2314 | default: |
| 2315 | return -EINVAL; |
| 2316 | } |
| 2317 | } |
| 2318 | |
Harald Welte | 44b9926 | 2020-03-07 14:59:05 +0100 | [diff] [blame] | 2319 | /*! Set the network device to which we should bind the multicast socket |
| 2320 | * \param[in] fd file descriptor of related socket |
| 2321 | * \param[in] ifname name of network interface to user for multicast |
| 2322 | * \returns 0 on success; negative otherwise */ |
| 2323 | int osmo_sock_mcast_iface_set(int fd, const char *ifname) |
| 2324 | { |
| 2325 | unsigned int ifindex; |
| 2326 | struct ip_mreqn mr; |
| 2327 | |
| 2328 | /* first, resolve interface name to ifindex */ |
| 2329 | ifindex = if_nametoindex(ifname); |
| 2330 | if (ifindex == 0) |
| 2331 | return -errno; |
| 2332 | |
| 2333 | /* next, configure kernel to use that ifindex for this sockets multicast traffic */ |
| 2334 | memset(&mr, 0, sizeof(mr)); |
| 2335 | mr.imr_ifindex = ifindex; |
| 2336 | return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_IF, &mr, sizeof(mr)); |
| 2337 | } |
| 2338 | |
| 2339 | |
Harald Welte | e30d7e6 | 2017-07-13 16:02:50 +0200 | [diff] [blame] | 2340 | /*! Enable/disable receiving all multicast packets, even for non-subscribed groups |
| 2341 | * \param[in] fd file descriptor of related socket |
| 2342 | * \param[in] enable Enable or Disable receiving of all packets |
| 2343 | * \returns 0 on success; negative otherwise */ |
| 2344 | int osmo_sock_mcast_all_set(int fd, bool enable) |
| 2345 | { |
| 2346 | int domain, all = 0; |
| 2347 | |
| 2348 | if (enable) |
| 2349 | all = 1; |
| 2350 | |
| 2351 | domain = sock_get_domain(fd); |
| 2352 | if (domain < 0) |
| 2353 | return domain; |
| 2354 | |
| 2355 | switch (domain) { |
| 2356 | case AF_INET: |
| 2357 | #ifdef IP_MULTICAST_ALL |
| 2358 | return setsockopt(fd, IPPROTO_IP, IP_MULTICAST_ALL, &all, sizeof(all)); |
| 2359 | #endif |
| 2360 | case AF_INET6: |
| 2361 | /* there seems no equivalent ?!? */ |
| 2362 | default: |
| 2363 | return -EINVAL; |
| 2364 | } |
| 2365 | } |
| 2366 | |
| 2367 | /* FreeBSD calls the socket option differently */ |
| 2368 | #if !defined(IPV6_ADD_MEMBERSHIP) && defined(IPV6_JOIN_GROUP) |
| 2369 | #define IPV6_ADD_MEMBERSHIP IPV6_JOIN_GROUP |
| 2370 | #endif |
| 2371 | |
| 2372 | /*! Subscribe to the given IP multicast group |
| 2373 | * \param[in] fd file descriptor of related scoket |
| 2374 | * \param[in] grp_addr ASCII representation of the multicast group address |
| 2375 | * \returns 0 on success; negative otherwise */ |
| 2376 | int osmo_sock_mcast_subscribe(int fd, const char *grp_addr) |
| 2377 | { |
| 2378 | int rc, domain; |
| 2379 | struct ip_mreq mreq; |
| 2380 | struct ipv6_mreq mreq6; |
| 2381 | struct in6_addr i6a; |
| 2382 | |
| 2383 | domain = sock_get_domain(fd); |
| 2384 | if (domain < 0) |
| 2385 | return domain; |
| 2386 | |
| 2387 | switch (domain) { |
| 2388 | case AF_INET: |
| 2389 | memset(&mreq, 0, sizeof(mreq)); |
| 2390 | mreq.imr_multiaddr.s_addr = inet_addr(grp_addr); |
| 2391 | mreq.imr_interface.s_addr = htonl(INADDR_ANY); |
| 2392 | return setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP, &mreq, sizeof(mreq)); |
| 2393 | #ifdef IPV6_ADD_MEMBERSHIP |
| 2394 | case AF_INET6: |
| 2395 | memset(&mreq6, 0, sizeof(mreq6)); |
| 2396 | rc = inet_pton(AF_INET6, grp_addr, (void *)&i6a); |
| 2397 | if (rc < 0) |
| 2398 | return -EINVAL; |
| 2399 | mreq6.ipv6mr_multiaddr = i6a; |
| 2400 | return setsockopt(fd, IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, &mreq6, sizeof(mreq6)); |
| 2401 | #endif |
| 2402 | default: |
| 2403 | return -EINVAL; |
| 2404 | } |
| 2405 | } |
| 2406 | |
Philipp Maier | 2d2490e | 2017-10-20 19:41:26 +0200 | [diff] [blame] | 2407 | /*! Determine the matching local IP-address for a given remote IP-Address. |
| 2408 | * \param[out] local_ip caller provided memory for resulting local IP-address |
| 2409 | * \param[in] remote_ip remote IP-address |
Philipp Maier | 2d2490e | 2017-10-20 19:41:26 +0200 | [diff] [blame] | 2410 | * \returns 0 on success; negative otherwise |
| 2411 | * |
| 2412 | * The function accepts IPv4 and IPv6 address strings. The caller must provide |
| 2413 | * at least INET6_ADDRSTRLEN bytes for local_ip if an IPv6 is expected as |
| 2414 | * as result. For IPv4 addresses the required amount is INET_ADDRSTRLEN. */ |
| 2415 | int osmo_sock_local_ip(char *local_ip, const char *remote_ip) |
| 2416 | { |
| 2417 | int sfd; |
| 2418 | int rc; |
| 2419 | struct addrinfo addrinfo_hint; |
| 2420 | struct addrinfo *addrinfo = NULL; |
Pau Espin Pedrol | 81e7a6c | 2020-08-28 20:44:26 +0200 | [diff] [blame] | 2421 | struct sockaddr_storage local_addr; |
| 2422 | struct sockaddr_in *sin; |
| 2423 | struct sockaddr_in6 *sin6; |
Philipp Maier | 2d2490e | 2017-10-20 19:41:26 +0200 | [diff] [blame] | 2424 | socklen_t local_addr_len; |
| 2425 | uint16_t family; |
| 2426 | |
| 2427 | /* Find out the address family (AF_INET or AF_INET6?) */ |
| 2428 | memset(&addrinfo_hint, '\0', sizeof(addrinfo_hint)); |
Pau Espin Pedrol | 308ab79 | 2020-08-28 19:47:25 +0200 | [diff] [blame] | 2429 | addrinfo_hint.ai_family = AF_UNSPEC; |
Philipp Maier | 2d2490e | 2017-10-20 19:41:26 +0200 | [diff] [blame] | 2430 | addrinfo_hint.ai_flags = AI_NUMERICHOST; |
| 2431 | rc = getaddrinfo(remote_ip, NULL, &addrinfo_hint, &addrinfo); |
| 2432 | if (rc) |
| 2433 | return -EINVAL; |
| 2434 | family = addrinfo->ai_family; |
| 2435 | freeaddrinfo(addrinfo); |
| 2436 | |
| 2437 | /* Connect a dummy socket to trick the kernel into determining the |
| 2438 | * ip-address of the interface that would be used if we would send |
| 2439 | * out an actual packet */ |
| 2440 | sfd = osmo_sock_init2(family, SOCK_DGRAM, IPPROTO_UDP, NULL, 0, remote_ip, 0, OSMO_SOCK_F_CONNECT); |
| 2441 | if (sfd < 0) |
| 2442 | return -EINVAL; |
| 2443 | |
| 2444 | /* Request the IP address of the interface that the kernel has |
| 2445 | * actually choosen. */ |
| 2446 | memset(&local_addr, 0, sizeof(local_addr)); |
| 2447 | local_addr_len = sizeof(local_addr); |
| 2448 | rc = getsockname(sfd, (struct sockaddr *)&local_addr, &local_addr_len); |
Philipp Maier | 8b7975b | 2018-01-22 15:38:07 +0100 | [diff] [blame] | 2449 | close(sfd); |
Philipp Maier | 2d2490e | 2017-10-20 19:41:26 +0200 | [diff] [blame] | 2450 | if (rc < 0) |
| 2451 | return -EINVAL; |
Pau Espin Pedrol | 81e7a6c | 2020-08-28 20:44:26 +0200 | [diff] [blame] | 2452 | |
| 2453 | switch (local_addr.ss_family) { |
| 2454 | case AF_INET: |
| 2455 | sin = (struct sockaddr_in*)&local_addr; |
| 2456 | if (!inet_ntop(AF_INET, &sin->sin_addr, local_ip, INET_ADDRSTRLEN)) |
| 2457 | return -EINVAL; |
| 2458 | break; |
| 2459 | case AF_INET6: |
| 2460 | sin6 = (struct sockaddr_in6*)&local_addr; |
Pau Espin Pedrol | 7bda854 | 2020-08-31 11:21:30 +0200 | [diff] [blame] | 2461 | if (!inet_ntop(AF_INET6, &sin6->sin6_addr, local_ip, INET6_ADDRSTRLEN)) |
Pau Espin Pedrol | 81e7a6c | 2020-08-28 20:44:26 +0200 | [diff] [blame] | 2462 | return -EINVAL; |
| 2463 | break; |
| 2464 | default: |
Philipp Maier | 2d2490e | 2017-10-20 19:41:26 +0200 | [diff] [blame] | 2465 | return -EINVAL; |
Pau Espin Pedrol | 81e7a6c | 2020-08-28 20:44:26 +0200 | [diff] [blame] | 2466 | } |
Philipp Maier | 2d2490e | 2017-10-20 19:41:26 +0200 | [diff] [blame] | 2467 | |
| 2468 | return 0; |
| 2469 | } |
| 2470 | |
Alexander Couzens | 0f36421 | 2020-07-27 22:33:01 +0200 | [diff] [blame] | 2471 | /*! Determine the matching local address for a given remote address. |
| 2472 | * \param[out] local_ip caller provided memory for resulting local address |
| 2473 | * \param[in] remote_ip remote address |
| 2474 | * \returns 0 on success; negative otherwise |
| 2475 | */ |
| 2476 | int osmo_sockaddr_local_ip(struct osmo_sockaddr *local_ip, const struct osmo_sockaddr *remote_ip) |
| 2477 | { |
| 2478 | int sfd; |
| 2479 | int rc; |
| 2480 | socklen_t local_ip_len; |
| 2481 | |
| 2482 | sfd = osmo_sock_init_osa(SOCK_DGRAM, IPPROTO_UDP, NULL, remote_ip, OSMO_SOCK_F_CONNECT); |
| 2483 | if (sfd < 0) |
| 2484 | return -EINVAL; |
| 2485 | |
| 2486 | memset(local_ip, 0, sizeof(*local_ip)); |
| 2487 | local_ip_len = sizeof(*local_ip); |
| 2488 | rc = getsockname(sfd, (struct sockaddr *)local_ip, &local_ip_len); |
| 2489 | close(sfd); |
| 2490 | |
| 2491 | return rc; |
| 2492 | } |
| 2493 | |
Neels Hofmeyr | cf7f792 | 2022-02-02 03:08:40 +0100 | [diff] [blame] | 2494 | /*! Copy the addr part, the IP address octets in network byte order, to a buffer. |
| 2495 | * Useful for encoding network protocols. |
| 2496 | * \param[out] dst Write octets to this buffer. |
| 2497 | * \param[in] dst_maxlen Space available in buffer. |
| 2498 | * \param[in] os Sockaddr to copy IP of. |
| 2499 | * \return nr of octets written on success, negative on error. |
| 2500 | */ |
| 2501 | int osmo_sockaddr_to_octets(uint8_t *dst, size_t dst_maxlen, const struct osmo_sockaddr *os) |
| 2502 | { |
| 2503 | const void *addr; |
| 2504 | size_t len; |
Neels Hofmeyr | 1790f17 | 2022-02-02 03:08:40 +0100 | [diff] [blame] | 2505 | switch (os->u.sa.sa_family) { |
Neels Hofmeyr | cf7f792 | 2022-02-02 03:08:40 +0100 | [diff] [blame] | 2506 | case AF_INET: |
| 2507 | addr = &os->u.sin.sin_addr; |
| 2508 | len = sizeof(os->u.sin.sin_addr); |
| 2509 | break; |
| 2510 | case AF_INET6: |
| 2511 | addr = &os->u.sin6.sin6_addr; |
| 2512 | len = sizeof(os->u.sin6.sin6_addr); |
| 2513 | break; |
| 2514 | default: |
| 2515 | return -ENOTSUP; |
| 2516 | } |
| 2517 | if (dst_maxlen < len) |
| 2518 | return -ENOSPC; |
| 2519 | memcpy(dst, addr, len); |
| 2520 | return len; |
| 2521 | } |
| 2522 | |
| 2523 | /*! Copy the addr part, the IP address octets in network byte order, from a buffer. |
| 2524 | * Useful for decoding network protocols. |
| 2525 | * \param[out] os Write IP address to this sockaddr. |
| 2526 | * \param[in] src Source buffer to read IP address octets from. |
| 2527 | * \param[in] src_len Number of octets to copy. |
| 2528 | * \return number of octets read on success, negative on error. |
| 2529 | */ |
| 2530 | int osmo_sockaddr_from_octets(struct osmo_sockaddr *os, const void *src, size_t src_len) |
| 2531 | { |
| 2532 | void *addr; |
| 2533 | size_t len; |
| 2534 | *os = (struct osmo_sockaddr){0}; |
| 2535 | switch (src_len) { |
| 2536 | case sizeof(os->u.sin.sin_addr): |
Neels Hofmeyr | 1790f17 | 2022-02-02 03:08:40 +0100 | [diff] [blame] | 2537 | os->u.sa.sa_family = AF_INET; |
Neels Hofmeyr | cf7f792 | 2022-02-02 03:08:40 +0100 | [diff] [blame] | 2538 | addr = &os->u.sin.sin_addr; |
| 2539 | len = sizeof(os->u.sin.sin_addr); |
| 2540 | break; |
| 2541 | case sizeof(os->u.sin6.sin6_addr): |
| 2542 | os->u.sin6.sin6_family = AF_INET6; |
| 2543 | addr = &os->u.sin6.sin6_addr; |
| 2544 | len = sizeof(os->u.sin6.sin6_addr); |
| 2545 | break; |
| 2546 | default: |
| 2547 | return -ENOTSUP; |
| 2548 | } |
| 2549 | memcpy(addr, src, len); |
| 2550 | return len; |
| 2551 | } |
| 2552 | |
Alexander Couzens | e4181ea | 2020-07-20 00:03:16 +0200 | [diff] [blame] | 2553 | /*! Compare two osmo_sockaddr. |
| 2554 | * \param[in] a |
| 2555 | * \param[in] b |
| 2556 | * \return 0 if a and b are equal. Otherwise it follows memcmp() |
| 2557 | */ |
Vadim Yanitskiy | def5a40 | 2020-10-09 21:40:47 +0700 | [diff] [blame] | 2558 | int osmo_sockaddr_cmp(const struct osmo_sockaddr *a, |
| 2559 | const struct osmo_sockaddr *b) |
Alexander Couzens | e4181ea | 2020-07-20 00:03:16 +0200 | [diff] [blame] | 2560 | { |
| 2561 | if (a == b) |
| 2562 | return 0; |
| 2563 | if (!a) |
| 2564 | return 1; |
| 2565 | if (!b) |
| 2566 | return -1; |
| 2567 | |
| 2568 | if (a->u.sa.sa_family != b->u.sa.sa_family) { |
| 2569 | return OSMO_CMP(a->u.sa.sa_family, b->u.sa.sa_family); |
| 2570 | } |
| 2571 | |
| 2572 | switch (a->u.sa.sa_family) { |
| 2573 | case AF_INET: |
| 2574 | return memcmp(&a->u.sin, &b->u.sin, sizeof(struct sockaddr_in)); |
| 2575 | case AF_INET6: |
| 2576 | return memcmp(&a->u.sin6, &b->u.sin6, sizeof(struct sockaddr_in6)); |
| 2577 | default: |
| 2578 | /* fallback to memcmp for remaining AF over the full osmo_sockaddr length */ |
| 2579 | return memcmp(a, b, sizeof(struct osmo_sockaddr)); |
| 2580 | } |
| 2581 | } |
| 2582 | |
Alexander Couzens | 80788fa | 2020-10-12 01:11:20 +0200 | [diff] [blame] | 2583 | /*! string-format a given osmo_sockaddr address |
| 2584 | * \param[in] sockaddr the osmo_sockaddr to print |
| 2585 | * \return pointer to the string on success; NULL on error |
| 2586 | */ |
| 2587 | const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *sockaddr) |
| 2588 | { |
| 2589 | /* INET6_ADDRSTRLEN contains already a null termination, |
| 2590 | * adding '[' ']' ':' '16 bit port' */ |
| 2591 | static __thread char buf[INET6_ADDRSTRLEN + 8]; |
| 2592 | return osmo_sockaddr_to_str_buf(buf, sizeof(buf), sockaddr); |
| 2593 | } |
| 2594 | |
Neels Hofmeyr | 09d6574 | 2021-12-01 10:25:02 +0100 | [diff] [blame] | 2595 | /*! string-format a given osmo_sockaddr address into a user-supplied buffer. |
| 2596 | * Same as osmo_sockaddr_to_str_buf() but returns a would-be length in snprintf() style. |
| 2597 | * \param[in] buf user-supplied output buffer |
| 2598 | * \param[in] buf_len size of the user-supplied output buffer in bytes |
| 2599 | * \param[in] sockaddr the osmo_sockaddr to print |
| 2600 | * \return number of characters that would be written if the buffer is large enough, like snprintf(). |
| 2601 | */ |
| 2602 | int osmo_sockaddr_to_str_buf2(char *buf, size_t buf_len, const struct osmo_sockaddr *sockaddr) |
| 2603 | { |
| 2604 | struct osmo_strbuf sb = { .buf = buf, .len = buf_len }; |
| 2605 | uint16_t port = 0; |
| 2606 | |
| 2607 | if (!sockaddr) { |
| 2608 | OSMO_STRBUF_PRINTF(sb, "NULL"); |
| 2609 | return sb.chars_needed; |
| 2610 | } |
| 2611 | |
| 2612 | switch (sockaddr->u.sa.sa_family) { |
| 2613 | case AF_INET: |
| 2614 | OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_and_uint, &port, &sockaddr->u.sa); |
| 2615 | if (port) |
| 2616 | OSMO_STRBUF_PRINTF(sb, ":%u", port); |
| 2617 | break; |
| 2618 | case AF_INET6: |
| 2619 | OSMO_STRBUF_PRINTF(sb, "["); |
| 2620 | OSMO_STRBUF_APPEND(sb, osmo_sockaddr_to_str_and_uint, &port, &sockaddr->u.sa); |
| 2621 | OSMO_STRBUF_PRINTF(sb, "]"); |
| 2622 | if (port) |
| 2623 | OSMO_STRBUF_PRINTF(sb, ":%u", port); |
| 2624 | break; |
| 2625 | default: |
| 2626 | OSMO_STRBUF_PRINTF(sb, "unsupported family %d", sockaddr->u.sa.sa_family); |
| 2627 | break; |
| 2628 | } |
| 2629 | |
| 2630 | return sb.chars_needed; |
| 2631 | } |
| 2632 | |
| 2633 | /*! string-format a given osmo_sockaddr address into a talloc allocated buffer. |
| 2634 | * Like osmo_sockaddr_to_str_buf2() but returns a talloc allocated string. |
| 2635 | * \param[in] ctx talloc context to allocate from, e.g. OTC_SELECT. |
| 2636 | * \param[in] sockaddr the osmo_sockaddr to print. |
| 2637 | * \return human readable string. |
| 2638 | */ |
| 2639 | char *osmo_sockaddr_to_str_c(void *ctx, const struct osmo_sockaddr *sockaddr) |
| 2640 | { |
| 2641 | OSMO_NAME_C_IMPL(ctx, 64, "ERROR", osmo_sockaddr_to_str_buf2, sockaddr) |
| 2642 | } |
| 2643 | |
| 2644 | /*! string-format a given osmo_sockaddr address into a user-supplied buffer. |
| 2645 | * Like osmo_sockaddr_to_str_buf2() but returns buf, or NULL if too short. |
Alexander Couzens | 80788fa | 2020-10-12 01:11:20 +0200 | [diff] [blame] | 2646 | * \param[in] buf user-supplied output buffer |
| 2647 | * \param[in] buf_len size of the user-supplied output buffer in bytes |
| 2648 | * \param[in] sockaddr the osmo_sockaddr to print |
| 2649 | * \return pointer to the string on success; NULL on error |
| 2650 | */ |
| 2651 | char *osmo_sockaddr_to_str_buf(char *buf, size_t buf_len, |
| 2652 | const struct osmo_sockaddr *sockaddr) |
| 2653 | { |
Neels Hofmeyr | 09d6574 | 2021-12-01 10:25:02 +0100 | [diff] [blame] | 2654 | int chars_needed = osmo_sockaddr_to_str_buf2(buf, buf_len, sockaddr); |
| 2655 | if (chars_needed >= buf_len) |
Alexander Couzens | 80788fa | 2020-10-12 01:11:20 +0200 | [diff] [blame] | 2656 | return NULL; |
Alexander Couzens | 80788fa | 2020-10-12 01:11:20 +0200 | [diff] [blame] | 2657 | return buf; |
| 2658 | } |
| 2659 | |
Harald Welte | ce53e03 | 2021-04-27 21:44:34 +0200 | [diff] [blame] | 2660 | /*! Set the DSCP (differentiated services code point) of a socket. |
| 2661 | * \param[in] dscp DSCP value in range 0..63 |
| 2662 | * \returns 0 on success; negative on error. */ |
| 2663 | int osmo_sock_set_dscp(int fd, uint8_t dscp) |
| 2664 | { |
Harald Welte | 903e670 | 2021-04-28 13:27:12 +0200 | [diff] [blame] | 2665 | struct sockaddr_storage local_addr; |
| 2666 | socklen_t local_addr_len = sizeof(local_addr); |
Harald Welte | ce53e03 | 2021-04-27 21:44:34 +0200 | [diff] [blame] | 2667 | uint8_t tos; |
| 2668 | socklen_t tos_len = sizeof(tos); |
Harald Welte | 903e670 | 2021-04-28 13:27:12 +0200 | [diff] [blame] | 2669 | int tclass; |
| 2670 | socklen_t tclass_len = sizeof(tclass); |
Harald Welte | ce53e03 | 2021-04-27 21:44:34 +0200 | [diff] [blame] | 2671 | int rc; |
| 2672 | |
| 2673 | /* DSCP is a 6-bit value stored in the upper 6 bits of the 8-bit TOS */ |
| 2674 | if (dscp > 63) |
| 2675 | return -EINVAL; |
| 2676 | |
Harald Welte | 903e670 | 2021-04-28 13:27:12 +0200 | [diff] [blame] | 2677 | rc = getsockname(fd, (struct sockaddr *)&local_addr, &local_addr_len); |
Harald Welte | ce53e03 | 2021-04-27 21:44:34 +0200 | [diff] [blame] | 2678 | if (rc < 0) |
| 2679 | return rc; |
| 2680 | |
Harald Welte | 903e670 | 2021-04-28 13:27:12 +0200 | [diff] [blame] | 2681 | switch (local_addr.ss_family) { |
| 2682 | case AF_INET: |
| 2683 | /* read the original value */ |
| 2684 | rc = getsockopt(fd, IPPROTO_IP, IP_TOS, &tos, &tos_len); |
| 2685 | if (rc < 0) |
| 2686 | return rc; |
| 2687 | /* mask-in the DSCP into the upper 6 bits */ |
| 2688 | tos &= 0x03; |
| 2689 | tos |= dscp << 2; |
| 2690 | /* and write it back to the kernel */ |
| 2691 | rc = setsockopt(fd, IPPROTO_IP, IP_TOS, &tos, sizeof(tos)); |
| 2692 | break; |
| 2693 | case AF_INET6: |
| 2694 | /* read the original value */ |
| 2695 | rc = getsockopt(fd, IPPROTO_IPV6, IPV6_TCLASS, &tclass, &tclass_len); |
| 2696 | if (rc < 0) |
| 2697 | return rc; |
| 2698 | /* mask-in the DSCP into the upper 6 bits */ |
| 2699 | tclass &= 0x03; |
| 2700 | tclass |= dscp << 2; |
| 2701 | /* and write it back to the kernel */ |
| 2702 | rc = setsockopt(fd, IPPROTO_IPV6, IPV6_TCLASS, &tclass, sizeof(tclass)); |
| 2703 | break; |
| 2704 | case AF_UNSPEC: |
| 2705 | default: |
| 2706 | LOGP(DLGLOBAL, LOGL_ERROR, "No DSCP support for socket family %u\n", |
| 2707 | local_addr.ss_family); |
| 2708 | rc = -1; |
| 2709 | break; |
| 2710 | } |
Harald Welte | ce53e03 | 2021-04-27 21:44:34 +0200 | [diff] [blame] | 2711 | |
Harald Welte | 903e670 | 2021-04-28 13:27:12 +0200 | [diff] [blame] | 2712 | return rc; |
Harald Welte | ce53e03 | 2021-04-27 21:44:34 +0200 | [diff] [blame] | 2713 | } |
| 2714 | |
Harald Welte | ecc0bd8 | 2021-04-27 22:24:08 +0200 | [diff] [blame] | 2715 | /*! Set the priority value of a socket. |
| 2716 | * \param[in] prio priority value. Values outside 0..6 require CAP_NET_ADMIN. |
| 2717 | * \returns 0 on success; negative on error. */ |
| 2718 | int osmo_sock_set_priority(int fd, int prio) |
| 2719 | { |
| 2720 | /* and write it back to the kernel */ |
| 2721 | return setsockopt(fd, SOL_SOCKET, SO_PRIORITY, &prio, sizeof(prio)); |
| 2722 | } |
Alexander Couzens | 80788fa | 2020-10-12 01:11:20 +0200 | [diff] [blame] | 2723 | |
Pau Espin Pedrol | 19f27bb | 2023-12-08 14:58:51 +0100 | [diff] [blame] | 2724 | #ifdef HAVE_LIBSCTP |
| 2725 | /*! Fill in array of struct sctp_paddrinfo with each of the remote addresses of an SCTP socket |
| 2726 | * \param[in] fd file descriptor of SCTP socket |
| 2727 | * \param[out] pinfo Pointer to memory holding an array of struct sctp_paddrinfo (pinfo_cnt length). |
| 2728 | * \param[in,out] pinfo_cnt length of pinfo array (in elements). On return it contains the number of addresses found. |
| 2729 | * \returns 0 on success; negative otherwise |
| 2730 | * |
| 2731 | * Upon return, pinfo_cnt can be set to a higher value than the one set by the |
| 2732 | * caller. This can be used by the caller to find out the required array length |
| 2733 | * and then obtaining by calling the function twice. Only up to pinfo_cnt addresses |
| 2734 | * are filled in, as per the value provided by the caller. |
| 2735 | * |
| 2736 | * Usage example retrieving struct sctp_paddrinfo for all (up to OSMO_SOCK_MAX_ADDRS, 32) remote IP addresses: |
| 2737 | * struct sctp_paddrinfo pinfo[OSMO_SOCK_MAX_ADDRS]; |
| 2738 | * size_t pinfo_cnt = ARRAY_SIZE(pinfo); |
| 2739 | * rc = osmo_sock_sctp_get_peer_addr_info(fd, &pinfo[0], &num_hostbuf, pinfo_cnt); |
| 2740 | * if (rc < 0) |
| 2741 | * goto error; |
| 2742 | * if (pinfo_cnt > ARRAY_SIZE(hostbuf)) |
| 2743 | * goto not_enough_buffers; |
| 2744 | */ |
| 2745 | int osmo_sock_sctp_get_peer_addr_info(int fd, struct sctp_paddrinfo *pinfo, size_t *pinfo_cnt) |
| 2746 | { |
| 2747 | struct sockaddr *addrs = NULL; |
| 2748 | unsigned int n_addrs, i; |
| 2749 | void *addr_buf; |
| 2750 | int rc; |
| 2751 | socklen_t optlen; |
| 2752 | |
| 2753 | rc = sctp_getpaddrs(fd, 0, &addrs); |
| 2754 | |
| 2755 | if (rc < 0) |
| 2756 | return rc; |
| 2757 | if (rc == 0) |
| 2758 | return -ENOTCONN; |
| 2759 | |
| 2760 | n_addrs = rc; |
| 2761 | addr_buf = (void *)addrs; |
| 2762 | for (i = 0; i < n_addrs; i++) { |
| 2763 | struct sockaddr *sa_addr = (struct sockaddr *)addr_buf; |
| 2764 | size_t addrlen; |
| 2765 | |
| 2766 | switch (sa_addr->sa_family) { |
| 2767 | case AF_INET: |
| 2768 | addrlen = sizeof(struct sockaddr_in); |
| 2769 | break; |
| 2770 | case AF_INET6: |
| 2771 | addrlen = sizeof(struct sockaddr_in6); |
| 2772 | break; |
| 2773 | default: |
| 2774 | rc = -EINVAL; |
| 2775 | goto free_addrs_ret; |
| 2776 | } |
| 2777 | |
| 2778 | if (i >= *pinfo_cnt) { |
| 2779 | addr_buf += addrlen; |
| 2780 | continue; |
| 2781 | } |
| 2782 | |
| 2783 | memset(&pinfo[i], 0, sizeof(pinfo[0])); |
| 2784 | memcpy(&pinfo[i].spinfo_address, sa_addr, addrlen); |
| 2785 | optlen = sizeof(pinfo[0]); |
| 2786 | rc = getsockopt(fd, SOL_SCTP, SCTP_GET_PEER_ADDR_INFO, &pinfo[i], &optlen); |
| 2787 | if (rc < 0) |
| 2788 | goto free_addrs_ret; |
| 2789 | |
| 2790 | addr_buf += addrlen; |
| 2791 | } |
| 2792 | |
| 2793 | *pinfo_cnt = n_addrs; |
| 2794 | rc = 0; |
| 2795 | free_addrs_ret: |
| 2796 | sctp_freepaddrs(addrs); |
| 2797 | return rc; |
| 2798 | } |
| 2799 | #endif |
| 2800 | |
Harald Welte | e476442 | 2011-05-22 12:25:57 +0200 | [diff] [blame] | 2801 | #endif /* HAVE_SYS_SOCKET_H */ |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 2802 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 2803 | /*! @} */ |