| Capstone Engine |
| =============== |
| |
| [](https://travis-ci.org/aquynh/capstone) |
| [](https://ci.appveyor.com/project/aquynh/capstone/branch/master) |
| [](https://pypi.python.org/pypi/capstone) |
| [](https://pepy.tech/project/capstone) |
| |
| Deprecation |
| =========== |
| |
| The [`master`](https://github.com/capstone-engine/capstone/tree/master) branch is deprecated. |
| All forward development should be based on the [`next`](https://github.com/capstone-engine/capstone/tree/next) branch. |
| |
| To clone a fresh checkout with the `next` branch: |
| |
| git clone -b next https://github.com/capstone-engine/capstone |
| |
| To change to the `next` branch in an existing checkout: |
| |
| git checkout next |
| |
| ---- |
| |
| We moved the original historical repo of Capstone from https://github.com/aquynh/capstone to an organization, where we can add more maintainers to the project, and push Capstone development forward. |
| |
| Our new home is https://github.com/capstone-engine/capstone |
| |
| Nov 8th, 2021. |
| |
| ---- |
| |
| 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, MOS65XX, 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 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, macOS, 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. |
