Struct UnlockClient 

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

Client for unlocking and locking the vault in memory, and for minting session keys and unlocking the vault with one.

Fields

client: Client

Implementations

impl UnlockClient

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 invalidate_session_key(&self) -> Result<(), SettingsError>

Delete the persisted session key, so later CLI invocations can no longer unlock with it.

Removes [SESSION_PROTECTED_USER_KEY] from the database. This is how the CLI locks: each command runs in a new process, so there are no in-memory keys to clear. Long-lived clients lock with UnlockClient::lock instead.

impl UnlockClient

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

Unlock the client with the supplied unlock factor.

UnlockMethod::Legacy initializes the user’s crypto state from the request, as CryptoClient::initialize_user_crypto does, and returns its errors as UnlockError::EncryptionSettings.

If the client is already unlocked, this returns UnlockError::AlreadyUnlocked before doing any work and leaves the client’s keys untouched. The check only looks at whether a user key is present: it does not check which key the client holds, or whether it belongs to the user or account in the request.

impl UnlockClient

pub async fn lock(&self)

Clear the in-memory user and organization keys, retaining the client instance so that a later UnlockClient::unlock re-unlocks it.

On WASM, unlocking also copies the user key into client-held state through the key-management state bridge, so locking clears it there as well. The in-memory keys are cleared first, so the SDK is locked even if the state bridge call fails.

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.

impl FromWasm for UnlockClient

Available on crate feature wasm only.

type Wire = UnlockClient

The type JavaScript actually passes.

fn from_wire( wire: <UnlockClient as FromWasm>::Wire, ) -> Result<UnlockClient, WireError>

Recovers the Rust value from the wire value.

impl FromWasmAbi for UnlockClient

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) -> UnlockClient

Recover a Self from Self::Abi.

impl IntoWasmAbi for UnlockClient

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 UnlockClient

type LiftType = Arc<UnlockClient>

impl LongRefFromWasmAbi for UnlockClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<UnlockClient>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <UnlockClient as LongRefFromWasmAbi>::Abi, ) -> <UnlockClient as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl<UT> LowerError<UT> for UnlockClient

fn lower_error(obj: UnlockClient) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for UnlockClient

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

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

fn lower_return( obj: UnlockClient, ) -> Result<<UnlockClient as LowerReturn<UT>>::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 UnlockClient

fn is_none(abi: &<UnlockClient as FromWasmAbi>::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 UnlockClient

fn none() -> <UnlockClient as IntoWasmAbi>::Abi

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

impl RefFromWasmAbi for UnlockClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<UnlockClient>

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: <UnlockClient as RefFromWasmAbi>::Abi, ) -> <UnlockClient as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for UnlockClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<UnlockClient>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <UnlockClient as RefMutFromWasmAbi>::Abi, ) -> <UnlockClient as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl ToWasm for UnlockClient

Available on crate feature wasm only.

type Wire = UnlockClient

The type JavaScript actually receives.

fn to_wire(self) -> Result<<UnlockClient as ToWasm>::Wire, WireError>

Converts the Rust value into the wire value.

impl TryFromJsValue for UnlockClient

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

Performs the conversion.

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

Performs the conversion.

impl<UT> TypeId<UT> for UnlockClient

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for UnlockClient

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

unsafe fn vector_from_abi( js: <UnlockClient as VectorFromWasmAbi>::Abi, ) -> Box<[UnlockClient]>

impl VectorIntoWasmAbi for UnlockClient

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

fn vector_into_abi( vector: Box<[UnlockClient]>, ) -> <UnlockClient as VectorIntoWasmAbi>::Abi