canic-core 0.85.3

Canic — a canister orchestration and management toolkit for the Internet Computer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

//! Module: access
//!
//! Responsibility: compose endpoint access predicates and normalize access denial errors.
//! Does not own: endpoint response mapping, workflow authorization, or runtime metrics storage.
//! Boundary: endpoint macros call access predicates before delegating to workflow.

pub mod app;
pub mod auth;
pub mod env;
#[doc(hidden)]
pub mod expr;
pub mod metrics;

use thiserror::Error as ThisError;

///
/// AccessError
///
/// Framework-agnostic access-layer error returned by endpoint access predicates.
/// Endpoint boundaries convert this into the public unauthorized error shape.
///

#[derive(Debug, ThisError)]
pub enum AccessError {
    #[error("access denied: delegated auth cert expired")]
    DelegatedAuthCertExpired,

    #[error("access denied: delegated auth token expired")]
    DelegatedAuthTokenExpired,

    #[error("access denied: {0}")]
    Denied(String),
}

impl AccessError {
    #[must_use]
    pub const fn kind(&self) -> AccessErrorKind {
        match self {
            Self::DelegatedAuthCertExpired => AccessErrorKind::DelegatedAuthCertExpired,
            Self::DelegatedAuthTokenExpired => AccessErrorKind::DelegatedAuthTokenExpired,
            Self::Denied(_) => AccessErrorKind::Denied,
        }
    }
}

///
/// AccessErrorKind
///
/// Machine-readable access denial category for endpoint error adapters.
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum AccessErrorKind {
    DelegatedAuthCertExpired,
    DelegatedAuthTokenExpired,
    Denied,
}