com.webmethods.portal.framework.auth.totp

Interface ITOTPConfiguration

public interface ITOTPConfiguration

Method Summary

Modifier and Type	Method and Description
Object	clone()
boolean	enabled() Whether this configuration is active
String	getClientId() Provides TOTP Client Identifier
String	getRoleName()
List<Integer>	getScratchCodes() Randomly generated data that are optionally used as 'recovery passwords' in case the token generator is not available.
String	getUserServiceName()
int	getValidationCode()
int	getWindowSize()
void	setClientId(String clientId) Sets new TOTP Client Identifier
void	setRoleName(String roleName) Sets the name of the role which members are subject to TOTP authorization
void	setServiceEnabled(boolean serviceEnabled) Activates or disables this configuration
void	setSyncWindowSize(int syncWindowSize) Sets the number of time-step windows that should be checked during the validation process
void	setTotpServiceName(String totpServiceName) Sets the name of the One-Time Password service, responsible for two-factor identification

Method Detail

getClientId

String getClientId()
            throws Exception

Provides TOTP Client Identifier

Throws:

Exception

setClientId

void setClientId(String clientId)

Sets new TOTP Client Identifier

getValidationCode

int getValidationCode()
               throws Exception

Returns:

TOTP password at timestep 0 (the Unix Epoch).

Throws:

Exception

getScratchCodes

List<Integer> getScratchCodes()
                       throws Exception

Randomly generated data that are optionally used as 'recovery passwords' in case the token generator is not available. Generated together with the shared secret using the same, cryptographically strong pseudorandom generator

Returns:

A list of scratch codes

Throws:

Exception

enabled

boolean enabled()
         throws Exception

Whether this configuration is active

Throws:

Exception

setServiceEnabled

void setServiceEnabled(boolean serviceEnabled)

Activates or disables this configuration

getWindowSize

int getWindowSize()
           throws Exception

Returns:

Number of time-step windows that should be checked during the validation process

Throws:

Exception

setSyncWindowSize

void setSyncWindowSize(int syncWindowSize)

Sets the number of time-step windows that should be checked during the validation process

getUserServiceName

String getUserServiceName()
                   throws Exception

Returns:

The name of the One-Time Password service, responsible for two-factor identification

Throws:

Exception

setTotpServiceName

void setTotpServiceName(String totpServiceName)

Sets the name of the One-Time Password service, responsible for two-factor identification

getRoleName

String getRoleName()
            throws Exception

Returns:

The name of the role which members are subject to TOTP authorization

Throws:

Exception

setRoleName

void setRoleName(String roleName)

Sets the name of the role which members are subject to TOTP authorization

clone

Object clone()
      throws CloneNotSupportedException

Throws:

CloneNotSupportedException