com.hidglobal.ia.service.otp.parameters

Class OCRASuite

java.lang.Object

com.hidglobal.ia.service.otp.parameters.OCRASuite

public class OCRASuite
extends Object

Represents the OCRA suite and associated runtime parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OCRASuite.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHALLENGE_FORMAT_ALPHANUM
static String	CHALLENGE_FORMAT_HEX
static String	CHALLENGE_FORMAT_NUMERIC

Method Summary

Modifier and Type	Method and Description
String	getChallengeFormat() Get challenge format.
int	getCodeDigits() Get truncation size.
String	getCryptoFunction() Get HMAC Function used.
int	getMaxChallengeLength() Get maximum challenge length.
int	getMinChallengeLength() Get minimum challenge value, default value 0
String	getPinHashAlgo() Get hash algorithm for the PIN.
int	getSessionLength() Get session length.
int	getTimeStep() Get clock value.
boolean	hasCounter() Get information whether OCRA suite includes counter in calculation.
boolean	hasTime() Get counter value.
boolean	isPinRequired() Get information whether OCRA Suite requires PIN as input.
boolean	isSessionRequired() Get information whether OCRA Suite requires session information as input.
String	toString() Get the full OCRA Suite.

Methods inherited from class java.lang.Object

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

Field Detail

CHALLENGE_FORMAT_ALPHANUM

public static final String CHALLENGE_FORMAT_ALPHANUM

See Also:

Constant Field Values

CHALLENGE_FORMAT_NUMERIC

public static final String CHALLENGE_FORMAT_NUMERIC

See Also:

Constant Field Values

CHALLENGE_FORMAT_HEX

public static final String CHALLENGE_FORMAT_HEX

See Also:

Constant Field Values

Method Detail

getCryptoFunction

public String getCryptoFunction()

Get HMAC Function used.

Returns:

HMAC function (HMAC-SHA1, HMAC-SHA256, HMAC-SHA512)

getCodeDigits

public int getCodeDigits()

Get truncation size.

Returns:

size of the truncation (0 no truncation).

hasCounter

public boolean hasCounter()

Get information whether OCRA suite includes counter in calculation.

Returns:

boolean

hasTime

public boolean hasTime()

Get counter value.

Returns:

the counter value or 0 if no counter Get information whether OCRA Suite include timestamp in its calculation

getTimeStep

public int getTimeStep()

Get clock value.

Returns:

the counter value or 0 if no clock used in its calculation. Get timestep value. the timestep value or 0 if no timestep used in its calculation.

getMinChallengeLength

public int getMinChallengeLength()

Get minimum challenge value, default value 0

Returns:

Returns length.

getMaxChallengeLength

public int getMaxChallengeLength()

Get maximum challenge length.

Returns:

Returns length.

getChallengeFormat

public String getChallengeFormat()

Get challenge format.

Returns:

format (numeric, hexadecimal, alphanumeric).

isPinRequired

public boolean isPinRequired()

Get information whether OCRA Suite requires PIN as input. See setPIN method of the HIDInputOCRAParameters.

Returns:

the timestep value or 0 if no timestep used in its calculation.

getPinHashAlgo

public String getPinHashAlgo()

Get hash algorithm for the PIN.

Returns:

PIN or NULL if not required.

isSessionRequired

public boolean isSessionRequired()

Get information whether OCRA Suite requires session information as input. See setSession method of the HIDInputOCRAParameters.

Returns:

PIN or NULL if not required.

getSessionLength

public int getSessionLength()

Get session length.

Returns:

length.

toString

public String toString()

Get the full OCRA Suite.

Overrides:

toString in class Object

Returns:

Ocra Suite.