crypto_api 0.2.2

Defines a general purpose API for various cryptographic primitives
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
48
49
50
51

use std::error::Error;
use std::ops::Range;


/// Information about a hash implementation
#[derive(Debug, Eq, PartialEq, Clone)]
pub struct HashInfo {
	/// The name
	pub name: &'static str,
	
	/// The default/selected hash length
	pub hash_len: usize,
	/// the supported hash lengths
	pub hash_len_r: Range<usize>
}


/// A stateless (oneshot) hash interface
pub trait Hash {
	/// Returns information about the hash
	fn info(&self) -> HashInfo;
	
	/// Hashes `data` into `buf` and returns the hash length
	fn hash(&self, buf: &mut[u8], data: &[u8]) -> Result<usize, Box<dyn Error + 'static>>;
}

/// A variable length extension for `Hash`
pub trait VarlenHash: Hash {
	/// Hashes `data` into `buf` and returns the hash length
	fn varlen_hash(&self, buf: &mut[u8], data: &[u8]) -> Result<usize, Box<dyn Error + 'static>>;
}


/// A stateful (streaming) hash interface
pub trait StreamingHash {
	/// Returns information about the hash
	fn info(&self) -> HashInfo;
	
	/// (Re-)initializes the hash state
	fn init(&mut self) -> Result<(), Box<dyn Error + 'static>>;
	/// Adds the data in `input` to the hash state
	fn update(&mut self, input: &[u8]) -> Result<(), Box<dyn Error + 'static>>;
	/// Computes the hash into `buf` and returns the hash length
	fn finish(&mut self, buf: &mut[u8]) -> Result<usize, Box<dyn Error + 'static>>;
}

/// A variable length extension for `StreamingHash`
pub trait StreamingVarlenHash: StreamingHash {
	/// (Re-)initializes the hash state to produce an `hash_len`-sized hash
	fn varlen_init(&mut self, hash_len: usize) -> Result<(), Box<dyn Error + 'static>>;
}