Docs For Class auth

Docs For Class auth_config

Home

Documentation home

Atk index

Docs For Class auth_config [ package: atk ]

Class: auth_config

Source Location: /security/class.auth_config.inc

Class auth_config

Class Overview

Driver for authentication and authorization using entries in the configurationfile.

See the methods in the atkConfig class for an explanation of how to add users and privileges.

Does not support authorization.

Located in /security/class.auth_config.inc [line 32]

Wiki documentation

auth_interface
   |
   --auth_config

Author(s):

Ivo Jansch <ivo@achievo.org>

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::getPassword() This function returns password or false, if password can't be retrieve/recreate auth_interface::getPasswordPolicy() This function returns "get password" policy for current auth method 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::logout() Logout handling. The default implementation does simple session destruction and recreates a new session. 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::getPassword()

This function returns password or false, if password can't be retrieve/recreate

auth_interface::getPasswordPolicy()

This function returns "get password" policy for current auth method

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::logout()

Logout handling. The default implementation does simple session destruction and recreates a new session.

auth_interface::validateUser()

Authenticate a user.

[ Top ]

Method Summary

boolean	canMd5()	Does the authentication method support md5 encoding of passwords?
void	getAttribEntity()	This function returns the level/group(s) that are allowed to view/edit a certain attribute of a given node.
mixed	getEntity()	This function returns the level/group(s) that are allowed to perform the given action on a node.
mixed	getPassword()	This function returns password or false, if password can't be retrieve/recreate
const	getPasswordPolicy()	This function returns "get password" policy for current auth method
array	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.
false	setPasswordAllowed()	This function returns a boolean that is true when the class allows the resetting of the password of a user.
int	validateUser()	Authenticate a user.

[ Top ]

Properties

Methods

canMd5 [line 77]

boolean canMd5(
)

Does the authentication method support md5 encoding of passwords?

API Tags:

Return:

True if md5 is always used. false if md5 is not supported. Drivers that support both md5 and cleartext passwords can return atkconfig("authentication_md5") to let the application decide whether to use md5.

Redefinition of:

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

[ Top ]

getAttribEntity [line 142]

void getAttribEntity(
String
$node, String
$attrib, String
$mode, mixed
3 
)

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

Parameters:

String	$node:	The full nodename of the node for which to check attribute access.
String	$attrib:	The name of the attribute to check
String	$mode:	"view" or "edit"
mixed	3:	One (int) or more (array) entities that are allowed to view/edit the attribute.

Redefinition of:

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

[ Top ]

getEntity [line 109]

mixed getEntity(
String
$node, String
$action 
)

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

Parameters:

String	$node:	The full nodename of the node for which to check the privilege. (modulename.nodename)
String	$action:	The privilege to check.

API Tags:

Return:

One (int) or more (array) entities that are allowed to perform the action.

Redefinition of:

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

[ Top ]

getPassword [line 181]

mixed getPassword(
string
$username 
)

This function returns password or false, if password can't be retrieve/recreate

Parameters:

string

$username:

User for which the password should be regenerated

API Tags:

Return:

string with password or false

Redefinition of:

auth_interface::getPassword(): This function returns password or false, if password can't be retrieve/recreate

[ Top ]

getPasswordPolicy [line 169]

const getPasswordPolicy(
)

This function returns "get password" policy for current auth method

Redefinition of:

auth_interface::getPasswordPolicy(): This function returns "get password" policy for current auth method

[ Top ]

getUser [line 94]

array getUser(
String
$user 
)

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.

"level" -> The level/group(s) to which this user belongs. Specific implementations of the method may add more information if necessary.

Parameters:

String

$user:

The login of the user to retrieve.

API Tags:

Return:

Information about a user.

Redefinition of:

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.

[ Top ]

setPasswordAllowed [line 159]

false setPasswordAllowed(
)

This function returns a boolean that is true when the class allows the resetting of the password of a user.

API Tags:

Deprecated:

Seems like this function is not used anymore

[ Top ]

validateUser [line 53]

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 ]