Skip to main content

LocalAuthConfig

Struct LocalAuthConfig 

Source
pub struct LocalAuthConfig {
    pub password: bool,
    pub otp: bool,
    pub mfa: bool,
    pub anonymous: bool,
    pub email_verification: bool,
    pub mfa_issuer: Option<String>,
    pub email_from: Option<String>,
    pub reset_url_template: Option<String>,
    pub magic_link_template: Option<String>,
    pub verification_url_template: Option<String>,
}
Expand description

[auth.local] — the auth methods FraiseQL operates itself, rather than delegating to an IdP (#367).

Every enabled method mounts real HTTP routes and requires a database pool: credentials, MFA enrollments, OTP budgets and sessions are all durable state. A method enabled without what it needs refuses to boot rather than mounting a flow that cannot complete.

Fields§

§password: bool

Email + password sign-in: mounts /auth/v1/password/{signup,login} and the reset pair. Reset-link delivery additionally requires email_from.

§otp: bool

Email OTP / magic-link sign-in: mounts /auth/v1/otp and /auth/v1/verify. Requires email_from — a code nobody receives is not a login method.

§mfa: bool

TOTP MFA: mounts /auth/v1/mfa/{enroll,challenge,verify,unenroll}, backed by the Postgres enrollment store (enrollments must survive a restart, or a deploy locks every user out of their own account).

§anonymous: bool

Anonymous guest sessions: mounts POST /auth/v1/signup, which issues a session to any caller with no credentials at all. Off by default — this is a deliberate “anyone may hold a session” posture, not a convenience.

§email_verification: bool

Email verification for local-password accounts (#945): mounts POST /auth/v1/email/verify/{start,confirm}, both of which require an authenticated caller and act only on that caller’s own account.

Requires password — verification proves the address a local identity claims, and an account without one has nothing to verify — plus email_from and verification_url_template.

Confirming promotes the account’s own core.tb_user.email, which is what lets a later trusted social sign-in for the same address link into it. It never merges two accounts: an address already verified elsewhere is refused.

§mfa_issuer: Option<String>

Service name shown in authenticator apps for MFA enrollment (otpauth://…?issuer=). Defaults to "FraiseQL".

§email_from: Option<String>

The [mailbox.<name>] account whose SMTP half delivers OTP codes and password-reset links. Required whenever otp or password is enabled; naming a mailbox with no [mailbox.<name>.smtp] section refuses to boot.

§reset_url_template: Option<String>

Template for the password-reset link, with {token} substituted for the opaque reset token — e.g. https://app.example.com/reset?token={token}. Required when password is enabled: the link points at the operator’s front end, which FraiseQL cannot guess.

§magic_link_template: Option<String>

Template for the OTP magic link, with {code} substituted. Optional: when absent the email carries the bare six-digit code.

§verification_url_template: Option<String>

Template for the email-verification link, with {token} substituted for the opaque verification token — e.g. https://app.example.com/verify-email?token={token}. Required when email_verification is enabled: the link points at the operator’s front end, which FraiseQL cannot guess.

Trait Implementations§

Source§

impl Clone for LocalAuthConfig

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 LocalAuthConfig

Source§

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

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

impl Default for LocalAuthConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for LocalAuthConfig

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 Eq for LocalAuthConfig

Source§

impl PartialEq for LocalAuthConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for LocalAuthConfig

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

impl StructuralPartialEq for LocalAuthConfig

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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 = !

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