Struct keybase_keystore::KeyStore

pub struct KeyStore { /* fields omitted */ }

Implementations

impl KeyStore

pub async fn open<T: AsRef<Path>>(path: T) -> Result<Self, Error>

Opens a keystore.

pub async fn apply_mask<'_, '_>(
    &'_ self,
    mask: &'_ Mask,
    next_gen: u16
) -> Result<(), Error>

Creates a new generation from a password mask.

pub async fn gen<'_>(&'_ self) -> u16

Returns the generation number.

pub async fn is_initialized<'_>(&'_ self) -> bool

Checks if the keystore is initialized.

pub async fn initialize<'_, '_, '_>(
    &'_ self,
    dk: &'_ DeviceKey,
    pass: &'_ Password,
    force: bool
) -> Result<(), Error>

Initializes the keystore.

pub async fn unlock<'_, '_>(
    &'_ self,
    pass: &'_ Password
) -> Result<DeviceKey, Error>

Unlocking the keystore makes the random key decryptable.

pub async fn lock<'_>(&'_ self) -> Result<(), Error>

Locks the keystore by zeroizing the noise file. This makes the encrypted random key undecryptable without a password.

pub async fn device_key<'_>(&'_ self) -> Result<DeviceKey, Error>

The random key is used to decrypt the device key.

NOTE: Only works if the keystore was unlocked.

pub async fn password<'_>(&'_ self) -> Result<Password, Error>

The random key is used to recover the password.

NOTE: Only works if the keystore was unlocked.

pub async fn public<'_>(&'_ self) -> Result<PublicDeviceKey, Error>

Returns the public device key.

pub async fn change_password_mask<'_, '_>(
    &'_ self,
    password: &'_ Password
) -> Result<Mask, Error>

Change password.