Crate License Coverage Status Workflow Status Maintenance

double-ratchet-2

Implementation of the double ratchet system/encryption as specified by Signal.

The implementation follows the cryptographic recommendations provided by Signal. The AEAD Algorithm uses a constant Nonce. This might be changed in the future.

Example Usage:

Standard:

```rust use doubleratchet2::ratchet::Ratchet;

let sk = [1; 32]; // Initial Key created by a symmetric key agreement protocol let (mut bobratchet, publickey) = Ratchet::initbob(sk); // Creating Bobs Ratchet (returns Bobs PublicKey) let mut aliceratchet = Ratchet::initalice(sk, publickey); // Creating Alice Ratchet with Bobs PublicKey let data = b"Hello World".to_vec(); // Data to be encrypted let ad = b"Associated Data"; // Associated Data

let (header, encrypted, nonce) = aliceratchet.ratchetencrypt(&data, ad); // Encrypting message with Alice Ratchet (Alice always needs to send the first message) let decrypted = bobratchet.ratchetdecrypt(&header, &encrypted, &nonce, ad); // Decrypt message with Bobs Ratchet assert_eq!(data, decrypted) ```

With lost message:

```rust

let sk = [1; 32]; // Initial Key created by a symmetric key agreement protocol let (mut bobratchet, publickey) = Ratchet::initbob(sk); // Creating Bobs Ratchet (returns Bobs PublicKey) let mut aliceratchet = Ratchet::initalice(sk, publickey); // Creating Alice Ratchet with Bobs PublicKey let data = b"Hello World".to_vec(); // Data to be encrypted let ad = b"Associated Data"; // Associated Data

let (header1, encrypted1, nonce1) = aliceratchet.ratchetencrypt(&data, ad); // Lost message let (header2, encrypted2, nonce2) = aliceratchet.ratchetencrypt(&data, ad); // Successful message

let decrypted2 = bobratchet.ratchetdecrypt(&header2, &encrypted2, &nonce2, ad); // Decrypting second message first let decrypted1 = bobratchet.ratchetdecrypt(&header1, &encrypted1, &nonce1, ad); // Decrypting latter message

let comp = decrypted1 == data && decrypted2 == data; assert!(comp); ```

Encryption before recieving inital message

```rust use doubleratchet2::ratchet::Ratchet; let sk = [1; 32]; let ad = b"Associated Data"; let (mut bobratchet, _) = Ratchet::initbob(sk); let data = b"Hello World".to_vec();

let (, _, _) = bobratchet.ratchet_encrypt(&data, ad); ```

Encryption after recieving initial message

However bob can (of course) also encrypt messages. This is possible, after decrypting the first message from alice.

```rust use doubleratchet2::ratchet::Ratchet; let sk = [1; 32];

let (mut bobratchet, publickey) = Ratchet::initbob(sk); let mut aliceratchet = Ratchet::initalice(sk, publickey);

let data = b"Hello World".to_vec(); let ad = b"Associated Data";

let (header1, encrypted1, nonce1) = aliceratchet.ratchetencrypt(&data, ad); let decrypted1 = bobratchet.ratchet_decrypt(&header1, &encrypted1, &nonce1, ad);

let (header2, encrypted2, nonce2) = bobratchet.ratchetencrypt(&data, ad); let decrypted2 = aliceratchet.ratchetdecrypt(&header2, &encrypted2, &nonce2, ad);

assert_eq!(data, decrypted2); ```

Constructing and Deconstructing Headers

rust let header_bytes: Vec<u8> = header.clone().into(); let header_const = Header::from(header_bytes); assert_eq!(header, header_const);

Example Ratchet with encrypted headers

```rust use doubleratchet2::ratchet::RatchetEncHeader; let sk = [0; 32]; let sharedhka = [1; 32]; let sharednhkb = [2; 32];

let (mut bobratchet, publickey) = RatchetEncHeader::initbob(sk, sharedhka, sharednhkb); let mut aliceratchet = RatchetEncHeader::initalice(sk, publickey, sharedhka, sharednhkb); let data = b"Hello World".to_vec(); let ad = b"Associated Data";

let (header, encrypted, nonce) = aliceratchet.ratchetencrypt(&data, ad); let decrypted = bobratchet.ratchetdecrypt(&header, &encrypted, &nonce, ad); assert_eq!(data, decrypted) ```

Export / Import Ratchet with encrypted headers

This ratchet implements import and export functionality. This works over a bincode backend and maybe useful for saving Ratchets to and loading from a file. rust let (bob_ratchet, public_key) = RatchetEncHeader::init_bob(sk, shared_hka, shared_nhkb); let ex_ratchet = bob_ratchet.export(); let im_ratchet = RatchetEncHeader::import(&ex_ratchet); assert_eq!(im_ratchet, bob_ratchet)

Features

Currently the crate only supports one feature: ring. If feature is enabled the crate switches to ring-compat and uses ring as backend for Sha512 Hashing. May result in slightly better performance.

TODO: - [x] Standard Double Ratchet - [x] [Double Ratchet with encrypted headers][3]

Current version: 0.3.4

License: MIT