| 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 | |
| Nguyen Anh Quynh | 92c1750 | 2014-01-17 14:59:21 +0800 | [diff] [blame] | 7 | - Support multiple hardware architectures: ARM, ARM64 (ARMv8), Mips, PPC & X86. |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 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 |
| Nguyen Anh Quynh | 38b7bbb | 2014-01-22 10:21:25 +0800 | [diff] [blame] | 14 | registers read & written. |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 15 | |
| Nguyen Anh Quynh | 38b7bbb | 2014-01-22 10:21:25 +0800 | [diff] [blame] | 16 | - Implemented in pure C language, with lightweight wrappers for C++, C#, Go, |
| 17 | Java, Ocaml, Python, Ruby & Vala ready (either available in main code, |
| 18 | or provided externally by community). |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 19 | |
| Nguyen Anh Quynh | 92c1750 | 2014-01-17 14:59:21 +0800 | [diff] [blame] | 20 | - Native support for Windows & *nix platforms (with OSX, Linux, *BSD & Solaris |
| 21 | have been confirmed). |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 22 | |
| 23 | - Thread-safe by design. |
| 24 | |
| Nguyen Anh Quynh | b0b7308 | 2014-03-03 17:57:15 +0800 | [diff] [blame^] | 25 | - Special support for embedding into firmware or OS kernel. |
| 26 | |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 27 | - Distributed under the open source BSD license. |
| 28 | |
| Nguyen Anh Quynh | b7155b0 | 2013-12-18 00:18:06 +0800 | [diff] [blame] | 29 | Further information is available at http://www.capstone-engine.org |
| 30 | |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 31 | |
| 32 | [Compile] |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame] | 33 | |
| Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 34 | See COMPILE.TXT file for how to compile and install Capstone |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 35 | |
| 36 | |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame] | 37 | [Status] |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 38 | |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame] | 39 | - Capstone can only compile to Windows via Cygwin, or cross-compile using |
| 40 | MingW. Visual Studio support will be done in the future. |
| 41 | |
| 42 | - X86 engine cannot handle many malware tricks yet. Please report all the raw |
| 43 | binary code that Capstone cannot disassemble, or does that wrongly, so we can |
| 44 | fix that in the next version |
| 45 | |
| 46 | - This package only contains Java & Python bindings. For C#, Go, Ocaml & Ruby, |
| 47 | refer to the corresponding git repositories. |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 48 | |
| 49 | |
| 50 | [Hack] |
| 51 | |
| Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 52 | See HACK.TXT file for the structuture of the source code. |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame] | 53 | |
| 54 | |
| 55 | [License] |
| 56 | |
| Nguyen Anh Quynh | 24ca24c | 2013-12-18 10:16:07 +0800 | [diff] [blame] | 57 | This project is released under the BSD license. If you redistribute the binary |
| 58 | or source code of Capstone, please attach file LICENSE.TXT with your products. |