com.google.crypto.tink.aead

Class XChaCha20Poly1305Parameters

java.lang.Object

com.google.crypto.tink.Parameters

com.google.crypto.tink.aead.AeadParameters

com.google.crypto.tink.aead.XChaCha20Poly1305Parameters

public final class XChaCha20Poly1305Parameters
extends AeadParameters

Describes the parameters of an XChaChaPoly1305Key.

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

create

public static XChaCha20Poly1305Parameters create()

create

public static XChaCha20Poly1305Parameters create(XChaCha20Poly1305Parameters.Variant variant)

getVariant

public XChaCha20Poly1305Parameters.Variant getVariant()

Returns a variant object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class 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 String toString()

Overrides:

toString in class Object