com.gemalto.idp.mobile.otp.oath.soft

Interface SoftOathSettings

public interface SoftOathSettings

SoftOathSettings interface.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SoftOathSettings.OathHashAlgorithm Supported hash algorithms for HMAC computation
static class	SoftOathSettings.OathTimestepType Supported types of Time step.
static class	SoftOathSettings.OcraChallengeQuestionFormat Supported formats for the Question (Q) in the OCRA computation.
static class	SoftOathSettings.OcraPasswordHashAlgorithm Supported password hash algorithm.

Method Summary

Modifier and Type	Method and Description
void	setHotpHashAlgorithm(SoftOathSettings.OathHashAlgorithm hashAlgorithm) Set the HOTP hash algorithm.
void	setHotpLength(int otpLength) Set the HOTP length.
void	setOcraChallengeQuestionFormat(SoftOathSettings.OcraChallengeQuestionFormat challengeQuestionFormat) Set the format of the challenge question (Q)
void	setOcraCounterUsed(boolean useCounter) Enable/Disable the counter (C) in OCRA computation.
void	setOcraHashAlgorithm(SoftOathSettings.OathHashAlgorithm hashAlgorithm) Set the OCRA hash algorithm.
void	setOcraMaximumChallengeQuestionLength(int maxChallengeQuestionLength) Set the maximum challenge question length.
void	setOcraOtpLength(int otpLength) Set the OCRA OTP length.
void	setOcraPasswordHashAlgorithm(SoftOathSettings.OcraPasswordHashAlgorithm hashAlgorithm) Set the password Hash algorithm, set to OcraPasswordHashAlgorithm.NONE to not use it
void	setOcraSessionLength(int sessionLength) Set the maximum length in bytes of the Session (S) in UTF-8 encoding.
void	setOcraSuite(SecureString ocrasuite) Set the Ocra Suite, all the relevant OCRA settings will be set accordingly.
void	setOcraTimeSettings(SoftOathSettings.OathTimestepType timestepType, int timestepSize, long startTime) Set the OCRA time settings.
void	setTotpHashAlgorithm(SoftOathSettings.OathHashAlgorithm hashAlgorithm) Set the TOTP hash algorithm.
void	setTotpLength(int otpLength) Set the TOTP length.
void	setTotpStartTime(long startTime) Set the T0 value for TOTP computation.
void	setTotpTimestepSize(int timestepSize) Set the TOTP time step size.
void	setTotpTimestepType(SoftOathSettings.OathTimestepType timestepType) Set the TOTP time step type.

Method Detail

setHotpLength

void setHotpLength(int otpLength)

Set the HOTP length.

Parameters:

otpLength - the OTP length. Allowed range is 6-10 digits.

Throws:

IllegalArgumentException - when otpLength is not in allowed range.

Since:

4.0

setHotpHashAlgorithm

void setHotpHashAlgorithm(SoftOathSettings.OathHashAlgorithm hashAlgorithm)

Set the HOTP hash algorithm. HOTP only support SoftOathSettings.OathHashAlgorithm.SHA1 and SoftOathSettings.OathHashAlgorithm.SHA256 hash algorithm.

Parameters:

hashAlgorithm - the hmac algorithm.

Since:

4.0

setTotpLength

void setTotpLength(int otpLength)

Set the TOTP length.

Parameters:

otpLength - the OTP length. Allowed range is 6-10 digits.

Throws:

IllegalArgumentException - when otpLength is not in allowed range.

Since:

4.0

setTotpHashAlgorithm

void setTotpHashAlgorithm(SoftOathSettings.OathHashAlgorithm hashAlgorithm)

Set the TOTP hash algorithm.

Parameters:

hashAlgorithm - the hmac algorithm.

Since:

4.0

setTotpStartTime

void setTotpStartTime(long startTime)

Set the T0 value for TOTP computation.

Parameters:

startTime - value to start counting time steps. Default value is 0.

Throws:

IllegalArgumentException - when startTime is negative.

Since:

4.0

setTotpTimestepSize

void setTotpTimestepSize(int timestepSize)

Set the TOTP time step size.

Parameters:

timestepSize - the time step size. Default value is 30

Throws:

IllegalArgumentException - when timestepSize is less than or equal to 0.

Since:

4.0

setTotpTimestepType

void setTotpTimestepType(SoftOathSettings.OathTimestepType timestepType)

Set the TOTP time step type.

Parameters:

timestepType - the time step type. Default value is Seconds

Throws:

IllegalArgumentException - when timestepSize is less than or equal to 0.

Since:

4.1

setOcraOtpLength

void setOcraOtpLength(int otpLength)

Set the OCRA OTP length.

Parameters:

otpLength - the OTP length. 0 for full length or any value in the range 4-10 digits.

Throws:

IllegalArgumentException - when otpLength is not in allowed range.

Since:

4.0

setOcraHashAlgorithm

void setOcraHashAlgorithm(SoftOathSettings.OathHashAlgorithm hashAlgorithm)

Set the OCRA hash algorithm.

Parameters:

hashAlgorithm - the hmac algorithm.

Since:

4.0

setOcraTimeSettings

void setOcraTimeSettings(SoftOathSettings.OathTimestepType timestepType,
                         int timestepSize,
                         long startTime)

Set the OCRA time settings.

Parameters:

timestepType - the time step type, set to OathTimestepType.NONE to not use it

timestepSize - the time step size, it is ignored if timestepType is NONE

startTime - the start time, it is ignored if timestepType is NONE

Throws:

IllegalArgumentException - when at least one of these condition is true:

• timestepType is not equal to SoftOathSettings.OathTimestepType.NONE and timestepSize is less than or equal to zero.
• timestepType is not equal to SoftOathSettings.OathTimestepType.NONE and startTime is less than zero.
• timestepType is equal to SoftOathSettings.OathTimestepType.SECONDS and timestepSize is greater than 59.
• timestepType is equal to SoftOathSettings.OathTimestepType.MINUTES and timestepSize is greater than 59.
• timestepType is equal to SoftOathSettings.OathTimestepType.HOURS and timestepSize is greater than 48.

Since:

4.0

setOcraCounterUsed

void setOcraCounterUsed(boolean useCounter)

Enable/Disable the counter (C) in OCRA computation.

Parameters:

useCounter - True to enable.

Since:

4.0

setOcraChallengeQuestionFormat

void setOcraChallengeQuestionFormat(SoftOathSettings.OcraChallengeQuestionFormat challengeQuestionFormat)

Set the format of the challenge question (Q)

Parameters:

challengeQuestionFormat - the format of the Challenge question

Since:

4.0

setOcraSessionLength

void setOcraSessionLength(int sessionLength)

Set the maximum length in bytes of the Session (S) in UTF-8 encoding.

Parameters:

sessionLength - the length of the Session. -1 to not use session in Ocra computation or any value in the range 1-512. Default value is -1 (not used)

Throws:

IllegalArgumentException - when at least one of these condition is true:

• sessionLength is less than -1.
• sessionLength is positive but not in allowed range.

Since:

4.0

setOcraPasswordHashAlgorithm

void setOcraPasswordHashAlgorithm(SoftOathSettings.OcraPasswordHashAlgorithm hashAlgorithm)

Set the password Hash algorithm, set to OcraPasswordHashAlgorithm.NONE to not use it

Parameters:

hashAlgorithm - the Password Hash algorithm

Since:

4.0

setOcraMaximumChallengeQuestionLength

void setOcraMaximumChallengeQuestionLength(int maxChallengeQuestionLength)

Set the maximum challenge question length.

Parameters:

maxChallengeQuestionLength - the maximum length of the challenge string regardless of the format (e.g. the number of nibbles in hexadecimal format or the maximum number of digits in numerical format). Any value in the range 4-64.

Throws:

IllegalArgumentException - when maxChallengeQuestionLength is not in allowed range.

Since:

4.0

setOcraSuite

void setOcraSuite(SecureString ocrasuite)

Set the Ocra Suite, all the relevant OCRA settings will be set accordingly. Notice the startTime cannot be configured by Ocra Suite. Call setOcraTimeSettings(com.gemalto.idp.mobile.otp.oath.soft.SoftOathSettings.OathTimestepType, int, long) if startTime needs to be tweaked.

Parameters:

ocrasuite - the Ocra Suite

Throws:

IllegalArgumentException - when the ocrasuite is invalid.

Since:

4.0