Skip to main content

SecurityState

Struct SecurityState 

Source
pub struct SecurityState {
    pub captcha_issuance: RateLimiter,
    pub captcha_validation_ip: RateLimiter,
    pub captcha_validation_account: RateLimiter,
    /* private fields */
}
Expand description

Authentication limiters shared through app state.

Fields§

§captcha_issuance: RateLimiter

CAPTCHA issue budget.

§captcha_validation_ip: RateLimiter

CAPTCHA validation budget by client.

§captcha_validation_account: RateLimiter

CAPTCHA validation budget by account identifier.

Implementations§

Source§

impl SecurityState

Source

pub fn new(captcha_budget_per_minute: NonZeroU32) -> Self

Creates the default authentication policy.

Source

pub fn with_auth_policy( captcha_budget_per_minute: NonZeroU32, auth_policy: AuthRateLimitPolicy, ) -> Self

Creates custom authentication budgets.

Source

pub fn client_key(&self, peer_ip: IpAddr) -> String

Derives a stable client key from the connection’s TCP peer address.

Source

pub fn check_login( &self, client_key: &str, account_identifier: &str, ) -> Result<(), AuthRateLimitRejection>

Checks both client and normalized account login budgets.

Source

pub fn reset_login(&self, client_key: &str, account_identifier: &str)

Clears login budgets after credentials have been accepted.

Invalid attempts remain rate limited, while successful sign-ins do not accumulate into a lockout for the same client or account.

Source

pub fn check_two_factor( &self, client_key: &str, ) -> Result<(), AuthRateLimitRejection>

Checks the two-factor budget.

Source

pub fn check_two_factor_account( &self, account_id: &str, ) -> Result<(), AuthRateLimitRejection>

Checks the account budget after validating a server-issued challenge. The account key is shared across login and settings verification.

Source

pub fn check_registration( &self, client_key: &str, ) -> Result<(), AuthRateLimitRejection>

Checks the registration budget.

Source

pub fn check_password_reset( &self, client_key: &str, ) -> Result<(), AuthRateLimitRejection>

Checks the password-reset budget before request parsing or password hashing.

Trait Implementations§

Source§

impl Clone for SecurityState

Source§

fn clone(&self) -> Self

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 SecurityState

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more