Authenticator

Contract for Warlock authentication backends.

interface Authenticator

Implementations authenticate clients using credential pairs and provide existence checks for user identities.

Methods

authenticate

Authenticate a client using the provided credentials.

public authenticate(string $username, string $password, ?Client $client): bool

Parameters

Parameter	Type	Description
$username	string
$password	string
$client	Client

exists

Check whether a user exists.

public exists(string $username): bool

Parameters

Parameter	Type	Description
$username	string

addUser

Add a new user with the specified password.

public addUser(string $username, string $password): bool

Parameters

Parameter	Type	Description
$username	string
$password	string

removeUser

Remove an existing user.

public removeUser(string $username): bool

Parameters

Parameter	Type	Description
$username	string

listUsers

List all existing users.

public listUsers(): void

---

Generated by Hazaar API Doc Generator on Fri, 05 Jun 2026 06:08:15 +0000