ic_backup/model/artifacts/
mod.rs

1//! Canonical SHA-256 artifact metadata; filesystem effects belong to ops.
2
3use ic_host_artifacts::artifact::Sha256Digest;
4use serde::{Deserialize, Serialize, Serializer, ser::SerializeStruct};
5use thiserror::Error;
6
7/// Maintained checksum record with a lowercase, validated SHA-256 digest.
8#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
9#[serde(try_from = "ChecksumFields")]
10pub struct ArtifactChecksumRecord {
11    hash: String,
12}
13
14#[derive(Deserialize)]
15#[serde(deny_unknown_fields)]
16struct ChecksumFields {
17    algorithm: String,
18    hash: String,
19}
20
21impl TryFrom<ChecksumFields> for ArtifactChecksumRecord {
22    type Error = ChecksumError;
23
24    fn try_from(value: ChecksumFields) -> Result<Self, Self::Error> {
25        if value.algorithm != "sha256" {
26            return Err(ChecksumError::UnsupportedAlgorithm(value.algorithm));
27        }
28        Self::from_hash(&value.hash)
29    }
30}
31
32impl Serialize for ArtifactChecksumRecord {
33    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
34        let mut record = serializer.serialize_struct("ArtifactChecksumRecord", 2)?;
35        record.serialize_field("algorithm", self.algorithm())?;
36        record.serialize_field("hash", self.hash())?;
37        record.end()
38    }
39}
40
41impl ArtifactChecksumRecord {
42    /// Compute checksum metadata from exact bytes.
43    #[must_use]
44    pub fn from_bytes(bytes: &[u8]) -> Self {
45        Self {
46            hash: Sha256Digest::compute(bytes).to_string(),
47        }
48    }
49
50    /// Validate and normalize an existing digest.
51    ///
52    /// # Errors
53    /// Returns [`ChecksumError::InvalidHash`] unless the input has 64 hex digits.
54    pub fn from_hash(hash: &str) -> Result<Self, ChecksumError> {
55        Ok(Self {
56            hash: canonical_hash(hash)?,
57        })
58    }
59
60    pub(crate) fn from_digest(digest: [u8; 32]) -> Self {
61        Self {
62            hash: Sha256Digest::from_bytes(digest).to_string(),
63        }
64    }
65
66    /// Return the maintained algorithm identifier.
67    #[must_use]
68    #[expect(
69        clippy::unnecessary_literal_bound,
70        reason = "preserve the public accessor signature while removing stored constant data"
71    )]
72    pub fn algorithm(&self) -> &str {
73        "sha256"
74    }
75
76    /// Return the canonical lowercase hexadecimal digest.
77    #[must_use]
78    pub fn hash(&self) -> &str {
79        &self.hash
80    }
81
82    /// Compare a digest, accepting equivalent uppercase and lowercase hex.
83    ///
84    /// # Errors
85    /// Returns a typed malformed-hash or checksum-mismatch error.
86    pub fn verify(&self, expected_hash: &str) -> Result<(), ChecksumError> {
87        let expected = canonical_hash(expected_hash)?;
88        if self.hash == expected {
89            Ok(())
90        } else {
91            Err(ChecksumError::ChecksumMismatch {
92                expected,
93                actual: self.hash.clone(),
94            })
95        }
96    }
97}
98
99pub(crate) fn canonical_hash(hash: &str) -> Result<String, ChecksumError> {
100    let normalized = hash.to_ascii_lowercase();
101    normalized
102        .parse::<Sha256Digest>()
103        .map_err(|_| ChecksumError::InvalidHash(hash.to_owned()))?;
104    Ok(normalized)
105}
106
107/// Typed checksum-record validation failure.
108#[derive(Debug, Error)]
109pub enum ChecksumError {
110    /// The expected and observed exact bytes have different digests.
111    #[error("checksum mismatch: expected {expected}, actual {actual}")]
112    ChecksumMismatch {
113        /// Canonical expected digest.
114        expected: String,
115        /// Canonical observed digest.
116        actual: String,
117    },
118    /// A digest is not exactly 64 hexadecimal digits.
119    #[error("invalid SHA-256 checksum: {0}")]
120    InvalidHash(String),
121    /// Only the maintained SHA-256 algorithm is accepted.
122    #[error("unsupported checksum algorithm {0}")]
123    UnsupportedAlgorithm(String),
124}
125
126#[cfg(test)]
127mod tests;
ic_backup/model/artifacts/mod.rs

ic_backup/model/artifacts/
mod.rs
