dryoc is a pure-Rust, general-purpose cryptography library. It’s also an implementation of libsodium, and designed to be 100% compatible with, and interchangeable with, libsodium’s API.
Doing cryptography properly is hard. While no human is infallible, computers are pretty good at following instructions. Humans are bad at following instructions, but they do a decent job of giving instructions, provided they can effectively communicate intent. Thus, if the instructions humans give the computer are correct, we can be reasonably assured that the operations the computer does are correct too.
This library tries to make it easy to give the computer the correct instructions, and it does so by providing well-known implementations of general-purpose cryptography functions, in an API that’s relatively easy to use, type safe, and hard to use incorrectly.
As the name of this library implies, one should avoid trying to “roll their own crypto”, as it often results in avoidable mistakes. In the context of cryptography, mistakes can be very costly.
The minimum supported Rust version (MSRV) for this crate is Rust 1.51 or newer.
- 100% pure Rust
- mostly free of unsafe code2
- free of corporate and governmental influence
- automatic safety features such as zeroization of data structures (via Drop and Zeroize)
- protected memory support, with an API designed such that it’s hard to accidentally unprotect your memory
- designed to be especially difficult to use incorrectly3
- provides compatibility with libsodium, and implements most of its core functions
- covers common use cases for safe encryption, hashing, and message authentication
- reentrant and thread safe (no internal state, with the exception of using
lazy_staticfor protected memory to determine page size)
- available under the LGPL3 license
This library includes both a Classic API, which is very similar to the original libsodium API, and Rustaceous API with Rust-specific features. Both APIs can be used together interchangeably, according to your preferences. The Rustaceous API is a wrapper around the underlying classic API.
It’s recommended that you use the Rustaceous API unless you have strong feelings about using the Classic API. The Classic API includes some pitfalls and traps that are also present in the original libsodium API, and unless you’re extra careful you could make mistakes. With the Rustaceous API, it’s harder to make mistakes thanks to strict type and safety features.
The Rustaceous API is, arguably, somewhat trickier to use, especially if you’re new to Rust. The Rustaceous API requires knowing and specifying the desired type in many cases. For your convenience, type aliases are provided for common types within each module. The Classic API only uses base types (fixed length byte arrays and byte slices).
|Feature||Rustaceous API||Classic API||Libsodium Docs|
|Public-key authenticated boxes||Link|
|Secret-key authenticated boxes||Link|
This crate has not been audited by any 3rd parties. It uses well-known implementations of the underlying algorithms which have been previously verified as using constant-time operations.
With that out of the way, the deterministic nature of cryptography and extensive testing used in this crate means it’s relatively safe to use, provided the underlying algorithms remain safe. Arguably, this crate is incredibly safe (as far as cryptography libraries go) thanks to the features provided by the API of this crate, and those provided by the Rust language itself.
Not actually trademarked. ↩
The Rustaceous API is designed to protect users of this library from making mistakes, however the Classic API allows one to do as one pleases. ↩
Currently only available on nightly Rust, with the
nightlyfeature flag enabled. ↩
Secret-key message authentication
Constant value definitions
Public-key authenticated encryption
Secret-key authenticated encryption
Key derivation functions
Public/secret keypair tools
Key exchange functions
Memory protection utilities
Password hashing functions
Random number generation utilities
SHA-512 hash algorithm
Base type definitions
Various utility functions
Errors generated by Dryoc.