Docs For Class auth

Home

Documentation home

Atk index

Docs For Class auth_server [ package: atk ]

Class: auth_server

Source Location: /security/class.auth_server.inc

Class auth_server

Class Overview

Driver for external authentication, such as Apache .htaccess files.

With this driver, the webserver is supposed to handle the authentication. Use with care. ATK will not validate anything so if the server authentication is not set-up properly, this may be a security risk The only check ATK makes is whether the webserver has put a valid username in $_SERVER['PHP_AUTH_USER'].

Located in /security/class.auth_server.inc [line 33]

Wiki documentation

auth_interface
   |
   --auth_server

Author(s):

Ivo Jansch <ivo@achievo.org>
Gabriele Gallacci <infouser@gallacci.com>

Information Tags:

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From auth_interface auth_interface::$m_fatalError	Inherited From auth_interface auth_interface::allowed() Check if the currently logged-in user has a certain privilege on a node. auth_interface::attribAllowed() Check if the currently logged-in user has the right to view, edit etc. auth_interface::canMd5() Does the authentication method support md5 encoding of passwords? auth_interface::getAttribEntity() This function returns the level/group(s) that are allowed to view/edit a certain attribute of a given node. auth_interface::getEntity() This function returns the level/group(s) that are allowed to perform the given action on a node. auth_interface::getUser() This function returns information about a user in an associative array with the following elements: "name" -> the userid (should normally be the same as the $user variable that gets passed to it. auth_interface::getUserList() This function returns the list of users that may login. This can be used to display a dropdown of users from which to choose. auth_interface::validateUser() Authenticate a user.

Inherited Properties

Inherited Methods

Inherited From auth_interface

auth_interface::$m_fatalError

Inherited From auth_interface

auth_interface::allowed()

Check if the currently logged-in user has a certain privilege on a node.

auth_interface::attribAllowed()

Check if the currently logged-in user has the right to view, edit etc.

auth_interface::canMd5()

Does the authentication method support md5 encoding of passwords?

auth_interface::getAttribEntity()

This function returns the level/group(s) that are allowed to view/edit a certain attribute of a given node.

auth_interface::getEntity()

This function returns the level/group(s) that are allowed to perform the given action on a node.

auth_interface::getUser()

This function returns information about a user in an associative array with the following elements: "name" -> the userid (should normally be the same as the $user variable that gets passed to it.

auth_interface::getUserList()

This function returns the list of users that may login. This can be used to display a dropdown of users from which to choose.

auth_interface::validateUser()

Authenticate a user.

[ Top ]

Method Summary

boolean	canMd5()	Does this authentication method support md5 encoding of passwords?
int	validateUser()	Authenticate a user.

[ Top ]

Properties

Methods

canMd5 [line 64]

boolean canMd5(
)

Does this authentication method support md5 encoding of passwords?

API Tags:

Return:

false

Redefinition of:

auth_interface::canMd5(): Does the authentication method support md5 encoding of passwords?

[ Top ]

validateUser [line 54]

int validateUser(
String
$user, String
$passwd 
)

Authenticate a user.

Parameters:

String	$user:	The login of the user to authenticate.
String	$passwd:	The password of the user. Note: if the canMd5 function of an implementation returns true, $passwd will be passed as an md5 string.

API Tags:

Return:

AUTH_SUCCESS - Authentication succesful AUTH_MISMATCH - Authentication failed, wrong user/password combination AUTH_LOCKED - Account is locked, can not login with current username. AUTH_ERROR - Authentication failed due to some error which cannot be solved by just trying again. If you return this value, you *must* also fill the m_fatalError variable.

Redefinition of:

auth_interface::validateUser(): Authenticate a user.

[ Top ]