TorControlConnection
| Low-level handling for Tor control | connection. | | Speaks the SMTP-like protocol as defined | in torspec/control-spec.txt |
TorControlReply
| Reply from Tor, can be single or multi-line |
TorController
| Controller that connects to Tor control | socket, authenticate, then create | and maintain an ephemeral onion service. |

Constants

DEFAULT_LISTEN_ONION
DEFAULT_TOR_CONTROL
| Default control port |
MAX_LINE_LENGTH
| 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. |
RECONNECT_TIMEOUT_EXP
| Exponential backoff configuration | - growth factor |
RECONNECT_TIMEOUT_START
| Exponential backoff configuration | - initial timeout in seconds |
TOR_COOKIE_SIZE
| Tor cookie size (from control-spec.txt) |
TOR_NONCE_SIZE
| Size of client/server nonce for SAFECOOKIE |
TOR_SAFE_CLIENTKEY
| For computing clientHash in SAFECOOKIE |
TOR_SAFE_SERVERKEY
| For computing serverHash in SAFECOOKIE |

Functions

compute_response
| 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) |
default_onion_service_target
interrupt_tor_control
parse_tor_reply_mapping
| 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. |
split_tor_reply_line
| Split reply line in the form ‘AUTH METHODS=…’ | into a type ‘AUTH’ and arguments ‘METHODS=…’. | | Grammar is implicitly defined in https://spec.torproject.org/control-spec | by the server reply formats for PROTOCOLINFO | (S3.21) and AUTHCHALLENGE (S3.24). |
start_tor_control
stop_tor_control
tor_control_thread