Class: ControlCommand

new ControlCommand(commandStr)

Wraps a control command to send over the control port.

Parameters:

Name	Type	Description
`commandStr`	string	Command to send.

Source: lib/commands.js, line 15

Members

cmd

Properties

Name	Type	Description
`cmd`	string	Command instance was intialized with.

Source: lib/commands.js, line 19

Methods

toString() → {string}

Unwraps the command as a raw string.

Source: lib/commands.js, line 26

Returns:

Type:: string

(static) ADD_ONION(ports, addOnionOptsopt) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Attributes	Description
`ports`	string \| Array.<number> \| number		Ports to map this onion service to.
`addOnionOpts`	module:bulb/commands~ControlCommand~AddOnionOptions	<optional>	Configuration options.

Source: lib/commands.js, line 94
See: https://spec.torproject.org/control-spec/commands.html#add_onion

Returns:

Type:: module:bulb/commands~ControlCommand

(static) ATTACHSTREAM(streamId, options) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`streamId`	string	Stream ID to attach to circuit.
`options`	module:bulb/commands~ControlCommand~AttachStreamOptions

Source: lib/commands.js, line 266
See: https://spec.torproject.org/control-spec/commands.html#attachstream

Returns:

Type:: module:bulb/commands~ControlCommand

(static) AUTHCHALLENGE(nonceopt, typeopt) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Attributes	Default	Description
`nonce`	string	<optional>	""	Client nonce for challenge.
`type`	string	<optional>	"SAFECOOKIE"	The type of challenge.

Source: lib/commands.js, line 63
See: https://spec.torproject.org/control-spec/commands.html#authchallenge

Returns:

Type:: module:bulb/commands~ControlCommand

(static) AUTHENTICATE(tokenopt) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Attributes	Default	Description
`token`	string	<optional>	""	The auth token to send.

Source: lib/commands.js, line 53
See: https://spec.torproject.org/control-spec/commands.html#authenticate

Returns:

Type:: module:bulb/commands~ControlCommand

(static) CLOSECIRCUIT(circuitId, optionsopt) → {module:bulb/commands~ControlCommand}

Parameters:

Name Type Attributes Description

circuitId

string

Circuit ID to close.

options

object

Properties

Name	Type	Attributes	Default	Description
`ifUnused`	boolean	<optional>	false	Only close if circuit is unused.

Source: lib/commands.js, line 333
See: https://spec.torproject.org/control-spec/commands.html#closecircuit

Returns:

Type:: module:bulb/commands~ControlCommand

(static) CLOSESTREAM(streamId, reasonopt) → {module:bulb/commands~ControlCommand}

Parameters:

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

Source: lib/commands.js, line 322
See: https://spec.torproject.org/control-spec/commands.html#closestream

Returns:

Type:: module:bulb/commands~ControlCommand

(static) DEL_ONION(serviceId) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`serviceId`	string	Onion address excluding ".onion".

Source: lib/commands.js, line 174
See: https://spec.torproject.org/control-spec/commands.html#del_onion

Returns:

Type:: module:bulb/commands~ControlCommand

(static) DROPGUARDS() → {module:bulb/commands~ControlCommand}

Source: lib/commands.js, line 377
See: https://spec.torproject.org/control-spec/commands.html#dropguards

Returns:

Type:: module:bulb/commands~ControlCommand

(static) EXTENDCIRCUIT(circuitId, purposeopt) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Attributes	Description
`circuitId`	string		Circuit ID to extend.
`purpose`	string	<optional>	Purpose to set for the circuit.

Source: lib/commands.js, line 239
See: https://spec.torproject.org/control-spec/commands.html#extendcircuit

Returns:

Type:: module:bulb/commands~ControlCommand

(static) GETCONF(keyword) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`keyword`	string	Configuration key to get.

Source: lib/commands.js, line 202
See: https://spec.torproject.org/control-spec/commands.html#getconf

Returns:

Type:: module:bulb/commands~ControlCommand

(static) GETINFO(keyword) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`keyword`	string	Keyword for info to get.

Source: lib/commands.js, line 409
See: https://spec.torproject.org/control-spec/commands.html#getinfo

Returns:

Type:: module:bulb/commands~ControlCommand

(static) HSFETCH(serviceId, serverLongNameopt) → {string}

Parameters:

Name	Type	Attributes	Description
`serviceId`	string		Hidden service onion URL without ".onion".
`serverLongName`	string	<optional>	Server name to fetch from.

Source: lib/commands.js, line 387
See: https://spec.torproject.org/control-spec/commands.html#hsfetch

Returns:

Type:: string

(static) HSPOST(descriptor, serverLongNameopt) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Attributes	Description
`descriptor`	string		Raw hidden service descriptor string.
`serverLongName`	string	<optional>	Server name to post to.

Source: lib/commands.js, line 398
See: https://spec.torproject.org/control-spec/commands.html#hspost

Returns:

Type:: module:bulb/commands~ControlCommand

(static) LOADCONF(configText) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`configText`	string	Sends the torrc configuration to the controller.

Source: lib/commands.js, line 361
See: https://spec.torproject.org/control-spec/commands.html#loadconf

Returns:

Type:: module:bulb/commands~ControlCommand

(static) MAPADDRESS(targetAddr, replaceAddr) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`targetAddr`	string	Address to map from.
`replaceAddr`	string	Address to map to.

Source: lib/commands.js, line 229
See: https://spec.torproject.org/control-spec/commands.html#mapaddress

Returns:

Type:: module:bulb/commands~ControlCommand

(static) POSTDESCRIPTOR(descriptor, options) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`descriptor`	Object.<string, string>	Key value pairs for descriptor to post.
`options`	module:bulb/commands~ControlCommand~PostDescriptorOptions

Source: lib/commands.js, line 283
See: https://spec.torproject.org/control-spec/commands.html#postdescriptor

Returns:

Type:: module:bulb/commands~ControlCommand

(static) PROTOCOLINFO() → {module:bulb/commands~ControlCommand}

Source: lib/commands.js, line 71
See: https://spec.torproject.org/control-spec/commands.html#protocolinfo

Returns:

Type:: module:bulb/commands~ControlCommand

(static) QUIT() → {module:bulb/commands~ControlCommand}

Source: lib/commands.js, line 342
See: https://spec.torproject.org/control-spec/commands.html#quit

Returns:

Type:: module:bulb/commands~ControlCommand

(static) REDIRECTSTREAM(streamId, address, portopt) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Attributes	Description
`streamId`	string		Stream ID to redirect.
`address`	string		Hostname to redirect to.
`port`	number	<optional>	Port to redirect to.

Source: lib/commands.js, line 312
See: https://spec.torproject.org/control-spec/commands.html#redirectstream

Returns:

Type:: module:bulb/commands~ControlCommand

(static) RESETCONF(keyword) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`keyword`	string	Configuration key to reset.

Source: lib/commands.js, line 193
See: https://spec.torproject.org/control-spec/commands.html#resetconf

Returns:

Type:: module:bulb/commands~ControlCommand

(static) RESOLVE(address, reverseopt) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Attributes	Default	Description
`address`	string			Address to resolve.
`reverse`	boolean	<optional>	false	Do reverse lookup.

Source: lib/commands.js, line 352
See: https://spec.torproject.org/control-spec/commands.html#resolve

Returns:

Type:: module:bulb/commands~ControlCommand

(static) SAVECONF() → {module:bulb/commands~ControlCommand}

Source: lib/commands.js, line 210
See: https://spec.torproject.org/control-spec/commands.html#saveconf

Returns:

Type:: module:bulb/commands~ControlCommand

(static) SETCIRCUITPURPOSE(circuitId, purposeopt) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Attributes	Description
`circuitId`	string		Circuit ID to set purpose for.
`purpose`	string	<optional>	Purpose to set for the circuit.

Source: lib/commands.js, line 250
See: https://spec.torproject.org/control-spec/commands.html#setcircuitpurpose

Returns:

Type:: module:bulb/commands~ControlCommand

(static) SETCONF(keyword, value) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`keyword`	string	Configuration key.
`value`	string	Configuration value.

Source: lib/commands.js, line 184
See: https://spec.torproject.org/control-spec/commands.html#setconf

Returns:

Type:: module:bulb/commands~ControlCommand

(static) SETEVENTS(events) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`events`	Array.<string>	Names of events that tor should send.

Source: lib/commands.js, line 418
See: https://spec.torproject.org/control-spec/commands.html#setevents

Returns:

Type:: module:bulb/commands~ControlCommand

(static) SIGNAL(signal) → {module:bulb/commands~ControlCommand}

Parameters:

Name	Type	Description
`signal`	string	module:bulb/commands~ControlCommand~Signal type to send.

Source: lib/commands.js, line 219
See: https://spec.torproject.org/control-spec/commands.html#signal

Returns:

Type:: module:bulb/commands~ControlCommand

(static) TAKEOWNERSHIP() → {module:bulb/commands~ControlCommand}

Source: lib/commands.js, line 369
See: https://spec.torproject.org/control-spec/commands.html#takeownership

Returns:

Type:: module:bulb/commands~ControlCommand

Type Definitions

AddOnionOptions

Type:

object

Properties

Name	Type	Attributes	Default	Description
`clientName`	string	<optional>		Client auth identifier.
`clientBlob`	string	<optional>		Arbitrary auth data.
`keyType`	string	<optional>	"NEW"	Create a new key or use RSA1024.
`keyBlob`	string	<optional>	"BEST"	Key type to create or serialized.
`discardPrivateKey`	boolean	<optional>	false	Do not return key.
`detach`	boolean	<optional>	false	Keep service running after close.
`basicAuth`	boolean	<optional>	false	Use client name and blob auth.
`nonAnonymous`	boolean	<optional>	false	Non-anononymous mode.
`virtualPort`	number	<optional>	80	Virtual port to expose on the hidden service.

Source: lib/commands.js, line 75

AttachStreamOptions

Type:

object

Properties

Name	Type	Attributes	Description
`circuitId`	string		Circuit ID to attach stream to.
`hopNumber`	string	<optional>	Hop number in circuit to attach stream to.

Source: lib/commands.js, line 254

PostDescriptorOptions

Type:

object

Properties

Name	Type	Attributes	Default	Description
`options.purpose`	string	<optional>	"general"	Set descriptor purpose.
`options.cache`	boolean	<optional>	true	Cache the descriptor.

Source: lib/commands.js, line 271

Signal

Map of control signals.

Type:

Object.<string, string>

Source: lib/commands.js, line 30
See: https://spec.torproject.org/control-spec/commands.html#signal