Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 1.66 KB

README.md

File metadata and controls

58 lines (39 loc) · 1.66 KB

sodiumoxide

Build Status

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.

Dependencies

Sodium

Building

cargo build

Testing

cargo test

Documentation

cargo doc

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.

Documentation for the latest build can be found at gh-pages.

Examples

TBD

Join in

File bugs in the issue tracker

Master git repository

git clone https://github.com/dnaq/sodiumoxide.git

License

MIT

However the license will be changed to dual MIT/Apache-2.0 in the near future.

By contributing to the code you agree that the license of your contribution is MIT/Apache-2.0.