capsec-core 0.2.2

Core capability types for compile-time capability-based security in Rust
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

//! Error types for the capsec capability system.

/// Errors that can occur when using capsec capabilities.
///
/// Most commonly seen when an [`Attenuated`](crate::attenuate::Attenuated) capability
/// rejects an operation that falls outside its scope.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum CapSecError {
    /// The target of a capability operation is outside the granted scope.
    ///
    /// For example, trying to read `/etc/passwd` with a `DirScope` restricted to `/tmp`.
    #[error("capability target '{target}' is outside scope: {scope}")]
    OutOfScope {
        /// The path or address that was rejected.
        target: String,
        /// Description of the allowed scope.
        scope: String,
    },

    /// An I/O error from the underlying `std` operation.
    #[error(transparent)]
    Io(#[from] std::io::Error),

    /// The capability was revoked via its associated `Revoker`.
    #[error("capability has been revoked")]
    Revoked,

    /// The capability has expired (TTL elapsed).
    #[error("capability has expired")]
    Expired,

    /// The capability requires multiple approvals, but not all have been granted.
    #[error("capability requires dual-key approval, but approvals are insufficient")]
    InsufficientApprovals,

    /// An environment variable lookup error.
    #[error(transparent)]
    Env(#[from] std::env::VarError),
}