Struct ClientAuth

pub struct ClientAuth(pub(crate) Arc<Client>);

Tuple Fields

0: Arc<Client>

Implementations

impl ClientAuth

pub fn password_strength( &self, password: String, email: String, additional_inputs: Vec<String>, ) -> u8

API Draft: Calculate Password Strength

pub fn satisfies_policy( &self, password: String, strength: u8, policy: MasterPasswordPolicyOptions, ) -> bool

Evaluate if the provided password satisfies the provided policy

pub async fn hash_password( &self, email: String, password: String, kdf_params: Kdf, purpose: HashPurpose, ) -> Result<String, BitwardenError>

Hash the user password

pub fn make_register_keys( &self, email: String, password: String, kdf: Kdf, ) -> Result<RegisterKeyResponse, BitwardenError>

Generate keys needed for registration process

pub fn make_register_tde_keys( &self, email: String, org_public_key: String, remember_device: bool, ) -> Result<RegisterTdeKeyResponse, BitwardenError>

Generate keys needed for TDE process

pub fn make_key_connector_keys( &self, ) -> Result<KeyConnectorResponse, BitwardenError>

Generate keys needed to onboard a new user without master key to key connector

pub fn validate_password( &self, password: String, password_hash: String, ) -> Result<bool, BitwardenError>

Validate the user password

To retrieve the user’s password hash, use ClientAuth::hash_password with HashPurpose::LocalAuthentication during login and persist it. If the login method has no password, use the email OTP.

pub fn validate_password_user_key( &self, password: String, encrypted_user_key: String, ) -> Result<String, BitwardenError>

Validate the user password without knowing the password hash

Used for accounts that we know have master passwords but that have not logged in with a password. Some example are login with device or TDE.

This works by comparing the provided password against the encrypted user key.

pub fn validate_pin( &self, pin: String, pin_protected_user_key: EncString, ) -> Result<bool, BitwardenError>

Validate the user PIN

To validate the user PIN, you need to have the user’s pin_protected_user_key. This key is obtained when enabling PIN unlock on the account with the derive_pin_key method.

This works by comparing the decrypted user key with the current user key, so the client must be unlocked.

pub fn new_auth_request( &self, email: String, ) -> Result<AuthRequestResponse, BitwardenError>

Initialize a new auth request

pub fn approve_auth_request( &self, public_key: String, ) -> Result<AsymmetricEncString, BitwardenError>

Approve an auth request

pub fn trust_device(&self) -> Result<TrustDeviceResponse, BitwardenError>

Trust the current device

Trait Implementations

impl<UT> LiftRef<UT> for ClientAuth

type LiftType = Arc<ClientAuth>

impl<UT> LowerError<UT> for ClientAuth

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for ClientAuth

type ReturnType = <Arc<ClientAuth> 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 ClientAuth

const TYPE_ID_META: MetadataBuffer = _