Package com.nimbusds.openid.connect.sdk.claims

Class HashClaim

java.lang.Object

com.nimbusds.oauth2.sdk.id.Identifier

com.nimbusds.openid.connect.sdk.claims.HashClaim

All Implemented Interfaces:

Serializable, Comparable<Identifier>, net.minidev.json.JSONAware

Direct Known Subclasses:

AccessTokenHash, CodeHash, StateHash

public abstract class HashClaim
extends Identifier

The base class for SHA-2 based claims.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.nimbusds.oauth2.sdk.id.Identifier

DEFAULT_BYTE_LENGTH, secureRandom

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HashClaim(String value)	Creates a new SHA-2 based claim with the specified value.

Method Summary

Modifier and Type	Method	Description
static String	computeValue(Identifier identifier, com.nimbusds.jose.JWSAlgorithm alg)	Deprecated. Use computeValue(Identifier, JWSAlgorithm, Curve) instead.
static String	computeValue(Identifier identifier, com.nimbusds.jose.JWSAlgorithm alg, com.nimbusds.jose.jwk.Curve crv)	Computes the SHA-2 claim value for the specified identifier.
static MessageDigest	getMessageDigestInstance(com.nimbusds.jose.JWSAlgorithm alg)	Deprecated. Use getMessageDigestInstance(JWSAlgorithm, Curve) instead.
static MessageDigest	getMessageDigestInstance(com.nimbusds.jose.JWSAlgorithm alg, com.nimbusds.jose.jwk.Curve crv)	Gets the matching SHA-2 message digest for the specified JSON Web Signature (JWS) algorithm.

Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier

compareTo, equals, getValue, hashCode, toJSONString, toString, toStringList

Methods inherited from class java.lang.Object

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

Constructor Detail

HashClaim

protected HashClaim(String value)

Creates a new SHA-2 based claim with the specified value.

Parameters:

value - The claim value. Must not be null.

Method Detail

getMessageDigestInstance

@Deprecated
public static MessageDigest getMessageDigestInstance(com.nimbusds.jose.JWSAlgorithm alg)

Deprecated.

Use getMessageDigestInstance(JWSAlgorithm, Curve) instead.

Gets the matching SHA-2 message digest for the specified JSON Web Signature (JWS) algorithm.

Parameters:

alg - The JWS algorithm. Must not be null.

Returns:

The SHA-2 message digest, null if the JWS algorithm or its corresponding SHA-2 message digest are not supported.

getMessageDigestInstance

public static MessageDigest getMessageDigestInstance(com.nimbusds.jose.JWSAlgorithm alg,
                                                     com.nimbusds.jose.jwk.Curve crv)

Gets the matching SHA-2 message digest for the specified JSON Web Signature (JWS) algorithm.

Parameters:

alg - The JWS algorithm. Must not be null.

crv - The JWK curve used with the JWS algorithm, null if not applicable.

Returns:

The SHA-2 message digest, null if the JWS algorithm or its corresponding SHA-2 message digest are not supported.

computeValue

@Deprecated
public static String computeValue(Identifier identifier,
                                  com.nimbusds.jose.JWSAlgorithm alg)

Deprecated.

Use computeValue(Identifier, JWSAlgorithm, Curve) instead.

Computes the SHA-2 claim value for the specified identifier.

Parameters:

identifier - The identifier, typically an authorisation code or an access token. Must not be null.

alg - The reference JWS algorithm. Must not be null.

Returns:

The matching (truncated to first half) SHA-2 claim value, or null if the JWS algorithm or its corresponding SHA-2 message digest are not supported.

computeValue

public static String computeValue(Identifier identifier,
                                  com.nimbusds.jose.JWSAlgorithm alg,
                                  com.nimbusds.jose.jwk.Curve crv)

Computes the SHA-2 claim value for the specified identifier.

Parameters:

identifier - The identifier, typically an authorisation code or an access token. Must not be null.

alg - The reference JWS algorithm. Must not be null.

crv - The JWK curve used with the JWS algorithm, null if not applicable.

Returns:

The matching (truncated to first half) SHA-2 claim value, or null if the JWS algorithm or its corresponding SHA-2 message digest are not supported.