Package net.shibboleth.oidc.security.impl

Class EncryptJWTHandler

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

net.shibboleth.oidc.security.impl.EncryptJWTHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

public class EncryptJWTHandler
extends AbstractMessageHandler

A MessageHandler that encrypts a JWT using the EncryptionParameters found in the SecurityParametersContext. The Payload to encrypt is determined by lookup strategy. A supplied consumer takes the EncryptedJWT and updates the correct object in the MessageContext.

Field Summary

Fields

Modifier and Type	Field	Description
private EncryptionParameters	encryptionParameters	The signature signing parameters.
private BiConsumer<JWT,MessageContext>	jwtUpdateConsumer	A consumer that takes the EncryptedJWT 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 encryption.
private Function<MessageContext,Payload>	payloadToEncryptLookupStrategy	Strategy used to locate the payload to encrypt.
private Function<MessageContext,SecurityParametersContext>	securityParametersLookupStrategy	Strategy used to locate the SecurityParametersContext to use for signing.

Constructor Summary

Constructors

Constructor	Description
EncryptJWTHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
protected void	doInvoke(MessageContext messageContext)
protected boolean	doPreInvoke(MessageContext messageContext)
private void	logEncryption(String keyID, String alg, String enc)	A convince method to log encryption parameters.
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 encryption.
void	setPayloadToEncryptLookupStrategy(Function<MessageContext,Payload> strategy)	Set the strategy used to locate the Payload to encrypt.
void	setSecurityParametersLookupStrategy(Function<MessageContext,SecurityParametersContext> strategy)	Set the strategy used to locate the SecurityParametersContext to use.

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.

payloadToEncryptLookupStrategy

@NonnullAfterInit
private Function<MessageContext,Payload> payloadToEncryptLookupStrategy

Strategy used to locate the payload to encrypt.

jwtUpdateConsumer

@NonnullAfterInit
private BiConsumer<JWT,MessageContext> jwtUpdateConsumer

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

encryptionParameters

@NonnullBeforeExec
private EncryptionParameters encryptionParameters

The signature signing parameters.

logName

@Nonnull
private String logName

A friendly name to log as the subject of encryption.

Constructor Details

EncryptJWTHandler

public EncryptJWTHandler()

Constructor.

Method Details

setLogName

public void setLogName(@Nonnull @NotEmpty
 String name)

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

Parameters:

name - the friendly name

setJwtUpdateConsumer

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

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

Parameters:

consumer - the consumer

setPayloadToEncryptLookupStrategy

public void setPayloadToEncryptLookupStrategy(@Nonnull
 Function<MessageContext,Payload> strategy)

Set the strategy used to locate the Payload to encrypt.

Parameters:

strategy - the strategy

setSecurityParametersLookupStrategy

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

Set the strategy used to locate the SecurityParametersContext to use.

Parameters:

strategy - lookup strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

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

logEncryption

private void logEncryption(@Nullable
 String keyID,
 @Nullable
 String alg,
 @Nullable
 String enc)

A convince method to log encryption parameters. Avoids some of the clutter in the calling methods.

Parameters:

keyID - the keyID

alg - the content encryption algorithm

enc - the key management algorithm