io.polaris.core.crypto.otp

类 GoogleAuthenticator

java.lang.Object

io.polaris.core.crypto.otp.GoogleAuthenticator

所有已实现的接口:

IGoogleAuthenticator

public final class GoogleAuthenticator
extends Object
implements IGoogleAuthenticator

This class implements the functionality described in RFC 6238 (TOTP: Time based one-time password algorithm) and has been tested again Google's implementation of such algorithm in its Google Authenticator application.

This class lets users create a new 16-bit base32-encoded secret key with the validation code calculated at time = 0 (the UNIX epoch) and the URL of a Google-provided QR barcode to let an user load the generated information into Google Authenticator.

The random number generator used by this class uses the default algorithm and provider. Users can override them by setting the following system properties to the algorithm and provider name of their choice:

• RNG_ALGORITHM_KEY.
• RNG_ALGORITHM_PROVIDER_KEY.

This class does not store in any way either the generated keys nor the keys passed during the authorization process.

Java Server side class for Google Authenticator's TOTP generator was inspired by an author's blog post.

作者:

Enrico M. Crisostomo, Warren Strange

另请参阅:

, ,

字段概要

字段

限定符和类型	字段和说明
static String	RNG_ALGORITHM_KEY
static String	RNG_ALGORITHM_PROVIDER_KEY
static int	SCRATCH_CODE_MODULUS Modulus used to truncate the scratch code.

构造器概要

构造器

构造器和说明
GoogleAuthenticator()
GoogleAuthenticator(GoogleAuthenticatorConfig config)
GoogleAuthenticator(GoogleAuthenticatorConfig config, String randomNumberAlgorithm, String randomNumberAlgorithmProvider)
GoogleAuthenticator(String randomNumberAlgorithm, String randomNumberAlgorithmProvider)

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 java.lang.Object

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

字段详细资料

RNG_ALGORITHM_KEY

public static final String RNG_ALGORITHM_KEY

另请参阅:

常量字段值

RNG_ALGORITHM_PROVIDER_KEY

public static final String RNG_ALGORITHM_PROVIDER_KEY

另请参阅:

常量字段值

SCRATCH_CODE_MODULUS

public static final int SCRATCH_CODE_MODULUS

Modulus used to truncate the scratch code.

构造器详细资料

GoogleAuthenticator

public GoogleAuthenticator()

GoogleAuthenticator

public GoogleAuthenticator(GoogleAuthenticatorConfig config)

GoogleAuthenticator

public GoogleAuthenticator(String randomNumberAlgorithm,
                           String randomNumberAlgorithmProvider)

GoogleAuthenticator

public GoogleAuthenticator(GoogleAuthenticatorConfig config,
                           String randomNumberAlgorithm,
                           String randomNumberAlgorithmProvider)

方法详细资料

createCredentials

public GoogleAuthenticatorKey createCredentials()

从接口复制的说明: IGoogleAuthenticator

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.

指定者:

createCredentials 在接口中 IGoogleAuthenticator

返回:

secret key

createCredentials

public GoogleAuthenticatorKey createCredentials(String userName)

从接口复制的说明: IGoogleAuthenticator

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.

指定者:

createCredentials 在接口中 IGoogleAuthenticator

参数:

userName - the user name.

返回:

secret key

getTotpPassword

public int getTotpPassword(String secret)

从接口复制的说明: IGoogleAuthenticator

This method generates the current TOTP password.

指定者:

getTotpPassword 在接口中 IGoogleAuthenticator

参数:

secret - the encoded secret key.

返回:

the current TOTP password.

getTotpPassword

public int getTotpPassword(String secret,
                           long time)

从接口复制的说明: IGoogleAuthenticator

This method generates the TOTP password at the specified time.

指定者:

getTotpPassword 在接口中 IGoogleAuthenticator

参数:

secret - The encoded secret key.

time - The time to use to calculate the password.

返回:

the TOTP password at the specified time.

authorize

public boolean authorize(String secret,
                         int verificationCode)

从接口复制的说明: IGoogleAuthenticator

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

指定者:

authorize 在接口中 IGoogleAuthenticator

参数:

secret - the encoded secret key.

verificationCode - the verification code.

返回:

true if the validation code is valid, false otherwise.

另请参阅:

IGoogleAuthenticator.authorize(String, int, long)

authorize

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

从接口复制的说明: IGoogleAuthenticator

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.

指定者:

authorize 在接口中 IGoogleAuthenticator

参数:

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.