Skip to content

Latest commit

 

History

History
128 lines (90 loc) · 4.12 KB

README.md

File metadata and controls

128 lines (90 loc) · 4.12 KB
Raw

Hash Forge

PyPI version Build Status License: MIT Python Versions Downloads GitHub issues Project Status Code Style: Black Contributions welcome

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, PBKDF2, Whirlpool and RIPEMD-160.
  • 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.
  • Flexible Integration: Extendible to add new hashing algorithms as needed.

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]"

Usage

Basic Example

from hash_forge import HashManager
from hash-forge.hashers import PBKDF2Hasher

# Initialize HashManager with PBKDF2Hasher
hash_manager = HashManager(PBKDF2Hasher())

# Hash a string
hashed_value = hash_manager.hash("my_secure_password")

# Verify the string against the hashed value
is_valid = hash_manager.verify("my_secure_password", hashed_value)
print(is_valid)  # Outputs: True

# Check if the hash needs rehashing
needs_rehash = hash_manager.needs_rehash(hashed_value)
print(needs_rehash)  # Outputs: False

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.

Hashers

Currently supported hashers:

  • PBKDF2 (default)
  • bcrypt
  • Argon2
  • Scrypt
  • Blake2
  • Whirlpool
  • RIPEMD-160

You can initialize HashManager with one or more hashers:

from hash_forge import HashManager
from hash_forge.hashers import (
    Argon2Hasher,
    BCryptSha256Hasher,
    Blake2Hasher,
    PBKDF2Sha256Hasher,
    Ripemd160Hasher,
    ScryptHasher,
    WhirlpoolHasher,
)

hash_manager = HashManager(
    PBKDF2Sha256Hasher(iterations=150_000),
    BCryptSha256Hasher(),
    Argon2Hasher(),
    ScryptHasher(),
    Ripemd160Hasher(),
    Blake2Hasher('MySecretKey'),
    WhirlpoolHasher(),
  )

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)

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests to help improve the project.

License

This project is licensed under the MIT License.