io.polaris.core.crypto.otp

接口 IGoogleAuthenticator

所有已知实现类:

GoogleAuthenticator

public interface IGoogleAuthenticator

Google Authenticator library interface.

另请参阅:

GoogleAuth

方法概要

限定符和类型	方法和说明
boolean	authorize(String secret, int verificationCode) Checks a verification code against a secret key using the current time.
boolean	authorize(String secret, int verificationCode, long time) Checks a verification code against a secret key using the specified time.
GoogleAuthenticatorKey	createCredentials() This method generates a new set of credentials including: Secret key.
GoogleAuthenticatorKey	createCredentials(String userName) This method generates a new set of credentials invoking the #createCredentials method with no arguments.
int	getTotpPassword(String secret) This method generates the current TOTP password.
int	getTotpPassword(String secret, long time) This method generates the TOTP password at the specified time.

方法详细资料

createCredentials

GoogleAuthenticatorKey createCredentials()

This method generates a new set of credentials including:

1. Secret key.
2. Validation code.
3. A list of scratch codes.

The user must register this secret on their device.

返回:

secret key

createCredentials

GoogleAuthenticatorKey createCredentials(String userName)

This method generates a new set of credentials invoking the #createCredentials method with no arguments. The generated credentials are then saved using the configured #ICredentialRepository service.

The user must register this secret on their device.

参数:

userName - the user name.

返回:

secret key

getTotpPassword

int getTotpPassword(String secret)

This method generates the current TOTP password.

参数:

secret - the encoded secret key.

返回:

the current TOTP password.

getTotpPassword

int getTotpPassword(String secret,
                    long time)

This method generates the TOTP password at the specified time.

参数:

secret - The encoded secret key.

time - The time to use to calculate the password.

返回:

the TOTP password at the specified time.

authorize

boolean authorize(String secret,
                  int verificationCode)

Checks a verification code against a secret key using the current time.

参数:

secret - the encoded secret key.

verificationCode - the verification code.

返回:

true if the validation code is valid, false otherwise.

抛出:

GoogleAuthenticatorException - if a failure occurs during the calculation of the validation code. The only failures that should occur are related with the cryptographic functions provided by the JCE.

另请参阅:

authorize(String, int, long)

authorize

boolean authorize(String secret,
                  int verificationCode,
                  long time)

Checks a verification code against a secret key using the specified time. The algorithm also checks in a time window whose size determined by the windowSize property of this class.

The default value of 30 seconds recommended by RFC 6238 is used for the interval size.

参数:

secret - The encoded secret key.

verificationCode - The verification code.

time - The time to use to calculate the TOTP password..

返回:

true if the validation code is valid, false otherwise.

抛出:

GoogleAuthenticatorException - if a failure occurs during the calculation of the validation code. The only failures that should occur are related with the cryptographic functions provided by the JCE.