Merge pull request #2052 from kabeor/next

Update version tag
tree: 2ef10d9614a2cdcef2100f80cb8652e19fcf3e1b
  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. cmake_uninstall.cmake.in
  26. CMakeLists.txt
  27. CMakePresets.json
  28. COMPILE.TXT
  29. COMPILE_CMAKE.TXT
  30. COMPILE_MSVC.TXT
  31. config.mk
  32. CREDITS.TXT
  33. cs.c
  34. cs_priv.h
  35. cs_simple_types.h
  36. functions.mk
  37. HACK.TXT
  38. LEB128.h
  39. LICENSE.TXT
  40. LICENSE_LLVM.TXT
  41. make.sh
  42. Makefile
  43. Mapping.c
  44. Mapping.h
  45. MathExtras.h
  46. MCDisassembler.h
  47. MCFixedLenDisassembler.h
  48. MCInst.c
  49. MCInst.h
  50. MCInstrDesc.c
  51. MCInstrDesc.h
  52. MCRegisterInfo.c
  53. MCRegisterInfo.h
  54. nmake.bat
  55. pkgconfig.mk
  56. README.md
  57. RELEASE_NOTES
  58. SPONSORS.TXT
  59. SStream.c
  60. SStream.h
  61. TODO
  62. utils.c
  63. utils.h
README.md

Capstone Engine

Build status pypi package pypi downloads 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, M68K, M680X, Mips, MOS65XX, PPC, RISC-V(rv32G/rv64G), SH, Sparc, SystemZ, TMS320C64X, TriCore, Webassembly, XCore and X86 (16, 32, 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.