canic-core 0.99.29

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

//! 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::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::Caller(CallerPredicate::IsRegisteredToSubnet) => {
            "caller_is_registered_to_subnet"
        }
        BuiltinPredicate::Caller(CallerPredicate::IsWhitelisted) => "caller_is_whitelisted",
        BuiltinPredicate::Environment(EnvironmentPredicate::SelfIsDefaultSubnet) => {
            "self_is_default_subnet"
        }
        BuiltinPredicate::Environment(EnvironmentPredicate::SelfIsFleetRoot) => {
            "self_is_fleet_root"
        }
        BuiltinPredicate::Environment(EnvironmentPredicate::BuildIcOnly) => "build_ic_only",
        BuiltinPredicate::Environment(EnvironmentPredicate::BuildLocalOnly) => "build_local_only",
        BuiltinPredicate::Authenticated { .. } => "authenticated",
    }
}

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

pub(super) async fn evaluate(
    pred: &BuiltinPredicate,
    ctx: &AccessContext,
) -> 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::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::Caller(CallerPredicate::IsRegisteredToSubnet) => {
            access::auth::is_registered_to_subnet(ctx.caller).await
        }
        BuiltinPredicate::Caller(CallerPredicate::IsWhitelisted) => {
            access::auth::is_whitelisted(ctx.caller).await
        }
        BuiltinPredicate::Environment(EnvironmentPredicate::SelfIsDefaultSubnet) => {
            access::env::is_default_subnet()
        }
        BuiltinPredicate::Environment(EnvironmentPredicate::SelfIsFleetRoot) => {
            access::env::is_fleet_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.authenticated_caller, *required_scope)?;
            DelegatedAuthMetrics::record_authority(issuer_pid);
            Ok(())
        }
    }
}