Struct CryptoClient

pub struct CryptoClient {
    pub(crate) client: Client,
}

A client for the crypto operations.

Fields

client: Client

Implementations

impl CryptoClient

pub async fn initialize_user_crypto( &self, req: InitUserCryptoRequest, ) -> Result<(), EncryptionSettingsError>

Initialization method for the user crypto. Needs to be called before any other crypto operations.

pub async fn initialize_org_crypto( &self, req: InitOrgCryptoRequest, ) -> Result<(), EncryptionSettingsError>

Initialization method for the organization crypto. Needs to be called after initialize_user_crypto but before any other crypto operations.

pub fn make_key_pair( &self, user_key: B64, ) -> Result<MakeKeyPairResponse, CryptoError>

Generates a new key pair and encrypts the private key with the provided user key. Crypto initialization not required.

pub fn verify_asymmetric_keys( &self, request: VerifyAsymmetricKeysRequest, ) -> Result<VerifyAsymmetricKeysResponse, CryptoError>

Verifies a user’s asymmetric keys by decrypting the private key with the provided user key. Returns if the private key is decryptable and if it is a valid matching key. Crypto initialization not required.

pub fn make_keys_for_user_crypto_v2( &self, ) -> Result<UserCryptoV2KeysResponse, StatefulCryptoError>

Makes a new signing key pair and signs the public key for the user

pub fn get_v2_rotated_account_keys( &self, ) -> Result<UserCryptoV2KeysResponse, StatefulCryptoError>

Creates a rotated set of account keys for the current state

pub fn make_update_kdf( &self, password: String, kdf: Kdf, ) -> Result<UpdateKdfResponse, CryptoClientError>

Create the data necessary to update the user’s kdf settings. The user’s encryption key is re-encrypted for the password under the new kdf settings. This returns the re-encrypted user key and the new password hash but does not update sdk state.

pub fn enroll_pin( &self, pin: String, ) -> Result<EnrollPinResponse, CryptoClientError>

Protects the current user key with the provided PIN. The result can be stored and later used to initialize another client instance by using the PIN and the PIN key with initialize_user_crypto.

pub fn enroll_pin_with_encrypted_pin( &self, encrypted_pin: String, ) -> Result<EnrollPinResponse, CryptoClientError>

Protects the current user key with the provided PIN. The result can be stored and later used to initialize another client instance by using the PIN and the PIN key with initialize_user_crypto. The provided pin is encrypted with the user key.

pub fn unseal_password_protected_key_envelope( &self, pin: String, envelope: PasswordProtectedKeyEnvelope, ) -> Result<Vec<u8>, CryptoClientError>

Decrypts a PasswordProtectedKeyEnvelope, returning the user key, if successful. This is a stop-gap solution, until initialization of the SDK is used.

impl CryptoClient

pub async fn get_user_encryption_key(&self) -> Result<B64, CryptoClientError>

Get the uses’s decrypted encryption key. Note: It’s very important to keep this key safe, as it can be used to decrypt all of the user’s data

pub fn make_update_password( &self, new_password: String, ) -> Result<UpdatePasswordResponse, CryptoClientError>

Create the data necessary to update the user’s password. The user’s encryption key is re-encrypted with the new password. This returns the new encrypted user key and the new password hash but does not update sdk state.

pub fn derive_pin_key( &self, pin: String, ) -> Result<DerivePinKeyResponse, CryptoClientError>

Generates a PIN protected user key from the provided PIN. The result can be stored and later used to initialize another client instance by using the PIN and the PIN key with initialize_user_crypto.

pub fn derive_pin_user_key( &self, encrypted_pin: EncString, ) -> Result<EncString, CryptoClientError>

Derives the pin protected user key from encrypted pin. Used when pin requires master password on first unlock.

pub fn enroll_admin_password_reset( &self, public_key: B64, ) -> Result<UnsignedSharedKey, EnrollAdminPasswordResetError>

Prepares the account for being enrolled in the admin password reset feature. This encrypts the users UserKey with the organization’s public key.

pub fn derive_key_connector( &self, request: DeriveKeyConnectorRequest, ) -> Result<B64, DeriveKeyConnectorError>

Derive the master key for migrating to the key connector

Trait Implementations

impl From<CryptoClient> for JsValue

fn from(value: CryptoClient) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for CryptoClient

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) -> CryptoClient

Recover a Self from Self::Abi.

impl IntoWasmAbi for CryptoClient

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 CryptoClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<CryptoClient>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <CryptoClient as LongRefFromWasmAbi>::Abi, ) -> <CryptoClient as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for CryptoClient

fn is_none(abi: &<CryptoClient as FromWasmAbi>::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 CryptoClient

fn none() -> <CryptoClient as IntoWasmAbi>::Abi

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

impl RefFromWasmAbi for CryptoClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<CryptoClient>

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: <CryptoClient as RefFromWasmAbi>::Abi, ) -> <CryptoClient as RefFromWasmAbi>::Anchor

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

impl RefMutFromWasmAbi for CryptoClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<CryptoClient>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <CryptoClient as RefMutFromWasmAbi>::Abi, ) -> <CryptoClient as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for CryptoClient

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value( value: JsValue, ) -> Result<CryptoClient, <CryptoClient as TryFromJsValue>::Error>

Performs the conversion.

impl VectorFromWasmAbi for CryptoClient

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

unsafe fn vector_from_abi( js: <CryptoClient as VectorFromWasmAbi>::Abi, ) -> Box<[CryptoClient]>

impl VectorIntoWasmAbi for CryptoClient

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

fn vector_into_abi( vector: Box<[CryptoClient]>, ) -> <CryptoClient as VectorIntoWasmAbi>::Abi