com.pkware.smartcrypt.keymanagement.smartkeys

Interface Smartkey

All Known Implementing Classes:

AbstractSmartkey, ArchiveSmartkey, CommunitySmartkey, ContingencySmartkey, ErrorSmartkey, PrivateSmartkey, SdkSmartkey, TdeSmartkey, UnknownSmartkey

public interface Smartkey

Smartkeys are the core building block of Smartcrypt encryption. These contain all the useful information about the underlying cryptographic key.

Smartkeys are passive object. They do not update in real time, they do not perform complex logic. Smartkeys typically want to be used or monitored in an Observable as that will ensure that your application is working with the latest key information.

Method Summary

Modifier and Type	Method and Description
boolean	canDecrypt()
boolean	canEncrypt()
boolean	canManage()
List<Feature>	getFeatures()
SecretKey	getKey()
SecretKey	getKeyForDecryption(int revision)
String	getName() Useful for displaying in UIs.
List<KnownUser>	getParticipants()
int	getRevision()
String	getUrn() The URN for a Smartkey will never change.

Method Detail

getName

@Nonnull
String getName()

Useful for displaying in UIs. May change over time, so not good for programmatic filtering. An empty value indicates that human users should not be aware of this Smartkey.

Returns:

may be empty

getUrn

@Nonnull
String getUrn()

The URN for a Smartkey will never change.

Returns:

A globally unique identifier for this Smartkey

getKey

@Nonnull
SecretKey getKey()
                   throws MetaClientException

Returns:

the AES key matching the current getRevision()

Throws:

MetaClientException - if not allowed to encrypt using this key

See Also:

canEncrypt()

getRevision

int getRevision()

Returns:

revision of the highest AES key this Smartkey manages

getFeatures

@Nonnull
List<Feature> getFeatures()

Returns:

Unmodifiable; perform a copy if you need to change the list. May be empty.

getParticipants

@Nonnull
List<KnownUser> getParticipants()

Returns:

Unmodifiable; perform a copy if you need to change the list. May be empty.

canManage

boolean canManage()

Returns:

true if this user is allowed to modify this smartkey. If false, attempts at modification will result in errors.

canEncrypt

boolean canEncrypt()

Returns:

true if this user is allowed to encrypt using this smartkey. If false, attempts to retrieve the encryption key will throw an exception.

canDecrypt

boolean canDecrypt()

Returns:

true if this user is allowed to decrypt using this smartkey. If false, attempts to retrieve the decryption key with throw an exception.

getKeyForDecryption

@Nullable
SecretKey getKeyForDecryption(int revision)
                                 throws MetaClientException

Returns:

null if no key is available for the given revision

Throws:

MetaClientException - if this key is not allowed to be used for decryption

See Also:

canDecrypt()