HIDIA.Transaction.IKey Interface Reference

Represents a cryptographic key. More...

Public Member Functions
Task< string >	GetAlgorithm ()
	The standard algorithm name for the key. More...
Task< IOTPGenerator >	GetDefaultOTPGenerator ()
	Returns the default OTP generator for that key. More...
Task< byte[]>	GetEncoded ()
	Gets the key in its primary encoding format. More...
Task< byte[]>	GetEncoded (char[] password)
	Gets the key in its primary encoding format. More...
Task< string >	GetFormat ()
	The name of the primary encoding format of this key. More...
Task< string >	GetProperty (string name)
	Returns property for that key. More...
Task< IProtectionPolicy >	GetProtectionPolicy ()
	Returns the protection policy associated with key. More...
Task< bool >	IsExtractable ()
	Returns true when the key is extractable. More...

Properties
KeyId	Id [get]
	The key identifier. More...

Detailed Description

Represents a cryptographic key.

Member Function Documentation

GetAlgorithm()

Task<string> HIDIA.Transaction.IKey.GetAlgorithm

(

)

The standard algorithm name for the key.

Returns

the algoritm name

GetDefaultOTPGenerator()

Task<IOTPGenerator> HIDIA.Transaction.IKey.GetDefaultOTPGenerator

(

)

Returns the default OTP generator for that key.

Returns

The default OTP generator for that key.

GetEncoded() [1/2]

Task<byte[]> HIDIA.Transaction.IKey.GetEncoded

(

)

Gets the key in its primary encoding format.

Returns

The key in its primary encoding format

GetEncoded() [2/2]

Task<byte[]> HIDIA.Transaction.IKey.GetEncoded

(

char []

password

)

Gets the key in its primary encoding format.

Parameters

password

the key password

Returns

The key in its primary encoding format

GetFormat()

Task<string> HIDIA.Transaction.IKey.GetFormat

(

)

The name of the primary encoding format of this key.

Returns

The name of the format if the key is extractable.

Exceptions

NotImplementedException

GetProperty()

Task<string> HIDIA.Transaction.IKey.GetProperty

(

string

name

)

Returns property for that key.

Parameters

name	The key property name. The property name may be any of the following: KEY_PROPERTY_USAGE KEY_PROPERTY_LABEL KEY_PROPERTY_CREATE KEY_PROPERTY_EXPIRY

Returns

The key property value.

Exceptions

InternalException

GetProtectionPolicy()

Task<IProtectionPolicy> HIDIA.Transaction.IKey.GetProtectionPolicy

(

)

Returns the protection policy associated with key.

Returns

The ProtectionPolicy used to protect the key.

Exceptions

InternalException

IsExtractable()

Task<bool> HIDIA.Transaction.IKey.IsExtractable

(

)

Returns true when the key is extractable.

Returns

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

Exceptions

InternalException

Property Documentation

Id

KeyId HIDIA.Transaction.IKey.Id

get

The key identifier.