Struct aes_gcm::AesGcm

source · [−]

pub struct AesGcm<Aes, NonceSize> where
    Aes: BlockCipher<BlockSize = U16>,
    Aes::ParBlocks: ArrayLength<Block<Aes>>,
    NonceSize: ArrayLength<u8>,  { /* 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> AeadInPlace for AesGcm<Aes, NonceSize> where
 Aes: BlockCipher<BlockSize = U16>,
 Aes::ParBlocks: ArrayLength<Block<Aes>>,
 NonceSize: ArrayLength<u8>,

type NonceSize = NonceSize

The length of a nonce.

type TagSize = U16

The maximum length of the nonce.

type CiphertextOverhead = U0

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

source

fn encrypt_in_place_detached(
 &self,
 nonce: &GenericArray<u8, 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: &GenericArray<u8, 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> where
 Aes: BlockCipher<BlockSize = U16>,
 Aes::ParBlocks: ArrayLength<Block<Aes>>,
 NonceSize: ArrayLength<u8>,

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: BlockCipher<BlockSize = U16>,
 Aes::ParBlocks: ArrayLength<Block<Aes>>,
 NonceSize: ArrayLength<u8>,

source

fn from(cipher: Aes) -> Self

Performs the conversion.

source

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

type KeySize = Aes::KeySize

The size of the key array required by this algorithm.

source

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

Create a new AEAD instance with the given key.

source

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

Create new AEAD instance from key with variable size. Read more

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,

type NonceSize = <Alg as AeadInPlace>::NonceSize

The length of a nonce.

type TagSize = <Alg as AeadInPlace>::TagSize

The maximum length of the nonce.

type CiphertextOverhead = <Alg as AeadInPlace>::CiphertextOverhead

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

source

pub fn encrypt<'msg, 'aad>(
 &self,
 nonce: &GenericArray<u8, <Alg as Aead>::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

pub fn decrypt<'msg, 'aad>(
 &self,
 nonce: &GenericArray<u8, <Alg as Aead>::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,

type NonceSize = <Alg as AeadMutInPlace>::NonceSize

The length of a nonce.

type TagSize = <Alg as AeadMutInPlace>::TagSize

The maximum length of the nonce.

type CiphertextOverhead = <Alg as AeadMutInPlace>::CiphertextOverhead

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

source

pub fn encrypt<'msg, 'aad>(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadMut>::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

pub fn decrypt<'msg, 'aad>(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadMut>::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,

type NonceSize = <Alg as AeadInPlace>::NonceSize

The length of a nonce.

type TagSize = <Alg as AeadInPlace>::TagSize

The maximum length of the nonce.

type CiphertextOverhead = <Alg as AeadInPlace>::CiphertextOverhead

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

source

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

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

source

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

Encrypt the data in-place, returning the authentication tag

source

pub fn decrypt_in_place(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadMutInPlace>::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

pub fn decrypt_in_place_detached(
 &mut self,
 nonce: &GenericArray<u8, <Alg as AeadMutInPlace>::NonceSize>,
 associated_data: &[u8 ],
 buffer: &mut [u8 ],
 tag: &GenericArray<u8, <Alg as AeadMutInPlace>::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

pub 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

pub 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

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

Mutably borrows from an owned value. Read more

source

impl<T> From<!> for T

const: unstable · source

pub fn from(t: !) -> T

Performs the conversion.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

pub 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

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

Performs the conversion.

Struct aes_gcm::AesGcm

Trait Implementations

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

type NonceSize = NonceSize

type TagSize = U16

type CiphertextOverhead = U0

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

fn decrypt_in_place_detached( &self, nonce: &GenericArray<u8, 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> where Aes: BlockCipher<BlockSize = U16>, Aes::ParBlocks: ArrayLength<Block<Aes>>, NonceSize: ArrayLength<u8>,

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

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

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

fn from(cipher: Aes) -> Self

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

type KeySize = Aes::KeySize

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

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

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,

type NonceSize = <Alg as AeadInPlace>::NonceSize

type TagSize = <Alg as AeadInPlace>::TagSize

type CiphertextOverhead = <Alg as AeadInPlace>::CiphertextOverhead

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

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

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

type NonceSize = <Alg as AeadMutInPlace>::NonceSize

type TagSize = <Alg as AeadMutInPlace>::TagSize

type CiphertextOverhead = <Alg as AeadMutInPlace>::CiphertextOverhead

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

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

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

type NonceSize = <Alg as AeadInPlace>::NonceSize

type TagSize = <Alg as AeadInPlace>::TagSize

type CiphertextOverhead = <Alg as AeadInPlace>::CiphertextOverhead

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

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

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

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

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<!> for T

pub fn from(t: !) -> T

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

pub 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

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

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

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

fn decrypt_in_place_detached(
&self,
nonce: &GenericArray<u8, 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> where
Aes: BlockCipher<BlockSize = U16>,
Aes::ParBlocks: ArrayLength<Block<Aes>>,
NonceSize: ArrayLength<u8>,

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

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

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

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,

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

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

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

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

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

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

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

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

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

pub fn decrypt_in_place_detached(
&mut self,
nonce: &GenericArray<u8, <Alg as AeadMutInPlace>::NonceSize>,
associated_data: &[u8 ],
buffer: &mut [u8 ],
tag: &GenericArray<u8, <Alg as AeadMutInPlace>::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>,