HID APPROVE SDK  5.7.1
HID APPROVE SDK for iOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
<HIDOCRASuite> Protocol Reference

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

#import <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

- (NSString*) getChallengeFormat

Get challenge format.

Returns
format (numeric, hexadecimal, alphanumeric).
- (int) getCodeDigits

Get truncation size.

Returns
size of the truncation (0 no truncation).
- (NSString*) getCryptoFunction

Get HMAC Function used.

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

Get maximum challenge length.

Returns
Returns length.
- (int) getMinChallengeLength

Get minimum challenge value, default value 0

Returns
Returns length.
- (NSString*) getPINHashAlgo

Get hash algorithm for the PIN.

Returns
PIN or NULL if not required.
- (int) getSessionLength

Get session length.

Returns
length.
- (uint64_t) getTimeStep

Get timestep value.

Returns
the timestep value or 0 if no timestep used in its calculation.
- (BOOL) hasCounter

Get information whether OCRA suite includes counter in calculation.

Returns
bool.
- (BOOL) hasTime

Get information whether OCRA Suite include timestamp in its calculation

Returns
bool
- (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.
- (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.
- (NSString*) toString

Get the full OCRA Suite.

Returns
Ocra Suite.

The documentation for this protocol was generated from the following file: