Index
A B C G H I K R S V
All Classes|All Packages
All Classes|All Packages
All Classes|All Packages
A
- authorize(String, int) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- authorize(String, int) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
Checks a verification code against a secret key using the current time.
- authorize(String, int, long) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- authorize(String, int, long) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
Checks a verification code against a secret key using the specified time.
- authorizeUser(String, int) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- authorizeUser(String, int) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method validates a verification code of the specified user whose private key is retrieved from the configured credential repository using the current time.
- authorizeUser(String, int, long) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- authorizeUser(String, int, long) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method validates a verification code of the specified user whose private key is retrieved from the configured credential repository.
B
- BASE32 - com.warrenstrange.googleauth.KeyRepresentation
- BASE64 - com.warrenstrange.googleauth.KeyRepresentation
- build() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder
- build() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorKey.Builder
-
Creates an instance of the
GoogleAuthenticatorKeyclass. - Builder(String) - Constructor for class com.warrenstrange.googleauth.GoogleAuthenticatorKey.Builder
-
Creates an instance of the builder.
C
- com.warrenstrange.googleauth - package com.warrenstrange.googleauth
- createCredentials() - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- createCredentials() - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method generates a new set of credentials including: Secret key. Validation code. A list of scratch codes.
- createCredentials(String) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- createCredentials(String) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method generates a new set of credentials invoking the
#createCredentialsmethod with no arguments.
G
- getCodeDigits() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig
-
Returns the number of digits in the generated code.
- getConfig() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorKey
-
Get the config of this key.
- getCredentialRepository() - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
-
This method loads the first available ICredentialRepository registered using the Java service loader API.
- getCredentialRepository() - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method returns the credential repository used by this instance, or
nullif none is set or none can be found using the ServiceLoader API. - getHmacHashFunction() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig
-
Returns the cryptographic hash function used to calculate the HMAC (Hash-based Message Authentication Code).
- getKey() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorKey
-
Returns the secret key in Base32 encoding.
- getKeyModulus() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig
-
Returns the key module.
- getKeyRepresentation() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig
-
Returns the key representation.
- getNumberOfScratchCodes() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig
-
Returns the number of scratch codes to generate.
- getOtpAuthTotpURL(String, String, GoogleAuthenticatorKey) - Static method in class com.warrenstrange.googleauth.GoogleAuthenticatorQRGenerator
-
Returns the basic otpauth TOTP URI.
- getOtpAuthURL(String, String, GoogleAuthenticatorKey) - Static method in class com.warrenstrange.googleauth.GoogleAuthenticatorQRGenerator
-
Returns the URL of a Google Chart API call to generate a QR barcode to be loaded into the Google Authenticator application.
- getScratchCodes() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorKey
-
Get the list of scratch codes.
- getSecretBits() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig
-
Returns the number of bits of the secret keys to generate.
- getSecretKey(String) - Method in interface com.warrenstrange.googleauth.ICredentialRepository
-
This method retrieves the Base32-encoded private key of the given user.
- getTimeStepSizeInMillis() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig
-
Returns the time step size, in milliseconds, as specified by RFC 6238.
- getTotpPassword(String) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- getTotpPassword(String) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method generates the current TOTP password.
- getTotpPassword(String, long) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- getTotpPassword(String, long) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method generates the TOTP password at the specified time.
- getTotpPasswordOfUser(String) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- getTotpPasswordOfUser(String) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method generates the current TOTP password.
- getTotpPasswordOfUser(String, long) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- getTotpPasswordOfUser(String, long) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method generates the TOTP password at the specified time.
- getVerificationCode() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorKey
-
Returns the verification code at time = 0 (the UNIX epoch).
- getWindowSize() - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig
-
Returns an integer value representing the number of windows of size timeStepSizeInMillis that are checked during the validation process, to account for differences between the server and the client clocks.
- GoogleAuthenticator - Class in com.warrenstrange.googleauth
-
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.
- GoogleAuthenticator() - Constructor for class com.warrenstrange.googleauth.GoogleAuthenticator
- GoogleAuthenticator(GoogleAuthenticatorConfig) - Constructor for class com.warrenstrange.googleauth.GoogleAuthenticator
- GoogleAuthenticatorConfig - Class in com.warrenstrange.googleauth
- GoogleAuthenticatorConfig() - Constructor for class com.warrenstrange.googleauth.GoogleAuthenticatorConfig
- GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder - Class in com.warrenstrange.googleauth
- GoogleAuthenticatorConfigBuilder() - Constructor for class com.warrenstrange.googleauth.GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder
- GoogleAuthenticatorException - Exception in com.warrenstrange.googleauth
-
Date: 12/02/14 Time: 13:36
- GoogleAuthenticatorException(String) - Constructor for exception com.warrenstrange.googleauth.GoogleAuthenticatorException
-
Builds an exception with the provided error message.
- GoogleAuthenticatorException(String, Throwable) - Constructor for exception com.warrenstrange.googleauth.GoogleAuthenticatorException
-
Builds an exception with the provided error mesasge and the provided cuase.
- GoogleAuthenticatorKey - Class in com.warrenstrange.googleauth
-
This class is a JavaBean used by the GoogleAuthenticator library to represent a secret key.
- GoogleAuthenticatorKey.Builder - Class in com.warrenstrange.googleauth
-
This class is a builder to create instances of the
GoogleAuthenticatorKeyclass. - GoogleAuthenticatorQRGenerator - Class in com.warrenstrange.googleauth
-
This class provides helper methods to create a QR code containing the provided credential.
- GoogleAuthenticatorQRGenerator() - Constructor for class com.warrenstrange.googleauth.GoogleAuthenticatorQRGenerator
H
- HmacHashFunction - Enum in com.warrenstrange.googleauth
- HmacSHA1 - com.warrenstrange.googleauth.HmacHashFunction
- HmacSHA256 - com.warrenstrange.googleauth.HmacHashFunction
- HmacSHA512 - com.warrenstrange.googleauth.HmacHashFunction
I
- ICredentialRepository - Interface in com.warrenstrange.googleauth
- IGoogleAuthenticator - Interface in com.warrenstrange.googleauth
-
Google Authenticator library interface.
K
R
- RNG_ALGORITHM - Static variable in class com.warrenstrange.googleauth.GoogleAuthenticator
-
The system property to specify the random number generator algorithm to use.
- RNG_ALGORITHM_PROVIDER - Static variable in class com.warrenstrange.googleauth.GoogleAuthenticator
-
The system property to specify the random number generator provider to use.
S
- saveUserCredentials(String, String, int, List<Integer>) - Method in interface com.warrenstrange.googleauth.ICredentialRepository
-
This method saves the user credentials.
- SCRATCH_CODE_MODULUS - Static variable in class com.warrenstrange.googleauth.GoogleAuthenticator
-
Modulus used to truncate the scratch code.
- setCodeDigits(int) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder
- setConfig(GoogleAuthenticatorConfig) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorKey.Builder
-
Sets the config of the TOTP algorithm for this key.
- setCredentialRepository(ICredentialRepository) - Method in class com.warrenstrange.googleauth.GoogleAuthenticator
- setCredentialRepository(ICredentialRepository) - Method in interface com.warrenstrange.googleauth.IGoogleAuthenticator
-
This method sets the credential repository used by this instance.
- setHmacHashFunction(HmacHashFunction) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder
- setKey(String) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorKey.Builder
-
Sets the secret key.
- setKeyRepresentation(KeyRepresentation) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder
- setNumberOfScratchCodes(int) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder
- setScratchCodes(List<Integer>) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorKey.Builder
-
Sets the scratch codes.
- setSecretBits(int) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder
- setTimeStepSizeInMillis(long) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder
- setVerificationCode(int) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorKey.Builder
-
Sets the verification code.
- setWindowSize(int) - Method in class com.warrenstrange.googleauth.GoogleAuthenticatorConfig.GoogleAuthenticatorConfigBuilder
V
- valueOf(String) - Static method in enum com.warrenstrange.googleauth.HmacHashFunction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.warrenstrange.googleauth.KeyRepresentation
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.warrenstrange.googleauth.HmacHashFunction
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.warrenstrange.googleauth.KeyRepresentation
-
Returns an array containing the constants of this enum type, in the order they are declared.
All Classes|All Packages