Package com.google.crypto.tink.aead

Class LegacyKmsAeadParameters

java.lang.Object

com.google.crypto.tink.Parameters

com.google.crypto.tink.aead.AeadParameters

com.google.crypto.tink.aead.LegacyKmsAeadParameters

public final class LegacyKmsAeadParameters
extends AeadParameters

Describes the parameters of an KmsAeadKey

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LegacyKmsAeadParameters.Variant	Describes how the prefix is computed.

Method Summary

Modifier and Type	Method	Description
static LegacyKmsAeadParameters	create(java.lang.String keyUri)
static LegacyKmsAeadParameters	create(java.lang.String keyUri, LegacyKmsAeadParameters.Variant variant)
boolean	equals(java.lang.Object o)
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	keyUri()
java.lang.String	toString()
LegacyKmsAeadParameters.Variant	variant()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static LegacyKmsAeadParameters create(java.lang.String keyUri)
                                      throws java.security.GeneralSecurityException

Throws:

java.security.GeneralSecurityException

create

public static LegacyKmsAeadParameters create(java.lang.String keyUri,
                                             LegacyKmsAeadParameters.Variant variant)

keyUri

public java.lang.String keyUri()

variant

public LegacyKmsAeadParameters.Variant variant()

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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object