com.webmethods.portal.framework.auth.totp

Interface ITOTPAuthenticator

public interface ITOTPAuthenticator

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TIME_STEP_SIZE
static int	DEFAULT_WINDOW_SIZE

Method Summary

Modifier and Type	Method and Description
boolean	authorize(String userName, int verificationCode) Checks a verification code against a secret key the specified time.
ITOTPAuthenticatorKey	createCredentials(String userName) Computes a new random shared secret along with verification code and scratch codes.

Field Detail

DEFAULT_WINDOW_SIZE

static final int DEFAULT_WINDOW_SIZE

See Also:

Constant Field Values

DEFAULT_TIME_STEP_SIZE

static final int DEFAULT_TIME_STEP_SIZE

See Also:

Constant Field Values

Method Detail

createCredentials

ITOTPAuthenticatorKey createCredentials(String userName)
                                 throws Exception

Computes a new random shared secret along with verification code and scratch codes.

Parameters:

userName - The user name.

Returns:

ITOTPAuthenticatorKey Holding generated new random shared secret

Throws:

Exception

authorize

boolean authorize(String userName,
                  int verificationCode)
           throws Exception

Checks a verification code against a secret key the specified time.

Parameters:

userName - The user name.

verificationCode - The verification code of the specified user

Returns:

Whether verification code is valid against a secret key in a time window specified by ITOTPConfiguration

Throws:

Exception