HID APPROVE SDK 6.1
HID Approve SDK for iOS/macOS
Loading...
Searching...
No Matches
<HIDOCRASuite> Protocol Reference

Represents the OCRA suite and associated runtime parameters. More...

#include <HIDOCRAGenerator.h>

Instance Methods

(NSString *) - getChallengeFormat
(int) - getCodeDigits
(NSString *) - getCryptoFunction
(int) - getMaxChallengeLength
(int) - getMinChallengeLength
(NSString *) - getPINHashAlgo
(int) - getSessionLength
(uint64_t) - getTimeStep
(BOOL) - hasCounter
(BOOL) - hasTime
(BOOL) - isPinRequired
(BOOL) - isSessionRequired
(NSString *) - toString

Detailed Description

Represents the OCRA suite and associated runtime parameters.

Method Documentation

◆ getChallengeFormat

- (NSString *) getChallengeFormat

Get challenge format.

Returns
format (numeric, hexadecimal, alphanumeric).

◆ getCodeDigits

- (int) getCodeDigits

Get truncation size.

Returns
size of the truncation (0 no truncation).

◆ getCryptoFunction

- (NSString *) getCryptoFunction

Get HMAC Function used.

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

◆ getMaxChallengeLength

- (int) getMaxChallengeLength

Get maximum challenge length.

Returns
Returns length.

◆ getMinChallengeLength

- (int) getMinChallengeLength

Get minimum challenge value, default value 0

Returns
Returns length.

◆ getPINHashAlgo

- (NSString *) getPINHashAlgo

Get hash algorithm for the PIN.

Returns
PIN or NULL if not required.

◆ getSessionLength

- (int) getSessionLength

Get session length.

Returns
length.

◆ getTimeStep

- (uint64_t) getTimeStep

Get timestep value.

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

◆ hasCounter

- (BOOL) hasCounter

Get information whether OCRA suite includes counter in calculation.

Returns
bool.

◆ hasTime

- (BOOL) hasTime

Get information whether OCRA Suite include timestamp in its calculation

Returns
bool

◆ isPinRequired

- (BOOL) 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.

◆ isSessionRequired

- (BOOL) isSessionRequired

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

Returns
PIN or NULL if not required.

◆ toString

- (NSString *) toString

Get the full OCRA Suite.

Returns
Ocra Suite.