Enum UnsignedSharedKey

pub enum UnsignedSharedKey {
    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

UnsignedSharedKey is a Bitwarden specific primitive that represents an asymmetrically encrypted symmetric key. Since the symmetric key is directly encrypted with the public key, without any further signature, the receiver cannot guarantee the senders identity.

UnsignedSharedKey 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

UnsignedSharedKey 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 UnsignedSharedKey

pub fn encapsulate_key_unsigned( encapsulated_key: &SymmetricCryptoKey, encapsulation_key: &dyn AsymmetricEncryptable, ) -> Result<UnsignedSharedKey, CryptoError>

Encapsulate a symmetric key, to be shared asymmetrically. Produces a UnsignedSharedKey::Rsa2048_OaepSha1_B64 variant. Note, this does not sign the data and thus does not guarantee sender authenticity.

const fn enc_type(&self) -> u8

The numerical representation of the encryption type of the UnsignedSharedKey.

impl UnsignedSharedKey

pub fn decapsulate_key_unsigned( &self, decapsulation_key: &AsymmetricCryptoKey, ) -> Result<SymmetricCryptoKey, CryptoError>

Decapsulate a symmetric key, shared asymmetrically. Note: The shared key does not have a sender signature and sender authenticity is not guaranteed.

Trait Implementations

impl Clone for UnsignedSharedKey

fn clone(&self) -> UnsignedSharedKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnsignedSharedKey

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

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnsignedSharedKey

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UnsignedSharedKey

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

Formats the value using the given formatter.

impl Drop for UnsignedSharedKey

fn drop(&mut self)

Executes the destructor for this type.

impl FromStr for UnsignedSharedKey

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

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

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(generator: &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 Serialize for UnsignedSharedKey

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

where S: Serializer,

Serialize this value into the given Serde serializer.