BasicCallBack

Extremely simply HTTP Basic auth backend.

This backend basically works by calling a callback, which receives a username and password. The callback must return true or false depending on if authentication was correct.

Full name: \Sabre\DAV\Auth\Backend\BasicCallBack
Parent class: \Sabre\DAV\Auth\Backend\AbstractBasic

Properties

callBack

Callback.

protected callable $callBack

Methods

__construct

Creates the backend.

public __construct(callable $callBack): mixed

A callback must be provided to handle checking the username and password.

Parameters:

Parameter	Type	Description
`$callBack`	callable

validateUserPass

Validates a username and password.

protected validateUserPass(string $username, string $password): bool

This method should return true or false depending on if login succeeded.

Parameters:

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

Inherited methods

validateUserPass

Validates a username and password.

protected validateUserPass(string $username, string $password): bool

This method should return true or false depending on if login succeeded.

This method is abstract.

Parameters:

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

setRealm

Sets the authentication realm for this backend.

public setRealm(string $realm): mixed

Parameters:

Parameter	Type	Description
`$realm`	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