Skip to content

SpiderFoot automates OSINT for threat intelligence and mapping your attack surface.

Add sfp_apility module

Brendan Coles23cf78ca69ea
diff --git a/modules/sfp_apility.py b/modules/sfp_apility.py
new file mode 100644
index 00000000..aee5ae86
--- /dev/null
+++ b/modules/sfp_apility.py
@@ -0,0 +1,237 @@
+# -*- coding: utf-8 -*-
+# -------------------------------------------------------------------------------
+# Name: sfp_neutrinoapi
+# Purpose: SpiderFoot plug-in to search Apility API for IP address and domain
+# reputation.
+#
+# Author: <[email protected]>
+#
+# Created: 2019-09-16
+# Copyright: (c) bcoles 2019
+# Licence: GPL
+# -------------------------------------------------------------------------------
+
+import json
+import socket
+import time
+from sflib import SpiderFoot, SpiderFootPlugin, SpiderFootEvent
+
+class sfp_apility(SpiderFootPlugin):
+ """Apility:Footprint,Investigate,Passive:Reputation Systems:apikey:Search Apility API for IP address and domain reputation."""
+
+ # Default options
+ opts = {
+ 'api_key': '',
+ 'delay': 2,
+ 'malicious_freemail': True
+ }
+
+ # Option descriptions
+ optdescs = {
+ 'api_key': 'Apility API key.',
+ 'delay': 'Delay between requests, in seconds.',
+ 'malicious_freemail': 'Consider free mail servers to be malicious.'
+ }
+
+ results = None
+ errorState = False
+
+ # Initialize module and module options
+ def setup(self, sfc, userOpts=dict()):
+ self.sf = sfc
+ self.results = dict()
+ self.errorState = False
+
+ for opt in userOpts.keys():
+ self.opts[opt] = userOpts[opt]
+
+ # What events is this module interested in for input
+ def watchedEvents(self):
+ return ['IP_ADDRESS', 'INTERNET_NAME']
+
+ # What events this module produces
+ def producedEvents(self):
+ return ['MALICIOUS_IPADDR', 'MALICIOUS_INTERNET_NAME',
+ 'IP_ADDRESS', 'PROVIDER_MAIL', 'PROVIDER_DNS', 'RAW_RIR_DATA']
+
+ # Query baddomain REST API
+ # https://apility.io/apidocs/#domain-check
+ def queryBadDomain(self, qry):
+ headers = {
+ 'Accept': 'application/json',
+ 'X-Auth-Token': self.opts['api_key']
+ }
+ res = self.sf.fetchUrl('https://api.apility.net/baddomain/' + qry,
+ headers=headers,
+ timeout=15,
+ useragent=self.opts['_useragent'])
+
+ time.sleep(self.opts['delay'])
+
+ return self.parseApiResponse(res)
+
+ # Query badip REST API
+ # https://apility.io/apidocs/#ip-check
+ def queryBadIp(self, qry):
+ headers = {
+ 'Accept': 'application/json',
+ 'X-Auth-Token': self.opts['api_key']
+ }
+ res = self.sf.fetchUrl('https://api.apility.net/badip/' + qry,
+ headers=headers,
+ timeout=15,
+ useragent=self.opts['_useragent'])
+
+ time.sleep(self.opts['delay'])
+
+ return self.parseApiResponse(res)
+
+
+ # Query IP REST API
+ # https://apility.io/apidocs/#full-ip-address-reputation
+ # Note: currently unused
+ def queryIp(self, qry):
+ headers = {
+ 'Accept': 'application/json',
+ 'X-Auth-Token': self.opts['api_key']
+ }
+ res = self.sf.fetchUrl('https://api.apility.net/v2.0/ip/' + qry,
+ headers=headers,
+ timeout=15,
+ useragent=self.opts['_useragent'])
+
+ time.sleep(self.opts['delay'])
+
+ return self.parseApiResponse(res)
+
+ # Query AS IP REST API
+ # https://apility.io/apidocs/#get-the-as-information-from-an-ip-v2-0
+ # Note: currently unused
+ def queryAsIp(self, qry):
+ headers = {
+ 'Accept': 'application/json',
+ 'X-Auth-Token': self.opts['api_key']
+ }
+ res = self.sf.fetchUrl('https://api.apility.net/v2.0/as/ip/' + qry,
+ headers=headers,
+ timeout=15,
+ useragent=self.opts['_useragent'])
+
+ time.sleep(self.opts['delay'])
+
+ return self.parseApiResponse(res)
+
+ # Parse API response
+ def parseApiResponse(self, res):
+ # https://apility.io/docs/step-4-plans-pricing/
+ # https://apility.io/docs/difference-hits-requests/
+ if res['code'] == "429":
+ self.sf.error("You are being rate-limited by apility ", False)
+ self.errorState = True
+ return None
+
+ if res['code'] == "404":
+ return None
+
+ if res['content'] is None:
+ return None
+
+ if res['content'] == 'Unauthorized':
+ self.sf.error("Authentication failed", False)
+ self.errorState = True
+ return None
+
+ try:
+ data = json.loads(res['content'])
+ except Exception as e:
+ self.sf.debug("Error processing JSON response.")
+ return None
+
+ return data
+
+ # Handle events sent to this module
+ def handleEvent(self, event):
+ eventName = event.eventType
+ srcModuleName = event.module
+ eventData = event.data
+
+ if self.errorState:
+ return None
+
+ if eventData in self.results:
+ return None
+
+ if self.opts['api_key'] == "":
+ self.sf.error("You enabled sfp_apility but did not set an API key!", False)
+ self.errorState = True
+ return None
+
+ self.results[eventData] = True
+
+ self.sf.debug("Received event, " + eventName + ", from " + srcModuleName)
+
+ if eventName == 'IP_ADDRESS':
+ data = self.queryBadIp(eventData)
+
+ if data is None:
+ self.sf.debug("No matches found for " + eventData)
+ return None
+
+ res = data.get('response')
+
+ if not res:
+ self.sf.debug("No matches found for " + eventData)
+ return None
+
+ for m in res:
+ if m == 'FREEMAIL' and not self.opts['malicious_freemail']:
+ continue
+ evt = SpiderFootEvent('MALICIOUS_IPADDR', m + ' [' + eventData + ']', self.__name__, event)
+ self.notifyListeners(evt)
+
+ if eventName == 'INTERNET_NAME':
+ data = self.queryBadDomain(eventData)
+
+ if data is None:
+ self.sf.debug("No matches found for " + eventData)
+ return None
+
+ res = data.get('response')
+
+ if not res:
+ self.sf.debug("No matches found for " + eventData)
+ return None
+
+ evt = SpiderFootEvent('RAW_RIR_DATA', str(res), self.__name__, event)
+ self.notifyListeners(evt)
+
+ if res.get('ip'):
+ ip_address = res.get('ip').get('address')
+ if ip_address:
+ evt = SpiderFootEvent('IP_ADDRESS', ip_address, self.__name__, event)
+ self.notifyListeners(evt)
+
+ domain = res.get('domain')
+
+ if not domain:
+ self.sf.debug("No matches found for " + eventData)
+ return None
+
+ if domain.get('blacklist'):
+ for m in domain.get('blacklist'):
+ if m == 'FREEMAIL' and not self.opts['malicious_freemail']:
+ continue
+ evt = SpiderFootEvent('MALICIOUS_INTERNET_NAME', m + ' [' + eventData + ']', self.__name__, event)
+ self.notifyListeners(evt)
+
+ if domain.get('mx'):
+ for mx in domain.get('mx'):
+ evt = SpiderFootEvent('PROVIDER_MAIL', mx, self.__name__, event)
+ self.notifyListeners(evt)
+
+ if domain.get('ns'):
+ for ns in domain.get('ns'):
+ evt = SpiderFootEvent('PROVIDER_DNS', ns, self.__name__, event)
+ self.notifyListeners(evt)
+
+# End of sfp_apility class