| 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 | 636f506 | 2014-03-23 22:24:28 +0800 | [diff] [blame] | 7 | - Support multiple hardware architectures: ARM, ARM64 (ARMv8), Mips, PPC, Sparc, |
| Nguyen Anh Quynh | bc01e2c | 2014-10-20 16:29:15 +0800 | [diff] [blame] | 8 | SystemZ, XCore and X86 (including X86_64). |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 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 |
| Nguyen Anh Quynh | 38b7bbb | 2014-01-22 10:21:25 +0800 | [diff] [blame] | 15 | registers read & written. |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 16 | |
| Nguyen Anh Quynh | 38b7bbb | 2014-01-22 10:21:25 +0800 | [diff] [blame] | 17 | - Implemented in pure C language, with lightweight wrappers for C++, C#, Go, |
| Nguyen Anh Quynh | 9672cd2 | 2014-06-16 22:06:44 +0800 | [diff] [blame] | 18 | Java, NodeJS, Ocaml, Python, Ruby & Vala ready (available in main code, |
| 19 | or provided externally by the community). |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 20 | |
| Nguyen Anh Quynh | 9672cd2 | 2014-06-16 22:06:44 +0800 | [diff] [blame] | 21 | - Native support for all popular platforms: Windows, Mac OSX, iOS, Android, |
| 22 | Linux, *BSD, Solaris, etc. |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 23 | |
| 24 | - Thread-safe by design. |
| 25 | |
| Nguyen Anh Quynh | b0b7308 | 2014-03-03 17:57:15 +0800 | [diff] [blame] | 26 | - Special support for embedding into firmware or OS kernel. |
| 27 | |
| Nguyen Anh Quynh | edbee24 | 2014-10-21 12:04:38 +0800 | [diff] [blame] | 28 | - High performance & suitable for malware analysis (capable of handling various |
| 29 | X86 malware tricks). |
| 30 | |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 31 | - Distributed under the open source BSD license. |
| 32 | |
| Nguyen Anh Quynh | b7155b0 | 2013-12-18 00:18:06 +0800 | [diff] [blame] | 33 | Further information is available at http://www.capstone-engine.org |
| 34 | |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 35 | |
| 36 | [Compile] |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame] | 37 | |
| Nguyen Anh Quynh | 6217f36 | 2014-06-16 18:38:32 +0800 | [diff] [blame] | 38 | See COMPILE.TXT file for how to compile and install Capstone. |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 39 | |
| 40 | |
| Nguyen Anh Quynh | bc01e2c | 2014-10-20 16:29:15 +0800 | [diff] [blame] | 41 | [Documentation] |
| Nguyen Anh Quynh | 257ea59 | 2014-10-20 17:38:53 +0800 | [diff] [blame] | 42 | |
| Nguyen Anh Quynh | bc01e2c | 2014-10-20 16:29:15 +0800 | [diff] [blame] | 43 | See docs/README for how to customize & program your own tools with Capstone. |
| 44 | |
| 45 | |
| Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 46 | [Hack] |
| 47 | |
| Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 48 | See HACK.TXT file for the structuture of the source code. |
| Nguyen Anh Quynh | 8afa3dd | 2013-12-18 00:11:25 +0800 | [diff] [blame] | 49 | |
| 50 | |
| 51 | [License] |
| 52 | |
| Nguyen Anh Quynh | 24ca24c | 2013-12-18 10:16:07 +0800 | [diff] [blame] | 53 | This project is released under the BSD license. If you redistribute the binary |
| 54 | or source code of Capstone, please attach file LICENSE.TXT with your products. |