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

// License: see LICENSE file at root directory of `master` branch

//! # Keccak implementation
//!
//! ## Project
//!
//! - Repository: <https://bitbucket.org/haibison/zeros>
//! - License: Nice License 1.0.0 _(see LICENSE file at root directory of `master` branch)_
//! - _This project follows [Semantic Versioning 2.0.0]_
//!
//! ## Features
//!
//! This project provides _some_ hash functions from [Keccak].
//!
//! ## References
//!
//! - Specifications: <https://keccak.team/keccak_specs_summary.html>
//! - Test data: <https://csrc.nist.gov/projects/cryptographic-standards-and-guidelines/example-values>
//!
//! ## Notes
//!
//! - Currently only little-endian systems are supported. We don't have access or knowledge to test on big-endian systems.
//! - Internal state stores data on [`u64`]. So it works best on systems supporting `u64` natively.
//! - In addition to NIST's test data, the libray has passed millions of sample hashes generated by [OpenSSL].
//! - Documentation is built with all features. Some of them are optional. If you see components from other crates, you can view source to see
//!   what features are required.
//!
//! ## Usage
//!
//! - For small data: [`Hash::hash()`][enum:Hash-fn:hash].
//! - For large data: [`Keccak`][struct:Keccak].
//!
//! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html
//! [Keccak]: https://keccak.team
//! [OpenSSL]: https://www.openssl.org
//!
//! [fn:sha3_224]: fn.sha3_224.html
//! [fn:sha3_256]: fn.sha3_256.html
//! [fn:shake128]: fn.shake128.html
//! [struct:Keccak]: struct.Keccak.html
//! [enum:Hash-fn:hash]: enum.Hash.html#method.hash

#![warn(missing_docs)]
#![no_std]

// ╔═════════════════╗
// ║   IDENTIFIERS   ║
// ╚═════════════════╝

macro_rules! code_name  { () => { "zeros" }}
macro_rules! version    { () => { "11.1.0" }}

/// # Crate name
pub const NAME: &str = "Zeros";

/// # Crate code name
pub const CODE_NAME: &str = code_name!();

/// # ID of this crate
pub const ID: &str = concat!(
    "85ede580-25ef8822-72185cb5-6608f8ae-3c960bc1-75e3ab78-6d1f8a8a-55eb5c40-",
    "f0b681d6-13275f82-d587a89e-9de72f64-3951a1b0-79f48b29-de4a6330-817a600f",
);

/// # Crate version
pub const VERSION: &str = version!();

/// # Crate release date (year/month/day)
pub const RELEASE_DATE: (u16, u8, u8) = (2021, 4, 21);

/// # Tag, which can be used for logging...
pub const TAG: &str = concat!(code_name!(), "::85ede580::", version!());

// ╔════════════════════╗
// ║   IMPLEMENTATION   ║
// ╚════════════════════╝

#[macro_use]
extern crate alloc;

#[cfg(feature="std")]
extern crate std;

/// # Makes new Error with formatted string, or without one
macro_rules! err {
    () => {
        crate::Error::new(line!(), module_path!(), None)
    };
    ($s: literal) => {
        crate::Error::new(line!(), module_path!(), Some(alloc::borrow::Cow::Borrowed($s)))
    };
    ($s: literal, $($arg: tt)+) => {
        crate::Error::new(line!(), module_path!(), Some(alloc::borrow::Cow::Owned(alloc::format!($s, $($arg)+))))
    };
}

#[test]
fn test_macro_err() {
    use alloc::borrow::Cow;

    macro_rules! s_test { () => { "test" }}

    fn eq(first: Error, second: Error) -> bool {
        first.line() == second.line() && first.module_path() == second.module_path() && first.msg() == second.msg()
    }

    assert!(eq(err!(), Error::new(line!(), module_path!(), None)));
    assert!(eq(err!("test"), Error::new(line!(), module_path!(), Some(Cow::Borrowed(s_test!())))));
    assert!(eq(err!("{s:?}", s=s_test!()), Error::new(line!(), module_path!(), Some(Cow::Owned(alloc::format!("{:?}", s_test!()))))));
}

pub mod version_info;

mod error;
mod keccak;
mod zeros;

#[cfg(feature="std")]
mod hash_reader;
#[cfg(feature="std")]
mod hash_writer;

pub use crate::{
    error::*,
    zeros::*,
};

#[allow(deprecated)]
#[cfg(feature="std")]
pub use crate::{
    hash_reader::*,
    hash_writer::*,
};

#[cfg(target_endian="little")]
pub use crate::{
    keccak::*,
};

/// # Result type used in this crate
pub type Result<T> = core::result::Result<T, Error>;

/// # Result for I/O functions
#[cfg(feature="std")]
pub type IoResult<T> = core::result::Result<T, std::io::Error>;

#[test]
fn test_crate_version() {
    assert_eq!(VERSION, env!("CARGO_PKG_VERSION"));
}