EMSoftOathSettings

Objective-C

@protocol EMSoftOathSettings <NSObject>

Swift

protocol EMSoftOathSettings : NSObjectProtocol

Protocol for OATH related settings.

Since

2.2

  • Returns the length of an HOTP.

    Default: 8

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger hotpLength;

    Swift

    var hotpLength: Int { get }

  • Returns the hash algorithm used in the HMAC computation for HOTP.

    Default: EMOathHashSHA1. see EMOathHashAlgorithm.

    Declaration

    Objective-C

    @property (nonatomic, readonly) EMOathHashAlgorithm hotpHashAlgorithm;

    Swift

    var hotpHashAlgorithm: EMOathHashAlgorithm { get }

  • Returns the length of an TOTP.

    Default: 8

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger totpLength;

    Swift

    var totpLength: Int { get }

  • Returns the hash algorithm used in the HMAC computation for TOTP.

    Default: EMOathHashSHA1. see EMOathHashAlgorithm.

    Declaration

    Objective-C

    @property (nonatomic, readonly) EMOathHashAlgorithm totpHashAlgorithm;

    Swift

    var totpHashAlgorithm: EMOathHashAlgorithm { get }

  • Returns the T0 start time used in the settings.

    Default: 0

    Declaration

    Objective-C

    @property (nonatomic, readonly) int64_t totpStartTime;

    Swift

    var totpStartTime: Int64 { get }

  • Returns the time step size used in the settings.

    Default: 30

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger totpTimestepSize;

    Swift

    var totpTimestepSize: Int { get }

  • Returns the time step type for TOTP.

    Default: Seconds

    Declaration

    Objective-C

    @property (nonatomic, readonly) EMOathTimestepType totpTimestepType;

    Swift

    var totpTimestepType: EMOathTimestepType { get }

  • Returns the length of an OCRA OTP.

    Default: 8

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger ocraOtpLength;

    Swift

    var ocraOtpLength: Int { get }

  • Returns the hash algorithm used in the HMAC computation.

    Default: EMOathHashSHA1. See EMOathHashAlgorithm.

    Declaration

    Objective-C

    @property (nonatomic, readonly) EMOathHashAlgorithm ocraHashAlgorithm;

    Swift

    var ocraHashAlgorithm: EMOathHashAlgorithm { get }

  • Returns the T0 start time used in the settings.

    Default: 0

    Declaration

    Objective-C

    @property (nonatomic, readonly) int64_t ocraStartTime;

    Swift

    var ocraStartTime: Int64 { get }

  • Returns the time step type used in the settings.

    Default: EMTotpTimestepTypeSeconds. See EMOathTimestepType.

    Declaration

    Objective-C

    @property (nonatomic, readonly) EMOathTimestepType ocraTimestepType;

    Swift

    var ocraTimestepType: EMOathTimestepType { get }

  • Returns the time step size used in the settings.

    Default: 30

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger ocraTimestepSize;

    Swift

    var ocraTimestepSize: Int { get }

  • Returns YES if Counter is used, NO otherwise.

    Default: NO

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isOcraCounterUsed) BOOL ocraCounterUsed;

    Swift

    var isOcraCounterUsed: Bool { get }

  • Returns the format of the Challenge Question field.

    Default: EMOcraChallengeQuestionFormatNumeric. See EMOcraChallengeQuestionFormat.

    Declaration

    Objective-C

    @property (nonatomic, readonly) EMOcraChallengeQuestionFormat ocraChallengeQuestionFormat;

    Swift

    var ocraChallengeQuestionFormat: EMOcraChallengeQuestionFormat { get }

  • Returns the session length, -1 if not used.

    Default: -1

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger ocraSessionLength;

    Swift

    var ocraSessionLength: Int { get }

  • Returns the used password hash algorithm.

    Default: EMOcraPasswordNone. See EMOcraPasswordHashAlgorithm.

    Declaration

    Objective-C

    @property (nonatomic, readonly) EMOcraPasswordHashAlgorithm ocraPasswordHashAlgorithm;

    Swift

    var ocraPasswordHashAlgorithm: EMOcraPasswordHashAlgorithm { get }

  • Returns the maximum length of Challenge Question.

    Default: 8

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger ocraMaximumChallengeQuestionLength;

    Swift

    var ocraMaximumChallengeQuestionLength: Int { get }

  • Returns the OCRA suite for the OCRA settings.

    Default OCRA-1:HOTP-SHA1-8:QN08-T30S

    Declaration

    Objective-C

    - (id<EMSecureString>)getOcraSuite:(NSError **)error;

    Swift

    func getOcraSuite() throws -> any EMSecureString

    Parameters

    error

    If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.