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

Class AccessTokenHash

java.lang.Object

com.nimbusds.oauth2.sdk.id.Identifier

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

com.nimbusds.openid.connect.sdk.claims.AccessTokenHash

All Implemented Interfaces:

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

@Immutable
public final class AccessTokenHash
extends HashClaim

Access token hash (at_hash).

Related specifications:

• OpenID Connect Core 1.0, section 3.1.3.6.

See Also:

• Serialized Form

Field Summary

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

DEFAULT_BYTE_LENGTH, secureRandom

Constructor Summary

Constructors

Constructor	Description
AccessTokenHash(String value)	Creates a new access token hash with the specified value.

Method Summary

Modifier and Type	Method	Description
static AccessTokenHash	compute(AccessToken accessToken, com.nimbusds.jose.JWSAlgorithm alg)	Deprecated. Use compute(AccessToken, JWSAlgorithm, Curve) instead.
static AccessTokenHash	compute(AccessToken accessToken, com.nimbusds.jose.JWSAlgorithm alg, com.nimbusds.jose.jwk.Curve crv)	Computes the hash for the specified access token and reference JSON Web Signature (JWS) algorithm.
boolean	equals(Object object)
static boolean	isRequiredInIDTokenClaims(ResponseType responseType)	Checks if an access token hash claim must be included in ID tokens for the specified response type.

Methods inherited from class com.nimbusds.openid.connect.sdk.claims.HashClaim

computeValue, computeValue, getMessageDigestInstance, getMessageDigestInstance

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

compareTo, getValue, hashCode, toJSONString, toString, toStringList

Methods inherited from class java.lang.Object

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

Constructor Details

AccessTokenHash

public AccessTokenHash(String value)

Creates a new access token hash with the specified value.

Parameters:

value - The access token hash value. Must not be null.

Method Details

isRequiredInIDTokenClaims

public static boolean isRequiredInIDTokenClaims(ResponseType responseType)

Checks if an access token hash claim must be included in ID tokens for the specified response type.

Parameters:

responseType - The OpenID Connect response type. Must not be null.

Returns:

true if the access token hash is required, else false.

compute

@Deprecated
public static AccessTokenHash compute(AccessToken accessToken,
 com.nimbusds.jose.JWSAlgorithm alg)

Deprecated.

Use compute(AccessToken, JWSAlgorithm, Curve) instead.

Computes the hash for the specified access token and reference JSON Web Signature (JWS) algorithm.

Parameters:

accessToken - The access token. Must not be null.

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

Returns:

The access token hash, or null if the JWS algorithm is not supported.

compute

public static AccessTokenHash compute(AccessToken accessToken,
 com.nimbusds.jose.JWSAlgorithm alg,
 com.nimbusds.jose.jwk.Curve crv)

Computes the hash for the specified access token and reference JSON Web Signature (JWS) algorithm.

Parameters:

accessToken - The 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 access token hash, or null if the JWS algorithm is not supported.

equals

public boolean equals(Object object)

Overrides:

equals in class Identifier