com.google.crypto.tink.tinkkey.internal

Class ProtoKey

java.lang.Object

com.google.crypto.tink.tinkkey.internal.ProtoKey

All Implemented Interfaces:

TinkKey

@Immutable
public final class ProtoKey
extends Object
implements TinkKey

Wraps the proto KeyData as an implementation of a TinkKey. The underlying KeyData determines whether this ProtoKey has a secret.

ProtoKey is not intended for use outside of the Tink project.

Constructor Summary

Constructors

Constructor and Description
ProtoKey(KeyData keyData, KeyTemplate.OutputPrefixType opt) Constructs a ProtoKey with hasSecret() returning true if the input KeyData has key material of type UNKNOWN_KEYMATERIAL, SYMMETRIC, or ASYMMETRIC_PRIVATE.

Method Summary

Modifier and Type	Method and Description
KeyTemplate	getKeyTemplate() A TinkKey should know the KeyTemplate from which it was generated, which in turn specifies the cryptographic algorithm in which the TinkKey should be used.
KeyTemplate.OutputPrefixType	getOutputPrefixType()
KeyData	getProtoKey()
boolean	hasSecret() Returns true if the key contains secret key material, and false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtoKey

public ProtoKey(KeyData keyData,
                KeyTemplate.OutputPrefixType opt)

Constructs a ProtoKey with hasSecret() returning true if the input KeyData has key material of type UNKNOWN_KEYMATERIAL, SYMMETRIC, or ASYMMETRIC_PRIVATE.

Method Detail

getProtoKey

public KeyData getProtoKey()

getOutputPrefixType

public KeyTemplate.OutputPrefixType getOutputPrefixType()

hasSecret

public boolean hasSecret()

Description copied from interface: TinkKey

Returns true if the key contains secret key material, and false otherwise.

Specified by:

hasSecret in interface TinkKey

getKeyTemplate

public KeyTemplate getKeyTemplate()

Description copied from interface: TinkKey

A TinkKey should know the KeyTemplate from which it was generated, which in turn specifies the cryptographic algorithm in which the TinkKey should be used. Throws UnsupportedOperationException to help ease rollout until it is possible to easily find the KeyTemplate associated to a key described in proto

Specified by:

getKeyTemplate in interface TinkKey

Returns:

the KeyTemplate used to generate the key.

Throws:

UnsupportedOperationException - There is currently no direct way of getting a KeyTemplate from KeyData.