OTP Class

Properties   Methods   Events   Config Settings   Errors  

The OTP class allows creation of single use passwords.

Class Name

IPWorksAuth_OTP

Procedural Interface

 ipworksauth_otp_open();
 ipworksauth_otp_close($res);
 ipworksauth_otp_register_callback($res, $id, $function);
 ipworksauth_otp_get_last_error($res);
 ipworksauth_otp_get_last_error_code($res);
 ipworksauth_otp_set($res, $id, $index, $value);
 ipworksauth_otp_get($res, $id, $index);
 ipworksauth_otp_do_config($res, $configurationstring);
 ipworksauth_otp_do_createpassword($res);
 ipworksauth_otp_do_reset($res);
 ipworksauth_otp_do_validatepassword($res);

Remarks

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

To begin decide which algorithm you wish to use and set PasswordAlgorithm. Specify the shared secret in the Secret property.

Next, depending on the algorithm chosen you may set Counter (HOTP) or TimeStep (TOTP). If these properties are 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Counter Property (IPWorksAuth_OTP Class)

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

Object Oriented Interface

public function getCounter();
public function setCounter($value);

Procedural Interface

ipworksauth_otp_get($res, 1 );
ipworksauth_otp_set($res, 1, $value );

Default Value

0

Remarks

This property holds the counter value used for HMAC-Based One Time Password creation or validation. When PasswordAlgorithm is set to paHOTP 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.

This property is not applicable when using the Time-Based One Time Password algorithm.

Data Type

Long64

Password Property (IPWorksAuth_OTP Class)

The HMAC-Based or Time-Based One Time Password.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworksauth_otp_get($res, 2 );
ipworksauth_otp_set($res, 2, $value );

Default Value

''

Remarks

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

Data Type

String

PasswordAlgorithm Property (IPWorksAuth_OTP Class)

The algorithm used to create or validate the password.

Object Oriented Interface

public function getPasswordAlgorithm();
public function setPasswordAlgorithm($value);

Procedural Interface

ipworksauth_otp_get($res, 3 );
ipworksauth_otp_set($res, 3, $value );

Default Value

0

Remarks

This property specifies whether to use the HMAC-Based or Time-Based One Time Password algorithm. Possible values are:

Data Type

Integer

Secret Property (IPWorksAuth_OTP Class)

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

Object Oriented Interface

public function getSecret();
public function setSecret($value);

Procedural Interface

ipworksauth_otp_get($res, 4 );
ipworksauth_otp_set($res, 4, $value );

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.

Data Type

String

TimeStep Property (IPWorksAuth_OTP Class)

The time step (in seconds) used for Time-Based One Time Password creation or validation.

Object Oriented Interface

public function getTimeStep();
public function setTimeStep($value);

Procedural Interface

ipworksauth_otp_get($res, 5 );
ipworksauth_otp_set($res, 5, $value );

Default Value

30

Remarks

This property specifies the time step (in seconds) used for Time-Based One Time Password creation or validation. When PasswordAlgorithm is set to paTOTP this value must be specified before calling CreatePassword or ValidatePassword.

The default value is 30.

This property is not applicable when using the HMAC-Based One Time Password algorithm.

Data Type

Integer

ValidityTime Property (IPWorksAuth_OTP Class)

The validity time of the created password.

Object Oriented Interface

public function getValidityTime();

Procedural Interface

ipworksauth_otp_get($res, 6 );

Default Value

0

Remarks

This property returns the remaining validity time in seconds of the created password. After calling CreatePassword this property may be queried to determine for how many more seconds the password will be valid. If the password is no longer valid this property returns 0.

This property is read-only.

Data Type

Integer

Config Method (IPWorksAuth_OTP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksauth_otp_do_config($res, $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 (IPWorksAuth_OTP Class)

Creates a Time-Based or HMAC-Based One Time Password.

Object Oriented Interface

public function doCreatePassword();

Procedural Interface

ipworksauth_otp_do_createpassword($res);

Remarks

This method creates either a Time-Based or HMAC-Based One Time Password. The PasswordAlgorithm property specifies which algorithm to use.

The following properties are applicable when calling CreatePassword.

• PasswordAlgorithm
• Secret
• Counter (required for HMAC-Based One Time Password)
• TimeStep (applicable for Time-Based One Time Password)

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 (IPWorksAuth_OTP Class)

Reset the variables to default value.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksauth_otp_do_reset($res);

Remarks

This method will reset the variables to default value.

ValidatePassword Method (IPWorksAuth_OTP Class)

Validates a Time-Based or HMAC-Based One Time Password.

Object Oriented Interface

public function doValidatePassword();

Procedural Interface

ipworksauth_otp_do_validatepassword($res);

Remarks

This method validates a Time-Based or HMAC-Based One Time Password. The PasswordAlgorithm property specifies which algorithm to use.

The following properties are applicable when calling ValidatePassword.

• Password (required)
• PasswordAlgorithm
• Secret (required)
• Counter (required for HMAC-Based One Time Password)
• TimeStep (applicable for Time-Based One Time Password)

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

Error Event (IPWorksAuth_OTP Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksauth_otp_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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 (OTP Class)

OTP 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 (OTP Class)

OTP Errors