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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
use std::error::Error as StdError;
#[cfg(feature = "rustcrypto")]
mod rustcrypto;
#[cfg(feature = "rustcrypto")]
use rustcrypto::{Digest, Md5, Sha1, Sha256, Sha512};
#[cfg(not(feature = "rustcrypto"))]
mod selfcontained;
#[cfg(not(feature = "rustcrypto"))]
use selfcontained::{Md5, Sha1, Sha256, Sha512};
trait Hasher {
fn hash_type(&self) -> String;
fn update(&mut self, data: &[u8]);
fn sum(self: Box<Self>) -> String;
}
impl core::fmt::Debug for dyn Hasher {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "Hasher {{ hash_type: {} }}", self.hash_type())
}
}
macro_rules! impl_hasher_for {
($hasher:ty) => {
impl Hasher for $hasher {
fn hash_type(&self) -> String {
stringify!($hasher).to_string()
}
fn update(&mut self, data: &[u8]) {
#[cfg(not(feature = "rustcrypto"))]
self.consume(data);
#[cfg(feature = "rustcrypto")]
self.inner.update(data);
}
fn sum(self: Box<Self>) -> String {
#[cfg(not(feature = "rustcrypto"))]
let ret = self.result_string();
#[cfg(feature = "rustcrypto")]
let ret = format!("{:x}", self.inner.finalize());
ret
}
}
};
}
impl_hasher_for!(Md5);
impl_hasher_for!(Sha1);
impl_hasher_for!(Sha256);
impl_hasher_for!(Sha512);
#[derive(Debug)]
pub struct Error;
impl StdError for Error {}
impl core::fmt::Display for Error {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "unsupported hash algorithm")
}
}
/// ChecksumBuilder is used to create a Checksum instance.
pub struct ChecksumBuilder {
hasher: Box<dyn Hasher>,
}
impl Default for ChecksumBuilder {
fn default() -> Self {
Self::new()
}
}
impl ChecksumBuilder {
/// Creates a new ChecksumBuilder instance.
///
/// # Examples
///
/// ```rust
/// use scoop_hash::ChecksumBuilder;
/// let mut md5 = ChecksumBuilder::new().md5().build();
/// md5.consume(b"hello world");
/// assert!(md5.check("5eb63bbbe01eeed093cb22bb8f5acdc3"));
/// ```
pub fn new() -> ChecksumBuilder {
// Default to sha256
ChecksumBuilder {
hasher: Box::new(Sha256::new()),
}
}
/// Use the specified hash algorithm.
///
/// # Errors
///
/// Returns an error if the specified algorithm is not supported.
pub fn algo(self, algo: &str) -> Result<ChecksumBuilder, Error> {
match algo {
"md5" => Ok(self.md5()),
"sha1" => Ok(self.sha1()),
"sha256" => Ok(self.sha256()),
"sha512" => Ok(self.sha512()),
_ => Err(Error),
}
}
/// Use the md5 hash algorithm.
pub fn md5(self) -> ChecksumBuilder {
let algo: Box<dyn Hasher> = Box::new(Md5::new());
self.set_algo(algo)
}
/// Use the sha1 hash algorithm.
pub fn sha1(self) -> ChecksumBuilder {
let algo: Box<dyn Hasher> = Box::new(Sha1::new());
self.set_algo(algo)
}
/// Use the sha256 hash algorithm.
pub fn sha256(self) -> ChecksumBuilder {
let algo: Box<dyn Hasher> = Box::new(Sha256::new());
self.set_algo(algo)
}
/// Use the sha512 hash algorithm.
pub fn sha512(self) -> ChecksumBuilder {
let algo: Box<dyn Hasher> = Box::new(Sha512::new());
self.set_algo(algo)
}
fn set_algo(mut self, algo: Box<dyn Hasher>) -> ChecksumBuilder {
self.hasher = algo;
self
}
/// Build the Checksum instance for use.
///
/// If no hash algorithm is specified, sha256 will be used.
pub fn build(self) -> Checksum {
Checksum {
hasher: self.hasher,
}
}
}
/// Checksum is a wrapper around a hash algorithm.
#[derive(Debug)]
pub struct Checksum {
/// The hash algorithm.
hasher: Box<dyn Hasher>,
}
impl Checksum {
/// Consumes the provided data.
///
/// # Examples
///
/// ```rust
/// use scoop_hash::ChecksumBuilder;
/// let mut sha256 = ChecksumBuilder::new().build();
/// sha256.consume(b"hello world");
/// let result = sha256.finalize();
/// assert_eq!(result, "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9");
/// ```
#[inline]
pub fn consume(&mut self, data: &[u8]) {
self.hasher.update(data);
}
/// Gets the result of the hash computation as a hex string.
///
/// Note that the Checksum instance is consumed after getting the result.
#[inline]
pub fn finalize(self) -> String {
self.hasher.sum()
}
/// Checks if the result of the hash computation matches the input hash.
///
/// Note that the Checksum instance is consumed after calling this method,
/// if you want to keep the checksum result, use the finalize method instead.
#[inline]
pub fn check(self, input: &str) -> bool {
input == self.finalize()
}
}