8ac2843b9b
* chore(version): Update Version to 6.0.0-RC1 * chore(version): change version name to 6.0.0-alpha3 |
||
|---|---|---|
| .github | ||
| .reuse | ||
| LICENSES | ||
| arch | ||
| bindings | ||
| contrib | ||
| cstool | ||
| docs | ||
| include | ||
| packages | ||
| suite | ||
| tests | ||
| windows | ||
| windowsce | ||
| xcode | ||
| .appveyor.yml | ||
| .clang-format | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| BUILDING.md | ||
| CMakeLists.txt | ||
| CMakePresets.json | ||
| COMPILE_MAKE.TXT | ||
| CONTRIBUTING.md | ||
| CPackConfig.cmake | ||
| CPackConfig.txt | ||
| CREDITS.TXT | ||
| ChangeLog | ||
| LEB128.h | ||
| MCAsmInfo.h | ||
| MCDisassembler.h | ||
| MCFixedLenDisassembler.h | ||
| MCInst.c | ||
| MCInst.h | ||
| MCInstPrinter.c | ||
| MCInstPrinter.h | ||
| MCInstrDesc.c | ||
| MCInstrDesc.h | ||
| MCRegisterInfo.c | ||
| MCRegisterInfo.h | ||
| Makefile | ||
| Mapping.c | ||
| Mapping.h | ||
| MathExtras.h | ||
| README.md | ||
| SPONSORS.TXT | ||
| SStream.c | ||
| SStream.h | ||
| capstone-config.cmake.in | ||
| capstone.pc.in | ||
| cmake.sh | ||
| cmake_uninstall.cmake.in | ||
| config.mk | ||
| cs.c | ||
| cs_priv.h | ||
| cs_simple_types.h | ||
| functions.mk | ||
| make.sh | ||
| pkgconfig.mk | ||
| run-clang-tidy.sh | ||
| utils.c | ||
| utils.h | ||
README.md
Capstone Engine
[!TIP] Welcome to join our community group!
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:
-
Support multiple hardware architectures: ARM, AArch64, Alpha, ARC, BPF, Ethereum VM, LoongArch, HP PA-RISC (HPPA), M68K, M680X, Mips, MOS65XX, PPC, RISC-V(rv32G/rv64G), SH, Sparc, SystemZ, TMS320C64X, TriCore, Webassembly, XCore and X86 (16, 32, 64), Xtensa.
-
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 registers read & written.
-
Implemented in pure C language, with lightweight bindings for Swift, D, Clojure, F#, Common Lisp, Visual Basic, 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).
-
Native support for all popular platforms: Windows, Mac OSX, iOS, Android, Linux, *BSD, Solaris, etc.
-
Thread-safe by design.
-
Special support for embedding into firmware or OS kernel.
-
High performance & suitable for malware analysis (capable of handling various X86 malware tricks).
-
Distributed under the open source BSD license.
Further information is available at https://www.capstone-engine.org
Compile
See BUILDING.md file for how to compile and install Capstone.
Documentation
- Useful links and tutorials: docs/README
- Software architecture overview: docs/ARCHITECTURE.md
- Testing documentation: tests/README.md
- Updater (Auto-Sync) documentation: suite/auto-sync/README.md
Contributing
See CONTRIBUTING.md for an intro.
Fuzz
See suite/fuzz/README.md for more information.
License
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.