Package Documentation
Storm Package: synapse-tor
The following Commands are available from this package. This documentation is generated for version 4.0.1 of the package.
Storm Commands
This package implements the following Storm Commands.
tor.config.add
Add a Synapse-Tor configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Add a global configuration
tor.config.add global_config
// Add a configuration for the current user with a custom tag prefix
tor.config.add --scope self my_config --tag-prefix my.cno.infra.anon.tor
Usage: tor.config.add [options] <name>
Options:
--help : Display the command usage.
--ssl-noverify : Do not perform SSL/TLS verification.
--proxy <proxy> : Configure the proxy usage. (default: True)
--tag-prefix <tag_prefix> : The tag prefix to use when tagging ingested nodes. (default: cno.infra.anon.tor)
--scope <scope> : Set the scope on the configuration. (default: global, choices: global, self, unscoped)
Arguments:
<name> : A unique name for the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.tor.adminpower-ups.tor.user
tor.config.del
Delete a Synapse-Tor configuration.
Examples:
// Delete the "fooconfig" configuration
tor.config.del fooconfig
Usage: tor.config.del [options] <name>
Options:
--help : Display the command usage.
Arguments:
<name> : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.tor.adminpower-ups.tor.user
tor.config.list
Display the list of Synapse-Tor configurations you have access to.
Usage: tor.config.list [options]
Options:
--help : Display the command usage.
The command is accessible to users with one or more of the following permissions:
power-ups.tor.adminpower-ups.tor.user
tor.config.migrate
Migrate options for all Synapse-Tor configurations.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Migrate the tag prefix for all configurations
tor.config.migrate --tag-prefix my.cno.infra.anon.tor
Usage: tor.config.migrate [options]
Options:
--help : Display the command usage.
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when tagging ingested nodes. (default: None)
The command is accessible to users with one or more of the following permissions:
power-ups.tor.admin
tor.config.show
Show the details of a configuration.
Examples:
// Show the in-use configuration for the current user
tor.config.show
// Show a configuration by name
tor.config.show myconfig
Usage: tor.config.show [options] <name>
Options:
--help : Display the command usage.
Arguments:
[name] : The name of the configuration.
The command is accessible to users with one or more of the following permissions:
power-ups.tor.adminpower-ups.tor.user
tor.config.update
Update the configuration of a defined Synapse-Tor configuration.
The proxy argument can be set to one of the following values:
true: Use the Cortex configured proxy if set.
false: Do not use the Cortex configured proxy if set.
<str>: A proxy URL to use.
Examples:
// Set the permission level for user "myuser" to "admin" on the "fooconfig"
// configuration
tor.config.update fooconfig --perm user myuser admin
// Do not verify the SSL certificate when connecting to "fooconfig"
tor.config.update fooconfig --ssl-verify (false)
// Change the tag prefix used by the "fooconfig" configuration
tor.config.update fooconfig --tag-prefix my.cno.infra.anon.tor
// Change the name of the "fooconfig" configuration to "barconfig"
tor.config.update fooconfig --name barconfig
Usage: tor.config.update [options] <config>
Options:
--help : Display the command usage.
--perm <perm> : Set the permission level for a user or role on this configuration.
Arguments to this option are ``scope``, ``name``, ``level``:
<scope>: The scope for the permission, either "user" or "role".
<name>: The user/role name depending on scope.
<level>: The $lib.auth.easyperm.level, or None to remove the permission.
(default: None)
--ssl-verify <ssl_verify> : Set whether to verify the SSL certificate of the server. (default: None)
--proxy <proxy> : Configure the proxy usage. (default: None)
--tag-prefix <tag_prefix> : The tag prefix to use when tagging ingested nodes. (default: None)
--name <name> : Rename the configuration. (default: None)
Arguments:
<config> : The name of the configuration to modify.
The command is accessible to users with one or more of the following permissions:
power-ups.tor.adminpower-ups.tor.user
tor.sync
Download the current TOR exit node list and tag inet:ipv4 nodes.
This command pulls the current list of TOR exit nodes from
https://check.torproject.org/torbulkexitlist, creating inet:ipv4 nodes
and applying the cno.infra.anon.tor.exit tag to them.
The --relays option will also ingest all currently running TOR relays from
https://onionoo.torproject.org/summary, creating inet:ipv4 and inet:ipv6 nodes
and applying the cno.infra.anon.tor.relay tag to them.
Tags will have timestamps set according to the published time,
and the cno.infra.anon.tor prefix can be changed with the tor.config.update command.
Examples:
// Ingest TOR exit nodes and yield the inet:ipv4 nodes
tor.sync --yield
// Ingest TOR exit nodes and all relays
tor.sync --relays
Endpoints:
(user-configured base URL)
/torbulkexitlist : Download the current list of Tor exit nodes.
/summary : Download the summary of currently running Tor relays.
Usage: tor.sync [options]
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--yield : Yield the inet:ipv4 nodes.
--relays : Ingest all relays in addition to exit nodes.
--config <config> : Override the default config with the provided name.
The command is accessible to users with one or more of the following permissions:
power-ups.tor.adminpower-ups.tor.user
Storm Modules
This package does not export any Storm APIs.