Something went wrong. Try again.
READ-ONLY MIRROR of the previous soteria repo
Something went wrong. Try again.
Files
- OCaml 76%
- Raku 10%
- Python 8%
- Rust 4%
- C 1%
- 3 more languages <1%
README.md
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./assets/LOGO-SOTERIA-FULL-WHITE.png">
<source media="(prefers-color-scheme: light)" srcset="./assets/LOGO-SOTERIA-FULL-COLOUR.png">
<img alt="Shows a black logo in light color mode and a white one in dark color mode." src="./assets/LOGO-SOTERIA-FULL-COLOUR.png">
</picture>
Soteria is a library for writing efficient symbolic interpreters directly in OCaml.
The core library is just a small toolbox that we use for writing a set of analyses, currently for C and Rust.
# Build instructions
To build the current repository, you first need to [install OCaml](https://ocaml.org/docs/installing-ocaml).
We then advise to create a local switch for development, and build the project:
```sh
opam switch create . --deps-only -y
dune build @all
```
If you want to run the build version of the code, you must also [install Z3](https://github.com/Z3Prover/z3).
You can make sure that everything is working properly by running the test suite:
```sh
dune test
```
# Soteria-c (working name)
Soteria-C is an automatic in-IDE bug finder for C programs. It is in heavy development.
It can currently be tested on standalone files by opening this project in VSCode.
To do so, open the `Run and Debug` tab of the sidebar, select the "Launch (Local)" configuration and click the "play" button.
# Soteria Rust
Soteria-Rust is a Kani-like symbolic execution engine for Rust. It is in heavy development.
It can run standalone files, symbolically executing the `main` function, or any function with the attribute `#[kani::proof]`, if in Kani mode (`--kani`).
```sh
soteria-rust rustc <file>
```
It can also run all tests in a crate:
```sh
soteria-rust cargo <crate dir>
```
You may add `--help` to either of these commands to see all available options.
## Frontend
To use Soteria Rust you must have a frontend installed; we support [Obol](https://github.com/soteria-tools/obol) (recommended) and [Charon](https://github.com/AeneasVerif/charon).
[Obol](https://github.com/soteria-tools/o…