19#if defined(__linux__) && !defined(_GNU_SOURCE)
22#if defined(__APPLE__) && !defined(__APPLE_USE_RFC_3542)
23#define __APPLE_USE_RFC_3542
29#include <winpr/assert.h>
30#include <winpr/cast.h>
31#include <winpr/winsock.h>
34#if defined(_WIN32) && !defined(SIO_UDP_CONNRESET)
35#define SIO_UDP_CONNRESET _WSAIOW(IOC_VENDOR, 12)
37#if defined(_WIN32) && !defined(SIO_UDP_NETRESET)
38#define SIO_UDP_NETRESET _WSAIOW(IOC_VENDOR, 15)
44#include <sys/socket.h>
46#include <netinet/in.h>
52#if !defined(_WIN32) && defined(IP_PKTINFO) && !defined(__NetBSD__)
53#define UDPLISTENER_LOCAL_ADDRESS_IPV4
55#if !defined(_WIN32) && defined(IPV6_RECVPKTINFO) && defined(IPV6_PKTINFO)
56#define UDPLISTENER_LOCAL_ADDRESS_IPV6
59#if defined(_WIN32) && !defined(WSA_FLAG_NO_HANDLE_INHERIT)
60#define WSA_FLAG_NO_HANDLE_INHERIT 0x80
63#include <freerdp/log.h>
65#include "udplistener_internal.h"
67#define TAG FREERDP_TAG("core.udplistener")
70BOOL udpsocket_address_equal(
const struct sockaddr_storage* a,
const struct sockaddr* b,
75 if ((blen <
sizeof(b->sa_family)) || (a->ss_family != b->sa_family))
77 if (a->ss_family == AF_INET)
79 const struct sockaddr_in* x = WINPR_PACKED_ALIGN_CAST(
const struct sockaddr_in*, a);
80 const struct sockaddr_in* y = WINPR_PACKED_ALIGN_CAST(
const struct sockaddr_in*, b);
81 return (blen >=
sizeof(*y)) && (x->sin_port == y->sin_port) &&
82 (memcmp(&x->sin_addr, &y->sin_addr,
sizeof(x->sin_addr)) == 0);
84 if (a->ss_family == AF_INET6)
86 const struct sockaddr_in6* x = WINPR_PACKED_ALIGN_CAST(
const struct sockaddr_in6*, a);
87 const struct sockaddr_in6* y = WINPR_PACKED_ALIGN_CAST(
const struct sockaddr_in6*, b);
89 return (blen >=
sizeof(*y)) && (x->sin6_port == y->sin6_port) &&
90 (x->sin6_scope_id == y->sin6_scope_id) &&
91 (memcmp(&x->sin6_addr, &y->sin6_addr,
sizeof(x->sin6_addr)) == 0);
96void udpsocket_unmap_address(
const struct sockaddr* addr,
size_t addrlen,
97 struct sockaddr_storage* out,
size_t* outlen)
100 WINPR_ASSERT(addrlen <=
sizeof(*out));
102 memcpy(out, addr, addrlen);
104 if ((addr->sa_family != AF_INET6) || (addrlen <
sizeof(
struct sockaddr_in6)))
106 const struct sockaddr_in6* v6 = WINPR_PACKED_ALIGN_CAST(
const struct sockaddr_in6*, addr);
107 if (!IN6_IS_ADDR_V4MAPPED(&v6->sin6_addr))
110 struct sockaddr_in v4 = WINPR_C_ARRAY_INIT;
111 v4.sin_family = AF_INET;
112 v4.sin_port = v6->sin6_port;
113 memcpy(&v4.sin_addr, &v6->sin6_addr.s6_addr[12],
sizeof(v4.sin_addr));
114 memset(out, 0,
sizeof(*out));
115 memcpy(out, &v4,
sizeof(v4));
116 *outlen =
sizeof(v4);
122void udpsocket_set_no_inherit(SOCKET sockfd)
126 if (!SetHandleInformation((HANDLE)sockfd, HANDLE_FLAG_INHERIT, 0))
127 WLog_WARN(TAG,
"unable to prevent child processes from acquiring a socket");
129 const int flags = fcntl((
int)sockfd, F_GETFD);
130 if ((flags < 0) || (fcntl((
int)sockfd, F_SETFD, flags | FD_CLOEXEC) != 0))
131 WLog_WARN(TAG,
"failed to set close-on-exec for the socket");
137SOCKET udpsocket_new(
int family,
int type,
int protocol)
140 SOCKET sockfd = WSASocketW(family, type, protocol,
nullptr, 0,
141 WSA_FLAG_OVERLAPPED | WSA_FLAG_NO_HANDLE_INHERIT);
143 if ((sockfd == INVALID_SOCKET) && (WSAGetLastError() == WSAEINVAL))
144 sockfd = WSASocketW(family, type, protocol,
nullptr, 0, WSA_FLAG_OVERLAPPED);
146 SOCKET sockfd = _socket(family, type | UDPLISTENER_SOCK_CLOEXEC, protocol);
148 if (sockfd != INVALID_SOCKET)
149 udpsocket_set_no_inherit(sockfd);
153SOCKET udpsocket_bind(
const struct sockaddr* addr,
size_t addrlen)
157 SOCKET sockfd = udpsocket_new(addr->sa_family, SOCK_DGRAM, IPPROTO_UDP);
158 if (sockfd == INVALID_SOCKET)
159 return INVALID_SOCKET;
162 if ((addr->sa_family == AF_INET6) &&
163 (_setsockopt(sockfd, IPPROTO_IPV6, IPV6_V6ONLY, (
const char*)&on,
sizeof(on)) != 0))
164 WLog_WARN(TAG,
"failed to set IPV6_V6ONLY via setsockopt()");
168 if (_setsockopt(sockfd, SOL_SOCKET, SO_EXCLUSIVEADDRUSE, (
const char*)&on,
sizeof(on)) != 0)
171 return INVALID_SOCKET;
178 const UINT32 rcvbuf = UDPLISTENER_RECEIVE_BUFFER;
179 if (_setsockopt(sockfd, SOL_SOCKET, SO_RCVBUF, (
const char*)&rcvbuf,
sizeof(rcvbuf)) != 0)
180 WLog_WARN(TAG,
"failed to set SO_RCVBUF via setsockopt()");
182 if (_bind(sockfd, addr, WINPR_ASSERTING_INT_CAST(
int, addrlen)) != 0)
185 WLog_WARN(TAG,
"failed to bind UDP socket for RDP-UDP, error %d", WSAGetLastError());
187 return INVALID_SOCKET;
192void udpsocket_ignore_icmp_errors(SOCKET sockfd)
198 if (WSAIoctl(sockfd, SIO_UDP_CONNRESET, &report,
sizeof(report),
nullptr, 0, &bytes,
nullptr,
200 WLog_DBG(TAG,
"unable to disable SIO_UDP_CONNRESET");
202 if (WSAIoctl(sockfd, SIO_UDP_NETRESET, &report,
sizeof(report),
nullptr, 0, &bytes,
nullptr,
204 WLog_DBG(TAG,
"unable to disable SIO_UDP_NETRESET");
206 WINPR_UNUSED(sockfd);
210BOOL udpsocket_is_message_socket(SOCKET sockfd)
213 int typeLength =
sizeof(type);
214 return (_getsockopt(sockfd, SOL_SOCKET, SO_TYPE, (
char*)&type, &typeLength) == 0) &&
215 ((type == SOCK_SEQPACKET) || (type == SOCK_DGRAM));
219static BOOL udpsocket_is_any_address(
const struct sockaddr_storage* addr)
222 if (addr->ss_family == AF_INET)
224 const struct sockaddr_in* in = (
const struct sockaddr_in*)addr;
225 return in->sin_addr.s_addr == htonl(INADDR_ANY);
227 if (addr->ss_family == AF_INET6)
229 const struct sockaddr_in6* in6 = (
const struct sockaddr_in6*)addr;
230 return IN6_IS_ADDR_UNSPECIFIED(&in6->sin6_addr);
239 if (!udpsocket_is_any_address(&sock->addr))
243#if defined(UDPLISTENER_LOCAL_ADDRESS_IPV4) || defined(UDPLISTENER_LOCAL_ADDRESS_IPV6)
246#if defined(UDPLISTENER_LOCAL_ADDRESS_IPV4)
247 if (sock->addr.ss_family == AF_INET)
248 rc = _setsockopt(sock->sockfd, IPPROTO_IP, IP_PKTINFO, (
const char*)&on,
sizeof(on));
250#if defined(UDPLISTENER_LOCAL_ADDRESS_IPV6)
251 if (sock->addr.ss_family == AF_INET6)
253 _setsockopt(sock->sockfd, IPPROTO_IPV6, IPV6_RECVPKTINFO, (
const char*)&on,
sizeof(on));
255 sock->localAddress = (rc == 0);
256 if (!sock->localAddress)
258 "a socket bound to any address cannot determine the destination of a datagram. "
259 "With more than one address, a reply can go out from an incorrect address");
268 WINPR_ASSERT(addrlen);
271 memset(local, 0,
sizeof(*local));
272#if defined(UDPLISTENER_LOCAL_ADDRESS_IPV4) || defined(UDPLISTENER_LOCAL_ADDRESS_IPV6)
273 if (sock->localAddress)
277 struct cmsghdr header;
280 memset(&control, 0,
sizeof(control));
281 struct iovec iov = { .iov_base = data, .iov_len = size };
282 struct msghdr msg = WINPR_C_ARRAY_INIT;
284 msg.msg_namelen = WINPR_ASSERTING_INT_CAST(socklen_t, *addrlen);
287 msg.msg_control = control.data;
288 msg.msg_controllen =
sizeof(control.data);
289 const ssize_t got = recvmsg(WINPR_ASSERTING_INT_CAST(
int, sock->sockfd), &msg, 0);
292 *addrlen = WINPR_ASSERTING_INT_CAST(
int, msg.msg_namelen);
294 for (
struct cmsghdr* cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg))
296#if defined(UDPLISTENER_LOCAL_ADDRESS_IPV4)
297 if ((cmsg->cmsg_level == IPPROTO_IP) && (cmsg->cmsg_type == IP_PKTINFO) &&
298 (cmsg->cmsg_len >= CMSG_LEN(
sizeof(
struct in_pktinfo))))
300 struct in_pktinfo info = WINPR_C_ARRAY_INIT;
301 memcpy(&info, CMSG_DATA(cmsg),
sizeof(info));
302 local->family = AF_INET;
303 local->ipv4 = info.ipi_addr;
304 local->interfaceIndex = WINPR_ASSERTING_INT_CAST(UINT32, info.ipi_ifindex);
308#if defined(UDPLISTENER_LOCAL_ADDRESS_IPV6)
309 if ((cmsg->cmsg_level == IPPROTO_IPV6) && (cmsg->cmsg_type == IPV6_PKTINFO) &&
310 (cmsg->cmsg_len >= CMSG_LEN(
sizeof(
struct in6_pktinfo))))
312 struct in6_pktinfo info = WINPR_C_ARRAY_INIT;
313 memcpy(&info, CMSG_DATA(cmsg),
sizeof(info));
314 local->family = AF_INET6;
315 local->ipv6 = info.ipi6_addr;
316 local->interfaceIndex = WINPR_ASSERTING_INT_CAST(UINT32, info.ipi6_ifindex);
321 return WINPR_ASSERTING_INT_CAST(
int, got);
324 return _recvfrom(sock->sockfd, (
char*)data, WINPR_ASSERTING_INT_CAST(
int, size), 0,
325 (
struct sockaddr*)addr, addrlen);
328BOOL udpsocket_send_from(SOCKET sockfd,
const struct sockaddr_storage* to,
size_t tolen,
335#if defined(UDPLISTENER_LOCAL_ADDRESS_IPV4) || defined(UDPLISTENER_LOCAL_ADDRESS_IPV6)
338 struct cmsghdr header;
341 memset(&control, 0,
sizeof(control));
342 struct iovec iov = { .iov_base = WINPR_CAST_CONST_PTR_AWAY(data,
void*), .iov_len = length };
343 struct msghdr msg = WINPR_C_ARRAY_INIT;
344 msg.msg_name = WINPR_CAST_CONST_PTR_AWAY(to,
void*);
345 msg.msg_namelen = WINPR_ASSERTING_INT_CAST(socklen_t, tolen);
348 msg.msg_control = control.data;
349 msg.msg_controllen =
sizeof(control.data);
350 struct cmsghdr* cmsg = CMSG_FIRSTHDR(&msg);
358#if defined(UDPLISTENER_LOCAL_ADDRESS_IPV4)
359 if (local->family == AF_INET)
362 struct in_pktinfo info = WINPR_C_ARRAY_INIT;
363 info.ipi_spec_dst = local->ipv4;
364 cmsg->cmsg_level = IPPROTO_IP;
365 cmsg->cmsg_type = IP_PKTINFO;
366 cmsg->cmsg_len = CMSG_LEN(
sizeof(info));
367 memcpy(CMSG_DATA(cmsg), &info,
sizeof(info));
368 msg.msg_controllen = CMSG_SPACE(
sizeof(info));
372#if defined(UDPLISTENER_LOCAL_ADDRESS_IPV6)
373 if (local->family == AF_INET6)
377 struct in6_pktinfo info = WINPR_C_ARRAY_INIT;
378 info.ipi6_addr = local->ipv6;
379 if (IN6_IS_ADDR_LINKLOCAL(&local->ipv6))
380 info.ipi6_ifindex = local->interfaceIndex;
381 cmsg->cmsg_level = IPPROTO_IPV6;
382 cmsg->cmsg_type = IPV6_PKTINFO;
383 cmsg->cmsg_len = CMSG_LEN(
sizeof(info));
384 memcpy(CMSG_DATA(cmsg), &info,
sizeof(info));
385 msg.msg_controllen = CMSG_SPACE(
sizeof(info));
394 return sendmsg(WINPR_ASSERTING_INT_CAST(
int, sockfd), &msg, 0) >= 0;
396 WINPR_UNUSED(sockfd);
398 WINPR_UNUSED(length);
403BOOL udpsocket_source_address_unavailable(
int* error)
408 const int systemError = errno;
409 const BOOL gone = (systemError == ENODEV) || (systemError == ENXIO);
411 const BOOL gone = FALSE;
413 *error = WSAGetLastError();
414 return gone || (*error == WSAEADDRNOTAVAIL) || (*error == WSAEINVAL);
417BOOL udpsocket_peer_closed(
void)
421 const int error = WSAGetLastError();
422 return (error == WSAECONNRESET) || (error == WSAECONNREFUSED) || (error == WSAENOTCONN);
424 const int error = errno;
425 return (error == ECONNREFUSED) || (error == ENOTCONN) || (error == EPIPE) ||
426 (error == ECONNRESET);
430BOOL udpsocket_message_pair(SOCKET pair[2])
434 pair[0] = INVALID_SOCKET;
435 pair[1] = INVALID_SOCKET;
439 struct sockaddr_in addr[2] = WINPR_C_ARRAY_INIT;
440 for (
size_t x = 0; x < 2; x++)
442 int length =
sizeof(addr[x]);
443 addr[x].sin_family = AF_INET;
444 addr[x].sin_addr.s_addr = htonl(INADDR_LOOPBACK);
445 pair[x] = udpsocket_new(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
447 const BOOL exclusive = TRUE;
448 if ((pair[x] == INVALID_SOCKET) ||
449 (_setsockopt(pair[x], SOL_SOCKET, SO_EXCLUSIVEADDRUSE, (
const char*)&exclusive,
450 sizeof(exclusive)) != 0) ||
451 (_bind(pair[x], (
const struct sockaddr*)&addr[x],
sizeof(addr[x])) != 0) ||
452 (_getsockname(pair[x], (
struct sockaddr*)&addr[x], &length) != 0))
455 for (
size_t x = 0; x < 2; x++)
457 if (_connect(pair[x], (
const struct sockaddr*)&addr[1 - x],
sizeof(addr[1 - x])) != 0)
461 for (
size_t x = 0; x < 2; x++)
463 u_long nonBlocking = 1;
464 if (_ioctlsocket(pair[x], FIONBIO, &nonBlocking) != 0)
466 char drop[64] = WINPR_C_ARRAY_INIT;
467 while ((_recv(pair[x], drop,
sizeof(drop), 0) >= 0) || (WSAGetLastError() == WSAEMSGSIZE))
471 if (_ioctlsocket(pair[x], FIONBIO, &nonBlocking) != 0)
478 int sv[2] = { -1, -1 };
479 if ((socketpair(AF_UNIX, SOCK_SEQPACKET | UDPLISTENER_SOCK_CLOEXEC, 0, sv) != 0) &&
480 (socketpair(AF_UNIX, SOCK_DGRAM | UDPLISTENER_SOCK_CLOEXEC, 0, sv) != 0))
482 pair[0] = (SOCKET)sv[0];
483 pair[1] = (SOCKET)sv[1];
484 udpsocket_set_no_inherit(pair[0]);
485 udpsocket_set_no_inherit(pair[1]);
492 for (
size_t x = 0; x < 2; x++)
494 if (pair[x] != INVALID_SOCKET)
495 closesocket(pair[x]);
496 pair[x] = INVALID_SOCKET;
503BOOL freerdp_udp_socket_pair(
int fds[2])
507 SOCKET pair[2] = { INVALID_SOCKET, INVALID_SOCKET };
508 if (!udpsocket_message_pair(pair))
512 const UINT32 size = UDPLISTENER_RECEIVE_BUFFER;
513 for (
size_t x = 0; x < 2; x++)
515 if ((_setsockopt(pair[x], SOL_SOCKET, SO_SNDBUF, (
const char*)&size,
sizeof(size)) != 0) ||
516 (_setsockopt(pair[x], SOL_SOCKET, SO_RCVBUF, (
const char*)&size,
sizeof(size)) != 0))
517 WLog_DBG(TAG,
"failed to set the buffer sizes of a socket pair");
518 fds[x] = (int)pair[x];
523void udpsocket_poll_set(udpPollFd* fd, SOCKET sockfd)
529 fd->fd = WINPR_ASSERTING_INT_CAST(
int, sockfd);
535int udpsocket_poll(udpPollFd* fds,
size_t count)
538 return WSAPoll(fds, WINPR_ASSERTING_INT_CAST(ULONG, count), -1);
540 return poll(fds, WINPR_ASSERTING_INT_CAST(nfds_t, count), -1);