HOTP Module

Properties   Methods   Events   Config Settings   Errors  

The HOTP module allows creation of HMAC-Based One-Time passwords.

Syntax

IPWorksAuth.Hotp

Remarks

The HOTP class implements the HOTP algorithm defined in RFC 4226 (HMAC-Based One-Time Password). These types of passwords are commonly used as a second factor of authentication in multi-factor authentication scenarios.

To begin specify the shared secret in the Secret property.

Next, you may set Counter. If this property is not set, the class will use a default value.

To create the password call CreatePassword. The Password property will be populated with the new password.

To validate a password set the Password property and call ValidatePassword. The method will return True or False to indicate success or failure.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

Counter Property (HOTP Module)

The counter used for HMAC-Based One Time Password creation or validation.

Syntax

• Swift
• Objective-C

public var counter: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=counter,setter=setCounter:) long long counter;

- (long long)counter;
- (void)setCounter :(long long)newCounter;

Default Value

0

Remarks

This property holds the counter value used for HMAC-Based One Time Password creation or validation. This value must be specified before calling CreatePassword or ValidatePassword. The value should be incremented each time a password is created.

The default value is 0.

Password Property (HOTP Module)

The HMAC-Based One Time Password.

Syntax

• Swift
• Objective-C

public var password: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

This property holds the HMAC-Based One Time Password. This property is populated after calling CreatePassword. This property must be set before calling ValidatePassword.

Secret Property (HOTP Module)

The Base32 encoded shared secret used when creating and validating a password.

Syntax

• Swift
• Objective-C

public var secret: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=secret,setter=setSecret:) NSString* secret;

- (NSString*)secret;
- (void)setSecret :(NSString*)newSecret;

Default Value

""

Remarks

This property specifies the Base32 encoded shared secret used when creating and validating a password. This should be set before calling CreatePassword or ValidatePassword.

If this is not set before calling CreatePassword a random secret will be automatically generated. This functionality provides an easy way to create new secret values. The length of the secret is defined by SecretLength.

Config Method (HOTP Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreatePassword Method (HOTP Module)

Creates a HMAC-Based One Time Password.

Syntax

• Swift
• Objective-C

public func createPassword() throws -> Void

- (void)createPassword;

Remarks

This method creates a HMAC-Based One Time Password.

The following properties are applicable when calling CreatePassword.

• Secret
• Counter

Calling CreatePassword populates the Password property with the created password.

If Secret is not specified before calling this method a random secret will be automatically generated.

Reset Method (HOTP Module)

Reset the variables to default value.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method will reset the variables to default value.

ValidatePassword Method (HOTP Module)

Validates a HMAC-Based One Time Password.

Syntax

• Swift
• Objective-C

public func validatePassword() throws -> Bool

- (BOOL)validatePassword;

Remarks

This method validates a HMAC-Based One Time Password.

The following properties are applicable when calling ValidatePassword.

• Password (required)
• Secret (required)
• Counter (required)

The method will return True if the password is validated, False otherwise.

Error Event (HOTP Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Config Settings (HOTP Module)

HOTP Config Settings

//TOTP
otpauth://totp/MyServiceName:account@company.com?secret=JBSWY3DPEHPK3PXP&digits=6&period=30

//HOTP
otpauth://hotp/MyServiceName:account@company.com?secret=JBSWY3DPEHPK3PXP&digits=6&counter=0

Base Config Settings

Trappable Errors (HOTP Module)

HOTP Errors