Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions crates/arcanum-hash/src/argon2_impl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,34 @@
//! - **Parallelism**: Can utilize multiple cores
//!
//! We use **Argon2id** which combines Argon2i and Argon2d for best security.
//!
//! ## Example
//!
//! ```rust
//! use arcanum_hash::prelude::*;
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! // 1. Choose parameters (Moderate is recommended for general use)
//! let params = Argon2Params::moderate();
//!
//! // 2. Hash a password
//! // Salt is automatically generated using OsRng
//! let password = b"correct horse battery staple";
//! let hash = Argon2::hash_password(password, &params)?;
//!
//! // 3. Verify a password
//! let is_valid = Argon2::verify_password(password, &hash)?;
//! assert!(is_valid);
//!
//! // 4. Key Derivation (e.g., for encryption)
//! use rand::rngs::OsRng;
//! use rand::RngCore;
//! let mut salt = [0u8; 16];
//! OsRng.fill_bytes(&mut salt);
//! let derived_key = Argon2::derive_key(password, &salt, &params, 32)?;
//! # Ok(())
//! # }
//! ```

use crate::traits::PasswordHash;
use arcanum_core::error::{Error, Result};
Expand Down