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 async fn get_user_encryption_key(&self) -> Result<String, MobileCryptoError>

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 update_password( &self, new_password: String, ) -> Result<UpdatePasswordResponse, MobileCryptoError>

Update the user’s password, which will re-encrypt the user’s encryption key with the new password. This returns the new encrypted user key and the new password hash.

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

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, MobileCryptoError>

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: String, ) -> Result<AsymmetricEncString, EnrollAdminPasswordResetError>

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

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

Derive the master key for migrating to the key connector

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

Generates a new key pair and encrypts the private key with the provided user key.

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.