Skip to main content

AuthProvider

Struct AuthProvider 

Source
pub struct AuthProvider { /* private fields */ }
Expand description

Provides API key retrieval and HTTP request authentication for the CLI.

API key resolution order:

  1. Environment variable APCORE_AUTH_API_KEY
  2. Config resolver auth.api_key field (may be keyring: or enc: prefixed)
  3. Return None if neither is present.

Audit D1-006 parity (v0.6.x): the optional encryptor injection slot mirrors the TypeScript AuthProvider(config, encryptor?) constructor. When omitted, a fresh ConfigEncryptor is constructed lazily on first keyring/enc lookup.

Implementations§

Source§

impl AuthProvider

Source

pub fn new(config: ConfigResolver) -> Self

Create a new AuthProvider with the given configuration resolver. The encryptor is constructed lazily on first keyring/enc lookup.

Source

pub fn with_encryptor( config: ConfigResolver, encryptor: ConfigEncryptor, ) -> Self

Create a new AuthProvider with an explicit ConfigEncryptor. Useful for tests that want to inject a new_forced_aes() instance.

Source

pub fn get_api_key(&self) -> Result<Option<String>, AuthenticationError>

Retrieve the API key using the resolution order above.

Returns Ok(None) when no key is configured, Ok(Some(key)) on success, or Err(DecryptionFailed) when a stored encrypted key cannot be decoded — distinguishes “not configured” from “stored key is corrupt”, which matters for user diagnostics.

Source

pub fn authenticate_request( &self, headers: HashMap<String, String>, ) -> Result<HashMap<String, String>, AuthenticationError>

Add the Authorization header to the given headers map and return it.

Spec (SEC-02) cross-SDK contract: “On success: the input headers dict with Authorization added”. Takes ownership of the map, augments it, and returns it — matching Python’s mutate-and-return semantics. Callers who need to keep the original map should clone before passing.

§Errors
  • AuthenticationError::MissingApiKey — no key is configured.
  • AuthenticationError::DecryptionFailed — stored key cannot be decrypted.
  • AuthenticationError::MalformedApiKey — key contains CR/LF that HTTP rejects.
Source

pub fn apply_to_reqwest( &self, builder: RequestBuilder, ) -> Result<RequestBuilder, AuthenticationError>

Inject the Authorization header into a reqwest::RequestBuilder.

Convenience adapter over authenticate_request for reqwest-based callers.

Source

pub fn check_status_code(&self, status: u16) -> Result<(), AuthenticationError>

Check an HTTP status code for authentication errors.

Returns Ok(()) for non-auth-error codes, Err(InvalidApiKey) for 401/403. This is the testable core of handle_response.

Source

pub fn handle_response( &self, response: Response, ) -> Result<Response, AuthenticationError>

Inspect an HTTP response for 401/403 codes and raise the appropriate error.

Returns the response unchanged if authentication succeeded.

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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<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