Bitcoin Core  27.99.0
P2P Digital Currency
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | Private Member Functions | Static Private Attributes | Friends | List of all members
CNetAddr Class Reference

Network address. More...

#include <netaddress.h>

Inheritance diagram for CNetAddr:
[legend]
Collaboration diagram for CNetAddr:
[legend]

Classes

struct  SerParams
 

Public Types

enum class  Encoding { V1 , V2 }
 
enum  BIP155Network : uint8_t {
  IPV4 = 1 , IPV6 = 2 , TORV2 = 3 , TORV3 = 4 ,
  I2P = 5 , CJDNS = 6
}
 BIP155 network ids recognized by this software. More...
 

Public Member Functions

 CNetAddr ()
 Construct an unspecified IPv6 network address (::/128). More...
 
 CNetAddr (const struct in_addr &ipv4Addr)
 
void SetIP (const CNetAddr &ip)
 
void SetLegacyIPv6 (Span< const uint8_t > ipv6)
 Set from a legacy IPv6 address. More...
 
bool SetInternal (const std::string &name)
 Create an "internal" address that represents a name or FQDN. More...
 
bool SetSpecial (const std::string &addr)
 Parse a Tor or I2P address and set this object to it. More...
 
bool IsBindAny () const
 
bool IsIPv4 () const
 
bool IsIPv6 () const
 
bool IsRFC1918 () const
 
bool IsRFC2544 () const
 
bool IsRFC6598 () const
 
bool IsRFC5737 () const
 
bool IsRFC3849 () const
 
bool IsRFC3927 () const
 
bool IsRFC3964 () const
 
bool IsRFC4193 () const
 
bool IsRFC4380 () const
 
bool IsRFC4843 () const
 
bool IsRFC7343 () const
 
bool IsRFC4862 () const
 
bool IsRFC6052 () const
 
bool IsRFC6145 () const
 
bool IsHeNet () const
 
bool IsTor () const
 
bool IsI2P () const
 
bool IsCJDNS () const
 
bool HasCJDNSPrefix () const
 
bool IsLocal () const
 
bool IsRoutable () const
 
bool IsInternal () const
 
bool IsValid () const
 
bool IsPrivacyNet () const
 Whether this object is a privacy network. More...
 
bool IsAddrV1Compatible () const
 Check if the current object can be serialized in pre-ADDRv2/BIP155 format. More...
 
enum Network GetNetwork () const
 
std::string ToStringAddr () const
 
bool GetInAddr (struct in_addr *pipv4Addr) const
 Try to get our IPv4 address. More...
 
Network GetNetClass () const
 
uint32_t GetLinkedIPv4 () const
 For IPv4, mapped IPv4, SIIT translated IPv4, Teredo, 6to4 tunneled addresses, return the relevant IPv4 address as a uint32. More...
 
bool HasLinkedIPv4 () const
 Whether this address has a linked IPv4 address (see GetLinkedIPv4()). More...
 
std::vector< unsigned char > GetAddrBytes () const
 
int GetReachabilityFrom (const CNetAddr &paddrPartner) const
 Calculates a metric for how reachable (*this) is from a given partner. More...
 
 CNetAddr (const struct in6_addr &pipv6Addr, const uint32_t scope=0)
 
bool GetIn6Addr (struct in6_addr *pipv6Addr) const
 Try to get our IPv6 (or CJDNS) address. More...
 
bool IsRelayable () const
 Whether this address should be relayed to other peers even if we can't reach it ourselves. More...
 
template<typename Stream >
void Serialize (Stream &s) const
 Serialize to a stream. More...
 
template<typename Stream >
void Unserialize (Stream &s)
 Unserialize from a stream. More...
 

Static Public Attributes

static constexpr SerParams V1 {Encoding::V1}
 
static constexpr SerParams V2 {Encoding::V2}
 

Protected Attributes

prevector< ADDR_IPV6_SIZE, uint8_t > m_addr {ADDR_IPV6_SIZE, 0x0}
 Raw representation of the network address. More...
 
Network m_net {NET_IPV6}
 Network to which this address belongs. More...
 
uint32_t m_scope_id {0}
 Scope id if scoped/link-local IPV6 address. More...
 

Private Member Functions

bool SetTor (const std::string &addr)
 Parse a Tor address and set this object to it. More...
 
bool SetI2P (const std::string &addr)
 Parse an I2P address and set this object to it. More...
 
BIP155Network GetBIP155Network () const
 Get the BIP155 network id of this address. More...
 
bool SetNetFromBIP155Network (uint8_t possible_bip155_net, size_t address_size)
 Set m_net from the provided BIP155 network id and size after validation. More...
 
void SerializeV1Array (uint8_t(&arr)[V1_SERIALIZATION_SIZE]) const
 Serialize in pre-ADDRv2/BIP155 format to an array. More...
 
template<typename Stream >
void SerializeV1Stream (Stream &s) const
 Serialize in pre-ADDRv2/BIP155 format to a stream. More...
 
template<typename Stream >
void SerializeV2Stream (Stream &s) const
 Serialize as ADDRv2 / BIP155. More...
 
void UnserializeV1Array (uint8_t(&arr)[V1_SERIALIZATION_SIZE])
 Unserialize from a pre-ADDRv2/BIP155 format from an array. More...
 
template<typename Stream >
void UnserializeV1Stream (Stream &s)
 Unserialize from a pre-ADDRv2/BIP155 format from a stream. More...
 
template<typename Stream >
void UnserializeV2Stream (Stream &s)
 Unserialize from a ADDRv2 / BIP155 format. More...
 

Static Private Attributes

static constexpr size_t V1_SERIALIZATION_SIZE = ADDR_IPV6_SIZE
 Size of CNetAddr when serialized as ADDRv1 (pre-BIP155) (in bytes). More...
 
static constexpr size_t MAX_ADDRV2_SIZE = 512
 Maximum size of an address as defined in BIP155 (in bytes). More...
 

Friends

class CSubNet
 
bool operator== (const CNetAddr &a, const CNetAddr &b)
 
bool operator!= (const CNetAddr &a, const CNetAddr &b)
 
bool operator< (const CNetAddr &a, const CNetAddr &b)
 

Detailed Description

Network address.

Definition at line 111 of file netaddress.h.

Member Enumeration Documentation

◆ BIP155Network

enum CNetAddr::BIP155Network : uint8_t

BIP155 network ids recognized by this software.

Enumerator
IPV4 
IPV6 
TORV2 
TORV3 
I2P 
CJDNS 

Definition at line 263 of file netaddress.h.

◆ Encoding

enum CNetAddr::Encoding
strong
Enumerator
V1 
V2 

BIP155 encoding.

Definition at line 223 of file netaddress.h.

Constructor & Destructor Documentation

◆ CNetAddr() [1/3]

CNetAddr::CNetAddr ( )
default

Construct an unspecified IPv6 network address (::/128).

Note
This address is considered invalid by CNetAddr::IsValid()

◆ CNetAddr() [2/3]

CNetAddr::CNetAddr ( const struct in_addr &  ipv4Addr)
explicit

Definition at line 291 of file netaddress.cpp.

Here is the call graph for this function:

◆ CNetAddr() [3/3]

CNetAddr::CNetAddr ( const struct in6_addr &  pipv6Addr,
const uint32_t  scope = 0 
)
explicit

Definition at line 298 of file netaddress.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ GetAddrBytes()

std::vector< unsigned char > CNetAddr::GetAddrBytes ( ) const

Definition at line 693 of file netaddress.cpp.

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

◆ GetBIP155Network()

CNetAddr::BIP155Network CNetAddr::GetBIP155Network ( ) const
private

Get the BIP155 network id of this address.

Must not be called for IsInternal() objects.

Returns
BIP155 network id, except TORV2 which is no longer supported.

Definition at line 23 of file netaddress.cpp.

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

◆ GetIn6Addr()

bool CNetAddr::GetIn6Addr ( struct in6_addr *  pipv6Addr) const

Try to get our IPv6 (or CJDNS) address.

Parameters
[out]pipv6AddrThe in6_addr struct to which to copy.
Returns
Whether or not the operation was successful, in particular, whether or not our address was an IPv6 address.
See also
CNetAddr::IsIPv6()

Definition at line 643 of file netaddress.cpp.

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

◆ GetInAddr()

bool CNetAddr::GetInAddr ( struct in_addr *  pipv4Addr) const

Try to get our IPv4 address.

Parameters
[out]pipv4AddrThe in_addr struct to which to copy.
Returns
Whether or not the operation was successful, in particular, whether or not our address was an IPv4 address.
See also
CNetAddr::IsIPv4()

Definition at line 624 of file netaddress.cpp.

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

◆ GetLinkedIPv4()

uint32_t CNetAddr::GetLinkedIPv4 ( ) const

For IPv4, mapped IPv4, SIIT translated IPv4, Teredo, 6to4 tunneled addresses, return the relevant IPv4 address as a uint32.

Definition at line 658 of file netaddress.cpp.

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

◆ GetNetClass()

Network CNetAddr::GetNetClass ( ) const

Definition at line 675 of file netaddress.cpp.

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

◆ GetNetwork()

enum Network CNetAddr::GetNetwork ( ) const

Definition at line 478 of file netaddress.cpp.

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

◆ GetReachabilityFrom()

int CNetAddr::GetReachabilityFrom ( const CNetAddr paddrPartner) const

Calculates a metric for how reachable (*this) is from a given partner.

Definition at line 714 of file netaddress.cpp.

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

◆ HasCJDNSPrefix()

bool CNetAddr::HasCJDNSPrefix ( ) const
inline

Definition at line 177 of file netaddress.h.

Here is the caller graph for this function:

◆ HasLinkedIPv4()

bool CNetAddr::HasLinkedIPv4 ( ) const

Whether this address has a linked IPv4 address (see GetLinkedIPv4()).

Definition at line 653 of file netaddress.cpp.

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

◆ IsAddrV1Compatible()

bool CNetAddr::IsAddrV1Compatible ( ) const

Check if the current object can be serialized in pre-ADDRv2/BIP155 format.

Definition at line 478 of file netaddress.cpp.

Here is the caller graph for this function:

◆ IsBindAny()

bool CNetAddr::IsBindAny ( ) const

Definition at line 304 of file netaddress.cpp.

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

◆ IsCJDNS()

bool CNetAddr::IsCJDNS ( ) const
inline

Definition at line 176 of file netaddress.h.

Here is the caller graph for this function:

◆ IsHeNet()

bool CNetAddr::IsHeNet ( ) const

Definition at line 394 of file netaddress.cpp.

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

◆ IsI2P()

bool CNetAddr::IsI2P ( ) const
inline

Definition at line 175 of file netaddress.h.

Here is the caller graph for this function:

◆ IsInternal()

bool CNetAddr::IsInternal ( ) const
Returns
Whether or not this is a dummy address that represents a name.
See also
CNetAddr::SetInternal(const std::string &)

Definition at line 473 of file netaddress.cpp.

Here is the caller graph for this function:

◆ IsIPv4()

bool CNetAddr::IsIPv4 ( ) const
inline

Definition at line 157 of file netaddress.h.

Here is the caller graph for this function:

◆ IsIPv6()

bool CNetAddr::IsIPv6 ( ) const
inline

Definition at line 158 of file netaddress.h.

Here is the caller graph for this function:

◆ IsLocal()

bool CNetAddr::IsLocal ( ) const

Definition at line 399 of file netaddress.cpp.

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

◆ IsPrivacyNet()

bool CNetAddr::IsPrivacyNet ( ) const
inline

Whether this object is a privacy network.

TODO: consider adding IsCJDNS() here when more peers adopt CJDNS, see: https://github.com/bitcoin/bitcoin/pull/27411#issuecomment-1497176155

Definition at line 188 of file netaddress.h.

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

◆ IsRelayable()

bool CNetAddr::IsRelayable ( ) const
inline

Whether this address should be relayed to other peers even if we can't reach it ourselves.

Definition at line 218 of file netaddress.h.

Here is the call graph for this function:

◆ IsRFC1918()

bool CNetAddr::IsRFC1918 ( ) const

Definition at line 312 of file netaddress.cpp.

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

◆ IsRFC2544()

bool CNetAddr::IsRFC2544 ( ) const

Definition at line 320 of file netaddress.cpp.

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

◆ IsRFC3849()

bool CNetAddr::IsRFC3849 ( ) const

Definition at line 342 of file netaddress.cpp.

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

◆ IsRFC3927()

bool CNetAddr::IsRFC3927 ( ) const

Definition at line 325 of file netaddress.cpp.

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

◆ IsRFC3964()

bool CNetAddr::IsRFC3964 ( ) const

Definition at line 347 of file netaddress.cpp.

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

◆ IsRFC4193()

bool CNetAddr::IsRFC4193 ( ) const

Definition at line 370 of file netaddress.cpp.

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

◆ IsRFC4380()

bool CNetAddr::IsRFC4380 ( ) const

Definition at line 359 of file netaddress.cpp.

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

◆ IsRFC4843()

bool CNetAddr::IsRFC4843 ( ) const

Definition at line 382 of file netaddress.cpp.

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

◆ IsRFC4862()

bool CNetAddr::IsRFC4862 ( ) const

Definition at line 364 of file netaddress.cpp.

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

◆ IsRFC5737()

bool CNetAddr::IsRFC5737 ( ) const

Definition at line 335 of file netaddress.cpp.

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

◆ IsRFC6052()

bool CNetAddr::IsRFC6052 ( ) const

Definition at line 352 of file netaddress.cpp.

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

◆ IsRFC6145()

bool CNetAddr::IsRFC6145 ( ) const

Definition at line 375 of file netaddress.cpp.

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

◆ IsRFC6598()

bool CNetAddr::IsRFC6598 ( ) const

Definition at line 330 of file netaddress.cpp.

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

◆ IsRFC7343()

bool CNetAddr::IsRFC7343 ( ) const

Definition at line 388 of file netaddress.cpp.

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

◆ IsRoutable()

bool CNetAddr::IsRoutable ( ) const
Returns
Whether or not this network address is publicly routable on the global internet.
Note
A routable address is always valid. As in, the set of routable addresses is a subset of the set of valid addresses.
See also
CNetAddr::IsValid()

Definition at line 463 of file netaddress.cpp.

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

◆ IsTor()

bool CNetAddr::IsTor ( ) const
inline

Definition at line 174 of file netaddress.h.

Here is the caller graph for this function:

◆ IsValid()

bool CNetAddr::IsValid ( ) const
Returns
Whether or not this network address is a valid address that could be used to refer to an actual host.
Note
A valid address may or may not be publicly routable on the global internet. As in, the set of valid addresses is a superset of the set of publicly routable addresses.
See also
CNetAddr::IsRoutable()

Definition at line 425 of file netaddress.cpp.

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

◆ Serialize()

template<typename Stream >
void CNetAddr::Serialize ( Stream &  s) const
inline

Serialize to a stream.

Definition at line 238 of file netaddress.h.

Here is the call graph for this function:

◆ SerializeV1Array()

void CNetAddr::SerializeV1Array ( uint8_t(&)  arr[V1_SERIALIZATION_SIZE]) const
inlineprivate

Serialize in pre-ADDRv2/BIP155 format to an array.

Definition at line 324 of file netaddress.h.

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

◆ SerializeV1Stream()

template<typename Stream >
void CNetAddr::SerializeV1Stream ( Stream &  s) const
inlineprivate

Serialize in pre-ADDRv2/BIP155 format to a stream.

Definition at line 362 of file netaddress.h.

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

◆ SerializeV2Stream()

template<typename Stream >
void CNetAddr::SerializeV2Stream ( Stream &  s) const
inlineprivate

Serialize as ADDRv2 / BIP155.

Definition at line 375 of file netaddress.h.

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

◆ SetI2P()

bool CNetAddr::SetI2P ( const std::string &  addr)
private

Parse an I2P address and set this object to it.

Parameters
[in]addrAddress to parse, must be a valid C string, for example ukeu3k5oycgaauneqgtnvselmt4yemvoilkln7jpvamvfx7dnkdq.b32.i2p.
Returns
Whether the operation was successful.
See also
CNetAddr::IsI2P()

Definition at line 264 of file netaddress.cpp.

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

◆ SetInternal()

bool CNetAddr::SetInternal ( const std::string &  name)

Create an "internal" address that represents a name or FQDN.

AddrMan uses these fake addresses to keep track of which DNS seeds were used.

Returns
Whether or not the operation was successful.
See also
NET_INTERNAL, INTERNAL_IN_IPV6_PREFIX, CNetAddr::IsInternal(), CNetAddr::IsRFC4193()

Definition at line 169 of file netaddress.cpp.

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

◆ SetIP()

void CNetAddr::SetIP ( const CNetAddr ip)

Definition at line 103 of file netaddress.cpp.

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

◆ SetLegacyIPv6()

void CNetAddr::SetLegacyIPv6 ( Span< const uint8_t >  ipv6)

Set from a legacy IPv6 address.

Legacy IPv6 address may be a normal IPv6 address, or another address (e.g. IPv4) disguised as IPv6. This encoding is used in the legacy addr encoding.

Definition at line 134 of file netaddress.cpp.

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

◆ SetNetFromBIP155Network()

bool CNetAddr::SetNetFromBIP155Network ( uint8_t  possible_bip155_net,
size_t  address_size 
)
private

Set m_net from the provided BIP155 network id and size after validation.

Return values
truethe network was recognized, is valid and m_net was set
falsenot recognised (from future?) and should be silently ignored
Exceptions
std::ios_base::failureif the network is one of the BIP155 founding networks (id 1..6) with wrong address size.

Definition at line 45 of file netaddress.cpp.

Here is the caller graph for this function:

◆ SetSpecial()

bool CNetAddr::SetSpecial ( const std::string &  addr)

Parse a Tor or I2P address and set this object to it.

Parameters
[in]addrAddress to parse, for example pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion or ukeu3k5oycgaauneqgtnvselmt4yemvoilkln7jpvamvfx7dnkdq.b32.i2p.
Returns
Whether the operation was successful.
See also
CNetAddr::IsTor(), CNetAddr::IsI2P()

Definition at line 208 of file netaddress.cpp.

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

◆ SetTor()

bool CNetAddr::SetTor ( const std::string &  addr)
private

Parse a Tor address and set this object to it.

Parameters
[in]addrAddress to parse, must be a valid C string, for example pg6mmjiyjmcrsslvykfwnntlaru7p5svn6y2ymmju6nubxndf4pscryd.onion.
Returns
Whether the operation was successful.
See also
CNetAddr::IsTor()

Definition at line 225 of file netaddress.cpp.

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

◆ ToStringAddr()

std::string CNetAddr::ToStringAddr ( ) const

Definition at line 581 of file netaddress.cpp.

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

◆ Unserialize()

template<typename Stream >
void CNetAddr::Unserialize ( Stream &  s)
inline

Unserialize from a stream.

Definition at line 251 of file netaddress.h.

Here is the call graph for this function:

◆ UnserializeV1Array()

void CNetAddr::UnserializeV1Array ( uint8_t(&)  arr[V1_SERIALIZATION_SIZE])
inlineprivate

Unserialize from a pre-ADDRv2/BIP155 format from an array.

This function is only called from UnserializeV1Stream() and is a wrapper for SetLegacyIPv6(); however, we keep it for symmetry with SerializeV1Array() to have pairs of ser/unser functions and to make clear that if one is altered, a corresponding reverse modification should be applied to the other.

Definition at line 399 of file netaddress.h.

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

◆ UnserializeV1Stream()

template<typename Stream >
void CNetAddr::UnserializeV1Stream ( Stream &  s)
inlineprivate

Unserialize from a pre-ADDRv2/BIP155 format from a stream.

Definition at line 410 of file netaddress.h.

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

◆ UnserializeV2Stream()

template<typename Stream >
void CNetAddr::UnserializeV2Stream ( Stream &  s)
inlineprivate

Unserialize from a ADDRv2 / BIP155 format.

Definition at line 423 of file netaddress.h.

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

Friends And Related Function Documentation

◆ CSubNet

friend class CSubNet
friend

Definition at line 272 of file netaddress.h.

◆ operator!=

bool operator!= ( const CNetAddr a,
const CNetAddr b 
)
friend

Definition at line 212 of file netaddress.h.

◆ operator<

bool operator< ( const CNetAddr a,
const CNetAddr b 
)
friend

Definition at line 609 of file netaddress.cpp.

◆ operator==

bool operator== ( const CNetAddr a,
const CNetAddr b 
)
friend

Definition at line 604 of file netaddress.cpp.

Member Data Documentation

◆ m_addr

prevector<ADDR_IPV6_SIZE, uint8_t> CNetAddr::m_addr {ADDR_IPV6_SIZE, 0x0}
protected

Raw representation of the network address.

In network byte order (big endian) for IPv4 and IPv6.

Definition at line 118 of file netaddress.h.

◆ m_net

Network CNetAddr::m_net {NET_IPV6}
protected

Network to which this address belongs.

Definition at line 123 of file netaddress.h.

◆ m_scope_id

uint32_t CNetAddr::m_scope_id {0}
protected

Scope id if scoped/link-local IPV6 address.

See https://tools.ietf.org/html/rfc4007

Definition at line 129 of file netaddress.h.

◆ MAX_ADDRV2_SIZE

constexpr size_t CNetAddr::MAX_ADDRV2_SIZE = 512
staticconstexprprivate

Maximum size of an address as defined in BIP155 (in bytes).

This is only the size of the address, not the entire CNetAddr object when serialized.

Definition at line 303 of file netaddress.h.

◆ V1

constexpr SerParams CNetAddr::V1 {Encoding::V1}
staticconstexpr

Definition at line 231 of file netaddress.h.

◆ V1_SERIALIZATION_SIZE

constexpr size_t CNetAddr::V1_SERIALIZATION_SIZE = ADDR_IPV6_SIZE
staticconstexprprivate

Size of CNetAddr when serialized as ADDRv1 (pre-BIP155) (in bytes).

Definition at line 296 of file netaddress.h.

◆ V2

constexpr SerParams CNetAddr::V2 {Encoding::V2}
staticconstexpr

Definition at line 232 of file netaddress.h.


The documentation for this class was generated from the following files: