Enum AuthError 

#[non_exhaustive]
pub enum AuthError {
    KeyNotFound {
        key_name: String,
    },
    InvalidKeyFormat {
        reason: String,
    },
    KeyParsingFailed {
        reason: String,
    },
    NoAuthConfiguration,
    InvalidAuthConfiguration {
        reason: String,
    },
    EmptyDelegationPath,
    DelegationDepthExceeded {
        depth: usize,
    },
    InvalidDelegationStep {
        reason: String,
    },
    DelegatedTreeLoadFailed {
        tree_id: ID,
        source: Box<Error>,
    },
    InvalidDelegationTips {
        tree_id: ID,
        claimed_tips: Vec<ID>,
    },
    DelegationNotFound {
        tree_id: ID,
    },
    DelegationPathTooLong {
        len: usize,
        max: usize,
    },
    DelegationTipsTooMany {
        tree_id: ID,
        len: usize,
        max: usize,
    },
    DelegatedTreeUnsynced {
        tree_id: ID,
        missing: Vec<ID>,
    },
    CannotRevokeNonKey {
        key_name: String,
    },
    MalformedEntry {
        reason: &'static str,
    },
    InvalidSignature,
    SignatureVerificationFailed {
        reason: String,
    },
    DatabaseRequired {
        operation: String,
    },
    InvalidPermissionString {
        value: String,
    },
    PermissionRequiresPriority {
        permission_type: String,
    },
    InvalidPriorityValue {
        value: String,
    },
    InvalidKeyStatus {
        value: String,
    },
    PermissionDenied {
        reason: String,
    },
    KeyAlreadyExists {
        key_name: String,
    },
    KeyNameConflict {
        key_name: String,
        existing_pubkey: String,
        new_pubkey: String,
    },
    SigningKeyMismatch {
        reason: String,
    },
}

Errors that can occur during authentication operations.

Stability

• New variants may be added in minor versions (enum is #[non_exhaustive])
• Existing variants will not be removed in minor versions
• Field additions/changes require a major version bump
• Helper methods like is_*() provide stable APIs

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

KeyNotFound

A requested authentication key was not found in the configuration.

Fields

key_name: String

The name of the key that was not found

InvalidKeyFormat

Invalid key format or parsing error.

Fields

reason: String

Description of why the key format is invalid

KeyParsingFailed

Key parsing failed due to cryptographic library error.

Fields

reason: String

Description of the parsing failure

NoAuthConfiguration

No authentication configuration was found.

InvalidAuthConfiguration

The authentication configuration is invalid.

Fields

reason: String

Description of why the configuration is invalid

EmptyDelegationPath

Delegation path is empty when it should contain at least one step.

DelegationDepthExceeded

Maximum delegation depth was exceeded to prevent infinite loops.

Fields

depth: usize

The maximum depth that was exceeded

InvalidDelegationStep

A delegation step is invalid.

Fields

reason: String

Description of why the delegation step is invalid

DelegatedTreeLoadFailed

Failed to load a delegated tree.

Fields

tree_id: ID

The ID of the tree that failed to load

source: Box<Error>

The underlying error

InvalidDelegationTips

Delegation tips don’t match the actual tree state.

Fields

tree_id: ID

The ID of the tree with invalid tips

claimed_tips: Vec<ID>

The tips that were claimed but are invalid

DelegationNotFound

A delegated tree reference was not found in the configuration.

Fields

tree_id: ID

The root tree ID of the delegation that was not found

DelegationPathTooLong

Delegation path exceeds the maximum allowed number of steps.

The delegation path is wire-supplied on the entry’s signature key, and each step drives backend work before the authorization gate decides. Bounding the path length caps that amplification (a flat path of N steps is the chain-depth analog of N levels of recursion).

Fields

len: usize

Number of steps supplied

max: usize

Maximum allowed

DelegationTipsTooMany

A delegation step claims more tips than allowed.

Claimed tips are wire-supplied and each drives DAG traversal; the per-step count is bounded to cap that amplification.

Fields

tree_id: ID

The delegated tree root ID

len: usize

Number of tips claimed

max: usize

Maximum allowed

DelegatedTreeUnsynced

A delegated tree referenced by a delegation is not synced locally enough to decide the monotonicity floor.

This is a transient condition, not a validation failure: the entries in missing have not arrived yet. The caller should keep the entry unverified and re-check after syncing missing from the delegated tree’s peers, rather than rejecting it as a forgery. Deliberately excluded from AuthError::is_delegation_error — it signals sync state, not a delegation defect.

Fields

tree_id: ID

The delegated tree root ID

missing: Vec<ID>

Entries that must be synced before validation can proceed.

CannotRevokeNonKey

Attempted to revoke an entry that is not a key.

Fields

key_name: String

The name of the entry that is not a key

MalformedEntry

Entry has malformed signature info (e.g., hint without signature).

Fields

reason: &'static str

Description of why the entry is malformed

InvalidSignature

Signature verification failed.

SignatureVerificationFailed

Signature verification failed with specific error.

Fields

reason: String

Description of the verification failure

DatabaseRequired

Database is required for the operation but not available.

Fields

operation: String

The operation that requires a database

InvalidPermissionString

Invalid permission string format.

Fields

value: String

The invalid permission string

PermissionRequiresPriority

Permission type requires a priority value.

Fields

permission_type: String

The permission type that requires priority

InvalidPriorityValue

Invalid priority value.

Fields

value: String

The invalid priority value

InvalidKeyStatus

Invalid key status string.

Fields

value: String

The invalid status value

PermissionDenied

Permission denied for an operation.

Fields

reason: String

Description of why permission was denied

KeyAlreadyExists

Attempted to add a key that already exists.

Fields

key_name: String

The name of the key that already exists

KeyNameConflict

Key name conflicts with existing key that has different public key.

Fields

key_name: String

The name of the conflicting key

existing_pubkey: String

The public key of the existing key

new_pubkey: String

The public key of the new key

SigningKeyMismatch

Signing key does not match the claimed identity in a DatabaseKey.

Fields

reason: String

Description of the mismatch

Implementations

impl AuthError

pub fn is_not_found(&self) -> bool

Check if this error indicates a key or delegation was not found.

pub fn is_invalid_signature(&self) -> bool

Check if this error indicates invalid signature.

pub fn is_permission_denied(&self) -> bool

Check if this error indicates permission was denied.

pub fn is_key_already_exists(&self) -> bool

Check if this error indicates a key already exists.

pub fn is_key_name_conflict(&self) -> bool

Check if this error indicates a key name conflict.

pub fn is_configuration_error(&self) -> bool

Check if this error indicates a configuration problem.

pub fn is_delegation_error(&self) -> bool

Check if this error is related to delegation.

pub fn is_delegated_tree_unsynced(&self) -> bool

Check if this error indicates a delegated tree is not yet synced enough to validate — a transient, retriable condition, not a delegation defect (see AuthError::DelegatedTreeUnsynced).

pub fn key_name(&self) -> Option<&str>

Get the key name if this error is about a missing key.

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 Error

fn from(err: AuthError) -> Self

Converts to this type from the input type.