Skip to content

Commit

Permalink
Blacken
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Hennenfent committed Jul 10, 2020
1 parent e5501ff commit 7abbe16
Show file tree
Hide file tree
Showing 20 changed files with 20,713 additions and 9,502 deletions.
66 changes: 52 additions & 14 deletions __init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,57 +3,78 @@
from .gui import explain_window
from .instruction_state import get_state
from .explain import explain_llil, fold_multi_il
from .util import get_function_at, find_mlil, find_llil, find_lifted_il, inst_in_func, dereference_symbols
from .util import (
get_function_at,
find_mlil,
find_llil,
find_lifted_il,
inst_in_func,
dereference_symbols,
)

import traceback

arch = None
architecture_specific_explanation_function = lambda *_: (False, ["Architecture-specific explanations unavailable"])
architecture_specific_explanation_function = lambda *_: (
False,
["Architecture-specific explanations unavailable"],
)


def init_plugin(bv):
""" Creates the plugin window and sets up the architecture-specfic functions """
global arch, architecture_specific_explanation_function

# Sets up architecture-specific functions
if bv.arch.name != arch:
if 'x86' in bv.arch.name:
if "x86" in bv.arch.name:
from .x86 import get_doc_url
from .x86.explain import arch_explain_instruction as arch_explain

explain_window().get_doc_url = get_doc_url
architecture_specific_explanation_function = arch_explain
elif 'mips' in bv.arch.name:
elif "mips" in bv.arch.name:
from .mips import get_doc_url
from .mips.explain import arch_explain_instruction as arch_explain

explain_window().get_doc_url = get_doc_url
architecture_specific_explanation_function = arch_explain
elif 'aarch64' in bv.arch.name:
elif "aarch64" in bv.arch.name:
from .aarch64 import get_doc_url
from .aarch64.explain import arch_explain_instruction as arch_explain

explain_window().get_doc_url = get_doc_url
architecture_specific_explanation_function = arch_explain
elif 'arm' in bv.arch.name or 'thumb' in bv.arch.name: # Note: completely untested on thumb2. I couldn't find a test binary.
elif (
"arm" in bv.arch.name or "thumb" in bv.arch.name
): # Note: completely untested on thumb2. I couldn't find a test binary.
from .ual import get_doc_url
from .ual.explain import arch_explain_instruction as arch_explain

explain_window().get_doc_url = get_doc_url
architecture_specific_explanation_function = arch_explain
elif '6502' in bv.arch.name:
elif "6502" in bv.arch.name:
from .asm6502 import get_doc_url
from .asm6502.explain import arch_explain_instruction as arch_explain

explain_window().get_doc_url = get_doc_url
architecture_specific_explanation_function = arch_explain
elif 'msp430' in bv.arch.name:
elif "msp430" in bv.arch.name:
from .msp430 import get_doc_url
from .msp430.explain import arch_explain_instruction as arch_explain

explain_window().get_doc_url = get_doc_url
architecture_specific_explanation_function = arch_explain
elif 'powerpc' in bv.arch.name:
elif "powerpc" in bv.arch.name:
# PowerPC support will likely be added in Binja v1.1; may need to change the arch name
from .powerpc import get_doc_url
from .powerpc.explain import arch_explain_instruction as arch_explain

explain_window().get_doc_url = get_doc_url
architecture_specific_explanation_function = arch_explain
arch = bv.arch.name


def explain_instruction(bv, addr):
""" Callback for the menu item that passes the information to the GUI """
init_plugin(bv)
Expand All @@ -71,21 +92,30 @@ def explain_instruction(bv, addr):

# Give the architecture submodule a chance to supply an explanation for this instruction that takes precedence
# over the one generated via the LLIL
should_supersede_llil, explanation_list = architecture_specific_explanation_function(bv, instruction, lifted_il_list)
(
should_supersede_llil,
explanation_list,
) = architecture_specific_explanation_function(bv, instruction, lifted_il_list)

# Display the raw instruction
try:
explain_window().instruction = "{addr}: {inst}".format(addr=hex(addr).replace("L", ""), inst=instruction)
explain_window().instruction = "{addr}: {inst}".format(
addr=hex(addr).replace("L", ""), inst=instruction
)
except Exception:
traceback.print_exc()

if len(explanation_list) > 0:
if should_supersede_llil:
# If we got an architecture-specific explanation and it should supersede the LLIL, use that
explain_window().description = [explanation for explanation in explanation_list]
explain_window().description = [
explanation for explanation in explanation_list
]
else:
# Otherwise, just prepend the arch-specific explanation to the LLIL explanation
explain_window().description = [explanation for explanation in explanation_list] + [explain_llil(bv, llil) for llil in (parse_il)]
explain_window().description = [
explanation for explanation in explanation_list
] + [explain_llil(bv, llil) for llil in (parse_il)]
else:
# By default, we just use the LLIL explanation
# We append the line number if we're displaying a conditional.
Expand All @@ -96,7 +126,14 @@ def explain_instruction(bv, addr):
explain_window().mlil = [dereference_symbols(bv, mlil) for mlil in mlil_list]

# Pass in the flags, straight from the API. We don't do much with these, but they might make things more clear
explain_window().flags = [(func.get_flags_read_by_lifted_il_instruction(lifted.instr_index), func.get_flags_written_by_lifted_il_instruction(lifted.instr_index), lifted) for lifted in lifted_il_list]
explain_window().flags = [
(
func.get_flags_read_by_lifted_il_instruction(lifted.instr_index),
func.get_flags_written_by_lifted_il_instruction(lifted.instr_index),
lifted,
)
for lifted in lifted_il_list
]

# Display what information we can calculate about the program state before the instruction is executed
try:
Expand All @@ -106,4 +143,5 @@ def explain_instruction(bv, addr):

explain_window().show()


PluginCommand.register_for_address("Explain Instruction", "", explain_instruction)
Loading

0 comments on commit 7abbe16

Please sign in to comment.