Move AeadInPlace into Aead and add a const TAG_POSITION to AeadCore

Author: baloo

Cargo.lock

@@ -18,8 +18,8 @@ resolver = "2"
 aead-stream = { path = "./aead-stream" }
 aes-gcm     = { path = "./aes-gcm" }
 
-aead          = { git = "https://github.com/baloo/traits.git", branch = "baloo/aead/bicephalbuffer" }
-crypto-common = { git = "https://github.com/baloo/traits.git", branch = "baloo/aead/bicephalbuffer" }
+aead          = { git = "https://github.com/baloo/traits.git", branch = "baloo/aead/mockbuffer-merge" }
+crypto-common = { git = "https://github.com/baloo/traits.git", branch = "baloo/aead/mockbuffer-merge" }
 
 chacha20 = { git = "https://github.com/RustCrypto/stream-ciphers.git" }
 

Cargo.toml

@@ -6,7 +6,7 @@
 extern crate alloc;
 
 use aead::{
-    AeadCore, AeadInPlace, Buffer, Error, Result,
+    AeadCore, AeadInOut, Buffer, Error, Result,
     array::{
         Array, ArraySize,
         typenum::{U4, U5, Unsigned},
@@ -32,7 +32,7 @@ pub type NonceSize<A, S> =
 /// Create a new STREAM from the provided AEAD.
 pub trait NewStream<A>: StreamPrimitive<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<Self::NonceOverhead>,
     NonceSize<A, Self>: ArraySize,
 {
@@ -57,7 +57,7 @@ where
 /// Deliberately immutable and stateless to permit parallel operation.
 pub trait StreamPrimitive<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<Self::NonceOverhead>,
     NonceSize<A, Self>: ArraySize,
 {
@@ -165,7 +165,7 @@ macro_rules! impl_stream_object {
         #[derive(Debug)]
         pub struct $name<A, S>
         where
-            A: AeadInPlace,
+            A: AeadInOut,
             S: StreamPrimitive<A>,
             A::NonceSize: Sub<<S as StreamPrimitive<A>>::NonceOverhead>,
             NonceSize<A, S>: ArraySize,
@@ -179,7 +179,7 @@ macro_rules! impl_stream_object {
 
         impl<A, S> $name<A, S>
         where
-            A: AeadInPlace,
+            A: AeadInOut,
             S: StreamPrimitive<A>,
             A::NonceSize: Sub<<S as StreamPrimitive<A>>::NonceOverhead>,
             NonceSize<A, S>: ArraySize,
@@ -344,7 +344,7 @@ pub type DecryptorLE31<A> = Decryptor<A, StreamLE31<A>>;
 #[derive(Debug)]
 pub struct StreamBE32<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<U5>,
     <<A as AeadCore>::NonceSize as Sub<U5>>::Output: ArraySize,
 {
@@ -357,7 +357,7 @@ where
 
 impl<A> NewStream<A> for StreamBE32<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<U5>,
     <<A as AeadCore>::NonceSize as Sub<U5>>::Output: ArraySize,
 {
@@ -371,7 +371,7 @@ where
 
 impl<A> StreamPrimitive<A> for StreamBE32<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<U5>,
     <<A as AeadCore>::NonceSize as Sub<U5>>::Output: ArraySize,
 {
@@ -405,7 +405,7 @@ where
 
 impl<A> StreamBE32<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<U5>,
     <<A as AeadCore>::NonceSize as Sub<U5>>::Output: ArraySize,
 {
@@ -434,7 +434,7 @@ where
 #[derive(Debug)]
 pub struct StreamLE31<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<U4>,
     <<A as AeadCore>::NonceSize as Sub<U4>>::Output: ArraySize,
 {
@@ -447,7 +447,7 @@ where
 
 impl<A> NewStream<A> for StreamLE31<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<U4>,
     <<A as AeadCore>::NonceSize as Sub<U4>>::Output: ArraySize,
 {
@@ -461,7 +461,7 @@ where
 
 impl<A> StreamPrimitive<A> for StreamLE31<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<U4>,
     <<A as AeadCore>::NonceSize as Sub<U4>>::Output: ArraySize,
 {
@@ -495,7 +495,7 @@ where
 
 impl<A> StreamLE31<A>
 where
-    A: AeadInPlace,
+    A: AeadInOut,
     A::NonceSize: Sub<U4>,
     <<A as AeadCore>::NonceSize as Sub<U4>>::Output: ArraySize,
 {

aead-stream/src/lib.rs

@@ -17,7 +17,7 @@ categories = ["cryptography", "no-std"]
 rust-version = "1.85"
 
 [dependencies]
-aead = { version = "0.6.0-rc.0", default-features = false, features = ["inout"] }
+aead = { version = "0.6.0-rc.0", default-features = false }
 aes = { version = "=0.9.0-pre.3", optional = true }
 cipher = "=0.5.0-pre.8"
 ctr = "0.10.0-pre.2"

aes-gcm-siv/Cargo.toml

@@ -34,7 +34,7 @@
 //! 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`]
+//! The [`AeadInOut::encrypt_in_place`] and [`AeadInOut::decrypt_in_place`]
 //! methods accept any type that impls the [`aead::Buffer`] trait which
 //! contains the plaintext for encryption or ciphertext for decryption.
 //!
@@ -48,7 +48,7 @@
 #![cfg_attr(not(all(feature = "os_rng", feature = "heapless")), doc = "```ignore")]
 //! # fn main() -> Result<(), Box<dyn std::error::Error>> {
 //! use aes_gcm_siv::{
-//!     aead::{AeadInPlace, KeyInit, rand_core::OsRng, heapless::Vec},
+//!     aead::{AeadInOut, KeyInit, rand_core::OsRng, heapless::Vec},
 //!     Aes256GcmSiv, Nonce, // Or `Aes128GcmSiv`
 //! };
 //!
@@ -83,7 +83,7 @@ pub use aead::{self, AeadCore, AeadInOut, Error, Key, KeyInit, KeySizeUser};
 #[cfg(feature = "aes")]
 pub use aes;
 
-use aead::{PostfixTagged, inout::InOutBuf};
+use aead::{TagPosition, inout::InOutBuf};
 use cipher::{
     BlockCipherEncrypt, BlockSizeUser, InnerIvInit, StreamCipherCore,
     array::Array,
@@ -161,10 +161,9 @@ where
 {
     type NonceSize = U12;
     type TagSize = U16;
+    const TAG_POSITION: TagPosition = TagPosition::Postfix;
 }
 
-impl<Aes> PostfixTagged for AesGcmSiv<Aes> {}
-
 impl<Aes> AeadInOut for AesGcmSiv<Aes>
 where
     Aes: BlockSizeUser<BlockSize = U16> + BlockCipherEncrypt + KeyInit,

aes-gcm-siv/src/lib.rs

@@ -17,7 +17,7 @@ categories = ["cryptography", "no-std"]
 rust-version = "1.85"
 
 [dependencies]
-aead = { version = "0.6.0-rc.0", default-features = false, features = ["inout"] }
+aead = { version = "0.6.0-rc.0", default-features = false }
 aes = { version = "=0.9.0-pre.3", optional = true }
 cipher = "=0.5.0-pre.8"
 ctr = "0.10.0-pre.2"

aes-gcm/Cargo.toml

@@ -54,7 +54,7 @@
 //! 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`]
+//! The [`AeadInOut::encrypt_in_place`] and [`AeadInOut::decrypt_in_place`]
 //! methods accept any type that impls the [`aead::Buffer`] trait which
 //! contains the plaintext for encryption or ciphertext for decryption.
 //!
@@ -68,7 +68,7 @@
 #![cfg_attr(not(all(feature = "os_rng", feature = "heapless")), doc = "```ignore")]
 //! # fn main() -> Result<(), Box<dyn core::error::Error>> {
 //! use aes_gcm::{
-//!     aead::{AeadCore, AeadInPlace, KeyInit, rand_core::OsRng, heapless::Vec},
+//!     aead::{AeadCore, AeadInOut, KeyInit, rand_core::OsRng, heapless::Vec},
 //!     Aes256Gcm, Nonce, // Or `Aes128Gcm`
 //! };
 //!
@@ -103,7 +103,7 @@ pub use aead::{self, AeadCore, AeadInOut, Error, Key, KeyInit, KeySizeUser};
 #[cfg(feature = "aes")]
 pub use aes;
 
-use aead::{PostfixTagged, inout::InOutBuf};
+use aead::{TagPosition, inout::InOutBuf};
 
 use cipher::{
     BlockCipherEncrypt, BlockSizeUser, InnerIvInit, StreamCipherCore,
@@ -253,11 +253,7 @@ where
 {
     type NonceSize = NonceSize;
     type TagSize = TagSize;
-}
-
-impl<Aes, NonceSize, TagSize> PostfixTagged for AesGcm<Aes, NonceSize, TagSize> where
-    TagSize: self::TagSize
-{
+    const TAG_POSITION: TagPosition = TagPosition::Postfix;
 }
 
 impl<Aes, NonceSize, TagSize> AeadInOut for AesGcm<Aes, NonceSize, TagSize>

aes-gcm/src/lib.rs

@@ -34,7 +34,7 @@
 //! 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`]
+//! The [`AeadInOut::encrypt_in_place`] and [`AeadInOut::decrypt_in_place`]
 //! methods accept any type that impls the [`aead::Buffer`] trait which
 //! contains the plaintext for encryption or ciphertext for decryption.
 //!
@@ -48,7 +48,7 @@
 #![cfg_attr(not(all(feature = "os_rng", feature = "heapless")), doc = "```ignore")]
 //! # fn main() -> Result<(), Box<dyn core::error::Error>> {
 //! use aes_siv::{
-//!     aead::{AeadCore, AeadInPlace, KeyInit, rand_core::OsRng, heapless::Vec},
+//!     aead::{AeadCore, AeadInOut, KeyInit, rand_core::OsRng, heapless::Vec},
 //!     Aes256SivAead, Nonce, // Or `Aes128SivAead`
 //! };
 //!
@@ -83,11 +83,11 @@ extern crate alloc;
 
 pub mod siv;
 
-pub use aead::{self, AeadCore, AeadInOut, AeadInPlace, Error, Key, KeyInit, KeySizeUser};
+pub use aead::{self, Aead, AeadCore, AeadInOut, Error, Key, KeyInit, KeySizeUser};
 
 use crate::siv::Siv;
 use aead::{
-    Buffer,
+    TagPosition,
     array::Array,
     consts::{U1, U16, U32, U64},
     inout::InOutBuf,
@@ -205,39 +205,7 @@ where
     // https://tools.ietf.org/html/rfc5297#section-6
     type NonceSize = NonceSize;
     type TagSize = U16;
-}
-
-impl<C, M, NonceSize> AeadInPlace for SivAead<C, M, NonceSize>
-where
-    Self: KeySizeUser,
-    Siv<C, M>: KeyInit + KeySizeUser<KeySize = <Self as KeySizeUser>::KeySize>,
-    C: BlockSizeUser<BlockSize = U16> + BlockCipherEncrypt + KeyInit + KeySizeUser,
-    M: Mac<OutputSize = U16> + FixedOutputReset + KeyInit,
-    <C as KeySizeUser>::KeySize: Add,
-    NonceSize: ArraySize + IsGreaterOrEqual<U1>,
-{
-    fn encrypt_in_place(
-        &self,
-        nonce: &Array<u8, Self::NonceSize>,
-        associated_data: &[u8],
-        buffer: &mut dyn Buffer,
-    ) -> Result<(), Error> {
-        // "SIV performs nonce-based authenticated encryption when a component of
-        // the associated data is a nonce.  For purposes of interoperability the
-        // final component -- i.e., the string immediately preceding the
-        // plaintext in the vector input to S2V -- is used for the nonce."
-        // https://tools.ietf.org/html/rfc5297#section-3
-        Siv::<C, M>::new(&self.key).encrypt_in_place([associated_data, nonce.as_slice()], buffer)
-    }
-
-    fn decrypt_in_place(
-        &self,
-        nonce: &Array<u8, Self::NonceSize>,
-        associated_data: &[u8],
-        buffer: &mut dyn Buffer,
-    ) -> Result<(), Error> {
-        Siv::<C, M>::new(&self.key).decrypt_in_place([associated_data, nonce.as_slice()], buffer)
-    }
+    const TAG_POSITION: TagPosition = TagPosition::Prefix;
 }
 
 impl<C, M, NonceSize> AeadInOut for SivAead<C, M, NonceSize>

aes-siv/src/lib.rs

@@ -15,7 +15,7 @@ categories = ["cryptography", "no-std"]
 rust-version = "1.85"
 
 [dependencies]
-aead = { version = "0.6.0-rc.0", default-features = false, features = ["inout"] }
+aead = { version = "0.6.0-rc.0", default-features = false }
 subtle = { version = "2", default-features = false }
 zeroize = { version = "1.6", optional = true, default-features = false, features = ["derive"] }
 ascon = "0.4"

ascon-aead/Cargo.toml

@@ -59,7 +59,7 @@
 //! 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`]
+//! The [`AeadInOut::encrypt_in_place`] and [`AeadInOut::decrypt_in_place`]
 //! methods accept any type that impls the [`aead::Buffer`] trait which
 //! contains the plaintext for encryption or ciphertext for decryption.
 //!
@@ -72,7 +72,7 @@
 //! ```
 //! # #[cfg(feature = "heapless")] {
 //! use ascon_aead::{AsconAead128, Key, Nonce};
-//! use ascon_aead::aead::{AeadInPlace, KeyInit};
+//! use ascon_aead::aead::{AeadInOut, KeyInit};
 //! use ascon_aead::aead::heapless::Vec;
 //!
 //! let key = Key::<AsconAead128>::from_slice(b"very secret key.");
@@ -105,9 +105,7 @@
 pub use zeroize;
 
 pub use aead::{self, Error, Key, Nonce, Tag};
-use aead::{
-    AeadCore, AeadInOut, KeyInit, KeySizeUser, PostfixTagged, consts::U16, inout::InOutBuf,
-};
+use aead::{AeadCore, AeadInOut, KeyInit, KeySizeUser, TagPosition, consts::U16, inout::InOutBuf};
 
 mod asconcore;
 
@@ -137,10 +135,9 @@ impl<P: Parameters> KeyInit for Ascon<P> {
 impl<P: Parameters> AeadCore for Ascon<P> {
     type NonceSize = U16;
     type TagSize = U16;
+    const TAG_POSITION: TagPosition = TagPosition::Postfix;
 }
 
-impl<P: Parameters> PostfixTagged for Ascon<P> {}
-
 impl<P: Parameters> AeadInOut for Ascon<P> {
     fn encrypt_inout_detached(
         &self,
@@ -200,10 +197,9 @@ impl KeyInit for AsconAead128 {
 impl AeadCore for AsconAead128 {
     type NonceSize = U16;
     type TagSize = U16;
+    const TAG_POSITION: TagPosition = TagPosition::Postfix;
 }
 
-impl PostfixTagged for AsconAead128 {}
-
 impl AeadInOut for AsconAead128 {
     #[inline(always)]
     fn encrypt_inout_detached(