-
Notifications
You must be signed in to change notification settings - Fork 119
/
triage.py
executable file
·220 lines (198 loc) · 8.6 KB
/
triage.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
#!/usr/bin/env python
### BEGIN LICENSE ###
### Use of the triage tools and related source code is subject to the terms
### of the license below.
###
### ------------------------------------------------------------------------
### Copyright (C) 2011 Carnegie Mellon University. All Rights Reserved.
### ------------------------------------------------------------------------
### Redistribution and use in source and binary forms, with or without
### modification, are permitted provided that the following conditions are
### met:
###
### 1. Redistributions of source code must retain the above copyright
### notice, this list of conditions and the following acknowledgments
### and disclaimers.
###
### 2. Redistributions in binary form must reproduce the above copyright
### notice, this list of conditions and the following disclaimer in the
### documentation and/or other materials provided with the distribution.
###
### 3. The names "Department of Homeland Security," "Carnegie Mellon
### University," "CERT" and/or "Software Engineering Institute" shall
### not be used to endorse or promote products derived from this software
### without prior written permission. For written permission, please
### contact permission@sei.cmu.edu.
###
### 4. Products derived from this software may not be called "CERT" nor
### may "CERT" appear in their names without prior written permission of
### permission@sei.cmu.edu.
###
### 5. Redistributions of any form whatsoever must retain the following
### acknowledgment:
###
### "This product includes software developed by CERT with funding
### and support from the Department of Homeland Security under
### Contract No. FA 8721-05-C-0003."
###
### THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
### CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY KIND, EITHER
### EXPRESS OR IMPLIED, AS TO ANY MATTER, AND ALL SUCH WARRANTIES, INCLUDING
### WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ARE
### EXPRESSLY DISCLAIMED. WITHOUT LIMITING THE GENERALITY OF THE FOREGOING,
### CARNEGIE MELLON UNIVERSITY DOES NOT MAKE ANY WARRANTY OF ANY KIND
### RELATING TO EXCLUSIVITY, INFORMATIONAL CONTENT, ERROR-FREE OPERATION,
### RESULTS TO BE OBTAINED FROM USE, FREEDOM FROM PATENT, TRADEMARK AND
### COPYRIGHT INFRINGEMENT AND/OR FREEDOM FROM THEFT OF TRADE SECRETS.
### END LICENSE ###
# Jonathan Foote
# jmfoote@loyola.edu
'''
A simple batch wrapper script for the CERT 'exploitable' GDB extension.
'''
from __future__ import print_function
from optparse import OptionParser
from string import Template
import subprocess
import shlex
import pickle as pkl
import os
import warnings
import sys
# allows for un-pickling of exploitable's Classification objects
file_path = os.path.dirname(os.path.realpath(__file__))
sys.path.append(os.path.join(file_path, "exploitable"))
class TriagedStates(list):
'''
A list of triaged items: (substring, exploitable::Classification)
tuples.
'''
def __init__(self, verbose=False):
self.verbose = verbose
def __str__(self):
if len(self) == 1:
cl = self[0][1]
if cl:
return str(cl)
return "Failed to triage (no crash?): %s" % self[0][0]
result = ""
failed = []
last = None
triaged = sorted(self, key=lambda tstate: tstate[1]) # sort by classification
for sub, classification in triaged:
if not classification or len(classification.tags) == 0:
failed.append(sub)
continue
if not last or str(classification.tags[0]) != str(last.tags[0]):
result += "\n%s: %s\n" % (classification.category,
classification.tags[0].short_desc)
result += "%s" % sub
if self.verbose:
for tag in classification.tags[1:]:
result += " (%s)" % tag.short_desc
result += "\n"
last = classification
failed = [state for state in self if not state[1] or len(state[1].tags) == 0]
if len(failed) > 0:
result += "\nFailed to triage:\n"+ "\n".join([s[0] for s in failed])
return result
class Triager(object):
'''
An object that can triage a set of inferior invocations via calls to
GDB.
'''
exploitable_py = os.path.normpath(os.path.join(file_path, 'exploitable/exploitable.py'))
gdb_cmd = "gdb --batch -ex \"source " + exploitable_py + "\" " +\
"-ex run -ex \"exploitable -p %s\" --args"
tmp_file = "/tmp/triage.pkl"
verbose = False
step_script = None
def __init__(self):
pass
def _cleanup_tmp_file(self):
'''
Deletes the temp file that is generated by the exploitable
extension and consumed by this script.
'''
if os.path.exists(self.tmp_file):
os.remove(self.tmp_file)
def triage(self, inferior_cmd, inferior_subs, verbose=False):
'''
Triages a set of results of GDB invocations and returns a
corresponding instance of TriagedStates
'''
self.verbose = verbose
inferior_template = Template(inferior_cmd)
triaged = TriagedStates(self.verbose)
pos = 0
for sub in inferior_subs:
pos = pos + 1
self._cleanup_tmp_file()
inferior_cmd = inferior_template.safe_substitute(sub=sub)
if self.step_script:
call = self.step_script + " " + inferior_cmd
self.vprint("(%d/%d) calling: %s" % (pos, len(inferior_subs), call))
subprocess.call(shlex.split(call))
call = self.gdb_cmd.replace("%s", self.tmp_file) + " " + inferior_cmd
self.vprint("(%d/%d) calling: %s" % (pos, len(inferior_subs), call))
subprocess.call(shlex.split(call), stdout=open(os.devnull, 'w'))
try:
classification = pkl.load(open(self.tmp_file, "rb"))
except Exception as e:
classification = None
warnings.warn("triage failed (%s), call=%s" % (e, call))
triaged.append((sub, classification))
self._cleanup_tmp_file()
return triaged
def vprint(self, msg):
if self.verbose:
print(msg)
if __name__ == "__main__":
usage = "usage: %prog [options] CMD [arg1, arg2, ..]"
desc = "Runs CMD in gdb and prints results categorized by the " +\
"'exploitable' gdb command. If args are defined, CMD is " +\
"run for each arg with any instances of the magic string " +\
"${sub} in CMD replaced with the arg. Note that $ may " + \
"require an escape character (\\$)"
op = OptionParser(description=desc, usage=usage)
op.add_option("-v", "--verbose", action="store_true",
dest="verbose", default=False,
help="Print verbose messages to stdout and includes "
"all matching tags in summary")
op.add_option("-g", "--gdb-shell-cmd", action="store",
dest="gdb_shell_cmd", default=False,
help="Overrides gdb shell command. Default is '%s'"
% Triager.gdb_cmd)
op.add_option("-t", "--tmp-filename", action="store",
dest="tmp_filename", default=False,
help="Overrides temporary pkl filename. Default is '%s'"
% Triager.tmp_file)
op.add_option("-s", "--step-script", action="store",
dest="step_script", default=False,
help="run specified bash script between each invocation "
"of GDB. The app invocation string is passed as an "
"argument to the bash script.")
op.add_option("-o", "--output", action="store",
dest="output", default=False,
help="output result as JSON to supplied filepath.")
(opts, args) = op.parse_args()
if len(args) < 1:
op.error("wrong number of arguments")
if len(args) == 1:
cmd = "${sub}"
else:
cmd = args[0]
args = args[1:]
if opts.gdb_shell_cmd:
Triager.gdb_cmd = opts.gdb_shell_cmd
if opts.tmp_filename:
Triager.tmp_file = opts.tmp_filename
if opts.step_script:
Triager.step_script = opts.step_script
results = Triager().triage(cmd, args, opts.verbose)
if opts.output:
import json
# sort by classification before dumping
triaged = sorted(results , key=lambda tstate: tstate[1])
json.dump(triaged, open(opts.output, "wt"), indent=4)
print("\n\n\n\n", results)