netbase.h

Go to the documentation of this file.

// Copyright (c) 2009-2016 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_NETBASE_H
#define BITCOIN_NETBASE_H
 
#if defined(HAVE_CONFIG_H)
#include <config/bitcoin-config.h>
#endif
 
#include <compat/compat.h>
#include <netaddress.h>
#include <serialize.h>
#include <util/sock.h>
 
#include <cstdint>
#include <functional>
#include <memory>
#include <string>
#include <type_traits>
#include <vector>
 
extern int nConnectTimeout;
extern bool fNameLookup;
 
static const int DEFAULT_CONNECT_TIMEOUT = 5000;
static const int DEFAULT_NAME_LOOKUP = true;
 
const std::string ADDR_PREFIX_UNIX = "unix:";
 
enum class ConnectionDirection {
    None = 0,
    In = (1U << 0),
    Out = (1U << 1),
    Both = (In | Out),
};
 
static inline ConnectionDirection &operator|=(ConnectionDirection &a,
                                              ConnectionDirection b) {
    using underlying = typename std::underlying_type<ConnectionDirection>::type;
    a = ConnectionDirection(underlying(a) | underlying(b));
    return a;
}
 
static inline bool operator&(ConnectionDirection a, ConnectionDirection b) {
    using underlying = typename std::underlying_type<ConnectionDirection>::type;
    return (underlying(a) & underlying(b));
}
 
bool IsUnixSocketPath(const std::string &name);
 
class Proxy {
public:
    Proxy() : m_is_unix_socket(false), m_randomize_credentials(false) {}
    explicit Proxy(const CService &_proxy, bool randomize_credentials = false)
        : proxy(_proxy), m_is_unix_socket(false),
          m_randomize_credentials(randomize_credentials) {}
    explicit Proxy(const std::string path, bool randomize_credentials = false)
        : m_unix_socket_path(path), m_is_unix_socket(true),
          m_randomize_credentials(randomize_credentials) {}
 
    CService proxy;
    std::string m_unix_socket_path;
    bool m_is_unix_socket;
    bool m_randomize_credentials;
 
    bool IsValid() const {
        if (m_is_unix_socket) {
            return IsUnixSocketPath(m_unix_socket_path);
        }
        return proxy.IsValid();
    }
 
    sa_family_t GetFamily() const {
        if (m_is_unix_socket) {
            return AF_UNIX;
        }
        return proxy.GetSAFamily();
    }
 
    std::string ToString() const {
        if (m_is_unix_socket) {
            return m_unix_socket_path;
        }
        return proxy.ToStringAddrPort();
    }
 
    std::unique_ptr<Sock> Connect() const;
};
 
struct ProxyCredentials {
    std::string username;
    std::string password;
};
 
std::vector<CNetAddr> WrappedGetAddrInfo(const std::string &name,
                                         bool allow_lookup);
 
enum Network ParseNetwork(const std::string &net);
std::string GetNetworkName(enum Network net);
std::vector<std::string> GetNetworkNames(bool append_unroutable = false);
bool SetProxy(enum Network net, const Proxy &addrProxy);
bool GetProxy(enum Network net, Proxy &proxyInfoOut);
bool IsProxy(const CNetAddr &addr);
 
bool SetNameProxy(const Proxy &addrProxy);
bool HaveNameProxy();
bool GetNameProxy(Proxy &nameProxyOut);
 
using DNSLookupFn =
    std::function<std::vector<CNetAddr>(const std::string &, bool)>;
extern DNSLookupFn g_dns_lookup;
 
std::vector<CNetAddr>
LookupHost(const std::string &name, unsigned int nMaxSolutions,
           bool fAllowLookup, DNSLookupFn dns_lookup_function = g_dns_lookup);
 
std::optional<CNetAddr>
LookupHost(const std::string &name, bool fAllowLookup,
           DNSLookupFn dns_lookup_function = g_dns_lookup);
 
std::vector<CService> Lookup(const std::string &name, uint16_t portDefault,
                             bool fAllowLookup, unsigned int nMaxSolutions,
                             DNSLookupFn dns_lookup_function = g_dns_lookup);
 
std::optional<CService> Lookup(const std::string &name, uint16_t portDefault,
                               bool fAllowLookup,
                               DNSLookupFn dns_lookup_function = g_dns_lookup);
 
CService LookupNumeric(const std::string &name, uint16_t portDefault = 0,
                       DNSLookupFn dns_lookup_function = g_dns_lookup);
 
bool LookupSubNet(const std::string &strSubnet, CSubNet &subnet,
                  DNSLookupFn dns_lookup_function = g_dns_lookup);
 
std::unique_ptr<Sock> CreateSockOS(int domain, int type, int protocol);
 
extern std::function<std::unique_ptr<Sock>(int, int, int)> CreateSock;
 
std::unique_ptr<Sock> ConnectDirectly(const CService &dest,
                                      bool manual_connection);
 
std::unique_ptr<Sock> ConnectThroughProxy(const Proxy &proxy,
                                          const std::string &dest,
                                          uint16_t port,
                                          bool &proxy_connection_failed);
 
void InterruptSocks5(bool interrupt);
 
bool Socks5(const std::string &strDest, uint16_t port,
            const ProxyCredentials *auth, const Sock &socket);
 
bool IsBadPort(uint16_t port);
 
#endif // BITCOIN_NETBASE_H