HOTP Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorksAuth_HOTP

Procedural Interface

 ipworksauth_hotp_open();
 ipworksauth_hotp_close($res);
 ipworksauth_hotp_register_callback($res, $id, $function);
 ipworksauth_hotp_get_last_error($res);
 ipworksauth_hotp_get_last_error_code($res);
 ipworksauth_hotp_set($res, $id, $index, $value);
 ipworksauth_hotp_get($res, $id, $index);
 ipworksauth_hotp_do_config($res, $configurationstring);
 ipworksauth_hotp_do_createpassword($res);
 ipworksauth_hotp_do_reset($res);
 ipworksauth_hotp_do_validatepassword($res);

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.