Module: granax/commands

On this page

Methods

(static) ADD_ONION(ports, optionsopt)

Parameters:

Name Type Attributes Description

ports

array

Array containing optional virtualPort (defaults to 80) and target ip:port string

options

object

<optional>

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

Source: lib/commands.js, line 89

(static) ATTACHSTREAM(streamId, options) → {string}

Parameters:

Name Type Description

streamId string

options

object

Properties

Name	Type	Description
`circuitId`	string
`hopNumber`	string \| null

Source: lib/commands.js, line 209

Returns:

Type:: string

(static) AUTHCHALLENGE(nonceopt, typeopt) → {string}

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 23

Returns:

Type:: string

(static) AUTHENTICATE(tokenopt) → {string}

Parameters:

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

Source: lib/commands.js, line 14

Returns:

Type:: string

(static) CLOSECIRCUIT(circuitId, optionsopt) → {string}

Parameters:

Name Type Attributes Description

circuitId string

options

object

<optional>

Properties

Name	Type	Attributes	Default	Description
`ifUnused`	boolean	<optional>	false

Source: lib/commands.js, line 266

Returns:

Type:: string

(static) CLOSESTREAM(streamId, reasonopt) → {string}

Parameters:

Name	Type	Attributes	Default	Description
`streamId`	string
`reason`	number	<optional>	1

Source: lib/commands.js, line 256

Returns:

Type:: string

(static) DEL_ONION(serviceId) → {string}

Parameters:

Name	Type	Description
`serviceId`	string

Source: lib/commands.js, line 132

Returns:

Type:: string

(static) DROPGUARDS() → {string}

Source: lib/commands.js, line 305

Returns:

Type:: string

(static) EXTENDCIRCUIT(circuitId) → {string}

Parameters:

Name	Type	Description
`circuitId`	string

Source: lib/commands.js, line 188

Returns:

Type:: string

(static) GETCONF(keyword) → {string}

Parameters:

Name	Type	Description
`keyword`	string

Source: lib/commands.js, line 157

Returns:

Type:: string

(static) GETINFO(keyword) → {string}

Parameters:

Name	Type	Description
`keyword`	string

Source: lib/commands.js, line 334

Returns:

Type:: string

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

Parameters:

Name	Type	Attributes	Description
`serviceId`	string
`serverLongName`	string	<optional>

Source: lib/commands.js, line 314

Returns:

Type:: string

(static) HSPOST(descriptor, serverLongNameopt) → {string}

Parameters:

Name	Type	Attributes	Description
`descriptor`	string
`serverLongName`	string	<optional>

Source: lib/commands.js, line 324

Returns:

Type:: string

(static) LOADCONF(configText) → {string}

Parameters:

Name	Type	Description
`configText`	string

Source: lib/commands.js, line 291

Returns:

Type:: string

(static) MAPADDRESS(targetAddr, replaceAddr) → {string}

Parameters:

Name	Type	Description
`targetAddr`	string
`replaceAddr`	string

Source: lib/commands.js, line 180

Returns:

Type:: string

(static) POSTDESCRIPTOR(descriptor, options) → {string}

Parameters:

Name Type Description

descriptor object

options

object

Properties

Name	Type	Attributes	Default	Description
`purpose`	string	<optional>	"general"
`cache`	boolean	<optional>	true

Source: lib/commands.js, line 221

Returns:

Type:: string

(static) PROTOCOLINFO() → {string}

Source: lib/commands.js, line 30

Returns:

Type:: string

(static) QUIT() → {string}

Source: lib/commands.js, line 274

Returns:

Type:: string

(static) REDIRECTSTREAM(streamId, address, portopt) → {string}

Parameters:

Name	Type	Attributes	Description
`streamId`	string
`address`	string
`port`	number	<optional>

Source: lib/commands.js, line 247

Returns:

Type:: string

(static) RESETCONF(keyword) → {string}

Parameters:

Name	Type	Description
`keyword`	string

Source: lib/commands.js, line 149

Returns:

Type:: string

(static) RESOLVE(address, reverseopt) → {string}

Parameters:

Name	Type	Attributes	Default	Description
`address`	string
`reverse`	boolean	<optional>	false

Source: lib/commands.js, line 283

Returns:

Type:: string

(static) SAVECONF() → {string}

Source: lib/commands.js, line 164

Returns:

Type:: string

(static) SETCIRCUITPURPOSE(circuitId, purpose)

Parameters:

Name	Type	Description
`circuitId`	string
`purpose`	string

Source: lib/commands.js, line 198

(static) SETCONF(keyword, value) → {string}

Parameters:

Name	Type	Description
`keyword`	string
`value`	string

Source: lib/commands.js, line 141

Returns:

Type:: string

(static) SETEVENTS(events) → {string}

Parameters:

Name	Type	Description
`events`	Array.<string>

Source: lib/commands.js, line 342

Returns:

Type:: string

(static) SIGNAL() → {string}

Source: lib/commands.js, line 171

Returns:

Type:: string

(static) TAKEOWNERSHIP() → {string}

Source: lib/commands.js, line 298

Returns:

Type:: string

(inner) _addOnionPortsStringToCommand(ports, options, command)

Parameters:

Name	Type	Description
`ports`	array
`options`	object
`command`	array

Source: lib/commands.js, line 40

(inner) _addOnionPortsToCommand(ports, options, command)

Parameters:

Name	Type	Description
`ports`	array
`options`	object
`command`	array

Source: lib/commands.js, line 53