<HIDSyncOTPGenerator> Protocol Reference

Extends the OTP generator to support synchronous time or event based generation. (HOTP, TOTP) More...

#import <HIDSyncOTPGenerator.h>

Inheritance diagram for <HIDSyncOTPGenerator>:

Instance Methods
(NSString *)	- getOTP:error:
	Compute the one-time password. More...
Instance Methods inherited from <HIDOTPGenerator>
(id< HIDAlgorithmParameters >)	- getAlgorithmParameters
(NSString *)	- getName
(NSString *)	- getType
(NSString *)	- getVersion

Detailed Description

Extends the OTP generator to support synchronous time or event based generation. (HOTP, TOTP)

Method Documentation

- (NSString*) getOTP:		(NSString *)	password
error:		(NSError **)	error

Compute the one-time password.

Parameters

password	OTP key password (if protected by password).
error	error details. It may be nil.

Possible error codes are:

• HIDAuthentication if password is incorrect.
• HIDCredentialsExpired if key is no longer valid
• HIDPasswordExpired if expired password is given (changePassword required).
• HIDInternal if unexpected error occurred.
• HIDInvalidArgument if the given parameters are invalid or required parameters are missing.

Returns

The formatted OTP.

---

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

• HIDSyncOTPGenerator.h