Skip to content

Latest commit

 

History

History

lib

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

simple-secrets.rs Build Status

The Rust implementation of a simple, opinionated library for encrypting small packets of data securely. Designed for exchanging tokens among systems written in a variety of programming languages:

Examples

Rust API Documentation

Basic

Send:

use simple_secrets::Sender;

// Try `head /dev/urandom | shasum -a 256` to make a decent 256-bit key
let sender = Sender::new("<64-char hex string master key (32 bytes, 256 bits)>").unwrap();
let packet = sender.pack("this is a secret message").unwrap();
// => 'Qr4m7AughkcQIRqQvlyXiB67EwHdBf5n9JD2s_Z9NpO4ksPGvLYjNbDm3HRzvFXFSpV2IqDQw_LTamndMh2c7iOQT0lSp4LstqJPAtoQklU5sb7JHYyTOuf-6W-q7W8gAnq1wCs5'
// Initialize from any [u8; 32] if your key is already in bytes
let sender = Sender::from([0x9f; 32]);

Receive:

use simple_secrets::Sender;

// Same shared key
let sender = Sender::new("<64-char hex string master key (32 bytes, 256 bits)>").unwrap();
// Read data from somewhere
let packet = "OqlG6KVMeyFYmunboS3HIXkvN_nXKTxg2yNkQydZOhvJrZvmfov54hUmkkiZCnlhzyrlwOJkbV7XnPPbqvdzZ6TsFOO5YdmxjxRksZmeIhbhLaMiDbfsOuSY1dBn_ZgtYCw-FRIM".to_string();
let secret_message = sender.unpack(packet).unwrap();
// => { "msg" => "this is a secret message" }

Can you add ...

This implementation follows the spec for the Node.js version for 100% compatibility.

License

Licensed under either of

at your option.

Contribution

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.