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 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
/*
==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--
Zeros
Copyright (C) 2019-2024 Anonymous
There are several releases over multiple years,
they are listed as ranges, such as: "2019-2024".
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--
*/
//! # Zeros
//!
//! ## Project
//!
//! - License: GNU Lesser General Public License, either version 3, or (at your option) any later version.
//! - _This project follows [Semantic Versioning 2.0.0]_
//!
//! ## Features
//!
//! This project provides:
//!
//! - _Some_ [hash functions][mod:keccak] from [Keccak][site:keccak].
//! - Some cryptographic implementations: [Chacha][mod:chacha], [Poly1305][mod:poly1305], [Argon2][mod:argon2]...
//!
//! ## 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.
//! - Accuracy/correctness is highest priority. Speed is second. Currently, it's slower than well-known implementations, such as
//! [OpenSSL][site: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.
//!
//! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html
//!
//! [site:keccak]: https://keccak.team
//! [site:openssl]: https://www.openssl.org
//!
//! [mod:argon2]: argon2/index.html
//! [mod:chacha]: chacha/index.html
//! [mod:keccak]: keccak/index.html
//! [mod:poly1305]: poly1305/index.html
#![warn(missing_docs)]
#![no_std]
#![cfg_attr(
feature="simd",
feature(portable_simd),
deprecated(note="`simd` feature is just for _tests_! When [`Simd`](https://doc.rust-lang.org/core/simd/struct.Simd.html) is stabilized, it will be removed.")
)]
#![feature(doc_cfg)]
// ╔═════════════════╗
// ║ IDENTIFIERS ║
// ╚═════════════════╝
macro_rules! code_name { () => { "zeros" }}
macro_rules! version { () => { "16.0.4" }}
/// # 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) = (2024, 4, 16);
/// # 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!()))))));
}
#[macro_use]
mod error;
mod bytes;
mod str;
mod zeros;
pub mod argon2;
pub mod chacha;
pub mod io;
pub mod keccak;
pub mod poly1305;
pub mod version_info;
pub use crate::{
bytes::*,
error::*,
zeros::*,
};
/// # Result type used in this crate
pub type Result<T> = core::result::Result<T, Error>;
/// # Result for I/O functions
#[cfg(feature="std")]
#[doc(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"));
}