Struct UnlockClient 

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

Client for minting session keys and unlocking the vault with one.

Fields

client: Client

Implementations

impl UnlockClient

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

pub async fn generate_session_key(&self) -> Result<SessionKey, UnlockError>

Mint a new session key and persist the user key wrapped by it.

Requires the client to be unlocked (the user key must be present in the key store). The returned SessionKey should be stored outside the SDK by the caller and provided back to UnlockClient::unlock on the next rehydrated client.

pub async fn unlock(&self, unlock: UnlockMethod) -> Result<(), UnlockError>

Unlock a rehydrated client using the supplied unlock factor.

Reads [SESSION_PROTECTED_USER_KEY] and [ACCOUNT_CRYPTO_STATE] from the state registry, unwraps the user key, initializes the user’s crypto state, and restores any persisted organization keys.

pub async fn invalidate_session_key(&self) -> Result<(), SettingsError>

Invalidate the persisted session key, locking the vault for future invocations.

Removes [SESSION_PROTECTED_USER_KEY] from the database. Distinct from lock() on long-lived clients (mobile, desktop), which clears keys from memory: the CLI process exits between invocations, so locking must delete the persisted session key rather than mutate in-memory state.

Trait Implementations

impl Clone for UnlockClient

fn clone(&self) -> UnlockClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.