Enum EncString

pub enum EncString {
    AesCbc256_B64 {
        iv: [u8; 16],
        data: Vec<u8>,
    },
    AesCbc128_HmacSha256_B64 {
        iv: [u8; 16],
        mac: [u8; 32],
        data: Vec<u8>,
    },
    AesCbc256_HmacSha256_B64 {
        iv: [u8; 16],
        mac: [u8; 32],
        data: Vec<u8>,
    },
}

Encrypted string primitive

EncString is a Bitwarden specific primitive that represents a symmetrically encrypted string. They are are used together with the KeyDecryptable and KeyEncryptable traits to encrypt and decrypt data using SymmetricCryptoKeys.

The flexibility of the EncString type allows for different encryption algorithms to be used which is represented by the different variants of the enum.

Note

For backwards compatibility we will rarely if ever be able to remove support for decrypting old variants, but we should be opinionated in which variants are used for encrypting.

Variants

• AesCbc256_B64
• AesCbc128_HmacSha256_B64
• AesCbc256_HmacSha256_B64

Serialization

EncString implements Display and FromStr to allow for easy serialization and uses a custom scheme to represent the different variants.

The scheme is one of the following schemes:

• [type].[iv]|[data]
• [type].[iv]|[data]|[mac]

Where:

• [type]: is a digit number representing the variant.
• [iv]: (optional) is the initialization vector used for encryption.
• [data]: is the encrypted data.
• [mac]: (optional) is the MAC used to validate the integrity of the data.

Variants

AesCbc256_B64

0

Fields

iv: [u8; 16]

data: Vec<u8>

AesCbc128_HmacSha256_B64

1

Fields

iv: [u8; 16]

mac: [u8; 32]

data: Vec<u8>

AesCbc256_HmacSha256_B64

2

Fields

iv: [u8; 16]

mac: [u8; 32]

data: Vec<u8>

Implementations

impl EncString

pub fn try_from_optional( s: Option<String>, ) -> Result<Option<EncString>, CryptoError>

Synthetic sugar for mapping Option<String> to Result<Option<EncString>>

pub fn from_buffer(buf: &[u8]) -> Result<Self, CryptoError>

pub fn to_buffer(&self) -> Result<Vec<u8>, CryptoError>

impl EncString

pub(crate) fn encrypt_aes256_hmac( data_dec: &[u8], mac_key: &GenericArray<u8, U32>, key: &GenericArray<u8, U32>, ) -> Result<EncString, CryptoError>

const fn enc_type(&self) -> u8

The numerical representation of the encryption type of the EncString.

Trait Implementations

impl Clone for EncString

fn clone(&self) -> EncString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncString

To avoid printing sensitive information, EncString debug prints to EncString.

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EncString

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EncString

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

Formats the value using the given formatter.

impl Drop for EncString

fn drop(&mut self)

Executes the destructor for this type.

impl FromStr for EncString

Deserializes an EncString from a string.

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 JsonSchema for EncString

Usually we wouldn’t want to expose EncStrings in the API or the schemas. But during the transition phase we will expose endpoints using the EncString type.

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by 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<PinKey, EncString> for &[u8]

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

impl KeyEncryptable<PinKey, EncString> for String

fn encrypt_with_key(self, key: &PinKey) -> Result<EncString, 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 LocateKey for EncString

fn locate_key<'a>( &self, enc: &'a dyn KeyContainer, org_id: &Option<Uuid>, ) -> Result<&'a SymmetricCryptoKey, CryptoError>

impl PartialEq for EncString

fn eq(&self, other: &EncString) -> 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 EncString

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EncString