2016-10-22 03:40:06 -07:00
|
|
|
To install Capstone, you should run `pip install capstone`.
|
2015-02-03 22:41:07 +08:00
|
|
|
|
2024-11-18 12:10:27 +01:00
|
|
|
If you would like to build and install Capstone with just the source distribution,
|
|
|
|
|
just run `python -m pip install .`, considering you are in the folder with setup.py in it.
|
2015-05-15 16:59:09 +08:00
|
|
|
|
2016-10-19 00:50:38 -07:00
|
|
|
In order to use this source distribution, you will need an environment that can
|
2016-10-22 03:40:06 -07:00
|
|
|
compile C code. On Linux, this is usually easy, but on Windows, this involves
|
2016-10-19 00:50:38 -07:00
|
|
|
installing Visual Studio and using the "Developer Command Prompt" to perform the
|
2024-11-18 12:10:27 +01:00
|
|
|
installation. See BUILDING.md for more information.
|
2015-05-15 16:59:09 +08:00
|
|
|
|
2018-02-20 05:11:19 -08:00
|
|
|
By default, attempting to install the python bindings will trigger a build of
|
|
|
|
|
the capstone native core. If this is undesirable for whatever reason, for
|
|
|
|
|
instance, you already have a globally installed copy of libcapstone, you may
|
|
|
|
|
inhibit the build by setting the environment variable LIBCAPSTONE_PATH. The
|
|
|
|
|
exact value is not checked, just setting it will inhibit the build. During
|
|
|
|
|
execution, this variable may be set to the path of a directory containing a
|
|
|
|
|
specific version of libcapstone you would like to use.
|
|
|
|
|
|
2016-10-22 03:40:06 -07:00
|
|
|
If you don't want to build your own copy of Capstone, you can use a precompiled
|
|
|
|
|
binary distribution from PyPI. Saying `pip install capstone` should
|
|
|
|
|
automatically obtain an appropriate copy for your system. If it does not, please
|
2023-07-06 00:03:39 +08:00
|
|
|
open an issue at https://github.com/capstone-engine/capstone.
|
2015-02-03 22:41:07 +08:00
|
|
|
|
2015-02-03 10:20:30 +08: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:
|
|
|
|
|
|
2023-11-15 04:12:14 +00:00
|
|
|
- Support multiple hardware architectures: ARM, AARCH64 (ARMv8), Mips, PPC, Sparc,
|
2015-02-03 10:20:30 +08:00
|
|
|
SystemZ, XCore and X86 (including X86_64).
|
|
|
|
|
|
|
|
|
|
- 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 wrappers for C++, C#, Go,
|
|
|
|
|
Java, NodeJS, Ocaml, Python, Ruby & Vala ready (available 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 http://www.capstone-engine.org
|
|
|
|
|
|
|
|
|
|
|
2026-02-14 13:56:07 +00:00
|
|
|
## License
|
2015-02-03 10:20:30 +08: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.
|
