#include <torcontrol.h>
#include <chainparams.h>
#include <chainparamsbase.h>
#include <common/args.h>
#include <compat.h>
#include <crypto/hmac_sha256.h>
#include <logging.h>
#include <net.h>
#include <netaddress.h>
#include <netbase.h>
#include <util/readwritefile.h>
#include <util/strencodings.h>
#include <util/string.h>
#include <util/thread.h>
#include <util/time.h>
#include <boost/signals2/signal.hpp>
#include <event2/buffer.h>
#include <event2/bufferevent.h>
#include <event2/event.h>
#include <event2/thread.h>
#include <event2/util.h>
#include <cstdlib>
#include <deque>
#include <functional>
#include <set>
#include <vector>

Include dependency graph for torcontrol.cpp:

Classes
class	TorControlReply
	Reply from Tor, can be single or multi-line. More...

class	TorControlConnection
	Low-level handling for Tor control connection. More...

class	TorController
	Controller that connects to Tor control socket, authenticate, then create and maintain an ephemeral onion service. More...

Functions
std::pair< std::string, std::string >	SplitTorReplyLine (const std::string &s)

std::map< std::string, std::string >	ParseTorReplyMapping (const std::string &s)
	Parse reply arguments in the form 'METHODS=COOKIE,SAFECOOKIE COOKIEFILE=".../control_auth_cookie"'.

static std::vector< uint8_t >	ComputeResponse (const std::string &key, const std::vector< uint8_t > &cookie, const std::vector< uint8_t > &clientNonce, const std::vector< uint8_t > &serverNonce)
	Compute Tor SAFECOOKIE response.

static void	TorControlThread (CService onion_service_target)

void	StartTorControl (CService onion_service_target)

void	InterruptTorControl ()

void	StopTorControl ()

CService	DefaultOnionServiceTarget ()

Variables
const std::string	DEFAULT_TOR_CONTROL = "127.0.0.1:9051"
	Default control port.

static const int	TOR_COOKIE_SIZE = 32
	Tor cookie size (from control-spec.txt)

static const int	TOR_NONCE_SIZE = 32
	Size of client/server nonce for SAFECOOKIE.

static const std::string	TOR_SAFE_SERVERKEY
	For computing serverHash in SAFECOOKIE.

static const std::string	TOR_SAFE_CLIENTKEY
	For computing clientHash in SAFECOOKIE.

static const float	RECONNECT_TIMEOUT_START = 1.0
	Exponential backoff configuration - initial timeout in seconds.

static const float	RECONNECT_TIMEOUT_EXP = 1.5
	Exponential backoff configuration - growth factor.

static const int	MAX_LINE_LENGTH = 100000
	Maximum length for lines received on TorControlConnection.

static struct event_base *	gBase

static std::thread	torControlThread

Function Documentation

◆ ComputeResponse()

static std::vector< uint8_t > ComputeResponse	(	const std::string &	key,
		const std::vector< uint8_t > &	cookie,
		const std::vector< uint8_t > &	clientNonce,
		const std::vector< uint8_t > &	serverNonce
	)

static

Compute Tor SAFECOOKIE response.

ServerHash is computed as: HMAC-SHA256("Tor safe cookie authentication server-to-controller hash", CookieString | ClientNonce | ServerNonce) (with the HMAC key as its first argument)

After a controller sends a successful AUTHCHALLENGE command, the next command sent on the connection must be an AUTHENTICATE command, and the only authentication string which that AUTHENTICATE command will accept is:

HMAC-SHA256("Tor safe cookie authentication controller-to-server hash", CookieString | ClientNonce | ServerNonce)

Definition at line 596 of file torcontrol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DefaultOnionServiceTarget()

CService DefaultOnionServiceTarget ( )

Definition at line 871 of file torcontrol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InterruptTorControl()

void InterruptTorControl ( )

Definition at line 853 of file torcontrol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseTorReplyMapping()

std::map< std::string, std::string > ParseTorReplyMapping ( const std::string & s )

Parse reply arguments in the form 'METHODS=COOKIE,SAFECOOKIE COOKIEFILE=".../control_auth_cookie"'.

Returns a map of keys to values, or an empty map if there was an error. Grammar is implicitly defined in https://spec.torproject.org/control-spec by the server reply formats for PROTOCOLINFO (S3.21), AUTHCHALLENGE (S3.24), and ADD_ONION (S3.27). See also sections 2.1 and 2.3.

Unescape value. Per https://spec.torproject.org/control-spec section 2.1.1:

For future-proofing, controller implementors MAY use the following rules to be compatible with buggy Tor implementations and with future ones that implement the spec as intended:

Read
\t \r and \0 ... \377 as C escapes. Treat a backslash followed by any other character as that character.

Definition at line 304 of file torcontrol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SplitTorReplyLine()

std::pair< std::string, std::string > SplitTorReplyLine ( const std::string & s )

Definition at line 282 of file torcontrol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartTorControl()

void StartTorControl ( CService onion_service_target )

Definition at line 834 of file torcontrol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StopTorControl()

void StopTorControl ( )

Definition at line 863 of file torcontrol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TorControlThread()

static void TorControlThread ( CService onion_service_target )

static

Definition at line 827 of file torcontrol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ DEFAULT_TOR_CONTROL

const std::string DEFAULT_TOR_CONTROL = "127.0.0.1:9051"

Default control port.

Definition at line 38 of file torcontrol.cpp.

◆ gBase

struct event_base* gBase

static

Definition at line 824 of file torcontrol.cpp.

◆ MAX_LINE_LENGTH

const int MAX_LINE_LENGTH = 100000

static

Maximum length for lines received on TorControlConnection.

tor-control-spec.txt mentions that there is explicitly no limit defined to line length, this is belt-and-suspenders sanity limit to prevent memory exhaustion.

Definition at line 59 of file torcontrol.cpp.

◆ RECONNECT_TIMEOUT_EXP

const float RECONNECT_TIMEOUT_EXP = 1.5

static

Exponential backoff configuration - growth factor.

Definition at line 52 of file torcontrol.cpp.

◆ RECONNECT_TIMEOUT_START

const float RECONNECT_TIMEOUT_START = 1.0

static

Exponential backoff configuration - initial timeout in seconds.

Definition at line 50 of file torcontrol.cpp.

◆ TOR_COOKIE_SIZE

const int TOR_COOKIE_SIZE = 32

static

Tor cookie size (from control-spec.txt)

Definition at line 40 of file torcontrol.cpp.

◆ TOR_NONCE_SIZE

const int TOR_NONCE_SIZE = 32

static

Size of client/server nonce for SAFECOOKIE.

Definition at line 42 of file torcontrol.cpp.

◆ TOR_SAFE_CLIENTKEY

const std::string TOR_SAFE_CLIENTKEY

static

Initial value:

=

"Tor safe cookie authentication controller-to-server hash"

For computing clientHash in SAFECOOKIE.

Definition at line 47 of file torcontrol.cpp.

◆ TOR_SAFE_SERVERKEY

const std::string TOR_SAFE_SERVERKEY

static

Initial value:

=

"Tor safe cookie authentication server-to-controller hash"

For computing serverHash in SAFECOOKIE.

Definition at line 44 of file torcontrol.cpp.

◆ torControlThread

std::thread torControlThread

static

Definition at line 825 of file torcontrol.cpp.

Classes

Functions

Variables

Function Documentation

◆ ComputeResponse()

◆ DefaultOnionServiceTarget()

◆ InterruptTorControl()

◆ ParseTorReplyMapping()

◆ SplitTorReplyLine()

◆ StartTorControl()

◆ StopTorControl()

◆ TorControlThread()

Variable Documentation

◆ DEFAULT_TOR_CONTROL

◆ gBase

◆ MAX_LINE_LENGTH

◆ RECONNECT_TIMEOUT_EXP

◆ RECONNECT_TIMEOUT_START

◆ TOR_COOKIE_SIZE

◆ TOR_NONCE_SIZE

◆ TOR_SAFE_CLIENTKEY

◆ TOR_SAFE_SERVERKEY

◆ torControlThread