orionis.hashing.contracts.IHasher

ORIONIS API REFERENCE

Modules Classes Names

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class IHasher(ABC): (source)

Known subclasses: orionis.hashing.contracts.IHashManager, orionis.hashing.hashers.Argon2Hasher, orionis.hashing.hashers.BcryptHasher

View In Hierarchy

Define the contract implemented by every password hashing driver.

Implementations must rely on algorithms designed for password storage (Argon2id, bcrypt) and never on general purpose digests such as MD5 or the SHA family.

Async Method	`check`	Verify a plain text value against an encoded hash.
Method	`getAlgorithm`	Return the identifier of the algorithm used by the driver.
Async Method	`make`	Hash a plain text value off the event loop.
Method	`needsRehash`	Determine whether a hash was produced with outdated parameters.
Method	`setRounds`	Set the default cost factor used by the driver.
Class Variable	`__slots__`	Undocumented

@abstractmethod

async def check(self, value: str, hashed: str) -> bool: (source) ¶

overridden in orionis.hashing.hashers.Argon2Hasher, orionis.hashing.hashers.BcryptHasher, orionis.hashing.HashManager

Verify a plain text value against an encoded hash.

Parameters
value:`str`	Plain text value to verify.
hashed:`str`	Previously generated hash.

Returns
`bool`	`True` when the value matches the hash, `False` otherwise.

@abstractmethod

def getAlgorithm(self) -> str: (source) ¶

overridden in orionis.hashing.hashers.Argon2Hasher, orionis.hashing.hashers.BcryptHasher, orionis.hashing.HashManager

Return the identifier of the algorithm used by the driver.

Returns
`str`	Algorithm identifier, such as `'argon2id'` or `'bcrypt'`.

@abstractmethod

async def make(self, value: str, *, rounds: int | None = None, memory: int | None = None, threads: int | None = None) -> str: (source) ¶

overridden in orionis.hashing.hashers.Argon2Hasher, orionis.hashing.hashers.BcryptHasher, orionis.hashing.HashManager

Hash a plain text value off the event loop.

Parameters
value:`str`	Plain text value to hash.
rounds:`int \| None`	Per-call cost override. Maps to the bcrypt cost factor and to the Argon2id time cost. `None` keeps the configured value.
memory:`int \| None`	Per-call memory cost override, in kibibytes. Only meaningful for drivers that support it.
threads:`int \| None`	Per-call parallelism override. Only meaningful for drivers that support it.

Returns
`str`	Encoded hash, including algorithm identifier, parameters and salt.

@abstractmethod

def needsRehash(self, hashed: str) -> bool: (source) ¶

overridden in orionis.hashing.hashers.Argon2Hasher, orionis.hashing.hashers.BcryptHasher, orionis.hashing.HashManager

Determine whether a hash was produced with outdated parameters.

Parameters
hashed:`str`	Previously generated hash.

Returns
`bool`	`True` when the hash should be regenerated with the current configuration.

@abstractmethod

def setRounds(self, rounds: int) -> Self: (source) ¶

overridden in orionis.hashing.hashers.Argon2Hasher, orionis.hashing.hashers.BcryptHasher, orionis.hashing.HashManager

Set the default cost factor used by the driver.

Parameters
rounds:`int`	New cost factor. Maps to the bcrypt cost factor and to the Argon2id time cost.

Returns
`Self`	The same instance, allowing fluent configuration.

Raises
`HashConfigurationException`	If the value is not a valid cost factor for the driver.

__slots__: tuple = (source) ¶

overridden in orionis.hashing.contracts.IHashManager, orionis.hashing.hashers.Argon2Hasher, orionis.hashing.hashers.BcryptHasher

Undocumented