use crate::error::{PluginError, PluginResult};
use crate::options::OptionView;
pub trait HashPlugin: Sized {
fn create_with_opts(name: &str, opts: Option<OptionView<'_>>) -> PluginResult<Self>;
fn output_size(&self) -> u32;
fn block_size(&self) -> u32;
fn update(&mut self, data: &[u8]) -> PluginResult<()>;
fn reset(&mut self) -> PluginResult<()>;
fn try_clone(&self) -> PluginResult<Self>;
fn finalize(&mut self, out: &mut [u8]) -> PluginResult<()>;
}
pub fn create_simple<T: HashPlugin>(name: &str) -> PluginResult<T> {
T::create_with_opts(name, None)
}
pub fn default_block_size() -> u32 {
64
}
#[doc(hidden)]
pub fn err_with_message<E: std::fmt::Display>(code: crate::ErrorCode, e: E) -> PluginError {
PluginError::new(code, e.to_string())
}
#[cfg(test)]
mod tests {
use super::*;
struct XorHash {
acc: u8,
}
impl HashPlugin for XorHash {
fn create_with_opts(_name: &str, _opts: Option<OptionView<'_>>) -> PluginResult<Self> {
Ok(XorHash { acc: 0 })
}
fn output_size(&self) -> u32 {
1
}
fn block_size(&self) -> u32 {
default_block_size()
}
fn update(&mut self, data: &[u8]) -> PluginResult<()> {
for &b in data {
self.acc ^= b;
}
Ok(())
}
fn reset(&mut self) -> PluginResult<()> {
self.acc = 0;
Ok(())
}
fn try_clone(&self) -> PluginResult<Self> {
Ok(XorHash { acc: self.acc })
}
fn finalize(&mut self, out: &mut [u8]) -> PluginResult<()> {
if out.is_empty() {
return Err(crate::error::PluginError::new(
crate::ErrorCode::INSUFFICIENT_BUFFER,
"output buffer too small",
));
}
out[0] = self.acc;
Ok(())
}
}
#[test]
fn xor_hash_produces_xor_of_inputs() {
let mut h = XorHash::create_with_opts("xor", None).unwrap();
h.update(&[1, 2, 4]).unwrap();
let mut out = [0u8];
h.finalize(&mut out).unwrap();
assert_eq!(out[0], 1 ^ 2 ^ 4);
}
#[test]
fn xor_hash_clone_is_independent() {
let mut a = XorHash::create_with_opts("xor", None).unwrap();
a.update(&[0xFF]).unwrap();
let mut b = a.try_clone().unwrap();
a.update(&[0x01]).unwrap();
b.update(&[0x02]).unwrap();
let mut oa = [0u8];
let mut ob = [0u8];
a.finalize(&mut oa).unwrap();
b.finalize(&mut ob).unwrap();
assert_eq!(oa[0], 0xFF ^ 0x01);
assert_eq!(ob[0], 0xFF ^ 0x02);
}
#[test]
fn xor_hash_reset_clears_state() {
let mut h = XorHash::create_with_opts("xor", None).unwrap();
h.update(&[0xFF]).unwrap();
h.reset().unwrap();
let mut out = [0u8];
h.finalize(&mut out).unwrap();
assert_eq!(out[0], 0);
}
}