Skip to content

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

Run scan by use case.

smicallefe724c013bcf0
diff --git a/dyn/newscan.tmpl b/dyn/newscan.tmpl
index 37f71e55..34a6a99f 100644
--- a/dyn/newscan.tmpl
+++ b/dyn/newscan.tmpl
@@ -1,7 +1,7 @@
<%include file="HEADER.tmpl"/>
<script type='text/javascript'>
- activeTab = "type";
- alternateTab = "module";
+ tabs = [ "use", "type", "module" ];
+ activeTab = "use";
function submitForm() {
list = "";
@@ -12,17 +12,24 @@
});
$("#"+activeTab+"list").val(list);
- $("#"+alternateTab+"list").val("");
+ for (i = 0; i < tabs.length; tabs++) {
+ if (tabs[i] != activeTab) {
+ $("#"+tabs[i]+"list").val("");
+ }
+ }
}
- function switchTab() {
+ function switchTab(tabname) {
$("#"+activeTab+"table").hide();
$("#"+activeTab+"tab").removeClass("active");
- $("#"+alternateTab+"table").show();
- $("#"+alternateTab+"tab").addClass("active");
- tempTab = alternateTab;
- alternateTab = activeTab;
- activeTab = tempTab;
+ $("#"+tabname+"table").show();
+ $("#"+tabname+"tab").addClass("active");
+ activeTab = tabname;
+ if (activeTab == "use") {
+ $("#selectors").hide();
+ } else {
+ $("#selectors").show();
+ }
}
function selectAll() {
@@ -51,13 +58,22 @@
<div class="control-group">
<ul class='nav nav-tabs'>
- <li id='typetab' class="active"><a onClick='switchTab()' href='#'>By Required Data</a></li>
- <li id='moduletab'><a onClick='switchTab()' href='#'>By Module</a></li>
- <div style='text-align: right'>
+ <li id='usetab' class="active"><a onClick='switchTab("use")' href='#'>By Use Case</a></li>
+ <li id='typetab'><a onClick='switchTab("type")' href='#'>By Required Data</a></li>
+ <li id='moduletab'><a onClick='switchTab("module")' href='#'>By Module</a></li>
+ <div style='text-align: right; display: none' id='selectors'>
<button type="button" onClick='selectAll()' class="btn-mini btn-info">Select All</button>&nbsp;&nbsp;
<button type="button" onClick='deselectAll()' class="btn-mini btn-info">De-Select All</button>
</div>
</ul>
+ <table class="table table-striped table-condensed" id="usetable">
+ <tr><td><input type=radio name='usecase' value='all' id="usecase_all" checked></td><td>All</td><td><b>Get anything and everything about the target.</b><br><br>All SpiderFoot modules will be enabled (slow) but every possible piece of information about the target will be obtained and analysed.<br><br></td></tr>
+ <tr><td><input type=radio name='usecase' value='Footprint' id="usecase_footprint"></td><td>Footprint</td><td><b>Understand what information this target exposes to the Internet.</b><br><br>Gain an understanding about the target's network perimeter, associated identities and other information that is obtained through a lot of web crawling and search engine use.
+ <br><br></td></tr>
+ <tr><td><input type=radio name='usecase' value='Investigate' id="usecase_investigate"></td><td>Investigate</td><td><b>Best for when you suspect the target to be malicious but need more information.</b><br><br>Some basic footprinting will be performed in addition to querying of blacklists and other sources that may have information about your target's maliciousness.
+ </td></tr>
+ </table>
+
<table class="table table-striped table-condensed" id="moduletable" style='display: none'>
% for item in sorted(modules):
% if item != "sfp__stor_db":
@@ -65,7 +81,7 @@
% endif
% endfor
</table>
- <table class="table table-striped table-condensed" id="typetable">
+ <table class="table table-striped table-condensed" id="typetable" style='display: none'>
<% count = 0 %>
% for item in sorted(types):
% if count % 2 == 0:
@@ -91,12 +107,7 @@
<script type='text/javascript'>
$('#scantarget').popover({ 'html': true, 'animation': true, 'trigger': 'focus'});
if ("${selectedmods}" != "") {
- $("#moduletable").show();
- $("#moduletab").addClass("active");
- $("#typetable").hide();
- $("#typetab").removeClass("active");
- activeTab = "module";
- alternateTab = "type";
+ switchTab("module");
$("input[id^=module_]").each(function(id, obj) {
if ("${selectedmods}".indexOf(obj.id.replace("module_", "")) >= 0) {
diff --git a/sf.py b/sf.py
index fd939348..f64ec1c2 100755
--- a/sf.py
+++ b/sf.py
@@ -119,8 +119,9 @@ if __name__ == '__main__':
sfModules[modName] = dict()
mod = __import__('modules.' + modName, globals(), locals(), [modName])
sfModules[modName]['object'] = getattr(mod, modName)()
- sfModules[modName]['name'] = sfModules[modName]['object'].__doc__.split(":", 2)[0]
- sfModules[modName]['descr'] = sfModules[modName]['object'].__doc__.split(":", 2)[1]
+ sfModules[modName]['name'] = sfModules[modName]['object'].__doc__.split(":", 3)[0]
+ sfModules[modName]['cats'] = sfModules[modName]['object'].__doc__.split(":", 3)[1].split(",")
+ sfModules[modName]['descr'] = sfModules[modName]['object'].__doc__.split(":", 3)[2]
sfModules[modName]['provides'] = sfModules[modName]['object'].producedEvents()
sfModules[modName]['consumes'] = sfModules[modName]['object'].watchedEvents()
if hasattr(sfModules[modName]['object'], 'opts'):
diff --git a/sfwebui.py b/sfwebui.py
index da6e3dba..a438e8f9 100644
--- a/sfwebui.py
+++ b/sfwebui.py
@@ -518,7 +518,7 @@ class SpiderFootWebUi:
resultsetfp.exposed = True
# Initiate a scan
- def startscan(self, scanname, scantarget, modulelist, typelist):
+ def startscan(self, scanname, scantarget, modulelist, typelist, usecase):
global globalScanStatus
# Snapshot the current configuration to be used by the scan
@@ -534,12 +534,15 @@ class SpiderFootWebUi:
if scanname == "" or scantarget == "":
return self.error("Form incomplete.")
- if typelist == "" and modulelist == "":
+ if typelist == "" and modulelist == "" and usecase == "":
return self.error("Form incomplete.")
+ # User selected modules
if modulelist != "":
modlist = modulelist.replace('module_', '').split(',')
- else:
+
+ # User selected types
+ if len(modlist) == 0 and typelist != "":
typesx = typelist.replace('type_', '').split(',')
# 1. Find all modules that produce the requested types
modlist = sf.modulesProducing(typesx)
@@ -556,6 +559,12 @@ class SpiderFootWebUi:
newmodcpy = deepcopy(newmods)
newmods = list()
+ # User selected a use case
+ if len(modlist) == 0 and usecase != "":
+ for mod in self.config['__modules__']:
+ if usecase == 'all' or usecase in self.config['__modules__'][mod]['cats']:
+ modlist.append(mod)
+
# Add our mandatory storage module..
if "sfp__stor_db" not in modlist:
modlist.append("sfp__stor_db")