Home | History | Annotate | Download | only in capstone
      1 Capstone is a disassembly framework with the target of becoming the ultimate
      2 disasm engine for binary analysis and reversing in the security community.
      3 
      4 Created by Nguyen Anh Quynh, then developed and maintained by a small community,
      5 Capstone offers some unparalleled features:
      6 
      7 - Support multiple hardware architectures: ARM, ARM64 (ARMv8), Mips, PPC, Sparc,
      8   SystemZ, XCore and X86 (including X86_64).
      9 
     10 - Having clean/simple/lightweight/intuitive architecture-neutral API.
     11 
     12 - Provide details on disassembled instruction (called decomposer by others).
     13 
     14 - Provide semantics of the disassembled instruction, such as list of implicit
     15   registers read & written.
     16 
     17 - Implemented in pure C language, with lightweight bindings for Visual Basic, PHP,
     18   PowerShell, Emacs, Haskell, Perl, Python, Ruby, C#, NodeJS, Java, GO, C++, OCaml,
     19   Lua, Rust, Delphi, Free Pascal & Vala ready either in main code, or provided
     20   externally by the community).
     21 
     22 - Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
     23   Linux, *BSD, Solaris, etc.
     24 
     25 - Thread-safe by design.
     26 
     27 - Special support for embedding into firmware or OS kernel.
     28 
     29 - High performance & suitable for malware analysis (capable of handling various
     30   X86 malware tricks).
     31 
     32 - Distributed under the open source BSD license.
     33 
     34 Further information is available at http://www.capstone-engine.org
     35 
     36 
     37 [Compile]
     38 
     39 See COMPILE.TXT file for how to compile and install Capstone.
     40 
     41 
     42 [Documentation]
     43 
     44 See docs/README for how to customize & program your own tools with Capstone.
     45 
     46 
     47 [Hack]
     48 
     49 See HACK.TXT file for the structure of the source code.
     50 
     51 
     52 [License]
     53 
     54 This project is released under the BSD license. If you redistribute the binary
     55 or source code of Capstone, please attach file LICENSE.TXT with your products.
     56