Go to file
Nguyen Anh Quynh d501a372e3 update CREDITS.TXT 2015-05-13 16:09:26 +08:00
arch arm: remove ASRS, LSRS, SUBS & MOVS from mapping table insns[]. backported from the 'next' branch, but do not really remove these 'dead' instructions for compatibility reason 2015-05-08 15:08:35 +08:00
bindings cython: bump version in setup_cython.py to 3.0.3 2015-05-12 09:33:38 +08:00
contrib vsnprintf fix 2014-06-02 21:48:30 +08:00
docs docs: add a link to online doc of cs_disasm_iter() 2014-10-13 07:27:16 +08:00
include Fix spelling nits 2015-05-05 13:57:15 -07:00
msvc actually tracking test_iter 2015-05-01 22:32:30 -07:00
packages packages: update FreeBSD to version 3.0.3 2015-05-08 23:14:52 +08:00
suite suite: correct authors of patch_major_os_version.py 2015-05-06 10:39:28 +08:00
tests inttypes.h fix 2015-03-29 18:29:06 +08:00
xcode Renaming inttypes.h -> myinttypes.h 2015-04-07 14:58:43 -04:00
.gitignore Renaming inttypes.h -> myinttypes.h 2015-04-07 14:58:43 -04:00
CMakeLists.txt Merge branch 'v3' of https://github.com/aquynh/capstone into v3 2015-05-08 23:06:40 +08:00
COMPILE.TXT add some missing header files into COMPILE.TXT 2015-02-11 10:30:03 +08:00
COMPILE_CMAKE.TXT python: setup.py builds Windows core with cmake in release mode 2015-02-03 17:45:55 +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-05-13 16:09:26 +08:00
ChangeLog update Changelog for 3.0.3 2015-05-08 15:17:01 +08:00
HACK.TXT Fix utf8-art 2014-11-01 22:14:13 +01:00
LEB128.h Disassembler -> Disassembly 2014-04-29 11:21:04 +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 Disassembler -> Disassembly 2014-04-29 11:21:04 +08:00
MCFixedLenDisassembler.h Disassembler -> Disassembly 2014-04-29 11:21:04 +08:00
MCInst.c Add support to embed Capstone into OS X kernel extensions. 2015-04-10 23:28:12 +08:00
MCInst.h arm: some load/store instructions writeback without bang letter. bug reported by @jabba2989 2015-01-21 20:03:21 +08:00
MCInstrDesc.c Disassembler -> Disassembly 2014-04-29 11:21:04 +08:00
MCInstrDesc.h arm: more optimization on MCInstrDesc struct to reduce the library size by further 20KB 2015-03-10 17:30:26 +08:00
MCRegisterInfo.c Disassembler -> Disassembly. also delete an orphaned file 2014-05-08 22:54:58 +08:00
MCRegisterInfo.h avoid using stdbool.h to support compilers without C99 support 2014-05-15 21:40:24 +08:00
Makefile Add support to embed Capstone into OS X kernel extensions. 2015-04-10 23:28:12 +08:00
MathExtras.h arm64: update core. this added a lot more details to cs_arm64_op struct 2014-08-25 16:47:12 +08:00
README add Rust binding to README 2015-05-13 11:59:47 +08:00
RELEASE_NOTES update RELEASE_NOTES with a dedication to Prof. Yoshiyasu Takefuji 2015-05-08 16:11:10 +08:00
SStream.c Add support to embed Capstone into OS X kernel extensions. 2015-04-10 23:28:12 +08:00
SStream.h arm64: set absolute (rather than relative) address B/BL. issue reported by Pancake 2014-12-12 22:06:06 +08:00
TODO TODO 2015-03-11 11:32:37 +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 Add support to embed Capstone into OS X kernel extensions. 2015-04-10 23:28:12 +08:00
cs_priv.h add new API cs_group_name() to return group name in string, given the group id 2014-07-08 08:59:27 +08:00
functions.mk Makefile: put common functions into functions.mk 2014-05-01 22:53:52 +08:00
make.sh on OSX, 'make uninstall' should clean files under /usr/local rather than /usr 2014-07-22 21:19:02 +08:00
myinttypes.h fix typo in myinttypes.h 2015-04-10 23:28:25 +08:00
osxkernel_inttypes.h Add support to embed Capstone into OS X kernel extensions. 2015-04-10 23:28:12 +08:00
pkgconfig.mk bump version to 3.0.3 2015-05-08 15:22:26 +08:00
utils.c Add support to embed Capstone into OS X kernel extensions. 2015-04-10 23:28:12 +08:00
utils.h fix more MSVC warnings 2014-08-26 15:57:04 +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.