Struct PinLockSystem 

pub struct PinLockSystem<'a> {
    client: &'a Client,
}

Provides PIN-based unlock functionality. This includes enrolling into PIN-based unlock, unlocking using the PIN and handling necessary operations (PIN envelope refreshing when transitioning to after-first-unlock mode).

Fields

client: &'a Client

Implementations

impl PinLockSystem<'_>

fn key_store(&self) -> &KeyStore<KeySlotIds>

pub fn with_client(client: &Client) -> PinLockSystem<'_>

Creates a PIN lock system view for a client instance.

async fn get_active_pin_envelope(&self) -> Option<PasswordProtectedKeyEnvelope>

Retrieves the currently active PIN envelope.

If both envelopes are present, the ephemeral envelope is preferred.

pub(crate) async fn unlock(&self, pin: &str) -> Result<(), UnlockError>

Attempts to unlock the user key using pin.

Returns UnlockError::NoPinSet if no PIN is configured, UnlockError::PinWrong if pin is incorrect, and UnlockError::InternalError for other failures.

pub(crate) async fn on_unlock(&self)

Refreshes in-memory PIN unlock material after a successful non-PIN unlock.

This recreates the ephemeral PIN envelope from the encrypted PIN, when available.

pub async fn set_pin( &self, pin: String, lock_type: PinLockType, ) -> Result<(), ()>

Sets the PIN and stores the generated envelope according to the lock type.

pub async fn unset_pin(&self)

Clears both persistent and ephemeral PIN envelopes.

pub async fn get_pin_lock_type(&self) -> Option<PinLockType>

Returns the lock type for the currently configured PIN.

pub async fn get_pin_status(&self) -> PinUnlockStatus

Returns the current PIN unlock status.

If a lock type is configured but no ephemeral envelope is currently present, the status is PinUnlockStatus::NeedsUnlock.

pub async fn get_pin(&self) -> Option<String>

Returns the configured PIN, if an encrypted PIN is available and decryptable.

pub async fn validate_pin(&self, pin: String) -> bool

Validates that the provided PIN can decrypt the stored PIN envelope.