com.google.crypto.tink

Class Parameters

java.lang.Object

com.google.crypto.tink.Parameters

Direct Known Subclasses:

AeadParameters, LegacyProtoParameters, MacParameters, PrfParameters, SignatureParameters

@Immutable
 @Alpha
public abstract class Parameters
extends Object

Represents a cryptographic function without the actual key material.

In Tink, a Key represents a set of cryptographic functions. The Parameters class contains all the information about the function which is not randomly chosen with each instance.

Constructor Summary

Constructors

Constructor and Description
Parameters()

Method Summary

Modifier and Type	Method and Description
abstract 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Parameters

public Parameters()

Method Detail

hasIdRequirement

public abstract 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.

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.