Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
HACL Rust bindings
This is the hacl-star crate that provides Rust bindings for the HACL C package.
The FFI bindings are in the 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 | ||
| 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 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
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 test vectors.
They can be run with cargo test.
This will also run automatically generated binding tests from bindgen.