Struct AesKey 

pub struct AesKey<T: AesType>(/* private fields */);

Available on crate feature aes only.

An AES symmetric encryption key

Trait Implementations

impl<T: AesType> Clone for AesKey<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: AesType> Debug for AesKey<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T: AesType> Deserialize<'de> for AesKey<T>

where ArrayKey<<T as AesType>::KeySize>: for<'a> Deserialize<'a>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: AesType> FromJwk for AesKey<T>

fn from_jwk_parts(jwk: JwkParts<'_>) -> Result<Self, Error>

Import the key from a pre-parsed JWK

fn from_jwk(jwk: &str) -> Result<Self, Error>

Import the key from a JWK string reference

fn from_jwk_slice(jwk: &[u8]) -> Result<Self, Error>

Import the key from a JWK byte slice

impl<T: AesType> FromKeyDerivation for AesKey<T>

fn from_key_derivation<D: KeyDerivation>(derive: D) -> Result<Self, Error>

where Self: Sized,

Create a new instance of a key from a key derivation

impl<Lhs, Rhs, T> FromKeyExchange<Lhs, Rhs> for AesKey<T>

where Lhs: KeyExchange<Rhs> + ?Sized, Rhs: ?Sized, T: AesType,

fn from_key_exchange(lhs: &Lhs, rhs: &Rhs) -> Result<Self, Error>

Derive an instance of this key directly from a supported key exchange

impl<T: AesType> HasKeyAlg for AesKey<T>

fn algorithm(&self) -> KeyAlg

Get the corresponding key algorithm.

impl<T: AesType> HasKeyBackend for AesKey<T>

fn key_backend(&self) -> KeyBackend

Get the corresponding key backend.

impl<C, D> KeyAeadInPlace for AesKey<AesCbcHmac<C, D>>

where AesCbcHmac<C, D>: AesType, C: BlockCipher + KeyInit + BlockEncryptMut + BlockDecryptMut, D: Digest + BlockSizeUser, C::KeySize: Shl<B1>, <C::KeySize as Shl<B1>>::Output: ArrayLength<u8>,

fn encrypt_in_place( &self, buffer: &mut dyn ResizeBuffer, nonce: &[u8], aad: &[u8], ) -> Result<usize, Error>

Encrypt a secret value in place, appending the verification tag and returning the length of the ciphertext

fn decrypt_in_place( &self, buffer: &mut dyn ResizeBuffer, nonce: &[u8], aad: &[u8], ) -> Result<(), Error>

Decrypt an encrypted (verification tag appended) value in place

fn aead_params(&self) -> KeyAeadParams

Get the nonce and tag length for encryption

fn aead_padding(&self, msg_len: usize) -> usize

Get the ciphertext padding required

impl<C> KeyAeadInPlace for AesKey<AesKeyWrap<C>>

where AesKeyWrap<C>: AesType, C: KeyInit + KeySizeUser<KeySize = <AesKeyWrap<C> as AesType>::KeySize> + BlockCipher<BlockSize = U16> + BlockDecrypt + BlockEncrypt,

fn encrypt_in_place( &self, buffer: &mut dyn ResizeBuffer, nonce: &[u8], aad: &[u8], ) -> Result<usize, Error>

Encrypt a secret value in place, appending the verification tag and returning the length of the ciphertext

fn decrypt_in_place( &self, buffer: &mut dyn ResizeBuffer, nonce: &[u8], aad: &[u8], ) -> Result<(), Error>

Decrypt an encrypted (verification tag appended) value in place

fn aead_params(&self) -> KeyAeadParams

Get the nonce and tag length for encryption

fn aead_padding(&self, _msg_len: usize) -> usize

Get the ciphertext padding required

impl<T> KeyAeadInPlace for AesKey<T>

where T: KeyInit + AeadInPlace + AesType<KeySize = <T as KeySizeUser>::KeySize>,

fn encrypt_in_place( &self, buffer: &mut dyn ResizeBuffer, nonce: &[u8], aad: &[u8], ) -> Result<usize, Error>

Encrypt a secret value in place, appending the verification tag

fn decrypt_in_place( &self, buffer: &mut dyn ResizeBuffer, nonce: &[u8], aad: &[u8], ) -> Result<(), Error>

Decrypt an encrypted (verification tag appended) value in place

fn aead_params(&self) -> KeyAeadParams

Get the nonce and tag length for encryption

fn aead_padding(&self, _msg_len: usize) -> usize

Get the ciphertext padding required

impl<C, D> KeyAeadMeta for AesKey<AesCbcHmac<C, D>>

where AesCbcHmac<C, D>: AesType, C: BlockCipher + KeyInit,

type NonceSize = <C as BlockSizeUser>::BlockSize

The size of the AEAD nonce

type TagSize = <C as KeySizeUser>::KeySize

The size of the AEAD tag

fn random_nonce() -> GenericArray<u8, Self::NonceSize>

Available on crate feature getrandom only.

Generate a new random nonce

impl<C> KeyAeadMeta for AesKey<AesKeyWrap<C>>

where AesKeyWrap<C>: AesType,

type NonceSize = UTerm

The size of the AEAD nonce

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

The size of the AEAD tag

fn random_nonce() -> GenericArray<u8, Self::NonceSize>

Available on crate feature getrandom only.

Generate a new random nonce

impl<T: AeadCore + AesType> KeyAeadMeta for AesKey<T>

type NonceSize = <T as AeadCore>::NonceSize

The size of the AEAD nonce

type TagSize = <T as AeadCore>::TagSize

The size of the AEAD tag

fn random_nonce() -> GenericArray<u8, Self::NonceSize>

Available on crate feature getrandom only.

Generate a new random nonce

impl<T: AesType> KeyGen for AesKey<T>

fn generate(rng: impl KeyMaterial) -> Result<Self, Error>

Create a new key from a key material generator.

fn random() -> Result<Self, Error>

Available on crate feature getrandom only.

Generate a new random key.

impl<T: AesType> KeyMeta for AesKey<T>

type KeySize = <T as AesType>::KeySize

The size of the key secret bytes

impl<T: AesType> KeySecretBytes for AesKey<T>

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

Create a new key instance from a slice of key secret bytes.

fn with_secret_bytes<O>(&self, f: impl FnOnce(Option<&[u8]>) -> O) -> O

Access a temporary slice of the key secret bytes, if any.

impl<T: AesType> PartialEq for AesKey<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: AesType> Serialize for AesKey<T>

where ArrayKey<<T as AesType>::KeySize>: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: AesType> ToJwk for AesKey<T>

fn encode_jwk(&self, enc: &mut dyn JwkEncoder) -> Result<(), Error>

Write the JWK representation to an encoder

fn to_jwk_thumbprint(&self, alg: Option<KeyAlg>) -> Result<String, Error>

Available on crate feature alloc only.

Create the JWK thumbprint of the key

fn to_jwk_public(&self, alg: Option<KeyAlg>) -> Result<String, Error>

Available on crate feature alloc only.

Create a JWK of the public key

fn to_jwk_secret(&self, alg: Option<KeyAlg>) -> Result<SecretBytes, Error>

Available on crate feature alloc only.

Create a JWK of the secret key

impl<T: AesType> Zeroize for AesKey<T>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<T: AesType> Eq for AesKey<T>