com.google.crypto.tink.streamingaead

Class AesGcmHkdfStreamingKeyManager

java.lang.Object

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

com.google.crypto.tink.streamingaead.AesGcmHkdfStreamingKeyManager

public final class AesGcmHkdfStreamingKeyManager
extends KeyTypeManager<AesGcmHkdfStreamingKey>

This key manager generates new AesGcmHkdfStreamingKey keys and produces new instances of AesGcmHkdfStreaming.

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	aes128GcmHkdf1MBTemplate()
static KeyTemplate	aes128GcmHkdf4KBTemplate()
static KeyTemplate	aes256GcmHkdf1MBTemplate()
static KeyTemplate	aes256GcmHkdf4KBTemplate()
String	getKeyType() Returns the type URL that identifies the key type of keys managed by this KeyManager.
int	getVersion() Returns the version number of this KeyManager.
KeyTypeManager.KeyFactory<AesGcmHkdfStreamingKeyFormat,AesGcmHkdfStreamingKey>	keyFactory() Returns the KeyTypeManager.KeyFactory for this key type.
KeyData.KeyMaterialType	keyMaterialType() Returns the KeyData.KeyMaterialType for this proto.
AesGcmHkdfStreamingKey	parseKey(com.google.protobuf.ByteString byteString) Parses a serialized key proto.
static void	register(boolean newKeyAllowed)
void	validateKey(AesGcmHkdfStreamingKey key) Checks if the given keyProto is a valid key.

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

getVersion

public int getVersion()

Description copied from class: KeyTypeManager

Returns the version number of this KeyManager.

Specified by:

getVersion in class KeyTypeManager<AesGcmHkdfStreamingKey>

keyMaterialType

public KeyData.KeyMaterialType keyMaterialType()

Description copied from class: KeyTypeManager

Returns the KeyData.KeyMaterialType for this proto.

Specified by:

keyMaterialType in class KeyTypeManager<AesGcmHkdfStreamingKey>

validateKey

public void validateKey(AesGcmHkdfStreamingKey key)
                 throws GeneralSecurityException

Description copied from class: KeyTypeManager

Checks if the given keyProto is a valid key.

Specified by:

validateKey in class KeyTypeManager<AesGcmHkdfStreamingKey>

Throws:

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

parseKey

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

keyFactory

public KeyTypeManager.KeyFactory<AesGcmHkdfStreamingKeyFormat,AesGcmHkdfStreamingKey> 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<AesGcmHkdfStreamingKey>

register

public static void register(boolean newKeyAllowed)
                     throws GeneralSecurityException

Throws:

GeneralSecurityException

aes128GcmHkdf4KBTemplate

public static final KeyTemplate aes128GcmHkdf4KBTemplate()

Returns:

a KeyTemplate that generates new instances of AesGcmHkdfStreaming keys with the following parameters:

• Size of the main key: 16 bytes
• HKDF algo: HMAC-SHA256
• Size of AES-GCM derived keys: 16 bytes
• Ciphertext segment size: 4096 bytes

aes128GcmHkdf1MBTemplate

public static final KeyTemplate aes128GcmHkdf1MBTemplate()

Returns:

a KeyTemplate that generates new instances of AesGcmHkdfStreaming keys with the following parameters:

• Size of the main key: 16 bytes
• HKDF algo: HMAC-SHA256
• Size of AES-GCM derived keys: 16 bytes
• Ciphertext segment size: 1MB

aes256GcmHkdf4KBTemplate

public static final KeyTemplate aes256GcmHkdf4KBTemplate()

Returns:

a KeyTemplate that generates new instances of AesGcmHkdfStreaming keys with the following parameters:

• Size of the main key: 32 bytes
• HKDF algo: HMAC-SHA256
• Size of AES-GCM derived keys: 32 bytes
• Ciphertext segment size: 4096 bytes

aes256GcmHkdf1MBTemplate

public static final KeyTemplate aes256GcmHkdf1MBTemplate()

Returns:

a KeyTemplate that generates new instances of AesGcmHkdfStreaming keys with the following parameters:

• Size of the main key: 32 bytes
• HKDF algo: HMAC-SHA256
• Size of AES-GCM derived keys: 32 bytes
• Ciphertext segment size: 1MB