Docs For Class AuthNTokens

Description

AuthNTokens are used by AuthNMethods as an abstraction to allow for accessing common data from tokens passed that correspond to multiple Authorization systems. The identifier is often a username, but can be any string as long as it is unique within a given AuthNMethod.

AuthNMethods deal with two types of tokens. The first are arbitrary data that is passed by the user trying to authenticate. This data may be an array with elements for 'username' and 'password', it might be a string operated on by a private key, it might be a Kerberos Ticket, or pretty much anything else. It is up to a given AuthNMethod to pass the tokens passed to it to appropriate AuthNTokens objects for the handling of this data. AuthNTokens objects provide access to a string 'identifier' for given tokens data that can be used by other systems to identify this set of tokens. Additionally, the AuthNTokens objects can be initialized with an identifier and then passed to the authentication method for querying on the existance or associated properties of the user that corresponds to the identifier.

version: $Id: AuthNTokens.abstract.php,v 1.4 2007/09/04 20:25:37 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/agentmanagement/AuthNMethods/AuthNTokens.abstract.php (line 36)

Direct descendents

Class	Description
UsernamePasswordAuthNTokens	UsernamePasswordAuthNTokens is used by AuthNMethods that wrap systems that authenticate via a Username/Password pair of strings.

Method Summary

object AuthNTokens (object Properties $configuration)

string getIdentifier ()

mixed getTokens ()

void initializeForIdentifier (string $identifier)

void initializeForTokens (mixed $tokens)

Methods

Constructor AuthNTokens (line 46)

Constructor. Stores the configuration.

since: 3/1/05
access: public

object AuthNTokens (object Properties $configuration)

object Properties $configuration

getIdentifier (line 85)

Return the identifier string for this instance.

since: 3/1/05
access: public

string getIdentifier ()

getTokens (line 96)

Return properly formatted tokens for this instance.

since: 3/1/05
access: public

mixed getTokens ()

initializeForIdentifier (line 73)

Initialize this object for an identifier. The identifier is often a username, but can be any string as long as it is unique within a given AuthNMethod.

since: 3/1/05
access: public

void initializeForIdentifier (string $identifier)

string $identifier

Redefined in descendants as:

UsernamePasswordAuthNTokens::initializeForIdentifier() : Initialize this object for an identifier. The identifier is often a username, but can be any string as long as it is unique within a given AuthNMethod.

initializeForTokens (line 58)

Initialize this object for a set of authentication tokens.

since: 3/1/05
access: public

void initializeForTokens (mixed $tokens)

mixed $tokens

Redefined in descendants as:

UsernamePasswordAuthNTokens::initializeForTokens() : Initialize this object for a set of authentication tokens.
CryptUsernamePasswordAuthNTokens::initializeForTokens() : Initialize this object for a set of authentication tokens. Set the password to the encrypted version.
LDAPAuthNTokens::initializeForTokens() : Initialize this object for a set of authentication tokens. The identifier is the user's CN, but they may have passed a username or email as part of their tokens instead.
SQLDatabaseMD5UsernamePasswordAuthNTokens::initializeForTokens() : Initialize this object for a set of authentication tokens. Set the password to the encrypted version.
SQLDatabaseSHA1UsernamePasswordAuthNTokens::initializeForTokens() : Initialize this object for a set of authentication tokens. Set the password to the encrypted version.