Docs For Class auth

Docs For Class auth_sspi

Home

Documentation home

Atk index

Docs For Class auth_sspi [ package: atk ]

Class: auth_sspi

Source Location: /security/class.auth_sspi.inc

Class auth_sspi

Class Overview

Driver for authentication and authorization using Microsoft's Security Support Provider Interface (SSPI).

To use this authentication module, add a field to your user table that stores the user's SSPI account. Then add the following lines to your config.inc.php file:

// The names of your SSPI trusted domains. $config_auth_sspi_trusted_domains = Array ( "DOMAINNAME" );

// The field in the user table that stores the sspi account name $config_auth_sspi_accountfield = "sspiaccountfield";

Finally, change the following configuration values to enable SSPI.

$config_authentication = "sspi"; $config_authorization = "sspi";

Located in /security/class.auth_sspi.inc [line 45]

Wiki documentation

auth_interface
   |
   --auth_db
      |
      --auth_sspi

Author(s):

Giroux

Information Tags:

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From auth_db auth_db::$m_rightscache Inherited From auth_interface auth_interface::$m_fatalError	Inherited From auth_db auth_db::buildSelectUserQuery() Build the query for selecting the user for authentication auth_db::canMd5() Does the authentication method support md5 encoding of passwords? auth_db::getAccessLevel() Get the access level from the user auth_db::getAttribEntity() This function returns the level/group(s) that are allowed to view/edit a certain attribute of a given node. auth_db::getEntity() This function returns the level/group(s) that are allowed to perform the given action on a node. auth_db::getParentGroups() Get the parent groups auth_db::getPassword() returns the users password from record auth_db::getPasswordPolicy() This function returns "get password" policy for current auth method auth_db::gettingPassword() This function returns password or false, if password can't be retrieve/recreate auth_db::getUser() This function returns information about a user in an associative array with the following elements (minimal): "name" -> the userid (should normally be the same as the $user variable that gets passed to it. auth_db::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_db::isLocked() checks wether the useraccount is locked auth_db::matchPasswords() Match 2 passwords. auth_db::selectUser() Select the user record from the database auth_db::setPasswordAllowed() This function returns a boolean that is true when the class allows the resetting of the password of a user. auth_db::userListCompare() Compare function for sorting users on their username auth_db::validateUser() Authenticate a user. 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_db

auth_db::$m_rightscache

Inherited From auth_interface

auth_interface::$m_fatalError

Inherited From auth_db

auth_db::buildSelectUserQuery()

Build the query for selecting the user for authentication

auth_db::canMd5()

Does the authentication method support md5 encoding of passwords?

auth_db::getAccessLevel()

Get the access level from the user

auth_db::getAttribEntity()

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

auth_db::getEntity()

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

auth_db::getParentGroups()

Get the parent groups

auth_db::getPassword()

returns the users password from record

auth_db::getPasswordPolicy()

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

auth_db::gettingPassword()

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

auth_db::getUser()

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

auth_db::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_db::isLocked()

checks wether the useraccount is locked

auth_db::matchPasswords()

Match 2 passwords.

auth_db::selectUser()

Select the user record from the database

auth_db::setPasswordAllowed()

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

auth_db::userListCompare()

Compare function for sorting users on their username

auth_db::validateUser()

Authenticate a user.

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

auth_sspi	auth_sspi()
void	buildSelectUserQuery()
void	getUser()
void	selectUser()
void	validateUser()

[ Top ]

Properties

Methods

Constructor auth_sspi [line 47]

auth_sspi auth_sspi(
)

[ Top ]

buildSelectUserQuery [line 63]

void buildSelectUserQuery(

$sspiaccount, 
$usertable, 
$userfield, 
$sspiaccountfield, [
$accountdisablefield = null], [
$accountenbleexpression = null] 
)

Parameters:

	$sspiaccount:
	$usertable:
	$userfield:
	$sspiaccountfield:
	$accountdisablefield:
	$accountenbleexpression:

Redefinition of:

auth_db::buildSelectUserQuery(): Build the query for selecting the user for authentication

[ Top ]

getUser [line 174]

void getUser(

&$user 
)

Parameters:

&$user:

Redefinition of:

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

[ Top ]

selectUser [line 132]

void selectUser(

$user 
)

Parameters:

$user:

Redefinition of:

auth_db::selectUser(): Select the user record from the database

[ Top ]

validateUser [line 73]

void validateUser(
[
$user = ""], [
$passwd = ""] 
)

Parameters:

	$user:
	$passwd:

Redefinition of:

auth_db::validateUser(): Authenticate a user.

[ Top ]