Struct websession::backingstore::FileBackingStore

pub struct FileBackingStore { /* fields omitted */ }

File based backing store.

Implementations

impl FileBackingStore

pub fn new(filename: &str) -> FileBackingStore

Create a new file based backing store with the given file. The file must already exist, and is assumed to have appropriate permissions.

pub fn new_with_cost(filename: &str, cost: u32) -> FileBackingStore

Create a new file based backing store with the given file. The file must already exist, and is assumed to have appropriate permissions.

Trait Implementations

impl BackingStore for FileBackingStore

fn encrypt_credentials(&self, plain: &str) -> Result<String, BackingStoreError>

Encrypt unencrypted credentials. For passwords, this should be a sound hashing function. For some credentials, such as public keys, additional encryption may be unneeded.

fn get_credentials(
    &self,
    user: &str,
    fail_if_locked: bool
) -> Result<String, BackingStoreError>

Get the credentials for the user. For passwords, this would be the salted hashed password.

fn verify(
    &self,
    user: &str,
    plain_cred: &str
) -> Result<bool, BackingStoreError>

Verify the credentials for the user. It takes unencrypted passwords, such as that provided by a user logging in.

fn update_credentials(
    &self,
    user: &str,
    enc_cred: &str
) -> Result<(), BackingStoreError>

Set new credentials for the user.

fn lock(&self, user: &str) -> Result<(), BackingStoreError>

Lock the user to prevent logins. Locked users cannot verify, but the credentials are not cleared and can therefore be restored later (see unlock).

fn is_locked(&self, user: &str) -> Result<bool, BackingStoreError>

Check if the user is locked.

fn unlock(&self, user: &str) -> Result<(), BackingStoreError>

Unlock the user, restoring the original password/credentials.

fn create_preencrypted(
    &self,
    user: &str,
    enc_cred: &str
) -> Result<(), BackingStoreError>

Create a new user with the given credentials. Returns BackingStoreError::UserExists if the user already exists.

fn delete(&self, user: &str) -> Result<(), BackingStoreError>

Returns Ok(()) on deletion, Err(BackingStoreError::NoSuchUser) if they were already deleted, or IO or Mutex errors.

fn users(&self) -> Result<Vec<String>, BackingStoreError>

Return a Vec of the user names. users_iter may be more appropriate when there are large numbers of users. Only one of users or users_iter needs to be implemented, as the default implementations will take care of the other. However, there may be performance reasons to implement both.

fn check_user(&self, user: &str) -> Result<bool, BackingStoreError>

Return whether or not the user already exists in the backing store. May return a BackingStoreError, in particular, BackingStoreError::Locked, which means the user exists but the account is locked.

fn update_credentials_plain(
    &self,
    user: &str,
    plain_cred: &str
) -> Result<(), BackingStoreError>

Convenience method, calling encrypt_credentials and update_credentials. The default implementation should normally be sufficient.

fn create_plain(
    &self,
    user: &str,
    plain_cred: &str
) -> Result<(), BackingStoreError>

Convenience method, calling encrypt_credentials and create_preencrypted. The default implementation should normally be sufficient.

fn users_iter(&self) -> Result<IntoIter<String>, BackingStoreError>

Return an Iterator over the user names. users may be more convenient when there are small numbers of users. Only one of users or users_iter needs to be implemented, as the default implementations will take care of the other. However, there may be performance reasons to implement both.

impl Debug for FileBackingStore

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.