Struct aes_gcm::AesGcm

source · [−]

pub struct AesGcm<Aes, NonceSize> { /* private fields */ }

Expand description

AES-GCM: generic over an underlying AES implementation and nonce size.

This type is generic to support substituting alternative AES implementations (e.g. embedded hardware implementations)

It is NOT intended to be instantiated with any block cipher besides AES! Doing so runs the risk of unintended cryptographic properties!

The N generic parameter can be used to instantiate AES-GCM with other nonce sizes, however it’s recommended to use it with typenum::U12, the default of 96-bits.

If in doubt, use the built-in Aes128Gcm and Aes256Gcm type aliases.

Trait Implementations

source

impl<Aes, NonceSize> AeadCore for AesGcm<Aes, NonceSize> where
NonceSize: ArrayLength<u8>,

type NonceSize = NonceSize

The length of a nonce.

type TagSize = UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>

The maximum length of the nonce.

type CiphertextOverhead = UTerm

The upper bound amount of additional space required to support a ciphertext vs. a plaintext. Read more

source

impl<Aes, NonceSize> AeadInPlace for AesGcm<Aes, NonceSize> where
Aes: BlockCipher + BlockSizeUser<BlockSize = U16> + BlockEncrypt,
NonceSize: ArrayLength<u8>,

source

fn encrypt_in_place_detached(
 &self,
 nonce: &Nonce<NonceSize>,
 associated_data: &[u8],
 buffer: &mut [u8]
) -> Result<Tag, Error>

Encrypt the data in-place, returning the authentication tag

source

fn decrypt_in_place_detached(
 &self,
 nonce: &Nonce<NonceSize>,
 associated_data: &[u8],
 buffer: &mut [u8],
 tag: &Tag
) -> Result<(), Error>

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) Read more

source

fn encrypt_in_place(
 &self,
 nonce: &GenericArray<u8, Self::NonceSize>,
 associated_data: &[u8],
 buffer: &mut dyn Buffer
) -> Result<(), Error>

Encrypt the given buffer containing a plaintext message in-place. Read more

source

fn decrypt_in_place(
 &self,
 nonce: &GenericArray<u8, Self::NonceSize>,
 associated_data: &[u8],
 buffer: &mut dyn Buffer
) -> Result<(), Error>

Decrypt the message in-place, returning an error in the event the provided authentication tag does not match the given ciphertext. Read more

source

impl<Aes: Clone, NonceSize: Clone> Clone for AesGcm<Aes, NonceSize>

source

fn clone(&self) -> AesGcm<Aes, NonceSize>

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<Aes, NonceSize> From<Aes> for AesGcm<Aes, NonceSize> where
Aes: BlockSizeUser<BlockSize = U16> + BlockEncrypt,

source

fn from(cipher: Aes) -> Self

Converts to this type from the input type.

source

impl<Aes, NonceSize> KeyInit for AesGcm<Aes, NonceSize> where
Aes: BlockSizeUser<BlockSize = U16> + BlockEncrypt + KeyInit,

source

fn new(key: &Key<Self>) -> Self

Create new value from fixed size key.

fn new_from_slice(key: &[u8]) -> Result<Self, InvalidLength>

Create new value from variable size key.

fn generate_key(
rng: impl CryptoRng + RngCore
) -> GenericArray<u8, Self::KeySize>

Generate random key using the provided CryptoRng.

source

impl<Aes, NonceSize> KeySizeUser for AesGcm<Aes, NonceSize> where
Aes: KeySizeUser,

type KeySize = <Aes as KeySizeUser>::KeySize

Key size in bytes.

fn key_size() -> usize

Return key size in bytes.

Auto Trait Implementations

impl<Aes, NonceSize> RefUnwindSafe for AesGcm<Aes, NonceSize> where
Aes: RefUnwindSafe,
NonceSize: RefUnwindSafe,

impl<Aes, NonceSize> Send for AesGcm<Aes, NonceSize> where
Aes: Send,
NonceSize: Send,

impl<Aes, NonceSize> Sync for AesGcm<Aes, NonceSize> where
Aes: Sync,
NonceSize: Sync,

impl<Aes, NonceSize> Unpin for AesGcm<Aes, NonceSize> where
Aes: Unpin,
NonceSize: Unpin,

impl<Aes, NonceSize> UnwindSafe for AesGcm<Aes, NonceSize> where
Aes: UnwindSafe,
NonceSize: UnwindSafe,

Blanket Implementations

source

impl<Alg> Aead for Alg where
Alg: AeadInPlace,

source

fn encrypt<'msg, 'aad>(
 &self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Encrypt the given plaintext payload, and return the resulting ciphertext as a vector of bytes. Read more

source

fn decrypt<'msg, 'aad>(
 &self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Decrypt the given ciphertext slice, and return the resulting plaintext as a vector of bytes. Read more

source

impl<Alg> AeadMut for Alg where
Alg: AeadMutInPlace,

source

fn encrypt<'msg, 'aad>(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Encrypt the given plaintext slice, and return the resulting ciphertext as a vector of bytes. Read more

source

fn decrypt<'msg, 'aad>(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

Decrypt the given ciphertext slice, and return the resulting plaintext as a vector of bytes. Read more

source

impl<Alg> AeadMutInPlace for Alg where
Alg: AeadInPlace,

source

fn encrypt_in_place(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 associated_data: &[u8],
 buffer: &mut impl Buffer
) -> Result<(), Error>

Encrypt the given buffer containing a plaintext message in-place. Read more

source

fn encrypt_in_place_detached(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 associated_data: &[u8],
 buffer: &mut [u8]
) -> Result<GenericArray<u8, <Alg as AeadCore>::TagSize>, Error>

Encrypt the data in-place, returning the authentication tag

source

fn decrypt_in_place(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 associated_data: &[u8],
 buffer: &mut impl Buffer
) -> Result<(), Error>

Decrypt the message in-place, returning an error in the event the provided authentication tag does not match the given ciphertext. Read more

source

fn decrypt_in_place_detached(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
 associated_data: &[u8],
 buffer: &mut [u8],
 tag: &GenericArray<u8, <Alg as AeadCore>::TagSize>
) -> Result<(), Error>

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) Read more

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct aes_gcm::AesGcm

Trait Implementations

impl<Aes, NonceSize> AeadCore for AesGcm<Aes, NonceSize> where NonceSize: ArrayLength<u8>,

type NonceSize = NonceSize

type TagSize = UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>

type CiphertextOverhead = UTerm

impl<Aes, NonceSize> AeadInPlace for AesGcm<Aes, NonceSize> where Aes: BlockCipher + BlockSizeUser<BlockSize = U16> + BlockEncrypt, NonceSize: ArrayLength<u8>,

fn encrypt_in_place_detached( &self, nonce: &Nonce<NonceSize>, associated_data: &[u8], buffer: &mut [u8]) -> Result<Tag, Error>

fn decrypt_in_place_detached( &self, nonce: &Nonce<NonceSize>, associated_data: &[u8], buffer: &mut [u8], tag: &Tag) -> Result<(), Error>

fn encrypt_in_place( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut dyn Buffer) -> Result<(), Error>

fn decrypt_in_place( &self, nonce: &GenericArray<u8, Self::NonceSize>, associated_data: &[u8], buffer: &mut dyn Buffer) -> Result<(), Error>

impl<Aes: Clone, NonceSize: Clone> Clone for AesGcm<Aes, NonceSize>

fn clone(&self) -> AesGcm<Aes, NonceSize>

fn clone_from(&mut self, source: &Self)

impl<Aes, NonceSize> From<Aes> for AesGcm<Aes, NonceSize> where Aes: BlockSizeUser<BlockSize = U16> + BlockEncrypt,

fn from(cipher: Aes) -> Self

impl<Aes, NonceSize> KeyInit for AesGcm<Aes, NonceSize> where Aes: BlockSizeUser<BlockSize = U16> + BlockEncrypt + KeyInit,

fn new(key: &Key<Self>) -> Self

fn new_from_slice(key: &[u8]) -> Result<Self, InvalidLength>

fn generate_key( rng: impl CryptoRng + RngCore) -> GenericArray<u8, Self::KeySize>

impl<Aes, NonceSize> KeySizeUser for AesGcm<Aes, NonceSize> where Aes: KeySizeUser,

type KeySize = <Aes as KeySizeUser>::KeySize

fn key_size() -> usize

Auto Trait Implementations

impl<Aes, NonceSize> RefUnwindSafe for AesGcm<Aes, NonceSize> where Aes: RefUnwindSafe, NonceSize: RefUnwindSafe,

impl<Aes, NonceSize> Send for AesGcm<Aes, NonceSize> where Aes: Send, NonceSize: Send,

impl<Aes, NonceSize> Sync for AesGcm<Aes, NonceSize> where Aes: Sync, NonceSize: Sync,

impl<Aes, NonceSize> Unpin for AesGcm<Aes, NonceSize> where Aes: Unpin, NonceSize: Unpin,

impl<Aes, NonceSize> UnwindSafe for AesGcm<Aes, NonceSize> where Aes: UnwindSafe, NonceSize: UnwindSafe,

Blanket Implementations

impl<Alg> Aead for Alg where Alg: AeadInPlace,

fn encrypt<'msg, 'aad>( &self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, plaintext: impl Into<Payload<'msg, 'aad>>) -> Result<Vec<u8, Global>, Error>

fn decrypt<'msg, 'aad>( &self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, ciphertext: impl Into<Payload<'msg, 'aad>>) -> Result<Vec<u8, Global>, Error>

impl<Alg> AeadMut for Alg where Alg: AeadMutInPlace,

fn encrypt<'msg, 'aad>( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, plaintext: impl Into<Payload<'msg, 'aad>>) -> Result<Vec<u8, Global>, Error>

fn decrypt<'msg, 'aad>( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, ciphertext: impl Into<Payload<'msg, 'aad>>) -> Result<Vec<u8, Global>, Error>

impl<Alg> AeadMutInPlace for Alg where Alg: AeadInPlace,

fn encrypt_in_place( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer) -> Result<(), Error>

fn encrypt_in_place_detached( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, associated_data: &[u8], buffer: &mut [u8]) -> Result<GenericArray<u8, <Alg as AeadCore>::TagSize>, Error>

fn decrypt_in_place( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, associated_data: &[u8], buffer: &mut impl Buffer) -> Result<(), Error>

fn decrypt_in_place_detached( &mut self, nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>, associated_data: &[u8], buffer: &mut [u8], tag: &GenericArray<u8, <Alg as AeadCore>::TagSize>) -> Result<(), Error>

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<Aes, NonceSize> AeadCore for AesGcm<Aes, NonceSize> where
NonceSize: ArrayLength<u8>,

impl<Aes, NonceSize> AeadInPlace for AesGcm<Aes, NonceSize> where
Aes: BlockCipher + BlockSizeUser<BlockSize = U16> + BlockEncrypt,
NonceSize: ArrayLength<u8>,

fn encrypt_in_place_detached(
&self,
nonce: &Nonce<NonceSize>,
associated_data: &[u8],
buffer: &mut [u8]
) -> Result<Tag, Error>

fn decrypt_in_place_detached(
&self,
nonce: &Nonce<NonceSize>,
associated_data: &[u8],
buffer: &mut [u8],
tag: &Tag
) -> Result<(), Error>

fn encrypt_in_place(
&self,
nonce: &GenericArray<u8, Self::NonceSize>,
associated_data: &[u8],
buffer: &mut dyn Buffer
) -> Result<(), Error>

fn decrypt_in_place(
&self,
nonce: &GenericArray<u8, Self::NonceSize>,
associated_data: &[u8],
buffer: &mut dyn Buffer
) -> Result<(), Error>

impl<Aes, NonceSize> From<Aes> for AesGcm<Aes, NonceSize> where
Aes: BlockSizeUser<BlockSize = U16> + BlockEncrypt,

impl<Aes, NonceSize> KeyInit for AesGcm<Aes, NonceSize> where
Aes: BlockSizeUser<BlockSize = U16> + BlockEncrypt + KeyInit,

fn generate_key(
rng: impl CryptoRng + RngCore
) -> GenericArray<u8, Self::KeySize>

impl<Aes, NonceSize> KeySizeUser for AesGcm<Aes, NonceSize> where
Aes: KeySizeUser,

impl<Aes, NonceSize> RefUnwindSafe for AesGcm<Aes, NonceSize> where
Aes: RefUnwindSafe,
NonceSize: RefUnwindSafe,

impl<Aes, NonceSize> Send for AesGcm<Aes, NonceSize> where
Aes: Send,
NonceSize: Send,

impl<Aes, NonceSize> Sync for AesGcm<Aes, NonceSize> where
Aes: Sync,
NonceSize: Sync,

impl<Aes, NonceSize> Unpin for AesGcm<Aes, NonceSize> where
Aes: Unpin,
NonceSize: Unpin,

impl<Aes, NonceSize> UnwindSafe for AesGcm<Aes, NonceSize> where
Aes: UnwindSafe,
NonceSize: UnwindSafe,

impl<Alg> Aead for Alg where
Alg: AeadInPlace,

fn encrypt<'msg, 'aad>(
&self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

fn decrypt<'msg, 'aad>(
&self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

impl<Alg> AeadMut for Alg where
Alg: AeadMutInPlace,

fn encrypt<'msg, 'aad>(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
plaintext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

fn decrypt<'msg, 'aad>(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
ciphertext: impl Into<Payload<'msg, 'aad>>
) -> Result<Vec<u8, Global>, Error>

impl<Alg> AeadMutInPlace for Alg where
Alg: AeadInPlace,

fn encrypt_in_place(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
associated_data: &[u8],
buffer: &mut impl Buffer
) -> Result<(), Error>

fn encrypt_in_place_detached(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
associated_data: &[u8],
buffer: &mut [u8]
) -> Result<GenericArray<u8, <Alg as AeadCore>::TagSize>, Error>

fn decrypt_in_place(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
associated_data: &[u8],
buffer: &mut impl Buffer
) -> Result<(), Error>

fn decrypt_in_place_detached(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadCore>::NonceSize>,
associated_data: &[u8],
buffer: &mut [u8],
tag: &GenericArray<u8, <Alg as AeadCore>::TagSize>
) -> Result<(), Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,