Hash Forge

Hash Forge is a lightweight Python library designed to simplify the process of hashing and verifying data using a variety of secure hashing algorithms.
Overview
Hash Forge is a flexible and secure hash management tool that supports multiple hashing algorithms. This tool allows you to hash and verify data using popular hash algorithms, making it easy to integrate into projects where password hashing or data integrity is essential.
Features
- Multiple Hashing Algorithms: Supports bcrypt, Scrypt, Argon2, Blake2, Blake3, PBKDF2, Whirlpool and RIPEMD-160.
- Async/Await Support: Non-blocking operations with
hash_async(), verify_async(), and batch processing.
- Builder Pattern: Fluent, chainable API for elegant configuration.
- Configuration Management: Load settings from environment variables, JSON files, or code.
- Hashing and Verification: Easily hash strings and verify their integrity.
- Rehash Detection: Automatically detects if a hash needs to be rehashed based on outdated parameters or algorithms.
- Type-Safe API: Full TypeScript-like type hints with
AlgorithmType for better IDE support.
- Performance Optimized: O(1) hasher lookup, async batch operations 3-5x faster.
- Security Focused: Enforces minimum security parameters and uses cryptographically secure random generation.
- Well Documented: Comprehensive examples, security guidelines, and contribution docs.
Installation
pip install hash-forge
Optional Dependencies
Hash Forge provides optional dependencies for specific hashing algorithms. To install these, use:
-
bcrypt support:
pip install "hash-forge[bcrypt]"
-
Argon2 support:
pip install "hash-forge[argon2]"
-
Whirlpool and RIPEMD-160 support:
pip install "hash-forge[crypto]"
-
Blake3 support:
pip install "hash-forge[blake3]"
Quick Start
from hash_forge import HashManager
hash_manager = HashManager.from_algorithms("argon2")
hashed = hash_manager.hash("my_secure_password")
is_valid = hash_manager.verify("my_secure_password", hashed)
print(is_valid)
needs_update = hash_manager.needs_rehash(hashed)
Usage
Basic Example
from hash_forge import HashManager, AlgorithmType
from hash_forge.hashers import PBKDF2Sha256Hasher
hash_manager = HashManager(PBKDF2Sha256Hasher())
hashed_value = hash_manager.hash("my_secure_password")
is_valid = hash_manager.verify("my_secure_password", hashed_value)
print(is_valid)
needs_rehash = hash_manager.needs_rehash(hashed_value)
print(needs_rehash)
Examples
Check out the examples/ directory for more practical examples:
Quick Hash (New in v2.1.0)
For simple hashing without creating a HashManager instance:
from hash_forge import HashManager, AlgorithmType
hashed = HashManager.quick_hash("my_password")
algorithm: AlgorithmType = "argon2"
hashed = HashManager.quick_hash("my_password", algorithm=algorithm)
hashed = HashManager.quick_hash("my_password", algorithm="pbkdf2_sha256", iterations=200_000)
hashed = HashManager.quick_hash("my_password", algorithm="bcrypt", rounds=14)
hashed = HashManager.quick_hash("my_password", algorithm="argon2", time_cost=4)
Factory Pattern (New in v2.1.0)
Create HashManager instances using algorithm names:
from hash_forge import HashManager, AlgorithmType
hash_manager = HashManager.from_algorithms("pbkdf2_sha256", "argon2", "bcrypt")
algorithms: list[AlgorithmType] = ["pbkdf2_sha256", "bcrypt_sha256"]
hash_manager = HashManager.from_algorithms(*algorithms)
hash_manager = HashManager.from_algorithms("pbkdf2_sha256", "bcrypt", "argon2")
Note: The first hasher provided during initialization of HashManager will be the preferred hasher used for hashing operations, though any available hasher can be used for verification.
Available Algorithms
Currently supported algorithms with their AlgorithmType identifiers:
| PBKDF2-SHA256 | "pbkdf2_sha256" | High | Default, 150K iterations minimum |
| PBKDF2-SHA1 | "pbkdf2_sha1" | Medium | Legacy support |
| bcrypt | "bcrypt" | High | 12 rounds minimum |
| bcrypt-SHA256 | "bcrypt_sha256" | High | With SHA256 pre-hashing |
| Argon2 | "argon2" | Very High | Memory-hard function |
| Scrypt | "scrypt" | High | Memory-hard function |
| Blake2 | "blake2" | High | Fast cryptographic hash |
| Blake3 | "blake3" | Very High | Latest Blake variant |
| Whirlpool | "whirlpool" | Medium | 512-bit hash |
| RIPEMD-160 | "ripemd160" | Medium | 160-bit hash |
Algorithm-Specific Parameters
Different algorithms support different parameters. Use quick_hash() for algorithm-specific customization:
from hash_forge import HashManager
HashManager.quick_hash("password", algorithm="pbkdf2_sha256", iterations=200_000, salt_length=16)
HashManager.quick_hash("password", algorithm="pbkdf2_sha1", iterations=150_000)
HashManager.quick_hash("password", algorithm="bcrypt", rounds=14)
HashManager.quick_hash("password", algorithm="bcrypt_sha256", rounds=12)
HashManager.quick_hash("password", algorithm="argon2", time_cost=4, memory_cost=65536, parallelism=1)
HashManager.quick_hash("password", algorithm="scrypt", n=32768, r=8, p=1)
HashManager.quick_hash("password", algorithm="blake2", key="secret_key")
HashManager.quick_hash("password", algorithm="blake3", key="secret_key")
HashManager.quick_hash("password", algorithm="whirlpool")
HashManager.quick_hash("password", algorithm="ripemd160")
Traditional Initialization
For complete control over parameters, initialize HashManager with individual hasher instances:
from hash_forge import HashManager
from hash_forge.hashers import (
Argon2Hasher,
BCryptSha256Hasher,
Blake2Hasher,
PBKDF2Sha256Hasher,
Ripemd160Hasher,
ScryptHasher,
WhirlpoolHasher,
Blake3Hasher
)
hash_manager = HashManager(
PBKDF2Sha256Hasher(iterations=200_000),
BCryptSha256Hasher(rounds=14),
Argon2Hasher(time_cost=4),
ScryptHasher(),
Ripemd160Hasher(),
Blake2Hasher('MySecretKey'),
WhirlpoolHasher(),
Blake3Hasher()
)
Verifying a Hash
Use the verify method to compare a string with its hashed counterpart:
is_valid = hash_manager.verify("my_secure_password", hashed_value)
Checking for Rehashing
You can check if a hash needs to be rehashed (e.g., if the hashing algorithm parameters are outdated):
needs_rehash = hash_manager.needs_rehash(hashed_value)
Async Support (New in v3.0.0)
Hash Forge provides full async/await support for non-blocking operations. All synchronous methods have async equivalents that run in a thread pool executor to avoid blocking the event loop.
Basic Async Operations
import asyncio
from hash_forge import HashManager
async def main():
hash_manager = HashManager.from_algorithms("argon2")
hashed = await hash_manager.hash_async("my_password")
print(f"Hashed: {hashed}")
is_valid = await hash_manager.verify_async("my_password", hashed)
print(f"Valid: {is_valid}")
needs_rehash = await hash_manager.needs_rehash_async(hashed)
print(f"Needs rehash: {needs_rehash}")
asyncio.run(main())
Batch Operations
Process multiple passwords concurrently for better performance:
import asyncio
from hash_forge import HashManager
async def batch_example():
hash_manager = HashManager.from_algorithms("pbkdf2_sha256")
passwords = ["user1_pass", "user2_pass", "user3_pass", "user4_pass"]
hashes = await hash_manager.hash_many_async(passwords)
for password, hash_value in zip(passwords, hashes):
print(f"{password} -> {hash_value[:50]}...")
pairs = [
("user1_pass", hashes[0]),
("user2_pass", hashes[1]),
("wrong_password", hashes[2]),
]
results = await hash_manager.verify_many_async(pairs)
print(f"Results: {results}")
asyncio.run(batch_example())
Web Framework Integration
Perfect for async web frameworks like FastAPI, Sanic, or aiohttp:
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from hash_forge import HashManager
app = FastAPI()
hash_manager = HashManager.from_algorithms("argon2")
class LoginRequest(BaseModel):
username: str
password: str
@app.post("/register")
async def register(request: LoginRequest):
hashed = await hash_manager.hash_async(request.password)
return {"username": request.username, "password_hash": hashed}
@app.post("/login")
async def login(request: LoginRequest):
stored_hash = get_user_hash(request.username)
is_valid = await hash_manager.verify_async(request.password, stored_hash)
if not is_valid:
raise HTTPException(status_code=401, detail="Invalid credentials")
return {"message": "Login successful"}
Performance Benefits
The async methods are particularly useful when:
- Processing multiple passwords in parallel
- Integrating with async web frameworks
- Avoiding blocking the event loop during expensive hash operations
- Building responsive async applications
import asyncio
import time
from hash_forge import HashManager
async def performance_comparison():
hash_manager = HashManager.from_algorithms("argon2")
passwords = [f"password_{i}" for i in range(10)]
start = time.time()
hashes_sync = [hash_manager.hash(pwd) for pwd in passwords]
sync_time = time.time() - start
start = time.time()
hashes_async = await hash_manager.hash_many_async(passwords)
async_time = time.time() - start
print(f"Sequential: {sync_time:.2f}s")
print(f"Concurrent: {async_time:.2f}s")
print(f"Speedup: {sync_time/async_time:.2f}x")
asyncio.run(performance_comparison())
Configuration Management (New in v3.0.0)
Load configuration from environment variables, JSON files, or programmatically:
from hash_forge import HashManager
from hash_forge.config import HashForgeConfig
config = HashForgeConfig.from_env()
config = HashForgeConfig.from_json("config.json")
config = HashForgeConfig(
pbkdf2_iterations=200_000,
bcrypt_rounds=14,
argon2_time_cost=4
)
hash_manager = HashManager.from_config(config, "pbkdf2_sha256", "bcrypt")
config.to_json("hash_config.json")
Builder Pattern (New in v3.0.0)
Create HashManager instances with a fluent, chainable API:
from hash_forge import HashManager
hash_manager = (
HashManager.builder()
.with_algorithm("argon2", time_cost=4)
.with_algorithm("bcrypt", rounds=14)
.with_algorithm("pbkdf2_sha256", iterations=200_000)
.with_preferred("argon2")
.build()
)
from hash_forge.hashers import PBKDF2Sha256Hasher
custom_hasher = PBKDF2Sha256Hasher(iterations=300_000)
hash_manager = (
HashManager.builder()
.with_hasher(custom_hasher)
.with_algorithm("bcrypt")
.build()
)
What's New in v3.0.0
Hash Forge v3.0.0 represents a major architectural overhaul with significant performance improvements and new features while maintaining backward compatibility for the public API.
ποΈ Architecture Improvements
- Modular Structure: Complete reorganization into logical modules (
core/, config/, utils/, hashers/)
- Template Method Pattern: Reduced code duplication in hashers by 40% through base class abstraction
- Auto-Discovery Pattern: Simplified hasher registration with automatic decorator-based registration
- Chain of Responsibility: Each hasher autonomously determines if it can handle a hash
- Clean Architecture: Clear separation between public API and internal implementation
β‘ Performance Enhancements
- O(1) Hasher Lookup: Internal hasher mapping for instant algorithm detection (vs O(n) iteration)
- Async/Await Support: Full non-blocking operations with thread pool executor for CPU-bound tasks
- Batch Processing: Concurrent processing of multiple hashes with
hash_many_async() and verify_many_async()
- Optimized Memory: Reduced object creation overhead and better resource management
- Thread Pool Efficiency: Smart use of asyncio executors for parallel hash operations
π― New Features
- Async Operations: Complete async API with
hash_async(), verify_async(), needs_rehash_async()
- Builder Pattern: Fluent, chainable API for elegant HashManager configuration
- Config Management: Load settings from environment variables, JSON files, or programmatic config
- Logging Infrastructure: Built-in structured logging for debugging and monitoring
- Type Safety: Enhanced type hints with
AlgorithmType literals for IDE autocomplete
π Performance Benchmarks
With async batch operations, v3.0.0 achieves significant speedups:
- 10 concurrent hashes: ~3-5x faster than sequential
- 100 concurrent hashes: ~8-10x faster than sequential
- Web framework integration: Non-blocking operations prevent request queue buildup
- Memory efficiency: 40% less code duplication = smaller memory footprint
Async Support (New in v3.0.0)
Hash Forge provides full async/await support for non-blocking operations. All synchronous methods have async equivalents that run in a thread pool executor to avoid blocking the event loop.
Basic Async Operations
import asyncio
from hash_forge import HashManager
async def main():
hash_manager = HashManager.from_algorithms("argon2")
hashed = await hash_manager.hash_async("my_password")
print(f"Hashed: {hashed}")
is_valid = await hash_manager.verify_async("my_password", hashed)
print(f"Valid: {is_valid}")
needs_rehash = await hash_manager.needs_rehash_async(hashed)
print(f"Needs rehash: {needs_rehash}")
asyncio.run(main())
Batch Operations
Process multiple passwords concurrently for better performance:
import asyncio
from hash_forge import HashManager
async def batch_example():
hash_manager = HashManager.from_algorithms("pbkdf2_sha256")
passwords = ["user1_pass", "user2_pass", "user3_pass", "user4_pass"]
hashes = await hash_manager.hash_many_async(passwords)
for password, hash_value in zip(passwords, hashes):
print(f"{password} -> {hash_value[:50]}...")
pairs = [
("user1_pass", hashes[0]),
("user2_pass", hashes[1]),
("wrong_password", hashes[2]),
]
results = await hash_manager.verify_many_async(pairs)
print(f"Results: {results}")
asyncio.run(batch_example())
Web Framework Integration
Perfect for async web frameworks like FastAPI, Sanic, or aiohttp:
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from hash_forge import HashManager
app = FastAPI()
hash_manager = HashManager.from_algorithms("argon2")
class LoginRequest(BaseModel):
username: str
password: str
@app.post("/register")
async def register(request: LoginRequest):
hashed = await hash_manager.hash_async(request.password)
return {"username": request.username, "password_hash": hashed}
@app.post("/login")
async def login(request: LoginRequest):
stored_hash = get_user_hash(request.username)
is_valid = await hash_manager.verify_async(request.password, stored_hash)
if not is_valid:
raise HTTPException(status_code=401, detail="Invalid credentials")
return {"message": "Login successful"}
Performance Benefits
The async methods are particularly useful when:
- Processing multiple passwords in parallel
- Integrating with async web frameworks
- Avoiding blocking the event loop during expensive hash operations
- Building responsive async applications
import asyncio
import time
from hash_forge import HashManager
async def performance_comparison():
hash_manager = HashManager.from_algorithms("argon2")
passwords = [f"password_{i}" for i in range(10)]
start = time.time()
hashes_sync = [hash_manager.hash(pwd) for pwd in passwords]
sync_time = time.time() - start
start = time.time()
hashes_async = await hash_manager.hash_many_async(passwords)
async_time = time.time() - start
print(f"Sequential: {sync_time:.2f}s")
print(f"Concurrent: {async_time:.2f}s")
print(f"Speedup: {sync_time/async_time:.2f}x")
asyncio.run(performance_comparison())
Configuration Management (New in v3.0.0)
Load configuration from environment variables, JSON files, or programmatically:
from hash_forge import HashManager
from hash_forge.config import HashForgeConfig
config = HashForgeConfig.from_env()
config = HashForgeConfig.from_json("config.json")
config = HashForgeConfig(
pbkdf2_iterations=200_000,
bcrypt_rounds=14,
argon2_time_cost=4
)
hash_manager = HashManager.from_config(config, "pbkdf2_sha256", "bcrypt")
config.to_json("hash_config.json")
Builder Pattern (New in v3.0.0)
Create HashManager instances with a fluent, chainable API:
from hash_forge import HashManager
hash_manager = (
HashManager.builder()
.with_algorithm("argon2", time_cost=4)
.with_algorithm("bcrypt", rounds=14)
.with_algorithm("pbkdf2_sha256", iterations=200_000)
.with_preferred("argon2")
.build()
)
from hash_forge.hashers import PBKDF2Sha256Hasher
custom_hasher = PBKDF2Sha256Hasher(iterations=300_000)
hash_manager = (
HashManager.builder()
.with_hasher(custom_hasher)
.with_algorithm("bcrypt")
.build()
)
What's New in v3.0.0
Hash Forge v3.0.0 represents a major architectural overhaul with significant performance improvements and new features while maintaining backward compatibility for the public API.
ποΈ Architecture Improvements
- Modular Structure: Complete reorganization into logical modules (
core/, config/, utils/, hashers/)
- Template Method Pattern: Reduced code duplication in hashers by 40% through base class abstraction
- Auto-Discovery Pattern: Simplified hasher registration with automatic decorator-based registration
- Chain of Responsibility: Each hasher autonomously determines if it can handle a hash
- Clean Architecture: Clear separation between public API and internal implementation
β‘ Performance Enhancements
- O(1) Hasher Lookup: Internal hasher mapping for instant algorithm detection (vs O(n) iteration)
- Async/Await Support: Full non-blocking operations with thread pool executor for CPU-bound tasks
- Batch Processing: Concurrent processing of multiple hashes with
hash_many_async() and verify_many_async()
- Optimized Memory: Reduced object creation overhead and better resource management
- Thread Pool Efficiency: Smart use of asyncio executors for parallel hash operations
π― New Features
- Async Operations: Complete async API with
hash_async(), verify_async(), needs_rehash_async()
- Builder Pattern: Fluent, chainable API for elegant HashManager configuration
- Config Management: Load settings from environment variables, JSON files, or programmatic config
- Logging Infrastructure: Built-in structured logging for debugging and monitoring
- Type Safety: Enhanced type hints with
AlgorithmType literals for IDE autocomplete
π Performance Benchmarks
With async batch operations, v3.0.0 achieves significant speedups:
- 10 concurrent hashes: ~3-5x faster than sequential
- 100 concurrent hashes: ~8-10x faster than sequential
- Web framework integration: Non-blocking operations prevent request queue buildup
- Memory efficiency: 40% less code duplication = smaller memory footprint
π οΈ Developer Experience
π οΈ Developer Experience
- Type Safety:
AlgorithmType literal for IDE autocomplete and error detection
- Factory Pattern: Create hashers by algorithm name with
HasherFactory
- Builder Pattern: Chainable API for elegant configuration
- Builder Pattern: Chainable API for elegant configuration
- Convenience Methods:
quick_hash() and from_algorithms() for simpler usage
- Logging Support: Built-in logging infrastructure for debugging
- Logging Support: Built-in logging infrastructure for debugging
π Security Enhancements
- Parameter Validation: Enforces minimum security thresholds (150K PBKDF2 iterations, 12 BCrypt rounds)
- Custom Exceptions: More specific error types (
InvalidHasherError, UnsupportedAlgorithmError)
- Centralized Configuration: Security defaults in one place
π§ͺ Better Testing
- Enhanced Test Suite: 114 tests covering all functionality
- Enhanced Test Suite: 114 tests covering all functionality
- Type Checking Tests: Validates
AlgorithmType usage
- Configuration Validation: Tests security parameter enforcement
- Builder Pattern Tests: Validates fluent API
- Async Tests: Full coverage of async operations
- Config Tests: JSON, env vars, and programmatic config
- Builder Pattern Tests: Validates fluent API
- Async Tests: Full coverage of async operations
- Config Tests: JSON, env vars, and programmatic config
π API Improvements
Before v2.1.0:
from hash_forge.hashers.pbkdf2_hasher import PBKDF2Sha256Hasher
hasher = PBKDF2Sha256Hasher(iterations=150000)
hash_manager = HashManager(hasher)
v2.1.0:
v2.1.0:
from hash_forge import HashManager, AlgorithmType
algorithm: AlgorithmType = "pbkdf2_sha256"
hash_manager = HashManager.from_algorithms(algorithm)
hashed = HashManager.quick_hash("password", algorithm=algorithm, iterations=200_000)
v3.0.0:
from hash_forge import HashManager
from hash_forge.config import HashForgeConfig
hash_manager = (
HashManager.builder()
.with_algorithm("argon2", time_cost=4, memory_cost=65536)
.with_algorithm("bcrypt", rounds=14)
.with_preferred("argon2")
.build()
)
config = HashForgeConfig.from_json("config.json")
hash_manager = HashManager.from_config(config, "argon2", "bcrypt")
import asyncio
async def main():
hashes = await hash_manager.hash_many_async(["pass1", "pass2", "pass3"])
asyncio.run(main())
π Migration Guide (v2.x β v3.0.0)
The public API remains backward compatible, but internal imports have changed:
β
No changes needed (backward compatible):
from hash_forge import HashManager, AlgorithmType
from hash_forge.hashers import PBKDF2Sha256Hasher, BCryptHasher
hash_manager = HashManager.from_algorithms("pbkdf2_sha256")
hashed = hash_manager.hash("password")
β οΈ Update if using internal modules (rare):
from hash_forge.protocols import HasherProtocol
from hash_forge.factory import HasherFactory
from hash_forge.core.protocols import HasherProtocol
from hash_forge.core.factory import HasherFactory
π New Project Structure
hash_forge/
βββ __init__.py # Public API
βββ types.py # Type definitions (AlgorithmType)
βββ exceptions.py # Exception classes
β
βββ core/ # Core functionality (internal)
β βββ manager.py # HashManager implementation
β βββ builder.py # Builder pattern
β βββ factory.py # Hasher factory
β βββ protocols.py # Protocol definitions
β βββ base_hasher.py # Template base class
β
βββ config/ # Configuration (internal)
β βββ settings.py # Default parameters
β βββ constants.py # Constants
β βββ logging.py # Logging configuration
β
βββ hashers/ # Algorithm implementations
β βββ pbkdf2_hasher.py
β βββ bcrypt_hasher.py
β βββ argon2_hasher.py
β βββ ...
β
βββ utils/ # Utilities (internal)
βββ helpers.py
Documentation
Contributing
Contributions are welcome! Please read our Contributing Guide for details on:
- Setting up the development environment
- Running tests and linting
- Code style and documentation standards
- Submitting pull requests
Security
For security best practices and to report vulnerabilities, please see our Security Policy.
Recommended algorithms for password hashing:
- Argon2 (best choice)
- BCrypt (industry standard)
- PBKDF2-SHA256 (NIST approved)
License
This project is licensed under the MIT License - see the LICENSE file for details.