Crate chacha20poly1305

ChaCha20Poly1305 (RFC 8439) is an Authenticated Encryption with Associated Data (AEAD) cipher amenable to fast, constant-time implementations in software, based on the ChaCha20 stream cipher and Poly1305 universal hash function.

This crate contains pure Rust implementations of ChaCha20Poly1305 (with optional AVX2 acceleration) as well as the following variants thereof:

• XChaCha20Poly1305 - ChaCha20Poly1305 variant with an extended 192-bit (24-byte) nonce.
• ChaCha8Poly1305 / ChaCha12Poly1305 - non-standard, reduced-round variants (gated under the reduced-round Cargo feature). See the Too Much Crypto paper for background and rationale on when these constructions could be used. When in doubt, prefer ChaCha20Poly1305.

Performance Notes

By default this crate will use portable software implementations of the underlying ChaCha20 and Poly1305 ciphers it's based on.

When targeting modern x86/x86_64 CPUs, use the following RUSTFLAGS to take advantage of AVX2 acceleration:

RUSTFLAGS="-Ctarget-feature=+avx2"

Ideally target the haswell or skylake architectures as a baseline:

RUSTFLAGS="-Ctarget-cpu=haswell -Ctarget-feature=+avx2"

Security Notes

This crate has received one security audit by NCC Group, with no significant findings. We would like to thank MobileCoin for funding the audit.

All implementations contained in the crate are designed to execute in constant time, either by relying on hardware intrinsics (i.e. AVX2 on x86/x86_64), or using a portable implementation which is only constant time on processors which implement constant-time multiplication.

It is not suitable for use on processors with a variable-time multiplication operation (e.g. short circuit on multiply-by-zero / multiply-by-one, such as certain 32-bit PowerPC CPUs and some non-ARM microcontrollers).

Usage

use chacha20poly1305::{ChaCha20Poly1305, Key, Nonce}; // Or `XChaCha20Poly1305`
use chacha20poly1305::aead::{Aead, NewAead};

let key = Key::from_slice(b"an example very very secret key."); // 32-bytes
let cipher = ChaCha20Poly1305::new(key);

let nonce = Nonce::from_slice(b"unique nonce"); // 12-bytes; unique per message

let ciphertext = cipher.encrypt(nonce, b"plaintext message".as_ref())
    .expect("encryption failure!");  // NOTE: handle this error to avoid panics!
let plaintext = cipher.decrypt(nonce, ciphertext.as_ref())
    .expect("decryption failure!");  // NOTE: handle this error to avoid panics!

assert_eq!(&plaintext, b"plaintext message");

In-place Usage (eliminates alloc requirement)

This crate has an optional alloc feature which can be disabled in e.g. microcontroller environments that don't have a heap.

The AeadInPlace::encrypt_in_place and AeadInPlace::decrypt_in_place methods accept any type that impls the aead::Buffer trait which contains the plaintext for encryption or ciphertext for decryption.

Note that if you enable the heapless feature of this crate, you will receive an impl of aead::Buffer for heapless::Vec (re-exported from the aead crate as [aead::heapless::Vec]), which can then be passed as the buffer parameter to the in-place encrypt and decrypt methods:

use chacha20poly1305::{ChaCha20Poly1305, Key, Nonce}; // Or `XChaCha20Poly1305`
use chacha20poly1305::aead::{AeadInPlace, NewAead};
use chacha20poly1305::aead::heapless::{Vec, consts::U128};

let key = Key::from_slice(b"an example very very secret key.");
let cipher = ChaCha20Poly1305::new(key);

let nonce = Nonce::from_slice(b"unique nonce"); // 128-bits; unique per message

let mut buffer: Vec<u8, U128> = Vec::new();
buffer.extend_from_slice(b"plaintext message");

// Encrypt `buffer` in-place, replacing the plaintext contents with ciphertext
cipher.encrypt_in_place(nonce, b"", &mut buffer).expect("encryption failure!");

// `buffer` now contains the message ciphertext
assert_ne!(&buffer, b"plaintext message");

// Decrypt `buffer` in-place, replacing its ciphertext context with the original plaintext
cipher.decrypt_in_place(nonce, b"", &mut buffer).expect("decryption failure!");
assert_eq!(&buffer, b"plaintext message");

Re-exports

pub use aead;

Structs

ChaChaPoly1305	Generic ChaCha+Poly1305 Authenticated Encryption with Additional Data (AEAD) construction.
XChaCha20Poly1305	xchacha20poly1305 ChaCha20Poly1305 variant with an extended 192-bit (24-byte) nonce.

Type Definitions

ChaCha8Poly1305	reduced-round ChaCha8Poly1305 (reduced round variant) Authenticated Encryption with Additional Data (AEAD).
ChaCha12Poly1305	reduced-round ChaCha12Poly1305 (reduced round variant) Authenticated Encryption with Additional Data (AEAD).
ChaCha20Poly1305	chacha20 ChaCha20Poly1305 Authenticated Encryption with Additional Data (AEAD).
Key	Key type (256-bits/32-bytes).
Nonce	Nonce type (96-bits/12-bytes).
Tag	Poly1305 tag.
XNonce	EXtended ChaCha20 nonce (192-bits/24-bytes)