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

Capstone Engine

Build Status Build status pypi package pypi downloads Fuzzit Status
oss-fuzz 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), BPF, Ethereum VM, Webassembly, M68K, Mips, MOS65XX, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore, RISC-V(rv32G/rv64G) 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 Swift, D, 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.

Fuzz

See suite/fuzz/README.md for more information.

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.