Skip to content

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

Implement sfp_maltiverse

Krishnasis Mandal43197dcbc8ea
diff --git a/modules/sfp_maltiverse.py b/modules/sfp_maltiverse.py
new file mode 100644
index 00000000..c8658066
--- /dev/null
+++ b/modules/sfp_maltiverse.py
@@ -0,0 +1,210 @@
+# -*- coding: utf-8 -*-
+# -------------------------------------------------------------------------------
+# Name: sfp_maltiverse
+# Purpose: Spiderfoot plugin to search Maltiverse API
+# for any malicious activity by the target
+#
+# Author: Krishnasis Mandal <[email protected]>
+#
+# Created: 20/05/2020
+# Copyright: (c) Steve Micallef
+# Licence: GPL
+# -------------------------------------------------------------------------------
+
+from sflib import SpiderFoot, SpiderFootPlugin, SpiderFootEvent
+from netaddr import IPNetwork
+import urllib.request, urllib.parse, urllib.error
+import json
+from datetime import datetime
+
+class sfp_maltiverse(SpiderFootPlugin):
+ """Maltiverse:Investigate,Passive:Reputation Systems::Obtain information about any malicious activities involving IP addresses found"""
+
+ opts = {
+ 'checkaffiliates': True,
+ 'subnetlookup': False,
+ 'netblocklookup': True,
+ 'maxnetblock': 24,
+ 'maxsubnet': 24,
+ "age_limit_days": 30
+ }
+
+ # Option descriptions. Delete any options not applicable to this module.
+ optdescs = {
+ 'checkaffiliates': "Check affiliates?",
+ 'subnetlookup': "Look up all IPs on subnets which your target is a part of?",
+ 'netblocklookup': "Look up all IPs on netblocks deemed to be owned by your target for possible blacklisted hosts on the same target subdomain/domain?",
+ 'maxnetblock': "If looking up owned netblocks, the maximum netblock size to look up all IPs within (CIDR value, 24 = /24, 16 = /16, etc.)",
+ 'maxsubnet': "If looking up subnets, the maximum subnet size to look up all the IPs within (CIDR value, 24 = /24, 16 = /16, etc.)",
+ "age_limit_days": "Ignore any records older than this many days. 0 = unlimited.",
+ }
+
+ results = None
+ errorState = False
+
+ def setup(self, sfc, userOpts=dict()):
+ self.sf = sfc
+ self.results = self.tempStorage()
+
+ for opt in list(userOpts.keys()):
+ self.opts[opt] = userOpts[opt]
+
+ # What events is this module interested in for input
+ # For a list of all events, check sfdb.py.
+ def watchedEvents(self):
+ return ["IP_ADDRESS", "NETBLOCK_OWNER", "NETBLOCK_MEMBER",
+ "AFFILIATE_IPADDR"]
+
+ # What events this module produces
+ def producedEvents(self):
+ return ["IP_ADDRESS", "MALICIOUS_IPADDR", "RAW_RIR_DATA"]
+
+ # Check whether the IP Address is malicious using Phishstats API
+ # https://app.swaggerhub.com/apis-docs/maltiverse/api/1.0.0-oas3#/IPv4/getIP
+ def queryIPAddress(self, qry):
+
+ headers = {
+ 'Accept' : "application/json",
+ }
+
+ res = self.sf.fetchUrl(
+ 'https://api.maltiverse.com/ip/' + str(qry),
+ headers=headers,
+ timeout=15,
+ useragent=self.opts['_useragent']
+ )
+
+ if res['code'] == "400":
+ self.sf.error("Bad request. " + qry + " is not a valid IP Address", False)
+ return None
+
+ if res['code'] == "404":
+ self.sf.error("Not found", false)
+ return None
+
+ if not res['code'] == "200":
+ self.sf.error("No information found from Phishstats for IP Address", false)
+ return None
+
+ try:
+ # Maltiverse returns \\n instead of \n in the response
+ data = str(res['content']).replace("\\n"," ")
+ return json.loads(data)
+ except:
+ self.sf.error("Ill formatted data received as JSON response", False)
+ return None
+
+ # Handle events sent to this module
+ def handleEvent(self, event):
+
+ eventName = event.eventType
+ srcModuleName = event.module
+ eventData = event.data
+
+ if self.errorState:
+ return None
+
+ self.sf.debug("Received event, " + eventName + ", from " + srcModuleName)
+
+ # Don't look up stuff twice
+ if eventData in self.results:
+ self.sf.debug("Skipping " + eventData + " as already mapped.")
+ return None
+ else:
+ self.results[eventData] = True
+
+ if eventName == 'NETBLOCK_OWNER':
+ if not self.opts['netblocklookup']:
+ return None
+ else:
+ if IPNetwork(eventData).prefixlen < self.opts['maxnetblock']:
+ self.sf.debug("Network size bigger than permitted: " +
+ str(IPNetwork(eventData).prefixlen) + " > " +
+ str(self.opts['maxnetblock']))
+ return None
+
+ if eventName == 'NETBLOCK_MEMBER':
+ if not self.opts['subnetlookup']:
+ return None
+ else:
+ if IPNetwork(eventData).prefixlen < self.opts['maxsubnet']:
+ self.sf.debug("Network size bigger than permitted: " +
+ str(IPNetwork(eventData).prefixlen) + " > " +
+ str(self.opts['maxsubnet']))
+ return None
+
+ qrylist = list()
+ if eventName.startswith("NETBLOCK_"):
+ for ipaddr in IPNetwork(eventData):
+ qrylist.append(str(ipaddr))
+ self.results[str(ipaddr)] = True
+ else:
+ # If user has enabled affiliate checking
+ if eventName == "AFFILIATE_IPADDR" and not self.opts['checkaffiliates']:
+ return None
+ qrylist.append(eventData)
+
+ for addr in qrylist:
+
+ if self.checkForStop():
+ return None
+
+ data = self.queryIPAddress(addr)
+
+ if data is None:
+ break
+
+ maliciousIP = data.get('ip_addr')
+
+ if maliciousIP is None:
+ continue
+
+ if addr != maliciousIP:
+ self.sf.error("Reported address doesn't match requested, skipping", False)
+ continue
+
+ blacklistedRecords = data.get('blacklist')
+
+ if blacklistedRecords is None or len(blacklistedRecords) == 0:
+ self.sf.error("No blacklist information found for IP", False)
+ continue
+
+ # Data is reported about the IP Address
+ if eventName.startswith("NETBLOCK_"):
+ ipEvt = SpiderFootEvent("IP_ADDRESS", addr, self.__name__, event)
+ self.notifyListeners(ipEvt)
+
+ evt = SpiderFootEvent("RAW_RIR_DATA", str(data), self.__name__, event)
+ self.notifyListeners(evt)
+
+ maliciousIPDesc = "Maltiverse [ " + str(maliciousIP) + " ]\n"
+
+ for blacklistedRecord in blacklistedRecords:
+ lastSeen = blacklistedRecord.get('last_seen')
+ lastSeenDate = datetime.strptime(str(lastSeen), "%Y-%m-%d %H:%M:%S")
+
+ today = datetime.now()
+ difference = (today - lastSeenDate).days
+
+ if difference > int(self.opts["age_limit_days"]):
+ self.sf.debug("Record found is older than age limit, skipping")
+ continue
+
+ maliciousIPDesc += " - DESCRIPTION : " + str(blacklistedRecord.get("description")) + "\n"
+
+ maliciousIPDescHash = self.sf.hashstring(maliciousIPDesc)
+
+ if maliciousIPDescHash in self.results:
+ continue
+
+ self.results[maliciousIPDescHash] = True
+
+ if eventName.startswith("NETBLOCK_"):
+ evt = SpiderFootEvent("MALICIOUS_IPADDR", maliciousIPDesc, self.__name__, ipEvt)
+ else:
+ evt = SpiderFootEvent("MALICIOUS_IPADDR", maliciousIPDesc, self.__name__, event)
+
+ self.notifyListeners(evt)
+
+ return None
+# End of sfp_maltiverse class