Skip to main content

AccessKeyStrategy

Struct AccessKeyStrategy 

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

An AuthStrategy that uses a static access key to authenticate against a specific workspace.

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.

The first call to get_token authenticates with the server. Subsequent calls return the cached token until it expires, at which point re-authentication happens automatically. Every returned token is checked against the CRN; post-auth verification can fail in two ways:

Either outcome is preferred over silently letting the caller operate on a different workspace than they specified.

When constructed via AccessKeyStrategyBuilder::with_token_store, the strategy also persists tokens through an external TokenStore so that short-lived strategy instances (e.g. one per Edge Function request) can share a cache and avoid re-authenticating every cold start.

§Example

use stack_auth::{AccessKey, AccessKeyStrategy};
use cts_common::Crn;

let crn: Crn = "crn:ap-southeast-2.aws:ZVATKW3VHMFG27DY".parse().unwrap();
let key: AccessKey = "CSAKmyKeyId.myKeySecret".parse().unwrap();
let strategy = AccessKeyStrategy::new(crn, key).unwrap();

Implementations§

Source§

impl AccessKeyStrategy

Source

pub fn new(workspace_crn: Crn, access_key: AccessKey) -> Result<Self, AuthError>

Create a new AccessKeyStrategy for the given workspace CRN and access key. The auth endpoint is resolved automatically via service discovery using the region encoded in the CRN.

The CS_CTS_HOST environment variable, if set and non-empty, overrides service discovery — useful for pointing the strategy at a staging CTS or a local mock without changing the CRN.

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, access_key: AccessKey, ) -> AccessKeyStrategyBuilder

Return a builder for configuring an AccessKeyStrategy before construction.

§Example
use stack_auth::{AccessKey, AccessKeyStrategy};
use cts_common::Crn;

let crn: Crn = "crn:ap-southeast-2.aws:ZVATKW3VHMFG27DY".parse().unwrap();
let key: AccessKey = "CSAKmyKeyId.myKeySecret".parse().unwrap();
let strategy = AccessKeyStrategy::builder(crn, key)
    .audience("my-audience")
    .build()
    .unwrap();

Trait Implementations§

Source§

impl<S: TokenStore> AuthStrategy for &AccessKeyStrategy<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<S = NoStore> !Freeze for AccessKeyStrategy<S>

§

impl<S = NoStore> !RefUnwindSafe for AccessKeyStrategy<S>

§

impl<S = NoStore> !UnwindSafe for AccessKeyStrategy<S>

§

impl<S> Send for AccessKeyStrategy<S>
where S: Send,

§

impl<S> Sync for AccessKeyStrategy<S>
where S: Sync,

§

impl<S> Unpin for AccessKeyStrategy<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for AccessKeyStrategy<S>
where S: 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