Skip to content

CapstoneReloaded/capstone

Capstone Engine (Reloaded)

❗ This is an independent community development fork of the original Capstone project that was made in order to secure the future existence of that great, but slowly dying project. Unfortunately the original project is badly suffering from an extreme lack of maintenace and very slow response to any community involvement, if at all. This is an attempt to remedy the situation, but is not meant to replace that project, and rather complement it in such a way that issues, project milestones and pull requests can be handled more rapidly to push the project forward. ❗

For questions regarding the original project and its status, please contact the original Capstone owner and repository maintainer:
Nguyen Anh Quynh at [email protected].


Capstone GitHub last commit Maintenance Average time to resolve an issue

Reloaded:

STATUS: Version Date Maintained?
Working 3.0.5 2018-11-02 YES

Original:

STATUS: Version Date Maintained?
Working 3.0.5 2018-07-18 ?

GitHub last commit Maintenance Average time to resolve an issue

Build Status Build status


What is Capstone?

Capstone is the disassembly engine which is part of the Reverse Engineering (RE) framework known as the "Reversing Trilogy", consisting of:

The framwork has as target to become the ultimate tool for binary analysis in the security community, and has already established itself as an important part in a long list of related projects using its engine to various degrees.

As such, Capstone offers some unparalleled features:

  • Support multiple hardware architectures:
    ARM, ARM64 (ARMv8), Ethereum VM, M68K, Mips, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore and X86/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
    (Available either in main code or provided externally by the community.)

  • Native support for all popular platforms:
    Windows/Cygwin, 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.md 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.