Enum SymmetricCryptoKey 

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

The key type an Unlocked holds, re-exported so a caller building one for a test can name it. 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

Aes256GcmKey(Aes256GcmKey)

FIPS-approved AES-256-GCM key, used as the content-encryption key for FIPS DataEnvelopes. Encoded as a COSE key.

XAes256GcmKey(XAes256GcmKey)

Extended-nonce AES-256-GCM key. Encoded as a COSE key and used with type-7 EncStrings.

Implementations

impl SymmetricCryptoKey

pub fn make(algorithm: SymmetricKeyAlgorithm) -> SymmetricCryptoKey

Make a new SymmetricCryptoKey for the specified algorithm

pub fn to_encoded(&self) -> Bytes<BitwardenLegacyKeyContentFormat>

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. COSE-serialized variants are 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 fn to_base64(&self) -> B64

pub fn key_id(&self) -> Option<KeyId>

Returns the key ID of the key, if it has one. Every authenticated key variant has a key ID; only the unauthenticated SymmetricCryptoKey::Aes256CbcKey does not.

SymmetricCryptoKey::Aes256CbcHmacKey has no field to store a key ID in, and derives one from its key material instead: its RFC 9679 thumbprint, truncated to the key ID length. Two such keys with identical key material therefore share an ID.

Trait Implementations

impl Clone for SymmetricCryptoKey

fn clone(&self) -> SymmetricCryptoKey

Returns a duplicate 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 CoseKeyThumbprintExt for SymmetricCryptoKey

fn thumbprint(&self) -> Result<CoseKeyThumbprint, CryptoError>

Computes the RFC 9679 thumbprint of this symmetric key.

Returns an error for the unauthenticated legacy AES-CBC key, which is not representable as a COSE key.

impl CryptoKey for SymmetricCryptoKey

impl Debug for SymmetricCryptoKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SymmetricCryptoKey

fn deserialize<D>( deserializer: D, ) -> Result<SymmetricCryptoKey, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SymmetricCryptoKey

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl FromStr for SymmetricCryptoKey

type Err = CryptoError

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<SymmetricCryptoKey, <SymmetricCryptoKey as FromStr>::Err>

Parses a string s to return a value of this type.

impl KeyEncryptable<PinKey, EncString> for &SymmetricCryptoKey

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

Encrypts a value using the provided key reference.

impl PartialEq for SymmetricCryptoKey

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SymmetricCryptoKey

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Bytes<BitwardenLegacyKeyContentFormat>> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from( value: &Bytes<BitwardenLegacyKeyContentFormat>, ) -> Result<SymmetricCryptoKey, <SymmetricCryptoKey as TryFrom<&Bytes<BitwardenLegacyKeyContentFormat>>>::Error>

Performs the conversion.

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<SymmetricCryptoKey, <SymmetricCryptoKey as TryFrom<&CoseKey>>::Error>

Performs the conversion.

impl TryFrom<B64> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from( value: B64, ) -> Result<SymmetricCryptoKey, <SymmetricCryptoKey as TryFrom<B64>>::Error>

Performs the conversion.

impl TryFrom<EncodedSymmetricKey> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from( value: EncodedSymmetricKey, ) -> Result<SymmetricCryptoKey, <SymmetricCryptoKey as TryFrom<EncodedSymmetricKey>>::Error>

Performs the conversion.

impl TryFrom<String> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<SymmetricCryptoKey, <SymmetricCryptoKey as TryFrom<String>>::Error>

Performs the conversion.