Struct PureCrypto

pub struct PureCrypto {}

This module represents a stopgap solution to provide access to primitive crypto functions for JS clients. It is not intended to be used outside of the JS clients and this pattern should not be proliferated. It is necessary because we want to use SDK crypto prior to the SDK being fully responsible for state and keys.

Implementations

impl PureCrypto

pub fn symmetric_decrypt( enc_string: String, key: Vec<u8>, ) -> Result<String, CryptoError>

DEPRECATED: Use symmetric_decrypt_string instead. Cleanup ticket: https://bitwarden.atlassian.net/browse/PM-21247

pub fn symmetric_decrypt_string( enc_string: String, key: Vec<u8>, ) -> Result<String, CryptoError>

pub fn symmetric_decrypt_bytes( enc_string: String, key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

pub fn symmetric_decrypt_array_buffer( enc_bytes: Vec<u8>, key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

DEPRECATED: Use symmetric_decrypt_filedata instead. Cleanup ticket: https://bitwarden.atlassian.net/browse/PM-21247

pub fn symmetric_decrypt_filedata( enc_bytes: Vec<u8>, key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

pub fn symmetric_encrypt_string( plain: String, key: Vec<u8>, ) -> Result<String, CryptoError>

pub fn symmetric_encrypt_bytes( plain: Vec<u8>, key: Vec<u8>, ) -> Result<String, CryptoError>

pub fn symmetric_encrypt_filedata( plain: Vec<u8>, key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

pub fn decrypt_user_key_with_master_password( encrypted_user_key: String, master_password: String, email: String, kdf: Kdf, ) -> Result<Vec<u8>, CryptoError>

pub fn encrypt_user_key_with_master_password( user_key: Vec<u8>, master_password: String, email: String, kdf: Kdf, ) -> Result<String, CryptoError>

pub fn make_user_key_aes256_cbc_hmac() -> Vec<u8>

pub fn make_user_key_xchacha20_poly1305() -> Vec<u8>

pub fn wrap_symmetric_key( key_to_be_wrapped: Vec<u8>, wrapping_key: Vec<u8>, ) -> Result<String, CryptoError>

Wraps (encrypts) a symmetric key using a symmetric wrapping key, returning the wrapped key as an EncString.

pub fn unwrap_symmetric_key( wrapped_key: String, wrapping_key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

Unwraps (decrypts) a wrapped symmetric key using a symmetric wrapping key, returning the unwrapped key as a serialized byte array.

pub fn wrap_encapsulation_key( encapsulation_key: Vec<u8>, wrapping_key: Vec<u8>, ) -> Result<String, CryptoError>

Wraps (encrypts) an SPKI DER encoded encapsulation (public) key using a symmetric wrapping key. Note: Usually, a public key is - by definition - public, so this should not be used. The specific use-case for this function is to enable rotateable key sets, where the “public key” is not public, with the intent of preventing the server from being able to overwrite the user key unlocked by the rotateable keyset.

pub fn unwrap_encapsulation_key( wrapped_key: String, wrapping_key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

Unwraps (decrypts) a wrapped SPKI DER encoded encapsulation (public) key using a symmetric wrapping key.

pub fn wrap_decapsulation_key( decapsulation_key: Vec<u8>, wrapping_key: Vec<u8>, ) -> Result<String, CryptoError>

Wraps (encrypts) a PKCS8 DER encoded decapsulation (private) key using a symmetric wrapping key,

pub fn unwrap_decapsulation_key( wrapped_key: String, wrapping_key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

Unwraps (decrypts) a wrapped PKCS8 DER encoded decapsulation (private) key using a symmetric wrapping key.

pub fn encapsulate_key_unsigned( shared_key: Vec<u8>, encapsulation_key: Vec<u8>, ) -> Result<String, CryptoError>

Encapsulates (encrypts) a symmetric key using an asymmetric encapsulation key (public key) in SPKI format, returning the encapsulated key as a string. Note: This is unsigned, so the sender’s authenticity cannot be verified by the recipient.

pub fn decapsulate_key_unsigned( encapsulated_key: String, decapsulation_key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

Decapsulates (decrypts) a symmetric key using an decapsulation key (private key) in PKCS8 DER format. Note: This is unsigned, so the sender’s authenticity cannot be verified by the recipient.

pub fn verifying_key_for_signing_key( signing_key: String, wrapping_key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

Given a wrapped signing key and the symmetric key it is wrapped with, this returns the corresponding verifying key.

pub fn key_algorithm_for_verifying_key( verifying_key: Vec<u8>, ) -> Result<SignatureAlgorithm, CryptoError>

Returns the algorithm used for the given verifying key.

pub fn verify_and_unwrap_signed_public_key( signed_public_key: Vec<u8>, verifying_key: Vec<u8>, ) -> Result<Vec<u8>, CryptoError>

For a given signing identity (verifying key), this function verifies that the signing identity claimed ownership of the public key. This is a one-sided claim and merely shows that the signing identity has the intent to receive messages encrypted to the public key.

Trait Implementations

impl From<PureCrypto> for JsValue

fn from(value: PureCrypto) -> Self

Converts to this type from the input type.

impl FromWasmAbi for PureCrypto

type Abi = u32

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

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for PureCrypto

type Abi = u32

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

fn into_abi(self) -> u32

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

impl LongRefFromWasmAbi for PureCrypto

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<PureCrypto>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for PureCrypto

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 OptionIntoWasmAbi for PureCrypto

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for PureCrypto

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<PureCrypto>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for PureCrypto

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<PureCrypto>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for PureCrypto

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for PureCrypto

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[PureCrypto]>

impl VectorIntoJsValue for PureCrypto

fn vector_into_jsvalue(vector: Box<[PureCrypto]>) -> JsValue

impl VectorIntoWasmAbi for PureCrypto

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[PureCrypto]>) -> Self::Abi

impl WasmDescribe for PureCrypto

fn describe()

impl WasmDescribeVector for PureCrypto

fn describe_vector()

impl SupportsConstructor for PureCrypto

impl SupportsInstanceProperty for PureCrypto

impl SupportsStaticProperty for PureCrypto