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

Defines the HOTP algorithm parameters. More...

Inheritance diagram for com.hidglobal.ia.service.otp.parameters.HOTPParameters:

Public Member Functions
int	getCodeDigits ()
long	getCounter ()
String	getMACAlgo ()
int	getTruncationOffsets ()
boolean	isCheckSumUsed ()
void	setCodeDigits (int codeDigits)
void	setCounter (long counter)
void	setMACAlgo (String algorithm)
void	setTruncationOffsets (int truncationOffset)
void	useCheckSum (boolean useCheckSum)
Public Member Functions inherited from com.hidglobal.ia.service.otp.parameters.AlgorithmParameters
Set< String >	getModes ()
int	getStandardVersion ()
void	setModes (Set< String > authModes)
void	setStandardVersion (int standardVersion)

Detailed Description

Defines the HOTP algorithm parameters.

Member Function Documentation

getCodeDigits()

int com.hidglobal.ia.service.otp.parameters.HOTPParameters.getCodeDigits ( )

inline

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

Returns

Returns Code Digits.

getCounter()

long com.hidglobal.ia.service.otp.parameters.HOTPParameters.getCounter ( )

inline

Returns counter (Moving Factor) for calculation.

Returns

Returns counter as an unsigned long.

getMACAlgo()

String com.hidglobal.ia.service.otp.parameters.HOTPParameters.getMACAlgo ( )

inline

Message authentication code (MAC) Algorithm requested.

Returns

Return friendly name for MAC Algorithm.

getTruncationOffsets()

int com.hidglobal.ia.service.otp.parameters.HOTPParameters.getTruncationOffsets ( )

inline

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.

isCheckSumUsed()

boolean com.hidglobal.ia.service.otp.parameters.HOTPParameters.isCheckSumUsed ( )

inline

Determines if a checksum digit is added to the calculation.

Returns

Returns true if checksum is requested.

setCodeDigits()

void com.hidglobal.ia.service.otp.parameters.HOTPParameters.setCodeDigits ( int  codeDigits )

inline

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

Parameters

codeDigits

number of truncated digits.

setCounter()

void com.hidglobal.ia.service.otp.parameters.HOTPParameters.setCounter ( long  counter )

inline

Sets counter (Moving Factor) for calculation.

Parameters

counter

(Moving Factor) as unsigned long for calculation.

setMACAlgo()

void com.hidglobal.ia.service.otp.parameters.HOTPParameters.setMACAlgo ( String  algorithm )

inline

Sets message authentication code (MAC) Algorithm requested.

Parameters

algorithm

friendly name for MAC Algorithm.

setTruncationOffsets()

void com.hidglobal.ia.service.otp.parameters.HOTPParameters.setTruncationOffsets ( int  truncationOffset )

inline

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.

useCheckSum()

void com.hidglobal.ia.service.otp.parameters.HOTPParameters.useCheckSum ( boolean  useCheckSum )

inline

Enables checksum digit is added to the calculation.

Parameters

useCheckSum

the use of a checksum