creusot

About

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 Coma, an intermediate verification language of the Why3 Platform. Users can then leverage the full power of Why3 to (semi)-automatically discharge the verification conditions!

See ARCHITECTURE.md for technical details.

Help and Discussion

If you need help using Creusot or would like to discuss, you can post on the discussions forum or join our Zulip chat!

Citing Creusot

If you would like to cite Creusot in academic contexts, we encourage you to use our ICFEM'22 publication.

Examples of Verification

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 examples and tests/should_succeed.

Projects built with Creusot

• 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.
• Krabka is a Kafka broker written in Rust and key safety algorithms verified with Creusot
• Another big project is in the works :)

Installing Creusot as a user

1. Install rustup, to get the suitable Rust toolchain
2. Get opam, the package manager for OCaml
3. Clone the creusot repository, then move into the creusot directory.

   git clone https://github.com/creusot-rs/creusot
   cd creusot
   

4. Install Creusot:

   ./INSTALL
   

5. Check that the installation succeeded:

   cargo creusot --help
   

See the Creusot guide: Installation for more details.

Upgrading Creusot

1. Enter the cloned Creusot git repository used previously to install Creusot
2. Update Creusot's sources:

   git pull
   

3. Update opam's package listing:

   opam update
   

4. Reinstall Creusot:

   ./INSTALL
   

Hacking on Creusot

See CONTRIBUTING.md for information on the developer workflow for hacking on the Creusot codebase.