Struct UserCryptoManagementClient 

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

Client for managing the cryptographic machinery of a user account, including key-rotation.

Fields

client: Client

Implementations

impl UserCryptoManagementClient

pub async fn migrate_to_key_connector( &self, key_connector_url: String, ) -> Result<(), MigrateToKeyConnectorError>

Migrates an initialized account to Key Connector unlock.

Requires the client to be unlocked so the current user key is available in memory.

impl UserCryptoManagementClient

pub async fn password_change_and_rotate_user_keys( &self, request: PasswordChangeAndRotateUserKeysRequest, ) -> Result<(), RotateUserKeysError>

Combines a password change and user key rotation into a single request.

Before rotating, this checks whether the user’s public key encryption key pair needs regeneration and fixes it if necessary. This ensures that key rotation can proceed even if the existing private key is corrupt.

impl UserCryptoManagementClient

pub async fn rotate_user_keys( &self, request: RotateUserKeysRequest, ) -> Result<(), RotateUserKeysError>

Rotates the user’s encryption keys without a password change.

impl UserCryptoManagementClient

pub async fn get_untrusted_organization_public_keys( &self, ) -> Result<Vec<V1OrganizationMembership>, RotateUserKeysError>

Fetches the organization public keys for V1 organization memberships for the user for organizations for which reset password is enrolled. These have to be trusted manually be the user before rotating.

pub async fn get_untrusted_emergency_access_public_keys( &self, ) -> Result<Vec<V1EmergencyAccessMembership>, RotateUserKeysError>

Fetches the emergency access public keys for V1 emergency access memberships for the user. These have to be trusted manually be the user before rotating.

impl UserCryptoManagementClient

pub fn pin_settings(&self) -> PinSettingsClient

Returns the PIN settings sub-client.

impl UserCryptoManagementClient

pub async fn regenerate_public_key_encryption_key_pair_if_needed( &self, ) -> Result<bool, KeyPairRegenerationError>

Checks whether the user’s public key encryption key pair needs regeneration, and if so, generates a new key pair and submits it to the server.

If regeneration is performed, the updated [WrappedAccountCryptographicState] is persisted via the state bridge (when registered).

Requires the client to be unlocked so the current user key is available in memory. Only applicable to V1 encryption accounts.

pub async fn should_regenerate_public_key_encryption_key_pair( &self, ) -> Result<bool, KeyPairRegenerationError>

Checks whether the user’s public key encryption key pair needs regeneration.

Returns true if the key pair is missing, corrupt, or doesn’t match the public key on the server. Returns false if the key pair is valid or if regeneration is not applicable (e.g., user key not available, V2 encryption account).

pub(crate) async fn regenerate_public_key_encryption_key_pair_if_needed_with_ciphers( &self, ciphers: &[Cipher], ) -> Result<Option<WrappedAccountCryptographicState>, KeyPairRegenerationError>

Variant of Self::regenerate_public_key_encryption_key_pair_if_needed that accepts pre-fetched ciphers instead of fetching them from the API.

Returns None if no regeneration was needed, or the updated [WrappedAccountCryptographicState] read from the key store after regeneration.

impl UserCryptoManagementClient

pub(crate) fn new(client: Client) -> Self

Trait Implementations

impl Clone for UserCryptoManagementClient

fn clone(&self) -> UserCryptoManagementClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<UserCryptoManagementClient> for JsValue

fn from(value: UserCryptoManagementClient) -> Self

Converts to this type from the input type.

impl FromWasmAbi for UserCryptoManagementClient

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 UserCryptoManagementClient

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<UT> LiftRef<UT> for UserCryptoManagementClient

type LiftType = Arc<UserCryptoManagementClient>

impl LongRefFromWasmAbi for UserCryptoManagementClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<UserCryptoManagementClient>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl<UT> LowerError<UT> for UserCryptoManagementClient

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for UserCryptoManagementClient

type ReturnType = <Arc<UserCryptoManagementClient> 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 OptionFromWasmAbi for UserCryptoManagementClient

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 UserCryptoManagementClient

fn none() -> Self::Abi

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

impl RefFromWasmAbi for UserCryptoManagementClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<UserCryptoManagementClient>

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 UserCryptoManagementClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<UserCryptoManagementClient>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for UserCryptoManagementClient

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

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl<UT> TypeId<UT> for UserCryptoManagementClient

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for UserCryptoManagementClient

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

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

impl VectorIntoWasmAbi for UserCryptoManagementClient

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

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

impl WasmDescribe for UserCryptoManagementClient

fn describe()

impl WasmDescribeVector for UserCryptoManagementClient

fn describe_vector()

impl SupportsConstructor for UserCryptoManagementClient

impl SupportsInstanceProperty for UserCryptoManagementClient

impl SupportsStaticProperty for UserCryptoManagementClient