Users¶

MQP-Database-Access User module.

BlockedIdentityError ¶

Bases: IdentityError

Raised when an identity is blocked from access.

IdentityError ¶

Bases: Exception

Base exception for identity-related failures.

IncorrectSecretError ¶

Bases: IdentityError

Raised when a provided secret does not authenticate.

UnknownIdentityError ¶

Bases: IdentityError

Raised when an identity is not present in the database.

authenticate ¶

authenticate(identity: str, password: str) -> None

Authenticate the identity against the database identities.

create_new_ldap_user ¶

create_new_ldap_user(
    identity: str,
    security_level: str,
    email: str,
    affiliation: str,
    association: str,
) -> None

Create a new user record without storing a local secret hash.

create_new_security_level ¶

create_new_security_level(
    name: str,
    token_max_live_count: int,
    token_max_lifetime: int,
    token_min_creation_interval: int,
    token_max_jobs: int,
    token_max_budget: int,
    token_max_rate: int,
    login_max_interval: int,
) -> None

Create a new user security level configuration.

create_new_user_with_secret ¶

create_new_user_with_secret(
    identity: str,
    secret: str,
    security_level: str,
    email: str,
    affiliation: str,
    association: str,
    force_secret_reset: bool = False,
) -> None

Create a new user with a salted, peppered, and hashed secret.

fetch_user_by_identity ¶

fetch_user_by_identity(identity: str) -> User

Fetch database user data through identity.

fetch_user_security_level ¶

fetch_user_security_level(name: str)

Fetch a user security level by name.

set_new_secret_for_identity ¶

set_new_secret_for_identity(
    identity: str, new_secret: str, forced: bool = False
) -> None

Set a new password (salted and peppered) for a given identity.