def test_scanConfigSet_argument_instanceId_with_empty_value_should_raise_ValueError(self): """ Test scanConfigSet(self, id, optMap=dict()) """ sfdb = SpiderFootDb(self.default_options, False) with self.assertRaises(ValueError) as cm: sfdb.scanConfigSet("", dict())
def test_scanConfigSet_argument_optMap_of_invalid_type_should_raise_TypeError(self): """ Test scanConfigSet(self, id, optMap=dict()) """ sfdb = SpiderFootDb(self.default_options, False) instance_id = "example instance id" invalid_types = [None, ""] for invalid_type in invalid_types: with self.subTest(invalid_type=invalid_type): with self.assertRaises(TypeError) as cm: sfdb.scanConfigSet(instance_id, invalid_type)
def test_scan_config_set(self): """ Test scanConfigSet(self, id, optMap=dict()) """ sfdb = SpiderFootDb(self.default_options, False) invalid_types = [None, ""] for invalid_type in invalid_types: with self.subTest(invalid_type=invalid_type): with self.assertRaises(TypeError) as cm: sfdb.scanConfigSet("", invalid_type) with self.assertRaises(ValueError) as cm: sfdb.scanConfigSet("", dict())
def startScan(self): self.moduleInstances = dict() dbh = SpiderFootDb(self.config) self.sf.setDbh(dbh) aborted = False # Create a unique ID for this scan and create it in the back-end DB. self.config['__guid__'] = dbh.scanInstanceGenGUID(self.target) self.sf.setScanId(self.config['__guid__']) self.myId = self.config['__guid__'] dbh.scanInstanceCreate(self.config['__guid__'], self.name, self.target) dbh.scanInstanceSet(self.config['__guid__'], time.time() * 1000, None, 'STARTING') self.status = "STARTING" # Save the config current set for this scan self.config['_modulesenabled'] = self.moduleList dbh.scanConfigSet(self.config['__guid__'], self.sf.configSerialize(self.config)) self.sf.status("Scan [" + self.config['__guid__'] + "] initiated.") # moduleList = list of modules the user wants to run try: for modName in self.moduleList: if modName == '': continue module = __import__('modules.' + modName, globals(), locals(), [modName]) mod = getattr(module, modName)() mod.__name__ = modName # A bit hacky: we pass the database object as part of the config. This # object should only be used by the internal SpiderFoot modules writing # to the database, which at present is only sfp_stor_db. # Individual modules cannot create their own SpiderFootDb instance or # we'll get database locking issues, so it all goes through this. self.config['__sfdb__'] = dbh # Set up the module # Configuration is a combined global config with module-specific options #modConfig = deepcopy(self.config) modConfig = self.config['__modules__'][modName]['opts'] for opt in self.config.keys(): modConfig[opt] = self.config[opt] mod.clearListeners( ) # clear any listener relationships from the past mod.setup(self.sf, self.target, modConfig) self.moduleInstances[modName] = mod self.sf.status(modName + " module loaded.") # Register listener modules and then start all modules sequentially for module in self.moduleInstances.values(): for listenerModule in self.moduleInstances.values(): # Careful not to register twice or you will get duplicate events if listenerModule in module._listenerModules: continue # Note the absence of a check for whether a module can register # to itself. That is intentional because some modules will # act on their own notifications (e.g. sfp_dns)! if listenerModule.watchedEvents() != None: module.registerListener(listenerModule) dbh.scanInstanceSet(self.config['__guid__'], status='RUNNING') self.status = "RUNNING" # Create the "ROOT" event which un-triggered modules will link events to rootEvent = SpiderFootEvent("INITIAL_TARGET", self.target, "SpiderFoot UI") dbh.scanEventStore(self.config['__guid__'], rootEvent) # Start the modules sequentially. for module in self.moduleInstances.values(): # Check in case the user requested to stop the scan between modules initializing if module.checkForStop(): dbh.scanInstanceSet(self.config['__guid__'], status='ABORTING') self.status = "ABORTING" aborted = True break # Many modules' start() method will return None, as most will rely on # notifications during the scan from other modules. module.start() # Check if any of the modules ended due to being stopped for module in self.moduleInstances.values(): if module.checkForStop(): aborted = True if aborted: self.sf.status("Scan [" + self.config['__guid__'] + "] aborted.") dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'ABORTED') self.status = "ABORTED" else: self.sf.status("Scan [" + self.config['__guid__'] + "] completed.") dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'FINISHED') self.status = "FINISHED" except Exception as e: exc_type, exc_value, exc_traceback = sys.exc_info() self.sf.error("Unhandled exception encountered during scan. " + \ "Please report this as a bug: " + \ repr(traceback.format_exception(exc_type, exc_value, exc_traceback)), False) self.sf.status("Scan [" + self.config['__guid__'] + "] failed: " + str(e)) dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'ERROR-FAILED') self.status = "ERROR-FAILED" self.moduleInstances = None dbh.close() self.sf.setDbh(None) self.sf.setScanId(None)
class SpiderFootScanner(): # Temporary storage temp = None def __init__(self, scanName, scanTarget, targetType, scanId, moduleList, globalOpts, moduleOpts): """Initialize SpiderFootScanner object and immediately start a scan of the specified target. Args: scanName (str): name of the scan scanTarget (str): scan target targetType (str): scan target type scanId (str): scan identifier moduleList (list): list of modules to run globalOpts (dict): scan options moduleOpts (dict): unused Returns: None """ if not isinstance(scanName, str): raise TypeError("scanName is %s; expected str()" % type(scanName)) if not isinstance(scanTarget, str): raise TypeError("scanTarget is %s; expected str()" % type(scanTarget)) if not isinstance(scanId, str): raise TypeError("scanId is %s; expected str()" % type(scanId)) if not isinstance(moduleList, list): raise TypeError("moduleList is %s; expected list()" % type(moduleList)) if not isinstance(globalOpts, dict): raise TypeError("globalOpts is %s; expected dict()" % type(globalOpts)) self.temp = dict() self.temp['config'] = deepcopy(globalOpts) self.temp['targetValue'] = scanTarget self.temp['targetType'] = targetType self.temp['moduleList'] = moduleList self.temp['scanName'] = scanName self.temp['scanId'] = scanId self.startScan() def setStatus(self, status, started=None, ended=None): """Set the status of the currently running scan (if any). Args: status (str): scan status ("RUNNING", "STARTING", "STARTED", "ABORT-REQUESTED", "ABORTED", "FINISHED", "ERROR-FAILED") started (str): TBD ended (str): TBD Returns: None """ #if self is None: # print(("Internal Error: Status set attempted before " + \ # "SpiderFootScanner was ready.")) # exit(-1) self.status = status self.dbh.scanInstanceSet(self.scanId, started, ended, status) return None def run(self): """Start running a scan.""" self.startScan() def getId(self): if hasattr(self, 'scanId'): return self.scanId return None def startScan(self): """Start running a scan.""" self.moduleInstances = dict() self.sf = SpiderFoot(self.temp['config']) self.config = deepcopy(self.temp['config']) self.dbh = SpiderFootDb(self.temp['config']) self.targetValue = self.temp['targetValue'] self.targetType = self.temp['targetType'] self.moduleList = self.temp['moduleList'] self.modconfig = dict() self.scanName = self.temp['scanName'] self.scanId = self.temp['scanId'] aborted = False self.sf.setDbh(self.dbh) # Create a unique ID for this scan and create it in the back-end DB. self.sf.setGUID(self.scanId) self.dbh.scanInstanceCreate(self.scanId, self.scanName, self.targetValue) self.setStatus("STARTING", time.time() * 1000, None) # Create our target try: target = SpiderFootTarget(self.targetValue, self.targetType) except BaseException as e: self.sf.status("Scan [%s] failed: %s" % (self.scanId, e)) self.setStatus("ERROR-FAILED", None, time.time() * 1000) return None # Save the config current set for this scan self.config['_modulesenabled'] = self.moduleList self.dbh.scanConfigSet(self.scanId, self.sf.configSerialize(deepcopy(self.config))) self.sf.status("Scan [" + self.scanId + "] initiated.") # moduleList = list of modules the user wants to run try: # Process global options that point to other places for data # If a SOCKS server was specified, set it up if self.config['_socks1type'] != '': socksDns = self.config['_socks6dns'] socksAddr = self.config['_socks2addr'] socksPort = int(self.config['_socks3port']) socksUsername = self.config['_socks4user'] or '' socksPassword = self.config['_socks5pwd'] or '' creds = "" if socksUsername and socksPassword: creds = socksUsername + ":" + socksPassword + "@" proxy = creds + socksAddr + ":" + str(socksPort) if self.config['_socks1type'] == '4': proxy = 'socks4://' + proxy elif self.config['_socks1type'] == '5': proxy = 'socks5://' + proxy elif self.config['_socks1type'] == 'HTTP': proxy = 'http://' + proxy elif self.config['_socks1type'] == 'TOR': proxy = 'socks5h://' + proxy self.sf.debug("SOCKS: " + socksAddr + ":" + str(socksPort) + \ "(" + socksUsername + ":" + socksPassword + ")") self.sf.updateSocket(proxy) else: self.sf.revertSocket() # Override the default DNS server if self.config['_dnsserver'] != "": res = dns.resolver.Resolver() res.nameservers = [self.config['_dnsserver']] dns.resolver.override_system_resolver(res) else: dns.resolver.restore_system_resolver() # Set the user agent self.config['_useragent'] = self.sf.optValueToData( self.config['_useragent']) # Get internet TLDs tlddata = self.sf.cacheGet("internet_tlds", self.config['_internettlds_cache']) # If it wasn't loadable from cache, load it from scratch if tlddata is None: self.config['_internettlds'] = self.sf.optValueToData( self.config['_internettlds']) self.sf.cachePut("internet_tlds", self.config['_internettlds']) else: self.config["_internettlds"] = tlddata.splitlines() for modName in self.moduleList: if modName == '': continue try: module = __import__('modules.' + modName, globals(), locals(), [modName]) except ImportError: self.sf.error("Failed to load module: " + modName, False) continue mod = getattr(module, modName)() mod.__name__ = modName # Module may have been renamed or removed if modName not in self.config['__modules__']: continue # Set up the module # Configuration is a combined global config with module-specific options self.modconfig[modName] = deepcopy(self.config['__modules__'][modName]['opts']) for opt in list(self.config.keys()): self.modconfig[modName][opt] = deepcopy(self.config[opt]) mod.clearListeners() # clear any listener relationships from the past mod.setup(self.sf, self.modconfig[modName]) mod.setDbh(self.dbh) mod.setScanId(self.scanId) # Give modules a chance to 'enrich' the original target with # aliases of that target. newTarget = mod.enrichTarget(target) if newTarget is not None: target = newTarget self.moduleInstances[modName] = mod # Override the module's local socket module # to be the SOCKS one. if self.config['_socks1type'] != '': mod._updateSocket(socket) # Set up event output filters if requested if self.config['__outputfilter']: mod.setOutputFilter(self.config['__outputfilter']) self.sf.status(modName + " module loaded.") # Register listener modules and then start all modules sequentially for module in list(self.moduleInstances.values()): # Register the target with the module module.setTarget(target) for listenerModule in list(self.moduleInstances.values()): # Careful not to register twice or you will get duplicate events if listenerModule in module._listenerModules: continue # Note the absence of a check for whether a module can register # to itself. That is intentional because some modules will # act on their own notifications (e.g. sfp_dns)! if listenerModule.watchedEvents() is not None: module.registerListener(listenerModule) # Now we are ready to roll.. self.setStatus("RUNNING") # Create a pseudo module for the root event to originate from psMod = SpiderFootPlugin() psMod.__name__ = "SpiderFoot UI" psMod.setTarget(target) psMod.setDbh(self.dbh) psMod.clearListeners() for mod in list(self.moduleInstances.values()): if mod.watchedEvents() is not None: psMod.registerListener(mod) # Create the "ROOT" event which un-triggered modules will link events to rootEvent = SpiderFootEvent("ROOT", self.targetValue, "", None) psMod.notifyListeners(rootEvent) firstEvent = SpiderFootEvent(self.targetType, self.targetValue, "SpiderFoot UI", rootEvent) psMod.notifyListeners(firstEvent) # Special case.. check if an INTERNET_NAME is also a domain if self.targetType == 'INTERNET_NAME': if self.sf.isDomain(self.targetValue, self.config['_internettlds']): firstEvent = SpiderFootEvent('DOMAIN_NAME', self.targetValue, "SpiderFoot UI", rootEvent) psMod.notifyListeners(firstEvent) # If in interactive mode, loop through this shared global variable # waiting for inputs, and process them until my status is set to # FINISHED. # Check in case the user requested to stop the scan between modules # initializing for module in list(self.moduleInstances.values()): if module.checkForStop(): self.setStatus('ABORTING') aborted = True break if aborted: self.sf.status("Scan [" + self.scanId + "] aborted.") self.setStatus("ABORTED", None, time.time() * 1000) else: self.sf.status("Scan [" + self.scanId + "] completed.") self.setStatus("FINISHED", None, time.time() * 1000) except BaseException as e: exc_type, exc_value, exc_traceback = sys.exc_info() self.sf.error("Unhandled exception (" + e.__class__.__name__ + ") " + \ "encountered during scan. Please report this as a bug: " + \ repr(traceback.format_exception(exc_type, exc_value, exc_traceback)), False) self.sf.status("Scan [" + self.scanId + "] failed: " + str(e)) self.setStatus("ERROR-FAILED", None, time.time() * 1000) self.dbh.close()
def startScan(self): self.moduleInstances = dict() dbh = SpiderFootDb(self.config) self.sf.setDbh(dbh) aborted = False # Create a unique ID for this scan and create it in the back-end DB. self.config['__guid__'] = dbh.scanInstanceGenGUID(self.target) self.sf.setScanId(self.config['__guid__']) self.myId = self.config['__guid__'] dbh.scanInstanceCreate(self.config['__guid__'], self.name, self.target) dbh.scanInstanceSet(self.config['__guid__'], time.time() * 1000, None, 'STARTING') self.status = "STARTING" # Save the config current set for this scan self.config['_modulesenabled'] = self.moduleList dbh.scanConfigSet(self.config['__guid__'], self.sf.configSerialize(self.config)) self.sf.status("Scan [" + self.config['__guid__'] + "] initiated.") # moduleList = list of modules the user wants to run try: # Process global options that point to other places for data # If a SOCKS server was specified, set it up if self.config['_socks1type'] != '': socksType = socks.PROXY_TYPE_SOCKS4 socksDns = self.config['_socks6dns'] socksAddr = self.config['_socks2addr'] socksPort = int(self.config['_socks3port']) socksUsername = '' socksPassword = '' if self.config['_socks1type'] == '4': socksType = socks.PROXY_TYPE_SOCKS4 if self.config['_socks1type'] == '5': socksType = socks.PROXY_TYPE_SOCKS5 socksUsername = self.config['_socks4user'] socksPassword = self.config['_socks5pwd'] if self.config['_socks1type'] == 'HTTP': socksType = socks.PROXY_TYPE_HTTP self.sf.debug("SOCKS: " + socksAddr + ":" + str(socksPort) + \ "(" + socksUsername + ":" + socksPassword + ")") socks.setdefaultproxy(socksType, socksAddr, socksPort, socksDns, socksUsername, socksPassword) # Override the default socket and getaddrinfo calls with the # SOCKS ones socket.socket = socks.socksocket socket.create_connection = socks.create_connection socket.getaddrinfo = socks.getaddrinfo self.sf.updateSocket(socket) # Override the default DNS server if self.config['_dnsserver'] != "": res = dns.resolver.Resolver() res.nameservers = [ self.config['_dnsserver'] ] dns.resolver.override_system_resolver(res) else: dns.resolver.restore_system_resolver() # Set the user agent self.config['_useragent'] = self.sf.optValueToData(self.config['_useragent']) # Get internet TLDs tlddata = self.sf.cacheGet("internet_tlds", self.config['_internettlds_cache']) # If it wasn't loadable from cache, load it from scratch if tlddata == None: self.config['_internettlds'] = self.sf.optValueToData(self.config['_internettlds']) self.sf.cachePut("internet_tlds", self.config['_internettlds']) else: self.config["_internettlds"] = tlddata.splitlines() for modName in self.moduleList: if modName == '': continue module = __import__('modules.' + modName, globals(), locals(), [modName]) mod = getattr(module, modName)() mod.__name__ = modName # A bit hacky: we pass the database object as part of the config. This # object should only be used by the internal SpiderFoot modules writing # to the database, which at present is only sfp__stor_db. # Individual modules cannot create their own SpiderFootDb instance or # we'll get database locking issues, so it all goes through this. self.config['__sfdb__'] = dbh # Set up the module # Configuration is a combined global config with module-specific options #modConfig = deepcopy(self.config) modConfig = self.config['__modules__'][modName]['opts'] for opt in self.config.keys(): modConfig[opt] = self.config[opt] mod.clearListeners() # clear any listener relationships from the past mod.setup(self.sf, self.target, modConfig) self.moduleInstances[modName] = mod # Override the module's local socket module # to be the SOCKS one. if self.config['_socks1type'] != '': mod._updateSocket(socket) self.sf.status(modName + " module loaded.") # Register listener modules and then start all modules sequentially for module in self.moduleInstances.values(): for listenerModule in self.moduleInstances.values(): # Careful not to register twice or you will get duplicate events if listenerModule in module._listenerModules: continue # Note the absence of a check for whether a module can register # to itself. That is intentional because some modules will # act on their own notifications (e.g. sfp_dns)! if listenerModule.watchedEvents() != None: module.registerListener(listenerModule) dbh.scanInstanceSet(self.config['__guid__'], status='RUNNING') self.status = "RUNNING" # Create the "ROOT" event which un-triggered modules will link events to rootEvent = SpiderFootEvent("INITIAL_TARGET", self.target, "SpiderFoot UI") dbh.scanEventStore(self.config['__guid__'], rootEvent) # Start the modules sequentially. for module in self.moduleInstances.values(): # Check in case the user requested to stop the scan between modules initializing if module.checkForStop(): dbh.scanInstanceSet(self.config['__guid__'], status='ABORTING') self.status = "ABORTING" aborted = True break # Many modules' start() method will return None, as most will rely on # notifications during the scan from other modules. module.start() # Check if any of the modules ended due to being stopped for module in self.moduleInstances.values(): if module.checkForStop(): aborted = True if aborted: self.sf.status("Scan [" + self.config['__guid__'] + "] aborted.") dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'ABORTED') self.status = "ABORTED" else: self.sf.status("Scan [" + self.config['__guid__'] + "] completed.") dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'FINISHED') self.status = "FINISHED" except BaseException as e: exc_type, exc_value, exc_traceback = sys.exc_info() self.sf.error("Unhandled exception (" + e.__class__.__name__ + ") " + \ "encountered during scan. Please report this as a bug: " + \ repr(traceback.format_exception(exc_type, exc_value, exc_traceback)), False) self.sf.status("Scan [" + self.config['__guid__'] + "] failed: " + str(e)) dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'ERROR-FAILED') self.status = "ERROR-FAILED" self.moduleInstances = None dbh.close() self.sf.setDbh(None) self.sf.setScanId(None)
class SpiderFootScanner(): """SpiderFootScanner object. Attributes: scanId (str): unique ID of the scan status (str): status of the scan """ __scanId = None __status = None __config = None __sf = None __dbh = None __targetValue = None __targetType = None __moduleList = list() __target = None __moduleInstances = dict() __modconfig = dict() __scanName = None def __init__(self, scanName, scanId, targetValue, targetType, moduleList, globalOpts, start=True): """Initialize SpiderFootScanner object. Args: scanName (str): name of the scan scanId (str): unique ID of the scan targetValue (str): scan target targetType (str): scan target type moduleList (list): list of modules to run globalOpts (dict): scan options start (bool): start the scan immediately Raises: TypeError: arg type was invalid ValueError: arg value was invalid Todo: Eventually change this to be able to control multiple scan instances """ if not isinstance(globalOpts, dict): raise TypeError( f"globalOpts is {type(globalOpts)}; expected dict()") if not globalOpts: raise ValueError("globalOpts is empty") self.__config = deepcopy(globalOpts) self.__dbh = SpiderFootDb(self.__config) if not isinstance(scanName, str): raise TypeError(f"scanName is {type(scanName)}; expected str()") if not scanName: raise ValueError("scanName value is blank") self.__scanName = scanName if not isinstance(scanId, str): raise TypeError(f"scanId is {type(scanId)}; expected str()") if not scanId: raise ValueError("scanId value is blank") if not isinstance(targetValue, str): raise TypeError( f"targetValue is {type(targetValue)}; expected str()") if not targetValue: raise ValueError("targetValue value is blank") self.__targetValue = targetValue if not isinstance(targetType, str): raise TypeError( f"targetType is {type(targetType)}; expected str()") if not targetType: raise ValueError("targetType value is blank") self.__targetType = targetType if not isinstance(moduleList, list): raise TypeError( f"moduleList is {type(moduleList)}; expected list()") if not moduleList: raise ValueError("moduleList is empty") self.__moduleList = moduleList self.__sf = SpiderFoot(self.__config) self.__sf.dbh = self.__dbh # Create a unique ID for this scan in the back-end DB. if not isinstance(scanId, str): raise TypeError(f"scanId is {type(scanId)}; expected str()") if scanId: self.__scanId = scanId else: self.__scanId = self.__sf.genScanInstanceId() self.__sf.scanId = self.__scanId self.__dbh.scanInstanceCreate(self.__scanId, self.__scanName, self.__targetValue) # Create our target try: self.__target = SpiderFootTarget(self.__targetValue, self.__targetType) except (TypeError, ValueError) as e: self.__sf.status(f"Scan [{self.__scanId}] failed: {e}") self.__setStatus("ERROR-FAILED", None, time.time() * 1000) raise ValueError(f"Invalid target: {e}") # Save the config current set for this scan self.__config['_modulesenabled'] = self.__moduleList self.__dbh.scanConfigSet( self.__scanId, self.__sf.configSerialize(deepcopy(self.__config))) # Process global options that point to other places for data # If a SOCKS server was specified, set it up if self.__config['_socks1type']: # TODO: review why socksDns is unused # socksDns = self.__config['_socks6dns'] socksAddr = self.__config['_socks2addr'] socksPort = int(self.__config['_socks3port']) socksUsername = self.__config['_socks4user'] or '' socksPassword = self.__config['_socks5pwd'] or '' proxy = f"{socksAddr}:{socksPort}" if socksUsername or socksPassword: proxy = "%s:%s@%s" % (socksUsername, socksPassword, proxy) if self.__config['_socks1type'] == '4': proxy = 'socks4://' + proxy elif self.__config['_socks1type'] == '5': proxy = 'socks5://' + proxy elif self.__config['_socks1type'] == 'HTTP': proxy = 'http://' + proxy elif self.__config['_socks1type'] == 'TOR': proxy = 'socks5h://' + proxy else: raise ValueError( f"Invalid SOCKS proxy type: {self.__config['_socks1ttype']}" ) self.__sf.debug( f"SOCKS: {socksAddr}:{socksPort} ({socksUsername}:{socksPassword})" ) self.__sf.socksProxy = proxy else: self.__sf.socksProxy = None # Override the default DNS server if self.__config['_dnsserver']: res = dns.resolver.Resolver() res.nameservers = [self.__config['_dnsserver']] dns.resolver.override_system_resolver(res) else: dns.resolver.restore_system_resolver() # Set the user agent self.__config['_useragent'] = self.__sf.optValueToData( self.__config['_useragent']) # Get internet TLDs tlddata = self.__sf.cacheGet("internet_tlds", self.__config['_internettlds_cache']) # If it wasn't loadable from cache, load it from scratch if tlddata is None: self.__config['_internettlds'] = self.__sf.optValueToData( self.__config['_internettlds']) self.__sf.cachePut("internet_tlds", self.__config['_internettlds']) else: self.__config["_internettlds"] = tlddata.splitlines() self.__setStatus("INITIALIZING", time.time() * 1000, None) if start: self.__startScan() @property def scanId(self): """Unique identifier for this scan""" return self.__scanId @property def status(self): """Status of this scan""" return self.__status def __setStatus(self, status, started=None, ended=None): """Set the status of the currently running scan (if any). Args: status (str): scan status started (float): timestamp at start of scan ended (float): timestamp at end of scan Returns: None Raises: TypeError: arg type was invalid ValueError: arg value was invalid """ if not isinstance(status, str): raise TypeError(f"status is {type(status)}; expected str()") if status not in [ "INITIALIZING", "STARTING", "STARTED", "RUNNING", "ABORT-REQUESTED", "ABORTED", "ABORTING", "FINISHED", "ERROR-FAILED" ]: raise ValueError(f"Invalid scan status {status}") self.__status = status self.__dbh.scanInstanceSet(self.__scanId, started, ended, status) def __startScan(self): """Start running a scan.""" aborted = False self.__setStatus("STARTING", time.time() * 1000, None) self.__sf.status(f"Scan [{self.__scanId}] initiated.") try: # moduleList = list of modules the user wants to run for modName in self.__moduleList: if modName == '': continue try: module = __import__('modules.' + modName, globals(), locals(), [modName]) except ImportError: self.__sf.error("Failed to load module: " + modName, False) continue mod = getattr(module, modName)() mod.__name__ = modName # Module may have been renamed or removed if modName not in self.__config['__modules__']: continue # Set up the module # Configuration is a combined global config with module-specific options self.__modconfig[modName] = deepcopy( self.__config['__modules__'][modName]['opts']) for opt in list(self.__config.keys()): self.__modconfig[modName][opt] = deepcopy( self.__config[opt]) mod.clearListeners( ) # clear any listener relationships from the past mod.setup(self.__sf, self.__modconfig[modName]) mod.setDbh(self.__dbh) mod.setScanId(self.__scanId) # Give modules a chance to 'enrich' the original target with # aliases of that target. newTarget = mod.enrichTarget(self.__target) if newTarget is not None: self.__target = newTarget self.__moduleInstances[modName] = mod # Override the module's local socket module # to be the SOCKS one. if self.__config['_socks1type'] != '': mod._updateSocket(socket) # Set up event output filters if requested if self.__config['__outputfilter']: mod.setOutputFilter(self.__config['__outputfilter']) self.__sf.status(modName + " module loaded.") # Register listener modules and then start all modules sequentially for module in list(self.__moduleInstances.values()): # Register the target with the module module.setTarget(self.__target) for listenerModule in list(self.__moduleInstances.values()): # Careful not to register twice or you will get duplicate events if listenerModule in module._listenerModules: continue # Note the absence of a check for whether a module can register # to itself. That is intentional because some modules will # act on their own notifications (e.g. sfp_dns)! if listenerModule.watchedEvents() is not None: module.registerListener(listenerModule) # Now we are ready to roll.. self.__setStatus("RUNNING") # Create a pseudo module for the root event to originate from psMod = SpiderFootPlugin() psMod.__name__ = "SpiderFoot UI" psMod.setTarget(self.__target) psMod.setDbh(self.__dbh) psMod.clearListeners() for mod in list(self.__moduleInstances.values()): if mod.watchedEvents() is not None: psMod.registerListener(mod) # Create the "ROOT" event which un-triggered modules will link events to rootEvent = SpiderFootEvent("ROOT", self.__targetValue, "", None) psMod.notifyListeners(rootEvent) firstEvent = SpiderFootEvent(self.__targetType, self.__targetValue, "SpiderFoot UI", rootEvent) psMod.notifyListeners(firstEvent) # Special case.. check if an INTERNET_NAME is also a domain if self.__targetType == 'INTERNET_NAME': if self.__sf.isDomain(self.__targetValue, self.__config['_internettlds']): firstEvent = SpiderFootEvent('DOMAIN_NAME', self.__targetValue, "SpiderFoot UI", rootEvent) psMod.notifyListeners(firstEvent) # If in interactive mode, loop through this shared global variable # waiting for inputs, and process them until my status is set to # FINISHED. # Check in case the user requested to stop the scan between modules # initializing for module in list(self.__moduleInstances.values()): if module.checkForStop(): self.__setStatus('ABORTING') aborted = True break if aborted: self.__sf.status(f"Scan [{self.__scanId}] aborted.") self.__setStatus("ABORTED", None, time.time() * 1000) else: self.__sf.status(f"Scan [{self.__scanId}] completed.") self.__setStatus("FINISHED", None, time.time() * 1000) except BaseException as e: exc_type, exc_value, exc_traceback = sys.exc_info() self.__sf.error( f"Unhandled exception ({e.__class__.__name__}) encountered during scan." + "Please report this as a bug: " + repr( traceback.format_exception(exc_type, exc_value, exc_traceback)), False) self.__sf.status(f"Scan [{self.__scanId}] failed: {e}") self.__setStatus("ERROR-FAILED", None, time.time() * 1000) self.__dbh.close()
def startScan(self): self.moduleInstances = dict() dbh = SpiderFootDb(self.config) self.sf.setDbh(dbh) aborted = False # Create a unique ID for this scan and create it in the back-end DB. self.config['__guid__'] = dbh.scanInstanceGenGUID(self.target) self.sf.setScanId(self.config['__guid__']) self.myId = self.config['__guid__'] dbh.scanInstanceCreate(self.config['__guid__'], self.name, self.target) dbh.scanInstanceSet(self.config['__guid__'], time.time() * 1000, None, 'STARTING') self.status = "STARTING" # Save the config current set for this scan self.config['_modulesenabled'] = self.moduleList dbh.scanConfigSet(self.config['__guid__'], self.sf.configSerialize(self.config)) self.sf.status("Scan [" + self.config['__guid__'] + "] initiated.") # moduleList = list of modules the user wants to run try: for modName in self.moduleList: if modName == '': continue module = __import__('modules.' + modName, globals(), locals(), [modName]) mod = getattr(module, modName)() mod.__name__ = modName # A bit hacky: we pass the database object as part of the config. This # object should only be used by the internal SpiderFoot modules writing # to the database, which at present is only sfp__stor_db. # Individual modules cannot create their own SpiderFootDb instance or # we'll get database locking issues, so it all goes through this. self.config['__sfdb__'] = dbh # Set up the module # Configuration is a combined global config with module-specific options #modConfig = deepcopy(self.config) modConfig = self.config['__modules__'][modName]['opts'] for opt in self.config.keys(): modConfig[opt] = self.config[opt] mod.clearListeners() # clear any listener relationships from the past mod.setup(self.sf, self.target, modConfig) self.moduleInstances[modName] = mod self.sf.status(modName + " module loaded.") # Register listener modules and then start all modules sequentially for module in self.moduleInstances.values(): for listenerModule in self.moduleInstances.values(): # Careful not to register twice or you will get duplicate events if listenerModule in module._listenerModules: continue # Note the absence of a check for whether a module can register # to itself. That is intentional because some modules will # act on their own notifications (e.g. sfp_dns)! if listenerModule.watchedEvents() != None: module.registerListener(listenerModule) dbh.scanInstanceSet(self.config['__guid__'], status='RUNNING') self.status = "RUNNING" # Create the "ROOT" event which un-triggered modules will link events to rootEvent = SpiderFootEvent("INITIAL_TARGET", self.target, "SpiderFoot UI") dbh.scanEventStore(self.config['__guid__'], rootEvent) # Start the modules sequentially. for module in self.moduleInstances.values(): # Check in case the user requested to stop the scan between modules initializing if module.checkForStop(): dbh.scanInstanceSet(self.config['__guid__'], status='ABORTING') self.status = "ABORTING" aborted = True break # Many modules' start() method will return None, as most will rely on # notifications during the scan from other modules. module.start() # Check if any of the modules ended due to being stopped for module in self.moduleInstances.values(): if module.checkForStop(): aborted = True if aborted: self.sf.status("Scan [" + self.config['__guid__'] + "] aborted.") dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'ABORTED') self.status = "ABORTED" else: self.sf.status("Scan [" + self.config['__guid__'] + "] completed.") dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'FINISHED') self.status = "FINISHED" except Exception as e: exc_type, exc_value, exc_traceback = sys.exc_info() self.sf.error("Unhandled exception (" + e.__class__.__name__ + ") " + \ "encountered during scan. Please report this as a bug: " + \ repr(traceback.format_exception(exc_type, exc_value, exc_traceback)), False) self.sf.status("Scan [" + self.config['__guid__'] + "] failed: " + str(e)) dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'ERROR-FAILED') self.status = "ERROR-FAILED" self.moduleInstances = None dbh.close() self.sf.setDbh(None) self.sf.setScanId(None)
def startScan(self): self.moduleInstances = dict() dbh = SpiderFootDb(self.config) self.sf.setDbh(dbh) aborted = False # Create a unique ID for this scan and create it in the back-end DB. self.config['__guid__'] = dbh.scanInstanceGenGUID(self.target) self.sf.setScanId(self.config['__guid__']) self.myId = self.config['__guid__'] dbh.scanInstanceCreate(self.config['__guid__'], self.name, self.target) dbh.scanInstanceSet(self.config['__guid__'], time.time() * 1000, None, 'STARTING') self.status = "STARTING" # Save the config current set for this scan self.config['_modulesenabled'] = self.moduleList dbh.scanConfigSet(self.config['__guid__'], self.sf.configSerialize(self.config)) self.sf.status("Scan [" + self.config['__guid__'] + "] initiated.") # moduleList = list of modules the user wants to run try: # Process global options that point to other places for data # If a SOCKS server was specified, set it up if self.config['_socks1type'] != '': socksType = socks.PROXY_TYPE_SOCKS4 socksDns = self.config['_socks6dns'] socksAddr = self.config['_socks2addr'] socksPort = int(self.config['_socks3port']) socksUsername = '' socksPassword = '' if self.config['_socks1type'] == '4': socksType = socks.PROXY_TYPE_SOCKS4 if self.config['_socks1type'] == '5': socksType = socks.PROXY_TYPE_SOCKS5 socksUsername = self.config['_socks4user'] socksPassword = self.config['_socks5pwd'] if self.config['_socks1type'] == 'HTTP': socksType = socks.PROXY_TYPE_HTTP self.sf.debug("SOCKS: " + socksAddr + ":" + str(socksPort) + \ "(" + socksUsername + ":" + socksPassword + ")") socks.setdefaultproxy(socksType, socksAddr, socksPort, socksDns, socksUsername, socksPassword) # Override the default socket and getaddrinfo calls with the # SOCKS ones socket.socket = socks.socksocket socket.create_connection = socks.create_connection socket.getaddrinfo = socks.getaddrinfo self.sf.updateSocket(socket) # Override the default DNS server if self.config['_dnsserver'] != "": res = dns.resolver.Resolver() res.nameservers = [self.config['_dnsserver']] dns.resolver.override_system_resolver(res) else: dns.resolver.restore_system_resolver() # Set the user agent self.config['_useragent'] = self.sf.optValueToData( self.config['_useragent']) # Get internet TLDs tlddata = self.sf.cacheGet("internet_tlds", self.config['_internettlds_cache']) # If it wasn't loadable from cache, load it from scratch if tlddata == None: self.config['_internettlds'] = self.sf.optValueToData( self.config['_internettlds']) self.sf.cachePut("internet_tlds", self.config['_internettlds']) else: self.config["_internettlds"] = tlddata.splitlines() for modName in self.moduleList: if modName == '': continue module = __import__('modules.' + modName, globals(), locals(), [modName]) mod = getattr(module, modName)() mod.__name__ = modName # A bit hacky: we pass the database object as part of the config. This # object should only be used by the internal SpiderFoot modules writing # to the database, which at present is only sfp__stor_db. # Individual modules cannot create their own SpiderFootDb instance or # we'll get database locking issues, so it all goes through this. self.config['__sfdb__'] = dbh # Set up the module # Configuration is a combined global config with module-specific options #modConfig = deepcopy(self.config) modConfig = self.config['__modules__'][modName]['opts'] for opt in self.config.keys(): modConfig[opt] = self.config[opt] mod.clearListeners( ) # clear any listener relationships from the past mod.setup(self.sf, self.target, modConfig) self.moduleInstances[modName] = mod # Override the module's local socket module # to be the SOCKS one. if self.config['_socks1type'] != '': mod._updateSocket(socket) self.sf.status(modName + " module loaded.") # Register listener modules and then start all modules sequentially for module in self.moduleInstances.values(): for listenerModule in self.moduleInstances.values(): # Careful not to register twice or you will get duplicate events if listenerModule in module._listenerModules: continue # Note the absence of a check for whether a module can register # to itself. That is intentional because some modules will # act on their own notifications (e.g. sfp_dns)! if listenerModule.watchedEvents() != None: module.registerListener(listenerModule) dbh.scanInstanceSet(self.config['__guid__'], status='RUNNING') self.status = "RUNNING" # Create the "ROOT" event which un-triggered modules will link events to rootEvent = SpiderFootEvent("INITIAL_TARGET", self.target, "SpiderFoot UI") dbh.scanEventStore(self.config['__guid__'], rootEvent) # Start the modules sequentially. for module in self.moduleInstances.values(): # Check in case the user requested to stop the scan between modules initializing if module.checkForStop(): dbh.scanInstanceSet(self.config['__guid__'], status='ABORTING') self.status = "ABORTING" aborted = True break # Many modules' start() method will return None, as most will rely on # notifications during the scan from other modules. module.start() # Check if any of the modules ended due to being stopped for module in self.moduleInstances.values(): if module.checkForStop(): aborted = True if aborted: self.sf.status("Scan [" + self.config['__guid__'] + "] aborted.") dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'ABORTED') self.status = "ABORTED" else: self.sf.status("Scan [" + self.config['__guid__'] + "] completed.") dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'FINISHED') self.status = "FINISHED" except BaseException as e: exc_type, exc_value, exc_traceback = sys.exc_info() self.sf.error("Unhandled exception (" + e.__class__.__name__ + ") " + \ "encountered during scan. Please report this as a bug: " + \ repr(traceback.format_exception(exc_type, exc_value, exc_traceback)), False) self.sf.status("Scan [" + self.config['__guid__'] + "] failed: " + str(e)) dbh.scanInstanceSet(self.config['__guid__'], None, time.time() * 1000, 'ERROR-FAILED') self.status = "ERROR-FAILED" self.moduleInstances = None dbh.close() self.sf.setDbh(None) self.sf.setScanId(None)