def test_set_and_get(idadir):
from bap.utils.config import get, set, is_set
for path in ('foo', 'foo.bar'):
assert get(path) is None
set(path, 'hello')
assert get(path) == 'hello'
assert not is_set(path)
set(path, 'true')
assert is_set(path)
def __init__(self, symbols=True):
try:
check_and_configure_bap()
except:
idc.Message('BAP> configuration failed\n{0}\n'.
format(str(sys.exc_info())))
traceback.print_exc()
raise BapIdaError()
bap = config.get('bap_executable_path')
if bap is None or not os.access(bap, os.X_OK):
idc.Warning('''
The bap application is either not found or is not an executable.
Please install bap or, if it is installed, provide a path to it.
Installation instructions are available at: http://bap.ece.cmu.edu.
''')
raise BapNotFound()
binary = idaapi.get_input_file_path()
super(BapIda, self).__init__(bap, binary)
# if you run IDA inside IDA you will crash IDA
self.args.append('--no-ida')
self._on_finish = []
self._on_cancel = []
self._on_failed = []
if symbols:
self._setup_symbols()
headers = config.is_set('ida_api.enabled')
if headers:
self._setup_headers(bap)
def test_check_and_configure_bap(bappath, askbap, idadir):
from bap.utils.run import check_and_configure_bap
from bap.utils import config
check_and_configure_bap()
bap = config.get('bap_executable_path')
expected = {'clever': bappath, 'stupid': None}
assert bap == expected[askbap['user']]
def __init__(self, symbols=True):
try:
check_and_configure_bap()
except:
idc.Message('BAP> configuration failed\n{0}\n'.format(
str(sys.exc_info())))
traceback.print_exc()
raise BapIdaError()
bap = config.get('bap_executable_path')
if bap is None or not os.access(bap, os.X_OK):
idc.Warning('''
The bap application is either not found or is not an executable.
Please install bap or, if it is installed, provide a path to it.
Installation instructions are available at: http://bap.ece.cmu.edu.
''')
raise BapNotFound()
binary = idaapi.get_input_file_path()
super(BapIda, self).__init__(bap, binary)
# if you run IDA inside IDA you will crash IDA
self.args.append('--no-ida')
self._on_finish = []
self._on_cancel = []
self._on_failed = []
if symbols:
self._setup_symbols()
headers = config.is_set('ida_api.enabled')
if headers:
self._setup_headers(bap)
def test_check_and_configure_bap(bappath, askbap, idadir):
from bap.utils.run import check_and_configure_bap
from bap.utils import config
check_and_configure_bap()
bap = config.get('bap_executable_path')
expected = {
'clever': bappath,
'stupid': None
}
assert bap == expected[askbap['user']]
def config_path():
if config.get('bap_executable_path') is not None:
return
default_bap_path = ''
from subprocess import check_output, CalledProcessError
import os
try:
default_bap_path = check_output(['which', 'bap']).strip()
except (OSError, CalledProcessError) as e:
# Cannot run 'which' command OR
# 'which' could not find 'bap'
try:
default_bap_path = os.path.join(
check_output(['opam', 'config', 'var', 'bap:bin']).strip(),
'bap'
)
except OSError:
# Cannot run 'opam'
pass
if not default_bap_path.endswith('bap'):
default_bap_path = ''
def confirm(msg):
from idaapi import askyn_c, ASKBTN_CANCEL, ASKBTN_YES
return askyn_c(ASKBTN_CANCEL, msg) == ASKBTN_YES
while True:
bap_path = idaapi.askfile_c(False, default_bap_path, 'Path to bap')
if bap_path is None:
if confirm('Are you sure you don\'t want to set path?'):
return
else:
continue
if not bap_path.endswith('bap'):
if not confirm("Path does not end with bap. Confirm?"):
continue
if not os.path.isfile(bap_path):
if not confirm("Path does not point to a file. Confirm?"):
continue
break
config.set('bap_executable_path', bap_path)
def config_path():
if config.get('bap_executable_path') is not None:
return
default_bap_path = ''
from subprocess import check_output, CalledProcessError
import os
try:
default_bap_path = check_output(['which', 'bap']).strip()
except (OSError, CalledProcessError) as e:
# Cannot run 'which' command OR
# 'which' could not find 'bap'
try:
default_bap_path = os.path.join(
check_output(['opam', 'config', 'var', 'bap:bin']).strip(),
'bap')
except OSError:
# Cannot run 'opam'
pass
if not default_bap_path.endswith('bap'):
default_bap_path = ''
def confirm(msg):
from idaapi import askyn_c, ASKBTN_CANCEL, ASKBTN_YES
return askyn_c(ASKBTN_CANCEL, msg) == ASKBTN_YES
while True:
bap_path = idaapi.askfile_c(False, default_bap_path, 'Path to bap')
if bap_path is None:
if confirm('Are you sure you don\'t want to set path?'):
return
else:
continue
if not bap_path.endswith('bap'):
if not confirm("Path does not end with bap. Confirm?"):
continue
if not os.path.isfile(bap_path):
if not confirm("Path does not point to a file. Confirm?"):
continue
break
config.set('bap_executable_path', bap_path)
def check_and_configure_bap():
"""Ensures that bap location is known."""
if not config.get('bap_executable_path'):
path = ask_user(bap.find())
if path and len(path) > 0:
config.set('bap_executable_path', path)
def run_bap_with(argument_string, no_extras=False):
"""
Run bap with the given argument_string.
Uses the currently open file, dumps latest symbols from IDA and runs
BAP with the argument_string
Also updates the 'BAP View'
Note: If no_extras is set to True, then none of the extra work mentioned
above is done, and instead, bap is just run purely using
bap <executable> <argument_string>
"""
from bap.plugins.bap_view import BAP_View
from bap.utils import config
import ida
import idc
import tempfile
check_and_configure_bap()
bap_executable_path = config.get('bap_executable_path')
if bap_executable_path is None:
return # The user REALLY doesn't want us to run it
args = {
'bap_executable_path': bap_executable_path,
'bap_output_file': tempfile.mkstemp(suffix='.out',
prefix='ida-bap-')[1],
'input_file_path': idc.GetInputFilePath(),
'symbol_file_location': tempfile.mkstemp(suffix='.sym',
prefix='ida-bap-')[1],
'header_path': tempfile.mkstemp(suffix='.h', prefix='ida-bap-')[1],
'remaining_args': argument_string
}
if no_extras:
command = (
"\
\"{bap_executable_path}\" \"{input_file_path}\" \
{remaining_args} \
> \"{bap_output_file}\" 2>&1 \
".format(**args)
)
else:
bap_api_enabled = (config.get('enabled',
default='0',
section='bap_api').lower() in
('1', 'true', 'yes'))
ida.dump_symbol_info(args['symbol_file_location'])
if bap_api_enabled:
ida.dump_c_header(args['header_path'])
idc.Exec(
"\
\"{bap_executable_path}\" \
--api-add=c:\"{header_path}\" \
".format(**args)
)
command = (
"\
\"{bap_executable_path}\" \"{input_file_path}\" \
--read-symbols-from=\"{symbol_file_location}\" \
--symbolizer=file \
--rooter=file \
{remaining_args} \
-d > \"{bap_output_file}\" 2>&1 \
".format(**args)
)
idc.Exec(command)
with open(args['bap_output_file'], 'r') as f:
BAP_View.update(
"BAP execution string\n" +
"--------------------\n" +
"\n" +
'\n --'.join(command.strip().split('--')) +
"\n" +
"\n" +
"Output\n" +
"------\n" +
"\n" +
f.read()
)
# Force close BAP View
# This forces the user to re-open the new view if needed
# This "hack" is needed since IDA decides to give a different BAP_View
# class here, than the cls parameter it sends to BAP_View
# TODO: Fix this
import idaapi
tf = idaapi.find_tform("BAP View")
if tf:
idaapi.close_tform(tf, 0)
# Do a cleanup of all the temporary files generated/added
if not no_extras:
if bap_api_enabled:
idc.Exec(
"\
\"{bap_executable_path}\" \
--api-remove=c:`basename \"{header_path}\"` \
".format(**args)
)
idc.Exec(
"\
rm -f \
\"{symbol_file_location}\" \
\"{header_path}\" \
\"{bap_output_file}\" \
".format(**args)
)
def config_bap_api():
if config.get('enabled', section='bap_api') is None:
config.set('enabled', '1', section='bap_api')
def run_bap_with(argument_string):
"""
Run bap with the given argument_string.
Uses the currently open file, dumps latest symbols from IDA and runs
BAP with the argument_string
Also updates the 'BAP View'
"""
from bap.plugins.bap_view import BAP_View
from bap.utils import config
import ida
import idc
import tempfile
check_and_configure_bap()
bap_executable_path = config.get('bap_executable_path')
if bap_executable_path is None:
return # The user REALLY doesn't want us to run it
args = {
'bap_executable_path':
bap_executable_path,
'bap_output_file':
tempfile.mkstemp(suffix='.out', prefix='ida-bap-')[1],
'input_file_path':
idc.GetInputFilePath(),
'symbol_file_location':
tempfile.mkstemp(suffix='.sym', prefix='ida-bap-')[1],
'header_path':
tempfile.mkstemp(suffix='.h', prefix='ida-bap-')[1],
'remaining_args':
argument_string
}
bap_api_enabled = (config.get('enabled', default='0',
section='bap_api').lower()
in ('1', 'true', 'yes'))
ida.dump_symbol_info(args['symbol_file_location'])
if bap_api_enabled:
ida.dump_c_header(args['header_path'])
idc.Exec("\
\"{bap_executable_path}\" \
--api-add=c:\"{header_path}\" \
".format(**args))
command = ("\
\"{bap_executable_path}\" \"{input_file_path}\" \
--read-symbols-from=\"{symbol_file_location}\" --symbolizer=file \
{remaining_args} \
-d > \"{bap_output_file}\" 2>&1 \
".format(**args))
idc.Exec(command)
with open(args['bap_output_file'], 'r') as f:
BAP_View.update("BAP execution string\n" + "--------------------\n" +
"\n" + '\n --'.join(('bap' +
argument_string).split('--')) +
"\n" + "\n" + "Output\n" + "------\n" + "\n" +
f.read())
# Force close BAP View
# This forces the user to re-open the new view if needed
# This "hack" is needed since IDA decides to give a different BAP_View
# class here, than the cls parameter it sends to BAP_View
# TODO: Fix this
import idaapi
tf = idaapi.find_tform("BAP View")
if tf:
idaapi.close_tform(tf, 0)
# Do a cleanup of all the temporary files generated/added
if bap_api_enabled:
idc.Exec("\
\"{bap_executable_path}\" \
--api-remove=c:`basename \"{header_path}\"` \
".format(**args))
idc.Exec("\
rm -f \
\"{symbol_file_location}\" \
\"{header_path}\" \
\"{bap_output_file}\" \
".format(**args))
def config_bap_api():
if config.get('enabled', section='bap_api') is None:
config.set('enabled', '1', section='bap_api')
def check_and_configure_bap():
"""Ensures that bap location is known."""
if not config.get('bap_executable_path'):
path = ask_user(bap.find())
if path and len(path) > 0:
config.set('bap_executable_path', path)
