com.google.crypto.tink.jwt

Class JwtSignaturePublicKey

java.lang.Object

com.google.crypto.tink.Key

com.google.crypto.tink.jwt.JwtSignaturePublicKey

Direct Known Subclasses:

JwtEcdsaPublicKey, JwtRsaSsaPkcs1PublicKey, JwtRsaSsaPssPublicKey

public abstract class JwtSignaturePublicKey
extends Key

Represents a key to verify JWT using asymmetric cryptography (i.e., using the JwtPublicKeyVerify interface).

Constructor Summary

Constructors

Constructor and Description
JwtSignaturePublicKey()

Method Summary

Modifier and Type	Method and Description
abstract Optional<String>	getKid() Returns the "kid" to be used for this key (https://www.rfc-editor.org/rfc/rfc7517#section-4.5).
abstract JwtSignatureParameters	getParameters() Returns the parameters of this key.

Methods inherited from class com.google.crypto.tink.Key

equalsKey, getIdRequirementOrNull

Methods inherited from class java.lang.Object

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

Constructor Detail

JwtSignaturePublicKey

public JwtSignaturePublicKey()

Method Detail

getKid

public abstract Optional<String> getKid()

Returns the "kid" to be used for this key (https://www.rfc-editor.org/rfc/rfc7517#section-4.5).

Note that the "kid" is not necessarily related to Tink's "Key ID" in the keyset.

If present, this kid will be written into the kid header during computeMacAndEncode. If absent, no kid will be written.

If present, and the kid header is present, the contents of the kid header needs to match the return value of this function.

Note that getParameters.allowKidAbsent() specifies if omitting the kid header is allowed. Of course, if getParameters.allowKidAbsent() is true, then getKid must not return an empty Optional.

getParameters

public abstract JwtSignatureParameters getParameters()

Returns the parameters of this key.

Specified by:

getParameters in class Key