canic-core 0.61.1

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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use crate::storage::prelude::*;

///
/// DelegatedSessionRecord
///

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct DelegatedSessionRecord {
    pub wallet_pid: Principal,
    pub delegated_pid: Principal,
    pub issued_at: u64,
    pub expires_at: u64,
    pub bootstrap_token_fingerprint: Option<[u8; 32]>,
}

///
/// DelegatedSessionBootstrapBindingRecord
///

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct DelegatedSessionBootstrapBindingRecord {
    pub wallet_pid: Principal,
    pub delegated_pid: Principal,
    pub token_fingerprint: [u8; 32],
    pub bound_at: u64,
    pub expires_at: u64,
}

///
/// AttestationKeyStatusRecord
///

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum AttestationKeyStatusRecord {
    Current,
    Previous,
}

///
/// AttestationPublicKeyRecord
///

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct AttestationPublicKeyRecord {
    pub key_id: u32,
    pub public_key_sec1: Vec<u8>,
    pub key_name: String,
    pub key_hash: [u8; 32],
    pub status: AttestationKeyStatusRecord,
    pub valid_from: Option<u64>,
    pub valid_until: Option<u64>,
}

///
/// AuthStateRecord
///

#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct AuthStateRecord {
    pub delegated_sessions: Vec<DelegatedSessionRecord>,

    pub delegated_session_bootstrap_bindings: Vec<DelegatedSessionBootstrapBindingRecord>,

    pub attestation_public_keys: Vec<AttestationPublicKeyRecord>,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cdk::{serialize::deserialize, serialize::serialize};
    use serde::ser::SerializeMap;

    #[test]
    fn auth_state_decode_drops_legacy_delegated_token_use_markers() {
        let legacy = LegacyAuthStateRecord {
            delegated_sessions: vec![DelegatedSessionRecord {
                wallet_pid: p(1),
                delegated_pid: p(2),
                issued_at: 10,
                expires_at: 20,
                bootstrap_token_fingerprint: None,
            }],
            delegated_session_bootstrap_bindings: Vec::new(),
            legacy_uses: vec![LegacyUseRecord {
                issuer_shard_pid: p(3),
                subject: p(4),
                cert_hash: [5; 32],
                nonce: [6; 16],
                used_at: 11,
                expires_at: 20,
            }],
            attestation_public_keys: Vec::new(),
        };
        let bytes = serialize(&legacy).expect("legacy auth state serializes");

        let decoded: AuthStateRecord =
            deserialize(&bytes).expect("new auth state ignores removed field");

        assert_eq!(decoded.delegated_sessions, legacy.delegated_sessions);
        assert!(decoded.delegated_session_bootstrap_bindings.is_empty());
        assert!(decoded.attestation_public_keys.is_empty());
    }

    ///
    /// LegacyUseRecord
    ///
    #[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
    struct LegacyUseRecord {
        issuer_shard_pid: Principal,
        subject: Principal,
        cert_hash: [u8; 32],
        nonce: [u8; 16],
        used_at: u64,
        expires_at: u64,
    }

    ///
    /// LegacyAuthStateRecord
    ///
    #[derive(Clone, Debug)]
    struct LegacyAuthStateRecord {
        delegated_sessions: Vec<DelegatedSessionRecord>,
        delegated_session_bootstrap_bindings: Vec<DelegatedSessionBootstrapBindingRecord>,
        legacy_uses: Vec<LegacyUseRecord>,
        attestation_public_keys: Vec<AttestationPublicKeyRecord>,
    }

    impl Serialize for LegacyAuthStateRecord {
        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where
            S: serde::Serializer,
        {
            let mut map = serializer.serialize_map(Some(4))?;
            map.serialize_entry("delegated_sessions", &self.delegated_sessions)?;
            map.serialize_entry(
                "delegated_session_bootstrap_bindings",
                &self.delegated_session_bootstrap_bindings,
            )?;
            let legacy_key = ["delegated", "_token", "_uses"].concat();
            map.serialize_entry(&legacy_key, &self.legacy_uses)?;
            map.serialize_entry("attestation_public_keys", &self.attestation_public_keys)?;
            map.end()
        }
    }

    fn p(id: u8) -> Principal {
        Principal::from_slice(&[id; 29])
    }
}