Enum AsymmetricEncString

pub enum AsymmetricEncString {
    Rsa2048_OaepSha256_B64 {
        data: Vec<u8>,
    },
    Rsa2048_OaepSha1_B64 {
        data: Vec<u8>,
    },
    Rsa2048_OaepSha256_HmacSha256_B64 {
        data: Vec<u8>,
        mac: Vec<u8>,
    },
    Rsa2048_OaepSha1_HmacSha256_B64 {
        data: Vec<u8>,
        mac: Vec<u8>,
    },
}

Encrypted string primitive

AsymmetricEncString is a Bitwarden specific primitive that represents an asymmetrically encrypted string. They are used together with the KeyDecryptable and KeyEncryptable traits to encrypt and decrypt data using crate::AsymmetricCryptoKeys.

The flexibility of the AsymmetricEncString 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

• Rsa2048_OaepSha256_B64
• Rsa2048_OaepSha1_B64

Serialization

AsymmetricEncString implements std::fmt::Display and std::str::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].[data]

Where:

• [type]: is a digit number representing the variant.
• [data]: is the encrypted data.

Variants

Rsa2048_OaepSha256_B64

3

Fields

data: Vec<u8>

Rsa2048_OaepSha1_B64

4

Fields

data: Vec<u8>

Rsa2048_OaepSha256_HmacSha256_B64

👎Deprecated

5

Fields

data: Vec<u8>

👎Deprecated

mac: Vec<u8>

👎Deprecated

Rsa2048_OaepSha1_HmacSha256_B64

👎Deprecated

6

Fields

data: Vec<u8>

👎Deprecated

mac: Vec<u8>

👎Deprecated

Implementations

impl AsymmetricEncString

pub fn encrypt_rsa2048_oaep_sha1( data_dec: &[u8], key: &dyn AsymmetricEncryptable, ) -> Result<AsymmetricEncString, CryptoError>

Encrypt and produce a AsymmetricEncString::Rsa2048_OaepSha1_B64 variant.

const fn enc_type(&self) -> u8

The numerical representation of the encryption type of the AsymmetricEncString.

Trait Implementations

impl Clone for AsymmetricEncString

fn clone(&self) -> AsymmetricEncString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AsymmetricEncString

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

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AsymmetricEncString

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AsymmetricEncString

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

Formats the value using the given formatter.

impl Drop for AsymmetricEncString

fn drop(&mut self)

Executes the destructor for this type.

impl FromStr for AsymmetricEncString

Deserializes an AsymmetricEncString 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 AsymmetricEncString

Usually we wouldn’t want to expose AsymmetricEncStrings in the API or the schemas. But during the transition phase we will expose endpoints using the AsymmetricEncString 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<AsymmetricCryptoKey, String> for AsymmetricEncString

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

impl KeyDecryptable<AsymmetricCryptoKey, Vec<u8>> for AsymmetricEncString

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

impl Serialize for AsymmetricEncString

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

where S: Serializer,

Serialize this value into the given Serde serializer.