Documentation

Auth extends PDO
in package

SabreDav authentication plugin class.

Table of Contents

$tableName  : string
PDO table name we'll be using.
$realm  : string
Authentication Realm.
check()  : array<string|int, mixed>
When this method is called, the backend must check if authentication was successful.
checkBasic()  : array<string|int, mixed>
When this method is called, the backend must check if authentication was successful.

Properties

$tableName

PDO table name we'll be using.

public string $tableName = 'dav_users'

$realm

Authentication Realm.

protected string $realm = 'YetiDAV'

The realm is often displayed by browser clients when showing the authentication dialog.

Methods

check()

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

public check(RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

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
$request : RequestInterface
$response : ResponseInterface
Return values
array<string|int, mixed>

checkBasic()

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

public checkBasic(RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

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
$request : RequestInterface
$response : ResponseInterface
Return values
array<string|int, mixed>

        

Search results