Le marteau-pilon, forges et aciéries de Saint-Chamond, Joseph-Fortuné LAYRAUD, 1889
Creusot is a deductive verifier for Rust code. It verifies your code is safe from panics, overflows, and assertion failures. By adding annotations you can take it further and verify your code does the correct thing.
Creusot works by translating Rust code to WhyML, the verification and specification language of Why3. Users can then leverage the full power of Why3 to (semi)-automatically discharge the verification conditions!
See ARCHITECTURE.md for technical details.
If you need help using Creusot or would like to discuss, you can post on the discussions forum or join our Zulip chat!
If you would like to cite Creusot in academic contexts, we encourage you to use our ICFEM'22 publication.
To get an idea of what verifying a program with Creusot looks like, we encourage you to take a look at some of our test suite:
- Zeroing out a vector
- Binary search on Vectors
- Sorting a vector
- IterMut
- Normalizing If-Then-Else Expressions
More examples are found in creusot/tests/should_succeed.
- CreuSAT is a verified SAT solver written in Rust and verified with Creusot. It really pushes the tool to its limits and gives an idea of what 'use in anger' looks like.
- Another big project is in the works :)
- Install
rustup
, to get the suitable Rust toolchain - Get
opam
, the package manager for OCaml - Clone the creusot repository,
then move into the
creusot
directory for the rest of the setup.$ git clone https://github.com/creusot-rs/creusot $ cd creusot
- Set up Why3 and Alt-Ergo. Create a local
opam
switch with why3 and alt-ergo:This will build why3, alt-ergo and their ocaml dependencies in a local$ opam switch create -y . ocaml.4.14.1 $ eval $(opam env)
_opam
directory. - Build Creusot:
this will build the
$ cargo install --path creusot-rustc $ cargo install --path cargo-creusot
cargo-creusot
andcreusot-rustc
executables and place them in~/.cargo/bin
. - Set up Creusot:
this will download additional solvers (Z3, CVC4, CVC5) and configure Why3 to use them.
$ cargo creusot setup install
- Enter the cloned Creusot git repository used previously to install Creusot
- Update Creusot's sources:
$ git pull
- Upgrade Why3 and Alt-Ergo if needed:
$ eval $(opam env) $ opam update $ opam install .
- Rebuild and reinstall Creusot:
$ cargo install --path creusot-rustc $ cargo install --path cargo-creusot
- Re-run Creusot's setup:
$ cargo creusot setup install
See the guide.
See HACKING.md for information on the developer workflow for hacking on the Creusot codebase.