Enum TokenError

pub enum TokenError {
    BiscuitError(String),
    VerificationError(String),
    InvalidKeyFormat(String),
    AuthorizationError(String),
    Generic(String),
}

Error type for hessra-token operations

Variants

BiscuitError(String)

Error occurred during Biscuit token operations

VerificationError(String)

Error occurred during token verification

InvalidKeyFormat(String)

Invalid key format provided

AuthorizationError(String)

Token authorization failed

Generic(String)

Generic error with message

Implementations

impl TokenError

pub fn biscuit_error<E: StdError>(err: E) -> Self

Create a new Biscuit-related error

Examples found in repository

examples/token_verification.rs (line 105)

fn generate_example_token(keypair: Arc<KeyPair>) -> Result<String, TokenError> {
    // Create a simple test biscuit with authorization rules
    let biscuit_builder = biscuit!(
        r#"
            // Grant rights to alice for resource1
            right("alice", "resource1", "read");
            right("alice", "resource1", "write");
        "#
    );

    // Build and serialize the token
    let biscuit = biscuit_builder
        .build(&keypair)
        .map_err(|e| TokenError::biscuit_error(e))?;

    let token_bytes = biscuit.to_vec().map_err(|e| TokenError::biscuit_error(e))?;

    // Encode to base64 for transmission
    Ok(encode_token(&token_bytes))
}

/// Generate a token with service chain attestations
fn generate_service_chain_token(
    root_keypair: Arc<KeyPair>,
    service1_public_key: String,
    service2_public_key: String,
) -> Result<String, TokenError> {
    // Create a biscuit with service chain authorization
    let biscuit_builder = biscuit!(
        r#"
            // Basic rights
            right("alice", "resource1", "read");
            right("alice", "resource1", "write");
            
            // Service nodes
            node($s, "node1") <- service($s) trusting authority, {node1_public_key};
            node($s, "node2") <- service($s) trusting authority, {node2_public_key};
        "#,
        node1_public_key = biscuit_key_from_string(service1_public_key)?,
        node2_public_key = biscuit_key_from_string(service2_public_key)?,
    );

    // Build and serialize the token
    let biscuit = biscuit_builder
        .build(&root_keypair)
        .map_err(|e| TokenError::biscuit_error(e))?;

    let token_bytes = biscuit.to_vec().map_err(|e| TokenError::biscuit_error(e))?;

    // Encode to base64
    Ok(encode_token(&token_bytes))
}

examples/token_attenuation.rs (line 75)

fn generate_example_token() -> Result<(String, KeyPair), TokenError> {
    // Create a test keypair
    let keypair = KeyPair::new();

    // Create a simple test biscuit with authorization rules
    let biscuit_builder = biscuit!(
        r#"
            // Grant rights to alice for resource1
            right("alice", "resource1", "read");
            right("alice", "resource1", "write");
        "#
    );

    // Build and serialize the token
    let biscuit = biscuit_builder
        .build(&keypair)
        .map_err(|e| TokenError::biscuit_error(e))?;

    let token_bytes = biscuit.to_vec().map_err(|e| TokenError::biscuit_error(e))?;

    // Encode to base64 for transmission
    Ok((encode_token(&token_bytes), keypair))
}

pub fn verification_error<S: Into<String>>(msg: S) -> Self

Create a new verification error

pub fn invalid_key_format<S: Into<String>>(msg: S) -> Self

Create a new invalid key format error

pub fn authorization_error<S: Into<String>>(msg: S) -> Self

Create a new authorization error

pub fn generic<S: Into<String>>(msg: S) -> Self

Create a new generic error

Trait Implementations

impl Debug for TokenError

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

Formats the value using the given formatter.

impl Display for TokenError

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

Formats the value using the given formatter.

impl Error for TokenError

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<&str> for TokenError

fn from(err: &str) -> Self

Converts to this type from the input type.

impl From<FromHexError> for TokenError

fn from(err: FromHexError) -> Self

Converts to this type from the input type.

impl From<String> for TokenError

fn from(err: String) -> Self

Converts to this type from the input type.

impl From<Token> for TokenError

fn from(err: Token) -> Self

Converts to this type from the input type.