Skip to main content

MemoryAuth

Struct MemoryAuth 

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

Simple in-memory authentication backend using a hash set.

This is suitable for small deployments with a fixed set of users. For dynamic user management or large user bases, consider using a database-backed backend.

Implementations§

Source§

impl MemoryAuth

Source

pub fn new() -> Self

Create a new empty auth backend.

Source

pub fn from_hashes<I, S>(hashes: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Create from pre-computed SHA224 hashes.

§Example
use trojan_auth::MemoryAuth;

let auth = MemoryAuth::from_hashes(["abc123...", "def456..."]);
Source

pub fn from_passwords<I, S>(passwords: I) -> Self
where I: IntoIterator<Item = S>, S: AsRef<str>,

Create from plaintext passwords (will be hashed).

§Example
use trojan_auth::MemoryAuth;

let auth = MemoryAuth::from_passwords(["password1", "password2"]);
Source

pub fn from_passwords_with_ids<I, P, U>(pairs: I) -> Self
where I: IntoIterator<Item = (P, U)>, P: AsRef<str>, U: Into<String>,

Create from password-to-user-id pairs.

§Example
use trojan_auth::MemoryAuth;

let auth = MemoryAuth::from_passwords_with_ids([
    ("password1", "user1"),
    ("password2", "user2"),
]);
Source

pub fn add_password(&mut self, password: &str, user_id: Option<String>)

Add a user with a plaintext password.

Source

pub fn add_hash(&mut self, hash: String, user_id: Option<String>)

Add a user with a pre-computed hash.

Source

pub fn remove_hash(&mut self, hash: &str) -> bool

Remove a user by hash.

Source

pub fn len(&self) -> usize

Get the number of registered users.

Source

pub fn is_empty(&self) -> bool

Check if no users are registered.

Source

pub fn contains(&self, hash: &str) -> bool

Check if a hash is registered.

Trait Implementations§

Source§

impl AuthBackend for MemoryAuth

Source§

fn verify<'life0, 'life1, 'async_trait>( &'life0 self, hash: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<AuthResult, AuthError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Verify a password hash. Read more
Source§

fn record_traffic<'life0, 'life1, 'async_trait>( &'life0 self, _user_id: &'life1 str, _bytes: u64, ) -> Pin<Box<dyn Future<Output = Result<(), AuthError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Optional: Record traffic usage for a user. Read more
Source§

impl Clone for MemoryAuth

Source§

fn clone(&self) -> MemoryAuth

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MemoryAuth

Source§

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

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

impl Default for MemoryAuth

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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.