codyps / sodalite

tweetnacl in rust

sodalite

An implementation of tweetnacl in pure rust. Originally generated by manually translating tweetnacl.c into rust. Tested by verifying outputs match those of tweetnacl.

• 
• 
• sodalite
• tweetnacl
• tweetnacl-sys

Todo

• provide additional APIs:
• rather than take bare mutable references, use wrapper types around the refs to capture the underlying type (ie: prevent mixing keys between primitives)
• add a buffer and/or "set-only" abstraction to prevent unsafety wrt uninitialized values (also should allow some internal optimization).
• sodiumoxide style API that returns values rather than taking mutable refs
• Use namespacing to separate different APIs and backend impls
• start testing against sodiumoxide as well
• Provide some of the API improvements from libsodium that are missing nacl (disjoint signatures, not requiring special extra space in buffers)

License

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.

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.

sodalite's Issues

Question about secretbox

Dear sodalite developer,

I have been using your library and I have a question about the secretbox function. In the documentation, it states that the first 32 bytes of the message must be zero. Can you explain why this is necessary?

Thank you for your time and for creating this library.

Best regards,
Aitor Ruiz

doesn't pass clippy

Get 'signal: 11, SIGSEGV: invalid memory reference'

When I use secretbox_open API I got 'signal: 11, SIGSEGV: invalid memory reference', below is some demo code:

const NONCE_LENGTH: usize = 24;

fn decrypt_content(password: &str, encrypted: &str) -> Result<String> {

    let encrypted_bytes = hex::decode(encrypted)?;
    let nonce: &[u8; 24] = &encrypted_bytes[0..NONCE_LENGTH].try_into().unwrap();
    println!("nonce: {}", hex::encode(nonce.clone()));
    let cipher_text = &encrypted_bytes[NONCE_LENGTH..];
    println!("cipher_text: {}", hex::encode(cipher_text.clone()));
    let mut encoded = Vec::<u8>::new();
    encoded.resize(cipher_text.len(), 0u8);

    let key = password_to_key(password);  // return a [u8; 32]

    println!("key: {}", hex::encode(key.clone()));
    let ret = secretbox_open(&mut encoded, cipher_text, nonce, &key);
    assert!(ret.is_ok(), "open secretbox failed");

    println!("encoded: {}", hex::encode(encoded.clone()));
   
    Ok(hex::encode(encoded))
}

Pls give me some suggestions