com.google.crypto.tink.prf

Class HkdfPrfParameters

java.lang.Object

com.google.crypto.tink.Parameters

com.google.crypto.tink.prf.PrfParameters

com.google.crypto.tink.prf.HkdfPrfParameters

@Alpha
public final class HkdfPrfParameters
extends PrfParameters

Describes the parameters of an HkdfPrfKey.

This API is annotated with Alpha because it is not yet stable and might change in the future.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HkdfPrfParameters.Builder Builder for HkdfPrfParameters.
static class	HkdfPrfParameters.HashType The Hash algorithm used.

Method Summary

Modifier and Type	Method and Description
static HkdfPrfParameters.Builder	builder()
boolean	equals(Object o)
HkdfPrfParameters.HashType	getHashType()
int	getKeySizeBytes()
Bytes	getSalt() Gets the salt value, which defaults to null if not set, as per RFC 5869.
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

builder

public static HkdfPrfParameters.Builder builder()

getKeySizeBytes

public int getKeySizeBytes()

getHashType

public HkdfPrfParameters.HashType getHashType()

getSalt

@Nullable
public Bytes getSalt()

Gets the salt value, which defaults to null if not set, as per RFC 5869. The HKDF PRF implementation must convert a null salt to a string of zeros that is the length of the hash function output.

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