Enum SymmetricCryptoKey

pub enum SymmetricCryptoKey {
    Aes256CbcKey(Aes256CbcKey),
    Aes256CbcHmacKey(Aes256CbcHmacKey),
    XChaCha20Poly1305Key(XChaCha20Poly1305Key),
}

A symmetric encryption key. Used to encrypt and decrypt EncString

Variants

Aes256CbcKey(Aes256CbcKey)

Aes256CbcHmacKey(Aes256CbcHmacKey)

XChaCha20Poly1305Key(XChaCha20Poly1305Key)

Data encrypted by XChaCha20Poly1305Key keys has type Cose_Encrypt0_B64

Implementations

impl SymmetricCryptoKey

const AES256_CBC_KEY_LEN: usize = 32usize

const AES256_CBC_HMAC_KEY_LEN: usize = 64usize

pub(crate) fn make_aes256_cbc_hmac_key_internal( rng: impl RngCore + CryptoRng, ) -> Self

Generate a new random AES256_CBC SymmetricCryptoKey

WARNING: This function should only be used with a proper cryptographic RNG. If you do not have a good reason for using this function, use SymmetricCryptoKey::make_aes256_cbc_hmac_key instead.

pub fn make_aes256_cbc_hmac_key() -> Self

Generate a new random AES256_CBC_HMAC SymmetricCryptoKey

pub fn make_xchacha20_poly1305_key() -> Self

Generate a new random XChaCha20Poly1305 SymmetricCryptoKey

pub fn to_encoded(&self) -> Vec<u8>

Encodes the key to a byte array representation, that is separated by size. SymmetricCryptoKey::Aes256CbcHmacKey and SymmetricCryptoKey::Aes256CbcKey are encoded as 64 and 32 bytes respectively. SymmetricCryptoKey::XChaCha20Poly1305Key is encoded as at least 65 bytes, using padding.

This can be used for storage and transmission in the old byte array format. When the wrapping key is a COSE key, and the wrapped key is a COSE key, then this should not use the byte representation but instead use the COSE key representation.

pub(crate) fn to_encoded_raw(&self) -> Vec<u8>

Creates the byte representation of the key, without any padding. This should not be used directly for creating serialized key representations, instead, SymmetricCryptoKey::to_encoded should be used.

SymmetricCryptoKey::Aes256CbcHmacKey and SymmetricCryptoKey::Aes256CbcKey are encoded as 64 and 32 byte arrays respectively, representing the key bytes directly. SymmetricCryptoKey::XChaCha20Poly1305Key is encoded as a COSE key, serialized to a byte array. The COSE key can be either directly encrypted using COSE, where the content format hints an the key type, or can be represented as a byte array, if padded to be larger than the byte array representation of the other key types using the aforementioned SymmetricCryptoKey::to_encoded function.

pub fn to_base64(&self) -> String

Trait Implementations

impl Clone for SymmetricCryptoKey

fn clone(&self) -> SymmetricCryptoKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for SymmetricCryptoKey

fn ct_eq(&self, other: &SymmetricCryptoKey) -> Choice

Note: This is constant time with respect to comparing two keys of the same type, but not constant type with respect to the fact that different keys are compared. If two types of different keys are compared, then this does have different timing.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for SymmetricCryptoKey

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

Formats the value using the given formatter.

impl Drop for SymmetricCryptoKey

fn drop(&mut self)

Executes the destructor for this type.

impl KeyDecryptable<SymmetricCryptoKey, String> for EncString

fn decrypt_with_key( &self, key: &SymmetricCryptoKey, ) -> Result<String, CryptoError>

impl KeyDecryptable<SymmetricCryptoKey, Vec<u8>> for EncString

fn decrypt_with_key( &self, key: &SymmetricCryptoKey, ) -> Result<Vec<u8>, CryptoError>

impl KeyEncryptable<SymmetricCryptoKey, EncString> for &[u8]

fn encrypt_with_key( self, key: &SymmetricCryptoKey, ) -> Result<EncString, CryptoError>

impl KeyEncryptable<SymmetricCryptoKey, EncString> for &str

fn encrypt_with_key( self, key: &SymmetricCryptoKey, ) -> Result<EncString, CryptoError>

impl KeyEncryptable<SymmetricCryptoKey, EncString> for String

fn encrypt_with_key( self, key: &SymmetricCryptoKey, ) -> Result<EncString, CryptoError>

impl PartialEq for SymmetricCryptoKey

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 TryFrom<&CoseKey> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(cose_key: &CoseKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SymmetricCryptoKey> for MasterKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: &SymmetricCryptoKey) -> Result<Self, CryptoError>

Performs the conversion.

impl TryFrom<&mut [u8]> for SymmetricCryptoKey

fn try_from(value: &mut [u8]) -> Result<Self, Self::Error>

Note: This function takes the byte slice by mutable reference and will zero out all the data in it. This is to prevent the key from being left in memory.

type Error = CryptoError

The type returned in the event of a conversion error.

impl TryFrom<String> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl CryptoKey for SymmetricCryptoKey