capstone/README.md

66 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2016-03-01 05:57:06 +00:00
Capstone Engine
===============
[![Build Status](https://travis-ci.org/aquynh/capstone.svg?branch=next)](https://travis-ci.org/aquynh/capstone)
2016-03-07 16:19:07 +00:00
[![Build status](https://ci.appveyor.com/api/projects/status/a4wvbn89wu3pinas/branch/next?svg=true)](https://ci.appveyor.com/project/aquynh/capstone/branch/next)
2016-03-01 04:11:44 +00:00
2013-11-27 04:11:31 +00:00
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:
2018-03-31 09:29:22 +00:00
- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Ethereum VM, M68K,
2018-07-05 03:26:39 +00:00
Mips, NEO VM, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore and X86.
2013-11-27 04:11:31 +00:00
- 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
2014-01-22 02:21:25 +00:00
registers read & written.
2013-11-27 04:11:31 +00:00
2017-04-12 02:02:16 +00:00
- Implemented in pure C language, with lightweight bindings for PHP, PowerShell,
Emacs, Haskell, Perl, Python, Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua,
Rust, Delphi, Free Pascal & Vala ready either in main code, or provided
externally by the community).
2013-11-27 04:11:31 +00:00
2014-06-16 14:06:44 +00:00
- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
Linux, *BSD, Solaris, etc.
2013-11-27 04:11:31 +00:00
- Thread-safe by design.
2014-03-03 09:57:15 +00:00
- Special support for embedding into firmware or OS kernel.
2014-10-21 04:04:38 +00:00
- High performance & suitable for malware analysis (capable of handling various
X86 malware tricks).
2013-11-27 04:11:31 +00:00
- Distributed under the open source BSD license.
2013-12-17 16:18:06 +00:00
Further information is available at http://www.capstone-engine.org
2013-11-27 04:11:31 +00:00
2016-03-01 05:57:06 +00:00
Compile
-------
2013-12-17 16:11:25 +00:00
2014-06-16 10:38:32 +00:00
See COMPILE.TXT file for how to compile and install Capstone.
2013-11-27 04:11:31 +00:00
2016-03-01 05:57:06 +00:00
Documentation
-------------
2014-10-20 09:38:53 +00:00
2014-10-20 08:29:15 +00:00
See docs/README for how to customize & program your own tools with Capstone.
2016-03-01 05:57:06 +00:00
Hack
----
2013-11-27 04:11:31 +00:00
2015-10-03 02:04:59 +00:00
See HACK.TXT file for the structure of the source code.
2013-12-17 16:11:25 +00:00
2016-03-01 05:57:06 +00:00
License
-------
2013-12-17 16:11:25 +00:00
2013-12-18 02:16:07 +00:00
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.