Go to file
kabeor 70ae4f7957 Merge branch 'master' of https://github.com/kabeor/capstone 2021-11-13 10:24:46 +08:00
.github/workflows PyPI workflow (#1645) 2020-11-15 08:48:32 +08:00
arch fix inconsistent behavior of Mips_option() (#1744) 2021-06-13 21:34:40 +08:00
bindings Enable detection and build on all BSD systems. (#1753) 2021-05-24 01:35:51 +08:00
contrib Fix user data alignment in MEMBLOCK (#1471) 2019-05-09 09:23:46 +07:00
cstool systemz: pad instruction width up to 6 bytes (#1679) 2020-09-03 16:49:29 +08:00
docs add Capstone Engine Documentation 2021-11-13 10:24:21 +08:00
include include: avoid UB with signed overflow/shift (#1675) 2020-09-15 16:03:03 +08:00
msvc MSVC tooling updates (#1651) 2021-03-07 21:59:02 +08:00
packages merge next to master 2018-07-20 12:36:50 +08:00
suite Corpus generation is more robust (#1419) 2019-03-11 13:13:45 +08:00
tests fix build android (#1765) 2021-06-13 21:28:57 +08:00
windows Fix user data alignment in MEMBLOCK (#1471) 2019-05-09 09:23:46 +07:00
windowsce Added documentation for building for Windows CE. 2016-04-12 09:26:47 +02:00
xcode merge next to master 2018-07-20 12:36:50 +08:00
.appveyor.yml rename appveyor.yml to .appveyor.yml 2016-03-15 00:01:10 +08:00
.gitattributes Fix language statistics by considering *.inc files to be C files. (#1078) 2018-01-14 20:42:20 +08:00
.gitignore fix for make.sh for android (#1523) 2019-07-27 00:16:01 +08:00
.gitmodules add Capstone Engine Documentation 2021-11-13 10:24:21 +08:00
.travis.yml Update .travis.yml 2020-01-02 09:41:03 +08:00
CMakeLists.txt Update cmake_minimum_required to version 2.8.12 (#1756) 2021-06-13 21:31:40 +08:00
COMPILE.TXT Update top-level COMPILE.TXT file (#1577) 2019-12-26 12:28:08 +08:00
COMPILE_CMAKE.TXT Fixed typos in compilation steps. (#1762) 2021-06-13 21:29:51 +08:00
COMPILE_MSVC.TXT Add vcpkg installation instructions (#1602) 2020-03-24 16:27:30 +08:00
CREDITS.TXT PyPI workflow (#1645) 2020-11-15 08:48:32 +08:00
ChangeLog ChangeLog 2019-01-10 13:18:49 +08:00
HACK.TXT update HACK.TXT with coding style 2019-02-02 07:39:07 +08:00
LEB128.h Undefined shifts (#1154) 2018-06-02 16:49:36 +08:00
LICENSE.TXT a a newline to LICENSE.TXT 2014-02-20 17:08:28 +08:00
LICENSE_LLVM.TXT initial import 2013-11-27 12:11:31 +08:00
MCDisassembler.h 2015 2015-03-04 17:45:23 +08:00
MCFixedLenDisassembler.h 2015 2015-03-04 17:45:23 +08:00
MCInst.c MCInst: fix uninitialized value in operand value (#1684) 2020-09-16 17:05:55 +08:00
MCInst.h remove unused MCOperand_Init() 2019-01-22 09:01:14 +08:00
MCInstrDesc.c merge next to master 2018-07-20 12:36:50 +08:00
MCInstrDesc.h merge next to master 2018-07-20 12:36:50 +08:00
MCRegisterInfo.c merge next to master 2018-07-20 12:36:50 +08:00
MCRegisterInfo.h merge next to master 2018-07-20 12:36:50 +08:00
Makefile Fix Makefile CAPSTONE_BUILD_CORE_ONLY (#1617) 2020-05-05 01:11:16 +08:00
MathExtras.h fix undefined shift in countLeadingZeros (#1157) 2018-06-03 22:27:54 +08:00
README.md Fixed a small typo `Mac OSX` (#1777) 2021-11-10 00:21:21 +08:00
RELEASE_NOTES update SPONSORS.TXT 2019-01-10 21:45:56 +08:00
SPONSORS.TXT update SPONSORS.TXT 2019-01-10 21:45:56 +08:00
SStream.c merge next to master 2018-07-20 12:36:50 +08:00
SStream.h merge next to master 2018-07-20 12:36:50 +08:00
TODO TODO 2015-03-11 11:33:00 +08:00
capstone.pc.in capstone.pc.in: use CMAKE_INSTALL_LIBDIR for libdir (#1659) 2020-07-19 17:07:18 +08:00
cmake.sh fix cmake.sh 2019-04-29 21:15:17 +08:00
config.mk Add support for the MOS65XX family such as the MOS 6502. 2018-12-06 22:53:33 +01:00
cs.c Fix typos of MOS65XX (#1390) 2019-02-18 19:52:51 +08:00
cs_priv.h merge next to master 2018-07-20 12:36:50 +08:00
functions.mk Makefile: put common functions into functions.mk 2014-05-01 22:53:52 +08:00
make.sh fix build android (#1765) 2021-06-13 21:28:57 +08:00
nmake.bat Add cmake option to tell whether architectures should be included by default (#1463) 2019-04-29 17:28:21 +07:00
pkgconfig.mk v4.1.0: set extra version = 0 2019-01-22 15:28:55 +08:00
utils.c Fix typos. (#1248) 2018-09-17 20:54:00 +08:00
utils.h Fix typos. (#1248) 2018-09-17 20:54:00 +08:00

README.md

Capstone Engine

Build Status Build status pypi package pypi downloads


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.