literate-crypto 0.0.3

Literate Cryptography by 12hbender
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

use docext::docext;

mod merkledamgard;
pub mod sha2;
pub mod sha3;

pub use {
    merkledamgard::{CompressionFn, DaviesMeyer, DaviesMeyerStep, MerkleDamgard, MerkleDamgardPad},
    sha2::{Sha1, Sha224, Sha256},
    sha3::{Sha3_224, Sha3_256, Sha3_384, Sha3_512},
};

/// A cryptographic hash function maps a _preimage_ of arbitrary length into a
/// fixed-size _hash digest_.
///
/// To be cryptographically secure, this function must be one-way and collision
/// resistant. One-way means that given a hash digest, there is no better way to
/// get the preimage than by brute force.
///
/// A _hash collision_ occurs when two preimages $M_1$ and $M_2$, $M_1
/// \neq M_2$, generate the same hash digest, $Hash(M_1) = Hash(M_2)$. The hash
/// function is _collision resistant_ if the best way to find such $(M_1, M_2)$
/// is by brute force.
#[docext]
pub trait Hash {
    type Digest;

    /// The block used internally by the hash function.
    ///
    /// All hash functions are implemented by internally operating on blocks in
    /// various ways. This fact is used by the [HMAC](crate::Hmac)
    /// construction.
    type Block;

    fn hash(&self, preimage: &[u8]) -> Self::Digest;
}