Package com.sun.identity.authentication.modules.radius

Class RADIUS

java.lang.Object

com.sun.identity.authentication.spi.AMLoginModule

com.sun.identity.authentication.modules.radius.RADIUS

All Implemented Interfaces:

LoginModule

public class RADIUS
extends AMLoginModule

An authentication module that defers to remote radius servers to validate username and password. It includes admin console configuration pages for identifying the remote servers and various parameters.

Field Summary

Fields inherited from class com.sun.identity.authentication.spi.AMLoginModule

amCache, auditor, currentState

Constructor Summary

Constructors

Constructor	Description
RADIUS()

Method Summary

Modifier and Type	Method	Description
void	destroyModuleState()	Destroy the module state.
Principal	getPrincipal()	Returns java.security.Principal.
void	init(Subject subject, Map sharedState, Map options)	Initializes this LoginModule.
void	nullifyUsedVars()	Set all the used variables to null.
int	process(Callback[] callbacks, int state)	Takes an array of submitted Callback, process them and decide the order of next state to go.
protected void	readAttributesFromResponsePacket(Packet response)	Extension point to handle additional response attributes
void	shutdown()	Shutdown the RADIUS connection.

Methods inherited from class com.sun.identity.authentication.spi.AMLoginModule

abort, clearInfoText, commit, createIdentity, forceCallbacksInit, getAMIdentityRepository, getAttribute, getAuditEntryDetail, getAuthenticatedPrincipals, getAuthLevel, getCallback, getCallback, getCallbackHandler, getCurrentState, getFailCount, getHttpServletRequest, getHttpServletResponse, getInfoText, getLocale, getLoginLocale, getLoginState, getMaximumFailCount, getNewUserIDs, getNumberOfStates, getOrgProfile, getOrgServiceTemplate, getPwdKey, getRequestOrg, getServiceConfig, getSessionId, getSSOSession, getUserAliasList, getUserKey, getUserProfile, getUserSessionProperty, getUserSessions, incrementFailCount, initialize, isAccountLocked, isDynamicProfileCreationEnabled, isRequired, isSessionQuotaReached, isSharedStateEnabled, isSuperAdmin, isUseFirstPassEnabled, isValidUserEntry, login, logout, replaceCallback, replaceHeader, resetCallback, resetCurrentState, setAuthLevel, setFailureID, setForceCallbacksRead, setLoginFailureURL, setLoginSuccessURL, setModuleErrorTemplate, setOrg, setSharedStateEnabled, setUserAttributes, setUserSessionProperty, storeUsername, storeUsernamePasswd, substituteHeader, substituteInfoText, validatePassword, validateUserName

Methods inherited from class java.lang.Object

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

Constructor Detail

RADIUS

public RADIUS()

Method Detail

init

public void init(Subject subject,
                 Map sharedState,
                 Map options)

Initializes this LoginModule.

Specified by:

init in class AMLoginModule

Parameters:

subject - the Subject to be authenticated.

sharedState - shared LoginModule state.

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

process

public int process(Callback[] callbacks,
                   int state)
            throws AuthLoginException

Takes an array of submitted Callback, process them and decide the order of next state to go. Return STATE_SUCCEED if the login is successful, return STATE_FAILED if the LoginModule should be ignored.

Specified by:

process in class AMLoginModule

Parameters:

callbacks - an array of Callback for this Login state

state - order of state. State order starts with 1.

Returns:

int order of next state. Return STATE_SUCCEED if authentication is successful, return STATE_FAILED if the LoginModule should be ignored.

Throws:

AuthLoginException - if the user fails authentication or some anomalous condition occurs

readAttributesFromResponsePacket

protected void readAttributesFromResponsePacket(Packet response)
                                         throws AuthLoginException

Extension point to handle additional response attributes

Parameters:

response - the RADIUS authentication response packet

Throws:

AuthLoginException - exception thrown if login has to fail based on additional attributes

getPrincipal

public Principal getPrincipal()

Returns java.security.Principal.

Specified by:

getPrincipal in class AMLoginModule

Returns:

java.security.Principal

destroyModuleState

public void destroyModuleState()

Destroy the module state.

Overrides:

destroyModuleState in class AMLoginModule

nullifyUsedVars

public void nullifyUsedVars()

Set all the used variables to null.

Overrides:

nullifyUsedVars in class AMLoginModule

shutdown

public void shutdown()

Shutdown the RADIUS connection.