<HIDKey> Protocol Reference

Key instance. More...

#import <HIDKey.h>

Instance Methods
(NSString *)	- getAlgorithm:
	Gets the standard algorithm name for the key. More...
(id< HIDOTPGenerator >)	- getDefaultOTPGenerator:
	Returns the default OTP generator associated with the key. More...
(NSData *)	- getEncoded:
	Gets the key in its primary encoding format. More...
(NSData *)	- getEncoded:error:
	Gets the key in its primary encoding format. More...
(NSString *)	- getFormat:
	Gets the name of the primary encoding format of this key. More...
(HIDIdentifier *)	- getId
	Gets the keyId associated with key. More...
(id< HIDOTPGenerator >)	- getOTPGenerator:error:
	Returns the OTP generator with specified name associated with a key. More...
(NSString *)	- getProperty:error:
	Returns property for that key. More...
(id< HIDProtectionPolicy >)	- getProtectionPolicy:
	Gets the protection policy associated with key. More...
(NSArray *)	- getSupportedOTPGenerators:
	Returns the list of supported OTP generators associated with the key. More...
(BOOL)	- isExtractable:
	Returns true when the key is extractable. More...

Detailed Description

Key instance.

Method Documentation

- (NSString*) getAlgorithm:

(NSError **)

error

Gets the standard algorithm name for the key.

Parameters

error

error details. It may be nil.

Returns

The algorithm name.

- (id<HIDOTPGenerator>) getDefaultOTPGenerator:

(NSError **)

error

Returns the default OTP generator associated with the key.

Parameters

error

error details. It may be nil.

Returns

The HIDOTPGenerator instance, nil if key is not supporting any OTP generators or an error occurs.

- (NSData*) getEncoded:

(NSError **)

error

Gets the key in its primary encoding format.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDAuthentication if key password is incorrect
• HIDInternal if unexpected error occurred.

Returns

the key in its primary encoding format, or nil if an error occurred

- (NSData*) getEncoded:		(NSString *)	password
error:		(NSError **)	error

Gets the key in its primary encoding format.

Parameters

password	the key password.
error	error details. It may be nil.

Possible error codes are:

• HIDAuthentication if key password is incorrect
• HIDInternal if unexpected error occurred.

Returns

The key in its primary encoding format, or nil if an error occurred.

- (NSString*) getFormat:

(NSError **)

error

Gets the name of the primary encoding format of this key.

Parameters

error

error details. It may be nil.

Returns

The encoding format name.

- (HIDIdentifier*) getId

Gets the keyId associated with key.

Returns

the keyId, nil if not set.

- (id<HIDOTPGenerator>) getOTPGenerator:		(NSString *)	name
error:		(NSError **)	error

Returns the OTP generator with specified name associated with a key.

Parameters

name	one of OTP generators names (see getSupportedOTPGenerators: )
error	error details. It may be nil.

Possible error codes are:

• HIDNotImplemented if not implemented

Returns

The HIDOTPGenerator instance, nil if key is not supporting any OTP generators or an error occurs.

- (NSString*) getProperty:		(NSString *)	propertyId
error:		(NSError **)	error

Returns property for that key.

Parameters

propertyId

key property name.

The property name may be any of the following:

• HID_KEY_PROPERTY_USAGE
• HID_KEY_PROPERTY_LABEL
• HID_KEY_PROPERTY_CREATE
• HID_KEY_PROPERTY_EXPIRY

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurred.

Returns

The key property value, nil if an error occurs.

- (id<HIDProtectionPolicy>) getProtectionPolicy:

(NSError **)

error

Gets the protection policy associated with key.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDInternal if unexpected error occurred.

Returns

The HIDProtectionPolicy used to protect the key, nil if an error occurs.

- (NSArray*) getSupportedOTPGenerators:

(NSError **)

error

Returns the list of supported OTP generators associated with the key.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDNotImplemented if not implemented

Returns

The list of HIDOTPGenerator instances, nil if key is not supporting any OTP generators or an error occurs.

- (BOOL) isExtractable:

(NSError **)

error

Returns true when the key is extractable.

Parameters

error

error details. It may be nil.

Returns

true or false depending on whether the key is extractable or not.

---

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

• HIDKey.h