Package com.google.crypto.tink.aead

Class AesCtrHmacAeadParameters

java.lang.Object

com.google.crypto.tink.Parameters

com.google.crypto.tink.aead.AeadParameters

com.google.crypto.tink.aead.AesCtrHmacAeadParameters

public final class AesCtrHmacAeadParameters
extends AeadParameters

Describes the parameters of an AesCtrHmacAeadKey.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AesCtrHmacAeadParameters.Builder	Builds a new AesCtrHmacAeadParameters instance.
static class	AesCtrHmacAeadParameters.HashType	The Hash algorithm used for the HMAC.
static class	AesCtrHmacAeadParameters.Variant	Describes how the prefix is computed.

Method Summary

Modifier and Type	Method	Description
static AesCtrHmacAeadParameters.Builder	builder()
boolean	equals(java.lang.Object o)
int	getAesKeySizeBytes()
int	getCiphertextOverheadSizeBytes()	Returns the size of the overhead added to the actual ciphertext (i.e.
AesCtrHmacAeadParameters.HashType	getHashType()	Returns a hash type object.
int	getHmacKeySizeBytes()
int	getIvSizeBytes()
int	getTagSizeBytes()
AesCtrHmacAeadParameters.Variant	getVariant()	Returns a variant object.
int	hashCode()
boolean	hasIdRequirement()	Returns true if a key created with the parameters in this object has to have a certain ID when it is in a keyset.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static AesCtrHmacAeadParameters.Builder builder()

getAesKeySizeBytes

public int getAesKeySizeBytes()

getHmacKeySizeBytes

public int getHmacKeySizeBytes()

getTagSizeBytes

public int getTagSizeBytes()

getIvSizeBytes

public int getIvSizeBytes()

getCiphertextOverheadSizeBytes

public int getCiphertextOverheadSizeBytes()

Returns the size of the overhead added to the actual ciphertext (i.e. the size of the IV plus the size of the security relevant tag plus the size of the prefix with which this key prefixes the ciphertext.

getVariant

public AesCtrHmacAeadParameters.Variant getVariant()

Returns a variant object.

getHashType

public AesCtrHmacAeadParameters.HashType getHashType()

Returns a hash type object.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

hasIdRequirement

public boolean hasIdRequirement()

Description copied from class: Parameters

Returns true if a key created with the parameters in this object has to have a certain ID when it is in a keyset.

In Tink, certain keys change their behavior depending on the key id (for example, an Aead object can prefix the ciphertext with the big endian encoding of the key id). If this is the case, such a key should require a unique id in Key.getIdRequirementOrNull() and return true here.

Specified by:

hasIdRequirement in class Parameters

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object