com.google.crypto.tink.aead

Class AesGcmSivKeyManager

java.lang.Object

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

com.google.crypto.tink.aead.AesGcmSivKeyManager

public final class AesGcmSivKeyManager
extends KeyTypeManager<AesGcmSivKey>

This key manager generates new AesGcmSivKey keys and produces new instances of AesGcmSiv.

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	aes128GcmSivTemplate() Creates and returns a KeyTemplate that generates new instances of AES-GCM-SIV with the following parameters: Key size: 16 bytes Prefix type: KeyTemplate.OutputPrefixType#TINK
static KeyTemplate	aes256GcmSivTemplate() Creates and returns a KeyTemplate that generates new instances of AES-GCM-SIV with the following parameters: Key size: 32 bytes Prefix type: KeyTemplate.OutputPrefixType#TINK
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<AesGcmSivKeyFormat,AesGcmSivKey>	keyFactory() Returns the KeyTypeManager.KeyFactory for this key type.
KeyData.KeyMaterialType	keyMaterialType() Returns the KeyData.KeyMaterialType for this proto.
AesGcmSivKey	parseKey(com.google.protobuf.ByteString byteString) Parses a serialized key proto.
static KeyTemplate	rawAes128GcmSivTemplate() Creates and returns a KeyTemplate that generates new instances of AES-GCM with the following parameters: Key size: 16 bytes Prefix type: KeyTemplate.OutputPrefixType#RAW (no prefix)
static KeyTemplate	rawAes256GcmSivTemplate() Creates and returns a KeyTemplate that generates new instances of AES-GCM-SIV with the following parameters: Key size: 32 bytes Prefix type: KeyTemplate.OutputPrefixType#RAW (no prefix)
static void	register(boolean newKeyAllowed)
void	validateKey(AesGcmSivKey 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<AesGcmSivKey>

getVersion

public int getVersion()

Description copied from class: KeyTypeManager

Returns the version number of this KeyManager.

Specified by:

getVersion in class KeyTypeManager<AesGcmSivKey>

keyMaterialType

public KeyData.KeyMaterialType keyMaterialType()

Description copied from class: KeyTypeManager

Returns the KeyData.KeyMaterialType for this proto.

Specified by:

keyMaterialType in class KeyTypeManager<AesGcmSivKey>

validateKey

public void validateKey(AesGcmSivKey key)
                 throws GeneralSecurityException

Description copied from class: KeyTypeManager

Checks if the given keyProto is a valid key.

Specified by:

validateKey in class KeyTypeManager<AesGcmSivKey>

Throws:

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

parseKey

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

keyFactory

public KeyTypeManager.KeyFactory<AesGcmSivKeyFormat,AesGcmSivKey> 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<AesGcmSivKey>

register

public static void register(boolean newKeyAllowed)
                     throws GeneralSecurityException

Throws:

GeneralSecurityException

aes128GcmSivTemplate

public static final KeyTemplate aes128GcmSivTemplate()

Creates and returns a KeyTemplate that generates new instances of AES-GCM-SIV with the following parameters:

• Key size: 16 bytes
• Prefix type: KeyTemplate.OutputPrefixType#TINK

rawAes128GcmSivTemplate

public static final KeyTemplate rawAes128GcmSivTemplate()

Creates and returns a KeyTemplate that generates new instances of AES-GCM with the following parameters:

• Key size: 16 bytes
• Prefix type: KeyTemplate.OutputPrefixType#RAW (no prefix)

Keys generated from this template should create ciphertexts compatible with other libraries.

aes256GcmSivTemplate

public static final KeyTemplate aes256GcmSivTemplate()

Creates and returns a KeyTemplate that generates new instances of AES-GCM-SIV with the following parameters:

• Key size: 32 bytes
• Prefix type: KeyTemplate.OutputPrefixType#TINK

rawAes256GcmSivTemplate

public static final KeyTemplate rawAes256GcmSivTemplate()

Creates and returns a KeyTemplate that generates new instances of AES-GCM-SIV with the following parameters:

• Key size: 32 bytes
• Prefix type: KeyTemplate.OutputPrefixType#RAW (no prefix)

Keys generated from this template should create ciphertexts compatible with other libraries.