Basic

Less than 1 minute

class Basic implements \Hazaar\Warlock\Server\Auth\Authenticator

Properties

private BTree $authDB

Basic constructor.

public __construct(string $dbFile, bool $createDatabase): void

Parameter	Type	Description
`$dbFile`	`string`	the path to the authentication database file (BTree format)
`$createDatabase`	`bool`

Authenticate a client using the provided username and password.

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

Parameter	Type	Description
`$username`	`string`	the username provided by the client
`$password`	`string`	the password provided by the client
`$client`	`Client`

Check whether a user exists in the authentication database.

public exists(string $username): bool

Parameter	Type	Description
`$username`	`string`	the username to look up

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

Parameter	Type	Description
`$username`	`string`
`$password`	`string`

public removeUser(string $username): bool

Parameter	Type	Description
`$username`	`string`

public listUsers(): void

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