HTPasswd

Users stored in an Apache-style .htpasswd file, one identity:hash line per user.

class HTPasswd implements \Hazaar\Auth\Interface\UserProvider , \Hazaar\Auth\Interface\PasswordStore , \Hazaar\Auth\Interface\UserManager , \Hazaar\Auth\Interface\PasswordHasherAware

Implements: Hazaar\Auth\Interface\UserProvider, Hazaar\Auth\Interface\PasswordStore, Hazaar\Auth\Interface\UserManager, Hazaar\Auth\Interface\PasswordHasherAware

Hashes are checked with Hazaar\Auth\Hasher\HTPasswd, which understands the formats htpasswd writes.

Properties

options

private Options $options

Type: Hazaar\Auth\Provider\HTPasswd\Options

passwd

private string $passwd

Type: string

Methods

__construct

public __construct(array|Options $options): void

Parameters

Parameter	Type	Description
$options	array	Hazaar\Auth\Provider\HTPasswd\Options

findByIdentity

public findByIdentity(string $identity): ?Identity

Returns: Hazaar\Auth\Identity

Parameters

Parameter	Type	Description
$identity	string

getPasswordHash

public getPasswordHash(string $identity): ?string

Returns: string

Parameters

Parameter	Type	Description
$identity	string

setPasswordHash

public setPasswordHash(string $identity, string $hash): bool

Returns: bool

Parameters

Parameter	Type	Description
$identity	string
$hash	string

createUser

public createUser(string $identity, ?string $passwordHash, array $data): bool

Returns: bool

Parameters

Parameter	Type	Description
$identity	string
$passwordHash	string
$data	array

deleteUser

public deleteUser(string $identity): bool

Returns: bool

Parameters

Parameter	Type	Description
$identity	string

getPasswordHasher

public getPasswordHasher(): PasswordHasher

Returns: Hazaar\Auth\Interface\PasswordHasher

read

private read(bool $mustExist): array

Returns: array

Parameters

Parameter	Type	Description
$mustExist	bool

write

private write(array $users): bool

Returns: bool

Parameters

Parameter	Type	Description
$users	array	identity => hash

---

Generated by Hazaar API Doc Generator on Wed, 28 Oct 2026 08:43:30 +0000