hacl 0.0.1-dev.1

Crypto library using formally verified code from the HACL project
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

# HACL Rust bindings

![Maturity Level][maturity-badge]
[![Build & Test][github-actions-badge]][github-actions-link]

This is the `hacl-star` crate that provides Rust bindings for the HACL C package.
The FFI bindings are in the [hacl-star-sys](hacl-star-sys/) crates.

**⚠️ Note:** This crate is still work in progress.
Don't use in production just yet.

| Platform    | Supported |
| :---------- | :-------: |
| MacOS       |    ✅     |
| MacOS Arm64 |    ✅     |
| iOS         |    ✅     |
| Linux x64   |    ✅     |
| Linux x86   |    ✅     |
| Windows x64 |    ✅     |
| Arm64 Linux |    ✅     |
| Arm32 Linux |    ✅     |

## Crates

| Name          | Crates.io                                                                         |                         Docs                         |
| :------------ | :-------------------------------------------------------------------------------- | :--------------------------------------------------: |
| hacl-star-sys | [![crates.io][hacl-star-sys-crate-badge]](https://crates.io/crates/hacl-star-sys) | [![Docs][docs-badge]](https://docs.rs/hacl-star-sys) |
| hacl-star     | [![crates.io][hacl-star-crate-badge]](https://crates.io/crates/hacl-star)         |   [![Docs][docs-badge]](https://docs.rs/hacl-star)   |

## Features

By default the hacl-star crate includes the `random` feature that allows generating random values (keys, nonces, etc.).
But this is not verified code and uses the [rand](https://crates.io/crates/rand) crate. It can be disabled with `--no-default-features`.
Please bring your own randomness if you want to be safe.

## Platforms

See above for a list of supported platforms.

### Building

```bash
cd ../
./mach rust
cd -
cargo build
```

Please see the [top level readme] for how to build.

## Benchmarks

To run benchmarks use `cargo bench`.

## Tests

All primitives are tested against the [Wycheproof](https://github.com/google/wycheproof) test vectors.
They can be run with `cargo test`.
This will also run automatically generated binding tests from bindgen.

[maturity-badge]: https://img.shields.io/badge/maturity-beta-orange.svg?style=for-the-badge
[github-actions-badge]: https://img.shields.io/github/actions/workflow/status/cryspen/hacl-packages/rust.yml?label=build%20%26%20tests&logo=github&style=for-the-badge&branch=main
[github-actions-link]: https://github.com/cryspen/hacl-packages/actions/workflows/rust.yml?query=branch%3Amain
[hacl-star-crate-badge]: https://img.shields.io/crates/v/hacl-star.svg?style=for-the-badge
[hacl-star-sys-crate-badge]: https://img.shields.io/crates/v/hacl-star-sys.svg?style=for-the-badge
[docs-badge]: https://img.shields.io/badge/docs-blue.svg?style=for-the-badge
[top level readme]: https://github.com/cryspen/hacl-packages#readme