Bitcoin Core  0.20.99
P2P Digital Currency
Classes | Macros | Enumerations | Functions | Variables
netbase.cpp File Reference
#include <netbase.h>
#include <sync.h>
#include <tinyformat.h>
#include <util/strencodings.h>
#include <util/string.h>
#include <util/system.h>
#include <atomic>
#include <cstdint>
#include <limits>
#include <fcntl.h>
Include dependency graph for netbase.cpp:

Go to the source code of this file.

Classes

struct  ProxyCredentials
 Credentials for proxy authentication. More...
 

Macros

#define MSG_NOSIGNAL   0
 

Enumerations

enum  SOCKSVersion : uint8_t { SOCKS4 = 0x04, SOCKS5 = 0x05 }
 SOCKS version. More...
 
enum  SOCKS5Method : uint8_t { NOAUTH = 0x00, GSSAPI = 0x01, USER_PASS = 0x02, NO_ACCEPTABLE = 0xff }
 Values defined for METHOD in RFC1928. More...
 
enum  SOCKS5Command : uint8_t { CONNECT = 0x01, BIND = 0x02, UDP_ASSOCIATE = 0x03 }
 Values defined for CMD in RFC1928. More...
 
enum  SOCKS5Reply : uint8_t {
  SUCCEEDED = 0x00, GENFAILURE = 0x01, NOTALLOWED = 0x02, NETUNREACHABLE = 0x03,
  HOSTUNREACHABLE = 0x04, CONNREFUSED = 0x05, TTLEXPIRED = 0x06, CMDUNSUPPORTED = 0x07,
  ATYPEUNSUPPORTED = 0x08
}
 Values defined for REP in RFC1928. More...
 
enum  SOCKS5Atyp : uint8_t { IPV4 = 0x01, DOMAINNAME = 0x03, IPV6 = 0x04 }
 Values defined for ATYPE in RFC1928. More...
 
enum  IntrRecvError {
  IntrRecvError::OK, IntrRecvError::Timeout, IntrRecvError::Disconnected, IntrRecvError::NetworkError,
  IntrRecvError::Interrupted
}
 Status codes that can be returned by InterruptibleRecv. More...
 

Functions

static proxyType proxyInfo [NET_MAXGUARDED_BY (g_proxyinfo_mutex)
 
static std::atomic< bool > interruptSocks5Recv (false)
 
enum Network ParseNetwork (const std::string &net_in)
 
std::string GetNetworkName (enum Network net)
 
static bool LookupIntern (const std::string &name, std::vector< CNetAddr > &vIP, unsigned int nMaxSolutions, bool fAllowLookup)
 
bool LookupHost (const std::string &name, std::vector< CNetAddr > &vIP, unsigned int nMaxSolutions, bool fAllowLookup)
 Resolve a host string to its corresponding network addresses. More...
 
bool LookupHost (const std::string &name, CNetAddr &addr, bool fAllowLookup)
 Resolve a host string to its first corresponding network address. More...
 
bool Lookup (const std::string &name, std::vector< CService > &vAddr, int portDefault, bool fAllowLookup, unsigned int nMaxSolutions)
 Resolve a service string to its corresponding service. More...
 
bool Lookup (const std::string &name, CService &addr, int portDefault, bool fAllowLookup)
 Resolve a service string to its first corresponding service. More...
 
CService LookupNumeric (const std::string &name, int portDefault)
 Resolve a service string with a numeric IP to its first corresponding service. More...
 
struct timeval MillisToTimeval (int64_t nTimeout)
 Convert milliseconds to a struct timeval for e.g. More...
 
static IntrRecvError InterruptibleRecv (uint8_t *data, size_t len, int timeout, const SOCKET &hSocket)
 Try to read a specified number of bytes from a socket. More...
 
static std::string Socks5ErrorString (uint8_t err)
 Convert SOCKS5 reply to an error message. More...
 
static bool Socks5 (const std::string &strDest, int port, const ProxyCredentials *auth, const SOCKET &hSocket)
 Connect to a specified destination service through an already connected SOCKS5 proxy. More...
 
SOCKET CreateSocket (const CService &addrConnect)
 Try to create a socket file descriptor with specific properties in the communications domain (address family) of the specified service. More...
 
template<typename... Args>
static void LogConnectFailure (bool manual_connection, const char *fmt, const Args &... args)
 
bool ConnectSocketDirectly (const CService &addrConnect, const SOCKET &hSocket, int nTimeout, bool manual_connection)
 Try to connect to the specified service on the specified socket. More...
 
bool SetProxy (enum Network net, const proxyType &addrProxy)
 
bool GetProxy (enum Network net, proxyType &proxyInfoOut)
 
bool SetNameProxy (const proxyType &addrProxy)
 Set the name proxy to use for all connections to nodes specified by a hostname. More...
 
bool GetNameProxy (proxyType &nameProxyOut)
 
bool HaveNameProxy ()
 
bool IsProxy (const CNetAddr &addr)
 
bool ConnectThroughProxy (const proxyType &proxy, const std::string &strDest, int port, const SOCKET &hSocket, int nTimeout, bool &outProxyConnectionFailed)
 Connect to a specified destination service through a SOCKS5 proxy by first connecting to the SOCKS5 proxy. More...
 
bool LookupSubNet (const std::string &strSubnet, CSubNet &ret)
 Parse and resolve a specified subnet string into the appropriate internal representation. More...
 
std::string NetworkErrorString (int err)
 Return readable error string for a network error code. More...
 
bool CloseSocket (SOCKET &hSocket)
 Close socket and set hSocket to INVALID_SOCKET. More...
 
bool SetSocketNonBlocking (const SOCKET &hSocket, bool fNonBlocking)
 Disable or enable blocking-mode for a socket. More...
 
bool SetSocketNoDelay (const SOCKET &hSocket)
 Set the TCP_NODELAY flag on a socket. More...
 
void InterruptSocks5 (bool interrupt)
 

Variables

static Mutex g_proxyinfo_mutex
 
int nConnectTimeout = DEFAULT_CONNECT_TIMEOUT
 
bool fNameLookup = DEFAULT_NAME_LOOKUP
 
static const int SOCKS5_RECV_TIMEOUT = 20 * 1000
 

Macro Definition Documentation

◆ MSG_NOSIGNAL

#define MSG_NOSIGNAL   0

Definition at line 29 of file netbase.cpp.

Enumeration Type Documentation

◆ IntrRecvError

enum IntrRecvError
strong

Status codes that can be returned by InterruptibleRecv.

Enumerator
OK 
Timeout 
Disconnected 
NetworkError 
Interrupted 

Definition at line 318 of file netbase.cpp.

◆ SOCKS5Atyp

enum SOCKS5Atyp : uint8_t

Values defined for ATYPE in RFC1928.

Enumerator
IPV4 
DOMAINNAME 
IPV6 

Definition at line 311 of file netbase.cpp.

◆ SOCKS5Command

enum SOCKS5Command : uint8_t

Values defined for CMD in RFC1928.

Enumerator
CONNECT 
BIND 
UDP_ASSOCIATE 

Definition at line 291 of file netbase.cpp.

◆ SOCKS5Method

enum SOCKS5Method : uint8_t

Values defined for METHOD in RFC1928.

Enumerator
NOAUTH 

No authentication required.

GSSAPI 

GSSAPI.

USER_PASS 

Username/password.

NO_ACCEPTABLE 

No acceptable methods.

Definition at line 283 of file netbase.cpp.

◆ SOCKS5Reply

enum SOCKS5Reply : uint8_t

Values defined for REP in RFC1928.

Enumerator
SUCCEEDED 

Succeeded.

GENFAILURE 

General failure.

NOTALLOWED 

Connection not allowed by ruleset.

NETUNREACHABLE 

Network unreachable.

HOSTUNREACHABLE 

Network unreachable.

CONNREFUSED 

Connection refused.

TTLEXPIRED 

TTL expired.

CMDUNSUPPORTED 

Command not supported.

ATYPEUNSUPPORTED 

Address type not supported.

Definition at line 298 of file netbase.cpp.

◆ SOCKSVersion

enum SOCKSVersion : uint8_t

SOCKS version.

Enumerator
SOCKS4 
SOCKS5 

Definition at line 277 of file netbase.cpp.

Function Documentation

◆ CloseSocket()

bool CloseSocket ( SOCKET hSocket)

Close socket and set hSocket to INVALID_SOCKET.

Definition at line 901 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConnectSocketDirectly()

bool ConnectSocketDirectly ( const CService addrConnect,
const SOCKET hSocket,
int  nTimeout,
bool  manual_connection 
)

Try to connect to the specified service on the specified socket.

Parameters
addrConnectThe service to which to connect.
hSocketThe socket on which to connect.
nTimeoutWait this many milliseconds for the connection to be established.
manual_connectionWhether or not the connection was manually requested (e.g. through the addnode RPC)
Returns
Whether or not a connection was successfully made.

Definition at line 632 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConnectThroughProxy()

bool ConnectThroughProxy ( const proxyType proxy,
const std::string &  strDest,
int  port,
const SOCKET hSocket,
int  nTimeout,
bool &  outProxyConnectionFailed 
)

Connect to a specified destination service through a SOCKS5 proxy by first connecting to the SOCKS5 proxy.

Parameters
proxyThe SOCKS5 proxy.
strDestThe destination service to which to connect.
portThe destination port.
hSocketThe socket on which to connect to the SOCKS5 proxy.
nTimeoutWait this many milliseconds for the connection to the SOCKS5 proxy to be established.
[out]outProxyConnectionFailedWhether or not the connection to the SOCKS5 proxy failed.
Returns
Whether or not the operation succeeded.

Definition at line 791 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CreateSocket()

SOCKET CreateSocket ( const CService addrConnect)

Try to create a socket file descriptor with specific properties in the communications domain (address family) of the specified service.

For details on the desired properties, see the inline comments in the source code.

Definition at line 569 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetNameProxy()

bool GetNameProxy ( proxyType nameProxyOut)

Definition at line 754 of file netbase.cpp.

Here is the caller graph for this function:

◆ GetNetworkName()

std::string GetNetworkName ( enum Network  net)

Definition at line 55 of file netbase.cpp.

Here is the caller graph for this function:

◆ GetProxy()

bool GetProxy ( enum Network  net,
proxyType proxyInfoOut 
)

Definition at line 721 of file netbase.cpp.

Here is the caller graph for this function:

◆ GUARDED_BY()

static proxyType nameProxy GUARDED_BY ( g_proxyinfo_mutex  )
static

◆ HaveNameProxy()

bool HaveNameProxy ( )

Definition at line 762 of file netbase.cpp.

Here is the caller graph for this function:

◆ InterruptibleRecv()

static IntrRecvError InterruptibleRecv ( uint8_t *  data,
size_t  len,
int  timeout,
const SOCKET hSocket 
)
static

Try to read a specified number of bytes from a socket.

Please read the "see also" section for more detail.

Parameters
dataThe buffer where the read bytes should be stored.
lenThe number of bytes to read into the specified buffer.
timeoutThe total timeout in milliseconds for this read.
hSocketThe socket (has to be in non-blocking mode) from which to read bytes.
Returns
An IntrRecvError indicating the resulting status of this read. IntrRecvError::OK only if all of the specified number of bytes were read.
See also
This function can be interrupted by calling InterruptSocks5(bool). Sockets can be made non-blocking with SetSocketNonBlocking(const SOCKET&, bool).

Definition at line 344 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ InterruptSocks5()

void InterruptSocks5 ( bool  interrupt)

Definition at line 951 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ interruptSocks5Recv()

static std::atomic<bool> interruptSocks5Recv ( false  )
static
Here is the caller graph for this function:

◆ IsProxy()

bool IsProxy ( const CNetAddr addr)

Definition at line 767 of file netbase.cpp.

◆ LogConnectFailure()

template<typename... Args>
static void LogConnectFailure ( bool  manual_connection,
const char *  fmt,
const Args &...  args 
)
static

Definition at line 611 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Lookup() [1/2]

bool Lookup ( const std::string &  name,
std::vector< CService > &  vAddr,
int  portDefault,
bool  fAllowLookup,
unsigned int  nMaxSolutions 
)

Resolve a service string to its corresponding service.

Parameters
nameThe string representing a service. Could be a name or a numerical IP address (IPv6 addresses should be in their disambiguated bracketed form), optionally followed by a port number. (e.g. example.com:8333 or
[out]vAddrThe resulting services to which the specified service string resolved.
portDefaultThe default port for resulting services if not specified by the service string.
fAllowLookupWhether or not hostname lookups are permitted. If yes, external queries may be performed.
nMaxSolutionsThe maximum number of results we want, specifying 0 means "as many solutions as we get."
Returns
Whether or not the service string successfully resolved to any resulting services.

Definition at line 207 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Lookup() [2/2]

bool Lookup ( const std::string &  name,
CService addr,
int  portDefault,
bool  fAllowLookup 
)

Resolve a service string to its first corresponding service.

See also
Lookup(const char *, std::vector<CService>&, int, bool, unsigned int) for additional parameter descriptions.

Definition at line 232 of file netbase.cpp.

Here is the call graph for this function:

◆ LookupHost() [1/2]

bool LookupHost ( const std::string &  name,
std::vector< CNetAddr > &  vIP,
unsigned int  nMaxSolutions,
bool  fAllowLookup 
)

Resolve a host string to its corresponding network addresses.

Parameters
nameThe string representing a host. Could be a name or a numerical IP address (IPv6 addresses in their bracketed form are allowed).
[out]vIPThe resulting network addresses to which the specified host string resolved.
Returns
Whether or not the specified host string successfully resolved to any resulting network addresses.
See also
Lookup(const char *, std::vector<CService>&, int, bool, unsigned int) for additional parameter descriptions.

Definition at line 153 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LookupHost() [2/2]

bool LookupHost ( const std::string &  name,
CNetAddr addr,
bool  fAllowLookup 
)

Resolve a host string to its first corresponding network address.

See also
LookupHost(const std::string&, std::vector<CNetAddr>&, unsigned int, bool) for additional parameter descriptions.

Definition at line 174 of file netbase.cpp.

Here is the call graph for this function:

◆ LookupIntern()

static bool LookupIntern ( const std::string &  name,
std::vector< CNetAddr > &  vIP,
unsigned int  nMaxSolutions,
bool  fAllowLookup 
)
static

Definition at line 65 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LookupNumeric()

CService LookupNumeric ( const std::string &  name,
int  portDefault 
)

Resolve a service string with a numeric IP to its first corresponding service.

Returns
The resulting CService if the resolution was successful, [::]:0 otherwise.
See also
Lookup(const char *, CService&, int, bool) for additional parameter descriptions.

Definition at line 255 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LookupSubNet()

bool LookupSubNet ( const std::string &  strSubnet,
CSubNet ret 
)

Parse and resolve a specified subnet string into the appropriate internal representation.

Parameters
strSubnetA string representation of a subnet of the form network address [ "/", ( CIDR-style suffix | netmask ) ](e.g. 2001:db8::/32, 192.0.2.0/255.255.255.0, or 8.8.8.8).
retThe resulting internal representation of a subnet.
Returns
Whether the operation succeeded or not.

Definition at line 825 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ MillisToTimeval()

struct timeval MillisToTimeval ( int64_t  nTimeout)

Convert milliseconds to a struct timeval for e.g.

select.

Definition at line 268 of file netbase.cpp.

Here is the caller graph for this function:

◆ NetworkErrorString()

std::string NetworkErrorString ( int  err)

Return readable error string for a network error code.

Definition at line 883 of file netbase.cpp.

Here is the caller graph for this function:

◆ ParseNetwork()

enum Network ParseNetwork ( const std::string &  net_in)

Definition at line 43 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetNameProxy()

bool SetNameProxy ( const proxyType addrProxy)

Set the name proxy to use for all connections to nodes specified by a hostname.

After setting this proxy, connecting to a node specified by a hostname won't result in a local lookup of said hostname, rather, connect to the node by asking the name proxy for a proxy connection to the hostname, effectively delegating the hostname lookup to the specified proxy.

This delegation increases privacy for those who set the name proxy as they no longer leak their external hostname queries to their DNS servers.

Returns
Whether or not the operation succeeded.
Note
SOCKS5's support for UDP-over-SOCKS5 has been considered, but no SOCK5 server in common use (most notably Tor) actually implements UDP support, and a DNS resolver is beyond the scope of this project.

Definition at line 746 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetProxy()

bool SetProxy ( enum Network  net,
const proxyType addrProxy 
)

Definition at line 712 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SetSocketNoDelay()

bool SetSocketNoDelay ( const SOCKET hSocket)

Set the TCP_NODELAY flag on a socket.

Definition at line 944 of file netbase.cpp.

Here is the caller graph for this function:

◆ SetSocketNonBlocking()

bool SetSocketNonBlocking ( const SOCKET hSocket,
bool  fNonBlocking 
)

Disable or enable blocking-mode for a socket.

Definition at line 917 of file netbase.cpp.

Here is the caller graph for this function:

◆ Socks5()

static bool Socks5 ( const std::string &  strDest,
int  port,
const ProxyCredentials auth,
const SOCKET hSocket 
)
static

Connect to a specified destination service through an already connected SOCKS5 proxy.

Parameters
strDestThe destination fully-qualified domain name.
portThe destination port.
authThe credentials with which to authenticate with the specified SOCKS5 proxy.
hSocketThe SOCKS5 proxy socket.
Returns
Whether or not the operation succeeded.
Note
The specified SOCKS5 proxy socket must already be connected to the SOCKS5 proxy.
See also
RFC1928: SOCKS Protocol Version 5

Definition at line 443 of file netbase.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Socks5ErrorString()

static std::string Socks5ErrorString ( uint8_t  err)
static

Convert SOCKS5 reply to an error message.

Definition at line 401 of file netbase.cpp.

Here is the caller graph for this function:

Variable Documentation

◆ fNameLookup

bool fNameLookup = DEFAULT_NAME_LOOKUP

Definition at line 37 of file netbase.cpp.

◆ g_proxyinfo_mutex

Mutex g_proxyinfo_mutex
static

Definition at line 33 of file netbase.cpp.

◆ nConnectTimeout

int nConnectTimeout = DEFAULT_CONNECT_TIMEOUT

Definition at line 36 of file netbase.cpp.

◆ SOCKS5_RECV_TIMEOUT

const int SOCKS5_RECV_TIMEOUT = 20 * 1000
static

Definition at line 40 of file netbase.cpp.