com.google.crypto.tink

Interface KeyManager<P>

All Known Subinterfaces:

PrivateKeyManager<P>

public interface KeyManager<P>

A KeyManager "understands" keys of a specific key type: it can generate keys of the supported type and create primitives for supported keys.

A key type is identified by the global name of the protocol buffer that holds the corresponding key material, and is given by typeUrl-field of KeyData-protocol buffer.

The template parameter P denotes the primitive corresponding to the keys handled by this manager.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
boolean	doesSupport(String typeUrl)
String	getKeyType()
P	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.
P	getPrimitive(com.google.protobuf.MessageLite key) Constructs an instance of P for the key given in key.
Class<P>	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.
KeyData	newKeyData(com.google.protobuf.ByteString serializedKeyFormat) Generates a new KeyData according to specification in serializedkeyFormat.

Method Detail

getPrimitive

P getPrimitive(com.google.protobuf.ByteString serializedKey)
        throws GeneralSecurityException

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

For primitives of type Mac, Aead, PublicKeySign, PublicKeyVerify, DeterministicAead, HybridEncrypt, and HybridDecrypt this should be a primitive which ignores the output prefix and assumes "RAW".

Returns:

the new constructed P

Throws:

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

getPrimitive

P getPrimitive(com.google.protobuf.MessageLite key)
        throws GeneralSecurityException

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

For primitives of type Mac, Aead, PublicKeySign, PublicKeyVerify, DeterministicAead, HybridEncrypt, and HybridDecrypt this should be a primitive which ignores the output prefix and assumes "RAW".

Returns:

the new constructed P

Throws:

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

newKey

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

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

Returns:

the new generated key

Throws:

GeneralSecurityException - if the specified format is wrong or not supported

newKey

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

Generates a new key according to specification in keyFormat.

Returns:

the new generated key

Throws:

GeneralSecurityException - if the specified format is wrong or not supported

doesSupport

boolean doesSupport(String typeUrl)

Returns:

true iff this KeyManager supports key type identified by typeUrl.

getKeyType

String getKeyType()

Returns:

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

getVersion

int getVersion()

Returns:

the version number of this KeyManager.

getPrimitiveClass

Class<P> getPrimitiveClass()

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

Returns:

P.class

newKeyData

KeyData newKeyData(com.google.protobuf.ByteString serializedKeyFormat)
            throws GeneralSecurityException

Generates a new KeyData according to specification in serializedkeyFormat.

This should be used solely by KeysetManager.

Returns:

the new generated key

Throws:

GeneralSecurityException - if the specified format is wrong or not supported