Enum SymmetricCryptoKey 

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

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

const AES256_CBC_KEY_LEN: usize = 32

const AES256_CBC_HMAC_KEY_LEN: usize = 64

pub(crate) fn make_aes256_cbc_hmac_key_internal(rng: impl 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(algorithm: SymmetricKeyAlgorithm) -> Self

Make a new SymmetricCryptoKey for the specified algorithm

pub(crate) fn make_aes256_cbc_hmac_key() -> Self

Generate a new random AES256_CBC_HMAC SymmetricCryptoKey

pub(crate) fn make_xchacha20_poly1305_key() -> Self

Generate a new random XChaCha20Poly1305 SymmetricCryptoKey

pub fn to_encoded(&self) -> BitwardenLegacyKeyBytes

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(crate) fn to_encoded_raw(&self) -> EncodedSymmetricKey

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. XChaCha20-Poly1305, AES-256-GCM, and XAES-256-GCM keys are encoded as serialized COSE keys. A COSE key can be directly encrypted with a COSE key content format or represented as a byte array. When represented as a byte array, the array is padded to be larger than the byte array representation of the other aforementioned key types.

pub(crate) fn try_from_cose(serialized_key: &[u8]) -> Result<Self, CryptoError>

pub fn to_base64(&self) -> B64

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

Returns the key ID of the key, if it has one. COSE-serialized key variants have a key ID.

pub(crate) fn as_cose_key_view(&self) -> Option<CoseKeyView<'_>>

Returns a CoseKeyView for COSE-encoded symmetric key variants. Legacy AES-CBC variants return None.

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 legacy AES-CBC keys, which are not currently representable as COSE keys.

impl Debug for SymmetricCryptoKey

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

Formats the value using the given formatter.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::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.

impl FromStr for SymmetricCryptoKey

type Err = CryptoError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl FromWasmAbi for SymmetricCryptoKey

Available on crate feature wasm only.

type Abi = <String as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(abi: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for SymmetricCryptoKey

Available on crate feature wasm only.

type Abi = <String as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

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<PinKey, EncString> for &SymmetricCryptoKey

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

Encrypts a value using the provided key reference.

impl<T: ConstContentFormat> KeyEncryptable<SymmetricCryptoKey, EncString> for &Bytes<T>

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

Encrypts a value using the provided key reference.

impl KeyEncryptable<SymmetricCryptoKey, EncString> for &str

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

Encrypts a value using the provided key reference.

impl KeyEncryptable<SymmetricCryptoKey, EncString> for String

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

Encrypts a value using the provided key reference.

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

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

impl OptionFromWasmAbi for SymmetricCryptoKey

Available on crate feature wasm only.

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

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 Serialize for SymmetricCryptoKey

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::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: &BitwardenLegacyKeyBytes) -> Result<Self, Self::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<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<B64> for SymmetricCryptoKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: B64) -> Result<Self, Self::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<Self, Self::Error>

Performs the conversion.

impl TryFrom<JsValue> for SymmetricCryptoKey

Available on crate feature wasm only.

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: JsValue) -> Result<Self, Self::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<Self, Self::Error>

Performs the conversion.

impl WasmDescribe for SymmetricCryptoKey

Available on crate feature wasm only.

fn describe()

impl CryptoKey for SymmetricCryptoKey