forked from smicallef/spiderfoot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sfscan.py
256 lines (219 loc) · 10.4 KB
/
sfscan.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
#-----------------------------------------------------------------
# Name: sfscan
# Purpose: Scanning control functionality
#
# Author: Steve Micallef <steve@binarypool.com>
#
# Created: 11/03/2013
# Copyright: (c) Steve Micallef 2013
# License: GPL
#-----------------------------------------------------------------
import json
import traceback
import os
import time
import re
import sys
import socket
import socks
import dns.resolver
import threading
import thread
import random
from netaddr import IPNetwork
from copy import deepcopy, copy
from sfdb import SpiderFootDb
from sflib import SpiderFoot, SpiderFootEvent, SpiderFootTarget, \
SpiderFootPlugin, globalScanStatus
# Eventually change this to be able to control multiple scan instances
class SpiderFootScanner(threading.Thread):
# Thread-safe storage
ts = None
# Temporary storage
temp = None
# moduleOpts not yet used
def __init__(self, scanName, scanTarget, targetType, scanId, moduleList,
globalOpts, moduleOpts):
# Initialize the thread
threading.Thread.__init__(self, name="SF_"+scanName+\
str(random.randint(100000, 999999)))
# Temporary data to be used in startScan
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
# Set the status of the currently running scan (if any)
def setStatus(self, status, started=None, ended=None):
if self.ts == None:
print "Internal Error: Status set attempted before " + \
"SpiderFootScanner was ready."
exit(-1)
self.ts.status = status
self.ts.dbh.scanInstanceSet(self.ts.scanId, started, ended, status)
globalScanStatus.setStatus(self.ts.scanId, status)
return None
def run(self):
self.startScan()
def getId(self):
if hasattr(self.ts, 'scanId'):
return self.ts.scanId
return None
# Start running a scan
def startScan(self):
global globalScanStatus
self.ts = threading.local()
self.ts.moduleInstances = dict()
self.ts.sf = SpiderFoot(self.temp['config'])
self.ts.config = deepcopy(self.temp['config'])
self.ts.dbh = SpiderFootDb(self.temp['config'])
self.ts.targetValue = self.temp['targetValue']
self.ts.targetType = self.temp['targetType']
self.ts.moduleList = self.temp['moduleList']
self.ts.modconfig = dict()
self.ts.scanName = self.temp['scanName']
self.ts.scanId = self.temp['scanId']
aborted = False
self.ts.sf.setDbh(self.ts.dbh)
# Create a unique ID for this scan and create it in the back-end DB.
self.ts.sf.setGUID(self.ts.scanId)
self.ts.dbh.scanInstanceCreate(self.ts.scanId,
self.ts.scanName, self.ts.targetValue)
self.setStatus("STARTING", time.time() * 1000, None)
# Create our target
target = SpiderFootTarget(self.ts.targetValue, self.ts.targetType)
# Save the config current set for this scan
self.ts.config['_modulesenabled'] = self.ts.moduleList
self.ts.dbh.scanConfigSet(self.ts.scanId,
self.ts.sf.configSerialize(deepcopy(self.ts.config)))
self.ts.sf.status("Scan [" + self.ts.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.ts.config['_socks1type'] != '':
socksType = socks.PROXY_TYPE_SOCKS4
socksDns = self.ts.config['_socks6dns']
socksAddr = self.ts.config['_socks2addr']
socksPort = int(self.ts.config['_socks3port'])
socksUsername = ''
socksPassword = ''
if self.ts.config['_socks1type'] == '4':
socksType = socks.PROXY_TYPE_SOCKS4
if self.ts.config['_socks1type'] == '5':
socksType = socks.PROXY_TYPE_SOCKS5
socksUsername = self.ts.config['_socks4user']
socksPassword = self.ts.config['_socks5pwd']
if self.ts.config['_socks1type'] == 'HTTP':
socksType = socks.PROXY_TYPE_HTTP
self.ts.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.ts.sf.updateSocket(socket)
# Override the default DNS server
if self.ts.config['_dnsserver'] != "":
res = dns.resolver.Resolver()
res.nameservers = [ self.ts.config['_dnsserver'] ]
dns.resolver.override_system_resolver(res)
else:
dns.resolver.restore_system_resolver()
# Set the user agent
self.ts.config['_useragent'] = self.ts.sf.optValueToData(
self.ts.config['_useragent'])
# Get internet TLDs
tlddata = self.ts.sf.cacheGet("internet_tlds",
self.ts.config['_internettlds_cache'])
# If it wasn't loadable from cache, load it from scratch
if tlddata == None:
self.ts.config['_internettlds'] = self.ts.sf.optValueToData(
self.ts.config['_internettlds'])
self.ts.sf.cachePut("internet_tlds", self.ts.config['_internettlds'])
else:
self.ts.config["_internettlds"] = tlddata.splitlines()
for modName in self.ts.moduleList:
if modName == '':
continue
module = __import__('modules.' + modName, globals(), locals(),
[modName])
mod = getattr(module, modName)()
mod.__name__ = modName
# Set up the module
# Configuration is a combined global config with module-specific options
self.ts.modconfig[modName] = deepcopy(self.ts.config['__modules__'][modName]['opts'])
for opt in self.ts.config.keys():
self.ts.modconfig[modName][opt] = deepcopy(self.ts.config[opt])
mod.clearListeners() # clear any listener relationships from the past
mod.setup(self.ts.sf, self.ts.modconfig[modName])
mod.setDbh(self.ts.dbh)
mod.setScanId(self.ts.scanId)
# Give modules a chance to 'enrich' the original target with
# aliases of that target.
newTarget = mod.enrichTarget(target)
if newTarget != None:
target = newTarget
self.ts.moduleInstances[modName] = mod
# Override the module's local socket module
# to be the SOCKS one.
if self.ts.config['_socks1type'] != '':
mod._updateSocket(socket)
self.ts.sf.status(modName + " module loaded.")
# Register listener modules and then start all modules sequentially
for module in self.ts.moduleInstances.values():
# Register the target with the module
module.setTarget(target)
for listenerModule in self.ts.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)
# 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.clearListeners()
for mod in self.ts.moduleInstances.values():
if mod.watchedEvents() != None:
psMod.registerListener(mod)
# Create the "ROOT" event which un-triggered modules will link events to
rootEvent = SpiderFootEvent("ROOT", "", "", None)
psMod.notifyListeners(rootEvent)
firstEvent = SpiderFootEvent(self.ts.targetType, self.ts.targetValue,
"SpiderFoot UI", rootEvent)
psMod.notifyListeners(firstEvent)
# Check in case the user requested to stop the scan between modules
# initializing
for module in self.ts.moduleInstances.values():
if module.checkForStop():
self.setStatus('ABORTING')
aborted = True
break
if aborted:
self.ts.sf.status("Scan [" + self.ts.scanId + "] aborted.")
self.setStatus("ABORTED", None, time.time() * 1000)
else:
self.ts.sf.status("Scan [" + self.ts.scanId + "] completed.")
self.setStatus("FINISHED", None, time.time() * 1000)
except BaseException as e:
exc_type, exc_value, exc_traceback = sys.exc_info()
self.ts.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.ts.sf.status("Scan [" + self.ts.scanId + "] failed: " + str(e))
self.setStatus("ERROR-FAILED", None, time.time() * 1000)
self.ts.dbh.close()
del self.ts
del self.temp