com.google.crypto.tink.jwt

Class JwtEcdsaPrivateKey

java.lang.Object

com.google.crypto.tink.Key

com.google.crypto.tink.jwt.JwtSignaturePrivateKey

com.google.crypto.tink.jwt.JwtEcdsaPrivateKey

All Implemented Interfaces:

PrivateKey

@Immutable
public final class JwtEcdsaPrivateKey
extends JwtSignaturePrivateKey

Represents a key for computing JWT ECDSA signatures (ES256, ES384, ES512).

See https://datatracker.ietf.org/doc/html/rfc7518 for more information.

Field Summary

Fields

Modifier and Type	Field and Description
SecretBigInteger	privateKeyValue
JwtEcdsaPublicKey	publicKey

Method Summary

Modifier and Type	Method and Description
static JwtEcdsaPrivateKey	create(JwtEcdsaPublicKey publicKey, SecretBigInteger privateValue)
boolean	equalsKey(Key o) Returns true if the key is guaranteed to be equal to other.
JwtEcdsaParameters	getParameters() Returns a Parameters object containing all the information about the key which is not randomly chosen.
SecretBigInteger	getPrivateValue()
JwtEcdsaPublicKey	getPublicKey()

Methods inherited from class com.google.crypto.tink.jwt.JwtSignaturePrivateKey

getIdRequirementOrNull, getKid

Methods inherited from class java.lang.Object

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

Field Detail

publicKey

public final JwtEcdsaPublicKey publicKey

privateKeyValue

public final SecretBigInteger privateKeyValue

Method Detail

create

public static JwtEcdsaPrivateKey create(JwtEcdsaPublicKey publicKey,
                                        SecretBigInteger privateValue)
                                 throws GeneralSecurityException

Throws:

GeneralSecurityException

getPrivateValue

public SecretBigInteger getPrivateValue()

getParameters

public JwtEcdsaParameters getParameters()

Description copied from class: Key

Returns a Parameters object containing all the information about the key which is not randomly chosen.

Implementations need to ensure that getParameters().hasIdRequirement() returns true if and only if getIdRequirementOrNull is non-null.

Specified by:

getParameters in class JwtSignaturePrivateKey

getPublicKey

public JwtEcdsaPublicKey getPublicKey()

Specified by:

getPublicKey in interface PrivateKey

Specified by:

getPublicKey in class JwtSignaturePrivateKey

equalsKey

public boolean equalsKey(Key o)

Description copied from class: Key

Returns true if the key is guaranteed to be equal to other.

Implementations are required to do this in constant time.

Note: this is allowed to return false even if two keys are guaranteed to represent the same function, but are represented differently. For example, a key is allowed to internally store the number of zero-bytes used as padding when a large number is represented as a byte array, and use this in the comparison.

Note: Tink Key objects should typically not override hashCode (because it could risk leaking key material). Hence, they typically also should not override equals.

Specified by:

equalsKey in class Key