Class Auth_http

Description

The Auth_http class transparently logs users in to Horde using already present HTTP authentication headers.

The 'encryption' parameter specifies what kind of passwords are in the .htpasswd file. The supported options are 'crypt-des' (standard crypted htpasswd entries) and 'aprmd5'. This information is used if you want to directly authenticate users with this driver, instead of relying on transparent auth.

$Horde: framework/Auth/Auth/http.php,v 1.21.10.14 2009/01/06 15:22:49 jan Exp $

Copyright 1999-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://opensource.org/licenses/lgpl-license.php.

Located in /Auth/Auth/http.php (line 23)

Auth
   |
   --Auth_http
Variable Summary
 array $_users
Method Summary
 Auth_http Auth_http ([array $params = array()])
 mixed listUsers ()
 boolean transparent ()
Variables
array $capabilities = array('add' => false,
'update' => false,
'resetpassword' => false,
'remove' => false,
'list' => false,
'transparent' => true)
(line 31)

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.


Redefinition of:
Auth::$capabilities
An array of capabilities, so that the driver can report which operations it supports and which it doesn't.
array $_users = array() (line 43)

Array of usernames and hashed passwords.

Inherited Variables

Inherited from Auth

Auth::$_authCredentials
Auth::$_params
Methods
Constructor Auth_http (line 50)

Constructs a new HTTP authentication object.

Auth_http Auth_http ([array $params = array()])
  • array $params: A hash containing parameters.
listUsers (line 133)

List all users in the system.

  • return: The array of userIds, or a PEAR_Error object on failure.
mixed listUsers ()

Redefinition of:
Auth::listUsers()
Lists all users in the system.
transparent (line 144)

Automatic authentication: Find out if the client has HTTP authentication info present.

  • return: Whether or not the client is allowed.
boolean transparent ()

Redefinition of:
Auth::transparent()
Automatic authentication.

Inherited Methods

Inherited From Auth

 Auth::addHook()
 Auth::addLogoutParameters()
 Auth::addUser()
 Auth::authenticate()
 Auth::clearAuth()
 Auth::exists()
 Auth::factory()
 Auth::genRandomPassword()
 Auth::getAuth()
 Auth::getAuthDomain()
 Auth::getBareAuth()
 Auth::getCredential()
 Auth::getCryptedPassword()
 Auth::getDriver()
 Auth::getLoginScreen()
 Auth::getLogoutReason()
 Auth::getLogoutReasonString()
 Auth::getParam()
 Auth::getProvider()
 Auth::getSalt()
 Auth::hasCapability()
 Auth::isAdmin()
 Auth::isAuthenticated()
 Auth::isPasswordChangeRequested()
 Auth::listUsers()
 Auth::readSessionData()
 Auth::removeHook()
 Auth::removeUser()
 Auth::removeUserData()
 Auth::setAuth()
 Auth::setCredential()
 Auth::singleton()
 Auth::transparent()
 Auth::updateUser()
 Auth::_authenticate()
 Auth::_isAdmin()

Documentation generated on Sun, 30 Jan 2011 05:18:15 +0000 by phpDocumentor 1.4.3