File

This is an authentication backend that uses a file to manage passwords.

The backend file must conform to Apache's htdigest format

Full name: \Sabre\DAV\Auth\Backend\File
Parent class: \Sabre\DAV\Auth\Backend\AbstractDigest

Properties

users

List of users.

protected array $users

Methods

__construct

Creates the backend object.

public __construct(string|null $filename = null): mixed

If the filename argument is passed in, it will parse out the specified file first.

Parameters:

Parameter	Type	Description
`$filename`	string\|null

loadFile

Loads an htdigest-formatted file. This method can be called multiple times if more than 1 file is used.

public loadFile(string $filename): mixed

Parameters:

Parameter	Type	Description
`$filename`	string

getDigestHash

Returns a users' information.

public getDigestHash(string $realm, string $username): string

Parameters:

Parameter	Type	Description
`$realm`	string
`$username`	string

Inherited methods

setRealm

Sets the authentication realm for this backend.

public setRealm(string $realm): mixed

Be aware that for Digest authentication, the realm influences the digest hash. Choose the realm wisely, because if you change it later, all the existing hashes will break and nobody can authenticate.

Parameters:

Parameter	Type	Description
`$realm`	string

getDigestHash

Returns a users digest hash based on the username and realm.

public getDigestHash(string $realm, string $username): string|null

If the user was not known, null must be returned.

This method is abstract.

Parameters:

Parameter	Type	Description
`$realm`	string
`$username`	string

check

When this method is called, the backend must check if authentication was successful.

public check(\Sabre\HTTP\RequestInterface $request, \Sabre\HTTP\ResponseInterface $response): array

The returned value must be one of the following

[true, "principals/username"] [false, "reason for failure"]

If authentication was successful, it's expected that the authentication backend returns a so-called principal url.

Examples of a principal url:

principals/admin principals/user1 principals/users/joe principals/uid/123457

If you don't use WebDAV ACL (RFC3744) we recommend that you simply return a string such as:

principals/users/[username]

Parameters:

Parameter	Type	Description
`$request`	\Sabre\HTTP\RequestInterface
`$response`	\Sabre\HTTP\ResponseInterface

challenge

This method is called when a user could not be authenticated, and authentication was required for the current request.

public challenge(\Sabre\HTTP\RequestInterface $request, \Sabre\HTTP\ResponseInterface $response): mixed

This gives you the opportunity to set authentication headers. The 401 status code will already be set.

In this case of Basic Auth, this would for example mean that the following header needs to be set:

$response->addHeader('WWW-Authenticate', 'Basic realm=SabreDAV');

Keep in mind that in the case of multiple authentication backends, other WWW-Authenticate headers may already have been set, and you'll want to append your own WWW-Authenticate header instead of overwriting the existing one.

Parameters:

Parameter	Type	Description
`$request`	\Sabre\HTTP\RequestInterface
`$response`	\Sabre\HTTP\ResponseInterface

Automatically generated on 2025-03-18