class Console():
COMMANDS = None
TAB = " "
MAX_PRINT_COMPLETE = 80
def __init__(self, gctx):
self.gctx = gctx
gctx.vim = False
self.COMMANDS_ALPHA = [
"analyzer",
"da",
"db",
"dd",
"dw",
"dq",
"dump",
"exit",
"functions",
"help",
"history",
"info",
"jmptable",
"load",
"lrawarm",
"lrawmips",
"lrawmips64",
"lrawx86",
"lrawx64",
"mips_set_gp",
"py",
"save",
"sections",
"sym",
"x",
"v",
"display.print_section",
"xrefs",
]
self.COMMANDS = {
"analyzer":
Command(0, self.__exec_analyzer, None, [
"",
"Analyzer information",
]),
"help":
Command(0, self.__exec_help, None, ["", "Display this help"]),
"history":
Command(0, self.__exec_history, None, [
"",
"Display the command history",
]),
"save":
Command(0, self.__exec_save, None, [
"",
"Save the database (only symbols and history currently).",
]),
"load":
Command(1, self.__exec_load, self.__complete_load, [
"filename",
"Load a new binary file.",
]),
"lrawx86":
Command(1, self.__exec_lrawx86, self.__complete_load, [
"filename",
"Load a x86 raw file.",
]),
"lrawx64":
Command(1, self.__exec_lrawx64, self.__complete_load, [
"filename",
"Load a x64 raw file.",
]),
"lrawarm":
Command(1, self.__exec_lrawarm, self.__complete_load, [
"filename",
"Load a ARM raw file.",
]),
"lrawmips":
Command(1, self.__exec_lrawmips, self.__complete_load, [
"filename",
"Load a MIPS raw file.",
]),
"lrawmips64":
Command(1, self.__exec_lrawmips64, self.__complete_load, [
"filename",
"Load a MIPS64 raw file.",
]),
"x":
Command(1, self.__exec_x, self.__complete_x, [
"[SYMBOL|0xXXXX|EP]",
"Decompile and print on stdout. By default it will be main.",
"The decompilation is forced, it dosn't check if addresses",
"are defined as code."
]),
"v":
Command(1, self.__exec_v, self.__complete_x, [
"[SYMBOL|0xXXXX|EP]",
"Visual mode",
"Shortcuts:",
"c create code",
"p create function",
"x show xrefs",
"r rename",
"I switch to traditional instruction string output",
"g top",
"G bottom",
"z set current line on the middle",
"q quit",
"; edit inline comment (enter/escape to validate/cancel)",
"% goto next bracket",
"* highlight current word (ctrl-k to clear)",
"{ } previous/next paragraph",
"tab switch between dump/decompilation",
"enter follow address",
"escape go back",
"u re-enter (for undo)",
]),
"da":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in ascii, it stops when the end of the section is found",
]),
"db":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in bytes, it stops when the end of the section is found",
]),
"dd":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in dwords, it stops when the end of the section is found",
]),
"dw":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in words, it stops when the end of the section is found",
]),
"dq":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in qwords, it stops when the end of the section is found",
]),
# by default it will be gctx.nb_lines
"dump":
Command(2, self.__exec_dump, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Disassemble only.",
]),
"set":
Command(3, None, None, ["", "Set options"]),
"sym":
Command(3, self.__exec_sym, self.__complete_x, [
"[SYMBOL 0xXXXX] [| FILTER]",
"Print all symbols or set a new symbol.",
"You can filter symbols by searching the word FILTER.",
"If FILTER starts with -, the match is inversed."
]),
"exit":
Command(0, self.__exec_exit, None, ["", "Exit"]),
"sections":
Command(0, self.__exec_sections, None, [
"",
"Print all sections",
]),
"info":
Command(0, self.__exec_info, None,
["", "Information about the current binary"]),
"display.print_section":
Command(0, self.__exec_display_print_section, None,
["", "Print or not section when an address is found"]),
"jmptable":
Command(4, self.__exec_jmptable, None, [
"INST_ADDR TABLE_ADDR NB_ENTRIES SIZE_ENTRY",
"Create a jump table referenced at TABLE_ADDR and called",
"from INST_ADDR."
]),
"py":
Command(0, self.__exec_py, None,
["", "Run an interactive python shell."]),
"mips_set_gp":
Command(1, self.__exec_mips_set_gp, None,
["ADDR", "Set the register $gp to a fixed value."]),
"functions":
Command(1, self.__exec_functions, None,
["", "Print the function list."]),
"xrefs":
Command(1, self.__exec_xrefs, self.__complete_x,
["SYMBOL|0xXXXX|EP", "Print all xrefs."]),
}
self.analyzer = Analyzer()
self.analyzer.start()
rl = ReadLine(self.exec_command, self.complete, self.send_control_c)
self.rl = rl
if gctx.filename is not None:
self.__exec_load(["", gctx.filename])
rl.reload_cursor_line()
while 1:
rl.loop()
if not self.check_db_modified():
break
self.analyzer.msg.put("exit")
def check_db_modified(self):
if self.gctx.db is not None and self.gctx.db.modified:
print("the database was modified, run save or exit to force")
return True
return False
def send_control_c(self):
return
#
# Returns tuple :
# - list of completed string (i.e. rest of the current token)
# - string: the beginning of the current token
# - if len(list) > 1: it contains the common string between
# all possibilities
#
# Each sub-complete functions returns only the list.
#
def complete(self, line):
# If last_word == "_" it means that there was spaces before
# and we want to complete a new arg
tmp_line = line + "_"
tokens = shlex.split(tmp_line)
last_tok = tokens[-1][:-1] # remove the _
tmp_line = tmp_line[:-1]
comp = []
# Complete a command name
if len(tokens) == 1:
i = 0
for cmd in self.COMMANDS_ALPHA:
if cmd.startswith(last_tok):
# To keep spaces
comp.append(cmd[len(last_tok):] + " ")
i += 1
if i == self.MAX_PRINT_COMPLETE:
comp = None
break
else:
try:
first_tok = tokens[0]
f = self.COMMANDS[first_tok].callback_complete
if f is not None:
comp = f(tmp_line, len(tokens) - 1, last_tok)
except KeyError:
pass
if comp is None:
print("\ntoo much possibilities")
return None, None, None
if len(comp) <= 1:
return comp, last_tok, None
common = []
words_idx = {len(word): i for i, word in enumerate(comp)}
min_len = min(words_idx)
ref = words_idx[min_len]
# Recreate because we have maybe removed words with same length
words_idx = set(range(len(comp)))
words_idx.remove(ref)
for i, char in enumerate(comp[ref]):
found = True
for j in words_idx:
if comp[j][i] != char:
found = False
break
if not found:
break
common.append(char)
return comp, last_tok, "".join(common)
def __complete_load(self, tmp_line, nth_arg, last_tok):
if nth_arg != 1:
return []
comp = []
basename = os.path.basename(last_tok)
dirname = os.path.dirname(last_tok)
if not dirname:
dirname = "."
try:
i = 0
for f in os.listdir(dirname):
if f.startswith(basename):
f_backslahed = f.replace(" ", "\\ ")
if os.path.isdir(os.path.join(dirname, f)):
s = f_backslahed + "/"
else:
s = f_backslahed + " "
comp.append(s[len(basename):])
i += 1
if i == self.MAX_PRINT_COMPLETE:
return None
return comp
except FileNotFoundError:
return []
def __complete_x(self, tmp_line, nth_arg, last_tok):
if nth_arg != 1 or self.gctx.dis is None:
return []
return self.__find_symbol(tmp_line, nth_arg, last_tok)
def __find_symbol(self, tmp_line, nth_arg, last_tok):
comp = []
i = 0
for sect in self.gctx.dis.binary.section_names:
if sect.startswith(last_tok):
comp.append((sect + " ")[len(last_tok):])
i += 1
if i == self.MAX_PRINT_COMPLETE:
return None
for sym in self.gctx.dis.binary.symbols:
if sym.startswith(last_tok):
comp.append((sym + " ")[len(last_tok):])
i += 1
if i == self.MAX_PRINT_COMPLETE:
return None
return comp
def exec_command(self, line):
args = shlex.split(line)
if args[0] not in self.COMMANDS:
error("unknown command")
return
c = self.COMMANDS[args[0]]
if len(args) - 1 > c.max_args:
error("%s takes max %d args" % (args[0], c.max_args))
return
if c.callback_exec is not None:
c.callback_exec(args)
def __exec_exit(self, args):
self.analyzer.msg.put("exit")
sys.exit(0)
def __exec_dump(self, args):
if self.gctx.dis is None:
error("load a file before")
return
nb_lines = self.gctx.nb_lines
if len(args) == 3:
try:
nb_lines = int(args[2])
except:
pass
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
ctx.dump_asm(nb_lines).print()
def __exec_data(self, args):
if self.gctx.dis is None:
error("load a file before")
return
nb_lines = self.gctx.nb_lines
if len(args) <= 1:
self.gctx.entry = None
error("no address in parameter")
return
if len(args) == 3:
try:
nb_lines = int(args[2])
except:
pass
ctx = self.gctx.get_addr_context(args[1])
if ctx:
if args[0] == "da":
self.gctx.dis.dump_data_ascii(ctx, nb_lines)
elif args[0] == "db":
self.gctx.dis.dump_data(ctx, nb_lines, 1)
elif args[0] == "dw":
self.gctx.dis.dump_data(ctx, nb_lines, 2)
elif args[0] == "dd":
self.gctx.dis.dump_data(ctx, nb_lines, 4)
elif args[0] == "dq":
self.gctx.dis.dump_data(ctx, nb_lines, 8)
def push_analyze_symbols(self):
self.analyzer.set(self.gctx)
# Analyze all imports (it checks if functions return or not)
for ad in self.gctx.db.imports:
if self.gctx.dis.mem.is_func(ad):
self.analyzer.msg.put((ad, True, None))
# Analyze entry point
ep = self.gctx.dis.binary.get_entry_point()
if ep is not None:
self.analyzer.msg.put((ep, False, None))
# Analyze static functions
for ad in self.gctx.db.reverse_symbols:
if ad not in self.gctx.db.imports and self.gctx.dis.mem.is_func(
ad):
self.analyzer.msg.put((ad, True, None))
def __exec_load(self, args):
# TODO: kill the thread analyzer before loading a new file
if self.check_db_modified():
return
if len(args) != 2:
error("filename required")
return
self.gctx.raw_type = None
if self.gctx.load_file(args[1]):
self.rl.history = self.gctx.db.history
self.push_analyze_symbols()
def __exec_lrawx86(self, args):
if self.check_db_modified():
return
if len(args) != 2:
error("filename required")
return
self.gctx.raw_type = "x86"
self.gctx.raw_big_endian = False
if self.gctx.load_file(args[1]):
self.analyzer.set(self.gctx.dis, self.gctx.db)
def __exec_lrawx64(self, args):
if self.check_db_modified():
return
if len(args) != 2:
error("filename required")
return
self.gctx.raw_type = "x64"
self.gctx.raw_big_endian = False
self.gctx.filename = args[1]
if self.gctx.load_file(args[1]):
self.analyzer.set(self.gctx.dis, self.gctx.db)
def __exec_lrawarm(self, args):
if self.check_db_modified():
return
if len(args) != 2:
error("filename required")
return
self.gctx.raw_type = "arm"
if self.gctx.load_file(args[1]):
self.analyzer.set(self.gctx.dis, self.gctx.db)
def __exec_lrawmips(self, args):
if self.check_db_modified():
return
if len(args) != 2:
error("filename required")
return
self.gctx.raw_type = "mips"
if self.gctx.load_file(args[1]):
self.analyzer.set(self.gctx.dis, self.gctx.db)
def __exec_lrawmips64(self, args):
if self.check_db_modified():
return
if len(args) != 2:
error("filename required")
return
self.gctx.raw_type = "mips64"
if self.gctx.load_file(args[1]):
self.analyzer.set(self.gctx.dis, self.gctx.db)
def __exec_sym(self, args):
if self.gctx.dis is None:
error("load a file before")
return
if len(args) == 1:
self.gctx.dis.print_symbols(self.gctx.sectionsname)
return
if args[1][0] == "|":
if len(args) == 2 or len(args) > 3:
error("bad arguments (warn: need spaces between |)")
return
self.gctx.dis.print_symbols(self.gctx.sectionsname, args[2])
return
if len(args) > 3:
error("bad arguments")
return
if len(args) == 2:
error("an address is required to save the symbol")
return
if not args[2].startswith("0x"):
error("the address should starts with 0x")
return
if args[1].startswith("loc_"):
error("loc_ is a reserved prefix")
return
# Save new symbol
try:
addr = int(args[2], 16)
self.gctx.db.modified = True
self.gctx.dis.add_symbol(addr, args[1])
except:
error("there was an error when creating a symbol")
def __exec_x(self, args):
if self.gctx.dis is None:
error("load a file before")
return
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
try:
o = ctx.decompile()
if o is not None:
o.print()
except:
traceback.print_exc()
def __exec_v(self, args):
if self.gctx.dis is None:
error("load a file before")
return
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
o = ctx.dump_asm(NB_LINES_TO_DISASM)
if o is not None:
Visual(self.gctx, ctx, self.analyzer)
def __exec_help(self, args):
for name in self.COMMANDS_ALPHA:
cmd = self.COMMANDS[name]
if cmd.callback_exec is not None:
self.rl.print(color(name, 2))
self.rl.print(" ")
for i, line in enumerate(cmd.desc):
if i > 0:
self.rl.print(self.TAB)
self.rl.print(line)
self.rl.print("\n")
def __exec_history(self, args):
for line in reversed(self.rl.history):
print(line)
def __exec_sections(self, args):
if self.gctx.dis is None:
error("load a file before")
return
self.rl.print("NAME".ljust(20))
self.rl.print(" [ START - END - VIRTUAL_SIZE - RAW_SIZE ]\n")
for s in self.gctx.dis.binary.iter_sections():
s.print_header()
def __exec_info(self, args):
if self.gctx.filename is None:
print("no file loaded")
return
print("File:", self.gctx.filename)
statinfo = os.stat(self.gctx.filename)
print("Size: %.2f ko" % (statinfo.st_size / 1024.))
print_no_end("Type: ")
ty = self.gctx.dis.binary.type
if ty == T_BIN_PE:
print("PE")
elif ty == T_BIN_ELF:
print("ELF")
elif ty == T_BIN_RAW:
print("RAW")
import capstone as CAPSTONE
arch, mode = self.gctx.dis.binary.get_arch()
print_no_end("Arch: ")
if arch == CAPSTONE.CS_ARCH_X86:
if mode & CAPSTONE.CS_MODE_32:
print("x86")
elif mode & CAPSTONE.CS_MODE_64:
print("x64")
elif arch == CAPSTONE.CS_ARCH_ARM:
print("arm")
elif arch == CAPSTONE.CS_ARCH_MIPS:
if mode & CAPSTONE.CS_MODE_32:
print("mips")
elif mode & CAPSTONE.CS_MODE_64:
print("mips64 (octeon)")
else:
print("not supported")
if mode & CAPSTONE.CS_MODE_BIG_ENDIAN:
print("Endianess: big endian")
else:
print("Endianess: little endian")
def __exec_display_print_section(self, args):
if self.gctx.sectionsname:
print("now it's off")
self.gctx.sectionsname = False
else:
print("now it's on")
self.gctx.sectionsname = True
def __exec_save(self, args):
if self.gctx.dis is None:
error("load a file before")
return
self.gctx.db.save(self.rl.history)
print("database saved to", self.gctx.db.path)
self.gctx.db.modified = False
def __exec_jmptable(self, args):
if self.gctx.dis is None:
error("load a file before")
return
try:
inst_addr = int(args[1], 16)
table_addr = int(args[2], 16)
nb_entries = int(args[3])
entry_size = int(args[4])
except:
error(
"one parameter is invalid, be sure that addresses start with 0x"
)
return
if entry_size not in [2, 4, 8]:
error("error the entry size should be in [2, 4, 8]")
return
self.gctx.db.modified = True
self.gctx.dis.add_jmptable(inst_addr, table_addr, entry_size,
nb_entries)
# TODO: it will be better to start from the beginning of the function
# end-function may differ.
# Re-run the analyzer
self.analyzer.msg.put((inst_addr, False, None))
def __exec_py(self, args):
code.interact(local=locals())
def __exec_mips_set_gp(self, args):
if self.gctx.dis is None:
error("load a file before")
return
try:
self.gctx.dis.mips_gp = int(args[1], 16)
self.gctx.db.mips_gp = self.gctx.dis.mips_gp
except:
error("bad address")
self.gctx.db.modified = True
def __exec_functions(self, args):
if self.gctx.dis is None:
error("load a file before")
return
self.gctx.dis.print_functions()
def __exec_xrefs(self, args):
if self.gctx.dis is None:
error("load a file before")
return
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
if ctx.entry not in self.gctx.dis.xrefs:
return
ctx.dump_xrefs().print()
def __exec_analyzer(self, args):
print("addresses remaining to analyze:", self.analyzer.msg.qsize())
def __init__(self, gctx):
self.gctx = gctx
gctx.vim = False
self.COMMANDS_ALPHA = [
"analyzer",
"da",
"db",
"dd",
"dw",
"dq",
"dump",
"exit",
"functions",
"help",
"history",
"info",
"jmptable",
"load",
"lrawarm",
"lrawmips",
"lrawmips64",
"lrawx86",
"lrawx64",
"mips_set_gp",
"py",
"save",
"sections",
"sym",
"x",
"v",
"display.print_section",
"xrefs",
]
self.COMMANDS = {
"analyzer":
Command(0, self.__exec_analyzer, None, [
"",
"Analyzer information",
]),
"help":
Command(0, self.__exec_help, None, ["", "Display this help"]),
"history":
Command(0, self.__exec_history, None, [
"",
"Display the command history",
]),
"save":
Command(0, self.__exec_save, None, [
"",
"Save the database (only symbols and history currently).",
]),
"load":
Command(1, self.__exec_load, self.__complete_load, [
"filename",
"Load a new binary file.",
]),
"lrawx86":
Command(1, self.__exec_lrawx86, self.__complete_load, [
"filename",
"Load a x86 raw file.",
]),
"lrawx64":
Command(1, self.__exec_lrawx64, self.__complete_load, [
"filename",
"Load a x64 raw file.",
]),
"lrawarm":
Command(1, self.__exec_lrawarm, self.__complete_load, [
"filename",
"Load a ARM raw file.",
]),
"lrawmips":
Command(1, self.__exec_lrawmips, self.__complete_load, [
"filename",
"Load a MIPS raw file.",
]),
"lrawmips64":
Command(1, self.__exec_lrawmips64, self.__complete_load, [
"filename",
"Load a MIPS64 raw file.",
]),
"x":
Command(1, self.__exec_x, self.__complete_x, [
"[SYMBOL|0xXXXX|EP]",
"Decompile and print on stdout. By default it will be main.",
"The decompilation is forced, it dosn't check if addresses",
"are defined as code."
]),
"v":
Command(1, self.__exec_v, self.__complete_x, [
"[SYMBOL|0xXXXX|EP]",
"Visual mode",
"Shortcuts:",
"c create code",
"p create function",
"x show xrefs",
"r rename",
"I switch to traditional instruction string output",
"g top",
"G bottom",
"z set current line on the middle",
"q quit",
"; edit inline comment (enter/escape to validate/cancel)",
"% goto next bracket",
"* highlight current word (ctrl-k to clear)",
"{ } previous/next paragraph",
"tab switch between dump/decompilation",
"enter follow address",
"escape go back",
"u re-enter (for undo)",
]),
"da":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in ascii, it stops when the end of the section is found",
]),
"db":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in bytes, it stops when the end of the section is found",
]),
"dd":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in dwords, it stops when the end of the section is found",
]),
"dw":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in words, it stops when the end of the section is found",
]),
"dq":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in qwords, it stops when the end of the section is found",
]),
# by default it will be gctx.nb_lines
"dump":
Command(2, self.__exec_dump, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Disassemble only.",
]),
"set":
Command(3, None, None, ["", "Set options"]),
"sym":
Command(3, self.__exec_sym, self.__complete_x, [
"[SYMBOL 0xXXXX] [| FILTER]",
"Print all symbols or set a new symbol.",
"You can filter symbols by searching the word FILTER.",
"If FILTER starts with -, the match is inversed."
]),
"exit":
Command(0, self.__exec_exit, None, ["", "Exit"]),
"sections":
Command(0, self.__exec_sections, None, [
"",
"Print all sections",
]),
"info":
Command(0, self.__exec_info, None,
["", "Information about the current binary"]),
"display.print_section":
Command(0, self.__exec_display_print_section, None,
["", "Print or not section when an address is found"]),
"jmptable":
Command(4, self.__exec_jmptable, None, [
"INST_ADDR TABLE_ADDR NB_ENTRIES SIZE_ENTRY",
"Create a jump table referenced at TABLE_ADDR and called",
"from INST_ADDR."
]),
"py":
Command(0, self.__exec_py, None,
["", "Run an interactive python shell."]),
"mips_set_gp":
Command(1, self.__exec_mips_set_gp, None,
["ADDR", "Set the register $gp to a fixed value."]),
"functions":
Command(1, self.__exec_functions, None,
["", "Print the function list."]),
"xrefs":
Command(1, self.__exec_xrefs, self.__complete_x,
["SYMBOL|0xXXXX|EP", "Print all xrefs."]),
}
self.analyzer = Analyzer()
self.analyzer.start()
rl = ReadLine(self.exec_command, self.complete, self.send_control_c)
self.rl = rl
if gctx.filename is not None:
self.__exec_load(["", gctx.filename])
rl.reload_cursor_line()
while 1:
rl.loop()
if not self.check_db_modified():
break
self.analyzer.msg.put("exit")
def __init__(self, gctx):
self.gctx = gctx
gctx.vim = False
self.COMMANDS = {
"analyzer": Command(
0,
self.__exec_analyzer,
None,
[
"",
"Analyzer information",
]
),
"push_analyze_symbols": Command(
0,
self.push_analyze_symbols,
None,
[
"",
"Force to analyze the entry point, symbols and a memory scan will be done.",
]
),
"help": Command(
0,
self.__exec_help,
None,
[
"",
"Display this help"
]
),
"history": Command(
0,
self.__exec_history,
None,
[
"",
"Display the command history",
]
),
"save": Command(
0,
self.__exec_save,
None,
[
"",
"Save the database (only symbols and history currently).",
]
),
"x": Command(
1,
self.__exec_x,
self.__complete_x,
[
"[SYMBOL|0xXXXX|EP]",
"Decompile and print on stdout. By default it will be main.",
"The decompilation is forced, it dosn't check if addresses",
"are defined as code."
]
),
"v": Command(
1,
self.__exec_v,
self.__complete_x,
[
"[SYMBOL|0xXXXX|EP]",
"Visual mode",
"Shortcuts:",
"c create code",
"b/w/d/Q create byte/word/dword/qword",
"a create ascii string",
"p create function",
"o set [d|q]word as an offset",
"x show xrefs",
"r rename",
"/ binary search: if the first char is ! you can put an",
" hexa string example: /!ab 13 42",
"n/N next/previous search occurence",
"I switch to traditional instruction string output",
"M show/hide mangling",
"B show/hide bytes",
"g top",
"G bottom",
"z set current line on the middle",
"Q quit",
"; edit inline comment (enter/escape to validate/cancel)",
"% goto next bracket",
"* highlight current word (ctrl-k to clear)",
"{ } previous/next paragraph",
"tab switch between dump/decompilation",
"enter follow address",
"escape go back",
"u re-enter (for undo)",
]
),
"da": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in ascii, it stops when the end of the section is found",
]
),
"db": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in bytes, it stops when the end of the section is found",
]
),
"dd": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in dwords, it stops when the end of the section is found",
]
),
"dw": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in words, it stops when the end of the section is found",
]
),
"dq": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in qwords, it stops when the end of the section is found",
]
),
# by default it will be gctx.nb_lines
"dump": Command(
2,
self.__exec_dump,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Disassemble only.",
]
),
"set": Command(
3,
None,
None,
[
"",
"Set options"
]
),
"sym": Command(
3,
self.__exec_sym,
self.__complete_x,
[
"[SYMBOL 0xXXXX] [| FILTER]",
"Print all symbols or set a new symbol.",
"You can filter symbols by searching the word FILTER.",
"If FILTER starts with -, the match is inversed."
]
),
"exit": Command(
0,
self.__exec_exit,
None,
[
"",
"Exit"
]
),
"sections": Command(
0,
self.__exec_sections,
None,
[
"",
"Print all sections",
]
),
"info": Command(
0,
self.__exec_info,
None,
[
"",
"Information about the current binary"
]
),
"display.print_section": Command(
0,
self.__exec_display_print_section,
None,
[
"",
"Print or not section when an address is found"
]
),
"jmptable": Command(
4,
self.__exec_jmptable,
None,
[
"INST_ADDR TABLE_ADDR NB_ENTRIES SIZE_ENTRY",
"Create a jump table referenced at TABLE_ADDR and called",
"from INST_ADDR."
]
),
"py": Command(
0,
self.__exec_py,
None,
[
"",
"Run an interactive python shell."
]
),
"mips_set_gp": Command(
1,
self.__exec_mips_set_gp,
None,
[
"ADDR",
"Set the register $gp to a fixed value."
]
),
"functions": Command(
1,
self.__exec_functions,
None,
[
"",
"Print the function list."
]
),
"xrefs": Command(
1,
self.__exec_xrefs,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP",
"Print all xrefs."
]
),
}
rl = ReadLine(self.exec_command, self.complete, self.send_control_c)
self.rl = rl
self.rl.history = gctx.db.history
self.analyzer = Analyzer()
self.analyzer.init()
self.analyzer.start()
self.analyzer.set(gctx)
if gctx.dis.binary.get_arch_string() == "MIPS" and \
gctx.dis.mips_gp == -1:
print("please run first these commands :")
print("mips_set_gp 0xADDRESS")
print("push_analyze_symbols")
else:
# It means that the first analysis was already done
if gctx.autoanalyzer and len(gctx.db.functions) == 0:
self.push_analyze_symbols(None)
rl.reload_cursor_line()
while 1:
rl.loop()
if not self.check_db_modified():
break
self.analyzer.msg.put("exit")
class Console():
COMMANDS = None
TAB = " "
MAX_PRINT_COMPLETE = 80
def __init__(self, gctx):
self.gctx = gctx
gctx.vim = False
self.COMMANDS = {
"analyzer": Command(
0,
self.__exec_analyzer,
None,
[
"",
"Analyzer information",
]
),
"push_analyze_symbols": Command(
0,
self.push_analyze_symbols,
None,
[
"",
"Force to analyze the entry point, symbols and a memory scan will be done.",
]
),
"help": Command(
0,
self.__exec_help,
None,
[
"",
"Display this help"
]
),
"history": Command(
0,
self.__exec_history,
None,
[
"",
"Display the command history",
]
),
"save": Command(
0,
self.__exec_save,
None,
[
"",
"Save the database (only symbols and history currently).",
]
),
"x": Command(
1,
self.__exec_x,
self.__complete_x,
[
"[SYMBOL|0xXXXX|EP]",
"Decompile and print on stdout. By default it will be main.",
"The decompilation is forced, it dosn't check if addresses",
"are defined as code."
]
),
"v": Command(
1,
self.__exec_v,
self.__complete_x,
[
"[SYMBOL|0xXXXX|EP]",
"Visual mode",
"Shortcuts:",
"c create code",
"b/w/d/Q create byte/word/dword/qword",
"a create ascii string",
"p create function",
"o set [d|q]word as an offset",
"x show xrefs",
"r rename",
"/ binary search: if the first char is ! you can put an",
" hexa string example: /!ab 13 42",
"n/N next/previous search occurence",
"I switch to traditional instruction string output",
"M show/hide mangling",
"B show/hide bytes",
"g top",
"G bottom",
"z set current line on the middle",
"Q quit",
"; edit inline comment (enter/escape to validate/cancel)",
"% goto next bracket",
"* highlight current word (ctrl-k to clear)",
"{ } previous/next paragraph",
"tab switch between dump/decompilation",
"enter follow address",
"escape go back",
"u re-enter (for undo)",
]
),
"da": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in ascii, it stops when the end of the section is found",
]
),
"db": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in bytes, it stops when the end of the section is found",
]
),
"dd": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in dwords, it stops when the end of the section is found",
]
),
"dw": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in words, it stops when the end of the section is found",
]
),
"dq": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in qwords, it stops when the end of the section is found",
]
),
# by default it will be gctx.nb_lines
"dump": Command(
2,
self.__exec_dump,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Disassemble only.",
]
),
"set": Command(
3,
None,
None,
[
"",
"Set options"
]
),
"sym": Command(
3,
self.__exec_sym,
self.__complete_x,
[
"[SYMBOL 0xXXXX] [| FILTER]",
"Print all symbols or set a new symbol.",
"You can filter symbols by searching the word FILTER.",
"If FILTER starts with -, the match is inversed."
]
),
"exit": Command(
0,
self.__exec_exit,
None,
[
"",
"Exit"
]
),
"sections": Command(
0,
self.__exec_sections,
None,
[
"",
"Print all sections",
]
),
"info": Command(
0,
self.__exec_info,
None,
[
"",
"Information about the current binary"
]
),
"display.print_section": Command(
0,
self.__exec_display_print_section,
None,
[
"",
"Print or not section when an address is found"
]
),
"jmptable": Command(
4,
self.__exec_jmptable,
None,
[
"INST_ADDR TABLE_ADDR NB_ENTRIES SIZE_ENTRY",
"Create a jump table referenced at TABLE_ADDR and called",
"from INST_ADDR."
]
),
"py": Command(
0,
self.__exec_py,
None,
[
"",
"Run an interactive python shell."
]
),
"mips_set_gp": Command(
1,
self.__exec_mips_set_gp,
None,
[
"ADDR",
"Set the register $gp to a fixed value."
]
),
"functions": Command(
1,
self.__exec_functions,
None,
[
"",
"Print the function list."
]
),
"xrefs": Command(
1,
self.__exec_xrefs,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP",
"Print all xrefs."
]
),
}
rl = ReadLine(self.exec_command, self.complete, self.send_control_c)
self.rl = rl
self.rl.history = gctx.db.history
self.analyzer = Analyzer()
self.analyzer.init()
self.analyzer.start()
self.analyzer.set(gctx)
if gctx.dis.binary.get_arch_string() == "MIPS" and \
gctx.dis.mips_gp == -1:
print("please run first these commands :")
print("mips_set_gp 0xADDRESS")
print("push_analyze_symbols")
else:
# It means that the first analysis was already done
if gctx.autoanalyzer and len(gctx.db.functions) == 0:
self.push_analyze_symbols(None)
rl.reload_cursor_line()
while 1:
rl.loop()
if not self.check_db_modified():
break
self.analyzer.msg.put("exit")
def check_db_modified(self):
if self.gctx.db is not None and self.gctx.db.modified:
print("the database was modified, run save or exit to force")
return True
return False
def send_control_c(self):
return
#
# Returns tuple :
# - list of completed string (i.e. rest of the current token)
# - string: the beginning of the current token
# - if len(list) > 1: it contains the common string between
# all possibilities
#
# Each sub-complete functions returns only the list.
#
def complete(self, line):
# If last_word == "_" it means that there was spaces before
# and we want to complete a new arg
tmp_line = line + "_"
tokens = shlex.split(tmp_line)
last_tok = tokens[-1][:-1] # remove the _
tmp_line = tmp_line[:-1]
comp = []
# Complete a command name
if len(tokens) == 1:
i = 0
for cmd in COMMANDS_ALPHA:
if cmd.startswith(last_tok):
# To keep spaces
comp.append(cmd[len(last_tok):] + " ")
i += 1
if i == self.MAX_PRINT_COMPLETE:
comp = None
break
else:
try:
first_tok = tokens[0]
f = self.COMMANDS[first_tok].callback_complete
if f is not None:
comp = f(tmp_line, len(tokens)-1, last_tok)
except KeyError:
pass
if comp is None:
print("\ntoo much possibilities")
return None, None, None
if len(comp) <= 1:
return comp, last_tok, None
common = []
words_idx = {len(word):i for i, word in enumerate(comp)}
min_len = min(words_idx)
ref = words_idx[min_len]
# Recreate because we have maybe removed words with same length
words_idx = set(range(len(comp)))
words_idx.remove(ref)
for i, char in enumerate(comp[ref]):
found = True
for j in words_idx:
if comp[j][i] != char:
found = False
break
if not found:
break
common.append(char)
return comp, last_tok, "".join(common)
def __complete_load(self, tmp_line, nth_arg, last_tok):
if nth_arg != 1:
return []
comp = []
basename = os.path.basename(last_tok)
dirname = os.path.dirname(last_tok)
if not dirname:
dirname = "."
try:
i = 0
for f in os.listdir(dirname):
if f.startswith(basename):
f_backslahed = f.replace(" ", "\\ ")
if os.path.isdir(os.path.join(dirname, f)):
s = f_backslahed + "/"
else:
s = f_backslahed + " "
comp.append(s[len(basename):])
i += 1
if i == self.MAX_PRINT_COMPLETE:
return None
return comp
except FileNotFoundError:
return []
def __complete_x(self, tmp_line, nth_arg, last_tok):
if nth_arg != 1 or self.gctx.dis is None:
return []
return self.__find_symbol(tmp_line, nth_arg, last_tok)
def __find_symbol(self, tmp_line, nth_arg, last_tok):
comp = []
i = 0
for sect in self.gctx.dis.binary.section_names:
if sect.startswith(last_tok):
comp.append((sect + " ")[len(last_tok):])
i += 1
if i == self.MAX_PRINT_COMPLETE:
return None
for sym in self.gctx.db.symbols:
if sym.startswith(last_tok):
comp.append((sym + " ")[len(last_tok):])
i += 1
if i == self.MAX_PRINT_COMPLETE:
return None
for sym in self.gctx.db.demangled:
if sym.startswith(last_tok):
comp.append((sym + " ")[len(last_tok):])
i += 1
if i == self.MAX_PRINT_COMPLETE:
return None
return comp
def exec_command(self, line):
args = shlex.split(line)
if args[0] not in self.COMMANDS:
error("unknown command")
return
c = self.COMMANDS[args[0]]
if len(args)-1 > c.max_args:
error("%s takes max %d args" % (args[0], c.max_args))
return
if c.callback_exec is not None:
c.callback_exec(args)
def __exec_exit(self, args):
self.analyzer.msg.put("exit")
sys.exit(0)
def __exec_dump(self, args):
if self.gctx.dis is None:
error("load a file before")
return
nb_lines = self.gctx.nb_lines
if len(args) == 3:
try:
nb_lines = int(args[2])
except:
pass
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
ctx.dump_asm(nb_lines).print()
def __exec_data(self, args):
if self.gctx.dis is None:
error("load a file before")
return
nb_lines = self.gctx.nb_lines
if len(args) <= 1:
self.gctx.entry = None
error("no address in parameter")
return
if len(args) == 3:
try:
nb_lines = int(args[2])
except:
pass
ctx = self.gctx.get_addr_context(args[1])
if ctx:
if args[0] == "da":
self.gctx.dis.dump_data_ascii(ctx, nb_lines)
elif args[0] == "db":
self.gctx.dis.dump_data(ctx, nb_lines, 1)
elif args[0] == "dw":
self.gctx.dis.dump_data(ctx, nb_lines, 2)
elif args[0] == "dd":
self.gctx.dis.dump_data(ctx, nb_lines, 4)
elif args[0] == "dq":
self.gctx.dis.dump_data(ctx, nb_lines, 8)
def push_analyze_symbols(self, args):
# Analyze all imports (it checks if functions return or not)
for ad in self.gctx.db.imports:
if self.gctx.dis.mem.is_func(ad):
self.analyzer.msg.put((ad, True, True, False, None))
# Analyze entry point
ep = self.gctx.dis.binary.get_entry_point()
if ep is not None:
self.analyzer.msg.put((ep, False, True, False, None))
# Re push defined functions
for ad in self.gctx.db.functions:
if ad not in self.gctx.db.imports:
self.analyzer.msg.put((ad, False, True, False, None))
# Analyze static functions
for ad in self.gctx.db.reverse_symbols:
if ad not in self.gctx.db.imports and self.gctx.dis.mem.is_func(ad):
self.analyzer.msg.put((ad, True, True, False, None))
self.analyzer.msg.put("pass_scan_mem")
def __exec_sym(self, args):
if self.gctx.dis is None:
error("load a file before")
return
if len(args) == 1:
self.gctx.dis.print_symbols(self.gctx.sectionsname)
return
if args[1][0] == "|":
if len(args) == 2 or len(args) > 3:
error("bad arguments (warn: need spaces between |)")
return
self.gctx.dis.print_symbols(self.gctx.sectionsname, args[2])
return
if len(args) > 3:
error("bad arguments")
return
if len(args) == 2:
error("an address is required to save the symbol")
return
if not args[2].startswith("0x"):
error("the address should starts with 0x")
return
if args[1].startswith("loc_"):
error("loc_ is a reserved prefix")
return
# Save new symbol
try:
if self.gctx.dis.has_reserved_prefix(args[1]):
error("this is a reserved prefix")
return
addr = int(args[2], 16)
self.gctx.db.modified = True
self.gctx.dis.add_symbol(addr, args[1])
except:
error("there was an error when creating a symbol")
def __exec_x(self, args):
if self.gctx.dis is None:
error("load a file before")
return
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
try:
o = ctx.decompile()
if o is not None:
o.print()
except:
traceback.print_exc()
def __exec_v(self, args):
if self.gctx.dis is None:
error("load a file before")
return
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
o = ctx.dump_asm(NB_LINES_TO_DISASM)
if o is not None:
Visual(self.gctx, ctx, self.analyzer)
def __exec_help(self, args):
for name in COMMANDS_ALPHA:
cmd = self.COMMANDS[name]
if cmd.callback_exec is not None:
self.rl.print(color(name, 2))
self.rl.print(" ")
for i, line in enumerate(cmd.desc):
if i > 0:
self.rl.print(self.TAB)
self.rl.print(line)
self.rl.print("\n")
def __exec_history(self, args):
for line in reversed(self.rl.history):
print(line)
def __exec_sections(self, args):
if self.gctx.dis is None:
error("load a file before")
return
self.rl.print("NAME".ljust(20))
self.rl.print(" [ START - END - VIRTUAL_SIZE - RAW_SIZE ]\n")
for s in self.gctx.dis.binary.iter_sections():
s.print_header()
def __exec_info(self, args):
if self.gctx.filename is None:
print("no file loaded")
return
print("File:", self.gctx.filename)
statinfo = os.stat(self.gctx.filename)
print("Size: %.2f ko" % (statinfo.st_size/1024.))
print_no_end("Type: ")
ty = self.gctx.dis.binary.type
if ty == T_BIN_PE:
print("PE")
elif ty == T_BIN_ELF:
print("ELF")
elif ty == T_BIN_RAW:
print("RAW")
import capstone as CAPSTONE
arch, mode = self.gctx.dis.binary.get_arch()
print_no_end("Arch: ")
if arch == CAPSTONE.CS_ARCH_X86:
if mode & CAPSTONE.CS_MODE_32:
print("x86")
elif mode & CAPSTONE.CS_MODE_64:
print("x64")
elif arch == CAPSTONE.CS_ARCH_ARM:
print("arm")
elif arch == CAPSTONE.CS_ARCH_MIPS:
if mode & CAPSTONE.CS_MODE_32:
print("mips")
elif mode & CAPSTONE.CS_MODE_64:
print("mips64 (octeon)")
else:
print("not supported")
if mode & CAPSTONE.CS_MODE_BIG_ENDIAN:
print("Endianess: big endian")
else:
print("Endianess: little endian")
def __exec_display_print_section(self, args):
if self.gctx.sectionsname:
print("now it's off")
self.gctx.sectionsname = False
else:
print("now it's on")
self.gctx.sectionsname = True
def __exec_save(self, args):
if self.gctx.dis is None:
error("load a file before")
return
self.gctx.db.save(self.rl.history)
print("database saved to", self.gctx.db.path)
self.gctx.db.modified = False
def __exec_jmptable(self, args):
if self.gctx.dis is None:
error("load a file before")
return
try:
inst_addr = int(args[1], 16)
table_addr = int(args[2], 16)
nb_entries = int(args[3])
entry_size = int(args[4])
except:
error("one parameter is invalid, be sure that addresses start with 0x")
return
if entry_size not in [2, 4, 8]:
error("error the entry size should be in [2, 4, 8]")
return
self.gctx.db.modified = True
self.gctx.dis.add_jmptable(inst_addr, table_addr, entry_size, nb_entries)
queue_wait_analyzer = Queue()
# Re-run the analyzer
func_id = self.gctx.dis.mem.get_func_id(inst_addr)
if func_id == -1:
self.analyzer.msg.put((inst_addr, False, True, queue_wait_analyzer))
else:
ad = self.gctx.dis.func_id[func_id]
self.analyzer.msg.put((ad, True, True, queue_wait_analyzer))
queue_wait_analyzer.get()
def __exec_py(self, args):
code.interact(local=locals())
def __exec_mips_set_gp(self, args):
if self.gctx.dis is None:
error("load a file before")
return
try:
self.gctx.dis.mips_gp = int(args[1], 16)
self.gctx.db.mips_gp = self.gctx.dis.mips_gp
except:
error("bad address")
self.gctx.db.modified = True
def __exec_functions(self, args):
if self.gctx.dis is None:
error("load a file before")
return
self.gctx.dis.print_functions()
def __exec_xrefs(self, args):
if self.gctx.dis is None:
error("load a file before")
return
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
if ctx.entry not in self.gctx.dis.xrefs:
return
ctx.dump_xrefs().print()
def __exec_analyzer(self, args):
print("addresses remaining to analyze:", self.analyzer.msg.qsize())
if self.analyzer.running_second_pass:
print("scan the whole memory...")
ad = self.analyzer.where
print(" -> %s: 0x%x" % (self.gctx.dis.binary.get_section(ad).name, ad))
def __init__(self, gctx):
self.gctx = gctx
gctx.vim = False
self.COMMANDS = {
"analyzer":
Command(0, self.__exec_analyzer, None, [
"",
"Analyzer information",
]),
"push_analyze_symbols":
Command(0, self.push_analyze_symbols, None, [
"",
"Force to analyze the entry point, symbols and a memory scan will be done.",
]),
"help":
Command(0, self.__exec_help, None, ["", "Display this help"]),
"history":
Command(0, self.__exec_history, None, [
"",
"Display the command history",
]),
"save":
Command(0, self.__exec_save, None, [
"",
"Save the database (only symbols and history currently).",
]),
"x":
Command(1, self.__exec_x, self.__complete_x, [
"[SYMBOL|0xXXXX|EP]",
"Decompile and print on stdout. By default it will be main.",
"The decompilation is forced, it dosn't check if addresses",
"are defined as code."
]),
"v":
Command(1, self.__exec_v, self.__complete_x, [
"[SYMBOL|0xXXXX|EP]",
"Visual mode",
"Shortcuts:",
"c create code",
"b/w/d/Q create byte/word/dword/qword",
"a create ascii string",
"p create function",
"o set [d|q]word as an offset",
"x show xrefs",
"r rename",
"/ binary search: if the first char is ! you can put an",
" hexa string example: /!ab 13 42",
"n/N next/previous search occurence",
"I switch to traditional instruction string output",
"M show/hide mangling",
"B show/hide bytes",
"g top",
"G bottom",
"z set current line on the middle",
"Q quit",
"; edit inline comment (enter/escape to validate/cancel)",
"% goto next bracket",
"* highlight current word (ctrl-k to clear)",
"{ } previous/next paragraph",
"tab switch between dump/decompilation",
"enter follow address",
"escape go back",
"u re-enter (for undo)",
]),
"da":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in ascii, it stops when the end of the section is found",
]),
"db":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in bytes, it stops when the end of the section is found",
]),
"dd":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in dwords, it stops when the end of the section is found",
]),
"dw":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in words, it stops when the end of the section is found",
]),
"dq":
Command(2, self.__exec_data, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in qwords, it stops when the end of the section is found",
]),
# by default it will be gctx.nb_lines
"dump":
Command(2, self.__exec_dump, self.__complete_x, [
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Disassemble only.",
]),
"set":
Command(3, None, None, ["", "Set options"]),
"sym":
Command(3, self.__exec_sym, self.__complete_x, [
"[SYMBOL 0xXXXX] [| FILTER]",
"Print all symbols or set a new symbol.",
"You can filter symbols by searching the word FILTER.",
"If FILTER starts with -, the match is inversed."
]),
"exit":
Command(0, self.__exec_exit, None, ["", "Exit"]),
"sections":
Command(0, self.__exec_sections, None, [
"",
"Print all sections",
]),
"info":
Command(0, self.__exec_info, None,
["", "Information about the current binary"]),
"display.print_section":
Command(0, self.__exec_display_print_section, None,
["", "Print or not section when an address is found"]),
"jmptable":
Command(4, self.__exec_jmptable, None, [
"INST_ADDR TABLE_ADDR NB_ENTRIES SIZE_ENTRY",
"Create a jump table referenced at TABLE_ADDR and called",
"from INST_ADDR."
]),
"py":
Command(0, self.__exec_py, None,
["", "Run an interactive python shell."]),
"mips_set_gp":
Command(1, self.__exec_mips_set_gp, None,
["ADDR", "Set the register $gp to a fixed value."]),
"functions":
Command(1, self.__exec_functions, None,
["", "Print the function list."]),
"xrefs":
Command(1, self.__exec_xrefs, self.__complete_x,
["SYMBOL|0xXXXX|EP", "Print all xrefs."]),
}
rl = ReadLine(self.exec_command, self.complete, self.send_control_c)
self.rl = rl
self.rl.history = gctx.db.history
self.analyzer = Analyzer()
self.analyzer.init()
self.analyzer.start()
self.analyzer.set(gctx)
if gctx.dis.binary.get_arch_string() == "MIPS" and \
gctx.dis.mips_gp == -1:
print("please run first these commands :")
print("mips_set_gp 0xADDRESS")
print("push_analyze_symbols")
else:
# It means that the first analysis was already done
if gctx.autoanalyzer and len(gctx.db.functions) == 0:
self.push_analyze_symbols(None)
rl.reload_cursor_line()
while 1:
rl.loop()
if not self.check_db_modified():
break
self.analyzer.msg.put("exit")
class Console():
COMMANDS = None
TAB = " "
def __init__(self, gctx):
self.gctx = gctx
self.db = gctx.db
gctx.vim = False
self.COMMANDS = {
"analyzer": Command(
0,
self.__exec_analyzer,
None,
[
"",
"Analyzer information",
]
),
"push_analyze_symbols": Command(
0,
self.push_analyze_symbols,
None,
[
"",
"Force to analyze the entry point, symbols and a memory scan will be done.",
]
),
"help": Command(
0,
self.__exec_help,
None,
[
"",
"Display this help"
]
),
"history": Command(
0,
self.__exec_history,
None,
[
"",
"Display the command history",
]
),
"save": Command(
0,
self.__exec_save,
None,
[
"",
"Save the database (only symbols and history currently).",
]
),
"x": Command(
1,
self.__exec_x,
self.__complete_x,
[
"[SYMBOL|0xXXXX|EP]",
"Decompile and print on stdout. By default it will be main.",
"The decompilation is forced, it dosn't check if addresses",
"are defined as code."
]
),
"v": Command(
1,
self.__exec_v,
self.__complete_x,
[
"[SYMBOL|0xXXXX|EP]",
"Visual mode",
"Shortcuts:",
"c create code",
"b/w/d/Q create byte/word/dword/qword",
"a create ascii string",
"p create function",
"o set [d|q]word as an offset",
"x show xrefs",
"r rename",
"/ binary search: if the first char is ! you can put an",
" hexa string example: /!ab 13 42",
"n/N next/previous search occurence",
"I switch to traditional instruction string output",
"M show/hide mangling",
"B show/hide bytes",
"g top",
"G bottom",
"z set current line on the middle",
"Q quit",
"; edit inline comment (enter/escape to validate/cancel)",
"% goto next bracket",
"* highlight current word (ctrl-k to clear)",
"{ } previous/next paragraph",
"tab switch between dump/decompilation",
"enter follow address",
"escape go back",
"u re-enter (for undo)",
]
),
"hexdump": Command(
2,
self.__exec_hexdump,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Dump memory in hexa."
]
),
# by default it will be gctx.nb_lines
"dump": Command(
2,
self.__exec_dump,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Disassemble only.",
]
),
"set": Command(
3,
None,
None,
[
"",
"Set options"
]
),
"sym": Command(
3,
self.__exec_sym,
self.__complete_x,
[
"[SYMBOL 0xXXXX] [| FILTER]",
"Print all symbols or set a new symbol.",
"You can filter symbols by searching the word FILTER.",
"If FILTER starts with -, the match is inversed."
]
),
"exit": Command(
0,
self.__exec_exit,
None,
[
"",
"Exit"
]
),
"sections": Command(
0,
self.__exec_sections,
None,
[
"",
"Print all sections",
]
),
"info": Command(
0,
self.__exec_info,
None,
[
"",
"Information about the current binary"
]
),
"display.print_section": Command(
0,
self.__exec_display_print_section,
None,
[
"",
"Print or not section when an address is found"
]
),
"jmptable": Command(
4,
self.__exec_jmptable,
None,
[
"INST_ADDR TABLE_ADDR NB_ENTRIES SIZE_ENTRY",
"Create a jump table referenced at TABLE_ADDR and called",
"from INST_ADDR."
]
),
"py": Command(
1,
self.__exec_py,
self.__complete_file,
[
"[FILE]",
"Run an interactive python shell or execute a script.",
"The global variable 'api' will be accessible."
]
),
"mips_set_gp": Command(
1,
self.__exec_mips_set_gp,
None,
[
"ADDR",
"Set the register $gp to a fixed value."
]
),
"functions": Command(
1,
self.__exec_functions,
None,
[
"",
"Print the function list."
]
),
"xrefs": Command(
1,
self.__exec_xrefs,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP",
"Print all xrefs."
]
),
}
self.analyzer = Analyzer()
self.analyzer.init()
self.analyzer.start()
self.api = Api(gctx, self.analyzer)
gctx.api = self.api
self.analyzer.set(gctx)
if gctx.dis.binary.get_arch_string() == "MIPS" and \
gctx.dis.mips_gp == -1:
print("please run first these commands :")
print("mips_set_gp 0xADDRESS")
print("push_analyze_symbols")
else:
# If false it means that the first analysis was already done
if gctx.autoanalyzer and len(self.db.mem) == 0:
self.push_analyze_symbols(None)
self.comp = Completer(self)
self.comp.set_history(self.db.history)
while 1:
self.comp.loop()
if SHOULD_EXIT:
break
if not self.check_db_modified():
break
self.analyzer.msg.put("exit")
def check_db_modified(self):
if self.db is not None and self.db.modified:
print("the database was modified, run save or exit to force")
return True
return False
def __complete_file(self, nth_arg, last_tok):
if nth_arg != 1:
return []
results = []
basename = os.path.basename(last_tok)
dirname = os.path.dirname(last_tok)
if not dirname:
dirname = "."
try:
i = 0
for f in os.listdir(dirname):
if f.startswith(basename):
f_backslahed = f.replace(" ", "\\ ")
if os.path.isdir(os.path.join(dirname, f)):
s = "%s/%s/" % (dirname, f_backslahed)
else:
s = "%s/%s " % (dirname, f_backslahed)
results.append(s)
i += 1
if i == MAX_PRINT_COMPLETE:
return None
return results
except FileNotFoundError:
return []
def __complete_x(self, nth_arg, last_tok):
if nth_arg != 1 or self.gctx.dis is None:
return []
return self.__find_symbol(nth_arg, last_tok)
def __find_symbol(self, nth_arg, last_tok):
results = []
i = 0
for sect in self.gctx.dis.binary.section_names:
if sect.startswith(last_tok):
results.append((sect + " "))
i += 1
if i == MAX_PRINT_COMPLETE:
return None
for sym in self.db.symbols:
if sym.startswith(last_tok):
results.append((sym + " "))
i += 1
if i == MAX_PRINT_COMPLETE:
return None
for sym in self.db.demangled:
if sym.startswith(last_tok):
results.append((sym + " "))
i += 1
if i == MAX_PRINT_COMPLETE:
return None
return results
def exec_command(self, line):
args = shlex.split(line)
if args[0] not in self.COMMANDS:
error("unknown command")
return
c = self.COMMANDS[args[0]]
if len(args)-1 > c.max_args:
error("%s takes max %d args" % (args[0], c.max_args))
return
if c.callback_exec is not None:
try:
c.callback_exec(args)
except:
traceback.print_exc()
def __exec_exit(self, args):
global SHOULD_EXIT
self.analyzer.msg.put("exit")
SHOULD_EXIT = True
def __exec_dump(self, args):
nb_lines = self.gctx.nb_lines
if len(args) == 3:
try:
nb_lines = int(args[2])
except:
pass
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
ctx.dump_asm(nb_lines).print()
def __exec_hexdump(self, args):
nb_lines = self.gctx.nb_lines
if len(args) <= 1:
self.gctx.entry = None
error("no address in parameter")
return
if len(args) == 3:
try:
nb_lines = int(args[2])
except:
pass
ctx = self.gctx.get_addr_context(args[1])
if ctx:
self.gctx.dis.hexdump(ctx, nb_lines)
def push_analyze_symbols(self, args):
# Analyze all imports (it checks if functions return or not)
for ad in self.db.imports:
if ad in self.db.functions and self.db.functions[ad] is None:
self.analyzer.msg.put((ad, True, True, False, None))
# Analyze entry point
ep = self.gctx.dis.binary.get_entry_point()
if ep is not None:
self.analyzer.msg.put((ep, False, True, False, None))
# Analyze static functions
for ad in self.db.reverse_symbols:
if ad not in self.db.imports and \
ad in self.db.functions and self.db.functions[ad] is None:
self.analyzer.msg.put((ad, True, False, False, None))
self.analyzer.msg.put("pass_scan_mem")
def __exec_sym(self, args):
if len(args) == 1:
self.gctx.dis.print_symbols(self.gctx.sectionsname)
return
if args[1][0] == "|":
if len(args) == 2 or len(args) > 3:
error("bad arguments (warn: need spaces between |)")
return
self.gctx.dis.print_symbols(self.gctx.sectionsname, args[2])
return
if len(args) > 3:
error("bad arguments")
return
if len(args) == 2:
error("an address is required to save the symbol")
return
if not args[2].startswith("0x"):
error("the address should starts with 0x")
return
if args[1].startswith("loc_"):
error("loc_ is a reserved prefix")
return
# Save new symbol
try:
if not self.api.add_symbol(int(args[2], 16), args[1]):
error("cannot rename")
return
self.db.modified = True
except:
error("there was an error when creating a symbol")
def __exec_x(self, args):
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
try:
o = ctx.decompile()
if o is not None:
o.print()
except:
traceback.print_exc()
def __exec_v(self, args):
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
o = ctx.dump_asm(NB_LINES_TO_DISASM)
if o is not None:
Visual(self.gctx, ctx, self.analyzer, self.api)
def __exec_help(self, args):
for name in COMMANDS_ALPHA:
cmd = self.COMMANDS[name]
if cmd.callback_exec is not None:
print_no_end(color(name, 2))
print_no_end(" ")
for i, line in enumerate(cmd.desc):
if i > 0:
print_no_end(self.TAB)
print(line)
def __exec_history(self, args):
for line in self.comp.get_history():
print(line)
def __exec_sections(self, args):
print_no_end("NAME".ljust(20))
print(" [ START - END - VIRTUAL_SIZE - RAW_SIZE ]")
for s in self.gctx.dis.binary.iter_sections():
s.print_header()
def __exec_info(self, args):
print("File:", self.gctx.filename)
statinfo = os.stat(self.gctx.filename)
print("Size: %.2f ko" % (statinfo.st_size/1024.))
print_no_end("Type: ")
ty = self.gctx.dis.binary.type
if ty == T_BIN_PE:
print("PE")
elif ty == T_BIN_ELF:
print("ELF")
elif ty == T_BIN_RAW:
print("RAW")
import capstone as CAPSTONE
arch, mode = self.gctx.dis.binary.get_arch()
print_no_end("Arch: ")
if arch == CAPSTONE.CS_ARCH_X86:
if mode & CAPSTONE.CS_MODE_32:
print("x86")
elif mode & CAPSTONE.CS_MODE_64:
print("x64")
elif arch == CAPSTONE.CS_ARCH_ARM:
print("arm")
elif arch == CAPSTONE.CS_ARCH_MIPS:
if mode & CAPSTONE.CS_MODE_32:
print("mips")
elif mode & CAPSTONE.CS_MODE_64:
print("mips64 (octeon)")
else:
print("not supported")
if mode & CAPSTONE.CS_MODE_BIG_ENDIAN:
print("Endianess: big endian")
else:
print("Endianess: little endian")
def __exec_display_print_section(self, args):
if self.gctx.sectionsname:
print("now it's off")
self.gctx.sectionsname = False
else:
print("now it's on")
self.gctx.sectionsname = True
def __exec_save(self, args):
self.db.save(self.comp.get_history())
print("database saved to", self.db.path)
self.db.modified = False
def __exec_jmptable(self, args):
try:
inst_addr = int(args[1], 16)
table_addr = int(args[2], 16)
nb_entries = int(args[3])
entry_size = int(args[4])
except:
error("one parameter is invalid, be sure that addresses start with 0x")
return
if entry_size not in [2, 4, 8]:
error("error the entry size should be in [2, 4, 8]")
return
self.db.modified = True
self.api.create_jmptable(inst_addr, table_addr, entry_size, nb_entries)
def __exec_py(self, args):
ns = {"api": self.api}
if len(args) == 2:
exec(open(args[1]).read(), ns)
else:
readline.set_completer(rlcompleter.Completer(ns).complete)
code.interact(local=ns)
readline.set_completer(self.comp.complete)
def __exec_mips_set_gp(self, args):
try:
self.gctx.dis.mips_gp = int(args[1], 16)
self.db.mips_gp = self.gctx.dis.mips_gp
except:
error("bad address")
self.db.modified = True
def __exec_functions(self, args):
self.gctx.dis.print_functions(self.api)
def __exec_xrefs(self, args):
ad = None if len(args) == 1 else args[1]
ctx = self.gctx.get_addr_context(ad)
if ctx:
if ctx.entry not in self.gctx.dis.xrefs:
return
ctx.dump_xrefs().print()
def __exec_analyzer(self, args):
print("addresses remaining to analyze:", self.analyzer.msg.qsize())
if self.analyzer.running_second_pass:
print("scan the whole memory...")
ad = self.analyzer.where
print(" -> %s: 0x%x" % (self.gctx.dis.binary.get_section(ad).name, ad))
def __init__(self, gctx):
self.gctx = gctx
gctx.vim = False
self.COMMANDS_ALPHA = [
"analyzer",
"da",
"db",
"dd",
"dw",
"dq",
"dump",
"exit",
"functions",
"help",
"history",
"info",
"jmptable",
"load",
"lrawarm",
"lrawmips",
"lrawmips64",
"lrawx86",
"lrawx64",
"mips_set_gp",
"py",
"save",
"sections",
"sym",
"x",
"v",
"display.print_section",
"xrefs",
]
self.COMMANDS = {
"analyzer": Command(
0,
self.__exec_analyzer,
None,
[
"",
"Analyzer information",
]
),
"help": Command(
0,
self.__exec_help,
None,
[
"",
"Display this help"
]
),
"history": Command(
0,
self.__exec_history,
None,
[
"",
"Display the command history",
]
),
"save": Command(
0,
self.__exec_save,
None,
[
"",
"Save the database (only symbols and history currently).",
]
),
"load": Command(
1,
self.__exec_load,
self.__complete_load,
[
"filename",
"Load a new binary file.",
]
),
"lrawx86": Command(
1,
self.__exec_lrawx86,
self.__complete_load,
[
"filename",
"Load a x86 raw file.",
]
),
"lrawx64": Command(
1,
self.__exec_lrawx64,
self.__complete_load,
[
"filename",
"Load a x64 raw file.",
]
),
"lrawarm": Command(
1,
self.__exec_lrawarm,
self.__complete_load,
[
"filename",
"Load a ARM raw file.",
]
),
"lrawmips": Command(
1,
self.__exec_lrawmips,
self.__complete_load,
[
"filename",
"Load a MIPS raw file.",
]
),
"lrawmips64": Command(
1,
self.__exec_lrawmips64,
self.__complete_load,
[
"filename",
"Load a MIPS64 raw file.",
]
),
"x": Command(
1,
self.__exec_x,
self.__complete_x,
[
"[SYMBOL|0xXXXX|EP]",
"Decompile and print on stdout. By default it will be main.",
"The decompilation is forced, it dosn't check if addresses",
"are defined as code."
]
),
"v": Command(
1,
self.__exec_v,
self.__complete_x,
[
"[SYMBOL|0xXXXX|EP]",
"Visual mode",
"Shortcuts:",
"c create code",
"b/w/d/Q create byte/word/dword/qword",
"a create ascii string",
"p create function",
"o set [d|q]word as an offset",
"x show xrefs",
"r rename",
"I switch to traditional instruction string output",
"g top",
"G bottom",
"z set current line on the middle",
"Q quit",
"; edit inline comment (enter/escape to validate/cancel)",
"% goto next bracket",
"* highlight current word (ctrl-k to clear)",
"{ } previous/next paragraph",
"tab switch between dump/decompilation",
"enter follow address",
"escape go back",
"u re-enter (for undo)",
]
),
"da": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in ascii, it stops when the end of the section is found",
]
),
"db": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in bytes, it stops when the end of the section is found",
]
),
"dd": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in dwords, it stops when the end of the section is found",
]
),
"dw": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in words, it stops when the end of the section is found",
]
),
"dq": Command(
2,
self.__exec_data,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Print data in qwords, it stops when the end of the section is found",
]
),
# by default it will be gctx.nb_lines
"dump": Command(
2,
self.__exec_dump,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP [NB_LINES]",
"Disassemble only.",
]
),
"set": Command(
3,
None,
None,
[
"",
"Set options"
]
),
"sym": Command(
3,
self.__exec_sym,
self.__complete_x,
[
"[SYMBOL 0xXXXX] [| FILTER]",
"Print all symbols or set a new symbol.",
"You can filter symbols by searching the word FILTER.",
"If FILTER starts with -, the match is inversed."
]
),
"exit": Command(
0,
self.__exec_exit,
None,
[
"",
"Exit"
]
),
"sections": Command(
0,
self.__exec_sections,
None,
[
"",
"Print all sections",
]
),
"info": Command(
0,
self.__exec_info,
None,
[
"",
"Information about the current binary"
]
),
"display.print_section": Command(
0,
self.__exec_display_print_section,
None,
[
"",
"Print or not section when an address is found"
]
),
"jmptable": Command(
4,
self.__exec_jmptable,
None,
[
"INST_ADDR TABLE_ADDR NB_ENTRIES SIZE_ENTRY",
"Create a jump table referenced at TABLE_ADDR and called",
"from INST_ADDR."
]
),
"py": Command(
0,
self.__exec_py,
None,
[
"",
"Run an interactive python shell."
]
),
"mips_set_gp": Command(
1,
self.__exec_mips_set_gp,
None,
[
"ADDR",
"Set the register $gp to a fixed value."
]
),
"functions": Command(
1,
self.__exec_functions,
None,
[
"",
"Print the function list."
]
),
"xrefs": Command(
1,
self.__exec_xrefs,
self.__complete_x,
[
"SYMBOL|0xXXXX|EP",
"Print all xrefs."
]
),
}
self.analyzer = Analyzer()
self.analyzer.start()
rl = ReadLine(self.exec_command, self.complete, self.send_control_c)
self.rl = rl
if gctx.filename is not None:
self.__exec_load(["", gctx.filename])
rl.reload_cursor_line()
while 1:
rl.loop()
if not self.check_db_modified():
break
self.analyzer.msg.put("exit")