2016-03-01 05:57:06 +00:00
|
|
|
Capstone Engine
|
|
|
|
|
===============
|
|
|
|
|
|
2016-03-07 16:19:07 +00:00
|
|
|
[](https://ci.appveyor.com/project/aquynh/capstone/branch/next)
|
2019-02-07 10:35:51 +00:00
|
|
|
[](https://pypi.python.org/pypi/capstone)
|
2019-02-15 00:58:46 +00:00
|
|
|
[](https://pepy.tech/project/capstone)
|
2021-11-09 16:23:13 +00:00
|
|
|
[](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:capstone)
|
2016-03-01 04:11:44 +00:00
|
|
|
|
2013-11-27 04:11:31 +00:00
|
|
|
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:
|
|
|
|
|
|
2023-05-02 10:10:58 +00:00
|
|
|
- Support multiple hardware architectures: ARM, ARM64 (ARMv8), BPF, Ethereum VM,
|
|
|
|
|
M68K, M680X, Mips, MOS65XX, PPC, RISC-V(rv32G/rv64G), SH, Sparc, SystemZ,
|
2023-05-02 11:38:24 +00:00
|
|
|
TMS320C64X, TriCore, Webassembly, XCore and X86 (16, 32, 64).
|
2013-11-27 04:11:31 +00:00
|
|
|
|
|
|
|
|
- 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
|
2014-01-22 02:21:25 +00:00
|
|
|
registers read & written.
|
2013-11-27 04:11:31 +00:00
|
|
|
|
2020-11-25 08:19:40 +00:00
|
|
|
- Implemented in pure C language, with lightweight bindings for Swift, D, Clojure, F#,
|
2018-07-24 05:44:39 +00:00
|
|
|
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).
|
2013-11-27 04:11:31 +00:00
|
|
|
|
2014-06-16 14:06:44 +00:00
|
|
|
- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
|
2018-07-20 04:36:50 +00:00
|
|
|
Linux, \*BSD, Solaris, etc.
|
2013-11-27 04:11:31 +00:00
|
|
|
|
|
|
|
|
- Thread-safe by design.
|
|
|
|
|
|
2014-03-03 09:57:15 +00:00
|
|
|
- Special support for embedding into firmware or OS kernel.
|
|
|
|
|
|
2014-10-21 04:04:38 +00:00
|
|
|
- High performance & suitable for malware analysis (capable of handling various
|
|
|
|
|
X86 malware tricks).
|
|
|
|
|
|
2013-11-27 04:11:31 +00:00
|
|
|
- Distributed under the open source BSD license.
|
|
|
|
|
|
2013-12-17 16:18:06 +00:00
|
|
|
Further information is available at http://www.capstone-engine.org
|
|
|
|
|
|
2013-11-27 04:11:31 +00:00
|
|
|
|
2016-03-01 05:57:06 +00:00
|
|
|
Compile
|
|
|
|
|
-------
|
2013-12-17 16:11:25 +00:00
|
|
|
|
2014-06-16 10:38:32 +00:00
|
|
|
See COMPILE.TXT file for how to compile and install Capstone.
|
2013-11-27 04:11:31 +00:00
|
|
|
|
|
|
|
|
|
2016-03-01 05:57:06 +00:00
|
|
|
Documentation
|
|
|
|
|
-------------
|
2014-10-20 09:38:53 +00:00
|
|
|
|
2014-10-20 08:29:15 +00:00
|
|
|
See docs/README for how to customize & program your own tools with Capstone.
|
|
|
|
|
|
|
|
|
|
|
2016-03-01 05:57:06 +00:00
|
|
|
Hack
|
|
|
|
|
----
|
2013-11-27 04:11:31 +00:00
|
|
|
|
2015-10-03 02:04:59 +00:00
|
|
|
See HACK.TXT file for the structure of the source code.
|
2013-12-17 16:11:25 +00:00
|
|
|
|
|
|
|
|
|
2019-07-25 01:06:52 +00:00
|
|
|
Fuzz
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
See suite/fuzz/README.md for more information.
|
|
|
|
|
|
|
|
|
|
|
2016-03-01 05:57:06 +00:00
|
|
|
License
|
|
|
|
|
-------
|
2013-12-17 16:11:25 +00:00
|
|
|
|
2013-12-18 02:16:07 +00:00
|
|
|
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.
|
