Package Documentation
Storm Package: synapse-wigle
The following Commands are available from this package. This documentation is generated for version 5.0.0 of the package.
Storm Commands
This package implements the following Storm Commands.
wigle.config.add
Add a Synapse-WiGLE 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
wigle.config.add default myapiname myapitoken
// Add a configuration for the current user
wigle.config.add --scope self myconfig myapiname myapitoken
Usage: wigle.config.add [options] <name> <apiname> <apitoken>
Options:
--help : Display the command usage.
--ssl-noverify : Do not perform SSL/TLS verification.
--proxy <proxy> : Configure the proxy usage. (default: True)
--scope <scope> : Set the scope on the configuration. (default: global, choices: global, self, unscoped)
Arguments:
<name> : A unique name for the configuration.
<apiname> : The WiGLE API name.
<apitoken> : The WiGLE API token.
The command is accessible to users with one or more of the following permissions:
power-ups.wigle.adminpower-ups.wigle.user
wigle.config.del
Delete a Synapse-WiGLE configuration.
Examples:
// Delete the "myconfig" configuration
wigle.config.del myconfig
Usage: wigle.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.wigle.adminpower-ups.wigle.user
wigle.config.list
Display the list of Synapse-WiGLE configurations you have access to.
Usage: wigle.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.wigle.adminpower-ups.wigle.user
wigle.config.migrate
Migrate options for all Synapse-WiGLE 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:
// Disable SSL verification for all configurations
wigle.config.migrate --ssl-verify (false)
Usage: wigle.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)
The command is accessible to users with one or more of the following permissions:
power-ups.wigle.admin
wigle.config.show
Show the details of a configuration.
Examples:
// Show the in-use configuration for the current user
wigle.config.show
// Show a configuration by name
wigle.config.show myconfig
Usage: wigle.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.wigle.adminpower-ups.wigle.user
wigle.config.update
Update the configuration of a defined Synapse-WiGLE 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 "myconfig"
// configuration
wigle.config.update myconfig --perm user myuser admin
// Set the permission level for the "all" role to "deny" on the
// "myconfig" configuration
wigle.config.update myconfig --perm role all deny
// Do not verify the SSL certificate when connecting to "myconfig"
wigle.config.update myconfig --ssl-verify (false)
// Change the name of the "myconfig" configuration to "otherconfig"
wigle.config.update myconfig --name otherconfig
Usage: wigle.config.update [options] <config>
Options:
--help : Display the command usage.
--apiname <apiname> : The WiGLE API name. (default: None)
--apitoken <apitoken> : The WiGLE API token. (default: None)
--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 name, or (null) to remove the
permission, which falls back to the config default.
(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)
--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.wigle.adminpower-ups.wigle.user
wigle.network.detail
Ingest network details from WiGLE.
This command uses the /api/v2/network/deatil endpoint to ingest observations
for a given BSSID. A BSSID can be specified by inbound inet:wifi:ap or inet:mac nodes,
or by using the --netid argument to specify a full MAC address.
The latitude/longitude from an observation will be used as the last known
location on the inet:wifi:ap if the timestamp is greater than the seen time
on the node.
The results of the query are used to create geo:telem nodes,
which are linked to inet:wifi:ap nodes via a geo:telem:node property.
Examples:
// Ingest details using the BSSID from an inet:wifi:ap node
inet:wifi:ap=('cool-wifi', 'aa:bb:cc:dd:ee:ff') | wigle.network.detail
// Ingest details using the netid argument and yield geo:telem nodes
wigle.network.detail --netid "aa:bb:cc:dd:ee:ff" --yield
Usage: wigle.network.detail [options]
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--size <size> : Limit the number of results ingested to the given size.
--yield : Yield the newly created nodes.
--netid <netid> : Search for networks using the network BSSID.
--config <config> : Override the default config with the provided name.
Inputs:
inet:mac : inet:mac nodes
inet:wifi:ap : inet:wifi:ap nodes
The command is accessible to users with one or more of the following permissions:
power-ups.wigle.adminpower-ups.wigle.user
wigle.network.search
Search the WiGLE wifi database.
This command uses the /api/v2/network/search endpoint to search for wifi
networks by BSSID or within a specific latitude/longitude bounding box.
A BSSID can be specified by using inbound inet:wifi:ap nodes, or by using
the --netid argument to specify at least three octets, for example '0A:2C:EF'.
A latitude/longitude bounding box can can be specified by using inbound
geo:place nodes, or by using the--latlong and --radius arguments. The --radius
argument may also be specified when inbound geo:place nodes are used to
override their :radius property value when calculating a bounding box.
The results of the query are used to create or enrich existing
inet:wifi:ap nodes.
Examples:
// Search for networks within the :bbox property of geo:place nodes
geo:place#my.place | wigle.network.search
// Search for the location of an inet:wifi:ap node
inet:wifi:ap=('cool-wifi', 'aa:bb:cc:dd:ee:ff') | wigle.network.search
// Search and yield results using --latlong and --radius args
wigle.network.search --latlong (39.851, -104.675) --radius 1km --size 100
// Search by latlong and netid
wigle.network.search --latlong (39.851, -104.675) --radius 1km --netid "aa:bb:cc"
// Search for 300 results using a BSSID prefix and yield created nodes
wigle.network.search --netid "aa:bb:cc" --yield --size 300
// Search by an exact SSID
wigle.network.search --ssid foobar
// Search by SSID with a wildcard
wigle.network.search --netid "aa:bb:cc" --ssid-like foo%
Usage: wigle.network.search [options]
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
--size <size> : Limit the number of results ingested to the given size.
--yield : Yield the newly created nodes.
--latlong <latlong> : A tuple of (latitude, longitude) to use for searching instead of an inbound node.
--radius <radius> : Radius to use for bbox calculation, will be used instead of :radius if present on
inbound geo:place nodes.
--netid <netid> : Search for networks using the network BSSID. requires a minimum of the first 3 octets.
--ssid <ssid> : Search by an exact SSID string (case-insensitive).
--ssid-like <ssid_like> : Search by SSID, allowing wildcards '%' (any string) and '_' (any character).
--min-firsttime <min_firsttime>: Filter results by the minimum time of when they were first created.
--min-lasttime <min_lasttime>: Filter results by the minimum time of how recently they have had data submitted.
--config <config> : Override the default config with the provided name.
Inputs:
geo:place : geo:place nodes
inet:wifi:ap : inet:wifi:ap nodes
The command is accessible to users with one or more of the following permissions:
power-ups.wigle.adminpower-ups.wigle.user
Storm Modules
This package does not export any Storm APIs.