net::tor_address Class Reference

Tor onion address; internal format not condensed/decoded. More...

#include <tor_address.h>

Public Member Functions
	tor_address () noexcept
	An object with port() == 0 and host_str() == unknown_str().
bool	_load (epee::serialization::portable_storage &src, epee::serialization::section *hparent)
	Load from epee p2p format, and.
bool	store (epee::serialization::portable_storage &dest, epee::serialization::section *hparent) const
	Store in epee p2p format.
	tor_address (const tor_address &rhs) noexcept
	~tor_address ()=default
tor_address &	operator= (const tor_address &rhs) noexcept
bool	is_unknown () const noexcept
bool	equal (const tor_address &rhs) const noexcept
bool	less (const tor_address &rhs) const noexcept
bool	is_same_host (const tor_address &rhs) const noexcept
std::string	str () const
const char *	host_str () const noexcept
std::uint16_t	port () const noexcept
bool	is_blockable () const noexcept

Static Public Member Functions
static constexpr std::size_t	buffer_size () noexcept
static const char *	unknown_str () noexcept
static tor_address	unknown () noexcept
static expect< tor_address >	make (boost::string_ref address, std::uint16_t default_port=0)
static constexpr bool	is_loopback () noexcept
static constexpr bool	is_local () noexcept
static constexpr epee::net_utils::address_type	get_type_id () noexcept
static constexpr epee::net_utils::zone	get_zone () noexcept

Detailed Description

Tor onion address; internal format not condensed/decoded.

Definition at line 51 of file tor_address.h.

Constructor & Destructor Documentation

tor_address() [1/2]

net::tor_address::tor_address ( )

noexcept

An object with port() == 0 and host_str() == unknown_str().

Definition at line 100 of file tor_address.cpp.

      : port_(0)
    {
        static_assert(sizeof(unknown_host) <= sizeof(host_), "bad buffer size");
        std::memcpy(host_, unknown_host, sizeof(unknown_host));
        std::memset(host_ + sizeof(unknown_host), 0, sizeof(host_) - sizeof(unknown_host));
    }

tor_address() [2/2]

net::tor_address::tor_address ( const tor_address & rhs )

noexcept

Definition at line 147 of file tor_address.cpp.

      : port_(rhs.port_)
    {
        std::memcpy(host_, rhs.host_, sizeof(host_));
    }

~tor_address()

net::tor_address::~tor_address ( )

default

Here is the call graph for this function:

Member Function Documentation

_load()

bool net::tor_address::_load	(	epee::serialization::portable_storage &	src,
		epee::serialization::section *	hparent )

Load from epee p2p format, and.

Returns

false if not valid tor address

Definition at line 125 of file tor_address.cpp.

    {
        tor_serialized in{};
        if (in._load(src, hparent) && in.host.size() < sizeof(host_) && (in.host == unknown_host || !host_check(in.host).has_error()))
        {
            std::memcpy(host_, in.host.data(), in.host.size());
            std::memset(host_ + in.host.size(), 0, sizeof(host_) - in.host.size());
            port_ = in.port;
            return true;
        }
        static_assert(sizeof(unknown_host) <= sizeof(host_), "bad buffer size");
        std::memcpy(host_, unknown_host, sizeof(unknown_host)); // include null terminator
        port_ = 0;
        return false;
    }

buffer_size()

constexpr std::size_t net::tor_address::buffer_size ( )

inlinestaticconstexprnoexcept

Returns

Size of internal buffer for host.

Definition at line 61 of file tor_address.h.

{ return sizeof(host_); }

Here is the caller graph for this function:

equal()

bool net::tor_address::equal ( const tor_address & rhs ) const

noexcept

Definition at line 169 of file tor_address.cpp.

    {
        return port_ == rhs.port_ && is_same_host(rhs);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get_type_id()

constexpr epee::net_utils::address_type net::tor_address::get_type_id ( )

inlinestaticconstexprnoexcept

Definition at line 112 of file tor_address.h.

        {
            return epee::net_utils::address_type::tor;
        }

Here is the caller graph for this function:

get_zone()

constexpr epee::net_utils::zone net::tor_address::get_zone ( )

inlinestaticconstexprnoexcept

Definition at line 117 of file tor_address.h.

        {
            return epee::net_utils::zone::tor;
        }

host_str()

const char * net::tor_address::host_str ( ) const

inlinenoexcept

Returns

Null-terminated x.onion value or unknown_str().

Definition at line 104 of file tor_address.h.

{ return host_; }

Here is the call graph for this function:

Here is the caller graph for this function:

is_blockable()

bool net::tor_address::is_blockable ( ) const

inlinenoexcept

Returns

!is_unknown().

Definition at line 123 of file tor_address.h.

{ return !is_unknown(); }

Here is the call graph for this function:

Here is the caller graph for this function:

is_local()

constexpr bool net::tor_address::is_local ( )

inlinestaticconstexprnoexcept

Definition at line 110 of file tor_address.h.

{ return false; }

Here is the caller graph for this function:

is_loopback()

constexpr bool net::tor_address::is_loopback ( )

inlinestaticconstexprnoexcept

Definition at line 109 of file tor_address.h.

{ return false; }

Here is the caller graph for this function:

is_same_host()

bool net::tor_address::is_same_host ( const tor_address & rhs ) const

noexcept

Returns

True if onion addresses are identical.

\TODO v2 and v3 should be comparable - requires base32

Definition at line 179 of file tor_address.cpp.

    {
        return std::strcmp(host_str(), rhs.host_str()) == 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

is_unknown()

bool net::tor_address::is_unknown ( ) const

noexcept

Returns

True if default constructed or via unknown().

Definition at line 163 of file tor_address.cpp.

    {
        static_assert(1 <= sizeof(host_), "host size too small");
        return host_[0] == '<'; // character is not allowed otherwise
    }

Here is the caller graph for this function:

less()

bool net::tor_address::less ( const tor_address & rhs ) const

noexcept

Definition at line 174 of file tor_address.cpp.

    {
        return std::strcmp(host_str(), rhs.host_str()) < 0 || port() < rhs.port();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

make()

expect< tor_address > net::tor_address::make ( boost::string_ref address, std::uint16_t default_port = 0 )

static

Parse address in onion v2 or v3 format with (i.e. x.onion:80) with default_port being used iff port is not specified in address.

Definition at line 108 of file tor_address.cpp.

    {
        boost::string_ref host = address.substr(0, address.rfind(':'));
        const boost::string_ref port =
            address.substr(host.size() + (host.size() == address.size() ? 0 : 1));
 
        ELECTRONEUM_CHECK(host_check(host));
 
        std::uint16_t porti = default_port;
        if (!port.empty() && !epee::string_tools::get_xtype_from_string(porti, std::string{port}))
            return {net::error::invalid_port};
 
        static_assert(v2_length <= v3_length, "bad internal host size");
        static_assert(v3_length + sizeof(tld) == sizeof(tor_address::host_), "bad internal host size");
        return tor_address{host, porti};
    }

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

tor_address & net::tor_address::operator= ( const tor_address & rhs )

noexcept

Definition at line 153 of file tor_address.cpp.

    {
        if (this != std::addressof(rhs))
        {
            port_ = rhs.port_;
            std::memcpy(host_, rhs.host_, sizeof(host_));
        }
        return *this;
    }

port()

std::uint16_t net::tor_address::port ( ) const

inlinenoexcept

Returns

Port value or 0 if unspecified.

Definition at line 107 of file tor_address.h.

{ return port_; }

Here is the caller graph for this function:

store()

bool net::tor_address::store	(	epee::serialization::portable_storage &	dest,
		epee::serialization::section *	hparent ) const

Store in epee p2p format.

Definition at line 141 of file tor_address.cpp.

    {
        const tor_serialized out{std::string{host_}, port_};
        return out.store(dest, hparent);
    }

str()

std::string net::tor_address::str

(

)

const

Returns

x.onion or x.onion:z if port() != 0.

Definition at line 185 of file tor_address.cpp.

    {
        const std::size_t host_length = std::strlen(host_str());
        const std::size_t port_length =
            port_ == 0 ? 0 : std::numeric_limits<std::uint16_t>::digits10 + 2;
 
        std::string out{};
        out.reserve(host_length + port_length);
        out.assign(host_str(), host_length);
 
        if (port_ != 0)
        {
            out.push_back(':');
            namespace karma = boost::spirit::karma;
            karma::generate(std::back_inserter(out), karma::ushort_, port());
        }
        return out;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unknown()

tor_address net::tor_address::unknown ( )

inlinestaticnoexcept

Returns

A default constructed tor_address object.

Definition at line 70 of file tor_address.h.

{ return tor_address{}; }

Here is the call graph for this function:

Here is the caller graph for this function:

unknown_str()

const char * net::tor_address::unknown_str ( )

staticnoexcept

Returns

<unknown tor host>.

Definition at line 95 of file tor_address.cpp.

    {
        return unknown_host;
    }

Here is the caller graph for this function:

---

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

• /home/abuild/rpmbuild/BUILD/electroneum-5.1.3.1-build/electroneum-5.1.3.1/src/net/tor_address.h
• /home/abuild/rpmbuild/BUILD/electroneum-5.1.3.1-build/electroneum-5.1.3.1/src/net/tor_address.cpp