com.google.crypto.tink.aead

Class AesEaxKeyManager

java.lang.Object

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

com.google.crypto.tink.aead.AesEaxKeyManager

public final class AesEaxKeyManager
extends KeyTypeManager<AesEaxKey>

This key manager generates new AesEaxKey keys and produces new instances of AesEaxJce.

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	aes128EaxTemplate()
static KeyTemplate	aes256EaxTemplate()
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<AesEaxKeyFormat,AesEaxKey>	keyFactory() Returns the KeyTypeManager.KeyFactory for this key type.
KeyData.KeyMaterialType	keyMaterialType() Returns the KeyData.KeyMaterialType for this proto.
AesEaxKey	parseKey(com.google.protobuf.ByteString byteString) Parses a serialized key proto.
static KeyTemplate	rawAes128EaxTemplate()
static KeyTemplate	rawAes256EaxTemplate()
static void	register(boolean newKeyAllowed)
void	validateKey(AesEaxKey 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<AesEaxKey>

getVersion

public int getVersion()

Description copied from class: KeyTypeManager

Returns the version number of this KeyManager.

Specified by:

getVersion in class KeyTypeManager<AesEaxKey>

keyMaterialType

public KeyData.KeyMaterialType keyMaterialType()

Description copied from class: KeyTypeManager

Returns the KeyData.KeyMaterialType for this proto.

Specified by:

keyMaterialType in class KeyTypeManager<AesEaxKey>

validateKey

public void validateKey(AesEaxKey key)
                 throws GeneralSecurityException

Description copied from class: KeyTypeManager

Checks if the given keyProto is a valid key.

Specified by:

validateKey in class KeyTypeManager<AesEaxKey>

Throws:

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

parseKey

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

keyFactory

public KeyTypeManager.KeyFactory<AesEaxKeyFormat,AesEaxKey> 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<AesEaxKey>

register

public static void register(boolean newKeyAllowed)
                     throws GeneralSecurityException

Throws:

GeneralSecurityException

aes128EaxTemplate

public static final KeyTemplate aes128EaxTemplate()

Returns:

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

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

rawAes128EaxTemplate

public static final KeyTemplate rawAes128EaxTemplate()

Returns:

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

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

aes256EaxTemplate

public static final KeyTemplate aes256EaxTemplate()

Returns:

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

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

rawAes256EaxTemplate

public static final KeyTemplate rawAes256EaxTemplate()

Returns:

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

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