Skip to main content

MfaPolicy

Enum MfaPolicy 

Source
pub enum MfaPolicy {
    Disabled,
    Optional,
    Required,
    RequiredForRoles(&'static [Role]),
}
Expand description

Framework-wide MFA enforcement policy.

Plain Copy enum (no trait object) — operators wire it onto Admin via [crate::admin::types::Admin::require_mfa]. The login_guard consults the active policy AFTER successful password verification and AFTER R2’s must_change_password check (commit #15 of the R3 plan).

Forward-only enforcement (D6). Switching to MfaPolicy::Required does NOT retroactively revoke existing sessions. Existing users without MFA enrolled are redirected to /admin/mfa/enroll at the next request that hits login_guard. The pattern mirrors R2’s must_change_password interstitial.

Default is MfaPolicy::Optional. R1 page copy contains zero MFA mention; the doctrine-9 floor in DESIGN_RECOVERY (email is convenience, not root of trust) sets the baseline. Operators who want MFA enforcement opt in explicitly.

Typical project wiring:

use rustio_admin::auth::{MfaPolicy, Role};

// Enforce for everyone:
let admin = Admin::new().require_mfa(MfaPolicy::Required);

// Enforce for privileged roles only:
const PRIVILEGED: &[Role] = &[Role::Administrator, Role::Supervisor];
let admin = Admin::new().require_mfa(MfaPolicy::RequiredForRoles(PRIVILEGED));

// Reject MFA enrolment outright (e.g. for a public-kiosk admin):
let admin = Admin::new().require_mfa(MfaPolicy::Disabled);

Variants§

§

Disabled

MFA enrolment is rejected outright. Existing enrolments remain readable on the rustio_users row but the verify flow refuses to honour them. Used by deployments that have decided MFA is operationally inappropriate (kiosks, shared-credential workflows, etc.).

§

Optional

Default. Users may enrol; users without MFA can sign in with password alone. The pre-R3 framework behaviour.

§

Required

Every user must enrol. Forward-only — existing sessions remain valid; the login_guard redirects users without MFA to /admin/mfa/enroll at the next request.

§

RequiredForRoles(&'static [Role])

Required only for users whose Role appears in the slice. Forward-only with the same semantics as MfaPolicy::Required. Empty slice is equivalent to MfaPolicy::Optional — the policy reads “no role requires MFA” rather than “no users require MFA”.

Trait Implementations§

Source§

impl Clone for MfaPolicy

Source§

fn clone(&self) -> MfaPolicy

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 MfaPolicy

Source§

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

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

impl Default for MfaPolicy

Source§

fn default() -> Self

MfaPolicy::Optional is the framework default. R1 page copy contains zero MFA mention; operators opt into enforcement explicitly via [crate::admin::types::Admin::require_mfa].

Source§

impl Copy for MfaPolicy

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.
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