com.google.crypto.tink.hybrid.internal

Class HpkePrivateKeyManager

java.lang.Object

com.google.crypto.tink.internal.KeyTypeManager<KeyProtoT>

com.google.crypto.tink.internal.PrivateKeyTypeManager<HpkePrivateKey,HpkePublicKey>

com.google.crypto.tink.hybrid.internal.HpkePrivateKeyManager

public final class HpkePrivateKeyManager
extends PrivateKeyTypeManager<HpkePrivateKey,HpkePublicKey>

Key manager that generates new HpkePrivateKey keys and produces new instances of HpkeDecrypt primitives.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.crypto.tink.internal.KeyTypeManager

KeyTypeManager.KeyFactory<KeyFormatProtoT extends com.google.protobuf.MessageLite,KeyProtoT extends com.google.protobuf.MessageLite>

Constructor Summary

Constructors

Constructor and Description
HpkePrivateKeyManager()

Method Summary

Modifier and Type	Method and Description
String	getKeyType() Returns the type URL that identifies the key type of keys managed by this KeyManager.
HpkePublicKey	getPublicKey(HpkePrivateKey key) Creates a public key from the given private key.
int	getVersion() Returns the version number of this KeyManager.
KeyTypeManager.KeyFactory<HpkeKeyFormat,HpkePrivateKey>	keyFactory() Returns the KeyTypeManager.KeyFactory for this key type.
KeyData.KeyMaterialType	keyMaterialType() Returns the KeyData.KeyMaterialType for this proto.
HpkePrivateKey	parseKey(com.google.protobuf.ByteString byteString) Parses a serialized key proto.
static void	registerPair(boolean newKeyAllowed) Registers an HpkePrivateKeyManager and an HpkePublicKeyManager with the registry, so that HpkePrivateKey and HpkePublicKey key types can be used with Tink.
void	validateKey(HpkePrivateKey key) Checks if the given keyProto is a valid key.

Methods inherited from class com.google.crypto.tink.internal.PrivateKeyTypeManager

getPublicKeyClass

Methods inherited from class com.google.crypto.tink.internal.KeyTypeManager

fipsStatus, firstSupportedPrimitiveClass, getKeyClass, getPrimitive, supportedPrimitives

Methods inherited from class java.lang.Object

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

Constructor Detail

HpkePrivateKeyManager

public HpkePrivateKeyManager()

Method Detail

registerPair

public static void registerPair(boolean newKeyAllowed)
                         throws GeneralSecurityException

Registers an HpkePrivateKeyManager and an HpkePublicKeyManager with the registry, so that HpkePrivateKey and HpkePublicKey key types can be used with Tink.

Throws:

GeneralSecurityException

getKeyType

public String getKeyType()

Description copied from class: KeyTypeManager

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

Specified by:

getKeyType in class KeyTypeManager<HpkePrivateKey>

getVersion

public int getVersion()

Description copied from class: KeyTypeManager

Returns the version number of this KeyManager.

Specified by:

getVersion in class KeyTypeManager<HpkePrivateKey>

getPublicKey

public HpkePublicKey getPublicKey(HpkePrivateKey key)

Description copied from class: PrivateKeyTypeManager

Creates a public key from the given private key.

Specified by:

getPublicKey in class PrivateKeyTypeManager<HpkePrivateKey,HpkePublicKey>

keyMaterialType

public KeyData.KeyMaterialType keyMaterialType()

Description copied from class: KeyTypeManager

Returns the KeyData.KeyMaterialType for this proto.

Specified by:

keyMaterialType in class KeyTypeManager<HpkePrivateKey>

parseKey

public HpkePrivateKey parseKey(com.google.protobuf.ByteString byteString)
                        throws com.google.protobuf.InvalidProtocolBufferException

Description copied from class: KeyTypeManager

Parses a serialized key proto.

Implement as return KeyProtoT.parseFrom(byteString);.

Specified by:

parseKey in class KeyTypeManager<HpkePrivateKey>

Throws:

com.google.protobuf.InvalidProtocolBufferException

validateKey

public void validateKey(HpkePrivateKey key)
                 throws GeneralSecurityException

Description copied from class: KeyTypeManager

Checks if the given keyProto is a valid key.

Specified by:

validateKey in class KeyTypeManager<HpkePrivateKey>

Throws:

GeneralSecurityException - if the passed keyProto is not valid in any way.

keyFactory

public KeyTypeManager.KeyFactory<HpkeKeyFormat,HpkePrivateKey> keyFactory()

Description copied from class: KeyTypeManager

Returns the KeyTypeManager.KeyFactory for this key type.

By default, this throws an UnsupportedOperationException. Hence, if an implementation does not support creating primitives, no implementation is required.

Overrides:

keyFactory in class KeyTypeManager<HpkePrivateKey>