com.google.crypto.tink.aead

Class AesGcmKeyManager

java.lang.Object

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

com.google.crypto.tink.aead.AesGcmKeyManager

public final class AesGcmKeyManager
extends KeyTypeManager<AesGcmKey>

This key manager generates new AesGcmKey keys and produces new instances of AesGcmJce.

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	aes128GcmTemplate()
static KeyTemplate	aes256GcmTemplate()
TinkFipsUtil.AlgorithmFipsCompatibility	fipsStatus() Returns the FIPS compatibility of this KeyTypeManager.
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<AesGcmKeyFormat,AesGcmKey>	keyFactory() Returns the KeyTypeManager.KeyFactory for this key type.
KeyData.KeyMaterialType	keyMaterialType() Returns the KeyData.KeyMaterialType for this proto.
AesGcmKey	parseKey(com.google.protobuf.ByteString byteString) Parses a serialized key proto.
static KeyTemplate	rawAes128GcmTemplate()
static KeyTemplate	rawAes256GcmTemplate()
static void	register(boolean newKeyAllowed)
void	validateKey(AesGcmKey key) Checks if the given keyProto is a valid key.

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

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

getVersion

public int getVersion()

Description copied from class: KeyTypeManager

Returns the version number of this KeyManager.

Specified by:

getVersion in class KeyTypeManager<AesGcmKey>

keyMaterialType

public KeyData.KeyMaterialType keyMaterialType()

Description copied from class: KeyTypeManager

Returns the KeyData.KeyMaterialType for this proto.

Specified by:

keyMaterialType in class KeyTypeManager<AesGcmKey>

validateKey

public void validateKey(AesGcmKey key)
                 throws GeneralSecurityException

Description copied from class: KeyTypeManager

Checks if the given keyProto is a valid key.

Specified by:

validateKey in class KeyTypeManager<AesGcmKey>

Throws:

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

parseKey

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

keyFactory

public KeyTypeManager.KeyFactory<AesGcmKeyFormat,AesGcmKey> 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<AesGcmKey>

register

public static void register(boolean newKeyAllowed)
                     throws GeneralSecurityException

Throws:

GeneralSecurityException

aes128GcmTemplate

public static final KeyTemplate aes128GcmTemplate()

Returns:

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

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

On Android KitKat (API level 19), the Aead instance generated by this key template does not support associated data. It might not work at all in older versions.

rawAes128GcmTemplate

public static final KeyTemplate rawAes128GcmTemplate()

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.

On Android KitKat (API level 19), the Aead instance generated by this key template does not support associated data. It might not work at all in older versions.

aes256GcmTemplate

public static final KeyTemplate aes256GcmTemplate()

Returns:

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

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

On Android KitKat (API level 19), the Aead instance generated by this key template does not support associated data. It might not work at all in older versions.

rawAes256GcmTemplate

public static final KeyTemplate rawAes256GcmTemplate()

Returns:

a KeyTemplate that generates new instances of AES-GCM 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.

On Android KitKat (API level 19), the Aead instance generated by this key template does not support associated data. It might not work at all in older versions.

fipsStatus

public TinkFipsUtil.AlgorithmFipsCompatibility fipsStatus()

Description copied from class: KeyTypeManager

Returns the FIPS compatibility of this KeyTypeManager.

Overrides:

fipsStatus in class KeyTypeManager<AesGcmKey>