ic-platform 0.29.0

Controlled Candid and IC runtime dependency boundary
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

//! Upstream canister-signature key formats and hashing with owned issuer bytes.
//!
//! Encoding, decoding, hashing and domain separation delegate upstream. The
//! adapter preserves Platform Principal fields and checked DER framing. The
//! upstream signature store is not exported; consumers retain store lifecycle.

pub(crate) mod admission;

use crate::principal::Principal;

pub use ic_canister_sig_creation::{
    IC_ROOT_PK_DER, IC_ROOT_PK_DER_PREFIX, extract_raw_root_pk_from_der, hash_bytes,
    hash_with_domain,
};

/// An upstream canister-signature key with Platform's canonical issuer identity.
#[derive(Clone, Eq, PartialEq, Debug)]
pub struct CanisterSigPublicKey {
    /// Canister issuing this signature key.
    pub canister_id: Principal,
    /// Consumer-selected seed, preserved without normalization.
    pub seed: Vec<u8>,
}

impl CanisterSigPublicKey {
    /// Construct a key without changing the issuer or seed.
    pub fn new(canister_id: Principal, seed: Vec<u8>) -> Self {
        Self { canister_id, seed }
    }

    fn from_upstream(key: ic_canister_sig_creation::CanisterSigPublicKey) -> Self {
        Self {
            canister_id: Principal::from_slice(key.canister_id.as_slice()),
            seed: key.seed,
        }
    }

    fn upstream(&self) -> ic_canister_sig_creation::CanisterSigPublicKey {
        ic_canister_sig_creation::CanisterSigPublicKey::new(
            self.canister_id
                .as_slice()
                .try_into()
                .expect("owned Principal has at most 29 bytes"),
            self.seed.clone(),
        )
    }

    /// Decode the upstream raw key format.
    ///
    /// # Errors
    /// Returns the unchanged upstream parsing diagnostic.
    pub fn try_from_raw(bytes: &[u8]) -> Result<Self, String> {
        ic_canister_sig_creation::CanisterSigPublicKey::try_from_raw(bytes).map(Self::from_upstream)
    }

    /// Encode the key using the upstream DER implementation.
    pub fn to_der(&self) -> Vec<u8> {
        self.upstream().to_der()
    }

    /// Encode the key using the upstream raw implementation.
    pub fn to_raw(&self) -> Vec<u8> {
        self.upstream().to_raw()
    }
}

impl TryFrom<&[u8]> for CanisterSigPublicKey {
    type Error = String;

    fn try_from(bytes: &[u8]) -> Result<Self, Self::Error> {
        admission::canister_sig_der(bytes)?;
        ic_canister_sig_creation::CanisterSigPublicKey::try_from(bytes).map(Self::from_upstream)
    }
}