Crate digest

Expand description

This crate provides traits which describe functionality of cryptographic hash functions and Message Authentication algorithms.

Traits in this repository are organized into the following levels:

High-level convenience traits: Digest, DynDigest, Mac. Wrappers around lower-level traits for most common use-cases. Users should usually prefer using these traits.
Mid-level traits: Update, FixedOutput, FixedOutputReset, ExtendableOutput, ExtendableOutputReset, XofReader, Reset, KeyInit, and InnerInit. These traits atomically describe available functionality of an algorithm.
Marker traits: HashMarker, MacMarker. Used to distinguish different algorithm classes.
Low-level traits defined in the block_api module. These traits operate at a block-level and do not contain any built-in buffering. They are intended to be implemented by low-level algorithm providers only. Usually they should not be used in application-level code.

Additionally hash functions implement traits from the standard library: Default and Clone.

This crate does not provide any implementations of the io::Read/Write traits, see the digest-io crate for std::io-compatibility wrappers.

Re-exports§

block_apiblock-api: Low-level traits operating on blocks and wrappers around them.
consts
devdev: Development-related functionality

bench_update: Define Update impl benchmark
buffer_ct_variable: Creates a buffered wrapper around block-level “core” type which implements variable output size traits with output size selected at compile time.
buffer_fixed: Creates a buffered wrapper around block-level “core” type which implements fixed output size traits.
buffer_xof: Creates a buffered wrapper around block-level “core” type which implements extendable output size traits.
hash_rt_outsize_serialization_test: Define hash function serialization test
hash_serialization_test: Define hash function serialization test
new_mac_test: Define MAC test
new_test: Define hash function test

CtOutputmac: Fixed size output value which provides a safe Eq implementation that runs in constant time.
InvalidBufferSize: Buffer length is not equal to hash output size.
InvalidLengthmac: The error type returned when key and/or IV used in the KeyInit, KeyIvInit, and InnerIvInit slice-based methods had an invalid length.
InvalidOutputSize: The error type used in variable hash traits.
MacErrormac: Error type for when the Output of a Mac is not equal to the expected value.
XofFixedWrapper: Wrapper around ExtendableOutput types adding OutputSizeUser with the given size of S.

CollisionResistance: Types with a certain collision resistance.
CustomizedInit: Trait for hash functions with customization string for domain separation.
Digest: Convenience wrapper trait covering functionality of cryptographic hash functions with fixed output size.
DynDigest: Modification of the Digest trait suitable for trait objects.
DynDigestWithOidconst-oid: Convenience wrapper trait around DynDigest and DynAssociatedOid.
ExtendableOutput: Trait for hash functions with extendable-output (XOF).
ExtendableOutputReset: Trait for hash functions with extendable-output (XOF) able to reset themselves.
FixedOutput: Trait for hash functions with fixed-size output.
FixedOutputReset: Trait for hash functions with fixed-size output able to reset themselves.
HashMarker: Marker trait for cryptographic hash functions.
InnerInitmac: Types which can be initialized from another type (usually block ciphers).
KeyInitmac: Types which can be initialized from key.
Macmac: Convenience wrapper trait covering functionality of Message Authentication algorithms.
MacMarkermac: Marker trait for Message Authentication algorithms.
OutputSizeUser: Types which return data with the given size.
Reset: Resettable types.
Update: Types which consume data with byte granularity.
XofReader: Trait for reader types which are used to extract extendable output from a XOF (extendable-output function) result.