com.hidglobal.ia.service.otp.parameters

Class HOTPParameters

java.lang.Object

com.hidglobal.ia.service.otp.parameters.AlgorithmParameters

com.hidglobal.ia.service.otp.parameters.HOTPParameters

public class HOTPParameters
extends AlgorithmParameters

Defines the HOTP algorithm parameters.

Constructor Summary

Constructors

Constructor and Description
HOTPParameters()

Method Summary

Modifier and Type	Method and Description
int	getCodeDigits() Returns number of truncated digits (excluding the checksum digit).
long	getCounter() Returns counter (Moving Factor) for calculation.
String	getMACAlgo() Message authentication code (MAC) Algorithm requested.
int	getTruncationOffsets() Offset used for truncation.
boolean	isCheckSumUsed() Determines if a checksum digit is added to the calculation.
void	setCodeDigits(int codeDigits) Sets number of truncated digits (excluding the checksum digit).
void	setCounter(long counter) Sets counter (Moving Factor) for calculation.
void	setMACAlgo(String algorithm) Sets message authentication code (MAC) Algorithm requested.
void	setTruncationOffsets(int truncationOffset) Sets offset used for truncation.
void	useCheckSum(boolean useCheckSum) Enables checksum digit is added to the calculation.

Methods inherited from class com.hidglobal.ia.service.otp.parameters.AlgorithmParameters

getModes, getStandardVersion, setModes, setStandardVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

HOTPParameters

public HOTPParameters()

Method Detail

getMACAlgo

public String getMACAlgo()

Message authentication code (MAC) Algorithm requested.

Returns:

Return friendly name for MAC Algorithm.

setMACAlgo

public void setMACAlgo(String algorithm)

Sets message authentication code (MAC) Algorithm requested.

Parameters:

algorithm - friendly name for MAC Algorithm.

getCounter

public long getCounter()

Returns counter (Moving Factor) for calculation.

Returns:

Returns counter.

setCounter

public void setCounter(long counter)

Sets counter (Moving Factor) for calculation.

Parameters:

counter - (Moving Factor) for calculation.

getCodeDigits

public int getCodeDigits()

Returns number of truncated digits (excluding the checksum digit).

Returns:

Returns Code Digits.

setCodeDigits

public void setCodeDigits(int codeDigits)

Sets number of truncated digits (excluding the checksum digit).

Parameters:

codeDigits - number of truncated digits.

isCheckSumUsed

public boolean isCheckSumUsed()

Determines if a checksum digit is added to the calculation.

Returns:

Returns true if checksum is requested.

useCheckSum

public void useCheckSum(boolean useCheckSum)

Enables checksum digit is added to the calculation.

Parameters:

useCheckSum - the use of a checksum

getTruncationOffsets

public int getTruncationOffsets()

Offset used for truncation. Expected range is 0 - HashLength-5 (0-15 for HMAC-SHA-1), otherwise dynamic truncation is applied.

Returns:

Return offset byte.

setTruncationOffsets

public void setTruncationOffsets(int truncationOffset)

Sets offset used for truncation. Expected range is 0 - HashLength-5 (0-15 for HMAC-SHA-1), otherwise dynamic truncation is applied.

Parameters:

truncationOffset - offset used for truncation.