From 41f3c6aca4f7874d6a154ead2e16871f4948cc21 Mon Sep 17 00:00:00 2001
From: Camille Mougey <commial@gmail.com>
Date: Sun, 23 Apr 2023 11:45:58 +0200
Subject: [PATCH] Example: add a basic symbol_exec example

---
 example/symbol_exec/symbol_exec.py | 49 ++++++++++++++++++++++++++++++
 test/test_all.py                   |  1 +
 2 files changed, 50 insertions(+)
 create mode 100644 example/symbol_exec/symbol_exec.py

diff --git a/example/symbol_exec/symbol_exec.py b/example/symbol_exec/symbol_exec.py
new file mode 100644
index 000000000..84418da54
--- /dev/null
+++ b/example/symbol_exec/symbol_exec.py
@@ -0,0 +1,49 @@
+from __future__ import print_function
+from argparse import ArgumentParser
+
+from future.utils import viewvalues
+from miasm.analysis.binary import Container
+from miasm.analysis.machine import Machine
+from miasm.core.locationdb import LocationDB
+from miasm.ir.symbexec import SymbolicExecutionEngine
+
+parser = ArgumentParser("Simple SymbolicExecution demonstrator")
+parser.add_argument("target_binary", help="Target binary path")
+parser.add_argument("--address", help="Starting address for emulation. If not set, use the entrypoint")
+parser.add_argument("--steps", help="Log emulation state after each instruction", action="store_true")
+options = parser.parse_args()
+
+###################################################################
+# Common section from example/disam/dis_binary_lift_model_call.py #
+###################################################################
+
+fdesc = open(options.target_binary, 'rb')
+loc_db = LocationDB()
+
+cont = Container.from_stream(fdesc, loc_db)
+
+machine = Machine(cont.arch)
+
+mdis = machine.dis_engine(cont.bin_stream, loc_db=cont.loc_db)
+
+addr = cont.entry_point if options.address is None else int(options.address, 0)
+asmcfg = mdis.dis_multiblock(addr)
+
+lifter = machine.lifter_model_call(mdis.loc_db)
+ircfg = lifter.new_ircfg_from_asmcfg(asmcfg)
+
+#####################################
+#    End common section             #
+#####################################
+
+# Instantiate a Symbolic Execution engine with default value for registers
+symb = SymbolicExecutionEngine(lifter)
+
+# Emulate until the next address cannot be resolved (`ret`, unresolved condition, etc.)
+cur_addr = symb.run_at(ircfg, addr, step=options.steps)
+
+# Modified elements
+print('Modified registers:')
+symb.dump(mems=False)
+print('Modified memory (should be empty):')
+symb.dump(ids=False)
diff --git a/test/test_all.py b/test/test_all.py
index 2d078bf12..591f3d8e9 100755
--- a/test/test_all.py
+++ b/test/test_all.py
@@ -739,6 +739,7 @@ class ExampleSymbolExec(Example):
 
 
 testset += ExampleSymbolExec(["single_instr.py"])
+testset += ExampleSymbolExec(["symbol_exec.py", "--steps", Example.get_sample("box_upx.exe")])
 for options, nb_sol, tag in [([], 8, []),
                              (["-i", "--rename-args"], 12, [TAGS["z3"]])]:
     testset += ExampleSymbolExec(["depgraph.py",