rite-runtime 0.3.0

Execution engine for Rite ceremonies (internal to the `rite` CLI; no stable API)
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

//! Fingerprint helpers used across the runtime.

use std::io;
use std::path::Path;

use sha2::{Digest, Sha256};

/// Lower-hex SHA-256 of a byte slice, the raw primitive without any prefix.
#[must_use]
pub fn sha256_hex(data: &[u8]) -> String {
    let mut hasher = Sha256::new();
    hasher.update(data);
    base16ct::lower::encode_string(&hasher.finalize())
}

/// SHA-256 fingerprint of an in-memory byte slice.
///
/// Returns `"sha256:{lowercase_hex}"`, the convention used throughout
/// the runtime for artifact and transcript fingerprints.
#[must_use]
pub fn compute_fingerprint(data: &[u8]) -> String {
    format!("sha256:{}", sha256_hex(data))
}

/// SHA-256 fingerprint of a file's contents.
///
/// # Errors
///
/// Returns the underlying I/O error if the file cannot be read.
pub fn compute_file_fingerprint(path: &Path) -> io::Result<String> {
    let data = std::fs::read(path)?;
    Ok(compute_fingerprint(&data))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn fingerprint_of_known_bytes() {
        let fp = compute_fingerprint(b"hello world");
        assert_eq!(
            fp,
            "sha256:b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"
        );
    }
}