com.nimbusds.openid.connect.provider.spi.tokens

Class BaseSelfContainedAccessTokenClaimsCodec

java.lang.Object

com.nimbusds.openid.connect.provider.spi.tokens.BaseSelfContainedAccessTokenClaimsCodec

All Implemented Interfaces:

SelfContainedAccessTokenClaimsCodec

@ThreadSafe
public abstract class BaseSelfContainedAccessTokenClaimsCodec
extends Object
implements SelfContainedAccessTokenClaimsCodec

Base implementation of the SPI for encoding and decoding authorisations for self-contained access tokens into JWT claims sets.

Provides encoding and decoding for all token parameters for which there is an appropriate standard JWT claim (see JSON Web Token (JWT) (RFC 7519), section 4.1, draft-ietf-oauth-mtls-07):

• subject - "sub"
• actor - "act"
• expiration time - "exp"
• issue time - "iat"
• audience - "aud"
• JWT ID - "jti"
• client X.509 certificate SHA-256 thumbprint (mTLS) - "cnf.x5t#S256"

The extending class should implement encoding and decoding for the remaining token parameters:

• client ID
• scope
• consented OpenID claim names
• preferred claims locales
• preset OpenID claims
• additional data

Constructor Summary

Constructors

Constructor and Description
BaseSelfContainedAccessTokenClaimsCodec()

Method Summary

Modifier and Type	Method and Description
AccessTokenAuthorization	decode(com.nimbusds.jwt.JWTClaimsSet claimsSet, TokenCodecContext context) Decodes the specified JWT claims set into an access token authorisation.
com.nimbusds.jwt.JWTClaimsSet	encode(AccessTokenAuthorization tokenAuthz, TokenEncoderContext context) Encodes the specified access token authorisation into a JWT claims set.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSelfContainedAccessTokenClaimsCodec

public BaseSelfContainedAccessTokenClaimsCodec()

Method Detail

encode

public com.nimbusds.jwt.JWTClaimsSet encode(AccessTokenAuthorization tokenAuthz,
                                            TokenEncoderContext context)

Description copied from interface: SelfContainedAccessTokenClaimsCodec

Encodes the specified access token authorisation into a JWT claims set.

Specified by:

encode in interface SelfContainedAccessTokenClaimsCodec

Parameters:

tokenAuthz - The access token authorisation. Not null.

context - The token encoder context. Not null.

Returns:

The JWT claims set.

decode

public AccessTokenAuthorization decode(com.nimbusds.jwt.JWTClaimsSet claimsSet,
                                       TokenCodecContext context)
                                throws TokenDecodeException

Description copied from interface: SelfContainedAccessTokenClaimsCodec

Decodes the specified JWT claims set into an access token authorisation.

Specified by:

decode in interface SelfContainedAccessTokenClaimsCodec

Parameters:

claimsSet - The JWT claims set. Not null.

context - The token codec context. Not null.

Returns:

The access token authorisation.

Throws:

TokenDecodeException - If decoding failed.