Package net.shibboleth.oidc.security.impl

Class SignJWTHandler

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

net.shibboleth.oidc.security.impl.SignJWTHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

public class SignJWTHandler
extends AbstractMessageHandler

Message handler that signs a JWT and sets it back to the message context via an update consumer.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<MessageContext,JWTClaimsSet>	claimsToSignLookupStrategy	Strategy used to locate the payload to encrypt.
private JWTClaimsSet	jwtClaimSetToSign	The stashed claims to sign.
private BiConsumer<JWT,MessageContext>	jwtUpdateConsumer	A consumer that takes the Signed JWT and updates the correct object inside the MessageContext.
private final org.slf4j.Logger	log	Class logger.
private String	logName	A friendly name to log as the subject of signing.
private Function<MessageContext,SecurityParametersContext>	securityParametersLookupStrategy	Strategy used to locate the SecurityParametersContext to use for signing.
private JWSTokenSigner	signer	The signing engine used to sign the JWT claims set.
private Function<MessageContext,String>	typeHeaderLookupStrategy	Strategy used to locate the optional "typ" header to insert while signing.

Constructor Summary

Constructors

Constructor	Description
SignJWTHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected void	doInvoke(MessageContext messageContext)
protected boolean	doPreInvoke(MessageContext messageContext)
private void	logJWT(SignedJWT jwt)	Log (on trace) the JWT.
void	setClaimsToSignLookupStrategy(Function<MessageContext,JWTClaimsSet> strategy)	Set the strategy used to locate the JWTClaimsSet to sign.
void	setJwtUpdateConsumer(BiConsumer<JWT,MessageContext> consumer)	Set the consumer used to update the MessageContext with the supplied EncryptedJWT.
void	setLogName(String name)	Set the friendly name to log as the subject of signing.
void	setSecurityParametersLookupStrategy(Function<MessageContext,SecurityParametersContext> strategy)	Set the strategy used to locate the SecurityParametersContext to use.
void	setTypeHeader(String type)	Sets the value to be inserted as a "typ" header for the JWS.
void	setTypeHeaderLookupStrategy(Function<MessageContext,String> strategy)	Sets the strategy used to locate the optional "typ" header to insert while signing

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, isPreInvokeCalled, setActivationCondition

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 net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

securityParametersLookupStrategy

@Nonnull
private Function<MessageContext,SecurityParametersContext> securityParametersLookupStrategy

Strategy used to locate the SecurityParametersContext to use for signing.

jwtUpdateConsumer

@NonnullAfterInit
private BiConsumer<JWT,MessageContext> jwtUpdateConsumer

A consumer that takes the Signed JWT and updates the correct object inside the MessageContext.

claimsToSignLookupStrategy

@NonnullAfterInit
private Function<MessageContext,JWTClaimsSet> claimsToSignLookupStrategy

Strategy used to locate the payload to encrypt.

jwtClaimSetToSign

@NonnullBeforeExec
private JWTClaimsSet jwtClaimSetToSign

The stashed claims to sign.

typeHeaderLookupStrategy

@Nonnull
private Function<MessageContext,String> typeHeaderLookupStrategy

Strategy used to locate the optional "typ" header to insert while signing.

logName

@Nonnull
@NotEmpty
private String logName

A friendly name to log as the subject of signing.

signer

@NonnullBeforeExec
private JWSTokenSigner signer

The signing engine used to sign the JWT claims set.

Constructor Details

SignJWTHandler

public SignJWTHandler()

Constructor.

Method Details

setLogName

public void setLogName(@Nonnull @NotEmpty
 String name)

Set the friendly name to log as the subject of signing.

Parameters:

name - the friendly name

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

setClaimsToSignLookupStrategy

public void setClaimsToSignLookupStrategy(@Nonnull
 Function<MessageContext,JWTClaimsSet> strategy)

Set the strategy used to locate the JWTClaimsSet to sign.

Parameters:

strategy - the strategy

setJwtUpdateConsumer

public void setJwtUpdateConsumer(BiConsumer<JWT,MessageContext> consumer)

Set the consumer used to update the MessageContext with the supplied EncryptedJWT.

Parameters:

consumer - the consumer

setTypeHeader

public void setTypeHeader(@Nullable @NotEmpty
 String type)

Sets the value to be inserted as a "typ" header for the JWS.

Parameters:

type - header value

setSecurityParametersLookupStrategy

public void setSecurityParametersLookupStrategy(@Nonnull
 Function<MessageContext,SecurityParametersContext> strategy)

Set the strategy used to locate the SecurityParametersContext to use.

Parameters:

strategy - lookup strategy

setTypeHeaderLookupStrategy

public void setTypeHeaderLookupStrategy(@Nonnull
 Function<MessageContext,String> strategy)

Sets the strategy used to locate the optional "typ" header to insert while signing

Parameters:

strategy - lookup strategy

Since:

3.1.0

doPreInvoke

protected boolean doPreInvoke(@Nonnull
 MessageContext messageContext)
                       throws MessageHandlerException

Overrides:

doPreInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException

doInvoke

protected void doInvoke(@Nonnull
 MessageContext messageContext)
                 throws MessageHandlerException

Specified by:

doInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException

logJWT

private void logJWT(@Nonnull
 SignedJWT jwt)

Log (on trace) the JWT.

Parameters:

jwt - the JWT to log.