Skip to content

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

Add sfp_emailrep

Brendan Coles55df29d13171
diff --git a/modules/sfp_emailrep.py b/modules/sfp_emailrep.py
new file mode 100644
index 00000000..0c1dd2c3
--- /dev/null
+++ b/modules/sfp_emailrep.py
@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+# -------------------------------------------------------------------------------
+# Name: sfp_emailrep
+# Purpose: Searches EmailRep.io for email address reputation.
+#
+# Author: <bcoles[at]gmail[.]com>
+#
+# Created: 2019-08-07
+# Copyright: (c) bcoles 2019
+# Licence: GPL
+# -------------------------------------------------------------------------------
+
+import json
+import time
+from sflib import SpiderFoot, SpiderFootPlugin, SpiderFootEvent
+
+class sfp_emailrep(SpiderFootPlugin):
+ """EmailRep:Footprint,Investigate,Passive:Search Engines::Search EmailRep.io for email address reputation."""
+
+ opts = {
+ }
+
+ optdescs = {
+ }
+
+ results = None
+ errorState = False
+
+ def setup(self, sfc, userOpts=dict()):
+ self.sf = sfc
+ self.results = self.tempStorage()
+ self.errorState = False
+
+ for opt in userOpts.keys():
+ self.opts[opt] = userOpts[opt]
+
+ def watchedEvents(self):
+ return ['EMAILADDR']
+
+ def producedEvents(self):
+ return ['RAW_RIR_DATA', 'EMAILADDR_COMPROMISED', 'MALICIOUS_EMAILADDR']
+
+ # https://emailrep.io/docs/
+ def query(self, qry):
+ res = self.sf.fetchUrl('https://emailrep.io/' + qry,
+ useragent='curl', # cURL user-agent appears to be required
+ timeout=self.opts['_fetchtimeout'])
+
+ # Documentation does not indicate rate limit
+ time.sleep(1)
+
+ if res['content'] is None:
+ return None
+
+ if res['code'] == '400':
+ self.sf.error('API error: Bad request', False)
+ self.errorState = True
+ return None
+
+ if res['code'] == '429':
+ self.sf.error('API error: Too Many Requests', False)
+ self.errorState = True
+ return None
+
+ if res['code'] != '200':
+ self.sf.error('Unexpected reply from EmailRep.io: ' + res['code'], False)
+ self.errorState = True
+ return None
+
+ try:
+ data = json.loads(res['content'])
+ except BaseException as e:
+ self.sf.debug("Error processing JSON response: " + str(e))
+ return None
+
+ return data
+
+ def handleEvent(self, event):
+ eventName = event.eventType
+ srcModuleName = event.module
+ eventData = event.data
+
+ if eventData in self.results:
+ return None
+
+ self.results[eventData] = True
+
+ self.sf.debug("Received event, " + eventName + ", from " + srcModuleName)
+
+ res = self.query(eventData)
+
+ if res is None:
+ return None
+
+ evt = SpiderFootEvent('RAW_RIR_DATA', str(res), self.__name__, event)
+ self.notifyListeners(evt)
+
+ details = res.get('details')
+
+ if not details:
+ return None
+
+ credentials_leaked = details.get('credentials_leaked')
+ if credentials_leaked:
+ evt = SpiderFootEvent('EMAILADDR_COMPROMISED', eventData, self.__name__, event)
+ self.notifyListeners(evt)
+
+ malicious_activity = details.get('malicious_activity')
+ if malicious_activity:
+ evt = SpiderFootEvent('MALICIOUS_EMAILADDR', 'EmailRep [' + eventData + ']', self.__name__, event)
+ self.notifyListeners(evt)
+
+# End of sfp_emailrep class