Skip to content

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

sfdb: Add event attribute validation and error handling

Brendan Coles84326196edea
diff --git a/sfdb.py b/sfdb.py
index b92303c9..f375c9e7 100644
--- a/sfdb.py
+++ b/sfdb.py
@@ -1077,15 +1077,7 @@ class SpiderFootDb:
Args:
instanceId (str): scan instance ID
- sfEvent (SpiderFootEvent): A SpiderFootEvent object with the following variables:
- - eventType: the event, e.g. URL_FORM, RAW_DATA, etc.
- - generated: time the event occurred
- - confidence: how sure are we of this data's validity, 0-100
- - visibility: how 'visible' was this data, 0-100
- - risk: how much risk does this data represent, 0-100
- - module: module that generated the event
- - data: the actual data, i.e. a URL, port number, webpage content, etc.
- - sourceEventHash: hash of the event that triggered this event
+ sfEvent (SpiderFootEvent): event to be stored in the database
truncateSize (int): truncate size for event data
Returns:
@@ -1095,9 +1087,6 @@ class SpiderFootDb:
TypeError: arg type was invalid
ValueError: arg value was invalid
IOError: database I/O failed
-
- Todo:
- Review event attribute validation and error handling
"""
if not isinstance(instanceId, str):
@@ -1109,12 +1098,51 @@ class SpiderFootDb:
if not isinstance(sfEvent, SpiderFootEvent):
raise TypeError("sfEvent is %s; expected SpiderFootEvent()" % type(sfEvent))
+ if not sfEvent.generated:
+ raise ValueError("sfEvent.generated is empty")
+
+ if not isinstance(sfEvent.generated, str):
+ raise TypeError("generated is %s; expected str()" % type(instanceId))
+
+ if not isinstance(sfEvent.type, str):
+ raise TypeError("sfEvent.type is %s; expected str()" % type(sfEvent.data))
+
+ if not sfEvent.type:
+ raise ValueError("sfEvent.type is empty")
+
if not isinstance(sfEvent.data, str):
raise TypeError("sfEvent.data is %s; expected str()" % type(sfEvent.data))
if not sfEvent.data:
raise ValueError("sfEvent.data is empty")
+ if not isinstance(sfEvent.module, str):
+ raise TypeError("sfEvent.module is %s; expected str()" % type(sfEvent.module ))
+
+ if not sfEvent.module:
+ raise ValueError("sfEvent.module is empty")
+
+ if not isinstance(sfEvent.confidence, int):
+ raise TypeError("sfEvent.confidence is %s; expected int()" % type(sfEvent.confidence))
+
+ if not 0 <= sfEvent.confidence <= 100:
+ raise ValueError("sfEvent.confidence value is %s; expected 0 - 100" % sfEvent.confidence)
+
+ if not isinstance(sfEvent.visibility, int):
+ raise TypeError("sfEvent.visibility is %s; expected int()" % type(sfEvent.visibility))
+
+ if not 0 <= sfEvent.visibility <= 100:
+ raise ValueError("sfEvent.visibility value is %s; expected 0 - 100" % sfEvent.visibility)
+
+ if not isinstance(sfEvent.risk, int):
+ raise TypeError("sfEvent.risk is %s; expected int()" % type(sfEvent.risk))
+
+ if not 0 <= sfEvent.risk <= 100:
+ raise ValueError("sfEvent.risk value is %s; expected 0 - 100" % sfEvent.risk)
+
+ if not isinstance(sfEvent.sourceEvent, SpiderFootEvent):
+ raise TypeError("sfEvent.sourceEvent is %s; expected str()" % type(sfEvent.sourceEvent))
+
if not isinstance(sfEvent.sourceEventHash, str):
raise TypeError("sfEvent.sourceEventHash is %s; expected str()" % type(sfEvent.sourceEventHash))
diff --git a/sflib.py b/sflib.py
index 0f0d730f..c720c5b1 100644
--- a/sflib.py
+++ b/sflib.py
@@ -2494,7 +2494,7 @@ class SpiderFootPlugin(object):
Move all module state to use this, which then would enable a scan to be paused/resumed.
Note:
- Required for SpiderFoot HX compatability of modules.
+ Required for SpiderFoot HX compatibility of modules.
Returns:
dict: module temporary state data
@@ -2857,7 +2857,7 @@ class SpiderFootTarget(object):
class SpiderFootEvent(object):
- """SpiderFoot event."""
+ """SpiderFootEvent object representing identified data and associated meta data"""
generated = None
eventType = None
@@ -2868,8 +2868,8 @@ class SpiderFootEvent(object):
data = None
sourceEvent = None
sourceEventHash = None
- moduleDataSource = None
- actualSource = None
+ moduleDataSource = None # Required for SpiderFoot HX compatibility of modules
+ actualSource = None # Required for SpiderFoot HX compatibility of modules
__id = None
def __init__(self, eventType, data, module, sourceEvent,
@@ -2877,28 +2877,23 @@ class SpiderFootEvent(object):
"""Initialize SpiderFoot event.
Args:
- eventType (str): event type
- data (str): event data
+ eventType (str): event type, e.g. URL_FORM, RAW_DATA, etc.
+ data (str): event data, e.g. a URL, port number, webpage content, etc.
module (str): module from which the event originated
- sourceEvent (SpiderFootEvent): source event
- confidence (int): event confidence
- visibility (int): event visibility
- risk (int): event risk
+ sourceEvent (SpiderFootEvent): hash of the SpiderFootEvent event that triggered this event
+ confidence (int): how sure are we of this data's validity, 0-100
+ visibility (int): how 'visible' was this data, 0-100
+ risk (int): how much risk does this data represent, 0-100
Returns:
dict: event as dict
Raises:
TypeError: arg type was invalid
+ ValueError: arg value was invalid
"""
- self.eventType = eventType
self.generated = time.time()
- self.confidence = confidence
- self.visibility = visibility
- self.risk = risk
- self.module = module
- self.sourceEvent = sourceEvent
if not isinstance(data, str):
print("FATAL: Only string events are accepted, not '%s'." % type(data))
@@ -2908,8 +2903,51 @@ class SpiderFootEvent(object):
self.data = data
- # "ROOT" is a special "hash" reserved for elements with no
- # actual parent (e.g. the first page spidered.)
+ if not isinstance(eventType, str):
+ raise TypeError("eventType is %s; expected str()" % type(eventType))
+
+ if not eventType:
+ raise ValueError("eventType is empty")
+
+ self.eventType = eventType
+
+ if not isinstance(module, str):
+ raise TypeError("module is %s; expected str()" % type(module ))
+
+ if not module:
+ if eventType != "ROOT":
+ raise ValueError("module is empty")
+
+ self.module = module
+
+ if not isinstance(confidence, int):
+ raise TypeError("confidence is %s; expected int()" % type(confidence))
+
+ if not 0 <= confidence <= 100:
+ raise ValueError("confidence value is %s; expected 0 - 100" % confidence)
+
+ self.confidence = confidence
+
+ if not isinstance(visibility, int):
+ raise TypeError("visibility is %s; expected int()" % type(visibility))
+
+ if not 0 <= visibility <= 100:
+ raise ValueError("visibility value is %s; expected 0 - 100" % visibility)
+
+ self.visibility = visibility
+
+ if not isinstance(risk, int):
+ raise TypeError("risk is %s; expected int()" % type(risk))
+
+ if not 0 <= risk <= 100:
+ raise ValueError("risk value is %s; expected 0 - 100" % risk)
+
+ self.risk = risk
+
+ # "ROOT" is a special "hash" reserved for elements with no parent,
+ # such as targets provided via the web UI or CLI.
+ # return here, as there's no need to proceed with calculating
+ # a sourceEventHash or __id (apparently?).
if eventType == "ROOT":
self.sourceEventHash = "ROOT"
return
@@ -2920,6 +2958,8 @@ class SpiderFootEvent(object):
print("FATAL: Offending type: %s" % eventType)
raise TypeError("sourceEvent is %s; expected SpiderFootEvent()" % type(sourceEvent))
+ self.sourceEvent = sourceEvent
+
self.sourceEventHash = sourceEvent.getHash()
self.__id = self.eventType + str(self.generated) + self.module + \
str(random.SystemRandom().randint(0, 99999999))
diff --git a/test/unit/test_spiderfootevent.py b/test/unit/test_spiderfootevent.py
index 9b5d3bb0..629a1c75 100644
--- a/test/unit/test_spiderfootevent.py
+++ b/test/unit/test_spiderfootevent.py
@@ -23,14 +23,15 @@ class TestSpiderFootEvent(unittest.TestCase):
"""
Test __init__(self, eventType, data, module, sourceEvent, confidence=100, visibility=100, risk=0)
"""
+ event_type = 'ROOT'
event_data = ''
module = ''
source_event = ''
-
- event_type = 'ROOT'
source_event = SpiderFootEvent(event_type, event_data, module, source_event)
event_type = 'example non-root event type'
+ event_data = ''
+ module = 'example module'
evt = SpiderFootEvent(event_type, event_data, module, source_event)
self.assertIsInstance(evt, SpiderFootEvent)
@@ -53,7 +54,7 @@ class TestSpiderFootEvent(unittest.TestCase):
Test __init__(self, eventType, data, module, sourceEvent, confidence=100, visibility=100, risk=0)
"""
event_data = 'example event data'
- module = ''
+ module = 'example module'
event_type = 'example non-root event type'
invalid_types = [None, "", list(), dict()]
@@ -80,14 +81,15 @@ class TestSpiderFootEvent(unittest.TestCase):
"""
Test asDict(self)
"""
+ event_type = 'ROOT'
event_data = ''
module = ''
source_event = ''
-
- event_type = 'ROOT'
source_event = SpiderFootEvent(event_type, event_data, module, source_event)
event_type = 'example non-root event type'
+ event_data = ''
+ module = 'example_module'
evt = SpiderFootEvent(event_type, event_data, module, source_event)
evt_dict = evt.asDict()
@@ -113,7 +115,7 @@ class TestSpiderFootEvent(unittest.TestCase):
"""
event_type = 'not ROOT'
event_data = ''
- module = ''
+ module = 'example module'
source_event = SpiderFootEvent("ROOT", '', '', "ROOT")
evt = SpiderFootEvent(event_type, event_data, module, source_event)