<HIDKeyPair> Protocol Reference

Inheritance diagram for <HIDKeyPair>:

Instance Methods
(NSData *)	- getPrivateKeyEncoded:
	Gets the private key in its primary encoding format.
(NSData *)	- getPrivateKeyEncoded:error:
	Gets the private key in its primary encoding format.
Instance Methods inherited from <HIDKey>
(NSString *)	- getAlgorithm:
	Gets the standard algorithm name for the key.
(id< HIDOTPGenerator >)	- getDefaultOTPGenerator:
	Returns the default OTP generator associated with the key.
(NSData *)	- getEncoded:
	Gets the key in its primary encoding format.
(NSData *)	- getEncoded:error:
	Gets the key in its primary encoding format.
(NSString *)	- getFormat:
	Gets the name of the primary encoding format of this key.
(HIDIdentifier *)	- getId
	Gets the keyId associated with key.
(NSString *)	- getProperty:error:
	Returns property for that key.
(id< HIDProtectionPolicy >)	- getProtectionPolicy:
	Gets the protection policy associated with key.
(BOOL)	- isExtractable:
	Returns true when the key is extractable.

Method Documentation

getPrivateKeyEncoded:

- (NSData *) getPrivateKeyEncoded:

(NSError **)

error

Gets the private key in its primary encoding format.

Parameters

error

error details. It may be nil.

Possible error codes are:

• HIDAuthentication if password is incorrect. HID_ERROR_AUTH_REMAINING_TRIES contains lock counter details when applicable.
• HIDInternal if unexpected error occurred.

Returns

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

getPrivateKeyEncoded:error:

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

Gets the private key in its primary encoding format.

Parameters

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

Possible error codes are:

• HIDAuthentication if password is incorrect. HID_ERROR_AUTH_REMAINING_TRIES contains lock counter details when applicable.
• HIDInternal if unexpected error occurred.

Returns

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