SpiderFoot automates OSINT for threat intelligence and mapping your attack surface.
Python attacksurfacecticybersecurityfootprintinghackinginformation-gatheringinformation-securityinfosecintelligence-gatheringosintosint-frameworkosint-reconnaissanceosint-toolpentestingpythonreconsecurity-toolsthreat-intelligencethreatintel
# -*- coding: utf-8 -*-
# -------------------------------------------------------------------------------
# Name: sfp_ipstack
# Purpose: SpiderFoot plug-in to identify the Geo-location of IP addresses
# identified by other modules using ipstack.com.
#
# Author: Steve Micallef <[email protected]>
#
# Created: 20/08/2018
# Copyright: (c) Steve Micallef 2018
# Licence: MIT
# -------------------------------------------------------------------------------
import json
from spiderfoot import SpiderFootEvent, SpiderFootPlugin
class sfp_ipstack(SpiderFootPlugin):
meta = {
'name': "ipstack",
'summary': "Identifies the physical location of IP addresses identified using ipstack.com.",
'flags': ["apikey"],
'useCases': ["Footprint", "Investigate", "Passive"],
'categories': ["Real World"],
'dataSource': {
'website': "https://ipstack.com/",
'model': "FREE_AUTH_LIMITED",
'references': [
"https://ipstack.com/documentation",
"https://ipstack.com/faq"
],
'apiKeyInstructions': [
"Visit https://ipstack.com/product",
"Click on 'Get Free API Key'",
"Click on 'Dashboard'",
"The API key is listed under 'Your API Access Key'"
],
'favIcon': "https://ipstack.com/ipstack_images/ipstack_logo.svg",
'logo': "https://ipstack.com/ipstack_images/ipstack_logo.svg",
'description': "Locate and identify website visitors by IP address.\n"
"ipstack offers one of the leading IP to geolocation APIS "
"and global IP database services worldwide.",
}
}
# Default options
opts = {
"api_key": ""
}
optdescs = {
"api_key": "Ipstack.com API key."
}
results = None
errorState = False
def setup(self, sfc, userOpts=dict()):
self.sf = sfc
self.results = self.tempStorage()
self.errorState = False
for opt in list(userOpts.keys()):
self.opts[opt] = userOpts[opt]
# What events is this module interested in for input
def watchedEvents(self):
return ['IP_ADDRESS']
# What events this module produces
# This is to support the end user in selecting modules based on events
# produced.
def producedEvents(self):
return ["GEOINFO"]
# Handle events sent to this module
def handleEvent(self, event):
eventName = event.eventType
srcModuleName = event.module
eventData = event.data
self.debug(f"Received event, {eventName}, from {srcModuleName}")
if self.errorState:
return
if self.opts['api_key'] == "":
self.error("You enabled sfp_ipstack but did not set an API key!")
self.errorState = True
return
# Don't look up stuff twice
if eventData in self.results:
self.debug(f"Skipping {eventData}, already checked.")
return
self.results[eventData] = True
res = self.sf.fetchUrl("http://api.ipstack.com/" + eventData + "?access_key=" + self.opts['api_key'],
timeout=self.opts['_fetchtimeout'], useragent=self.opts['_useragent'])
if res['content'] is None:
self.info("No GeoIP info found for " + eventData)
try:
hostip = json.loads(res['content'])
if 'success' in hostip and hostip['success'] is False:
self.error("Invalid ipstack.com API key or usage limits exceeded.")
self.errorState = True
return
except Exception as e:
self.debug(f"Error processing JSON response: {e}")
return
geoinfo = hostip.get('country_name')
if geoinfo:
self.info(f"Found GeoIP for {eventData}: {geoinfo}")
evt = SpiderFootEvent("GEOINFO", geoinfo, self.__name__, event)
self.notifyListeners(evt)
# End of sfp_ipstack class