Skip to main content

OidcFederationStrategy

Struct OidcFederationStrategy 

Source
pub struct OidcFederationStrategy<P, S = NoStore> { /* private fields */ }
Expand description

An AuthStrategy that federates a third-party OIDC JWT (Clerk, Supabase, Auth0, …) into a CipherStash CTS service token via POST /api/authorise.

Each call to get_token returns a cached CTS token until it expires. Because /api/authorise issues no CTS refresh token, renewal means re-federating: the strategy calls the OidcProvider again for a current third-party JWT and exchanges it for a fresh CTS token. Supply an OidcProvider that returns the live provider token each time (e.g. wrapping clerk.session.getToken()).

The strategy is bound to a workspace CRN at construction. The region is derived from the CRN — there is no separate region argument — so a caller can’t accidentally point the strategy at one region while the CRN says another, matching AccessKeyStrategy.

Every returned token is checked against the CRN’s workspace — the same post-auth verification AccessKeyStrategy performs — so a token CTS minted for a different workspace (or one loaded from a poisoned shared cache) is never handed back. Verification can fail in two ways:

When constructed via OidcFederationStrategyBuilder::with_token_store, the strategy also persists tokens through an external TokenStore so short-lived instances (e.g. one per Edge Function request) can share a cache and skip re-federating on every cold start. The workspace check runs on cached and store-loaded tokens too, not just freshly federated ones.

§Example

use stack_auth::{AuthError, OidcProviderFn, OidcFederationStrategy, SecretToken};
use cts_common::Crn;

let crn: Crn = "crn:ap-southeast-2.aws:ZVATKW3VHMFG27DY".parse().unwrap();
let provider = OidcProviderFn::new(|| async {
    // Real consumers call into a provider SDK / FFI to fetch a live JWT.
    Ok::<_, AuthError>(SecretToken::new("header.payload.signature".to_string()))
});
let strategy = OidcFederationStrategy::new(crn, provider).unwrap();

Implementations§

Source§

impl<P: OidcProvider> OidcFederationStrategy<P>

Source

pub fn new(workspace_crn: Crn, oidc_provider: P) -> Result<Self, AuthError>

Create a new OidcFederationStrategy for the given workspace CRN and OIDC provider.

The auth endpoint is resolved automatically via service discovery using the region encoded in the CRN; the workspace ID is used to verify every federated token belongs to the right workspace.

A CRN with a service_name component (e.g. crn:ap-southeast-2.aws:ZVATKW3VHMFG27DY:zerokms) is accepted; the service_name is ignored. Only the region and workspace ID are load-bearing for this strategy.

Source

pub fn builder( workspace_crn: Crn, oidc_provider: P, ) -> OidcFederationStrategyBuilder<P>

Return a builder for configuring an OidcFederationStrategy before construction.

Trait Implementations§

Source§

impl<P: OidcProvider, S: TokenStore> AuthStrategy for &OidcFederationStrategy<P, S>

Source§

async fn get_token(self) -> Result<ServiceToken, AuthError>

Retrieve a valid access token, refreshing or re-authenticating as needed.

Auto Trait Implementations§

§

impl<P, S = NoStore> !Freeze for OidcFederationStrategy<P, S>

§

impl<P, S = NoStore> !RefUnwindSafe for OidcFederationStrategy<P, S>

§

impl<P, S = NoStore> !UnwindSafe for OidcFederationStrategy<P, S>

§

impl<P, S> Send for OidcFederationStrategy<P, S>
where S: Send, P: Send,

§

impl<P, S> Sync for OidcFederationStrategy<P, S>
where S: Sync, P: Sync,

§

impl<P, S> Unpin for OidcFederationStrategy<P, S>
where S: Unpin, P: Unpin,

§

impl<P, S> UnsafeUnpin for OidcFederationStrategy<P, S>
where S: UnsafeUnpin, P: UnsafeUnpin,

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> AuthStrategyBounds for T
where T: Send + Sync + 'static,

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

Source§

fn fake<U>(&self) -> U
where Self: FakeBase<U>,

Source§

fn fake_with_rng<U, R>(&self, rng: &mut R) -> U
where R: Rng + ?Sized, Self: FakeBase<U>,

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