Struct mc_oblivious_aes_gcm::AesGcm

pub struct AesGcm<Aes, NonceSize> { /* 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
    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.

fn generate_nonce(
    rng: impl CryptoRng + RngCore
) -> GenericArray<u8, Self::NonceSize>where
    GenericArray<u8, Self::NonceSize>: Default,

Generate a random nonce for this AEAD algorithm.

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>

Encrypt the data in-place, returning the authentication tag

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)

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: Clone, NonceSize: Clone> Clone for AesGcm<Aes, NonceSize>

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> CtAeadDecrypt for AesGcm<Aes, NonceSize>where
    Aes: BlockCipher + BlockSizeUser<BlockSize = U16> + BlockEncrypt,
    NonceSize: ArrayLength<u8>,

fn ct_decrypt_in_place_detached(
    &self,
    nonce: &GenericArray<u8, NonceSize>,
    associated_data: &[u8],
    buffer: &mut [u8],
    tag: &Tag
) -> CtDecryptResult

A constant time version of the original https://docs.rs/aes-gcm/0.6.0/src/aes_gcm/lib.rs.html#251

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

fn from(cipher: Aes) -> Self

Converts to this type from the input type.

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

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.

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.