hacspec hacspec chat

A specification language for crypto primitives in Rust.

This is the successor of https://github.com/HACS-workshop/hacspec.

Crates

Name Crates.io Docs CI
hacspec crates.io   Build & Test Status
hacspec-lib crates.io Docs Build & Test Status
hacspec-provider crates.io Docs Build & Test Status

Usage

Writing hacspec

hacspec is always valid Rust code such that starting to write hacspec is as simple as writing Rust code that is compliant with the language specification. However, this is very tedious. It is recommended to use the hacspec standard library to write hacspec. In order to ensure that the code is a hacspec one can use the typecheker.

Typechecking

Make sure you have at least rustup 1.23.0. The rust-toolchain automatically picks the correct Rust nightly version and components. The compiler version is currently pinned to nightly-2021-03-11.

Installing the typechecker from the repository

cargo install --path language

Installing the typechecker from crates.io (not always up to date)

cargo install hacspec --version 0.2.0-beta.4

Manually installing dependencies

First ensure that Rust nightly is installed and the typechecker is installed.

cd language
rustup toolchain install nightly-2021-03-11
rustup component add --toolchain nightly-2021-03-11 rustc-dev
cargo +nightly-2021-03-11 install hacspec

Depending on your system you might also need llvm-tools-preview

rustup component add --toolchain nightly-2021-03-11 llvm-tools-preview

Usage

In a hacspec crate or workspace directory typechecking can be done as follows now: (Specifying +nightly-2021-03-11 is only necessary if it’s not specified in the toolchain as it is in this main repository.)

cargo +nightly-2021-03-11 hacspec <crate-name>

Note that the crate dependencies need to be compiled before it can be typechecked.

cargo +nightly-2021-03-11 build

If typechecking succeeds, it should show

> Successfully typechecked.

Generating code

To generate F* or EasyCrypt code from hacspec the typechecker (see above) is required.

cargo +nightly-2021-03-11 hacspec -o <fst-name>.fst <crate-name>
cargo +nightly-2021-03-11 hacspec -o <ec-name>.ec <crate-name>

Publications & Other material

Repository Structure

This is a cargo workspace consisting of three main crates:

The three main crates make use of a set of additional crates:

Compiled code:

Contributing

Before starting any work please join the Zulip chat, start a discussion on Github, or file an issue to discuss your contribution.

The main entry points for contributions and some general work items are

Examples

There’s a set of example specs, divided between the safe and unsafe. To run all examples one can use cargo test.

Examples

Unsafe examples