com.google.crypto.tink.jwt

Class JwtHmacParameters.KidStrategy

java.lang.Object

com.google.crypto.tink.jwt.JwtHmacParameters.KidStrategy

Enclosing class:

JwtHmacParameters

@Immutable
public static final class JwtHmacParameters.KidStrategy
extends Object

Specifies how the "kid" header is handled.

Field Summary

Fields

Modifier and Type	Field and Description
static JwtHmacParameters.KidStrategy	BASE64_ENCODED_KEY_ID The "kid" is the URL safe (RFC 4648 Section 5) base64-encoded big-endian key_id in the keyset.
static JwtHmacParameters.KidStrategy	CUSTOM The "kid" is fixed.
static JwtHmacParameters.KidStrategy	IGNORED The "kid" header is ignored.

Method Summary

Modifier and Type	Method and Description
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BASE64_ENCODED_KEY_ID

public static final JwtHmacParameters.KidStrategy BASE64_ENCODED_KEY_ID

The "kid" is the URL safe (RFC 4648 Section 5) base64-encoded big-endian key_id in the keyset.

In computeMacAndEncode Tink always adds the KID.

In verifyMacAndDecode Tink checks that the kid is present and equal to this value.

This strategy is recommended by Tink.

IGNORED

public static final JwtHmacParameters.KidStrategy IGNORED

The "kid" header is ignored.

In computeMacAndEncode Tink does not write a "kid" header.

In verifyMacAndDecode Tink ignores the "kid" header.

CUSTOM

public static final JwtHmacParameters.KidStrategy CUSTOM

The "kid" is fixed. It can be obtained from parameters.getCustomKid().

In computeMacAndEncode Tink writes the "kid" header to the value given by parameters.getCustomKid().

In verifyMacAndDecode If the kid is present, it needs to match parameters.getCustomKid(). If the kid is absent, it will be accepted.

Note: Tink does not allow to randomly generate new JwtHmacKey objects from parameters objects with KidStrategy equals to CUSTOM.

Method Detail

toString

public String toString()

Overrides:

toString in class Object