com.google.crypto.tink.tinkkey

Class KeyHandle

java.lang.Object

com.google.crypto.tink.tinkkey.KeyHandle

public final class KeyHandle
extends Object

Wraps a TinkKey and enforces access to the underlying TinkKey with KeyAccess. Specifically, if the underlying TinkKey has a secret, then one can only get it with a SecretKeyAccess instance.

Method Summary

Modifier and Type	Method and Description
static KeyHandle	createFromKey(com.google.crypto.tink.proto.KeyData keyData, KeyTemplate.OutputPrefixType opt) Returns a KeyHandle instance where the underlying TinkKey wraps the input keyData.
static KeyHandle	createFromKey(TinkKey key, KeyAccess access) Returns a KeyHandle instance with key as the underlying TinkKey if the caller provides the correct KeyAccess instance.
TinkKey	getKey(KeyAccess access) Returns the underlying TinkKey key if access is a SecretKeyAccess and the key has a secret, or if the key does not have a secret, otherwise throws a GeneralSecurityException.
boolean	hasSecret() Returns true if the underlying TinkKey has a secret.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createFromKey

public static KeyHandle createFromKey(TinkKey key,
                                      KeyAccess access)
                               throws GeneralSecurityException

Returns a KeyHandle instance with key as the underlying TinkKey if the caller provides the correct KeyAccess instance.

Throws:

GeneralSecurityException - if access does not grant access to key

createFromKey

public static KeyHandle createFromKey(com.google.crypto.tink.proto.KeyData keyData,
                                      KeyTemplate.OutputPrefixType opt)

Returns a KeyHandle instance where the underlying TinkKey wraps the input keyData. The returned KeyHandle has a secret if keyData has key material of type UNKNOWN_KEYMATERIAL, SYMMETRIC, or ASYMMETRIC_PRIVATE.

hasSecret

public boolean hasSecret()

Returns true if the underlying TinkKey has a secret.

getKey

public TinkKey getKey(KeyAccess access)
               throws GeneralSecurityException

Returns the underlying TinkKey key if access is a SecretKeyAccess and the key has a secret, or if the key does not have a secret, otherwise throws a GeneralSecurityException.

Throws:

GeneralSecurityException