Class Authenticator

Description

Authentication subsystems main class

The authentication subsystems contains of a AutenticationMechanism which is a module that does the authentication and a AuthenticationUserInfoProvider which provides information (mainly a numeric userID) about a user and is used by the AuthorizationManager.

For password (plain) based authentication a AuthenticationPasswordBackend is used to verify the given credentials (this is done by the AuthenticationMechanism if needed.

Once a request has been authenticated the request is considered authenticated (even on logout).

To specifiy which of the modules/mechanisms/backends to use there are several virtual module classes you can bind: * auth.mech.<RequestHandlerClassName> - A authentication mechanism for a given reqest handler * auth.mech - The authentication mechanism used * auth.userinfo - The userinfo provider (provides username to numeric UID mapping) * auth.password.backend - If a plain, password based mechanism is chosen is used to verify the given password

Located in /phpsatk-lib/global/org.eenterphace.sat.authentication/authenticator.php (line 53)


	
			
Method Summary
Methods
authenticated (line 99)

Checks whether the request is authenticated

If not authenticated the remote user is to be considered as a guest. This might not work the way expected for some mechanisms as they might require prompting the user for a password (HTTP authentication schemes).

  • static:
  • access: public
boolean authenticated ()
getUsername (line 149)

Gets the username of the authenticated user

Returns the guest user for unauthenticated sessions.

  • access: public
  • static:
string getUsername ()
getUserObject (line 162)

Retrieves information about a user

  • access: public
  • static:
AuthorizationUser getUserObject ()
initialize (line 74)

Initializes the used authentication mechanism

  • static:
  • access: public
void initialize ()
logOut (line 186)

Invalidates the current authentication session

By now only calls just calls the frontends logout method but we may also notify the backend or some other interested classes.

  • static:
  • access: public
void logOut ()
requireAuthentication (line 127)

Checks authentication of the user

If prompting is available the user will be prompted for authentication if not logged in already.

Finally if something goes wrong, access is denied.

  • static:
  • access: public
void requireAuthentication ()

Documentation generated on Mon, 21 May 2007 10:34:43 +0200 by phpDocumentor 1.3.0RC5