Skip to content

Latest commit

 

History

History
67 lines (53 loc) · 2.55 KB

README.md

File metadata and controls

67 lines (53 loc) · 2.55 KB
Raw

Clarirs

Clarirs is a rust implementation of claripy, an expression and constrint solving library built for angr. Clarirs aims to be mostly compatible with claripy as used in angr, but does not aim to be perfect drop in replacement or support all features of claripy. Additionally, there is hope that the additional performance of this rust implementation will allow for more complex solving and simplification strategies to be implemented that increase overall performance, serving as a platform for future research.

Clarirs is currently in the early stages of development and is not yet ready for use in production. The API is subject to change and the library is not yet feature complete. If you are interested in contributing to the project, issues, pull requests, and feedback are all welcome. Feel free to reach out to the maintainers with any questions or concerns via GitHub, the angr Discord, or email.

Requirements and Installation

Clairs requires the latest stable version of rust to build. To build the library and run the tests, use cargo:

cargo build
cargo test

To build and test the python bindings, Python 3.10 or later is required. A venv is reccomended. To build and install the python bindings, install with pip:

pip install .

For a python development install, it may be more efficient to use maturin to build the python bindings:

maturin develop

See the maturin user guide for more information on using maturin.

Related works

Clarirs was not designed in a vacuum. The following projects have been influential in the design and implementation of clarirs. If you use clarirs in an academic work, please consider citing the following works:

  • claripy: The original implementation of claripy in python.
  • angr: The symbolic execution engine and program analysis framework that claripy was originally developed for, and that clarirs aims to be used with.
  • z3: The SMT solver that claripy and clarirs use to solve constraints.
  • claricpp: A C++ implementation of claripy that was developed as part of the angr project.

License

Clarirs is free software licensed under the BSD 2-Clause License. See the LICENSE file for more information.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in clarirs by you, shall be licensed under the BSD 2-Clause License, without any additional terms or conditions.