Go to file
Nguyen Anh Quynh 5a6007b0f1 suite: correct authors of patch_major_os_version.py 2015-05-06 10:40:20 +08:00
arch x86: fix 16bit address bound issue. reported by Oleksii Kuchma 2015-05-03 20:25:11 +08:00
bindings python: remove the leftover code in the last commit 2015-05-02 11:39:38 +08:00
contrib vsnprintf fix 2014-06-02 21:48:30 +08:00
docs docs: add the link to mnemonic.html 2015-04-27 16:35:30 +08:00
include/capstone Fix spelling nits 2015-05-06 06:05:35 +08:00
msvc tabs & version 4.0 instead of 12 2015-05-01 22:29:58 -07:00
packages package: update Brew formula (copied from upstream) 2015-02-24 20:49:47 +08:00
suite suite: correct authors of patch_major_os_version.py 2015-05-06 10:40:20 +08:00
tests tests: add info of test_customized_mnem.c to README 2015-04-27 11:10:26 +08:00
xcode Added test_customized_mnem file and target to Xcode project 2015-04-30 13:24:16 -04:00
.gitignore new option CS_OPT_MNEMONIC to customize instruction mnemonic 2015-04-26 22:54:41 +08:00
CMakeLists.txt new option CS_OPT_MNEMONIC to customize instruction mnemonic 2015-04-26 22:54:41 +08:00
COMPILE.TXT add some missing header files into COMPILE.TXT 2015-02-11 10:30:21 +08:00
COMPILE_CMAKE.TXT python: setup.py builds Windows core with cmake in release mode 2015-02-04 10:34:06 +08:00
COMPILE_MSVC.TXT added CAPSTONE_X86_ATT_DISABLE_NO to VS projects, readmes 2014-08-17 21:07:13 +02:00
CREDITS.TXT update CREDITS.TXT 2015-02-24 23:33:04 +08:00
ChangeLog update ChangeLog for 3.0.2 2015-03-12 00:10:50 +08:00
HACK.TXT Fix utf8-art 2014-11-01 22:14:13 +01:00
LEB128.h 2015 2015-03-04 17:45:23 +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
MANIFEST.in Updated setup.py so it can build the capstone library by itself. 2014-11-15 22:15:12 +01: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 Add support to embed Capstone 3.x branch into OS X kernel extensions. 2015-04-09 18:28:19 +01:00
MCInst.h arm: support cs_regs_access() API 2015-04-07 11:59:26 +08:00
MCInstrDesc.c 2015 2015-03-04 17:45:23 +08:00
MCInstrDesc.h 2015 2015-03-04 17:45:23 +08:00
MCRegisterInfo.c mips: update core 2015-03-02 15:12:42 +08:00
MCRegisterInfo.h mips: fix bugs in the last update 2015-03-02 17:31:44 +08:00
Makefile Improve the pkgconfig generation logic 2015-04-23 17:55:06 +02:00
MathExtras.h 2015 2015-03-04 17:45:23 +08:00
README README: add Rust as supported binding language 2015-04-07 15:05:28 +08:00
RELEASE_NOTES RELEASE_NOTES 2015-03-12 00:11:03 +08:00
SStream.c Add support to embed Capstone 3.x branch into OS X kernel extensions. 2015-04-09 18:28:19 +01:00
SStream.h 2015 2015-03-04 17:45:23 +08:00
TODO TODO 2015-03-11 11:33:00 +08:00
config.mk renamed CAPSTONE_NO_ATT to CAPSTONE_X86_ATT_DISABLE, added options to makefile, cmake, compile.txt 2014-08-17 20:59:05 +02:00
cs.c new option CS_OPT_MNEMONIC to customize instruction mnemonic 2015-04-26 22:54:41 +08:00
cs_priv.h rename MNEMONIC_SIZE to CS_MNEMONIC_SIZE 2015-04-27 09:47:59 +08:00
functions.mk Makefile: put common functions into functions.mk 2014-05-01 22:53:52 +08:00
make.sh Fix make -j warning 2015-03-07 11:40:19 +01:00
myinttypes.h fix typo in myinttypes.h 2015-04-10 23:22:22 +08:00
osxkernel_inttypes.h Add support to embed Capstone 3.x branch into OS X kernel extensions. 2015-04-09 18:28:19 +01:00
pkgconfig.mk bump version to 4.0 2014-12-26 23:14:53 +08:00
utils.c simplify ARCH_group_name() by using lookup table as suggested by @learn_more. also added the missing group name for GRP_PRIVILEGE 2015-04-27 12:13:34 +08:00
utils.h simplify ARCH_group_name() by using lookup table as suggested by @learn_more. also added the missing group name for GRP_PRIVILEGE 2015-04-27 12:13:34 +08:00

README

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), Mips, PPC, Sparc,
  SystemZ, 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 wrappers for C++, C#, Go,
  Java, Lua, NodeJS, Ocaml, Python, Ruby, Rust & Vala ready (available 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 structuture 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.