Class Sabre_DAV_Auth_Backend_AbstractDigest

Description

HTTP Digest authentication backend class

This class can be used by authentication objects wishing to use HTTP Digest Most of the digest logic is handled, implementors just need to worry about the getUserInfo method

  • author: Evert Pot (http://www.rooftopsolutions.nl/)
  • copyright: Copyright (C) 2007-2010 Rooftop Solutions. All rights reserved.
  • abstract:
  • license: Modified BSD License

Located in /sources_custom/Sabre/DAV/Auth/Backend/AbstractDigest.php (line 16)

Sabre_DAV_Auth_Backend_Abstract
   |
   --Sabre_DAV_Auth_Backend_AbstractDigest
Direct descendents
Class Description
Sabre_DAV_Auth_Backend_File This is an authentication backend that uses a file to manage passwords.
Variable Summary
array|null $currentUser
Method Summary
bool authenticate (Sabre_DAV_Server $server,  $realm)
array|null getCurrentUser ()
array getUserInfo (string $realm, string $username)
Variables
array|null $currentUser (line 24)

This variable holds information about the currently logged in user.

  • access: protected
Methods
authenticate (line 50)

Authenticates the user based on the current request.

If authentication is succesful, true must be returned. If authentication fails, an exception must be thrown.

  • throws: Sabre_DAV_Exception_NotAuthenticated
  • access: public
bool authenticate (Sabre_DAV_Server $server,  $realm)

Redefinition of:
Sabre_DAV_Auth_Backend_Abstract::authenticate()
Authenticates the user based on the current request.
getCurrentUser (line 99)

Returns information about the currently logged in user.

  • access: public
array|null getCurrentUser ()

Redefinition of:
Sabre_DAV_Auth_Backend_Abstract::getCurrentUser()
Returns information about the currently logged in user.
getUserInfo (line 39)

Returns a users information based on its username

The returned struct must contain at least a uri element (which can be identical to username) as well as a digestHash element.

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

  • abstract:
  • access: public
array getUserInfo (string $realm, string $username)
  • string $realm
  • string $username

Redefined in descendants as:

Inherited Methods

Inherited From Sabre_DAV_Auth_Backend_Abstract

Sabre_DAV_Auth_Backend_Abstract::authenticate()
Sabre_DAV_Auth_Backend_Abstract::getCurrentUser()
Sabre_DAV_Auth_Backend_Abstract::getUsers()

Documentation generated on Sun, 02 Jan 2011 23:06:51 +0000 by phpDocumentor 1.4.3