canic-host 0.42.8

//! Passive deployment-truth model types for host-side planning and safety checks.

use canic_core::bootstrap::parse_config_model;
use serde::Serialize;
use sha2::{Digest, Sha256};
use std::{
    fmt::Write as _,
    fs,
    io::Read,
    path::{Path, PathBuf},
};

mod authority;
mod model;
mod observe;
mod plan;
mod receipt;
mod report;
#[cfg(test)]
mod tests;
mod text;

pub use authority::{
    authority_report_from_plan, authority_report_from_plan_with_check_id,
    build_authority_reconciliation_plan,
};
pub use model::{
    ArtifactDigestSourceV1, ArtifactSourceV1, AuthorityActionCountV1, AuthorityActionV1,
    AuthorityApplyBlockerV1, AuthorityApplyReadinessV1, AuthorityAttemptedActionV1,
    AuthorityAutomaticActionV1, AuthorityControlClassCountV1, AuthorityControllerDeltaV1,
    AuthorityControllerObservationV1, AuthorityDryRunEvidenceV1, AuthorityExternalActionV1,
    AuthorityProfileV1, AuthorityReceiptV1, AuthorityReconciliationPlanV1,
    AuthorityReconciliationStateV1, AuthorityReportCountsV1, AuthorityReportV1,
    CanisterAuthorityActionV1, CanisterControlClassV1, DeploymentAssumptionV1, DeploymentCheckV1,
    DeploymentCommandResultV1, DeploymentDiffV1, DeploymentExecutionStatusV1, DeploymentIdentityV1,
    DeploymentInventoryV1, DeploymentObservationGapV1, DeploymentPlanV1, DeploymentReceiptV1,
    DiffItemV1, ExpectedCanisterV1, ExpectedPoolCanisterV1, LocalDeploymentConfigV1,
    ObservationStatusV1, ObservedArtifactV1, ObservedCanisterV1, ObservedPoolCanisterV1,
    PhaseReceiptV1, ResumeSafetyV1, RoleArtifactManifestV1, RoleArtifactV1, RoleEpochExpectationV1,
    RoleEpochObservationV1, RolePhaseReceiptV1, RolePhaseResultV1, SafetyFindingV1, SafetyReportV1,
    SafetySeverityV1, SafetyStatusV1, TrustDomainV1, VerifiedPostconditionV1,
    VerifierReadinessExpectationV1, VerifierReadinessObservationV1,
};
pub use observe::{
    DeploymentTruthError, LocalArtifactManifestRequest, LocalInventoryRequest,
    collect_local_deployment_inventory, collect_local_role_artifact_manifest,
};
pub use plan::{LocalDeploymentPlanRequest, build_local_deployment_plan};
pub use receipt::{
    AuthorityEvidenceError, artifact_gate_phase_receipt, artifact_gate_role_phase_receipts,
    authority_dry_run_receipt_from_plan, deployment_receipt_from_check,
    deployment_receipt_from_check_with_status, phase_receipt, validate_authority_dry_run_evidence,
};
pub use report::{
    LocalDeploymentCheckRequest, check_local_deployment, compare_plan_inventory_and_receipt,
    compare_plan_to_inventory, safety_report_from_diff,
};
pub use text::{
    authority_evidence_text, authority_plan_text, authority_receipt_text, authority_report_text,
};

pub const DEPLOYMENT_TRUTH_SCHEMA_VERSION: u32 = 1;
const ROOT_ROLE: &str = "root";
const IMPLICIT_WASM_STORE_ROLE: &str = "wasm_store";

fn deployment_truth_roles_with_implicit_wasm_store(mut roles: Vec<String>) -> Vec<String> {
    if !roles.iter().any(|role| role == IMPLICIT_WASM_STORE_ROLE) {
        roles.push(IMPLICIT_WASM_STORE_ROLE.to_string());
    }
    roles.sort_by(|left, right| {
        deployment_truth_role_rank(left)
            .cmp(&deployment_truth_role_rank(right))
            .then_with(|| left.cmp(right))
    });
    roles.dedup();
    roles
}

fn deployment_truth_role_rank(role: &str) -> u8 {
    match role {
        ROOT_ROLE => 0,
        IMPLICIT_WASM_STORE_ROLE => 1,
        _ => 2,
    }
}

fn deployment_truth_artifact_source(role: &str) -> ArtifactSourceV1 {
    match role {
        IMPLICIT_WASM_STORE_ROLE => ArtifactSourceV1::WasmStore,
        _ => ArtifactSourceV1::LocalBuild,
    }
}

fn deployment_config_path(workspace_root: &Path, config_path: Option<&Path>) -> PathBuf {
    config_path.map_or_else(
        || crate::release_set::config_path(workspace_root),
        |path| {
            if path.is_absolute() {
                path.to_path_buf()
            } else {
                workspace_root.join(path)
            }
        },
    )
}

fn file_sha256_hex(path: &Path) -> std::io::Result<String> {
    let mut file = fs::File::open(path)?;
    let mut hasher = Sha256::new();
    let mut buffer = [0_u8; 16 * 1024];
    loop {
        let read = file.read(&mut buffer)?;
        if read == 0 {
            break;
        }
        hasher.update(&buffer[..read]);
    }
    let digest = hasher.finalize();
    let mut hex = String::with_capacity(digest.len() * 2);
    for byte in digest {
        write!(&mut hex, "{byte:02x}").expect("writing to a String cannot fail");
    }
    Ok(hex)
}

fn canonical_runtime_config_sha256_hex(path: &Path) -> Result<String, Box<dyn std::error::Error>> {
    let source = fs::read_to_string(path)?;
    let config = parse_config_model(&source).map_err(|err| err.to_string())?;
    Ok(bytes_sha256_hex(&serde_json::to_vec(&config)?))
}

fn bytes_sha256_hex(bytes: &[u8]) -> String {
    let digest = Sha256::digest(bytes);
    let mut hex = String::with_capacity(digest.len() * 2);
    for byte in digest {
        write!(&mut hex, "{byte:02x}").expect("writing to a String cannot fail");
    }
    hex
}

fn stable_json_sha256_hex<T: Serialize>(value: &T) -> String {
    bytes_sha256_hex(
        &serde_json::to_vec(value)
            .expect("deployment truth identity inputs must JSON-encode deterministically"),
    )
}