Bitcoin Core 30.99.0
P2P Digital Currency
netbase.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-present The Bitcoin Core developers
3// Distributed under the MIT software license, see the accompanying
4// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6#include <bitcoin-build-config.h> // IWYU pragma: keep
7
8#include <netbase.h>
9
10#include <compat/compat.h>
11#include <logging.h>
12#include <sync.h>
13#include <tinyformat.h>
14#include <util/sock.h>
15#include <util/strencodings.h>
16#include <util/string.h>
17#include <util/time.h>
18
19#include <atomic>
20#include <chrono>
21#include <cstdint>
22#include <functional>
23#include <limits>
24#include <memory>
25
26#ifdef HAVE_SOCKADDR_UN
27#include <sys/un.h>
28#endif
29
31
32// Settings
35static Proxy nameProxy GUARDED_BY(g_proxyinfo_mutex);
38
39// Need ample time for negotiation for very slow proxies such as Tor
40std::chrono::milliseconds g_socks5_recv_timeout = 20s;
42
44
45std::vector<CNetAddr> WrappedGetAddrInfo(const std::string& name, bool allow_lookup)
46{
47 addrinfo ai_hint{};
48 // We want a TCP port, which is a streaming socket type
49 ai_hint.ai_socktype = SOCK_STREAM;
50 ai_hint.ai_protocol = IPPROTO_TCP;
51 // We don't care which address family (IPv4 or IPv6) is returned
52 ai_hint.ai_family = AF_UNSPEC;
53
54 // If we allow lookups of hostnames, use the AI_ADDRCONFIG flag to only
55 // return addresses whose family we have an address configured for.
56 //
57 // If we don't allow lookups, then use the AI_NUMERICHOST flag for
58 // getaddrinfo to only decode numerical network addresses and suppress
59 // hostname lookups.
60 ai_hint.ai_flags = allow_lookup ? AI_ADDRCONFIG : AI_NUMERICHOST;
61
62 addrinfo* ai_res{nullptr};
63 const int n_err{getaddrinfo(name.c_str(), nullptr, &ai_hint, &ai_res)};
64 if (n_err != 0) {
65 if ((ai_hint.ai_flags & AI_ADDRCONFIG) == AI_ADDRCONFIG) {
66 // AI_ADDRCONFIG on some systems may exclude loopback-only addresses
67 // If first lookup failed we perform a second lookup without AI_ADDRCONFIG
68 ai_hint.ai_flags = (ai_hint.ai_flags & ~AI_ADDRCONFIG);
69 const int n_err_retry{getaddrinfo(name.c_str(), nullptr, &ai_hint, &ai_res)};
70 if (n_err_retry != 0) {
71 return {};
72 }
73 } else {
74 return {};
75 }
76 }
77
78 // Traverse the linked list starting with ai_trav.
79 addrinfo* ai_trav{ai_res};
80 std::vector<CNetAddr> resolved_addresses;
81 while (ai_trav != nullptr) {
82 if (ai_trav->ai_family == AF_INET) {
83 assert(ai_trav->ai_addrlen >= sizeof(sockaddr_in));
84 resolved_addresses.emplace_back(reinterpret_cast<sockaddr_in*>(ai_trav->ai_addr)->sin_addr);
85 }
86 if (ai_trav->ai_family == AF_INET6) {
87 assert(ai_trav->ai_addrlen >= sizeof(sockaddr_in6));
88 const sockaddr_in6* s6{reinterpret_cast<sockaddr_in6*>(ai_trav->ai_addr)};
89 resolved_addresses.emplace_back(s6->sin6_addr, s6->sin6_scope_id);
90 }
91 ai_trav = ai_trav->ai_next;
92 }
93 freeaddrinfo(ai_res);
94
95 return resolved_addresses;
96}
97
99
100enum Network ParseNetwork(const std::string& net_in) {
101 std::string net = ToLower(net_in);
102 if (net == "ipv4") return NET_IPV4;
103 if (net == "ipv6") return NET_IPV6;
104 if (net == "onion") return NET_ONION;
105 if (net == "i2p") {
106 return NET_I2P;
107 }
108 if (net == "cjdns") {
109 return NET_CJDNS;
110 }
111 return NET_UNROUTABLE;
112}
113
114std::string GetNetworkName(enum Network net)
115{
116 switch (net) {
117 case NET_UNROUTABLE: return "not_publicly_routable";
118 case NET_IPV4: return "ipv4";
119 case NET_IPV6: return "ipv6";
120 case NET_ONION: return "onion";
121 case NET_I2P: return "i2p";
122 case NET_CJDNS: return "cjdns";
123 case NET_INTERNAL: return "internal";
124 case NET_MAX: assert(false);
125 } // no default case, so the compiler can warn about missing cases
126
127 assert(false);
128}
129
130std::vector<std::string> GetNetworkNames(bool append_unroutable)
131{
132 std::vector<std::string> names;
133 for (int n = 0; n < NET_MAX; ++n) {
134 const enum Network network{static_cast<Network>(n)};
135 if (network == NET_UNROUTABLE || network == NET_INTERNAL) continue;
136 names.emplace_back(GetNetworkName(network));
137 }
138 if (append_unroutable) {
139 names.emplace_back(GetNetworkName(NET_UNROUTABLE));
140 }
141 return names;
142}
143
144static std::vector<CNetAddr> LookupIntern(const std::string& name, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function)
145{
146 if (!ContainsNoNUL(name)) return {};
147 {
148 CNetAddr addr;
149 // From our perspective, onion addresses are not hostnames but rather
150 // direct encodings of CNetAddr much like IPv4 dotted-decimal notation
151 // or IPv6 colon-separated hextet notation. Since we can't use
152 // getaddrinfo to decode them and it wouldn't make sense to resolve
153 // them, we return a network address representing it instead. See
154 // CNetAddr::SetSpecial(const std::string&) for more details.
155 if (addr.SetSpecial(name)) return {addr};
156 }
157
158 std::vector<CNetAddr> addresses;
159
160 for (const CNetAddr& resolved : dns_lookup_function(name, fAllowLookup)) {
161 if (nMaxSolutions > 0 && addresses.size() >= nMaxSolutions) {
162 break;
163 }
164 /* Never allow resolving to an internal address. Consider any such result invalid */
165 if (!resolved.IsInternal()) {
166 addresses.push_back(resolved);
167 }
168 }
169
170 return addresses;
171}
172
173std::vector<CNetAddr> LookupHost(const std::string& name, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function)
174{
175 if (!ContainsNoNUL(name)) return {};
176 std::string strHost = name;
177 if (strHost.empty()) return {};
178 if (strHost.front() == '[' && strHost.back() == ']') {
179 strHost = strHost.substr(1, strHost.size() - 2);
180 }
181
182 return LookupIntern(strHost, nMaxSolutions, fAllowLookup, dns_lookup_function);
183}
184
185std::optional<CNetAddr> LookupHost(const std::string& name, bool fAllowLookup, DNSLookupFn dns_lookup_function)
186{
187 const std::vector<CNetAddr> addresses{LookupHost(name, 1, fAllowLookup, dns_lookup_function)};
188 return addresses.empty() ? std::nullopt : std::make_optional(addresses.front());
189}
190
191std::vector<CService> Lookup(const std::string& name, uint16_t portDefault, bool fAllowLookup, unsigned int nMaxSolutions, DNSLookupFn dns_lookup_function)
192{
193 if (name.empty() || !ContainsNoNUL(name)) {
194 return {};
195 }
196 uint16_t port{portDefault};
197 std::string hostname;
198 SplitHostPort(name, port, hostname);
199
200 const std::vector<CNetAddr> addresses{LookupIntern(hostname, nMaxSolutions, fAllowLookup, dns_lookup_function)};
201 if (addresses.empty()) return {};
202 std::vector<CService> services;
203 services.reserve(addresses.size());
204 for (const auto& addr : addresses)
205 services.emplace_back(addr, port);
206 return services;
207}
208
209std::optional<CService> Lookup(const std::string& name, uint16_t portDefault, bool fAllowLookup, DNSLookupFn dns_lookup_function)
210{
211 const std::vector<CService> services{Lookup(name, portDefault, fAllowLookup, 1, dns_lookup_function)};
212
213 return services.empty() ? std::nullopt : std::make_optional(services.front());
214}
215
216CService LookupNumeric(const std::string& name, uint16_t portDefault, DNSLookupFn dns_lookup_function)
217{
218 if (!ContainsNoNUL(name)) {
219 return {};
220 }
221 // "1.2:345" will fail to resolve the ip, but will still set the port.
222 // If the ip fails to resolve, re-init the result.
223 return Lookup(name, portDefault, /*fAllowLookup=*/false, dns_lookup_function).value_or(CService{});
224}
225
226bool IsUnixSocketPath(const std::string& name)
227{
228#ifdef HAVE_SOCKADDR_UN
229 if (!name.starts_with(ADDR_PREFIX_UNIX)) return false;
230
231 // Split off "unix:" prefix
232 std::string str{name.substr(ADDR_PREFIX_UNIX.length())};
233
234 // Path size limit is platform-dependent
235 // see https://manpages.ubuntu.com/manpages/xenial/en/man7/unix.7.html
236 if (str.size() + 1 > sizeof(((sockaddr_un*)nullptr)->sun_path)) return false;
237
238 return true;
239#else
240 return false;
241#endif
242}
243
245enum SOCKSVersion: uint8_t {
246 SOCKS4 = 0x04,
247 SOCKS5 = 0x05
249
251enum SOCKS5Method: uint8_t {
252 NOAUTH = 0x00,
253 GSSAPI = 0x01,
254 USER_PASS = 0x02,
256};
257
259enum SOCKS5Command: uint8_t {
260 CONNECT = 0x01,
261 BIND = 0x02,
262 UDP_ASSOCIATE = 0x03
264
266enum SOCKS5Reply: uint8_t {
267 SUCCEEDED = 0x00,
268 GENFAILURE = 0x01,
269 NOTALLOWED = 0x02,
272 CONNREFUSED = 0x05,
273 TTLEXPIRED = 0x06,
284};
285
287enum SOCKS5Atyp: uint8_t {
288 IPV4 = 0x01,
290 IPV6 = 0x04,
291};
292
294enum class IntrRecvError {
295 OK,
296 Timeout,
300};
301
318static IntrRecvError InterruptibleRecv(uint8_t* data, size_t len, std::chrono::milliseconds timeout, const Sock& sock)
319{
320 auto curTime{Now<SteadyMilliseconds>()};
321 const auto endTime{curTime + timeout};
322 while (len > 0 && curTime < endTime) {
323 ssize_t ret = sock.Recv(data, len, 0); // Optimistically try the recv first
324 if (ret > 0) {
325 len -= ret;
326 data += ret;
327 } else if (ret == 0) { // Unexpected disconnection
329 } else { // Other error or blocking
330 int nErr = WSAGetLastError();
331 if (nErr == WSAEINPROGRESS || nErr == WSAEWOULDBLOCK || nErr == WSAEINVAL) {
332 // Only wait at most MAX_WAIT_FOR_IO at a time, unless
333 // we're approaching the end of the specified total timeout
334 const auto remaining = std::chrono::milliseconds{endTime - curTime};
335 const auto timeout = std::min(remaining, std::chrono::milliseconds{MAX_WAIT_FOR_IO});
336 if (!sock.Wait(timeout, Sock::RECV)) {
338 }
339 } else {
341 }
342 }
343 if (g_socks5_interrupt) {
345 }
346 curTime = Now<SteadyMilliseconds>();
347 }
348 return len == 0 ? IntrRecvError::OK : IntrRecvError::Timeout;
349}
350
352static std::string Socks5ErrorString(uint8_t err)
353{
354 switch(err) {
356 return "general failure";
358 return "connection not allowed";
360 return "network unreachable";
362 return "host unreachable";
364 return "connection refused";
366 return "TTL expired";
368 return "protocol error";
370 return "address type not supported";
372 return "onion service descriptor can not be found";
374 return "onion service descriptor is invalid";
376 return "onion service introduction failed";
378 return "onion service rendezvous failed";
380 return "onion service missing client authorization";
382 return "onion service wrong client authorization";
384 return "onion service invalid address";
386 return "onion service introduction timed out";
387 default:
388 return strprintf("unknown (0x%02x)", err);
389 }
390}
391
392bool Socks5(const std::string& strDest, uint16_t port, const ProxyCredentials* auth, const Sock& sock)
393{
394 try {
395 IntrRecvError recvr;
396 LogDebug(BCLog::NET, "SOCKS5 connecting %s\n", strDest);
397 if (strDest.size() > 255) {
398 LogError("Hostname too long\n");
399 return false;
400 }
401 // Construct the version identifier/method selection message
402 std::vector<uint8_t> vSocks5Init;
403 vSocks5Init.push_back(SOCKSVersion::SOCKS5); // We want the SOCK5 protocol
404 if (auth) {
405 vSocks5Init.push_back(0x02); // 2 method identifiers follow...
406 vSocks5Init.push_back(SOCKS5Method::NOAUTH);
407 vSocks5Init.push_back(SOCKS5Method::USER_PASS);
408 } else {
409 vSocks5Init.push_back(0x01); // 1 method identifier follows...
410 vSocks5Init.push_back(SOCKS5Method::NOAUTH);
411 }
413 uint8_t pchRet1[2];
415 LogInfo("Socks5() connect to %s:%d failed: InterruptibleRecv() timeout or other failure\n", strDest, port);
416 return false;
417 }
418 if (pchRet1[0] != SOCKSVersion::SOCKS5) {
419 LogError("Proxy failed to initialize\n");
420 return false;
421 }
422 if (pchRet1[1] == SOCKS5Method::USER_PASS && auth) {
423 // Perform username/password authentication (as described in RFC1929)
424 std::vector<uint8_t> vAuth;
425 vAuth.push_back(0x01); // Current (and only) version of user/pass subnegotiation
426 if (auth->username.size() > 255 || auth->password.size() > 255) {
427 LogError("Proxy username or password too long\n");
428 return false;
429 }
430 vAuth.push_back(auth->username.size());
431 vAuth.insert(vAuth.end(), auth->username.begin(), auth->username.end());
432 vAuth.push_back(auth->password.size());
433 vAuth.insert(vAuth.end(), auth->password.begin(), auth->password.end());
435 LogDebug(BCLog::PROXY, "SOCKS5 sending proxy authentication %s:%s\n", auth->username, auth->password);
436 uint8_t pchRetA[2];
438 LogError("Error reading proxy authentication response\n");
439 return false;
440 }
441 if (pchRetA[0] != 0x01 || pchRetA[1] != 0x00) {
442 LogError("Proxy authentication unsuccessful\n");
443 return false;
444 }
445 } else if (pchRet1[1] == SOCKS5Method::NOAUTH) {
446 // Perform no authentication
447 } else {
448 LogError("Proxy requested wrong authentication method %02x\n", pchRet1[1]);
449 return false;
450 }
451 std::vector<uint8_t> vSocks5;
452 vSocks5.push_back(SOCKSVersion::SOCKS5); // VER protocol version
453 vSocks5.push_back(SOCKS5Command::CONNECT); // CMD CONNECT
454 vSocks5.push_back(0x00); // RSV Reserved must be 0
455 vSocks5.push_back(SOCKS5Atyp::DOMAINNAME); // ATYP DOMAINNAME
456 vSocks5.push_back(strDest.size()); // Length<=255 is checked at beginning of function
457 vSocks5.insert(vSocks5.end(), strDest.begin(), strDest.end());
458 vSocks5.push_back((port >> 8) & 0xFF);
459 vSocks5.push_back((port >> 0) & 0xFF);
461 uint8_t pchRet2[4];
462 if ((recvr = InterruptibleRecv(pchRet2, 4, g_socks5_recv_timeout, sock)) != IntrRecvError::OK) {
463 if (recvr == IntrRecvError::Timeout) {
464 /* If a timeout happens here, this effectively means we timed out while connecting
465 * to the remote node. This is very common for Tor, so do not print an
466 * error message. */
467 return false;
468 } else {
469 LogError("Error while reading proxy response\n");
470 return false;
471 }
472 }
473 if (pchRet2[0] != SOCKSVersion::SOCKS5) {
474 LogError("Proxy failed to accept request\n");
475 return false;
476 }
477 if (pchRet2[1] != SOCKS5Reply::SUCCEEDED) {
478 // Failures to connect to a peer that are not proxy errors
480 "Socks5() connect to %s:%d failed: %s\n", strDest, port, Socks5ErrorString(pchRet2[1]));
481 return false;
482 }
483 if (pchRet2[2] != 0x00) { // Reserved field must be 0
484 LogError("Error: malformed proxy response\n");
485 return false;
486 }
487 uint8_t pchRet3[256];
488 switch (pchRet2[3]) {
489 case SOCKS5Atyp::IPV4: recvr = InterruptibleRecv(pchRet3, 4, g_socks5_recv_timeout, sock); break;
490 case SOCKS5Atyp::IPV6: recvr = InterruptibleRecv(pchRet3, 16, g_socks5_recv_timeout, sock); break;
492 recvr = InterruptibleRecv(pchRet3, 1, g_socks5_recv_timeout, sock);
493 if (recvr != IntrRecvError::OK) {
494 LogError("Error reading from proxy\n");
495 return false;
496 }
497 int nRecv = pchRet3[0];
498 recvr = InterruptibleRecv(pchRet3, nRecv, g_socks5_recv_timeout, sock);
499 break;
500 }
501 default: {
502 LogError("Error: malformed proxy response\n");
503 return false;
504 }
505 }
506 if (recvr != IntrRecvError::OK) {
507 LogError("Error reading from proxy\n");
508 return false;
509 }
511 LogError("Error reading from proxy\n");
512 return false;
513 }
514 LogDebug(BCLog::NET, "SOCKS5 connected %s\n", strDest);
515 return true;
516 } catch (const std::runtime_error& e) {
517 LogError("Error during SOCKS5 proxy handshake: %s\n", e.what());
518 return false;
519 }
520}
521
522std::unique_ptr<Sock> CreateSockOS(int domain, int type, int protocol)
523{
524 // Not IPv4, IPv6 or UNIX
525 if (domain == AF_UNSPEC) return nullptr;
526
527 // Create a socket in the specified address family.
528 SOCKET hSocket = socket(domain, type, protocol);
529 if (hSocket == INVALID_SOCKET) {
530 return nullptr;
531 }
532
533 auto sock = std::make_unique<Sock>(hSocket);
534
535 if (domain != AF_INET && domain != AF_INET6 && domain != AF_UNIX) {
536 return sock;
537 }
538
539 // Ensure that waiting for I/O on this socket won't result in undefined
540 // behavior.
541 if (!sock->IsSelectable()) {
542 LogInfo("Cannot create connection: non-selectable socket created (fd >= FD_SETSIZE ?)\n");
543 return nullptr;
544 }
545
546#ifdef SO_NOSIGPIPE
547 int set = 1;
548 // Set the no-sigpipe option on the socket for BSD systems, other UNIXes
549 // should use the MSG_NOSIGNAL flag for every send.
550 if (sock->SetSockOpt(SOL_SOCKET, SO_NOSIGPIPE, &set, sizeof(int)) == SOCKET_ERROR) {
551 LogInfo("Error setting SO_NOSIGPIPE on socket: %s, continuing anyway\n",
553 }
554#endif
555
556 // Set the non-blocking option on the socket.
557 if (!sock->SetNonBlocking()) {
558 LogInfo("Error setting socket to non-blocking: %s\n", NetworkErrorString(WSAGetLastError()));
559 return nullptr;
560 }
561
562#ifdef HAVE_SOCKADDR_UN
563 if (domain == AF_UNIX) return sock;
564#endif
565
566 if (protocol == IPPROTO_TCP) {
567 // Set the no-delay option (disable Nagle's algorithm) on the TCP socket.
568 const int on{1};
569 if (sock->SetSockOpt(IPPROTO_TCP, TCP_NODELAY, &on, sizeof(on)) == SOCKET_ERROR) {
570 LogDebug(BCLog::NET, "Unable to set TCP_NODELAY on a newly created socket, continuing anyway\n");
571 }
572 }
573
574 return sock;
575}
576
577std::function<std::unique_ptr<Sock>(int, int, int)> CreateSock = CreateSockOS;
578
579template<typename... Args>
580static void LogConnectFailure(bool manual_connection, util::ConstevalFormatString<sizeof...(Args)> fmt, const Args&... args)
581{
582 std::string error_message = tfm::format(fmt, args...);
583 if (manual_connection) {
584 LogInfo("%s\n", error_message);
585 } else {
586 LogDebug(BCLog::NET, "%s\n", error_message);
587 }
588}
589
590static bool ConnectToSocket(const Sock& sock, struct sockaddr* sockaddr, socklen_t len, const std::string& dest_str, bool manual_connection)
591{
592 // Connect to `sockaddr` using `sock`.
593 if (sock.Connect(sockaddr, len) == SOCKET_ERROR) {
594 int nErr = WSAGetLastError();
595 // WSAEINVAL is here because some legacy version of winsock uses it
596 if (nErr == WSAEINPROGRESS || nErr == WSAEWOULDBLOCK || nErr == WSAEINVAL)
597 {
598 // Connection didn't actually fail, but is being established
599 // asynchronously. Thus, use async I/O api (select/poll)
600 // synchronously to check for successful connection with a timeout.
601 const Sock::Event requested = Sock::RECV | Sock::SEND;
602 Sock::Event occurred;
603 if (!sock.Wait(std::chrono::milliseconds{nConnectTimeout}, requested, &occurred)) {
604 LogInfo("wait for connect to %s failed: %s\n",
605 dest_str,
607 return false;
608 } else if (occurred == 0) {
609 LogDebug(BCLog::NET, "connection attempt to %s timed out\n", dest_str);
610 return false;
611 }
612
613 // Even if the wait was successful, the connect might not
614 // have been successful. The reason for this failure is hidden away
615 // in the SO_ERROR for the socket in modern systems. We read it into
616 // sockerr here.
617 int sockerr;
618 socklen_t sockerr_len = sizeof(sockerr);
619 if (sock.GetSockOpt(SOL_SOCKET, SO_ERROR, &sockerr, &sockerr_len) ==
620 SOCKET_ERROR) {
621 LogInfo("getsockopt() for %s failed: %s\n", dest_str, NetworkErrorString(WSAGetLastError()));
622 return false;
623 }
624 if (sockerr != 0) {
625 LogConnectFailure(manual_connection,
626 "connect() to %s failed after wait: %s",
627 dest_str,
628 NetworkErrorString(sockerr));
629 return false;
630 }
631 }
632#ifdef WIN32
633 else if (WSAGetLastError() != WSAEISCONN)
634#else
635 else
636#endif
637 {
638 LogConnectFailure(manual_connection, "connect() to %s failed: %s", dest_str, NetworkErrorString(WSAGetLastError()));
639 return false;
640 }
641 }
642 return true;
643}
644
645std::unique_ptr<Sock> ConnectDirectly(const CService& dest, bool manual_connection)
646{
647 auto sock = CreateSock(dest.GetSAFamily(), SOCK_STREAM, IPPROTO_TCP);
648 if (!sock) {
649 LogError("Cannot create a socket for connecting to %s\n", dest.ToStringAddrPort());
650 return {};
651 }
652
653 // Create a sockaddr from the specified service.
654 struct sockaddr_storage sockaddr;
655 socklen_t len = sizeof(sockaddr);
656 if (!dest.GetSockAddr((struct sockaddr*)&sockaddr, &len)) {
657 LogInfo("Cannot get sockaddr for %s: unsupported network\n", dest.ToStringAddrPort());
658 return {};
659 }
660
661 if (!ConnectToSocket(*sock, (struct sockaddr*)&sockaddr, len, dest.ToStringAddrPort(), manual_connection)) {
662 return {};
663 }
664
665 return sock;
666}
667
668std::unique_ptr<Sock> Proxy::Connect() const
669{
670 if (!IsValid()) return {};
671
672 if (!m_is_unix_socket) return ConnectDirectly(proxy, /*manual_connection=*/true);
673
674#ifdef HAVE_SOCKADDR_UN
675 auto sock = CreateSock(AF_UNIX, SOCK_STREAM, 0);
676 if (!sock) {
677 LogError("Cannot create a socket for connecting to %s\n", m_unix_socket_path);
678 return {};
679 }
680
681 const std::string path{m_unix_socket_path.substr(ADDR_PREFIX_UNIX.length())};
682
683 struct sockaddr_un addrun;
684 memset(&addrun, 0, sizeof(addrun));
685 addrun.sun_family = AF_UNIX;
686 // leave the last char in addrun.sun_path[] to be always '\0'
687 memcpy(addrun.sun_path, path.c_str(), std::min(sizeof(addrun.sun_path) - 1, path.length()));
688 socklen_t len = sizeof(addrun);
689
690 if(!ConnectToSocket(*sock, (struct sockaddr*)&addrun, len, path, /*manual_connection=*/true)) {
691 return {};
692 }
693
694 return sock;
695#else
696 return {};
697#endif
698}
699
700bool SetProxy(enum Network net, const Proxy &addrProxy) {
701 assert(net >= 0 && net < NET_MAX);
702 if (!addrProxy.IsValid())
703 return false;
705 proxyInfo[net] = addrProxy;
706 return true;
707}
708
709bool GetProxy(enum Network net, Proxy &proxyInfoOut) {
710 assert(net >= 0 && net < NET_MAX);
712 if (!proxyInfo[net].IsValid())
713 return false;
714 proxyInfoOut = proxyInfo[net];
715 return true;
716}
717
718bool SetNameProxy(const Proxy &addrProxy) {
719 if (!addrProxy.IsValid())
720 return false;
722 nameProxy = addrProxy;
723 return true;
724}
725
726bool GetNameProxy(Proxy &nameProxyOut) {
728 if(!nameProxy.IsValid())
729 return false;
730 nameProxyOut = nameProxy;
731 return true;
732}
733
736 return nameProxy.IsValid();
737}
738
739bool IsProxy(const CNetAddr &addr) {
741 for (int i = 0; i < NET_MAX; i++) {
742 if (addr == static_cast<CNetAddr>(proxyInfo[i].proxy))
743 return true;
744 }
745 return false;
746}
747
754{
755public:
758 }
759
762 ProxyCredentials auth;
763 auth.username = auth.password = strprintf("%s%i", m_prefix, m_counter);
764 ++m_counter;
765 return auth;
766 }
767
769 static constexpr size_t PREFIX_BYTE_LENGTH = 8;
770private:
771 const std::string m_prefix;
772 std::atomic<uint64_t> m_counter;
773
778 static std::string GenerateUniquePrefix() {
779 std::array<uint8_t, PREFIX_BYTE_LENGTH> prefix_bytes;
780 GetRandBytes(prefix_bytes);
781 return HexStr(prefix_bytes) + "-";
782 }
783};
784
785std::unique_ptr<Sock> ConnectThroughProxy(const Proxy& proxy,
786 const std::string& dest,
787 uint16_t port,
788 bool& proxy_connection_failed)
789{
790 // first connect to proxy server
791 auto sock = proxy.Connect();
792 if (!sock) {
793 proxy_connection_failed = true;
794 return {};
795 }
796
797 // do socks negotiation
798 if (proxy.m_tor_stream_isolation) {
800 ProxyCredentials random_auth{generator.Generate()};
801 if (!Socks5(dest, port, &random_auth, *sock)) {
802 return {};
803 }
804 } else {
805 if (!Socks5(dest, port, nullptr, *sock)) {
806 return {};
807 }
808 }
809 return sock;
810}
811
812CSubNet LookupSubNet(const std::string& subnet_str)
813{
814 CSubNet subnet;
815 assert(!subnet.IsValid());
816 if (!ContainsNoNUL(subnet_str)) {
817 return subnet;
818 }
819
820 const size_t slash_pos{subnet_str.find_last_of('/')};
821 const std::string str_addr{subnet_str.substr(0, slash_pos)};
822 std::optional<CNetAddr> addr{LookupHost(str_addr, /*fAllowLookup=*/false)};
823
824 if (addr.has_value()) {
825 addr = static_cast<CNetAddr>(MaybeFlipIPv6toCJDNS(CService{addr.value(), /*port=*/0}));
826 if (slash_pos != subnet_str.npos) {
827 const std::string netmask_str{subnet_str.substr(slash_pos + 1)};
828 if (const auto netmask{ToIntegral<uint8_t>(netmask_str)}) {
829 // Valid number; assume CIDR variable-length subnet masking.
830 subnet = CSubNet{addr.value(), *netmask};
831 } else {
832 // Invalid number; try full netmask syntax. Never allow lookup for netmask.
833 const std::optional<CNetAddr> full_netmask{LookupHost(netmask_str, /*fAllowLookup=*/false)};
834 if (full_netmask.has_value()) {
835 subnet = CSubNet{addr.value(), full_netmask.value()};
836 }
837 }
838 } else {
839 // Single IP subnet (<ipv4>/32 or <ipv6>/128).
840 subnet = CSubNet{addr.value()};
841 }
842 }
843
844 return subnet;
845}
846
847bool IsBadPort(uint16_t port)
848{
849 /* Don't forget to update doc/p2p-bad-ports.md if you change this list. */
850
851 switch (port) {
852 case 1: // tcpmux
853 case 7: // echo
854 case 9: // discard
855 case 11: // systat
856 case 13: // daytime
857 case 15: // netstat
858 case 17: // qotd
859 case 19: // chargen
860 case 20: // ftp data
861 case 21: // ftp access
862 case 22: // ssh
863 case 23: // telnet
864 case 25: // smtp
865 case 37: // time
866 case 42: // name
867 case 43: // nicname
868 case 53: // domain
869 case 69: // tftp
870 case 77: // priv-rjs
871 case 79: // finger
872 case 87: // ttylink
873 case 95: // supdup
874 case 101: // hostname
875 case 102: // iso-tsap
876 case 103: // gppitnp
877 case 104: // acr-nema
878 case 109: // pop2
879 case 110: // pop3
880 case 111: // sunrpc
881 case 113: // auth
882 case 115: // sftp
883 case 117: // uucp-path
884 case 119: // nntp
885 case 123: // NTP
886 case 135: // loc-srv /epmap
887 case 137: // netbios
888 case 139: // netbios
889 case 143: // imap2
890 case 161: // snmp
891 case 179: // BGP
892 case 389: // ldap
893 case 427: // SLP (Also used by Apple Filing Protocol)
894 case 465: // smtp+ssl
895 case 512: // print / exec
896 case 513: // login
897 case 514: // shell
898 case 515: // printer
899 case 526: // tempo
900 case 530: // courier
901 case 531: // chat
902 case 532: // netnews
903 case 540: // uucp
904 case 548: // AFP (Apple Filing Protocol)
905 case 554: // rtsp
906 case 556: // remotefs
907 case 563: // nntp+ssl
908 case 587: // smtp (rfc6409)
909 case 601: // syslog-conn (rfc3195)
910 case 636: // ldap+ssl
911 case 989: // ftps-data
912 case 990: // ftps
913 case 993: // ldap+ssl
914 case 995: // pop3+ssl
915 case 1719: // h323gatestat
916 case 1720: // h323hostcall
917 case 1723: // pptp
918 case 2049: // nfs
919 case 3306: // MySQL
920 case 3389: // RDP / Windows Remote Desktop
921 case 3659: // apple-sasl / PasswordServer
922 case 4045: // lockd
923 case 5060: // sip
924 case 5061: // sips
925 case 5432: // PostgreSQL
926 case 5900: // VNC
927 case 6000: // X11
928 case 6566: // sane-port
929 case 6665: // Alternate IRC
930 case 6666: // Alternate IRC
931 case 6667: // Standard IRC
932 case 6668: // Alternate IRC
933 case 6669: // Alternate IRC
934 case 6697: // IRC + TLS
935 case 10080: // Amanda
936 case 27017: // MongoDB
937 return true;
938 }
939 return false;
940}
941
943{
944 CService ret{service};
945 if (ret.IsIPv6() && ret.HasCJDNSPrefix() && g_reachable_nets.Contains(NET_CJDNS)) {
946 ret.m_net = NET_CJDNS;
947 }
948 return ret;
949}
int ret
ArgsManager & args
Definition: bitcoind.cpp:277
Network address.
Definition: netaddress.h:113
bool SetSpecial(std::string_view addr)
Parse a Tor or I2P address and set this object to it.
Definition: netaddress.cpp:212
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:530
sa_family_t GetSAFamily() const
Get the address family.
Definition: netaddress.cpp:822
bool GetSockAddr(struct sockaddr *paddr, socklen_t *addrlen) const
Obtain the IPv4/6 socket address this represents.
Definition: netaddress.cpp:862
std::string ToStringAddrPort() const
Definition: netaddress.cpp:903
bool IsValid() const
A helper class for interruptible sleeps.
Different type to mark Mutex at global scope.
Definition: sync.h:135
Definition: netbase.h:59
std::unique_ptr< Sock > Connect() const
Definition: netbase.cpp:668
bool IsValid() const
Definition: netbase.h:70
bool m_tor_stream_isolation
Definition: netbase.h:68
bool m_is_unix_socket
Definition: netbase.h:67
CService proxy
Definition: netbase.h:65
std::string m_unix_socket_path
Definition: netbase.h:66
List of reachable networks.
Definition: netbase.h:101
bool Contains(Network net) const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: netbase.h:131
RAII helper class that manages a socket and closes it automatically when it goes out of scope.
Definition: sock.h:27
static constexpr Event SEND
If passed to Wait(), then it will wait for readiness to send to the socket.
Definition: sock.h:148
virtual bool Wait(std::chrono::milliseconds timeout, Event requested, Event *occurred=nullptr) const
Wait for readiness for input (recv) or output (send).
Definition: sock.cpp:139
virtual void SendComplete(std::span< const unsigned char > data, std::chrono::milliseconds timeout, CThreadInterrupt &interrupt) const
Send the given data, retrying on transient errors.
Definition: sock.cpp:245
uint8_t Event
Definition: sock.h:138
static constexpr Event RECV
If passed to Wait(), then it will wait for readiness to read from the socket.
Definition: sock.h:143
virtual int GetSockOpt(int level, int opt_name, void *opt_val, socklen_t *opt_len) const
getsockopt(2) wrapper.
Definition: sock.cpp:96
virtual int Connect(const sockaddr *addr, socklen_t addr_len) const
connect(2) wrapper.
Definition: sock.cpp:55
virtual ssize_t Recv(void *buf, size_t len, int flags) const
recv(2) wrapper.
Definition: sock.cpp:50
Generate unique credentials for Tor stream isolation.
Definition: netbase.cpp:754
std::atomic< uint64_t > m_counter
Definition: netbase.cpp:772
ProxyCredentials Generate()
Return the next unique proxy credentials.
Definition: netbase.cpp:761
static std::string GenerateUniquePrefix()
Generate a random prefix for each of the credentials returned by this generator.
Definition: netbase.cpp:778
static constexpr size_t PREFIX_BYTE_LENGTH
Size of session prefix in bytes.
Definition: netbase.cpp:769
#define INVALID_SOCKET
Definition: compat.h:55
#define WSAEWOULDBLOCK
Definition: compat.h:49
#define WSAEINVAL
Definition: compat.h:48
#define SOCKET_ERROR
Definition: compat.h:56
#define WSAGetLastError()
Definition: compat.h:47
unsigned int SOCKET
Definition: compat.h:45
#define WSAEINPROGRESS
Definition: compat.h:53
std::string HexStr(const std::span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
Definition: hex_base.cpp:31
#define LogInfo(...)
Definition: logging.h:368
#define LogError(...)
Definition: logging.h:370
#define LogDebug(category,...)
Definition: logging.h:390
@ PROXY
Definition: logging.h:81
@ NET
Definition: logging.h:66
void format(std::ostream &out, FormatStringCheck< sizeof...(Args)> fmt, const Args &... args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1079
bool ContainsNoNUL(std::string_view str) noexcept
Check if a string does not contain any embedded NUL (\0) characters.
Definition: string.h:233
Network
A network type.
Definition: netaddress.h:33
@ NET_I2P
I2P.
Definition: netaddress.h:47
@ NET_CJDNS
CJDNS.
Definition: netaddress.h:50
@ NET_MAX
Dummy value to indicate the number of NET_* constants.
Definition: netaddress.h:57
@ NET_ONION
TOR (v2 or v3)
Definition: netaddress.h:44
@ NET_IPV6
IPv6.
Definition: netaddress.h:41
@ NET_IPV4
IPv4.
Definition: netaddress.h:38
@ NET_UNROUTABLE
Addresses from these networks are not publicly routable on the global Internet.
Definition: netaddress.h:35
@ NET_INTERNAL
A set of addresses that represent the hash of a string or FQDN.
Definition: netaddress.h:54
IntrRecvError
Status codes that can be returned by InterruptibleRecv.
Definition: netbase.cpp:294
SOCKS5Atyp
Values defined for ATYPE in RFC1928.
Definition: netbase.cpp:287
@ DOMAINNAME
Definition: netbase.cpp:289
@ IPV4
Definition: netbase.cpp:288
@ IPV6
Definition: netbase.cpp:290
CSubNet LookupSubNet(const std::string &subnet_str)
Parse and resolve a specified subnet string into the appropriate internal representation.
Definition: netbase.cpp:812
SOCKS5Command
Values defined for CMD in RFC1928.
Definition: netbase.cpp:259
@ UDP_ASSOCIATE
Definition: netbase.cpp:262
@ CONNECT
Definition: netbase.cpp:260
@ BIND
Definition: netbase.cpp:261
static void LogConnectFailure(bool manual_connection, util::ConstevalFormatString< sizeof...(Args)> fmt, const Args &... args)
Definition: netbase.cpp:580
std::unique_ptr< Sock > ConnectDirectly(const CService &dest, bool manual_connection)
Create a socket and try to connect to the specified service.
Definition: netbase.cpp:645
std::vector< CNetAddr > LookupHost(const std::string &name, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function)
Resolve a host string to its corresponding network addresses.
Definition: netbase.cpp:173
static Proxy proxyInfo[NET_MAX] GUARDED_BY(g_proxyinfo_mutex)
std::chrono::milliseconds g_socks5_recv_timeout
Definition: netbase.cpp:40
std::string GetNetworkName(enum Network net)
Definition: netbase.cpp:114
static IntrRecvError InterruptibleRecv(uint8_t *data, size_t len, std::chrono::milliseconds timeout, const Sock &sock)
Try to read a specified number of bytes from a socket.
Definition: netbase.cpp:318
CThreadInterrupt g_socks5_interrupt
Interrupt SOCKS5 reads or writes.
Definition: netbase.cpp:41
SOCKSVersion
SOCKS version.
Definition: netbase.cpp:245
@ SOCKS4
Definition: netbase.cpp:246
@ SOCKS5
Definition: netbase.cpp:247
bool HaveNameProxy()
Definition: netbase.cpp:734
bool SetNameProxy(const Proxy &addrProxy)
Set the name proxy to use for all connections to nodes specified by a hostname.
Definition: netbase.cpp:718
enum Network ParseNetwork(const std::string &net_in)
Definition: netbase.cpp:100
SOCKS5Method
Values defined for METHOD in RFC1928.
Definition: netbase.cpp:251
@ GSSAPI
GSSAPI.
Definition: netbase.cpp:253
@ NOAUTH
No authentication required.
Definition: netbase.cpp:252
@ USER_PASS
Username/password.
Definition: netbase.cpp:254
@ NO_ACCEPTABLE
No acceptable methods.
Definition: netbase.cpp:255
bool Socks5(const std::string &strDest, uint16_t port, const ProxyCredentials *auth, const Sock &sock)
Connect to a specified destination service through an already connected SOCKS5 proxy.
Definition: netbase.cpp:392
static std::string Socks5ErrorString(uint8_t err)
Convert SOCKS5 reply to an error message.
Definition: netbase.cpp:352
bool SetProxy(enum Network net, const Proxy &addrProxy)
Definition: netbase.cpp:700
std::vector< CService > Lookup(const std::string &name, uint16_t portDefault, bool fAllowLookup, unsigned int nMaxSolutions, DNSLookupFn dns_lookup_function)
Resolve a service string to its corresponding service.
Definition: netbase.cpp:191
static std::vector< CNetAddr > LookupIntern(const std::string &name, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function)
Definition: netbase.cpp:144
SOCKS5Reply
Values defined for REP in RFC1928 and https://spec.torproject.org/socks-extensions....
Definition: netbase.cpp:266
@ TTLEXPIRED
RFC1928: TTL expired.
Definition: netbase.cpp:273
@ CMDUNSUPPORTED
RFC1928: Command not supported.
Definition: netbase.cpp:274
@ TOR_HS_WRONG_CLIENT_AUTH
Tor: Onion service wrong client authorization.
Definition: netbase.cpp:281
@ TOR_HS_DESC_INVALID
Tor: Onion service descriptor is invalid.
Definition: netbase.cpp:277
@ NETUNREACHABLE
RFC1928: Network unreachable.
Definition: netbase.cpp:270
@ GENFAILURE
RFC1928: General failure.
Definition: netbase.cpp:268
@ TOR_HS_MISSING_CLIENT_AUTH
Tor: Onion service missing client authorization.
Definition: netbase.cpp:280
@ CONNREFUSED
RFC1928: Connection refused.
Definition: netbase.cpp:272
@ TOR_HS_BAD_ADDRESS
Tor: Onion service invalid address.
Definition: netbase.cpp:282
@ SUCCEEDED
RFC1928: Succeeded.
Definition: netbase.cpp:267
@ ATYPEUNSUPPORTED
RFC1928: Address type not supported.
Definition: netbase.cpp:275
@ NOTALLOWED
RFC1928: Connection not allowed by ruleset.
Definition: netbase.cpp:269
@ TOR_HS_INTRO_FAILED
Tor: Onion service introduction failed.
Definition: netbase.cpp:278
@ TOR_HS_DESC_NOT_FOUND
Tor: Onion service descriptor can not be found.
Definition: netbase.cpp:276
@ HOSTUNREACHABLE
RFC1928: Network unreachable.
Definition: netbase.cpp:271
@ TOR_HS_INTRO_TIMEOUT
Tor: Onion service introduction timed out.
Definition: netbase.cpp:283
@ TOR_HS_REND_FAILED
Tor: Onion service rendezvous failed.
Definition: netbase.cpp:279
CService MaybeFlipIPv6toCJDNS(const CService &service)
If an IPv6 address belongs to the address range used by the CJDNS network and the CJDNS network is re...
Definition: netbase.cpp:942
static GlobalMutex g_proxyinfo_mutex
Definition: netbase.cpp:33
ReachableNets g_reachable_nets
Definition: netbase.cpp:43
std::unique_ptr< Sock > CreateSockOS(int domain, int type, int protocol)
Create a real socket from the operating system.
Definition: netbase.cpp:522
bool fNameLookup
Definition: netbase.cpp:37
bool GetProxy(enum Network net, Proxy &proxyInfoOut)
Definition: netbase.cpp:709
int nConnectTimeout
Definition: netbase.cpp:36
static bool ConnectToSocket(const Sock &sock, struct sockaddr *sockaddr, socklen_t len, const std::string &dest_str, bool manual_connection)
Definition: netbase.cpp:590
std::unique_ptr< Sock > ConnectThroughProxy(const Proxy &proxy, const std::string &dest, uint16_t port, bool &proxy_connection_failed)
Connect to a specified destination service through a SOCKS5 proxy by first connecting to the SOCKS5 p...
Definition: netbase.cpp:785
std::function< std::unique_ptr< Sock >(int, int, int)> CreateSock
Socket factory.
Definition: netbase.cpp:577
bool IsUnixSocketPath(const std::string &name)
Check if a string is a valid UNIX domain socket path.
Definition: netbase.cpp:226
bool GetNameProxy(Proxy &nameProxyOut)
Definition: netbase.cpp:726
CService LookupNumeric(const std::string &name, uint16_t portDefault, DNSLookupFn dns_lookup_function)
Resolve a service string with a numeric IP to its first corresponding service.
Definition: netbase.cpp:216
bool IsProxy(const CNetAddr &addr)
Definition: netbase.cpp:739
bool IsBadPort(uint16_t port)
Determine if a port is "bad" from the perspective of attempting to connect to a node on that port.
Definition: netbase.cpp:847
std::vector< CNetAddr > WrappedGetAddrInfo(const std::string &name, bool allow_lookup)
Wrapper for getaddrinfo(3).
Definition: netbase.cpp:45
DNSLookupFn g_dns_lookup
Definition: netbase.cpp:98
std::vector< std::string > GetNetworkNames(bool append_unroutable)
Return a vector of publicly routable Network names; optionally append NET_UNROUTABLE.
Definition: netbase.cpp:130
static const int DEFAULT_NAME_LOOKUP
-dns default
Definition: netbase.h:28
const std::string ADDR_PREFIX_UNIX
Prefix for unix domain socket addresses (which are local filesystem paths)
Definition: netbase.h:31
std::function< std::vector< CNetAddr >(const std::string &, bool)> DNSLookupFn
Definition: netbase.h:203
static const int DEFAULT_CONNECT_TIMEOUT
-timeout default
Definition: netbase.h:26
void GetRandBytes(std::span< unsigned char > bytes) noexcept
Generate random data via the internal PRNG.
Definition: random.cpp:601
const char * name
Definition: rest.cpp:48
@ OK
The message verification was successful.
std::string NetworkErrorString(int err)
Return readable error string for a network error code.
Definition: sock.cpp:422
static constexpr auto MAX_WAIT_FOR_IO
Maximum time to wait for I/O readiness.
Definition: sock.h:21
Credentials for proxy authentication.
Definition: netbase.h:93
std::string username
Definition: netbase.h:94
std::string password
Definition: netbase.h:95
A wrapper for a compile-time partially validated format string.
Definition: string.h:92
#define LOCK(cs)
Definition: sync.h:259
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
bool SplitHostPort(std::string_view in, uint16_t &portOut, std::string &hostOut)
Splits socket address string into host string and port value.
std::string ToLower(std::string_view str)
Returns the lowercase equivalent of the given string.
assert(!tx.IsCoinBase())