com.google.crypto.tink.hybrid

Class EciesAeadHkdfPrivateKeyManager

java.lang.Object

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

com.google.crypto.tink.internal.PrivateKeyTypeManager<EciesAeadHkdfPrivateKey,EciesAeadHkdfPublicKey>

com.google.crypto.tink.hybrid.EciesAeadHkdfPrivateKeyManager

public final class EciesAeadHkdfPrivateKeyManager
extends PrivateKeyTypeManager<EciesAeadHkdfPrivateKey,EciesAeadHkdfPublicKey>

This key manager generates new EciesAeadHkdfPrivateKey keys and produces new instances of EciesAeadHkdfHybridDecrypt.

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>

Method Summary

Modifier and Type	Method and Description
static KeyTemplate	eciesP256HkdfHmacSha256Aes128CtrHmacSha256Template()
static KeyTemplate	eciesP256HkdfHmacSha256Aes128GcmTemplate()
String	getKeyType() Returns the type URL that identifies the key type of keys managed by this KeyManager.
EciesAeadHkdfPublicKey	getPublicKey(EciesAeadHkdfPrivateKey key) Creates a public key from the given private key.
int	getVersion() Returns the version number of this KeyManager.
KeyTypeManager.KeyFactory<EciesAeadHkdfKeyFormat,EciesAeadHkdfPrivateKey>	keyFactory() Returns the KeyTypeManager.KeyFactory for this key type.
KeyData.KeyMaterialType	keyMaterialType() Returns the KeyData.KeyMaterialType for this proto.
EciesAeadHkdfPrivateKey	parseKey(com.google.protobuf.ByteString byteString) Parses a serialized key proto.
static KeyTemplate	rawEciesP256HkdfHmacSha256Aes128CtrHmacSha256CompressedTemplate()
static KeyTemplate	rawEciesP256HkdfHmacSha256Aes128GcmCompressedTemplate()
static void	registerPair(boolean newKeyAllowed) Registers the EciesAeadHkdfPrivateKeyManager and the EciesAeadHkdfPublicKeyManager with the registry, so that the the EciesAeadHkdfKeys can be used with Tink.
void	validateKey(EciesAeadHkdfPrivateKey keyProto) 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

Method Detail

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<EciesAeadHkdfPrivateKey>

getVersion

public int getVersion()

Description copied from class: KeyTypeManager

Returns the version number of this KeyManager.

Specified by:

getVersion in class KeyTypeManager<EciesAeadHkdfPrivateKey>

getPublicKey

public EciesAeadHkdfPublicKey getPublicKey(EciesAeadHkdfPrivateKey key)
                                    throws GeneralSecurityException

Description copied from class: PrivateKeyTypeManager

Creates a public key from the given private key.

Specified by:

getPublicKey in class PrivateKeyTypeManager<EciesAeadHkdfPrivateKey,EciesAeadHkdfPublicKey>

Throws:

GeneralSecurityException

keyMaterialType

public KeyData.KeyMaterialType keyMaterialType()

Description copied from class: KeyTypeManager

Returns the KeyData.KeyMaterialType for this proto.

Specified by:

keyMaterialType in class KeyTypeManager<EciesAeadHkdfPrivateKey>

parseKey

public EciesAeadHkdfPrivateKey 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<EciesAeadHkdfPrivateKey>

Throws:

com.google.protobuf.InvalidProtocolBufferException

validateKey

public void validateKey(EciesAeadHkdfPrivateKey keyProto)
                 throws GeneralSecurityException

Description copied from class: KeyTypeManager

Checks if the given keyProto is a valid key.

Specified by:

validateKey in class KeyTypeManager<EciesAeadHkdfPrivateKey>

Throws:

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

keyFactory

public KeyTypeManager.KeyFactory<EciesAeadHkdfKeyFormat,EciesAeadHkdfPrivateKey> 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<EciesAeadHkdfPrivateKey>

registerPair

public static void registerPair(boolean newKeyAllowed)
                         throws GeneralSecurityException

Registers the EciesAeadHkdfPrivateKeyManager and the EciesAeadHkdfPublicKeyManager with the registry, so that the the EciesAeadHkdfKeys can be used with Tink.

Throws:

GeneralSecurityException

eciesP256HkdfHmacSha256Aes128GcmTemplate

public static final KeyTemplate eciesP256HkdfHmacSha256Aes128GcmTemplate()

Returns:

a KeyTemplate that generates new instances of ECIES-AEAD-HKDF key pairs with the following parameters:

• KEM: ECDH over NIST P-256
• DEM: AES128-GCM
• KDF: HKDF-HMAC-SHA256 with an empty salt
• EC Point Format: Uncompressed
• Prefix type: KeyTemplate.OutputPrefixType#TINK

Unlike other key templates that use AES-GCM, the instances of HybridDecrypt generated by this key template has no limitation on Android KitKat (API level 19). They might not work in older versions though.

rawEciesP256HkdfHmacSha256Aes128GcmCompressedTemplate

public static final KeyTemplate rawEciesP256HkdfHmacSha256Aes128GcmCompressedTemplate()

Returns:

a KeyTemplate that generates new instances of ECIES-AEAD-HKDF key pairs with the following parameters:

• KEM: ECDH over NIST P-256
• DEM: AES128-GCM
• KDF: HKDF-HMAC-SHA256 with an empty salt
• EC Point Format: Compressed
• Prefix type: KeyTemplate.OutputPrefixType#RAW (no prefix)

Unlike other key templates that use AES-GCM, the instances of HybridDecrypt generated by this key template has no limitation on Android KitKat (API level 19). They might not work in older versions though.

eciesP256HkdfHmacSha256Aes128CtrHmacSha256Template

public static final KeyTemplate eciesP256HkdfHmacSha256Aes128CtrHmacSha256Template()

Returns:

a KeyTemplate that generates new instances of ECIES-AEAD-HKDF key pairs with the following parameters:

• KEM: ECDH over NIST P-256
• DEM: AES128-CTR-HMAC-SHA256 with the following parameters
  • AES key size: 16 bytes
  • AES CTR IV size: 16 bytes
  • HMAC key size: 32 bytes
  • HMAC tag size: 16 bytes
• KDF: HKDF-HMAC-SHA256 with an empty salt
• EC Point Format: Uncompressed
• Prefix type: KeyTemplate.OutputPrefixType#TINK

rawEciesP256HkdfHmacSha256Aes128CtrHmacSha256CompressedTemplate

public static final KeyTemplate rawEciesP256HkdfHmacSha256Aes128CtrHmacSha256CompressedTemplate()

Returns:

a KeyTemplate that generates new instances of ECIES-AEAD-HKDF key pairs with the following parameters:

• KEM: ECDH over NIST P-256
• DEM: AES128-CTR-HMAC-SHA256 with the following parameters
  • AES key size: 16 bytes
  • AES CTR IV size: 16 bytes
  • HMAC key size: 32 bytes
  • HMAC tag size: 16 bytes
• KDF: HKDF-HMAC-SHA256 with an empty salt
• EC Point Format: Compressed
• Prefix type: KeyTemplate.OutputPrefixType#RAW (no prefix)