README
1 file changed
tree: 5a447ed880c1c533ef542ef521d83468382f56aa
  1. arch/
  2. bindings/
  3. contrib/
  4. cstool/
  5. docs/
  6. include/
  7. msvc/
  8. packages/
  9. suite/
  10. tests/
  11. windows/
  12. windowsce/
  13. xcode/
  14. .appveyor.yml
  15. .gitattributes
  16. .gitignore
  17. .travis.yml
  18. capstone.pc.in
  19. ChangeLog
  20. CMakeLists.txt
  21. COMPILE.TXT
  22. COMPILE_CMAKE.TXT
  23. COMPILE_MSVC.TXT
  24. config.mk
  25. CREDITS.TXT
  26. cs.c
  27. cs_priv.h
  28. functions.mk
  29. HACK.TXT
  30. LEB128.h
  31. LICENSE.TXT
  32. LICENSE_LLVM.TXT
  33. make.sh
  34. Makefile
  35. MathExtras.h
  36. MCDisassembler.h
  37. MCFixedLenDisassembler.h
  38. MCInst.c
  39. MCInst.h
  40. MCInstrDesc.c
  41. MCInstrDesc.h
  42. MCRegisterInfo.c
  43. MCRegisterInfo.h
  44. nmake-x86.bat
  45. nmake.bat
  46. pkgconfig.mk
  47. README.md
  48. RELEASE_NOTES
  49. SStream.c
  50. SStream.h
  51. TODO
  52. utils.c
  53. utils.h
README.md

Capstone Engine

Build Status Build status

Capstone is a disassembly framework with the target of becoming the ultimate disasm engine for binary analysis and reversing in the security community.

Created by Nguyen Anh Quynh, then developed and maintained by a small community, Capstone offers some unparalleled features:

  • Support multiple hardware architectures: ARM, ARM64 (ARMv8), Ethereum VM, M68K, Mips, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore and X86 (including X86_64).

  • Having clean/simple/lightweight/intuitive architecture-neutral API.

  • Provide details on disassembled instruction (called “decomposer” by others).

  • Provide semantics of the disassembled instruction, such as list of implicit registers read & written.

  • Implemented in pure C language, with lightweight bindings for Clojure, F#, Common Lisp, Visual Basic, PHP, PowerShell, Emacs, Haskell, Perl, Python, Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua, Rust, Delphi, Free Pascal & Vala ready either in main code, or provided externally by the community).

  • Native support for all popular platforms: Windows, Mac OSX, iOS, Android, Linux, *BSD, Solaris, etc.

  • Thread-safe by design.

  • Special support for embedding into firmware or OS kernel.

  • High performance & suitable for malware analysis (capable of handling various X86 malware tricks).

  • Distributed under the open source BSD license.

Further information is available at http://www.capstone-engine.org

Compile

See COMPILE.TXT file for how to compile and install Capstone.

Documentation

See docs/README for how to customize & program your own tools with Capstone.

Hack

See HACK.TXT file for the structure of the source code.

License

This project is released under the BSD license. If you redistribute the binary or source code of Capstone, please attach file LICENSE.TXT with your products.