Skip to main content

TokenError

Enum TokenError 

Source
pub enum TokenError {
    Missing,
    Malformed,
    Invalid,
    Expired,
    Unavailable(Error),
}
Expand description

Why a presented token was not accepted.

An unknown id and a wrong secret are the same variant on purpose. They are indistinguishable to the caller, and keeping them apart in the type is how somebody eventually writes a message — or a log line, or a metric — that tells an attacker which of their guesses was half right.

Variants§

§

Missing

No Authorization: Bearer header at all.

§

Malformed

Present, but not shaped like <id>|<secret>.

§

Invalid

No such token, or the wrong secret for it.

§

Expired

The right secret for a token that is past its expiry.

§

Unavailable(Error)

The store itself failed. Ours, not the caller’s.

Implementations§

Source§

impl TokenError

Source

pub fn message(&self) -> &'static str

What the client is told. Never mentions the token it presented.

Source

pub fn status(&self) -> Status

Source

pub fn challenge(&self) -> &'static str

The WWW-Authenticate challenge, per RFC 6750.

A bare Bearer when nothing was presented — the client may simply not know it needed to authenticate — and error="invalid_token" when something was, which tells a correct client to stop retrying with the credential it has and go get another one.

Trait Implementations§

Source§

impl Debug for TokenError

Source§

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

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

impl Display for TokenError

Source§

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

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

impl Error for TokenError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl IntoResponse for TokenError

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, 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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, !>

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.