com.warrenstrange.googleauth

Class GoogleAuthenticatorKey

java.lang.Object

com.warrenstrange.googleauth.GoogleAuthenticatorKey

public final class GoogleAuthenticatorKey
extends Object

This class is a JavaBean used by the GoogleAuthenticator library to represent a secret key.

This class is immutable.

Instance of this class should only be constructed by the GoogleAuthenticator library.

Since:

1.0

Version:

1.0

Author:

Enrico M. Crisostomo

See Also:

GoogleAuthenticator

Method Summary

Modifier and Type	Method and Description
String	getKey() Returns the secret key in Base32 encoding.
static String	getQRBarcodeURL(String user, String host, String secret) Deprecated. Use GoogleAuthenticatorQRGenerator##getOtpAuthURL instead.
List<Integer>	getScratchCodes() Get the list of scratch codes.
int	getVerificationCode() Returns the verification code at time = 0 (the UNIX epoch).

Methods inherited from class java.lang.Object

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

Method Detail

getQRBarcodeURL

public static String getQRBarcodeURL(String user,
                                     String host,
                                     String secret)

Deprecated. Use GoogleAuthenticatorQRGenerator##getOtpAuthURL instead.

Returns the URL of a Google-provided QR barcode to be loaded into the Google Authenticator application. The user scans this bar code with the application on their smart phones or manually enter the secret manually.

Parameters:

user - the user to assign the secret key to.

host - the host to assign the secret key to.

secret - the secret key in Base32 encoding.

Returns:

the URL of a Google-provided QR barcode to be loaded into the Google Authenticator application.

getScratchCodes

public List<Integer> getScratchCodes()

Get the list of scratch codes.

Returns:

the list of scratch codes.

getKey

public String getKey()

Returns the secret key in Base32 encoding.

Returns:

the secret key in Base32 encoding.

getVerificationCode

public int getVerificationCode()

Returns the verification code at time = 0 (the UNIX epoch).

Returns:

the verificationCode at time = 0 (the UNIX epoch).