-
Notifications
You must be signed in to change notification settings - Fork 2
/
fwhunt.py
270 lines (192 loc) · 7.01 KB
/
fwhunt.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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
import logging
import traceback
from typing import Any, Optional
import ida_idaapi
import ida_kernwin
import idc
from fwhunt import ui, utils
NAME = "FwHunt"
AUTHOR = "https://github.com/binarly-io/"
VERSION = "1.0.0"
DESCRIPTION = "Helper tool for generating FwHunt compliant rules"
g_form: Optional[ui.FwHuntForm] = None
g_rule: ui.FwHuntRule = ui.FwHuntRule()
logger = logging.getLogger(NAME)
# -----------------------------------------------------------------------
class FwHuntAction(ida_kernwin.action_handler_t):
"""Basic class for FwHunt action"""
def __init__(self) -> None:
ida_kernwin.action_handler_t.__init__(self)
def update(self, ctx) -> Any:
if ctx.widget_type == ida_kernwin.BWN_DISASM:
ida_kernwin.attach_action_to_popup(ctx.widget, None, self.name, "FwHunt/")
return ida_kernwin.AST_ENABLE_FOR_WIDGET
return ida_kernwin.AST_DISABLE_FOR_WIDGET
# -----------------------------------------------------------------------
class AddEfiGuid(FwHuntAction):
name = "AddEfiGuid"
description = "add GUID to detection rule"
hotkey = str()
def __init__(self) -> None:
super().__init__()
def activate(self, _ctx) -> bool:
if g_rule.editor is None:
return False
ea = ida_kernwin.get_screen_ea()
guid = utils.get_guid_value(ea)
name = utils.get_guid_name(ea)
logger.info(f"GUID: {guid} # {name}")
if guid is None:
return False
# append GUID to rule
g_rule.append_guid(guid, name)
return True
# -----------------------------------------------------------------------
class AddAsciiString(FwHuntAction):
name = "AddAsciiString"
description = "add ascii string to detection rule"
hotkey = str()
def __init__(self) -> None:
super().__init__()
def activate(self, _ctx) -> bool:
if g_rule.editor is None:
return False
ea = ida_kernwin.get_screen_ea()
logger.info(f"Address: {ea:#x}")
string = utils.get_ascii_string(ea)
if string is None:
return False
# remove \n
if "\n" in string:
string = string.split("\n")[0]
logger.info(f"String: {string}")
if not len(string):
return False
# append ascii string to rule
g_rule.append_string(string)
return True
# -----------------------------------------------------------------------
class AddWideString(FwHuntAction):
name = "AddWideString"
description = "add wide string to detection rule"
hotkey = str()
def __init__(self) -> None:
super().__init__()
def activate(self, ctx) -> bool:
if g_rule.editor is None:
return False
ea = ida_kernwin.get_screen_ea()
logger.info(f"Address: {ea:#x}")
string = utils.get_wide_string(ea)
if string is None:
return False
# remove \n
if "\n" in string:
string = string.split("\n")[0]
logger.info(f"Wide string: {string}")
if not len(string):
return False
# append wide string to rule
g_rule.append_wide_string(string)
return True
# -----------------------------------------------------------------------
class AddHexString(FwHuntAction):
name = "AddHexString"
description = "add hex string to detection rule"
hotkey = str()
def __init__(self) -> None:
super().__init__()
def activate(self, _ctx) -> bool:
if g_rule.editor is None:
return False
start_ea = idc.read_selection_start()
end_ea = idc.read_selection_end()
hex_string = utils.get_hex_string(start_ea, end_ea)
logger.info(f"Hex string: {hex_string}")
if hex_string is not None:
# append hex string to rule
g_rule.append_hex_string(hex_string)
return True
# -----------------------------------------------------------------------
class AddCodeSnippet(FwHuntAction):
name = "AddCodeSnippet"
description = "add code to detection rule"
hotkey = str()
def __init__(self) -> None:
super().__init__()
def activate(self, _ctx) -> bool:
if g_rule.editor is None:
return False
start_ea = idc.read_selection_start()
end_ea = idc.read_selection_end()
# if selected only one line
if start_ea == idc.BADADDR and end_ea == idc.BADADDR:
start_ea = ida_kernwin.get_screen_ea()
end_ea = idc.next_head(start_ea)
logger.info(f"Start code address: {start_ea:#x}")
logger.info(f"End code address: {end_ea:#x}")
code, comments = utils.get_code(start_ea, end_ea)
logger.info(f"Code: {code}")
if code is not None:
# append hex string to rule
g_rule.append_code(code, comments)
return True
# -----------------------------------------------------------------------
class FwHuntHelper(ida_idaapi.plugin_t):
"""FwHunt helper class"""
flags = 0
comment = DESCRIPTION
help = DESCRIPTION
wanted_name = NAME
wanted_hotkey = "Ctrl+Alt+F"
@staticmethod
def register_action(action, *args) -> None:
desc = ida_kernwin.action_desc_t(
action.name, action.description, action(*args), action.hotkey
)
ida_kernwin.register_action(desc)
@staticmethod
def init() -> Any:
ida_kernwin.msg(f"\n{NAME} ({VERSION})\n")
return ida_idaapi.PLUGIN_KEEP
@staticmethod
def run(_arg) -> bool:
global g_form
if g_form is not None:
g_form.Close(options=0)
# initialize the form
g_form = ui.FwHuntForm()
g_form.Show("FwHunt rule generator")
g_rule.install_editor(g_form.rule_preview)
g_form.fwhunt_scan_info.install_rule(g_rule)
# add actions
FwHuntHelper.register_action(AddEfiGuid)
FwHuntHelper.register_action(AddAsciiString)
FwHuntHelper.register_action(AddWideString)
FwHuntHelper.register_action(AddHexString)
FwHuntHelper.register_action(AddCodeSnippet)
@staticmethod
def term() -> None:
ida_kernwin.unregister_action(AddEfiGuid.name)
ida_kernwin.unregister_action(AddAsciiString.name)
ida_kernwin.unregister_action(AddWideString.name)
ida_kernwin.unregister_action(AddHexString.name)
ida_kernwin.unregister_action(AddCodeSnippet.name)
# -----------------------------------------------------------------------
# Entry for plugin
def PLUGIN_ENTRY() -> Optional[FwHuntHelper]:
try:
return FwHuntHelper()
except Exception as e:
logger.error(f"{str(e)}\n{traceback.format_exc()}")
return None
# -----------------------------------------------------------------------
# Entry for IDAPyhton script
def main() -> None:
try:
FwHuntHelper.init()
FwHuntHelper.run(0)
except Exception as e:
logger.error(f"{str(e)}\n{traceback.format_exc()}")
if __name__ == "__main__":
main()