1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
#![no_std]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![doc = include_str!("../README.md")]
#![doc(
html_logo_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg",
html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg"
)]
#![forbid(unsafe_code)]
#![warn(missing_docs, rust_2018_idioms)]
//! # Usage
//!
#![cfg_attr(all(feature = "getrandom", feature = "std"), doc = "```")]
#![cfg_attr(not(all(feature = "getrandom", feature = "std")), doc = "```ignore")]
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! use crypto_secretbox::{
//! aead::{Aead, AeadCore, KeyInit, OsRng},
//! XSalsa20Poly1305, Nonce
//! };
//!
//! let key = XSalsa20Poly1305::generate_key(&mut OsRng);
//! let cipher = XSalsa20Poly1305::new(&key);
//! let nonce = XSalsa20Poly1305::generate_nonce(&mut OsRng); // unique per message
//! let ciphertext = cipher.encrypt(&nonce, b"plaintext message".as_ref())?;
//! let plaintext = cipher.decrypt(&nonce, ciphertext.as_ref())?;
//! assert_eq!(&plaintext, b"plaintext message");
//! # Ok(())
//! # }
//! ```
//!
//! ## 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:
//!
#![cfg_attr(
all(feature = "getrandom", feature = "heapless", feature = "std"),
doc = "```"
)]
#![cfg_attr(
not(all(feature = "getrandom", feature = "heapless", feature = "std")),
doc = "```ignore"
)]
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! use crypto_secretbox::{
//! aead::{AeadCore, AeadInPlace, KeyInit, OsRng, heapless::Vec},
//! XSalsa20Poly1305, Nonce,
//! };
//!
//! let key = XSalsa20Poly1305::generate_key(&mut OsRng);
//! let cipher = XSalsa20Poly1305::new(&key);
//! let nonce = XSalsa20Poly1305::generate_nonce(&mut OsRng); // unique per message
//!
//! let mut buffer: Vec<u8, 128> = Vec::new(); // Note: buffer needs 16-bytes overhead for auth tag
//! 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)?;
//!
//! // `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)?;
//! assert_eq!(&buffer, b"plaintext message");
//! # Ok(())
//! # }
//! ```
//!
//! ```
//! # #[cfg(feature = "heapless")]
//! # {
//! use crypto_secretbox::XSalsa20Poly1305;
//! use crypto_secretbox::aead::{AeadCore, AeadInPlace, KeyInit, generic_array::GenericArray};
//! use crypto_secretbox::aead::heapless::Vec;
//!
//! let key = GenericArray::from_slice(b"an example very very secret key.");
//! let cipher = XSalsa20Poly1305::new(key);
//!
//! let nonce = GenericArray::from_slice(b"extra long unique nonce!"); // 24-bytes; unique
//!
//! let mut buffer: Vec<u8, 128> = 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");
//! # }
//! ```
//!
//! [1]: https://nacl.cr.yp.to/secretbox.html
//! [2]: https://en.wikipedia.org/wiki/Authenticated_encryption
//! [3]: https://docs.rs/salsa20
//! [4]: http://docs.rs/chacha20poly1305
//! [5]: https://docs.rs/chacha20poly1305/latest/chacha20poly1305/struct.XChaCha20Poly1305.html
//! [6]: https://tools.ietf.org/html/rfc8439
pub use aead::{self, consts, AeadCore, AeadInPlace, Error, KeyInit, KeySizeUser};
pub use cipher;
use aead::{
consts::{U0, U16, U24, U32, U8},
generic_array::GenericArray,
Buffer,
};
use cipher::{IvSizeUser, KeyIvInit, StreamCipher};
use core::marker::PhantomData;
use poly1305::Poly1305;
use zeroize::{Zeroize, Zeroizing};
#[cfg(feature = "chacha20")]
use chacha20::{hchacha, ChaCha20Legacy as ChaCha20};
#[cfg(feature = "salsa20")]
use salsa20::{hsalsa, Salsa20};
#[cfg(any(feature = "chacha20", feature = "salsa20"))]
use cipher::consts::U10;
/// Key type.
pub type Key = GenericArray<u8, U32>;
/// Nonce type.
pub type Nonce = GenericArray<u8, U24>;
/// Poly1305 tag.
pub type Tag = GenericArray<u8, U16>;
/// `crypto_secretbox` instantiated with the XChaCha20 stream cipher.
///
/// NOTE: this is a legacy construction which is missing modern features like
/// additional associated data.
///
/// We do not recommend using it in greenfield applications, and instead only
/// using it for interop with legacy applications which require use of the
/// `crypto_secretbox` construction instantiated with XChaCha20.
///
/// For new applications, we recommend using the `AEAD_XChaCha20_Poly1305`
/// construction as described in [`draft-irtf-cfrg-xchacha`]. An implementation
/// of this IETF flavor of XChaCha20Poly1305 can be found in
/// [`chacha20poly1305::XChaCha20Poly1305`].
///
/// [`draft-irtf-cfrg-xchacha`]: https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-xchacha
/// [`chacha20poly1305::XChaCha20Poly1305`]: https://docs.rs/chacha20poly1305/latest/chacha20poly1305/type.XChaCha20Poly1305.html
#[cfg(feature = "chacha20")]
pub type XChaCha20Poly1305 = SecretBox<ChaCha20>;
/// `crypto_secretbox` instantiated with the XSalsa20 stream cipher.
#[cfg(feature = "salsa20")]
pub type XSalsa20Poly1305 = SecretBox<Salsa20>;
/// The NaCl `crypto_secretbox` authenticated symmetric encryption primitive,
/// generic
pub struct SecretBox<C> {
/// Secret key.
key: Key,
/// Cipher.
cipher: PhantomData<C>,
}
impl<C> SecretBox<C> {
/// Size of an XSalsa20Poly1305 key in bytes
pub const KEY_SIZE: usize = 32;
/// Size of an XSalsa20Poly1305 nonce in bytes
pub const NONCE_SIZE: usize = 24;
/// Size of a Poly1305 tag in bytes
pub const TAG_SIZE: usize = 16;
}
impl<C> SecretBox<C>
where
C: Kdf + KeyIvInit + KeySizeUser<KeySize = U32> + IvSizeUser<IvSize = U8> + StreamCipher,
{
/// Initialize cipher instance and Poly1305 MAC.
fn init_cipher_and_mac(&self, nonce: &Nonce) -> (C, Poly1305) {
let (nonce_prefix, nonce_suffix) = nonce.split_at(16);
let subkey = Zeroizing::new(C::kdf(&self.key, nonce_prefix.as_ref().into()));
let mut cipher = C::new(&subkey, nonce_suffix.as_ref().into());
// Derive Poly1305 key from the first 32-bytes of the keystream.
let mut mac_key = Zeroizing::new(poly1305::Key::default());
cipher.apply_keystream(&mut mac_key);
let mac = Poly1305::new(&mac_key);
(cipher, mac)
}
}
// Handwritten instead of derived to avoid `C: Clone` bound
impl<C> Clone for SecretBox<C> {
fn clone(&self) -> Self {
Self {
key: self.key,
cipher: PhantomData,
}
}
}
impl<C> KeySizeUser for SecretBox<C> {
type KeySize = U32;
}
impl<C> KeyInit for SecretBox<C> {
fn new(key: &Key) -> Self {
SecretBox {
key: *key,
cipher: PhantomData,
}
}
}
impl<C> AeadCore for SecretBox<C> {
type NonceSize = U24;
type TagSize = U16;
type CiphertextOverhead = U0;
}
impl<C> AeadInPlace for SecretBox<C>
where
C: Kdf + KeyIvInit + KeySizeUser<KeySize = U32> + IvSizeUser<IvSize = U8> + StreamCipher,
{
fn encrypt_in_place(
&self,
nonce: &Nonce,
associated_data: &[u8],
buffer: &mut dyn Buffer,
) -> Result<(), Error> {
let pt_len = buffer.len();
// Make room in the buffer for the tag. It needs to be prepended.
buffer.extend_from_slice(Tag::default().as_slice())?;
// TODO(tarcieri): add offset param to `encrypt_in_place_detached`
buffer.as_mut().copy_within(..pt_len, Self::TAG_SIZE);
let tag = self.encrypt_in_place_detached(
nonce,
associated_data,
&mut buffer.as_mut()[Self::TAG_SIZE..],
)?;
buffer.as_mut()[..Self::TAG_SIZE].copy_from_slice(tag.as_slice());
Ok(())
}
fn encrypt_in_place_detached(
&self,
nonce: &Nonce,
associated_data: &[u8],
buffer: &mut [u8],
) -> Result<Tag, Error> {
// AAD unsupported
if !associated_data.is_empty() {
return Err(Error);
}
let (mut cipher, mac) = self.init_cipher_and_mac(nonce);
cipher.apply_keystream(buffer);
Ok(mac.compute_unpadded(buffer))
}
fn decrypt_in_place(
&self,
nonce: &Nonce,
associated_data: &[u8],
buffer: &mut dyn Buffer,
) -> Result<(), Error> {
if buffer.len() < Self::TAG_SIZE {
return Err(Error);
}
let tag = Tag::clone_from_slice(&buffer.as_ref()[..Self::TAG_SIZE]);
self.decrypt_in_place_detached(
nonce,
associated_data,
&mut buffer.as_mut()[Self::TAG_SIZE..],
&tag,
)?;
let pt_len = buffer.len() - Self::TAG_SIZE;
// TODO(tarcieri): add offset param to `encrypt_in_place_detached`
buffer.as_mut().copy_within(Self::TAG_SIZE.., 0);
buffer.truncate(pt_len);
Ok(())
}
fn decrypt_in_place_detached(
&self,
nonce: &Nonce,
associated_data: &[u8],
buffer: &mut [u8],
tag: &Tag,
) -> Result<(), Error> {
// AAD unsupported
if !associated_data.is_empty() {
return Err(Error);
}
let (mut cipher, mac) = self.init_cipher_and_mac(nonce);
let expected_tag = mac.compute_unpadded(buffer);
// This performs a constant-time comparison using the `subtle` crate
use subtle::ConstantTimeEq;
if expected_tag.ct_eq(tag).into() {
cipher.apply_keystream(buffer);
Ok(())
} else {
Err(Error)
}
}
}
impl<C> Drop for SecretBox<C> {
fn drop(&mut self) {
self.key.as_mut_slice().zeroize();
}
}
/// Key derivation function: trait for abstracting over HSalsa20 and HChaCha20.
pub trait Kdf {
/// Derive a new key from the provided input key and nonce.
fn kdf(key: &Key, nonce: &GenericArray<u8, U16>) -> Key;
}
impl<C> Kdf for SecretBox<C>
where
C: Kdf,
{
fn kdf(key: &Key, nonce: &GenericArray<u8, U16>) -> Key {
C::kdf(key, nonce)
}
}
#[cfg(feature = "chacha20")]
impl Kdf for ChaCha20 {
fn kdf(key: &Key, nonce: &GenericArray<u8, U16>) -> Key {
hchacha::<U10>(key, nonce)
}
}
#[cfg(feature = "salsa20")]
impl Kdf for Salsa20 {
fn kdf(key: &Key, nonce: &GenericArray<u8, U16>) -> Key {
hsalsa::<U10>(key, nonce)
}
}