com.hidglobal.ia.service.otp.parameters

Class TOTPParameters

java.lang.Object

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

com.hidglobal.ia.service.otp.parameters.TOTPParameters

public class TOTPParameters
extends AlgorithmParameters

Defines the TOTP algorithm parameters.

Constructor Summary

Constructors

Constructor and Description
TOTPParameters()

Method Summary

Modifier and Type	Method and Description
long	getClock() Return the clock used for the calculation (seconds)
int	getCodeDigits()
String	getMACAlgo()
long	getStartTime() Return the start time used for clock synchronization.
long	getTimeStep() Return the timestep used for calculation.
int	getTruncationOffset()
boolean	isChecksumUsed()
void	setClock(long clock) Sets the clock value.
void	setCodeDigits(int codeDigits) Sets the number of truncated digits.
void	setMACAlgo(String algorithm) Sets the MAC algorithm value.
void	setStartTime(long startTime) Sets the start time used for clock synchronization.
void	setTimeStep(long timeStep) Sets the time step
void	setTruncationOffset(int truncationOffset) Sets the truncation offset
void	setUseChecksum(boolean useChecksum) Sets the use of the checksum

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

TOTPParameters

public TOTPParameters()

Method Detail

getMACAlgo

public String getMACAlgo()

Returns:

the MAC algorithm value.

setMACAlgo

public void setMACAlgo(String algorithm)

Sets the MAC algorithm value.

Parameters:

algorithm - the MAC algorithm value

setUseChecksum

public void setUseChecksum(boolean useChecksum)

Sets the use of the checksum

Parameters:

useChecksum - true if checksum must be used

setTruncationOffset

public void setTruncationOffset(int truncationOffset)

Sets the truncation offset

Parameters:

truncationOffset - the truncation offset

setClock

public void setClock(long clock)

Sets the clock value.

Parameters:

clock - the clock value

setTimeStep

public void setTimeStep(long timeStep)

Sets the time step

Parameters:

timeStep - the time step

setStartTime

public void setStartTime(long startTime)

Sets the start time used for clock synchronization.

Parameters:

startTime - Start Time as number of seconds.

setCodeDigits

public void setCodeDigits(int codeDigits)

Sets the number of truncated digits.

Parameters:

codeDigits - the number of truncated digits

getClock

public long getClock()

Return the clock used for the calculation (seconds)

Returns:

Returns number of seconds as "Unix time" (i.e., the number of seconds elapsed since midnight UTC of January 1, 1970).

getCodeDigits

public int getCodeDigits()

Returns:

the number of truncated digits.

getTruncationOffset

public int getTruncationOffset()

Returns:

the truncation offset.

getTimeStep

public long getTimeStep()

Return the timestep used for calculation.

Returns:

Returns TimeStep as number of seconds.

getStartTime

public long getStartTime()

Return the start time used for clock synchronization.

Returns:

Returns Start Time as number of seconds.

isChecksumUsed

public boolean isChecksumUsed()

Returns:

if the checksum is added to OTP