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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
| """Take list of hosts/URIs or Nmap XML as input, scan hosts on given ports,
and return a searchable and sortable HTML report."""
import argparse
from argparse import RawDescriptionHelpFormatter
from datetime import datetime
import hashlib
from functools import partial
from multiprocessing.dummy import Pool as ThreadPool
from os import getcwd, path
import re
import jinja2
from lxml import html, etree
import lxml
import requests
try:
import ssdeep
except ImportError:
ssdeep = None
import urllib3
import xmltodict
results = {}
cwd = getcwd()
datatables_css = f'<link rel="stylesheet" type="text/css" href="{cwd}/css/jquery.dataTables.min.css">'
jquery = f'<script type="text/javascript" charset="utf8" src="{cwd}/js/jquery-3.5.1.min.js"></script>'
datatables = f'<script type="text/javascript" charset="utf8" src="{cwd}/js/jquery.dataTables.min.js"></script>'
datatables_celledit = f'<script type="text/javascript" charset="utf8" src="{cwd}/js/dataTables.cellEdit.js"></script>'
ssdeep_js = f'<script type="text/javascript" charset="utf8" src="{cwd}/js/ssdeep.js"></script>'
jinja_env = jinja2.Environment(trim_blocks=True, lstrip_blocks=True)
templateLoader = jinja2.FileSystemLoader(searchpath="./")
templateEnv = jinja2.Environment(loader=templateLoader)
TEMPLATE_FILE = "template.html"
template = templateEnv.get_template(TEMPLATE_FILE)
def parse_nmap_xml(nmap_file, ports):
"""Parse an Nmap .xml file for open HTTP(S) ports. Return a set."""
hosts = []
nmap_scan = xmltodict.parse(nmap_file.read())
for host in nmap_scan['nmaprun']['host']:
ipv4_addr = host['address']['@addr']
if isinstance(host['ports']['port'], list):
for port in host['ports']['port']:
if int(port['@portid']) in ports:
hosts.append(f"{ipv4_addr}:{port['@portid']}")
else:
if int(host['ports']['port']['@portid']) in ports:
hosts.append(f"{ipv4_addr}:{host['ports']['port']['@portid']}")
scan_set = {'https://' + host if host[-3:] == '443' else 'http://' + host for host in hosts}
return scan_set
def build_list(list_file, ports):
"""Read a text file of IPs or URLs, prepend protocol and append port as necessary.
Return a set for scanning"""
regex = re.compile(r"^(https?:\/\/)?.+?(:[0-9]{0,5})?$")
scan_set = set()
lines = [line.rstrip() for line in list_file.readlines()]
for line in lines:
line = re.match(regex, line)
if not line:
pass
elif line[1] and line[2]: # protocol and port
scan_set.add(line[0])
elif line[1] and not line[2]: # protocol no port
print('Protocol no port')
if line[1] == 'https://':
scan_set.add(line[0])
else:
for port in ports:
# Convert http://example.com:443 to https://example.com:443
if str(port) == '443':
uri = line[0].replace('http://', 'https://') + ':' + str(port)
scan_set.add(uri)
else:
uri = line[0] + ':' + str(port)
scan_set.add(uri)
print(scan_set)
exit()
elif not line[1] and line[2]: # no protocol but port
if line[2] == ':443':
uri = 'https://' + line[0]
else:
uri = 'http://' + line[0]
scan_set.add(uri)
elif not line[1] and not line[2]: # neither protocol nor port
for port in ports:
if str(port) == '443':
uri = 'https://' + line[0] + ':' + str(port)
else:
uri = 'http://' + line[0] + ':' + str(port)
scan_set.add(uri)
return scan_set
def prompt(question, default=None):
# Adapted from https://stackoverflow.com/a/3041990 - thanks fmark
"""Ask a yes/no question via input() and return answer.
"question" is a string that is presented to the user.
"default" is the presumed answer if the user just hits <Enter>.
It must be "yes" (the default), "no" or None (meaning
an answer is required of the user).
The "answer" return value is True for "yes" or False for "no".
"""
valid = {"yes": True, "y": True, "ye": True, "no": False, "n": False}
if default is None:
choice = " [y/n] "
elif default == "yes":
choice = " [Y/n] "
elif default == "no":
choice = " [y/N] "
else:
raise ValueError(f'Invalid default answer: {default}')
while True:
print(question + choice)
choice = input().lower()
if default is not None and choice == '':
return valid[default]
elif choice in valid:
return valid[choice]
else:
print('[*] Please respond with "[y]es" or "[n]o".')
def scan(timeout, validate_certs, no_redirect, user_agent, fuzzy, verbose, uri):
"""Make requests to the provided URIs and save attributes of the responses."""
headers = {'User-Agent': user_agent}
regex = re.compile(r"type=[\"|\']password[\"|\']", re.IGNORECASE)
# Build parser so multiple threads don't use a global parser
parser = etree.HTMLParser()
title, login, redirect, md5_hash, fuzzy_hash = None, None, None, None, None
error = None
results[uri] = [title, login, redirect, md5_hash, fuzzy_hash]
try:
resp = requests.get(uri, headers=headers, timeout=timeout, verify=validate_certs,
allow_redirects=no_redirect)
if resp.content:
md5_hash = hashlib.md5(resp.content).hexdigest()
tree = html.fromstring(resp.content, parser=parser)
try:
title = tree.find('.//title').text.lstrip().rstrip()
# Strip newline characters if it's depicted in HTML with line breaks
# those break javascript arrays built later.
if ',' in title:
title = '"' + title + '"' # If title contains comma, wrap in quotes for CSV export
except AttributeError:
if verbose:
print(f'[-] {uri} - attribute error; page may lack title element')
login = re.search(regex, resp.content.decode('ISO-8859-1'))
if login:
login = True
if fuzzy:
fuzzy_hash = ssdeep.hash(resp.content)
elif no_redirect is True:
if resp.url.strip('/') != uri:
redirect = resp.url
results[uri] = [title, resp.status_code, login, redirect, md5_hash, fuzzy_hash]
# Handle errors
except requests.exceptions.ConnectTimeout:
error = 'Timeout.'
results[uri].insert(1, error)
except requests.exceptions.ReadTimeout:
error = 'Timeout.'
results[uri].insert(1, error)
except requests.exceptions.SSLError:
error = 'Timeout'
results[uri].insert(1, error)
except requests.exceptions.TooManyRedirects:
error = 'Timeout'
results[uri].insert(1, 'Too many redirects')
# Since requests uses other libraries (socket, httplib, urllib3) a requests ConnectionError
# can be any number of errors raised by those libraries.
except requests.exceptions.ConnectionError as err:
err_msg = str(err.args[0])
if 'BadStatusLine' in err_msg:
error = 'Timeout'
results[uri].insert(1, 'Timeout')
elif 'Connection refused' in err_msg:
error = 'Timeout'
results[uri].insert(1, error)
elif 'Connection reset by peer' in err_msg:
error = 'Timeout'
results[uri].insert(1, error)
else: # Catch all the others
error = err_msg
results[uri].insert(1, 'Timeout')
if verbose and error:
print(f'[-] Error scanning {uri}: {error}')
def main():
"""Scan a list of hosts and generate an HTML report. Return nothing."""
user_agent = '''Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.163 Safari/537.36'''
parser = argparse.ArgumentParser(description='Scan and categorize web servers using a searchable and sortable'
'HTML report.',
epilog='list input: python3 catscan.py -l <ips.txt> -p 80 443 8080 -t 10\n'
'Nmap xml: python3 catscan.py -x <nmap.xml>',
formatter_class=RawDescriptionHelpFormatter)
group = parser.add_mutually_exclusive_group(required=True)
group.add_argument('-x', '--xml', dest='nmap_xml', type=argparse.FileType('r'),
help='Use an Nmap XML file as input.')
group.add_argument('-l', '--list', dest='host_list', type=argparse.FileType('r'),
help='Text file containing list of IPs or hostnames separated by line.')
parser.add_argument('-p', '--ports', dest='ports', nargs='+', required=False, default=[80, 443],
help='List of ports to scan. Default 80 and 443.')
parser.add_argument('-t', '--threads', dest='threads', type=int, default=10,
help='Number of threads. Default 10.')
parser.add_argument('-T', '--timeout', dest='timeout', type=int, default=5,
help='Timeout in seconds. Default 5.')
parser.add_argument('-o', '--output', dest='output', required=False,
help='Name of HTML report. Default based on date/time.')
parser.add_argument('-u', '--user-agent', dest='user_agent', required=False, default=user_agent,
help='User-Agent string.')
parser.add_argument('-r', '--no-redirect', dest='no_redirect', required=False, default=True, action='store_false',
help='Do not follow redirects. Catscan follows redirects by default.')
parser.add_argument('-k', '--validate', dest='validate_certs', required=False, default=False,
action='store_true', help='Validate certificates. Default false.')
parser.add_argument('-n', '--notes', dest='notes', required=False, default=False,
action='store_true', help='Add a writable "Notes" column to HTML report.')
parser.add_argument('-f', '--fuzzy', dest='fuzzy', required=False, default=False,
action='store_true', help='Use "fuzzy" hashes to identify similar sites.')
parser.add_argument('-v', '--verbose', dest='verbose', required=False, default=False,
action='store_true')
args = parser.parse_args()
nmap_file = args.nmap_xml
list_file = args.host_list
ports = args.ports
timeout = args.timeout
threads = args.threads
output = args.output
user_agent = args.user_agent
no_redirect = args.no_redirect
validate_certs = args.validate_certs
notes = args.notes
fuzzy = args.fuzzy
verbose = args.verbose
start_time = datetime.now()
if fuzzy and not ssdeep:
fuzzy = False
print('[-] Error importing ssdeep module. Fuzzy hashing functionality not available.')
if not output:
output = f'catscan_report_{start_time.strftime("%a_%d%b%Y_%H%M").lower()}.html'
if output:
if path.isfile(output):
ans = prompt(f'[*] Output file {output} already exists. Overwrite?', None)
if not ans:
print('[-] Provide new name or overwrite existing report. Exiting.')
exit()
if nmap_file:
scan_list = parse_nmap_xml(nmap_file, ports)
elif list_file:
scan_list = build_list(list_file, ports)
func = partial(scan, timeout, validate_certs, no_redirect, user_agent, fuzzy, verbose)
pool = ThreadPool(threads)
pool.map(func, scan_list)
pool.close()
pool.join()
end_scan_time = datetime.now()
if verbose:
print(f'[*] Scan time: {(end_scan_time - start_time).total_seconds()} seconds')
print(f'[*] {len(scan_list)} hosts scanned')
end_run_time = datetime.now()
print(f'[*] Total run time: {(end_run_time - start_time).total_seconds()} seconds')
title_counts, content_counts = {}, {}
for value in results.values():
if value[0] in title_counts:
title_counts[value[0]] += 1
else:
title_counts[value[0]] = 1
if value[4] in content_counts:
content_counts[value[4]][0] += 1
else:
content_counts[value[4]] = [1, value[0]]
with open(output, 'w', encoding="utf8") as html_report:
html_report.write(template.render(
start_time=start_time.strftime("%a_%d%b%Y_%H%M").lower(),
datatables_css=datatables_css,
jquery=jquery,
datatables=datatables,
datatables_celledit=datatables_celledit,
ssdeep_js=ssdeep_js,
redirect_column=no_redirect,
notes_column=notes,
fuzzy=fuzzy,
results=results,
title_counts=title_counts,
content_counts=content_counts
))
print(f'[*] Report written to {output}')
if __name__ == '__main__':
# Disable "InsecureRequestWarning: Unverified HTTPS request is being made.
# Adding certificate verification is strongly advised." warning.
urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
main() |
