Struct aes_gcm::AesGcm

pub struct AesGcm<Aes, NonceSize>where
    Aes: BlockCipher<BlockSize = U16> + BlockEncrypt,
    Aes::ParBlocks: ArrayLength<Block<Aes>>,
    NonceSize: ArrayLength<u8>,{ /* private fields */ }

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

impl<Aes, NonceSize> AeadCore for AesGcm<Aes, NonceSize>where Aes: NewBlockCipher + BlockCipher<BlockSize = U16> + BlockEncrypt, Aes::ParBlocks: ArrayLength<Block<Aes>>, 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.

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

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

Encrypt the data in-place, returning the authentication tag

fn decrypt_in_place_detached( &self, nonce: &Nonce<Self::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)

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.

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.

impl<Aes, NonceSize> Clone for AesGcm<Aes, NonceSize>where Aes: BlockCipher<BlockSize = U16> + BlockEncrypt + Clone, Aes::ParBlocks: ArrayLength<Block<Aes>>, NonceSize: ArrayLength<u8> + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Aes, NonceSize> From<Aes> for AesGcm<Aes, NonceSize>where Aes: NewBlockCipher + BlockCipher<BlockSize = U16> + BlockEncrypt, Aes::ParBlocks: ArrayLength<Block<Aes>>, NonceSize: ArrayLength<u8>,

fn from(cipher: Aes) -> Self

Converts to this type from the input type.

impl<Aes, NonceSize> NewAead for AesGcm<Aes, NonceSize>where Aes: NewBlockCipher + BlockCipher<BlockSize = U16> + BlockEncrypt, Aes::ParBlocks: ArrayLength<Block<Aes>>, NonceSize: ArrayLength<u8>,

type KeySize = <Aes as NewBlockCipher>::KeySize

The size of the key array required by this algorithm.

fn new(key: &BlockCipherKey<Aes>) -> Self

Create a new AEAD instance with the given key.

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

Create new AEAD instance from key given as a byte slice..