NaCl (pronounced "salt") is a new easy-to-use high-speed software library for network communication, encryption, decryption, signatures, etc. NaCl's goal is to provide all of the core operations needed to build higher-level cryptographic tools. Of course, other libraries already exist for these core operations. NaCl advances the state of the art by improving security, by improving usability, and by improving speed.
Sodium is a portable, cross-compilable, installable, packageable fork of NaCl (based on the latest released upstream version nacl-20110221), with a compatible API.
This package aims to provide a type-safe and efficient Rust binding that's just as easy to use.
Clang >= 3.9
brew install pkg-config)
Documentation will be generated in target/doc/...
Most documentation is taken from NaCl, with minor modification where the API differs between the C and Rust versions.
Several optional features are available:
std(default: enabled). When this feature is disabled, sodiumoxide builds using
#![no_std]. Some functionality may be lost. Requires a nightly build of Rust.
serde(default: enabled). Allows serialization and deserialization of keys, authentication tags, etc. using the serde library.
benchmarks(default: disabled). Compile benchmark tests. Requires a nightly build of Rust.
Sodiumoxide has been tested on:
- Linux: Yes
- Windows: Yes (MSVC)
- Mac OS:
To build sodiumoxide using libsodium from vcpkg, you have to add either
VCPKGRS_DYNAMIC=1 (for dynamic linking) or
RUSTFLAGS=-Ctarget-feature=+crt-static (for static linking) to environment variables.
Regardless of the OS, to link libsodium statically you also need to set
SODIUM_STATIC environment variable.
File bugs in the issue tracker
Master git repository
git clone https://github.com/sodiumoxide/sodiumoxide.git
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Go through the CONTRIBUTING.md document to know more about how to contribute to this project.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Code of Conduct
We believe in creating an enabling community for developers and have laid out a general code of conduct. Please read and adopt it to help us achieve and maintain the desired community standards.