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 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
//! Authenticated Encryption with Associated Data (AEAD) traits //! //! This crate provides an abstract interface for AEAD ciphers, which guarantee //! both confidentiality and integrity, even from a powerful attacker who is //! able to execute [chosen-ciphertext attacks]. The resulting security property, //! [ciphertext indistinguishability], is considered a basic requirement for //! modern cryptographic implementations. //! //! See [RustCrypto/AEADs] for cipher implementations which use this trait. //! //! [chosen-ciphertext attacks]: https://en.wikipedia.org/wiki/Chosen-ciphertext_attack //! [ciphertext indistinguishability]: https://en.wikipedia.org/wiki/Ciphertext_indistinguishability //! [RustCrypto/AEADs]: https://github.com/RustCrypto/AEADs #![no_std] #[cfg(feature = "alloc")] extern crate alloc; pub use generic_array; #[cfg(feature = "heapless")] pub use heapless; #[cfg(feature = "alloc")] use alloc::vec::Vec; use generic_array::{typenum::Unsigned, ArrayLength, GenericArray}; #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] pub struct Error; /// Implement the `decrypt_in_place` method on `Aead` and `AeadMut`. /// Uses a macro to gloss over `&self` vs `&mut self`. /// /// Assumes a postfix authentication tag. AEAD ciphers which do not use a /// postfix authentication tag will need to define their own implementation. macro_rules! impl_decrypt_in_place { ($aead:expr, $nonce:expr, $aad:expr, $buffer:expr) => {{ if $buffer.len() < Self::TagSize::to_usize() { return Err(Error); } let tag_pos = $buffer.len() - Self::TagSize::to_usize(); let (msg, tag) = $buffer.as_mut().split_at_mut(tag_pos); $aead.decrypt_in_place_detached($nonce, $aad, msg, GenericArray::from_slice(tag))?; $buffer.truncate(tag_pos); Ok(()) }}; } /// Instantiate either a stateless [`Aead`] or stateful [`AeadMut`] algorithm. pub trait NewAead { /// The size of the key array required by this algorithm. type KeySize: ArrayLength<u8>; /// Construct a new stateful instance for the given key. fn new(key: GenericArray<u8, Self::KeySize>) -> Self; } /// Authenticated Encryption with Associated Data (AEAD) algorithm. /// /// This trait is intended for use with stateless AEAD algorithms. The /// [`AeadMut`] trait provides a stateful interface. pub trait Aead { /// The length of a nonce. type NonceSize: ArrayLength<u8>; /// The maximum length of the nonce. type TagSize: ArrayLength<u8>; /// The upper bound amount of additional space required to support a /// ciphertext vs. a plaintext. type CiphertextOverhead: ArrayLength<u8> + Unsigned; /// Encrypt the given plaintext payload, and return the resulting /// ciphertext as a vector of bytes. /// /// The [`Payload`] type can be used to provide Additional Associated Data /// (AAD) along with the message: this is an optional bytestring which is /// not encrypted, but *is* authenticated along with the message. Failure /// to pass the same AAD that was used during encryption will cause /// decryption to fail, which is useful if you would like to "bind" the /// ciphertext to some other identifier, like a digital signature key /// or other identifier. /// /// If you don't care about AAD and just want to encrypt a plaintext /// message, `&[u8]` will automatically be coerced into a `Payload`: /// /// ```nobuild /// let plaintext = b"Top secret message, handle with care"; /// let ciphertext = cipher.encrypt(nonce, plaintext); /// ``` /// /// The default implementation assumes a postfix tag (ala AES-GCM, /// AES-GCM-SIV, ChaCha20Poly1305). [`Aead`] implementations which do not /// use a postfix tag will need to override this to correctly assemble the /// ciphertext message. #[cfg(feature = "alloc")] fn encrypt<'msg, 'aad>( &self, nonce: &GenericArray<u8, Self::NonceSize>, plaintext: impl Into<Payload<'msg, 'aad>>, ) -> Result<Vec<u8>, Error> { let payload = plaintext.into(); let mut buffer = Vec::with_capacity(payload.msg.len() + Self::TagSize::to_usize()); buffer.extend_from_slice(payload.msg); self.encrypt_in_place(nonce, payload.aad, &mut buffer)?; Ok(buffer) } /// Encrypt the given buffer containing a plaintext message in-place. /// /// The buffer must have sufficient capacity to store the ciphertext /// message, which will always be larger than the original plaintext. /// The exact size needed is cipher-dependent, but generally includes /// the size of an authentication tag. /// /// Returns an error if the buffer has insufficient capacity to store the /// resulting ciphertext message. fn encrypt_in_place( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer, ) -> Result<(), Error> { let tag = self.encrypt_in_place_detached(nonce, associated_data, buffer.as_mut())?; buffer.extend_from_slice(tag.as_slice())?; Ok(()) } /// Encrypt the data in-place, returning the authentication tag fn encrypt_in_place_detached( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut [u8], ) -> Result<GenericArray<u8, Self::TagSize>, Error>; /// Decrypt the given ciphertext slice, and return the resulting plaintext /// as a vector of bytes. /// /// See notes on [`Aead::encrypt()`] about allowable message payloads and /// Associated Additional Data (AAD). /// /// If you have no AAD, you can call this as follows: /// /// ```nobuild /// let ciphertext = b"..."; /// let plaintext = cipher.decrypt(nonce, ciphertext)?; /// ``` /// /// The default implementation assumes a postfix tag (ala AES-GCM, /// AES-GCM-SIV, ChaCha20Poly1305). [`Aead`] implementations which do not /// use a postfix tag will need to override this to correctly parse the /// ciphertext message. #[cfg(feature = "alloc")] fn decrypt<'msg, 'aad>( &self, nonce: &GenericArray<u8, Self::NonceSize>, ciphertext: impl Into<Payload<'msg, 'aad>>, ) -> Result<Vec<u8>, Error> { let payload = ciphertext.into(); let mut buffer = Vec::from(payload.msg); self.decrypt_in_place(nonce, payload.aad, &mut buffer)?; Ok(buffer) } /// Decrypt the message in-place, returning an error in the event the /// provided authentication tag does not match the given ciphertext. /// /// The buffer will be truncated to the length of the original plaintext /// message upon success. fn decrypt_in_place( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer, ) -> Result<(), Error> { impl_decrypt_in_place!(self, nonce, associated_data, buffer) } /// Decrypt the message in-place, returning an error in the event the provided /// authentication tag does not match the given ciphertext (i.e. ciphertext /// is modified/unauthentic) fn decrypt_in_place_detached( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut [u8], tag: &GenericArray<u8, Self::TagSize>, ) -> Result<(), Error>; } /// Stateful Authenticated Encryption with Associated Data algorithm. pub trait AeadMut { /// The length of a nonce. type NonceSize: ArrayLength<u8>; /// The maximum length of the nonce. type TagSize: ArrayLength<u8>; /// The upper bound amount of additional space required to support a /// ciphertext vs. a plaintext. type CiphertextOverhead: ArrayLength<u8> + Unsigned; /// Encrypt the given plaintext slice, and return the resulting ciphertext /// as a vector of bytes. /// /// See notes on [`Aead::encrypt()`] about allowable message payloads and /// Associated Additional Data (AAD). #[cfg(feature = "alloc")] fn encrypt<'msg, 'aad>( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, plaintext: impl Into<Payload<'msg, 'aad>>, ) -> Result<Vec<u8>, Error> { let payload = plaintext.into(); let mut buffer = Vec::with_capacity(payload.msg.len() + Self::TagSize::to_usize()); buffer.extend_from_slice(payload.msg); self.encrypt_in_place(nonce, payload.aad, &mut buffer)?; Ok(buffer) } /// Encrypt the given buffer containing a plaintext message in-place. /// /// The buffer must have sufficient capacity to store the ciphertext /// message, which will always be larger than the original plaintext. /// The exact size needed is cipher-dependent, but generally includes /// the size of an authentication tag. /// /// Returns an error if the buffer has insufficient capacity to store the /// resulting ciphertext message. fn encrypt_in_place( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer, ) -> Result<(), Error> { let tag = self.encrypt_in_place_detached(nonce, associated_data, buffer.as_mut())?; buffer.extend_from_slice(tag.as_slice())?; Ok(()) } /// Encrypt the data in-place, returning the authentication tag fn encrypt_in_place_detached( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut [u8], ) -> Result<GenericArray<u8, Self::TagSize>, Error>; /// Decrypt the given ciphertext slice, and return the resulting plaintext /// as a vector of bytes. /// /// See notes on [`Aead::encrypt()`] and [`Aead::decrypt()`] about allowable /// message payloads and Associated Additional Data (AAD). #[cfg(feature = "alloc")] fn decrypt<'msg, 'aad>( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, ciphertext: impl Into<Payload<'msg, 'aad>>, ) -> Result<Vec<u8>, Error> { let payload = ciphertext.into(); let mut buffer = Vec::from(payload.msg); self.decrypt_in_place(nonce, payload.aad, &mut buffer)?; Ok(buffer) } /// Decrypt the message in-place, returning an error in the event the /// provided authentication tag does not match the given ciphertext. /// /// The buffer will be truncated to the length of the original plaintext /// message upon success. fn decrypt_in_place( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer, ) -> Result<(), Error> { impl_decrypt_in_place!(self, nonce, associated_data, buffer) } /// Decrypt the data in-place, returning an error in the event the provided /// authentication tag does not match the given ciphertext (i.e. ciphertext /// is modified/unauthentic) fn decrypt_in_place_detached( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut [u8], tag: &GenericArray<u8, Self::TagSize>, ) -> Result<(), Error>; } /// A blanket implementation of the Stateful AEAD interface for Stateless /// AEAD implementations. impl<Algo: Aead> AeadMut for Algo { type NonceSize = Algo::NonceSize; type TagSize = Algo::TagSize; type CiphertextOverhead = Algo::CiphertextOverhead; /// Encrypt the given plaintext slice, and return the resulting ciphertext /// as a vector of bytes. #[cfg(feature = "alloc")] fn encrypt<'msg, 'aad>( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, plaintext: impl Into<Payload<'msg, 'aad>>, ) -> Result<Vec<u8>, Error> { <Self as Aead>::encrypt(self, nonce, plaintext) } /// Encrypt the given buffer containing a plaintext message in-place. fn encrypt_in_place( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer, ) -> Result<(), Error> { <Self as Aead>::encrypt_in_place(self, nonce, associated_data, buffer) } /// Encrypt the data in-place, returning the authentication tag fn encrypt_in_place_detached( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut [u8], ) -> Result<GenericArray<u8, Self::TagSize>, Error> { <Self as Aead>::encrypt_in_place_detached(self, nonce, associated_data, buffer) } /// Decrypt the given ciphertext slice, and return the resulting plaintext /// as a vector of bytes. #[cfg(feature = "alloc")] fn decrypt<'msg, 'aad>( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, ciphertext: impl Into<Payload<'msg, 'aad>>, ) -> Result<Vec<u8>, Error> { <Self as Aead>::decrypt(self, nonce, ciphertext) } /// Decrypt the message in-place, returning an error in the event the /// provided authentication tag does not match the given ciphertext. fn decrypt_in_place( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer, ) -> Result<(), Error> { <Self as Aead>::decrypt_in_place(self, nonce, associated_data, buffer) } /// Decrypt the data in-place, returning an error in the event the provided /// authentication tag does not match the given ciphertext (i.e. ciphertext /// is modified/unauthentic) fn decrypt_in_place_detached( &mut self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut [u8], tag: &GenericArray<u8, Self::TagSize>, ) -> Result<(), Error> { <Self as Aead>::decrypt_in_place_detached(self, nonce, associated_data, buffer, tag) } } /// AEAD payloads are a combination of a message (plaintext or ciphertext) /// and "additional associated data" (AAD) to be authenticated (in cleartext) /// along with the message. /// /// If you don't care about AAD, you can pass a `&[u8]` as the payload to /// `encrypt`/`decrypt` and it will automatically be coerced to this type. pub struct Payload<'msg, 'aad> { /// Message to be encrypted/decrypted pub msg: &'msg [u8], /// Optional "additional associated data" to authenticate along with /// this message. If AAD is provided at the time the message is encrypted, /// the same AAD *MUST* be provided at the time the message is decrypted, /// or decryption will fail. pub aad: &'aad [u8], } impl<'msg, 'aad> From<&'msg [u8]> for Payload<'msg, 'aad> { fn from(msg: &'msg [u8]) -> Self { Self { msg, aad: b"" } } } /// In-place encryption/decryption byte buffers. /// /// This trait defines the set of methods needed to support in-place operations /// on a `Vec`-like data type. pub trait Buffer: AsRef<[u8]> + AsMut<[u8]> { /// Get the length of the buffer fn len(&self) -> usize { self.as_ref().len() } /// Is the buffer empty? fn is_empty(&self) -> bool { self.as_ref().is_empty() } /// Extend this buffer from the given slice fn extend_from_slice(&mut self, other: &[u8]) -> Result<(), Error>; /// Truncate this buffer to the given size fn truncate(&mut self, len: usize); } #[cfg(feature = "alloc")] impl Buffer for Vec<u8> { fn extend_from_slice(&mut self, other: &[u8]) -> Result<(), Error> { Vec::extend_from_slice(self, other); Ok(()) } fn truncate(&mut self, len: usize) { Vec::truncate(self, len); } } #[cfg(feature = "heapless")] impl<N> Buffer for heapless::Vec<u8, N> where N: heapless::ArrayLength<u8>, { fn extend_from_slice(&mut self, other: &[u8]) -> Result<(), Error> { heapless::Vec::extend_from_slice(self, other).map_err(|_| Error) } fn truncate(&mut self, len: usize) { heapless::Vec::truncate(self, len); } }