Package net.shibboleth.sp.profile.impl

Class DoSealerOperation

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.sp.profile.AbstractAgentRequestAction

net.shibboleth.sp.profile.AbstractAgentAction

net.shibboleth.sp.profile.impl.DoSealerOperation

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class DoSealerOperation
extends AbstractAgentAction

Action that implements a remote API for SP agents to leverage a DataSealer.

All contexts are prefixed with IdentifiedComponent.getId() to prevent conflicts across agents.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_MSG_CTX, EventIds.ACCESS_DENIED, EventIds.INVALID_MESSAGE, EventIds.MESSAGE_PROC_ERROR

Precondition:

AgentRequestContext.getOutput().isstruct()

Field Summary

Fields

Modifier and Type	Field	Description
private DataSealer	dataSealer	DataSealer to use.
static final String	DECRYPT	Member for data to decrypt.
static final String	DECRYPTED	Member for decrypted data.
static final String	ENCRYPT	Member for data to encrypt.
static final String	ENCRYPTED	Member for encrypted data.
static final String	EXP	Member for storage expiration.
private DDF	input	Input message.
private org.slf4j.Logger	log	Class logger.
private DDF	output	Output message.

Constructor Summary

Constructors

Constructor	Description
DoSealerOperation()

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private DDF	doUnwrap(ProfileRequestContext profileRequestContext, DDF toUnwrap)	Perform unwrap operation.
private DDF	doWrap(ProfileRequestContext profileRequestContext, DDF toWrap)	Perform wrap operation.
void	setDataSealer(DataSealer sealer)	Sets the DataSealer to use.

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentAction

ensureAgent, getAgent

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentRequestAction

ensureAgentRequestContext, getAgentRequestContext, setAgentRequestContextLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

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

ENCRYPT

@Nonnull
@NotEmpty
public static final String ENCRYPT

Member for data to encrypt.

See Also:

• Constant Field Values

DECRYPT

@Nonnull
@NotEmpty
public static final String DECRYPT

Member for data to decrypt.

See Also:

• Constant Field Values

EXP

@Nonnull
@NotEmpty
public static final String EXP

Member for storage expiration.

See Also:

• Constant Field Values

ENCRYPTED

@Nonnull
@NotEmpty
public static final String ENCRYPTED

Member for encrypted data.

See Also:

• Constant Field Values

DECRYPTED

@Nonnull
@NotEmpty
public static final String DECRYPTED

Member for decrypted data.

See Also:

• Constant Field Values

log

@Nonnull
private org.slf4j.Logger log

Class logger.

dataSealer

@NonnullAfterInit
private DataSealer dataSealer

DataSealer to use.

input

@NonnullBeforeExec
private DDF input

Input message.

output

@NonnullBeforeExec
private DDF output

Output message.

Constructor Details

DoSealerOperation

public DoSealerOperation()

Method Details

setDataSealer

public void setDataSealer(@Nonnull
 DataSealer sealer)

Sets the DataSealer to use.

Parameters:

sealer - data sealer

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractAgentAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

doWrap

@Nonnull
private DDF doWrap(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 DDF toWrap)
            throws DataSealerException

Perform wrap operation.

Parameters:

profileRequestContext - profile request context

toWrap - list of nodes containing data to wrap

Returns:

a list node containing the encrypted data strings

Throws:

DataSealerException - if an error is raised

doUnwrap

@Nonnull
private DDF doUnwrap(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 DDF toUnwrap)
              throws DataSealerException

Perform unwrap operation.

Parameters:

profileRequestContext - profile request context

toUnwrap - list of nodes containing data to unwrap

Returns:

a list node containing the decrypted data strings

Throws:

DataSealerException - if an error is raised