Skip to main content

BearerAuth

Struct BearerAuth 

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

Bearer-token authentication (Authorization: Bearer <token>).

§Drop-path zeroization

The cached header string is wrapped in zeroize::Zeroizing so its buffer is overwritten with zeros before being returned to the allocator on drop. This defends against credential recovery from process core dumps, /proc/PID/mem inspection, and post-drop heap re-use across tenants in long-running multi-user JMAP clients (bd:JMAP-6r7c.59). Callers that hold the original token string SHOULD also store it in a Zeroizing<String> or equivalent — the zeroization here is bounded by what this type owns.

§Do not move validation from construction to per-request (bd:JMAP-6r7c.18)

A future contributor may suggest “just store the token field and call HeaderValue::from_str in auth_header on each request”. This is the wrong simplification for both BearerAuth and BasicAuth. Five reasons:

  1. Fail-fast at auth setup. Validation at construction means invalid credentials surface at BearerAuth::new() return value — the caller fails near the bug source (their auth-setup code). Per-request validation pushes failures to the first JmapClient::call() or fetch_session(), far from the bug and harder to debug.
  2. Hot-path performance. auth_header is called on every HTTP request and every WebSocket connection. HeaderValue::from_str walks the string and rejects on the first non-VCHAR/SP/HTAB octet (RFC 7230 §3.2.6) — non-trivial work for a hot path. Pre-validation moves that work out of every request.
  3. Infallible accessor signature. Pre-validation lets auth_header keep the signature fn auth_header(&self) -> Option<AuthHeader<'_>> — infallible. Per-request validation would require Result<Option<(&str, &str)>, ClientError>, propagating an extra error layer through every call site (HTTP call, blob upload/download, WebSocket connect, session fetch).
  4. Borrow simplicity. Storing as Zeroizing<String> lets auth_header return borrows directly without ownership tricks (Cow, Box<str>, etc.). The borrow checker stays simple, the call sites stay readable.
  5. Debug-redaction tripwire compatibility. The manual Debug impls on BearerAuth and BasicAuth (auth.rs further below) target the stored field. A future contributor adding #[derive(Debug)] instead of the manual impl is caught immediately by the existing canary tests bearer_auth_debug_does_not_leak_token and basic_auth_debug_does_not_leak_credentials (bd:JMAP-sc1b.79). Moving to per-request validation requires the field shape to change in a way that re-derives the canary contract — extra surface area for review without buying anything.

This is the same pre-validate-at-construction pattern rustls and reqwest use for their own type designs. It is not over-engineering.

Implementations§

Source§

impl BearerAuth

Source

pub fn new(token: &str) -> Result<Self, ClientError>

Construct a BearerAuth from a Bearer token string.

§Errors

Trait Implementations§

Source§

impl AuthProvider for BearerAuth

Source§

fn auth_header(&self) -> Option<AuthHeader<'_>>

Return an optional AuthHeader to attach to every request. Read more
Source§

impl Clone for BearerAuth

Source§

fn clone(&self) -> BearerAuth

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 BearerAuth

Source§

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

Formats the value using the given formatter. Read more

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