com.google.crypto.tink.tinkkey

Class KeyHandle

java.lang.Object

com.google.crypto.tink.tinkkey.KeyHandle

Direct Known Subclasses:

InternalKeyHandle

@Immutable
public 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.

Do not use this in new code. Instead, use Key and these facilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyHandle.KeyStatusType KeyStatusType is metadata associated to a key which is only meaningful when the key is part of a Keyset.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyHandle(TinkKey key, KeyHandle.KeyStatusType status, int keyId) Constructor intended for Tink internal purposes; allows one to set all the member variables of a KeyHandle.

Method Summary

Modifier and Type	Method and Description
static KeyHandle	createFromKey(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.
static KeyHandle	generateNew(KeyTemplate keyTemplate) Generates a new KeyHandle that contains a fresh key generated according to keyTemplate.
int	getId() Returns the key ID of this key.
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.
KeyTemplate	getKeyTemplate() Returns the KeyTemplate of the underlying TinkKey.
KeyHandle.KeyStatusType	getStatus() Returns the status of the key.
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

Constructor Detail

KeyHandle

protected KeyHandle(TinkKey key,
                    KeyHandle.KeyStatusType status,
                    int keyId)

Constructor intended for Tink internal purposes; allows one to set all the member variables of a KeyHandle.

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(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.

Do not use this in new code. Instead, use Key and these facilities.

generateNew

public static KeyHandle generateNew(KeyTemplate keyTemplate)
                             throws GeneralSecurityException

Generates a new KeyHandle that contains a fresh key generated according to keyTemplate.

Throws:

GeneralSecurityException - if the key template's type URL has not been registered with the Registry.

hasSecret

public boolean hasSecret()

Returns true if the underlying TinkKey has a secret.

getStatus

public KeyHandle.KeyStatusType getStatus()

Returns the status of the key. See KeyHandle.KeyStatusType.

getId

public int getId()

Returns the key ID of this key. The key ID is not guaranteed to be unique among all KeyHandles.

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

getKeyTemplate

public KeyTemplate getKeyTemplate()

Returns the KeyTemplate of the underlying TinkKey.

Throws:

UnsupportedOperationException - if the underlying TinkKey has not implemented getKeyTemplate().