com.google.crypto.tink

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

java.lang.Object

com.google.crypto.tink.PrivateKeyManagerImpl<PrimitiveT,KeyProtoT,PublicKeyProtoT>

All Implemented Interfaces:

KeyManager<PrimitiveT>, PrivateKeyManager<PrimitiveT>

@Alpha
public class PrivateKeyManagerImpl<PrimitiveT,KeyProtoT extends com.google.protobuf.MessageLite,PublicKeyProtoT extends com.google.protobuf.MessageLite>
extends Object
implements PrivateKeyManager<PrimitiveT>

Implementation of the PrivateKeyManager interface based on an PrivateKeyTypeManager and the corresponding public key manager, implemented by 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) Reduce visibility to package visible once all managers have been migrated.

Constructor Summary

Constructors

Constructor and Description
PrivateKeyManagerImpl(PrivateKeyTypeManager<KeyProtoT,PublicKeyProtoT> privateKeyManager, KeyTypeManager<PublicKeyProtoT> publicKeyManager, 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.
com.google.crypto.tink.proto.KeyData	getPublicKeyData(com.google.protobuf.ByteString serializedKey) Extracts the public key data from the private key data.
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

Methods inherited from interface com.google.crypto.tink.KeyManager

doesSupport, getKeyType, getPrimitive, getPrimitive, getPrimitiveClass, getVersion, newKey, newKey, newKeyData

Constructor Detail

PrivateKeyManagerImpl

public PrivateKeyManagerImpl(PrivateKeyTypeManager<KeyProtoT,PublicKeyProtoT> privateKeyManager,
                             KeyTypeManager<PublicKeyProtoT> publicKeyManager,
                             Class<PrimitiveT> primitiveClass)

Method Detail

getPublicKeyData

public com.google.crypto.tink.proto.KeyData getPublicKeyData(com.google.protobuf.ByteString serializedKey)
                                                      throws GeneralSecurityException

Description copied from interface: PrivateKeyManager

Extracts the public key data from the private key data.

Specified by:

getPublicKeyData in interface PrivateKeyManager<PrimitiveT>

Returns:

the KeyData containing the public keys

Throws:

GeneralSecurityException - if the specified format is wrong or not supported

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