Skip to main content

Auth

Struct Auth 

Source
pub struct Auth {
Show 23 fields pub kind: AuthKind, pub issuer: Option<String>, pub token_url: Option<String>, pub device_authorization_url: Option<String>, pub authorization_url: Option<String>, pub client_id: Option<String>, pub client_secret: Option<Secret>, pub grant: Option<OAuthGrant>, pub scopes: Vec<String>, pub audience: Option<String>, pub token: Option<Secret>, pub header: Option<String>, pub value: Option<Secret>, pub region: Option<String>, pub service: Option<String>, pub source: Option<String>, pub sso_start_url: Option<String>, pub account_id: Option<String>, pub role_name: Option<String>, pub svid: Option<String>, pub jwt_svid_file: Option<String>, pub svid_file: Option<String>, pub key_file: Option<String>,
}
Expand description

A unified per-endpoint authentication provider. A flat, kind-discriminated record: only the fields relevant to the chosen kind are set, and semantic validation is what enforces which of them are required — the type itself cannot, because every field is optional for some other kind.

Fields§

§kind: AuthKind§issuer: Option<String>

Issuer base URL for .well-known metadata discovery (RFC 8414 / OIDC). When set, it fills in whichever of the token / device-authorization / authorization endpoints the document leaves unset.

§token_url: Option<String>§device_authorization_url: Option<String>§authorization_url: Option<String>§client_id: Option<String>§client_secret: Option<Secret>

A confidential client’s secret ({{secret:…}}); omit for a public client (the device grant needs no secret).

§grant: Option<OAuthGrant>

device (default, interactive), authorization_code, or client_credentials (headless M2M).

§scopes: Vec<String>§audience: Option<String>§token: Option<Secret>

A static bearer ({{secret:…}}) → Authorization: Bearer ….

§header: Option<String>

A static credential under an arbitrary header name (paired with value).

§value: Option<Secret>§region: Option<String>§service: Option<String>

The AWS service to sign for (e.g. bedrock, execute-api).

§source: Option<String>

The credential source: env / static, sso (IAM Identity Center interactive login → temporary credentials), imds (the EC2 instance role) or irsa (the Kubernetes projected service-account token). Unset behaves as env.

§sso_start_url: Option<String>

aws source: sso — the IAM Identity Center portal start URL, the account, and the permission-set role to assume (via agentd login).

§account_id: Option<String>§role_name: Option<String>§svid: Option<String>

The SVID type: jwt (a rotating JWT-SVID bearer read from a file) or x509 (an mTLS client identity rather than a request signer).

§jwt_svid_file: Option<String>

Path to the SPIRE-written JWT-SVID token file (re-read per request, so a rotation is picked up).

§svid_file: Option<String>

Paths to the X.509-SVID cert + key (for svid: x509).

§key_file: Option<String>

Implementations§

Source§

impl Auth

Source

pub fn to_spec(&self) -> AuthSpec

Lower to the secret-free runtime AuthSpec (spawn payload). Secrets stay as {{secret:…}} templates.

Trait Implementations§

Source§

impl Clone for Auth

Source§

fn clone(&self) -> Auth

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 Auth

Source§

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

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

impl<'de> Deserialize<'de> for Auth

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 PartialEq for Auth

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Auth

Auto Trait Implementations§

§

impl Freeze for Auth

§

impl RefUnwindSafe for Auth

§

impl Send for Auth

§

impl Sync for Auth

§

impl Unpin for Auth

§

impl UnsafeUnpin for Auth

§

impl UnwindSafe for Auth

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

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