capstone-engine/capstonePublic

NotificationsYou must be signed in to change notification settings
Fork1.6k
Star7.9k

Capstone disassembly/disassembler framework for ARM, ARM64 (ARMv8), Alpha, BPF, Ethereum VM, HPPA, LoongArch, M68K, M680X, Mips, MOS65XX, PPC, RISC-V(rv32G/rv64G), SH, Sparc, SystemZ, TMS320C64X, TriCore, Webassembly, XCore and X86.

7.9k stars 1.6k forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 5,255 Commits
.github		.github
.reuse		.reuse
LICENSES		LICENSES
arch		arch
bindings		bindings
contrib		contrib
cstool		cstool
docs		docs
include		include
packages		packages
suite		suite
tests		tests
windows		windows
windowsce		windowsce
xcode		xcode
.appveyor.yml		.appveyor.yml
.clang-format		.clang-format
.dockerignore		.dockerignore
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.gitmodules		.gitmodules
BUILDING.md		BUILDING.md
CMakeLists.txt		CMakeLists.txt
CMakePresets.json		CMakePresets.json
COMPILE_MAKE.TXT		COMPILE_MAKE.TXT
CONTRIBUTING.md		CONTRIBUTING.md
CPackConfig.cmake		CPackConfig.cmake
CPackConfig.txt		CPackConfig.txt
CREDITS.TXT		CREDITS.TXT
ChangeLog		ChangeLog
LEB128.h		LEB128.h
MCAsmInfo.h		MCAsmInfo.h
MCDisassembler.h		MCDisassembler.h
MCFixedLenDisassembler.h		MCFixedLenDisassembler.h
MCInst.c		MCInst.c
MCInst.h		MCInst.h
MCInstPrinter.c		MCInstPrinter.c
MCInstPrinter.h		MCInstPrinter.h
MCInstrDesc.c		MCInstrDesc.c
MCInstrDesc.h		MCInstrDesc.h
MCRegisterInfo.c		MCRegisterInfo.c
MCRegisterInfo.h		MCRegisterInfo.h
Makefile		Makefile
Mapping.c		Mapping.c
Mapping.h		Mapping.h
MathExtras.h		MathExtras.h
README.md		README.md
SPONSORS.TXT		SPONSORS.TXT
SStream.c		SStream.c
SStream.h		SStream.h
capstone-config.cmake.in		capstone-config.cmake.in
capstone.pc.in		capstone.pc.in
cmake.sh		cmake.sh
cmake_uninstall.cmake.in		cmake_uninstall.cmake.in
config.mk		config.mk
cs.c		cs.c
cs_priv.h		cs_priv.h
cs_simple_types.h		cs_simple_types.h
functions.mk		functions.mk
make.sh		make.sh
pkgconfig.mk		pkgconfig.mk
run-clang-tidy.sh		run-clang-tidy.sh
utils.c		utils.c
utils.h		utils.h

Repository files navigation

Capstone Engine

Tip

Welcome to join our community group!

Capstone is a disassembly framework with the target of becoming the ultimatedisasm 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 implicitregisters 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 & Valaready 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 variousX86 malware tricks).
Distributed under the open source BSD license.

Further information is available athttps://www.capstone-engine.org

Compile

SeeBUILDING.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

SeeCONTRIBUTING.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 binaryor source code of Capstone, please attach file LICENSE.TXT with your products.