Change indentation to match codebase
This commit is contained in:
ex0dus-0x
parent
9a3399073b
commit
3831b25e63
@ -19,133 +19,133 @@ import argparse
|
|||||||
import functools
|
import functools
|
||||||
|
|
||||||
class DeepStateFrontend(object):
|
class DeepStateFrontend(object):
|
||||||
|
"""
|
||||||
|
Defines a base front-end object for using DeepState to interact with fuzzers. Base object designed
|
||||||
|
around `afl-fuzz` front-end as default.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, name, compiler=None, envvar="PATH"):
|
||||||
"""
|
"""
|
||||||
Defines a base front-end object for using DeepState to interact with fuzzers. Base object designed
|
initializes base object with fuzzer executable and path, and checks to see if fuzzer
|
||||||
around `afl-fuzz` front-end as default.
|
executable exists in supplied environment variable (default is $PATH).
|
||||||
|
|
||||||
|
optionally also sets path to compiler executable for compile-time instrumentation,
|
||||||
|
for those fuzzers that support it.
|
||||||
|
"""
|
||||||
|
if os.environ.get(envvar) is None:
|
||||||
|
raise RuntimeError(f"${envvar} does not contain any known paths.")
|
||||||
|
|
||||||
|
# collect paths from envvar, and check to see if fuzzer executable is present in paths
|
||||||
|
potential_paths = [var for var in os.environ.get(envvar).split(":")]
|
||||||
|
fuzzer_paths = [f"{path}/{name}" for path in potential_paths if os.path.isfile(path + '/' + name)]
|
||||||
|
if len(fuzzer_paths) == 0:
|
||||||
|
raise RuntimeError(f"${envvar} does not contain supplied fuzzer executable.")
|
||||||
|
|
||||||
|
# if supplied, check if compiler exists in potential_paths
|
||||||
|
if compiler is not None:
|
||||||
|
compiler_paths = [f"{path}/{compiler}" for path in potential_paths if os.path.isfile(path + '/' + compiler)]
|
||||||
|
if len(compiler_paths) == 0:
|
||||||
|
|
||||||
|
# check to see if user supplied absolute path
|
||||||
|
if os.path.is_file(compiler):
|
||||||
|
self.compiler = compiler
|
||||||
|
else:
|
||||||
|
raise RuntimeError(f"{compiler} does not exist as absolute path or in ${envvar}")
|
||||||
|
|
||||||
|
# use first compiler executable if multiple exists
|
||||||
|
self.compiler = compiler_path[0]
|
||||||
|
|
||||||
|
|
||||||
|
# in case name supplied as `bin/fuzzer`, strip executable name
|
||||||
|
if '/' in name:
|
||||||
|
self.name = name.split('/')[-1]
|
||||||
|
else:
|
||||||
|
self.name = name
|
||||||
|
|
||||||
|
# use first fuzzer executable path if multiple exists
|
||||||
|
self.fuzzer = fuzzer_paths[0]
|
||||||
|
|
||||||
|
|
||||||
|
def compile(self, flags):
|
||||||
|
"""
|
||||||
|
provides an interface for calling a compiler to instrument a test harness for
|
||||||
|
mutation-based fuzzers
|
||||||
|
"""
|
||||||
|
if self.compiler is None:
|
||||||
|
raise RuntimeError(f"No compiler specified for compile-time instrumentation.")
|
||||||
|
|
||||||
|
self.compile_cmd = [self.compiler, flags]
|
||||||
|
try:
|
||||||
|
r = subprocess.call(self.compile_cmd)
|
||||||
|
except BaseException as e:
|
||||||
|
raise RuntimeError(f"{self.compiler} interrupted due to exception:", e)
|
||||||
|
|
||||||
|
|
||||||
|
def cli_command(self, cmd_dict, compiler=None, cli_other=None):
|
||||||
|
"""
|
||||||
|
provides an interface for constructing proper command to be passed
|
||||||
|
to fuzzer cli executable.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, name, compiler=None, envvar="PATH"):
|
# turn arg mapping into viable cli args
|
||||||
"""
|
cmd_args = list(functools.reduce(lambda key, val: key + val, cmd_dict.items()))
|
||||||
initializes base object with fuzzer executable and path, and checks to see if fuzzer
|
cmd_args = [arg for arg in cmd_args if arg is not None]
|
||||||
executable exists in supplied environment variable (default is $PATH).
|
|
||||||
|
|
||||||
optionally also sets path to compiler executable for compile-time instrumentation,
|
# prepends compiler executable if specified
|
||||||
for those fuzzers that support it.
|
if compiler is not None:
|
||||||
"""
|
self.cmd = [compiler, self.fuzzer]
|
||||||
if os.environ.get(envvar) is None:
|
else:
|
||||||
raise RuntimeError(f"${envvar} does not contain any known paths.")
|
self.cmd = [self.fuzzer]
|
||||||
|
|
||||||
# collect paths from envvar, and check to see if fuzzer executable is present in paths
|
# create command to execute by fuzzer, append any other optional arguments
|
||||||
potential_paths = [var for var in os.environ.get(envvar).split(":")]
|
self.cmd += cmd_args
|
||||||
fuzzer_paths = [f"{path}/{name}" for path in potential_paths if os.path.isfile(path + '/' + name)]
|
if cli_other is not None:
|
||||||
if len(fuzzer_paths) == 0:
|
self.cmd += cli_other
|
||||||
raise RuntimeError(f"${envvar} does not contain supplied fuzzer executable.")
|
|
||||||
|
|
||||||
# if supplied, check if compiler exists in potential_paths
|
|
||||||
if compiler is not None:
|
|
||||||
compiler_paths = [f"{path}/{compiler}" for path in potential_paths if os.path.isfile(path + '/' + compiler)]
|
|
||||||
if len(compiler_paths) == 0:
|
|
||||||
|
|
||||||
# check to see if user supplied absolute path
|
|
||||||
if os.path.is_file(compiler):
|
|
||||||
self.compiler = compiler
|
|
||||||
else:
|
|
||||||
raise RuntimeError(f"{compiler} does not exist as absolute path or in ${envvar}")
|
|
||||||
|
|
||||||
# use first compiler executable if multiple exists
|
|
||||||
self.compiler = compiler_path[0]
|
|
||||||
|
|
||||||
|
|
||||||
# in case name supplied as `bin/fuzzer`, strip executable name
|
def execute_fuzzer(self):
|
||||||
if '/' in name:
|
"""
|
||||||
self.name = name.split('/')[-1]
|
takes constructed cli command and executes fuzzer with subprocess.call
|
||||||
else:
|
"""
|
||||||
self.name = name
|
try:
|
||||||
|
r = subprocess.call(self.cmd)
|
||||||
# use first fuzzer executable path if multiple exists
|
print(f"{self.name} finished with exit code", r)
|
||||||
self.fuzzer = fuzzer_paths[0]
|
except BaseException as e:
|
||||||
|
raise RuntimeError(f"{self.fuzzer} run interrupted due to exception:", e)
|
||||||
|
|
||||||
|
|
||||||
def compile(self, flags):
|
def post_processing(self):
|
||||||
"""
|
"""
|
||||||
provides an interface for calling a compiler to instrument a test harness for
|
performs any post-fuzzing operations, like test extraction / parsing
|
||||||
mutation-based fuzzers
|
"""
|
||||||
"""
|
raise NotImplementedError("Must be implemented by front-end executor.")
|
||||||
if self.compiler is None:
|
|
||||||
raise RuntimeError(f"No compiler specified for compile-time instrumentation.")
|
|
||||||
|
|
||||||
self.compile_cmd = [self.compiler, flags]
|
|
||||||
try:
|
|
||||||
r = subprocess.call(self.compile_cmd)
|
|
||||||
except BaseException as e:
|
|
||||||
raise RuntimeError(f"{self.compiler} interrupted due to exception:", e)
|
|
||||||
|
|
||||||
|
|
||||||
def cli_command(self, cmd_dict, compiler=None, cli_other=None):
|
_ARGS = None
|
||||||
"""
|
|
||||||
provides an interface for constructing proper command to be passed
|
|
||||||
to fuzzer cli executable.
|
|
||||||
"""
|
|
||||||
|
|
||||||
# turn arg mapping into viable cli args
|
@classmethod
|
||||||
cmd_args = list(functools.reduce(lambda key, val: key + val, cmd_dict.items()))
|
def parse_args(cls):
|
||||||
cmd_args = [arg for arg in cmd_args if arg is not None]
|
if cls._ARGS:
|
||||||
|
return cls._ARGS
|
||||||
|
|
||||||
# prepends compiler executable if specified
|
parser = argparse.ArgumentParser(
|
||||||
if compiler is not None:
|
description="Use fuzzer as back-end for DeepState.")
|
||||||
self.cmd = [compiler, self.fuzzer]
|
|
||||||
else:
|
|
||||||
self.cmd = [self.fuzzer]
|
|
||||||
|
|
||||||
# create command to execute by fuzzer, append any other optional arguments
|
parser.add_argument("binary", type=str, help="Path to the test binary to run.")
|
||||||
self.cmd += cmd_args
|
|
||||||
if cli_other is not None:
|
|
||||||
self.cmd += cli_other
|
|
||||||
|
|
||||||
|
parser.add_argument("--output_test_dir", type=str, default="out", help="Directory where tests will be saved.")
|
||||||
|
|
||||||
def execute_fuzzer(self):
|
parser.add_argument("--timeout", type=int, default=3600, help="How long to fuzz.")
|
||||||
"""
|
|
||||||
takes constructed cli command and executes fuzzer with subprocess.call
|
|
||||||
"""
|
|
||||||
try:
|
|
||||||
r = subprocess.call(self.cmd)
|
|
||||||
print(f"{self.name} finished with exit code", r)
|
|
||||||
except BaseException as e:
|
|
||||||
raise RuntimeError(f"{self.fuzzer} run interrupted due to exception:", e)
|
|
||||||
|
|
||||||
|
parser.add_argument("--seeds", type=str, help="Directory with seed inputs.")
|
||||||
|
|
||||||
def post_processing(self):
|
parser.add_argument("--which_test", type=str, help="Which test to run (equivalent to --input_which_test).")
|
||||||
"""
|
|
||||||
performs any post-fuzzing operations, like test extraction / parsing
|
|
||||||
"""
|
|
||||||
raise NotImplementedError("Must be implemented by front-end executor.")
|
|
||||||
|
|
||||||
|
parser.add_argument("--max_input_size", type=int, default=8192, help="Maximum input size.")
|
||||||
|
|
||||||
_ARGS = None
|
parser.add_argument("--fuzzer_help", action='store_true', help="Show fuzzer command line options.")
|
||||||
|
|
||||||
@classmethod
|
parser.add_argument("--args", default=[], nargs=argparse.REMAINDER, help="Other arguments to pass to fuzzer cli.")
|
||||||
def parse_args(cls):
|
|
||||||
if cls._ARGS:
|
|
||||||
return cls._ARGS
|
|
||||||
|
|
||||||
parser = argparse.ArgumentParser(
|
cls._ARGS = parser.parse_args()
|
||||||
description="Use fuzzer as back-end for DeepState.")
|
return cls._ARGS
|
||||||
|
|
||||||
parser.add_argument("binary", type=str, help="Path to the test binary to run.")
|
|
||||||
|
|
||||||
parser.add_argument("--output_test_dir", type=str, default="out", help="Directory where tests will be saved.")
|
|
||||||
|
|
||||||
parser.add_argument("--timeout", type=int, default=3600, help="How long to fuzz.")
|
|
||||||
|
|
||||||
parser.add_argument("--seeds", type=str, help="Directory with seed inputs.")
|
|
||||||
|
|
||||||
parser.add_argument("--which_test", type=str, help="Which test to run (equivalent to --input_which_test).")
|
|
||||||
|
|
||||||
parser.add_argument("--max_input_size", type=int, default=8192, help="Maximum input size.")
|
|
||||||
|
|
||||||
parser.add_argument("--fuzzer_help", action='store_true', help="Show fuzzer command line options.")
|
|
||||||
|
|
||||||
parser.add_argument("--args", default=[], nargs=argparse.REMAINDER, help="Other arguments to pass to fuzzer cli.")
|
|
||||||
|
|
||||||
cls._ARGS = parser.parse_args()
|
|
||||||
return cls._ARGS
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user