Package Documentation
Storm Package: synapse-wigle
The following Commands are available from this package. This documentation is generated for version 3.0.0 of the package.
Storm Commands
This package implements the following Storm Commands.
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 -(seenat)> light edge.
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.
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
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 (latitute, 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.
--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.
wigle.setup.apikey
Manage the WiGLE API user and key.
Examples
// Set global WiGLE API credentials.
wigle.setup.apikey testname abcd1234
// Set WiGLE API credentials for the current user.
wigle.setup.apikey --self testname abcd1234
// Display the scope of the current credentials.
wigle.setup.apikey --show-scope
// Display the current API credentials.
wigle.setup.apikey --show-apikey
// Remove the current global API credentials.
wigle.setup.apikey --remove
// Remove the per-user API credentials for the current user.
wigle.setup.apikey --self --remove
Usage: wigle.setup.apikey [options] <apiname> <apitoken>
Options:
--help : Display the command usage.
--self : Set or remove the credentials as a user variable. If not used, set them globally.
--show-scope : Display the API credentials scope in use (global vs self).
--show-apikey : Display the API credentials (requires admin perms or a "self" scope key).
--remove : Remove the configured API credentials. May be used with --self.
Arguments:
[apiname] : The API name string.
[apitoken] : The API token string.
Storm Modules
This package does not export any Storm APIs.