Skip to main content

UserStore

Struct UserStore 

Source
pub struct UserStore { /* private fields */ }
Expand description

In-memory, serializable collection of users keyed by name.

Implementations§

Source§

impl UserStore

Source

pub fn new() -> Self

Create an empty store.

Source

pub fn create_user( &mut self, name: &str, password: &str, role: &str, ) -> Result<(), AuthError>

Create a new user.

Errors if name already exists or role is not a known builtin. The password is hashed with argon2id before storage.

Source

pub fn authenticate(&self, name: &str, candidate: &str) -> Option<&User>

Authenticate a user by name + candidate password.

Returns Some(&User) only on a verified match. Unknown user or wrong password both return None.

Source

pub fn set_role(&mut self, name: &str, role: &str) -> Result<(), AuthError>

Reassign a user’s role.

Errors if the user is unknown or the role is not a known builtin.

Source

pub fn set_password( &mut self, name: &str, new_password: &str, ) -> Result<(), AuthError>

Replace a user’s password with a new argon2id hash, preserving role.

Errors if the user is unknown. The new plaintext is held in a buffer that is zeroed on drop.

Source

pub fn delete_user(&mut self, name: &str) -> Result<(), AuthError>

Remove a user. Errors if the user is unknown.

Source

pub fn len(&self) -> usize

Number of users in the store.

Source

pub fn is_empty(&self) -> bool

Whether the store has no users. When empty, the server falls back to the legacy shared-password authentication path.

Source

pub fn list_users(&self) -> Vec<(String, String)>

List users as (name, role) pairs. Never exposes password hashes.

Source

pub fn save(&self, dir: &Path) -> Result<()>

Persist the store to dir/auth.json as pretty JSON.

On Unix the file is written with mode 0600.

Source

pub fn load(dir: &Path) -> Result<Self>

Load the store from dir/auth.json.

If the file does not exist, returns an empty store.

Trait Implementations§

Source§

impl Clone for UserStore

Source§

fn clone(&self) -> UserStore

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UserStore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for UserStore

Source§

fn default() -> UserStore

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for UserStore

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for UserStore

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.