com.google.crypto.tink

Class KeyManagerImpl<PrimitiveT,KeyProtoT extends com.google.protobuf.MessageLite>

java.lang.Object

com.google.crypto.tink.KeyManagerImpl<PrimitiveT,KeyProtoT>

All Implemented Interfaces:

KeyManager<PrimitiveT>

Direct Known Subclasses:

PrivateKeyManagerImpl

@Alpha
public class KeyManagerImpl<PrimitiveT,KeyProtoT extends com.google.protobuf.MessageLite>
extends Object
implements KeyManager<PrimitiveT>

Implementation of the KeyManager interface based on an KeyTypeManager.

Choosing PrimitiveT equal to Void is valid; in this case the functions getPrimitive(com.google.protobuf.ByteString) will throw if invoked.

TODO(tholenst): Visibility restrict to package visibility once all key managers are migrated to KeyTypeManager's.

Constructor Summary

Constructors

Constructor and Description
KeyManagerImpl(KeyTypeManager<KeyProtoT> keyTypeManager, Class<PrimitiveT> primitiveClass)

Method Summary

Modifier and Type	Method and Description
boolean	doesSupport(String typeUrl)
String	getKeyType()
PrimitiveT	getPrimitive(com.google.protobuf.ByteString serializedKey) Constructs an instance of P for the key given in serializedKey, which must be a serialized key protocol buffer handled by this manager.
PrimitiveT	getPrimitive(com.google.protobuf.MessageLite key) Constructs an instance of P for the key given in key.
Class<PrimitiveT>	getPrimitiveClass() Returns the primitive class object of the P.
int	getVersion()
com.google.protobuf.MessageLite	newKey(com.google.protobuf.ByteString serializedKeyFormat) Generates a new key according to specification in serializedKeyFormat, which must be a serialized key format protocol buffer handled by this manager.
com.google.protobuf.MessageLite	newKey(com.google.protobuf.MessageLite keyFormat) Generates a new key according to specification in keyFormat.
com.google.crypto.tink.proto.KeyData	newKeyData(com.google.protobuf.ByteString serializedKeyFormat) Generates a new KeyData according to specification in serializedkeyFormat.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyManagerImpl

public KeyManagerImpl(KeyTypeManager<KeyProtoT> keyTypeManager,
                      Class<PrimitiveT> primitiveClass)

Method Detail

getPrimitive

public final PrimitiveT getPrimitive(com.google.protobuf.ByteString serializedKey)
                              throws GeneralSecurityException

Description copied from interface: KeyManager

Constructs an instance of P for the key given in serializedKey, which must be a serialized key protocol buffer handled by this manager.

Specified by:

getPrimitive in interface KeyManager<PrimitiveT>

Returns:

the new constructed P

Throws:

GeneralSecurityException - if the key given in serializedKey is corrupted or not supported

getPrimitive

public final PrimitiveT getPrimitive(com.google.protobuf.MessageLite key)
                              throws GeneralSecurityException

Description copied from interface: KeyManager

Constructs an instance of P for the key given in key.

Specified by:

getPrimitive in interface KeyManager<PrimitiveT>

Returns:

the new constructed P

Throws:

GeneralSecurityException - if the key given in key is corrupted or not supported

newKey

public final com.google.protobuf.MessageLite newKey(com.google.protobuf.ByteString serializedKeyFormat)
                                             throws GeneralSecurityException

Description copied from interface: KeyManager

Generates a new key according to specification in serializedKeyFormat, which must be a serialized key format protocol buffer handled by this manager.

Specified by:

newKey in interface KeyManager<PrimitiveT>

Returns:

the new generated key

Throws:

GeneralSecurityException - if the specified format is wrong or not supported

newKey

public final com.google.protobuf.MessageLite newKey(com.google.protobuf.MessageLite keyFormat)
                                             throws GeneralSecurityException

Description copied from interface: KeyManager

Generates a new key according to specification in keyFormat.

Specified by:

newKey in interface KeyManager<PrimitiveT>

Returns:

the new generated key

Throws:

GeneralSecurityException - if the specified format is wrong or not supported

doesSupport

public final boolean doesSupport(String typeUrl)

Specified by:

doesSupport in interface KeyManager<PrimitiveT>

Returns:

true iff this KeyManager supports key type identified by typeUrl.

getKeyType

public final String getKeyType()

Specified by:

getKeyType in interface KeyManager<PrimitiveT>

Returns:

the type URL that identifies the key type of keys managed by this KeyManager.

getVersion

public int getVersion()

Specified by:

getVersion in interface KeyManager<PrimitiveT>

Returns:

the version number of this KeyManager.

newKeyData

public final com.google.crypto.tink.proto.KeyData newKeyData(com.google.protobuf.ByteString serializedKeyFormat)
                                                      throws GeneralSecurityException

Description copied from interface: KeyManager

Generates a new KeyData according to specification in serializedkeyFormat.

This should be used solely by KeysetManager.

Specified by:

newKeyData in interface KeyManager<PrimitiveT>

Returns:

the new generated key

Throws:

GeneralSecurityException - if the specified format is wrong or not supported

getPrimitiveClass

public final Class<PrimitiveT> getPrimitiveClass()

Description copied from interface: KeyManager

Returns the primitive class object of the P. Should be implemented as return P.class; when implementing a key manager for primitive {$code P}.

Specified by:

getPrimitiveClass in interface KeyManager<PrimitiveT>

Returns:

P.class