WiGLE v1.0.0

About the connector

WiGLE (Wireless Geographic Logging Engine) is a website that collects information about the different wireless hotspots around the world.

This document provides information about the WiGLE connector, which facilitates automated interactions, with a WiGLE server using FortiSOAR™ playbooks. Add the WiGLE connector as a step in FortiSOAR™ playbooks and perform automated operations, such as searching for a network in the WiGLE connector, or retrieving statistics and information by group.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-wigle

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

• You must have the URL of WiGLE server to which you will connect and perform automated operations.
• You must have the API name and API token that is configured for your account to access the WiGLE endpoint.
• To access the FortiSOAR™, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the connectors page, select the WiGLE connector and click Configure to configure the following parameters:

Parameter	Description
Server URL	URL of the WiGLE server to which you will connect and perform the automated operations.
API Name	API name that is configured for your account to access the WiGLE endpoint.
API Token	API Token that is configured for your account to access the WiGLE endpoint.
Verify SSL	Specifies whether the SSL certificate for the server is to be verified or not. By default, this option is set as True.

Actions supported by the connector

The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:

Function	Description	Annotation and Category
Lookup Network	Searches for a network in the WiGLE database based on the input parameters such as freenet or paynet, you have specified.	lookup_network Investigation
Get Network Details	Retrieves details and observation records for a single network from WiGLE based on the WiFi Network BSSID and other parameters you have specified.	network_details Investigation
Cell Search	Searches for a cell in the WiGLE database based on the input parameters such as freenet or paynet, you have specified.	cell_search Investigation
Get Group Statistics	Retrieves statistics and information by group from WiGLE.	get_statistics_by_group Investigation
Get Site Statistics	Retrieves a named map of site-level statistics from WiGLE.	get_statistics_by_site Investigation
Get General Statistics	Retrieves a named map of general statistics from WiGLE.	get_statistics_by_general Investigation
Get Country Statistics	Retrieves statistics organized by country from WiGLE.	get_statistics_by_countries Investigation
Get Region Statistics	Retrieves statistics for a specified country, organized by region, from WiGLE based on the country code you have specified.	get_statistics_by_regions Investigation
Get User Statistics	Retrieves statistics for a user from WiGLE.	get_statistics_by_user Investigation

operation: Lookup Network

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criteria is applied, and an unfiltered list is returned.

Parameter	Description
Only Mine	If you select this option, i.e., set it to True, then this operation will search only for points that were first discovered by the current user. By default, this is unchecked, i.e., set to False.
Freenet	If you select this option, i.e., set it to True, then this operation will search for and included only those networks that have been marked as "free" access. By default, this is unchecked, i.e., set to False.
Paynet	If you select this option, i.e., set it to True, then this operation will search for and included only those networks that have been marked as "for-pay" access. By default, this is unchecked, i.e., set to False.
Not Mine	Searches only for points that were first discovered by users other than the current user.
Latitude From	Latitude from which you want to search for a network, i.e., the lesser of two latitudes by which you want to bound the search.
Latitude To	Latitude to which you want to search for a network, i.e., the greater of two latitudes by which you want to bound the search.
Longitude From	Longitude from which you want to search for a network, i.e., the lesser of two longitudes by which you want to bound the search.
Longitude To	Longitude to which you want to search for a network, i.e., the greater of two longitudes by which you want to bound the search.
Last Update	Filters points by how recently they have been updated.
Start Transition ID	Transition ID from which you want to search for a network, i.e., the earliest transition ID by which you want to bound the search (year-level precision only). For example, 20170501-00000
End Transition ID	Transition ID till which you want to search for a network, i.e., the latest transition ID by which you want to bound the search (year-level precision only). For example, 20180518-00000
Encryption	Encryption detected. You can specify one of the following encryptions: None, WEP, WPA, WPA2, WPA3, or Unknown. This field is case-insensitive, i.e., you can enter WPA or wpa.
Net ID	Searches and includes only those networks that match the string network BSSID that you have entered. For example, 0A:2C:EF:3D:25:1Bor 0A:2C:EF. Note: The first three octets are required.
SSID	Searches and includes only those networks that exactly match the string network name that you have entered.
SSID Like	Searches and includes only those networks that match the string network name that you have entered, allowing for wildcards % (any string) and _ (any character). For example, Gjensi%
Min QoS	Searches and includes only those networks whose Minimum Quality of Signal (QoS) matches the number you have entered. The allowable range is (0-7).
Search After	Previous page’s search_after to get the next page. By default, this is set to 0.
Results Per Page	Number of results that you want to display on one page. By default, it is set to 25 for COMMAPI and 100 for site. It is bounded at 1000 for COMMAPI and 100 for site.

Output

The output contains the following populated JSON schema:
{
"last": "",
"search_after": "",
"results": [
{
"road": "",
"channel": "",
"lasttime": "",
"encryption": "",
"housenumber": "",
"lastupdt": "",
"region": "",
"freenet": "",
"dhcp": "",
"ssid": "",
"trilong": "",
"trilat": "",
"firsttime": "",
"netid": "",
"type": "",
"transid": "",
"userfound": "",
"qos": "",
"wep": "",
"paynet": "",
"country": "",
"name": "",
"bcninterval": "",
"comment": "",
"city": ""
}
],
"resultCount": "",
"totalResults": "",
"first": "",
"success": ""
}

operation: Get Network Details

Input parameters

Parameter	Description
WiFi Network BSSID	WiFi Network BSSID based on which you want to retrieve details for the network.
GSM Operator ID	(Optional) GSM Operator ID based on which you want to retrieve details for the network.
GSM Location Area Code	(Optional) GSM Location Area Code based on which you want to retrieve details for the network.
GSM Cell ID	(Optional) GSM Cell ID based on which you want to retrieve details for the network.
CDMA System ID	(Optional) CDMA System ID based on which you want to retrieve details for the network.
CDMA Network ID	(Optional) CDMA NEtwork ID based on which you want to retrieve details for the network.
CDMA Base Station ID	(Optional) CDMA Base Station ID based on which you want to retrieve details for the network.

Output

The output contains the following populated JSON schema:
{
"cdma": "",
"results": [
{
"road": "",
"channel": "",
"lasttime": "",
"encryption": "",
"housenumber": "",
"lastupdt": "",
"region": "",
"freenet": "",
"dhcp": "",
"ssid": "",
"trilong": "",
"trilat": "",
"firsttime": "",
"netid": "",
"type": "",
"transid": "",
"userfound": "",
"qos": "",
"locationData": [
{
"snr": "",
"longitude": "",
"netId": "",
"month": "",
"encryptionValue": "",
"accuracy": "",
"alt": "",
"lastupdt": "",
"wep": "",
"latitude": "",
"noise": "",
"signal": "",
"ssid": "",
"name": "",
"time": ""
}
],
"wep": "",
"paynet": "",
"country": "",
"name": "",
"bcninterval": "",
"comment": "",
"city": ""
}
],
"success": "",
"gsm": "",
"addresses": [],
"wifi": ""
}

operation: Cell Search

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criteria is applied, and an unfiltered list is returned.

Parameter	Description
Only Mine	If you select this option, i.e., set it to True, then this operation will search only for points (cells) that were first discovered by the current user. By default, this is unchecked, i.e., set to False. Note: You can use any string to set or leave unset for general search. Cannot be used with COMMAPI authentication, since these are points that you have locally.
Show GSM	If you select this option, i.e., set it to True, then this operation will include GSM cell networks. By default, this is unchecked, i.e., set to False.
Show CDMA	If you select this option, i.e., set it to True, then this operation will include CDMA cell networks. By default, this is unchecked, i.e., set to False.
SSID	Searches and includes only those cell towers that exactly match the string network name that you have entered.
Not Mine	Searches only for points that were first discovered by users other than the current user.
SSID Like	Searches and includes only those cell towers that match the string network name that you have entered, allowing for wildcards % (any string) and _ (any character). For example, vodafone%
Latitude From	Latitude from which you want to search for a cell, i.e., the lesser of two latitudes by which you want to bound the search.
Latitude To	Latitude to which you want to search for a cell, i.e., the greater of two latitudes by which you want to bound the search.
Longitude From	Longitude from which you want to search for a cell, i.e., the lesser of two longitudes by which you want to bound the search.
Longitude To	Longitude to which you want to search for a cell, i.e., the greater of two longitudes by which you want to bound the search.
Last Update	Filters points by how recently they have been updated.
Start Transition ID	Transition ID from which you want to search for a cell, i.e., the earliest transition ID by which you want to bound the search (year-level precision only). For example, 20150318-00000
End Transition ID	Transition ID till which you want to search for a cell, i.e., the latest transition ID by which you want to bound the search (year-level precision only). For example, 20170326-00000
Cell Operator	Cell Operator (GSM/LTE/WCDMA) or System (CDMA) ID parameter by which to filter the results.
Cell LAC	Cell LAC (GSM/LTE/WCDMA) or Network (CDMA) ID parameter by which to filter the results.
Cell ID	Cell ID (GSM/LTE/WCDMA) or Basestation (CDMA) parameter by which to filter the results.
Min QoS	Searches and includes only those networks whose Minimum Quality of Signal (QoS) matches the number you have entered. The allowable range is (0-7).
Search After	Previous page’s search_after to get the next page. By default, this is set to 0.
Results Per Page	Number of results that you want to display on one page. By default, it is set to 25 for COMMAPI and 100 for site. It is bounded at 1000 for COMMAPI and 100 for site.

Output

The output contains the following populated JSON schema:
{
"last": "",
"search_after": "",
"results": [
{
"road": "",
"channel": "",
"lasttime": "",
"encryption": "",
"housenumber": "",
"lastupdt": "",
"region": "",
"freenet": "",
"dhcp": "",
"ssid": "",
"trilong": "",
"trilat": "",
"firsttime": "",
"netid": "",
"type": "",
"transid": "",
"userfound": "",
"qos": "",
"wep": "",
"paynet": "",
"country": "",
"name": "",
"bcninterval": "",
"comment": "",
"city": ""
}
],
"resultCount": "",
"success": "",
"first": "",
"totalResults": ""
}

operation: Get Group Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
"success": "",
"groups": [{
"owner": "",
"discovered": "",
"joined": "",
"members": "",
"groupId": "",
"groupName": "",
"total": "",
"genDisc": "",
}]
}

operation: Get Site Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
"netwpa2": "",
"trans1da": "",
"netwpa": "",
"nettotal": "",
"transtdy": "",
"dfltwpkn": "",
"success": "",
"nettoday": "",
"size": "",
"genloc": "",
"netwep": "",
"netloc": "",
"waitQueue": "",
"dfltnowp": "",
"netlocd2": "",
"netwpa3": "",
"netwep?": "",
"trans2da": "",
"netnowep": "",
"netwwwd3": "",
"transtot": "",
"loctotal": "",
"dfltssid": "",
"netlocdy": "",
"userstot": "",
"gentotal": ""
}

operation: Get General Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
"netwpa2": "",
"manufacturer": "",
"trans1da": "",
"netwpa": "",
"nettotal": "",
"transtdy": "",
"dfltwpkn": "",
"ieeeManufacturerStatistics": [{
"name": "",
"value": ""
}],
"success": "",
"nettoday": "",
"android": "",
"genloc": "",
"netwep": "",
"ssidStatistics": [{
"name": "",
"value": ""
}],
"manufacturerStatistics": [{
"name": "",
"value": ""
}],
"netloc": "",
"dfltnowp": "",
"netlocd2": "",
"netwpa3": "",
"netwep?": "",
"trans2da": "",
"octet": "",
"netnowep": "",
"netwwwd3": "",
"transtot": "",
"loctotal": "",
"dfltssid": "",
"netlocdy": "",
"userstot": "",
"gentotal": ""
}

operation: Get Country Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
"success": "",
"countries": [{
"count": "",
"country": ""
}]
}

operation: Get Region Statistics

Input parameters

Parameter	Description
Country	Two-letter code of the country for which you want to retrieve the regional statistical breakdown. By default, this is set to US.

Output

The output contains the following populated JSON schema:
{
"encryption": [
{
"count": "",
"wep": ""
}
],
"postalCode": [
{
"count": "",
"postalCode": ""
}
],
"success": "",
"regions": [
{
"count": "",
"region": ""
}
],
"country": ""
}

operation: Get User Statistics

Input parameters

None.

Output

The output contains the following populated JSON schema:
{
"statistics": {
"discoveredWiFiGPSPercent": "",
"prevRank": "",
"totalWiFiLocations": "",
"self": "",
"userName": "",
"discoveredCellGPS": "",
"discoveredWiFi": "",
"first": "",
"eventPrevMonthCount": "",
"prevMonthRank": "",
"discoveredWiFiGPS": "",
"last": "",
"eventMonthCount": "",
"monthRank": "",
"discoveredCell": "",
"rank": ""
},
"message": "",
"monthRank": "",
"success": "",
"rank": "",
"user": "",
"imageBadgeUrl": ""
}

Included playbooks

The Sample - WiGLE - 1.0.0 playbook collection comes bundled with the WiGLE connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the WiGLE connector.

• Cell Search
• Get Country Statistics
• Get General Statistics
• Get Group Statistics
• Get Network Details
• Get Region Statistics
• Get Site Statistics
• Get User Statistics
• Lookup Network

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.