Package com.bastiaanjansen.otp

Class OTPGenerator.Builder<B,G>

java.lang.Object

com.bastiaanjansen.otp.OTPGenerator.Builder<B,G>

Type Parameters:

B - concrete builder class

Direct Known Subclasses:

HOTPGenerator.Builder, TOTPGenerator.Builder

Enclosing class:

OTPGenerator

public abstract static class OTPGenerator.Builder<B,G>
extends Object

Abstract OTP builder

Author:

Bastiaan Jansen

Field Summary

Fields

Modifier and Type	Field	Description
protected HMACAlgorithm	algorithm	Hashing algorithm used to generate code, defaults to SHA1
static HMACAlgorithm	DEFAULT_HMAC_ALGORITHM	Default value for HMAC Algorithm
static int	DEFAULT_PASSWORD_LENGTH	Default value for password length
protected int	passwordLength	Number of digits for generated code in range 6...8, defaults to 6
protected byte[]	secret	Secret key used to generate the code, this should be a base32 string

Constructor Summary

Constructors

Constructor	Description
Builder(byte[] secret)

Method Summary

Modifier and Type	Method	Description
abstract G	build()
HMACAlgorithm	getAlgorithm()
abstract B	getBuilder()
int	getPasswordLength()
byte[]	getSecret()
B	withAlgorithm(HMACAlgorithm algorithm)	Change hashing algorithm
B	withPasswordLength(int passwordLength)	Change password length of code

Methods inherited from class java.lang.Object

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

Field Details

passwordLength

protected int passwordLength

Number of digits for generated code in range 6...8, defaults to 6

algorithm

protected HMACAlgorithm algorithm

Hashing algorithm used to generate code, defaults to SHA1

secret

protected byte[] secret

Secret key used to generate the code, this should be a base32 string

DEFAULT_PASSWORD_LENGTH

public static final int DEFAULT_PASSWORD_LENGTH

Default value for password length

See Also:

Constant Field Values

DEFAULT_HMAC_ALGORITHM

public static final HMACAlgorithm DEFAULT_HMAC_ALGORITHM

Default value for HMAC Algorithm

Constructor Details

Builder

public Builder(byte[] secret)

Method Details

withPasswordLength

public B withPasswordLength(int passwordLength)

Change password length of code

Parameters:

passwordLength - number of digits for generated code in range 6...8

Returns:

concrete builder

withAlgorithm

public B withAlgorithm(HMACAlgorithm algorithm)

Change hashing algorithm

Parameters:

algorithm - HMAC hashing algorithm

Returns:

concrete builder

getSecret

public byte[] getSecret()

getPasswordLength

public int getPasswordLength()

getAlgorithm

public HMACAlgorithm getAlgorithm()

getBuilder

public abstract B getBuilder()

build

public abstract G build()