Bitcoin
Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | Friends | List of all members
CNetAddr Class Reference

#include <netaddress.h>

Inheritance diagram for CNetAddr:
CService CAddress CAddrInfo

Public Member Functions

 CNetAddr ()
 
 CNetAddr (const struct in_addr &ipv4Addr)
 
void SetIP (const CNetAddr &ip)
 
bool SetInternal (const std::string &name)
 
bool SetSpecial (const std::string &strName)
 
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 IsTor () const
 
bool IsLocal () const
 
bool IsRoutable () const
 
bool IsInternal () const
 
bool IsValid () const
 
enum Network GetNetwork () const
 
std::string ToString () const
 
std::string ToStringIP () const
 
unsigned int GetByte (int n) const
 
uint64_t GetHash () const
 
bool GetInAddr (struct in_addr *pipv4Addr) const
 
std::vector< unsigned char > GetGroup () const
 
int GetReachabilityFrom (const CNetAddr *paddrPartner=nullptr) const
 
 CNetAddr (const struct in6_addr &pipv6Addr, const uint32_t scope=0)
 
bool GetIn6Addr (struct in6_addr *pipv6Addr) const
 
template<typename Stream , typename Operation >
void SerializationOp (Stream &s, Operation ser_action)
 

Public Attributes

 ADD_SERIALIZE_METHODS
 

Protected Attributes

unsigned char ip [16]
 
uint32_t scopeId {0}
 

Private Member Functions

void SetRaw (Network network, const uint8_t *data)
 

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

IP address (IPv6, or IPv4 using mapped IPv6 range (::FFFF:0:0/96))

Constructor & Destructor Documentation

◆ CNetAddr() [1/3]

CNetAddr::CNetAddr ( )

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

◆ CNetAddr() [3/3]

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

Member Function Documentation

◆ GetByte()

unsigned int CNetAddr::GetByte ( int  n) const

◆ GetGroup()

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

Get the canonical identifier of our network group

The groups are assigned in a way where it should be costly for an attacker to obtain addresses with many different group identifiers, even if it is cheap to obtain addresses with the same identifier.

Note
No two connections will be attempted to addresses with the same network group.

◆ GetHash()

uint64_t CNetAddr::GetHash ( ) const

◆ GetIn6Addr()

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

Try to get our IPv6 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()

◆ 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()

◆ GetNetwork()

enum Network CNetAddr::GetNetwork ( ) const

◆ GetReachabilityFrom()

int CNetAddr::GetReachabilityFrom ( const CNetAddr *  paddrPartner = nullptr) const

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

◆ IsBindAny()

bool CNetAddr::IsBindAny ( ) const

◆ IsInternal()

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

◆ IsIPv4()

bool CNetAddr::IsIPv4 ( ) const

◆ IsIPv6()

bool CNetAddr::IsIPv6 ( ) const

◆ IsLocal()

bool CNetAddr::IsLocal ( ) const

◆ IsRFC1918()

bool CNetAddr::IsRFC1918 ( ) const

◆ IsRFC2544()

bool CNetAddr::IsRFC2544 ( ) const

◆ IsRFC3849()

bool CNetAddr::IsRFC3849 ( ) const

◆ IsRFC3927()

bool CNetAddr::IsRFC3927 ( ) const

◆ IsRFC3964()

bool CNetAddr::IsRFC3964 ( ) const

◆ IsRFC4193()

bool CNetAddr::IsRFC4193 ( ) const

◆ IsRFC4380()

bool CNetAddr::IsRFC4380 ( ) const

◆ IsRFC4843()

bool CNetAddr::IsRFC4843 ( ) const

◆ IsRFC4862()

bool CNetAddr::IsRFC4862 ( ) const

◆ IsRFC5737()

bool CNetAddr::IsRFC5737 ( ) const

◆ IsRFC6052()

bool CNetAddr::IsRFC6052 ( ) const

◆ IsRFC6145()

bool CNetAddr::IsRFC6145 ( ) const

◆ IsRFC6598()

bool CNetAddr::IsRFC6598 ( ) const

◆ IsRFC7343()

bool CNetAddr::IsRFC7343 ( ) const

◆ 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()

◆ IsTor()

bool CNetAddr::IsTor ( ) const
Returns
Whether or not this is a dummy address that maps an onion address into IPv6.
See also
CNetAddr::SetSpecial(const std::string &)

◆ 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()

◆ SerializationOp()

template<typename Stream , typename Operation >
void CNetAddr::SerializationOp ( Stream &  s,
Operation  ser_action 
)
inline

◆ SetInternal()

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

Try to make this a dummy address that maps the specified name into IPv6 like so: (0xFD + sha256("bitcoin")[0:5]) + sha256(name)[0:10]. Such dummy addresses have a prefix of fd6b:88c0:8724::/48 and are guaranteed to not be publicly routable as it falls under RFC4193's fc00::/7 subnet allocated to unique-local addresses.

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

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

◆ SetIP()

void CNetAddr::SetIP ( const CNetAddr &  ip)

◆ SetRaw()

void CNetAddr::SetRaw ( Network  network,
const uint8_t *  data 
)
private

Set raw IPv4 or IPv6 address (in network byte order)

Note
Only NET_IPV4 and NET_IPV6 are allowed for network.

◆ SetSpecial()

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

Try to make this a dummy address that maps the specified onion address into IPv6 using OnionCat's range and encoding. Such dummy addresses have a prefix of fd87:d87e:eb43::/48 and are guaranteed to not be publicly routable as they fall under RFC4193's fc00::/7 subnet allocated to unique-local addresses.

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

◆ ToString()

std::string CNetAddr::ToString ( ) const

◆ ToStringIP()

std::string CNetAddr::ToStringIP ( ) const

Friends And Related Function Documentation

◆ CSubNet

friend class CSubNet
friend

◆ operator!=

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

◆ operator<

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

◆ operator==

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

Member Data Documentation

◆ ADD_SERIALIZE_METHODS

CNetAddr::ADD_SERIALIZE_METHODS

◆ ip

unsigned char CNetAddr::ip[16]
protected

◆ scopeId

uint32_t CNetAddr::scopeId {0}
protected
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.15