Enum AuthError 

pub enum AuthError {
    BadRequest(&'static str),
    InternalError(String),
    ValidationFailure(Error),
    VerificationFailure,
    NotPermitted,
}

Error type for different authorization failure scenarios.

Variants

BadRequest(&'static str)

Indicates that something about the request prevented authorization verification from happening properly.

InternalError(String)

Indicates that something about Objectstore prevented authorization verification from happening properly.

ValidationFailure(Error)

Indicates that the provided authorization token is invalid (e.g. expired or malformed).

VerificationFailure

Indicates that an otherwise-valid token was unable to be verified with configured keys.

NotPermitted

Indicates that the requested operation is not authorized and auth enforcement is enabled.

Implementations

impl AuthError

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

Return a shortname for the failure reason that can be used to tag metrics.

pub fn log( &self, permission: Option<Permission>, usecase: Option<&str>, enforce: bool, )

Increment a counter and emit a debug log for this auth failure.

If enforce is false, authentication failures will be logged as warnings to ensure they are found and fixed to unblock enabling enforcement.

Trait Implementations

impl Debug for AuthError

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

Formats the value using the given formatter.

impl Display for AuthError

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

Formats the value using the given formatter.

impl Error for AuthError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

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.

impl From<AuthError> for ApiError

fn from(source: AuthError) -> Self

Converts to this type from the input type.

impl From<Error> for AuthError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl PartialEq for AuthError

fn eq(&self, other: &AuthError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AuthError