org.forgerock.openam.authentication.modules.fr.oath

Class AuthenticatorOATH

java.lang.Object

com.sun.identity.authentication.spi.AMLoginModule

org.forgerock.openam.authentication.modules.fr.oath.AuthenticatorOATH

All Implemented Interfaces:

LoginModule

public class AuthenticatorOATH
extends AMLoginModule

Implements the OATH specification. OATH uses a OTP to authenticate a token to the server. This class implements two of OATH's protocols for OTP generation and authentication; HMAC-based One Time Password (HOTP) and Time-based One Time Password (TOTP).

Field Summary

Fields

Modifier and Type	Field and Description
protected String	amAuthOATH
protected Debug	debug

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

amCache, auditor, currentState

Constructor Summary

Constructors

Constructor and Description
AuthenticatorOATH() Standard constructor sets-up the debug logging module.

Method Summary

Modifier and Type	Method and Description
void	destroyModuleState() Called to cleanup the class level variables.
Principal	getPrincipal() Returns the principal for this module.
void	init(Subject subject, Map sharedState, Map options) Initializes the authentication module.
void	nullifyUsedVars() Called to cleanup the class level variables that won't be used again.
int	process(Callback[] callbacks, int state) Processes the OTP input by the user.

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

Field Detail

debug

protected Debug debug

amAuthOATH

protected String amAuthOATH

Constructor Detail

AuthenticatorOATH

public AuthenticatorOATH()

Standard constructor sets-up the debug logging module.

Method Detail

getPrincipal

public Principal getPrincipal()

Returns the principal for this module. This class is overridden from AMLoginModule.

Specified by:

getPrincipal in class AMLoginModule

Returns:

Principal of the authenticated user.

init

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

Initializes the authentication module. This function gets the modules settings, and the username from the previous authentication module in the chain.

Specified by:

init in class AMLoginModule

Parameters:

subject - For whom this module is initializing.

sharedState - Previously chained module data.

options - Configuration for this module.

process

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

Processes the OTP input by the user. Checks the OTP for validity, and resynchronizes the server as needed.

Specified by:

process in class AMLoginModule

Parameters:

callbacks - Incoming from the UI.

state - State of the module to process this access.

Returns:

-1 for success; 0 for failure, any other int to move to that state.

Throws:

AuthLoginException - upon any errors.

destroyModuleState

public void destroyModuleState()

Called to cleanup the class level variables.

Overrides:

destroyModuleState in class AMLoginModule

nullifyUsedVars

public void nullifyUsedVars()

Called to cleanup the class level variables that won't be used again.

Overrides:

nullifyUsedVars in class AMLoginModule