README 1.65 KB
Newer Older
1 2 3 4 5 6
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:

7 8
- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Mips, PPC, Sparc,
  SystemZ, XCore and X86 (including X86_64).
9 10 11 12 13 14

- 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
15
  registers read & written.
16

17
- Implemented in pure C language, with lightweight wrappers for C++, C#, Go,
18 19
  Java, NodeJS, Ocaml, Python, Ruby & Vala ready (available in main code,
  or provided externally by the community).
20

21 22
- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
  Linux, *BSD, Solaris, etc.
23 24 25

- Thread-safe by design.

26 27
- Special support for embedding into firmware or OS kernel.

28 29 30
- High performance & suitable for malware analysis (capable of handling various
  X86 malware tricks).

31 32 33 34 35 36 37
- Distributed under the open source BSD license.

Further information is available at http://www.capstone-engine.org


[Compile]

38
See COMPILE.TXT file for how to compile and install Capstone.
39 40


41
[Documentation]
42

43
See docs/README for how to customize & program your own tools with Capstone.
44 45 46 47


[Hack]

48
See HACK.TXT file for the structuture of the source code.
49 50 51 52 53 54


[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.