canic-core 0.110.41

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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

//! Module: access::expr::evaluators
//!
//! Responsibility: map builtin access predicates to names, metrics, and checks.
//! Does not own: expression tree construction, custom predicates, or metrics storage.
//! Boundary: `access::expr` calls this while interpreting builtin predicate leaves.

use super::{
    AccessContext, BuiltinPredicate, CallerPredicate, EnvironmentPredicate, FleetPredicate,
};
use crate::{
    access::{self, AccessError, metrics::DelegatedAuthMetrics},
    ids::AccessMetricKind,
};

pub(super) const fn name(pred: &BuiltinPredicate) -> &'static str {
    match pred {
        BuiltinPredicate::Fleet(FleetPredicate::AllowsUpdates) => "fleet_allows_updates",
        BuiltinPredicate::Fleet(FleetPredicate::IsQueryable) => "fleet_is_queryable",
        BuiltinPredicate::Caller(CallerPredicate::IsController) => "caller_is_controller",
        BuiltinPredicate::Caller(CallerPredicate::IsFleetAdmitted) => "caller_is_fleet_admitted",
        BuiltinPredicate::Caller(CallerPredicate::IsParent) => "caller_is_parent",
        BuiltinPredicate::Caller(CallerPredicate::IsChild) => "caller_is_child",
        BuiltinPredicate::Caller(CallerPredicate::IsRoot) => "caller_is_root",
        BuiltinPredicate::Caller(CallerPredicate::IsSameCanister) => "caller_is_same_canister",
        BuiltinPredicate::Environment(EnvironmentPredicate::SelfIsFleetSubnetRoot) => {
            "self_is_fleet_subnet_root"
        }
        BuiltinPredicate::Environment(EnvironmentPredicate::BuildIcOnly) => "build_ic_only",
        BuiltinPredicate::Environment(EnvironmentPredicate::BuildLocalOnly) => "build_local_only",
        BuiltinPredicate::Authenticated { .. } => "authenticated",
        BuiltinPredicate::AttestedLocalSubnet => "attested_local_subnet",
        BuiltinPredicate::ServiceAuthority { .. } => "deployment_service_authority",
    }
}

pub(super) const fn metric_kind(pred: &BuiltinPredicate) -> AccessMetricKind {
    match pred {
        BuiltinPredicate::Fleet(_) => AccessMetricKind::Guard,
        BuiltinPredicate::Caller(_)
        | BuiltinPredicate::Authenticated { .. }
        | BuiltinPredicate::AttestedLocalSubnet
        | BuiltinPredicate::ServiceAuthority { .. } => AccessMetricKind::Auth,
        BuiltinPredicate::Environment(EnvironmentPredicate::SelfIsFleetSubnetRoot) => {
            AccessMetricKind::Env
        }
        BuiltinPredicate::Environment(
            EnvironmentPredicate::BuildIcOnly | EnvironmentPredicate::BuildLocalOnly,
        ) => AccessMetricKind::Rule,
    }
}

/// A builtin denial or a predicate absent from the generated evaluator selection.
pub(super) enum BuiltinFailure {
    Denied(AccessError),
    Unselected,
}

pub(super) async fn evaluate<const FLEET_ADMISSION: bool>(
    pred: &BuiltinPredicate,
    ctx: &AccessContext,
) -> Result<(), BuiltinFailure> {
    let result: Result<(), AccessError> = match pred {
        BuiltinPredicate::Fleet(FleetPredicate::AllowsUpdates) => {
            access::fleet::guard_fleet_update()
        }
        BuiltinPredicate::Fleet(FleetPredicate::IsQueryable) => access::fleet::guard_fleet_query(),
        BuiltinPredicate::Caller(CallerPredicate::IsController) => {
            access::auth::is_controller(ctx.caller).await
        }
        BuiltinPredicate::Caller(CallerPredicate::IsFleetAdmitted) => {
            if !FLEET_ADMISSION {
                return Err(BuiltinFailure::Unselected);
            }
            access::auth::is_fleet_admitted(ctx.caller)
        }
        BuiltinPredicate::Caller(CallerPredicate::IsParent) => {
            access::auth::is_parent(ctx.caller).await
        }
        BuiltinPredicate::Caller(CallerPredicate::IsChild) => {
            access::auth::is_child(ctx.caller).await
        }
        BuiltinPredicate::Caller(CallerPredicate::IsRoot) => {
            access::auth::is_root(ctx.caller).await
        }
        BuiltinPredicate::Caller(CallerPredicate::IsSameCanister) => {
            access::auth::is_same_canister(ctx.caller).await
        }
        BuiltinPredicate::Environment(EnvironmentPredicate::SelfIsFleetSubnetRoot) => {
            access::env::is_fleet_subnet_root()
        }
        BuiltinPredicate::Environment(EnvironmentPredicate::BuildIcOnly) => {
            access::env::build_network_ic()
        }
        BuiltinPredicate::Environment(EnvironmentPredicate::BuildLocalOnly) => {
            access::env::build_network_local()
        }
        BuiltinPredicate::Authenticated { required_scope } => {
            let issuer_pid = access::auth::delegated_token_verified(ctx.caller, *required_scope)
                .map_err(BuiltinFailure::Denied)?;
            DelegatedAuthMetrics::record_authority(issuer_pid);
            Ok(())
        }
        BuiltinPredicate::AttestedLocalSubnet => {
            access::auth::is_attested_local_subnet(ctx.caller).await
        }
        BuiltinPredicate::ServiceAuthority { service } => {
            access::deployment::require_service_authority(service)
        }
    };
    result.map_err(BuiltinFailure::Denied)
}