Skip to main content

WebAuthnConfig

Struct WebAuthnConfig 

Source
pub struct WebAuthnConfig {
    pub rp_id: String,
    pub rp_name: String,
    pub attestation: String,
    pub timeout_ms: u64,
    pub rp_origins: Vec<String>,
    pub user_verification: String,
}
Expand description

WebAuthn Relying Party configuration.

Collects the RP identity, default timeouts, and attestation preference in a single struct so that individual handlers don’t need to scatter std::env::var calls.

§Example

use auth_framework::api::webauthn::WebAuthnConfig;

// Minimal — defaults to "localhost" / "AuthFramework" / "none"
let cfg = WebAuthnConfig::default();
assert_eq!(cfg.rp_id, "localhost");

// Typical production use
let cfg = WebAuthnConfig::new("auth.example.com", "My Service")
    .attestation("none")
    .timeout(120_000);
assert_eq!(cfg.rp_id, "auth.example.com");
assert_eq!(cfg.attestation, "none");

Fields§

§rp_id: String

Relying Party identifier (usually the domain name).

§rp_name: String

Human-readable Relying Party name.

§attestation: String

Attestation conveyance preference. This server does not verify attestation statements, so only "none" is accepted by the registration endpoints; any other value makes them refuse rather than request an attestation that would then be ignored.

§timeout_ms: u64

Timeout for ceremonies in milliseconds (default: 60 000).

§rp_origins: Vec<String>

Origins (scheme://host[:port]) the relying party is served from. The client-data origin of a ceremony must equal one of these exactly. Empty (the default) means https://{rp_id} (plus http://localhost when the rp id is localhost).

§user_verification: String

User-verification requirement of ceremonies: "required", "preferred" or "discouraged". Set by the server, never by the request. With "required" an assertion whose authenticator data does not carry the UV flag is refused.

Implementations§

Source§

impl WebAuthnConfig

Source

pub fn new(rp_id: impl Into<String>, rp_name: impl Into<String>) -> Self

Create a config with the given RP id and name.

Source

pub fn from_env() -> Self

Build a config from environment variables.

VariableDefault
WEBAUTHN_RP_ID"localhost"
WEBAUTHN_RP_NAME"AuthFramework"
WEBAUTHN_ATTESTATION"none"
WEBAUTHN_TIMEOUT_MS60000
WEBAUTHN_ORIGINS(empty: https://{rp_id}); comma-separated origins
WEBAUTHN_USER_VERIFICATION"preferred"
Source

pub fn origins(self, origins: Vec<String>) -> Self

Set the origins the relying party is served from (see Self::rp_origins).

Source

pub fn user_verification(self, requirement: impl Into<String>) -> Self

Set the user-verification requirement (required / preferred / discouraged).

Source

pub fn attestation(self, attestation: impl Into<String>) -> Self

Set the attestation conveyance preference.

Source

pub fn timeout(self, ms: u64) -> Self

Set the ceremony timeout in milliseconds.

Trait Implementations§

Source§

impl Clone for WebAuthnConfig

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 WebAuthnConfig

Source§

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

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

impl Default for WebAuthnConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for WebAuthnConfig

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 WebAuthnConfig

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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