| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 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 (aka ARMv8), Mips & X86. |
| 8 | |
| 9 | - Having clean/simple/lightweight/intuitive architecture-neutral API. |
| 10 | |
| 11 | - Provide details on disassembled instruction (called “decomposer” by others). |
| 12 | |
| 13 | - Provide semantics of the disassembled instruction, such as list of implicit |
| 14 | registers read & written. |
| 15 | |
| 16 | - Implemented in pure C language, with lightweight wrappers for C++, Python, |
| 17 | Ruby, OCaml, C#, Java and Go available. |
| 18 | |
| Nguyen Anh Quynh | b2dc054 | 2013-12-09 16:05:49 +0800 | [diff] [blame] | 19 | - Native support for Windows & *nix platforms (MacOSX, Linux & *BSD confirmed). |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 20 | |
| 21 | - Thread-safe by design. |
| 22 | |
| 23 | - Distributed under the open source BSD license. |
| 24 | |
| 25 | |
| 26 | [Compile] |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame^] | 27 | |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 28 | See COMPILE file for how to compile and install Capstone |
| 29 | |
| 30 | |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame^] | 31 | [Status] |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 32 | |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame^] | 33 | - Capstone can only compile to Windows via Cygwin, or cross-compile using |
| 34 | MingW. Visual Studio support will be done in the future. |
| 35 | |
| 36 | - X86 engine cannot handle many malware tricks yet. Please report all the raw |
| 37 | binary code that Capstone cannot disassemble, or does that wrongly, so we can |
| 38 | fix that in the next version |
| 39 | |
| 40 | - This package only contains Java & Python bindings. For C#, Go, Ocaml & Ruby, |
| 41 | refer to the corresponding git repositories. |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 42 | |
| 43 | |
| 44 | [Hack] |
| 45 | |
| 46 | See HACK file for the structuture of the source code. |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame^] | 47 | |
| 48 | |
| 49 | [License] |
| 50 | |
| 51 | This project is released under BSD license. If you redistribute the binary or |
| 52 | source code of Capstone, please attach the LICENSE.TXT file with your products. |