rust-crypto-utils/src/lib.rs

50 lines
2.4 KiB
Rust
Raw Normal View History

2022-06-11 10:50:31 +00:00
//! [![github]](https://github.com/MedzikUser/rust-crypto-utils)
//! [![crates-io]](https://crates.io/crates/crypto-utils )
//! [![docs-rs]](https://docs.rs/crypto-utils )
//!
//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K
//!
2022-06-11 10:42:32 +00:00
//! Cryptography Utils for Rust
//!
//! ## Importing
2022-06-11 10:50:31 +00:00
//! The driver is available on [crates-io]. To use the driver in
2022-06-11 10:42:32 +00:00
//! your application, simply add it to your project's `Cargo.toml`.
//!
//! ```toml
//! [dependencies]
//! crypto-utils = "0.1.0"
//! ```
//!
//! ## How to use?
//!
//! ### Compute a Sha hash
//!
//! Add `sha` features (is enabled by default)
//!
//! ```toml
//! [dependencies]
//! crypto-utils = { version = "...", features = ["sha"] }
//! ```
//!
//! Quick and easy Sha1, Sha256 and Sha512 hash computing.
//!
//! ```
//! use crypto_utils::sha::{Algorithm, CryptographicHash};
//!
//! // input data for a hasher
//! let input = "P@ssw0rd"; // &str
//!
//! // compute hash
//! let hash_bytes = CryptographicHash::hash(Algorithm::SHA1, input.as_bytes()); // Vec<u8>
//!
//! // decode hash to a String
//! let hash = hex::encode(hash_bytes); // String
//!
//! assert_eq!(hash, "21bd12dc183f740ee76f27b78eb39c8ad972a757".to_string())
//! ```
#[cfg(feature = "sha")]
pub mod sha;