Network address. More...

#include <netaddress.h>

Inheritance diagram for CNetAddr:

Collaboration diagram for CNetAddr:

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 &strName)
	Parse a TORv2 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	IsLocal () const

bool	IsRoutable () const

bool	IsInternal () const

bool	IsValid () const

enum Network	GetNetwork () const

std::string	ToString () const

std::string	ToStringIP () const

uint64_t	GetHash () const

bool	GetInAddr (struct in_addr *pipv4Addr) const
	Try to get our IPv4 address. More...

uint32_t	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...

uint32_t	GetMappedAS (const std::vector< bool > &asmap) const

std::vector< unsigned char >	GetGroup (const std::vector< bool > &asmap) const
	Get the canonical identifier of our network group. More...

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

int	GetReachabilityFrom (const CNetAddr *paddrPartner=nullptr) 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 address. 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...

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	scopeId {0}

Private Member Functions
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...

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...

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...

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 91 of file netaddress.h.

Constructor & Destructor Documentation

◆ CNetAddr() [1/3]

CNetAddr::CNetAddr ( )

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

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

Definition at line 26 of file netaddress.cpp.

◆ CNetAddr() [2/3]

CNetAddr::CNetAddr ( const struct in_addr & ipv4Addr )

explicit

Definition at line 125 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 132 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 543 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGroup()

std::vector< unsigned char > CNetAddr::GetGroup ( const std::vector< bool > & asmap ) 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.

Definition at line 489 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHash()

uint64_t CNetAddr::GetHash ( ) const

Definition at line 550 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 address.

Parameters

[out] pipv6Addr The 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 399 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] pipv4Addr The 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 380 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 414 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMappedAS()

uint32_t CNetAddr::GetMappedAS ( const std::vector< bool > & asmap ) const

Definition at line 448 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNetClass()

uint32_t CNetAddr::GetNetClass ( ) const

Definition at line 431 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 320 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 = nullptr ) const

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

Definition at line 572 of file netaddress.cpp.

Here is the call graph for this function:

◆ HasLinkedIPv4()

bool CNetAddr::HasLinkedIPv4 ( ) const

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

Definition at line 409 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsBindAny()

bool CNetAddr::IsBindAny ( ) const

Definition at line 138 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsHeNet()

bool CNetAddr::IsHeNet ( ) const

Definition at line 232 of file netaddress.cpp.

Here is the call graph for this function:

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 315 of file netaddress.cpp.

Here is the caller graph for this function:

◆ IsIPv4()

bool CNetAddr::IsIPv4 ( ) const

Definition at line 146 of file netaddress.cpp.

Here is the caller graph for this function:

◆ IsIPv6()

bool CNetAddr::IsIPv6 ( ) const

Definition at line 148 of file netaddress.cpp.

Here is the caller graph for this function:

◆ IsLocal()

bool CNetAddr::IsLocal ( ) const

Definition at line 245 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsRFC1918()

bool CNetAddr::IsRFC1918 ( ) const

Definition at line 150 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 158 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 180 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 163 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 185 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 208 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 197 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 220 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 202 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 173 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 190 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 213 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 168 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 226 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 305 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

Returns: Whether or not this is a dummy address that maps an onion address into IPv6.

See also: CNetAddr::SetSpecial(const std::string &)

Definition at line 243 of file netaddress.cpp.

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 271 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 178 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.

Some addresses (e.g. TORv3) cannot be serialized in pre-BIP155 format.

Definition at line 204 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.

Some addresses (e.g. TORv3) cannot be serialized in pre-BIP155 format.

Definition at line 244 of file netaddress.h.

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.

CAddrMan 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 92 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 28 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 60 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetSpecial()

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

Parse a TORv2 address and set this object to it.

Returns: Whether or not the operation was successful.

See also: CNetAddr::IsTor()

Definition at line 111 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ToString()

std::string CNetAddr::ToString ( ) const

Definition at line 355 of file netaddress.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ToStringIP()

std::string CNetAddr::ToStringIP ( ) const

Definition at line 331 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 187 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.

Definition at line 256 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 267 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 192 of file netaddress.h.

◆ operator!=

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

friend

Definition at line 171 of file netaddress.h.

◆ operator<

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

friend

Definition at line 365 of file netaddress.cpp.

◆ operator==

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

friend

Definition at line 360 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 98 of file netaddress.h.

◆ m_net

Network CNetAddr::m_net {NET_IPV6}

protected

Network to which this address belongs.

Definition at line 103 of file netaddress.h.

◆ scopeId

uint32_t CNetAddr::scopeId {0}

protected

Definition at line 105 of file netaddress.h.

◆ V1_SERIALIZATION_SIZE

constexpr size_t CNetAddr::V1_SERIALIZATION_SIZE = ADDR_IPV6_SIZE

staticprivate

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

Definition at line 198 of file netaddress.h.

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

src/netaddress.h
src/netaddress.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CNetAddr() [1/3]

◆ CNetAddr() [2/3]

◆ CNetAddr() [3/3]

Member Function Documentation

◆ GetAddrBytes()

◆ GetGroup()

◆ GetHash()

◆ GetIn6Addr()

◆ GetInAddr()

◆ GetLinkedIPv4()

◆ GetMappedAS()

◆ GetNetClass()

◆ GetNetwork()

◆ GetReachabilityFrom()

◆ HasLinkedIPv4()

◆ IsBindAny()

◆ IsHeNet()

◆ IsInternal()

◆ IsIPv4()

◆ IsIPv6()

◆ IsLocal()

◆ IsRFC1918()

◆ IsRFC2544()

◆ IsRFC3849()

◆ IsRFC3927()

◆ IsRFC3964()

◆ IsRFC4193()

◆ IsRFC4380()

◆ IsRFC4843()

◆ IsRFC4862()

◆ IsRFC5737()

◆ IsRFC6052()

◆ IsRFC6145()

◆ IsRFC6598()

◆ IsRFC7343()

◆ IsRoutable()

◆ IsTor()

◆ IsValid()

◆ Serialize()

◆ SerializeV1Array()

◆ SerializeV1Stream()

◆ SetInternal()

◆ SetIP()

◆ SetLegacyIPv6()

◆ SetSpecial()

◆ ToString()

◆ ToStringIP()

◆ Unserialize()

◆ UnserializeV1Array()

◆ UnserializeV1Stream()

Friends And Related Function Documentation

◆ CSubNet

◆ operator!=

◆ operator<

◆ operator==

Member Data Documentation

◆ m_addr

◆ m_net

◆ scopeId

◆ V1_SERIALIZATION_SIZE