orionis.auth.passwords.broker.PasswordBroker

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.

class documentation

class PasswordBroker: (source)

Issue hashed credentials and consume them with the password atomically.

Method	`__init__`	Initialize the broker with the configured identity and services.
Method	`_records`	Build a query for the account's password-reset record.
Async Method	`_resolve`	Resolve a current reset token to its identity.
Async Method	`issue`	Issue a reset token when the account's cooldown has elapsed.
Async Method	`reset`	Consume a reset token and atomically replace the password.
Async Method	`valid`	Validate a reset link without consuming its token.
Instance Variable	`db`	Undocumented
Instance Variable	`hashing`	Undocumented
Instance Variable	`model`	Undocumented
Instance Variable	`settings`	Undocumented
Instance Variable	`tokens`	Undocumented

def __init__(self, app: IApplication, db: IQueryBuilder, hashing: IHashManager): (source) ¶

Initialize the broker with the configured identity and services.

Parameters
app:`IApplication`	Application providing password-reset configuration.
db:`IQueryBuilder`	Query builder used to access the reset table.
hashing:`IHashManager`	Password hasher used to fingerprint and replace passwords.

Returns
`None`	The configured model, connection, hasher, and token repository are retained on the broker.

def _records(self, email: str) -> IRawQueryBuilder: (source) ¶

Build a query for the account's password-reset record.

Parameters
email:`str`	Normalized email address identifying the account.

Returns
`IRawQueryBuilder`	Fresh query scoped to the configured reset table and email.

async def _resolve(self, email: str, token: str) -> Model | None: (source) ¶

Resolve a current reset token to its identity.

Parameters
email:`str`	Normalized email address associated with the token.
token:`str`	Plain reset token supplied by the caller.

Returns
`Model \| None`	Matching identity when the token is valid and current, otherwise `None`.

async def issue(self, email: str) -> tuple[Model, str] | None: (source) ¶

Issue a reset token when the account's cooldown has elapsed.

Parameters
email:`str`	Email address associated with the identity.

Returns
`tuple[Model, str] \| None`	The identity and plain token when issued, or `None` when the identity is unknown or a recent token is still in its cooldown.

async def reset(self, email: str, token: str, password: str) -> Model | None: (source) ¶

Consume a reset token and atomically replace the password.

Parameters
email:`str`	Email address associated with the token.
token:`str`	Plain reset token supplied by the caller.
password:`str`	New plaintext password to hash and store.

Returns
`Model \| None`	Updated identity when the reset succeeds, or `None` when the token is invalid, stale, expired, or already consumed.

async def valid(self, email: str, token: str) -> bool: (source) ¶

Validate a reset link without consuming its token.

Parameters
email:`str`	Email address associated with the token.
token:`str`	Plain reset token supplied by the caller.

Returns
`bool`	`True` when the token resolves to the current identity; otherwise, `False`.

Undocumented

Undocumented

Undocumented

Undocumented

Undocumented