com.google.crypto.tink.hybrid

Class HpkeParameters

java.lang.Object

com.google.crypto.tink.Parameters

com.google.crypto.tink.hybrid.HybridParameters

com.google.crypto.tink.hybrid.HpkeParameters

public final class HpkeParameters
extends HybridParameters

Description of the parameters for an HpkePublicKey or HpkePrivateKey.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HpkeParameters.AeadId HPKE AEAD identifiers.
static class	HpkeParameters.Builder Builds a new HpkeParameters instance.
static class	HpkeParameters.KdfId HPKE KDF identifiers.
static class	HpkeParameters.KemId HPKE KEM identifiers.
static class	HpkeParameters.Variant Description of the output prefix prepended to the ciphertext.

Method Summary

Modifier and Type	Method and Description
static HpkeParameters.Builder	builder()
boolean	equals(Object o)
HpkeParameters.AeadId	getAeadId()
HpkeParameters.KdfId	getKdfId()
HpkeParameters.KemId	getKemId()
HpkeParameters.Variant	getVariant()
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.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static HpkeParameters.Builder builder()

getKemId

public HpkeParameters.KemId getKemId()

getKdfId

public HpkeParameters.KdfId getKdfId()

getAeadId

public HpkeParameters.AeadId getAeadId()

getVariant

public HpkeParameters.Variant getVariant()

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(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object