You need Unicorn installed to use this.
Usercorn has two implementations: Go and Python. The Go variant is more advanced, faster (+10x), and more stable, but harder to script.
Go Instructions
# preconditions:
# make sure you are using go1.5
# you will also need capstone development headers
# not windows:
make
# windows:
go build -i -o usercorn ./go
# test executables
./usercorn bins/x86.linux.elf
./usercorn bins/x86_64.linux.elf
./usercorn bins/x86.darwin.macho
./usercorn bins/x86_64.darwin.macho
./usercorn bins/x86.linux.cgc
./usercorn bins/mipsel.linux.elf
Python Instructions (DEPRECATED)
(The Python frontend has been deprecated and will eventually be replaced with a native module)
Install the Unicorn Python bindings (cd bindings/python; make install
)
pip install -r py/requirements.txt
# test executables
python py/run.py bins/x86.linux.elf
python py/run.py bins/x86_64.linux.elf
python py/run.py bins/x86.darwin.macho
python py/run.py bins/x86_64.darwin.macho
python py/run.py bins/x86.linux.cgc
- User-space system emulator.
- Backed by Unicorn.
- Similar to qemu-user.
- Unlike qemu-user, does not require the same OS for which the binary was built.
- Wait, what? What does that mean?
- Syscalls are coerced into the Go language APIs using persuasive fit techniques. Syscalls s/should/might/ work almost anywhere the language does.
- This means Usercorn should work anywhere Unicorn and Go work.
- Debug stubborn binaries. I had a binary gdb refused to debug ("Program exited during startup."). No problem. Usercorn can single-step into the program for you.
- Debug foreign architecture and OS binaries. You don't need a MIPS box. You don't need qemu-user. You don't even need Linux.
- Write tools, like fuzzers, static analyzers, recompilers, memory and register tracing...
- Selectively call functions from within a binary.
- Whatever you want. Open an issue if you have a cool debugging / reverse engineering idea I didn't think about - I may just implement it.
- Your userspace might be incredibly confusing to the target binary.
- No API for memory mapped files yet (kinda, if mmap() currently gets a file descriptor argument it will manually copy the file into memory).