/axum-password-worker

A wrapper for bcrypt that can be used as axum State, and uses a rayon thread pool so it won't block the tokio runtime.

Primary LanguageRustMIT LicenseMIT

axum-password-worker

A module providing a password hashing and verification worker.

This module contains the PasswordWorker struct, which manages hashing and verification operations using a combination of a rayon thread pool and crossbeam-channel to efficiently handle these operations asynchronously.

The methods will not block the tokio runtime. All await operations do not block. They use non-blocking channel implementations to send and receive passwords and hashes to the rayon thread pool.

PasswordWorker is Send + Sync + Clone and contains no lifetimes, so it can be used as axum state without an Arc.

Example

cargo run --example usage --features rust-argon2
use axum_password_worker::{BcryptConfig, PasswordWorker};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let password = "hunter2";
    let cost = 12; // bcrypt cost value
    let max_threads = 4; // rayon thread pool max threads
    let password_worker = PasswordWorker::new_bcrypt(max_threads)?;

    let hashed_password = password_worker.hash(password, BcryptConfig { cost }).await?;
    println!("Hashed password: {:?}", hashed_password);

    let is_valid = password_worker.verify(password, hashed_password).await?;
    println!("Verification result: {:?}", is_valid);

    Ok(())
}

Available feature flags

There are some implementations included in the library. Each is tied to optional dependency features.

  • bcrypt - (default) (dependency), exports the Bcrypt and BcryptConfig types.
  • rust-argon2 - (dependency), exports the Argon2id and Argon2idConfig types.