Class: TorControl

new TorControl(socket, optionsopt)

Parameters:

Name Type Attributes Description

socket

Socket

net.Socket connected to Tor's control port

options

object

Properties

Name	Type	Attributes	Default	Description
`authOnConnect`	boolean	<optional>	true	Automatically authenticate

Source: lib/control.js, line 92

Methods

addEventListeners(events)

Instructs Tor to send asynchronous events for the given types - these events will be emitted from the controller. Calling this method resets previously set event listeners

Parameters:

Name	Type	Description
`events`	Array.<string>	List of event types to listen for

Source: lib/control.js, line 540
See: https://gitweb.torproject.org/torspec.git/tree/control-spec.txt#n1708

attachStream(streamId, circuitIdopt, hopNumberopt)

Attaches the specified stream to the given circuit

Parameters:

Name	Type	Attributes	Default	Description
`streamId`	string			ID for the stream to attach
`circuitId`	string	<optional>	0	Circuit to attach stream
`hopNumber`	number	<optional>		Which hop to exit circuit

Source: lib/control.js, line 418

authenticate(token)

Authenticates with the control port given the supplied param

Parameters:

Name	Type	Description
`token`	string

Source: lib/control.js, line 246

cleanCircuits()

Clears DNS cache and establishes new clean circuits

Source: lib/control.js, line 359

clearDnsCache()

Forget client side hostname->ip cache

Source: lib/control.js, line 352

closeCicuit(circuitId, optionsopt)

Closes the given circuit

Parameters:

Name Type Attributes Description

circuitId

string

ID for the circuit to close

options

object

Properties

Name	Type	Attributes	Default	Description
`ifUnused`	boolean	<optional>	false	Only close if not in use

Source: lib/control.js, line 459

closeStream(streamId, reasonopt)

Closes the exit for the given stream

Parameters:

Name	Type	Attributes	Default	Description
`streamId`	string			ID for the stream to close
`reason`	number	<optional>	1	Reason code for closing stream

Source: lib/control.js, line 449
See: https://gitweb.torproject.org/torspec.git/tree/tor-spec.txt#n1404

createAddressMapping(target, replacement)

Instruct Tor to route requests to the target to the replacement

Parameters:

Name	Type	Description
`target`	string	Original address to map
`replacement`	string	New address to route request to target

Source: lib/control.js, line 383

createCircuit(purposeopt)

Creates a new circuit, returning the newly created circuit ID

Parameters:

Name	Type	Attributes	Default	Description
`purpose`	string	<optional>	"general"	The circuit purpose, either general\|controller

Source: lib/control.js, line 391

createHiddenService(ports, optionsopt)

Establishes a hidden service on the given target

Parameters:

Name	Type	Attributes	Description
`ports`	array		Array containing optional virtualPort (defaults to 80) and target ip:port string
`options`	object	<optional>	module:commands#ADD_ONION

Source: lib/control.js, line 270

destroyHiddenService(serviceId)

Takes down a running hidden service owned by this controller

Parameters:

Name	Type	Description
`serviceId`	string	Tor hidden service ID

Source: lib/control.js, line 278

dropGuards()

Tells the server to drop all guard nodes. Do not invoke this command lightly; it can increase vulnerability to tracking attacks over time.

Source: lib/control.js, line 501

dumpHeartbeat()

Dumps a heartbeat message to the logs

Source: lib/control.js, line 366

dumpStats()

Dump stats to tor log file

Source: lib/control.js, line 331

enableDebug()

Set open logs to debug level

Source: lib/control.js, line 338

extendCircuit(circuitId)

Extends the existing circuit

Parameters:

Name	Type	Description
`circuitId`	string	The circuit ID to extend

Source: lib/control.js, line 399

fetchHiddenServiceDescriptor(serviceId, serverLongNameopt)

Fetches descriptors for the given hidden service

Parameters:

Name	Type	Attributes	Description
`serviceId`	string		ID for the hidden service
`serverLongName`	string	<optional>	Long name for specific server to use

Source: lib/control.js, line 510

getAuthChallenge(nonce)

Requests an authentication challenge from tor

Parameters:

Name	Type	Description
`nonce`	string	Client nonce for authenticating

Source: lib/control.js, line 254

getConfig(keyword)

Return the values for the given configuration key

Parameters:

Name	Type	Description
`keyword`	string	Configuration key

Source: lib/control.js, line 303

getInfo(keyword)

Get information from Tor not stored in configuration

Parameters:

Name	Type	Description
`keyword`	string	Keyword for info to fetch

Source: lib/control.js, line 529
See: https://gitweb.torproject.org/torspec.git/tree/control-spec.txt#n500

getProtocolInfo()

Ask tor for general information

Source: lib/control.js, line 261

halt()

Shutdown tor immediately

Source: lib/control.js, line 345

loadConfig(configText)

Instruct Tor to load the configuration file from the given text

Parameters:

Name	Type	Description
`configText`	string	Complete torrc config text to load

Source: lib/control.js, line 484

postDescriptor(descriptor, optionsopt)

Inform the server about a new descriptor

Parameters:

Name Type Attributes Description

descriptor

object

Key-value pairs for server descriptor

options

object

Properties

Name	Type	Attributes	Default	Description
`purpose`	string	<optional>	"general"	general\|controller\|bridge
`cache`	boolean	<optional>	true	Flag for caching descriptor

Source: lib/control.js, line 429

postHiddenServiceDescriptor(descriptor, serverLongNameopt)

Launch a hidden service descriptor upload

Parameters:

Name	Type	Attributes	Description
`descriptor`	string
`serverLongName`	string	<optional>	Long name for specific server to use

Source: lib/control.js, line 520
See: https://gitweb.torproject.org/torspec.git/tree/rend-spec.txt#n193

quit()

Tells Tor to hang up on the controller

Source: lib/control.js, line 466

redirectStream(streamId, address, portopt)

Change the exit address on a given stream

Parameters:

Name	Type	Attributes	Description
`streamId`	string		ID for stream to redirect
`address`	string		Exit address for the given stream
`port`	number	<optional>	Exit port for the given stream

Source: lib/control.js, line 439

reloadConfig()

Reloads the config values set

Source: lib/control.js, line 317

removeEventListeners()

Instructs Tor to stop listening for events

Source: lib/control.js, line 547

resetConfig(keyword)

Change the value for a configuration variable to it's default

Parameters:

Name	Type	Description
`keyword`	string	Configuration key

Source: lib/control.js, line 295

resolve(address, optionsopt)

Launch remote hostname lookup - answer returnd as async ADDRMAP event

Parameters:

Name Type Attributes Description

address

string

Address to lookup

options

object

Properties

Name	Type	Attributes	Default	Description
`reverse`	boolean	<optional>	false	Perform reverse lookup

Source: lib/control.js, line 476

saveConfig()

Tell Tor to write out it's config value to it's torrc

Source: lib/control.js, line 310

setCircuitPurpose(circuitId, purpose)

Sets the purpose of the given circuit

Parameters:

Name	Type	Description
`circuitId`	string	The identifier for the circuit
`purpose`	string	One of general\|controller

Source: lib/control.js, line 408

setConfig(keyword, value)

Change the value for a configuration variable

Parameters:

Name	Type	Description
`keyword`	string	Configuration key
`value`	string	New value to set

Source: lib/control.js, line 287

shutdown()

Controlled shutdown signal

Source: lib/control.js, line 324

signal(signal)

Sends a signal to the control port

Parameters:

Name	Type	Description
`signal`	string

Source: lib/control.js, line 374

takeOwnership()

Take ownership of the tor process - will close tor when the connection closes

Source: lib/control.js, line 492

(static) createChallengeResponse(cookie, clientNonce, serverNonce) → {string}

Creates the challenge response from a SAFECOOKIE challenge

Parameters:

Name	Type	Description
`cookie`	string	The secret cookie string
`clientNonce`	string	Client nonce sent with auth challenge
`serverNonce`	string	Server nonce reply from auth challenge