Interface ISmartkeys

Namespace: PKWARE.Smartcrypt.KeyManagement
Assembly: SmartcryptKeyManagement.dll
Syntax
public interface ISmartkeys

Methods

Create(SmartkeySpec)

Declaration
[NotNull]
IObservable<ISmartkey> Create([NotNull] SmartkeySpec spec)
Parameters
Type Name Description
SmartkeySpec spec
Returns
Type Description
IObservable<ISmartkey>
Exceptions
Type Condition
MetaClientException

If the Smartkey cannot be created.

Deserialize(String)

Declaration
[NotNull]
IObservable<ISmartkey> Deserialize([NotNull] string serialized)
Parameters
Type Name Description
String serialized
Returns
Type Description
IObservable<ISmartkey>
Exceptions
Type Condition
MetaClientException

With Category of CategoryUpgrade if the serialized content cannot be parsed. Also with other categories for other reasons.

ListAll()

Declaration
[NotNull]
IObservable<ISet<ISmartkey>> ListAll()
Returns
Type Description
IObservable<ISet<ISmartkey>>

RequestAccess(String)

Declaration
void RequestAccess([NotNull] string serialized)
Parameters
Type Name Description
String serialized
Exceptions
Type Condition
MetaClientException

With Category of CategoryUpgrade if the serialized content cannot be parsed. May also happen as a results of network problems and other reasons.

Serialize(ISmartkey)

Declaration
[NotNull]
string Serialize([NotNull] ISmartkey smartkey)
Parameters
Type Name Description
ISmartkey smartkey
Returns
Type Description
String

The serialized Smartkey. This is safe to store in plaintext and with the data.
Exceptions
Type Condition
MetaClientException

If the provided key cannot be serialized. This may happen if given an invalid key.

Update(ISmartkey, SmartkeySpec)

It is not possible to change whether or not a key is rotatable or its kind.

Declaration
[NotNull]
IObservable<ISmartkey> Update([NotNull] ISmartkey smartkey, [NotNull] SmartkeySpec spec)
Parameters
Type Name Description
ISmartkey smartkey
SmartkeySpec spec
Returns
Type Description
IObservable<ISmartkey>
Exceptions
Type Condition
MetaClientException