Struct CryptoClient

pub struct CryptoClient(pub(crate) CryptoClient);

Tuple Fields

0: CryptoClient

Implementations

impl CryptoClient

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

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<(), BitwardenError>

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<B64, BitwardenError>

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

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.

Note: This is deprecated and make_update_password should be used instead

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

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

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

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

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

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: EncString, ) -> Result<EnrollPinResponse, BitwardenError>

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 enroll_admin_password_reset( &self, public_key: B64, ) -> Result<UnsignedSharedKey, BitwardenError>

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

Derive the master key for migrating to the key connector

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

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 new encrypted user key and the new password hash but does not update sdk state.

Trait Implementations

impl<UT> LiftRef<UT> for CryptoClient

type LiftType = Arc<CryptoClient>

impl<UT> LowerError<UT> for CryptoClient

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for CryptoClient

type ReturnType = <Arc<CryptoClient> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for CryptoClient

const TYPE_ID_META: MetadataBuffer