Skip to main content

AuthMechanism

Enum AuthMechanism 

Source
pub enum AuthMechanism {
    Bearer {
        header: HeaderName,
    },
    Cookie {
        cookie: CookieName,
        login: MethodPath,
        refresh: Option<MethodPath>,
        logout: Option<MethodPath>,
    },
    Oidc {
        issuer: IssuerUrl,
        client_id: ClientId,
        exchange: Option<MethodPath>,
        request_scopes: Vec<String>,
    },
    Anonymous,
}
Expand description

Tagged union of supported auth mechanisms a backend advertises.

Wire form: discriminated on kind, snake_case ("bearer", "cookie", "oidc", "anonymous"). See AUTHZ-S01-output §2 for canonical JSON examples.

Variants§

§

Bearer

Static bearer token (today’s substrate --api-key shape). Not user-bound; the token authorizes the bearer.

Fields

§header: HeaderName

Header carrying the token, e.g. Authorization.

§

Cookie

Cookie session, with a backend-defined login method that issues Set-Cookie.

Fields

§cookie: CookieName

Name of the session cookie.

§login: MethodPath

Method the client calls to issue/establish the cookie.

§refresh: Option<MethodPath>

Optional method to renew the cookie.

§logout: Option<MethodPath>

Optional method to invalidate the cookie.

§

Oidc

OIDC mechanism (designed-for; may not be implemented in initial epic).

Fields

§issuer: IssuerUrl

Issuer URL of the IdP.

§client_id: ClientId

client_id registered with the IdP for this backend.

§exchange: Option<MethodPath>

Optional auth.exchange-style method the backend exposes to swap an ID token for a backend session cookie.

§request_scopes: Vec<String>

Scopes the backend will request from the IdP. Bare-string scopes per the OIDC convention (e.g. "openid", "profile", "email"); AUTHZ scoping vocabulary is a separate concern (AUTHZ-CORE-4).

§

Anonymous

Anonymous — the backend accepts unauthenticated callers for some methods.

Advertising Anonymous is not permission to bypass scoping: per-method #[plexus::method(public)] markers gate which methods anonymous callers may invoke (AUTHZ-CORE-1 / AUTHZ-CORE-2). The advertisement says “anonymous is one of the accepted shapes”; the authorization layer says “this specific method is callable that way.”

Trait Implementations§

Source§

impl Clone for AuthMechanism

Source§

fn clone(&self) -> AuthMechanism

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 AuthMechanism

Source§

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

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

impl<'de> Deserialize<'de> for AuthMechanism

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 JsonSchema for AuthMechanism

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for AuthMechanism

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for AuthMechanism

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

Source§

impl StructuralPartialEq for AuthMechanism

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,