ThreatFlux Hashing

A high-performance async file hashing library for Rust, supporting MD5, SHA256, SHA512, and BLAKE3 algorithms with concurrent processing capabilities.

Features

• 🚀 Async/Await Support - Built on tokio for efficient async operations
• ⚡ Concurrent Processing - Calculate multiple hashes in parallel
• 🔧 Configurable - Customize buffer sizes, concurrency limits, and algorithms
• 📦 Selective Hashing - Choose which algorithms to calculate
• 🔄 Zero-Copy Operations - Efficient memory usage
• 📝 Optional Serde Support - Serialize/deserialize hash results

Installation

Add this to your Cargo.toml:

[dependencies]
threatflux-hashing = "1.7.0"

Quick Start

use threatflux_hashing::calculate_all_hashes;
use std::path::Path;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let hashes = calculate_all_hashes(Path::new("file.bin")).await?;
    
    println!("MD5:    {:?}", hashes.md5);
    println!("SHA256: {:?}", hashes.sha256);
    println!("SHA512: {:?}", hashes.sha512);
    println!("BLAKE3: {:?}", hashes.blake3);
    
    Ok(())
}

Advanced Usage

Custom Configuration

use threatflux_hashing::{calculate_all_hashes_with_config, HashConfig, HashAlgorithms};
use std::path::Path;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = HashConfig {
        algorithms: HashAlgorithms {
            md5: true,
            sha256: true,
            sha512: false,  // Skip SHA512 for speed
            blake3: true,
        },
        buffer_size: 16384,  // 16KB buffer
        max_concurrent_operations: 20,
    };
    
    let hashes = calculate_all_hashes_with_config(Path::new("file.bin"), &config).await?;
    Ok(())
}

Single Hash Calculation

use threatflux_hashing::calculate_md5;
use std::path::Path;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let md5 = calculate_md5(Path::new("file.bin")).await?;
    println!("MD5: {}", md5);
    Ok(())
}

Concurrent File Processing

use threatflux_hashing::calculate_all_hashes;
use tokio::task::JoinSet;
use std::path::Path;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let files = vec!["file1.bin", "file2.bin", "file3.bin"];
    let mut tasks = JoinSet::new();
    
    for file in files {
        tasks.spawn(async move {
            calculate_all_hashes(Path::new(file)).await
        });
    }
    
    while let Some(result) = tasks.join_next().await {
        match result {
            Ok(Ok(hashes)) => println!("Hashes: {:?}", hashes),
            Ok(Err(e)) => eprintln!("Hash error: {}", e),
            Err(e) => eprintln!("Task error: {}", e),
        }
    }
    
    Ok(())
}

Performance Tips

1. Buffer Size: Larger buffers (16KB-64KB) generally improve performance for large files
2. Algorithm Selection: Skip unnecessary algorithms to reduce computation time
3. Concurrency: Adjust max_concurrent_operations based on your system's capabilities
4. BLAKE3: Consider using BLAKE3 for the best performance-to-security ratio

Supported Algorithms

Error Handling

The library uses custom error types for better error handling:

use threatflux_hashing::{calculate_all_hashes, HashError};
use std::path::Path;

#[tokio::main]
async fn main() {
    match calculate_all_hashes(Path::new("nonexistent.bin")).await {
        Ok(hashes) => println!("Success: {:?}", hashes),
        Err(HashError::Io(e)) => eprintln!("IO Error: {}", e),
        Err(e) => eprintln!("Other error: {}", e),
    }
}

Features

• serde (default): Enable serialization/deserialization support

[dependencies]
threatflux-hashing = { version = "1.7.0", default-features = false }

License

Licensed under the MIT License. See LICENSE for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Benchmarks

Run benchmarks with:

cargo bench

Typical performance on modern hardware:

• MD5: ~500 MB/s
• SHA256: ~300 MB/s
• SHA512: ~200 MB/s
• BLAKE3: ~1 GB/s

Performance varies based on file size, system capabilities, and configuration.