Package net.shibboleth.idp.plugin.oidc.op.profile.logic

Class DefaultJwtRefreshTokenSerializationFunction

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.idp.plugin.oidc.op.profile.logic.DefaultJwtRefreshTokenSerializationFunction

All Implemented Interfaces:

BiFunction<ProfileRequestContext,RefreshTokenClaimsSet,String>, Component, DestructableComponent, InitializableComponent

public class DefaultJwtRefreshTokenSerializationFunction
extends AbstractInitializableComponent
implements BiFunction<ProfileRequestContext,RefreshTokenClaimsSet,String>

Default implementation for serializing the refresh token claims set into a JWT refresh token. The JWT refresh token contains the following claims:

• iss - The issuer value fetched from TokenClaimsSet.getIssuer()
• aud - The audience value fetched from audienceLookupStrategy
• iat - The issued at value fetched from TokenClaimsSet.getIssuedAt()
• exp - The expiration value fetched from TokenClaimsSet.getExp()
• jti - The token identifier value fetched from TokenClaimsSet.getID()
• client_id - The client ID value fetched from TokenClaimsSet.getClientID()
• for_op - the internal state information for OP's use (the sealed refresh token claims set)

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,String>	audienceLookupStrategy	Strategy to find the audience value from the context.
private DataSealer	dataSealer	Data sealer for sealing private parts of the refresh token.
private final org.slf4j.Logger	log	Class logger.
private com.fasterxml.jackson.databind.ObjectMapper	objectMapper	Object mapper used for pretty-printing JWT contents.
private org.slf4j.Logger	protocolMessageLog	Used to log protocol messages.
private Function<ProfileRequestContext,SecurityParametersContext>	securityParametersContextLookupStrategy	Strategy used to look up the SecurityParametersContext to set the parameters for.
(package private) MessageHandler	signingParametersHandler	Handler that resolves and populates SignatureSigningParameters.
private BiFunction<ProfileRequestContext,RefreshTokenClaimsSet,String>	typeHeaderLookupStrategy	Strategy used to lookup the type header value for the JWT.

Constructor Summary

Constructors

Constructor	Description
DefaultJwtRefreshTokenSerializationFunction()	Constructor.

Method Summary

Modifier and Type	Method	Description
String	apply(ProfileRequestContext profileRequestContext, RefreshTokenClaimsSet claimsSet)
protected com.nimbusds.jwt.SignedJWT	constructJWT(RefreshTokenClaimsSet claimsSet, String audience, SignatureSigningParameters signingParameters, String typeHeader)	Construct a SignedJWT with the given input claims and signing parameters.
protected void	doInitialize()
void	setAudienceLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the audience lookup strategy.
void	setDataSealer(DataSealer sealer)	Set the data sealer instance to use.
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)	Set the object mapper used for pretty-printing JWT contents.
void	setSecurityParametersContextLookupStrategy(Function<ProfileRequestContext,SecurityParametersContext> strategy)	Set the strategy used to look up the SecurityParametersContext to set the parameters for.
void	setSigningParametersHandler(MessageHandler handler)	Set the handler that resolves and populates SignatureSigningParameters.
void	setTypeHeaderLookupStrategy(BiFunction<ProfileRequestContext,RefreshTokenClaimsSet,String> strategy)	Set the strategy used to lookup the type header value for the JWT.

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

protocolMessageLog

@Nonnull
private org.slf4j.Logger protocolMessageLog

Used to log protocol messages.

dataSealer

@NonnullAfterInit
private DataSealer dataSealer

Data sealer for sealing private parts of the refresh token.

securityParametersContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,SecurityParametersContext> securityParametersContextLookupStrategy

Strategy used to look up the SecurityParametersContext to set the parameters for.

signingParametersHandler

@NonnullAfterInit
MessageHandler signingParametersHandler

Handler that resolves and populates SignatureSigningParameters.

typeHeaderLookupStrategy

@NonnullAfterInit
private BiFunction<ProfileRequestContext,RefreshTokenClaimsSet,String> typeHeaderLookupStrategy

Strategy used to lookup the type header value for the JWT.

audienceLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,String> audienceLookupStrategy

Strategy to find the audience value from the context.

objectMapper

@NonnullAfterInit
private com.fasterxml.jackson.databind.ObjectMapper objectMapper

Object mapper used for pretty-printing JWT contents.

Constructor Details

DefaultJwtRefreshTokenSerializationFunction

public DefaultJwtRefreshTokenSerializationFunction()

Constructor.

Method Details

setDataSealer

public void setDataSealer(@Nonnull
 DataSealer sealer)

Set the data sealer instance to use.

Parameters:

sealer - What to set.

setSecurityParametersContextLookupStrategy

public void setSecurityParametersContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,SecurityParametersContext> strategy)

Set the strategy used to look up the SecurityParametersContext to set the parameters for.

Parameters:

strategy - What to set.

setSigningParametersHandler

public void setSigningParametersHandler(@Nonnull
 MessageHandler handler)

Set the handler that resolves and populates SignatureSigningParameters.

Parameters:

handler - What to set.

setTypeHeaderLookupStrategy

public void setTypeHeaderLookupStrategy(@Nonnull
 BiFunction<ProfileRequestContext,RefreshTokenClaimsSet,String> strategy)

Set the strategy used to lookup the type header value for the JWT.

Parameters:

strategy - What to set.

setAudienceLookupStrategy

public void setAudienceLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Set the audience lookup strategy.

Parameters:

strategy - the strategy.

setObjectMapper

public void setObjectMapper(@Nonnull
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Set the object mapper used for pretty-printing JWT contents.

Parameters:

mapper - What to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

apply

@Nullable
public String apply(@Nullable
 ProfileRequestContext profileRequestContext,
 @Nullable
 RefreshTokenClaimsSet claimsSet)

Specified by:

apply in interface BiFunction<ProfileRequestContext,RefreshTokenClaimsSet,String>

constructJWT

@Nullable
protected com.nimbusds.jwt.SignedJWT constructJWT(@Nonnull
 RefreshTokenClaimsSet claimsSet,
 @Nonnull
 String audience,
 @Nonnull
 SignatureSigningParameters signingParameters,
 @Nullable
 String typeHeader)

Construct a SignedJWT with the given input claims and signing parameters.

Parameters:

claimsSet - The input for payload

audience - The audience for the JWT

signingParameters - The signing parameters

typeHeader - The type header value for the JWT

Returns:

A signed JWT, or null