Package com.google.crypto.tink.jwt

Class JwtHmacParameters

java.lang.Object

com.google.crypto.tink.Parameters

com.google.crypto.tink.jwt.JwtMacParameters

com.google.crypto.tink.jwt.JwtHmacParameters

public class JwtHmacParameters
extends JwtMacParameters

Describes the parameters of a JwtHmacKey.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JwtHmacParameters.Algorithm	The algorithm to be used for the mac computation.
static class	JwtHmacParameters.Builder	Helps creating a JwtHmacParameters object.
static class	JwtHmacParameters.KidStrategy	Specifies how the "kid" header is handled.

Method Summary

Modifier and Type	Method	Description
boolean	allowKidAbsent()	If true, tokens without "kid" header are allowed when verifying a token.
static JwtHmacParameters.Builder	builder()
boolean	equals(java.lang.Object o)
JwtHmacParameters.Algorithm	getAlgorithm()
int	getKeySizeBytes()
JwtHmacParameters.KidStrategy	getKidStrategy()
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	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static JwtHmacParameters.Builder builder()

getKeySizeBytes

public int getKeySizeBytes()

getKidStrategy

public JwtHmacParameters.KidStrategy getKidStrategy()

getAlgorithm

public JwtHmacParameters.Algorithm getAlgorithm()

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

allowKidAbsent

public boolean allowKidAbsent()

Description copied from class: JwtMacParameters

If true, tokens without "kid" header are allowed when verifying a token.

Specified by:

allowKidAbsent in class JwtMacParameters

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