com.cafesoft.cams.auth.login.module
Class AESOXmlLoginModule

java.lang.Object
  com.cafesoft.cams.auth.login.module.AESOXmlLoginModule

All Implemented Interfaces:

LoggerClient, ServiceClient, LoginModule

public class AESOXmlLoginModule
extends Object
implements LoginModule, ServiceClient, LoggerClient

AESOXmlLoginModule implements the JAAS LoginModule interface and works in conjunction with Cams "Automatic Enterprise Sign-On" (AESO) to authenticate users and assign roles using information stored in a XML user repository. This particular implementation uses a ServiceFinder object to access the XML user repository.

NOTE: This login module is appropriate for simple sites with a small number of users or for Cams development and testing.

If support for one of these two authentication mechanisms is not configured, the this login module will successfully authenticate the user named in the "username" callback value and assign roles as configured in the XML user repository.

All configuration parameters are listed below:

• serviceId - The unique name of the XML User Repository Service that you are assigning to this login module.
• debug - Flag that enables/disables debugging.
• agentSecret - The expected value for the "agent_secret" callback value, which must be present in the authentication request. This value is used to authenticated Cams agents, which assert the identity of a user already authenticated at the web layer. The agent secret is used to protect against impersonation attacks via carefully created HTTP requests attempting to subvert AESO component trust relationships.
• defaultRoles - (Optional) A list of one or more default roles separated by a comma to be added to the user session on successful authentication.

Since:

09/23/2008

See Also:

Subject, CallbackHandler, LoginModule

Constructor Summary

AESOXmlLoginModule()
Default AESOXmlLoginModule Constructor.

Method Summary

boolean	abort() Method to abort the authentication process (phase 2).
boolean	commit() Method to commit the authentication process (phase 2).
void	initialize(Subject subject, CallbackHandler callbackHandler, Map sharedState, Map options) Initialize this LoginModule.
boolean	login() Method to authenticate a Subject (phase 1).
boolean	logout() Method which logs out a Subject.
void	setLogger(Logger logger) Sets the logger.
void	setServiceFinder(ServiceFinder finder) Set the ServiceFinder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AESOXmlLoginModule

public AESOXmlLoginModule()

Default AESOXmlLoginModule Constructor.

Method Detail

setServiceFinder

public void setServiceFinder(ServiceFinder finder)

Set the ServiceFinder.

Specified by:

setServiceFinder in interface ServiceClient

Parameters:

finder - the class used by find Services by the ServiceClient.

setLogger

public void setLogger(Logger logger)

Sets the logger.

Specified by:

setLogger in interface LoggerClient

Parameters:

logger - logs messages

initialize

public void initialize(Subject subject,
                       CallbackHandler callbackHandler,
                       Map sharedState,
                       Map options)

Initialize this LoginModule.

This method is called by the LoginContext after this LoginModule has been instantiated. The purpose of this method is to initialize this LoginModule with the relevant information. If this LoginModule does not understand any of the data stored in sharedState or options parameters, they can be ignored.

Specified by:

initialize in interface LoginModule

Parameters:

subject - the Subject to be authenticated.

callbackHandler - a CallbackHandler for communicating with the end user (prompting for usernames and passwords, for example).

sharedState - state shared with other configured LoginModules.

options - options specified in the login Configuration for this particular LoginModule.

login

public boolean login()
              throws LoginException

Method to authenticate a Subject (phase 1).

The implementation of this method authenticates a Subject. For example, it may prompt for Subject information such as a username and password and then attempt to verify the password. This method saves the result of the authentication attempt as private state within the LoginModule.

Specified by:

login in interface LoginModule

Returns:

true if the authentication succeeded, or false if this LoginModule should be ignored.

Throws:

LoginException - if the authentication fails

commit

public boolean commit()
               throws LoginException

Method to commit the authentication process (phase 2).

This method is called if the LoginContext's overall authentication succeeded (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules succeeded).

If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method associates relevant Principals and Credentials with the Subject located in the LoginModule. If this LoginModule's own authentication attempted failed, then this method removes/destroys any state that was originally saved.

Specified by:

commit in interface LoginModule

Returns:

true if this method succeeded, or false if this LoginModule should be ignored.

Throws:

LoginException - if the commit fails

abort

public boolean abort()
              throws LoginException

Method to abort the authentication process (phase 2).

This method is called if the LoginContext's overall authentication failed. (the relevant REQUIRED, REQUISITE, SUFFICIENT and OPTIONAL LoginModules did not succeed).

If this LoginModule's own authentication attempt succeeded (checked by retrieving the private state saved by the login method), then this method cleans up any state that was originally saved.

Specified by:

abort in interface LoginModule

Returns:

true if this method succeeded, or false if this LoginModule should be ignored.

Throws:

LoginException - if the abort fails

logout

public boolean logout()
               throws LoginException

Method which logs out a Subject.

An implementation of this method might remove/destroy a Subject's Principals and Credentials.

Specified by:

logout in interface LoginModule

Returns:

true if this method succeeded, or false if this LoginModule should be ignored.

Throws:

LoginException - if the logout fails