ostree/rust-bindings/rust/src/checksum.rs

use glib::translate::{from_glib_full, FromGlibPtrFull};
use glib::GString;
use glib_sys::{g_free, g_malloc, g_malloc0, gpointer};
use libc::c_char;
use std::fmt;
use std::ptr::copy_nonoverlapping;

const BYTES_LEN: usize = ostree_sys::OSTREE_SHA256_DIGEST_LEN as usize;
const HEX_LEN: usize = ostree_sys::OSTREE_SHA256_STRING_LEN as usize;
const B64_LEN: usize = 43;

/// A binary SHA256 checksum.
#[derive(Debug)]
pub struct Checksum {
    bytes: *mut [u8; BYTES_LEN],
}

impl Checksum {
    /// Create a `Checksum` value, taking ownership of the given memory location.
    ///
    /// # Safety
    /// `bytes` must point to a fully initialized 32-byte memory location that is freeable with
    /// `g_free` (this is e.g. the case if the memory was allocated with `g_malloc`). The value
    /// takes ownership of the memory, i.e. the memory is freed when the value is dropped. The
    /// memory must not be freed by other code.
    unsafe fn new(bytes: *mut [u8; BYTES_LEN]) -> Checksum {
        assert!(!bytes.is_null());
        Checksum { bytes }
    }

    /// Create a `Checksum` from a hexadecimal SHA256 string.
    ///
    /// Unfortunately, the underlying libostree function has no way to report parsing errors. If the
    /// string is not a valid SHA256 string, the program will abort!
    pub fn from_hex(checksum: &str) -> Checksum {
        // TODO: implement by hand to avoid stupid assertions?
        assert_eq!(checksum.len(), HEX_LEN);
        unsafe {
            // We know checksum is at least as long as needed, trailing NUL is unnecessary.
            from_glib_full(ostree_sys::ostree_checksum_to_bytes(
                checksum.as_ptr() as *const c_char
            ))
        }
    }

    /// Create a `Checksum` from a base64-encoded String.
    ///
    /// Invalid base64 characters will not be reported, but will cause unknown output instead, most
    /// likely 0.
    pub fn from_base64(b64_checksum: &str) -> Checksum {
        // TODO: implement by hand for better error reporting?
        assert_eq!(b64_checksum.len(), B64_LEN);
        unsafe {
            let buf = g_malloc0(BYTES_LEN) as *mut [u8; BYTES_LEN];
            // We know b64_checksum is at least as long as needed, trailing NUL is unnecessary.
            ostree_sys::ostree_checksum_b64_inplace_to_bytes(
                b64_checksum.as_ptr() as *const [c_char; 32],
                buf as *mut u8,
            );
            from_glib_full(buf)
        }
    }

    /// Convert checksum to hex-encoded string.
    pub fn to_hex(&self) -> GString {
        // This one returns a NUL-terminated string.
        unsafe { from_glib_full(ostree_sys::ostree_checksum_from_bytes(self.bytes)) }
    }

    /// Convert checksum to base64.
    pub fn to_base64(&self) -> String {
        let mut buf: Vec<u8> = Vec::with_capacity(B64_LEN + 1);
        unsafe {
            ostree_sys::ostree_checksum_b64_inplace_from_bytes(
                self.bytes,
                buf.as_mut_ptr() as *mut c_char,
            );
            // Assumption: 43 valid bytes are in the buffer.
            buf.set_len(B64_LEN);
            // Assumption: all characters are ASCII, ergo valid UTF-8.
            String::from_utf8_unchecked(buf)
        }
    }
}

impl Drop for Checksum {
    fn drop(&mut self) {
        unsafe {
            g_free(self.bytes as gpointer);
        }
    }
}

impl Clone for Checksum {
    fn clone(&self) -> Self {
        unsafe {
            let cloned = g_malloc(BYTES_LEN) as *mut [u8; BYTES_LEN];
            // copy one array of 32 elements
            copy_nonoverlapping::<[u8; BYTES_LEN]>(self.bytes, cloned, 1);
            Checksum::new(cloned)
        }
    }
}

impl PartialEq for Checksum {
    fn eq(&self, other: &Self) -> bool {
        unsafe {
            let ret = ostree_sys::ostree_cmp_checksum_bytes(
                self.bytes as *const u8,
                other.bytes as *const u8,
            );
            ret == 0
        }
    }
}

impl Eq for Checksum {}

impl fmt::Display for Checksum {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.to_hex())
    }
}

impl FromGlibPtrFull<*mut [u8; BYTES_LEN]> for Checksum {
    unsafe fn from_glib_full(ptr: *mut [u8; BYTES_LEN]) -> Self {
        Checksum::new(ptr)
    }
}

impl FromGlibPtrFull<*mut [*mut u8; BYTES_LEN]> for Checksum {
    unsafe fn from_glib_full(ptr: *mut [*mut u8; BYTES_LEN]) -> Self {
        Checksum::new(ptr as *mut u8 as *mut [u8; BYTES_LEN])
    }
}

impl FromGlibPtrFull<*mut u8> for Checksum {
    unsafe fn from_glib_full(ptr: *mut u8) -> Self {
        Checksum::new(ptr as *mut [u8; BYTES_LEN])
    }
}

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

    const CHECKSUM_STRING: &str =
        "bf875306783efdc5bcab37ea10b6ca4e9b6aea8b94580d0ca94af120565c0e8a";
    const CHECKSUM_BASE64: &str = "v4dTBng+_cW8qzfqELbKTptq6ouUWA0MqUrxIFZcDoo";

    #[test]
    fn should_create_checksum_from_bytes() {
        let bytes = unsafe { g_malloc0(BYTES_LEN) } as *mut u8;
        let checksum: Checksum = unsafe { from_glib_full(bytes) };
        assert_eq!(checksum.to_string(), "00".repeat(BYTES_LEN));
    }

    #[test]
    fn should_parse_checksum_string_to_bytes() {
        let csum = Checksum::from_hex(CHECKSUM_STRING);
        assert_eq!(csum.to_string(), CHECKSUM_STRING);
    }

    #[test]
    #[should_panic]
    fn should_panic_for_too_short_hex_string() {
        Checksum::from_hex(&"FF".repeat(31));
    }

    #[test]
    fn should_convert_checksum_to_base64() {
        let csum = Checksum::from_hex(CHECKSUM_STRING);
        assert_eq!(csum.to_base64(), CHECKSUM_BASE64);
    }

    #[test]
    fn should_convert_base64_string_to_checksum() {
        let csum = Checksum::from_base64(CHECKSUM_BASE64);
        assert_eq!(csum.to_base64(), CHECKSUM_BASE64);
        assert_eq!(csum.to_string(), CHECKSUM_STRING);
    }

    #[test]
    #[should_panic]
    fn should_panic_for_too_short_b64_string() {
        Checksum::from_base64("abcdefghi");
    }

    #[test]
    fn should_be_all_zeroes_for_invalid_base64_string() {
        let csum = Checksum::from_base64(&"\n".repeat(43));
        assert_eq!(csum.to_string(), "00".repeat(32));
    }

    #[test]
    fn should_compare_checksums() {
        let csum = Checksum::from_hex(CHECKSUM_STRING);
        assert_eq!(csum, csum);
        let csum2 = Checksum::from_hex(CHECKSUM_STRING);
        assert_eq!(csum2, csum);
    }

    #[test]
    fn should_clone_value() {
        let csum = Checksum::from_hex(CHECKSUM_STRING);
        let csum2 = csum.clone();
        assert_eq!(csum2, csum);
        let csum3 = csum2.clone();
        assert_eq!(csum3, csum);
        assert_eq!(csum3, csum2);
    }
}