diff --git a/aes-gcm/src/lib.rs b/aes-gcm/src/lib.rs index f7a26513..51565517 100644 --- a/aes-gcm/src/lib.rs +++ b/aes-gcm/src/lib.rs @@ -130,9 +130,17 @@ pub const P_MAX: u64 = 1 << 36; pub const C_MAX: u64 = (1 << 36) + 16; /// AES-GCM nonces. +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Nonce = GenericArray; /// AES-GCM tags. +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Tag = GenericArray; /// Trait implemented for valid tag sizes, i.e. diff --git a/aes-siv/src/lib.rs b/aes-siv/src/lib.rs index ebe917d1..32a282f5 100644 --- a/aes-siv/src/lib.rs +++ b/aes-siv/src/lib.rs @@ -105,9 +105,17 @@ use digest::{FixedOutputReset, Mac}; use pmac::Pmac; /// AES-SIV nonces +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Nonce = GenericArray; /// AES-SIV tags (i.e. the Synthetic Initialization Vector value) +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Tag = GenericArray; /// The `SivAead` type wraps the more powerful `Siv` interface in a more diff --git a/ascon-aead/src/lib.rs b/ascon-aead/src/lib.rs index 81774e94..22acb637 100644 --- a/ascon-aead/src/lib.rs +++ b/ascon-aead/src/lib.rs @@ -178,10 +178,22 @@ impl AeadInPlace for Ascon

{ /// Ascon-128 pub struct Ascon128(Ascon); /// Key for Ascon-128 +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Ascon128Key = Key; /// Nonce for Ascon-128 +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Ascon128Nonce = Nonce; /// Tag for Ascon-128 +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Ascon128Tag = Tag; impl KeySizeUser for Ascon128 { diff --git a/ccm/src/lib.rs b/ccm/src/lib.rs index b6e75d74..3d567fdc 100644 --- a/ccm/src/lib.rs +++ b/ccm/src/lib.rs @@ -58,9 +58,17 @@ use subtle::ConstantTimeEq; mod private; /// CCM nonces +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Nonce = GenericArray; /// CCM tags +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Tag = GenericArray; /// Trait implemented for valid tag sizes, i.e. diff --git a/chacha20poly1305/src/lib.rs b/chacha20poly1305/src/lib.rs index de0b8eed..27548ce0 100644 --- a/chacha20poly1305/src/lib.rs +++ b/chacha20poly1305/src/lib.rs @@ -161,7 +161,9 @@ use chacha20::{ChaCha12, ChaCha8, XChaCha12, XChaCha8}; /// Key type (256-bits/32-bytes). /// -/// Implemented as an alias for [`GenericArray`]. +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. /// /// All [`ChaChaPoly1305`] variants (including `XChaCha20Poly1305`) use this /// key type. @@ -169,17 +171,23 @@ pub type Key = GenericArray; /// Nonce type (96-bits/12-bytes). /// -/// Implemented as an alias for [`GenericArray`]. +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Nonce = GenericArray; /// XNonce type (192-bits/24-bytes). /// -/// Implemented as an alias for [`GenericArray`]. +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type XNonce = GenericArray; /// Poly1305 tag. /// -/// Implemented as an alias for [`GenericArray`]. +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Tag = GenericArray; /// ChaCha20Poly1305 Authenticated Encryption with Additional Data (AEAD). diff --git a/deoxys/src/lib.rs b/deoxys/src/lib.rs index 7d44b2e1..648da06c 100644 --- a/deoxys/src/lib.rs +++ b/deoxys/src/lib.rs @@ -133,9 +133,17 @@ pub type DeoxysII128 = Deoxys, deoxys_bc pub type DeoxysII256 = Deoxys, deoxys_bc::DeoxysBc384>; /// Deoxys nonces +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Nonce = GenericArray; /// Deoxys tags +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Tag = GenericArray; /// Deoxys encryption modes. diff --git a/eax/src/lib.rs b/eax/src/lib.rs index e8323d74..a9af517f 100644 --- a/eax/src/lib.rs +++ b/eax/src/lib.rs @@ -148,9 +148,17 @@ pub const P_MAX: u64 = 1 << 36; pub const C_MAX: u64 = (1 << 36) + 16; /// EAX nonces +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Nonce = GenericArray; /// EAX tags +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Tag = GenericArray; pub mod online; diff --git a/mgm/src/lib.rs b/mgm/src/lib.rs index eca92e1a..cea90a61 100644 --- a/mgm/src/lib.rs +++ b/mgm/src/lib.rs @@ -48,11 +48,24 @@ use sealed::Sealed; cpufeatures::new!(mul_intrinsics, "sse2", "ssse3", "pclmulqdq"); /// MGM nonces +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Nonce = GenericArray; /// MGM tags +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. pub type Tag = GenericArray; +/// MGM blocks +/// +/// Implemented as an alias for +/// [`GenericArray`](https://docs.rs/generic-array/0.14.5/generic_array/struct.GenericArray.html). +/// Note that this crate re-exports aead which re-exports GenericArray. type Block = GenericArray::BlockSize>; // cipher, nonce, aad, buffer type EncArgs<'a, C> = (&'a C, &'a Block, &'a [u8], &'a mut [u8]);