Package net.shibboleth.oidc.profile.encoding.impl

Class HTTPPostRequestEncoder

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.encoder.AbstractMessageEncoder

org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

net.shibboleth.oidc.profile.encoding.impl.AbstractOIDCMessageEncoder

net.shibboleth.oidc.profile.encoding.impl.HTTPPostRequestEncoder

All Implemented Interfaces:

Predicate<OAuth2AuthorizationProfileConfiguration.HttpRequestMethod>, OIDCMessageEncoder, Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageEncoder, HttpServletResponseMessageEncoder

public class HTTPPostRequestEncoder
extends AbstractOIDCMessageEncoder

A message encoder that encodes an OpenID authentication or logout request by HTTP Form POST Serialization.

Field Summary

Fields

Modifier and Type	Field	Description
private StringDigester	cspDigester	CSP digester for generating CSP hashes.
private IdentifierGenerationStrategy	cspNonceGenerator	CSP nonce generator.
static final String	DEFAULT_TEMPLATE_ID	Default template ID for using FORM POST request type for authentication or logout.
private final org.slf4j.Logger	log	Class logger.
private org.apache.velocity.app.VelocityEngine	velocityEngine	Velocity engine used to evaluate the template when using FORM POST response mode.
private String	velocityTemplateId	ID of the Velocity template used when using FORM POST response mode.

Fields inherited from class org.opensaml.messaging.encoder.AbstractMessageEncoder

BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
HTTPPostRequestEncoder()

Method Summary

Modifier and Type	Method	Description
private org.apache.velocity.VelocityContext	createContext(URI endpoint, List<Pair<String,String>> params, HttpServletResponse httpResponse)	Create a Velocity context and encode the response parameters into the context.
protected void	doEncode()
private org.apache.velocity.VelocityContext	doPostEncode(OIDCAuthenticationRequest request, HttpServletResponse httpResponse)	Construct form POST for an authentication request.
private org.apache.velocity.VelocityContext	doPostEncode(OIDCLogoutRequest request, HttpServletResponse httpResponse)	Construct form POST for a logout request.
void	setCSPDigester(StringDigester digester)	Sets a StringDigester to use in computing CSP digests in views.
void	setCSPNonceGenerator(IdentifierGenerationStrategy strategy)	Sets an IdentifierGenerationStrategy to use in computing CSP nonces in views.
void	setVelocityEngine(org.apache.velocity.app.VelocityEngine newVelocityEngine)	Set the VelocityEngine instance.
void	setVelocityTemplateId(String newVelocityTemplateId)	Set the Velocity template id.
boolean	test(OAuth2AuthorizationProfileConfiguration.HttpRequestMethod requestMethod)

Methods inherited from class net.shibboleth.oidc.profile.encoding.impl.AbstractOIDCMessageEncoder

createParametersFromRequest, createParametersFromRequest, serializeAuthorizationParamsToQueryString, serializeAuthorizationParamsToUrl, serializeLogoutParamsToUrl, serializeMessageForLogging, setAuthorizationParamsAreValidPredicate, validateParams

Methods inherited from class org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

doInitialize, getHttpServletResponse, getHttpServletResponseSupplier, setHttpServletResponseSupplier

Methods inherited from class org.opensaml.messaging.encoder.AbstractMessageEncoder

encode, getMessageContext, getMessageToLog, getProtocolMessageLogger, getProtocolMessageLoggerSubCategory, logEncodedMessage, prepareContext, setMessageContext, setProtocolMessageLoggerSubCategory

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.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface org.opensaml.messaging.encoder.MessageEncoder

encode, prepareContext, setMessageContext

Methods inherited from interface java.util.function.Predicate

and, negate, or

Field Details

DEFAULT_TEMPLATE_ID

@Nonnull
@NotEmpty
public static final String DEFAULT_TEMPLATE_ID

Default template ID for using FORM POST request type for authentication or logout.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

velocityEngine

@Nullable
private org.apache.velocity.app.VelocityEngine velocityEngine

Velocity engine used to evaluate the template when using FORM POST response mode.

velocityTemplateId

@Nonnull
@NotEmpty
private String velocityTemplateId

ID of the Velocity template used when using FORM POST response mode.

cspDigester

@Nullable
private StringDigester cspDigester

CSP digester for generating CSP hashes.

cspNonceGenerator

@Nullable
private IdentifierGenerationStrategy cspNonceGenerator

CSP nonce generator.

Constructor Details

HTTPPostRequestEncoder

public HTTPPostRequestEncoder()

Method Details

setCSPDigester

public void setCSPDigester(@Nullable
 StringDigester digester)

Sets a StringDigester to use in computing CSP digests in views.

Parameters:

digester - digester to set

Since:

3.1.0

setCSPNonceGenerator

public void setCSPNonceGenerator(@Nullable
 IdentifierGenerationStrategy strategy)

Sets an IdentifierGenerationStrategy to use in computing CSP nonces in views.

Parameters:

strategy - nonce strategy

Since:

3.1.0

setVelocityTemplateId

public void setVelocityTemplateId(@Nonnull @NotEmpty
 String newVelocityTemplateId)

Set the Velocity template id.

Defaults to DEFAULT_TEMPLATE_ID.

Parameters:

newVelocityTemplateId - the new Velocity template id

setVelocityEngine

public void setVelocityEngine(@Nonnull
 org.apache.velocity.app.VelocityEngine newVelocityEngine)

Set the VelocityEngine instance.

Parameters:

newVelocityEngine - the new VelocityEngine instane

test

public boolean test(@Nullable
 OAuth2AuthorizationProfileConfiguration.HttpRequestMethod requestMethod)

doPostEncode

private org.apache.velocity.VelocityContext doPostEncode(@Nonnull
 OIDCAuthenticationRequest request,
 @Nonnull
 HttpServletResponse httpResponse)
                                                  throws MessageEncodingException

Construct form POST for an authentication request.

Parameters:

request - the authentication request.

httpResponse - the httpResponse.

Returns:

response message as velocity context.

Throws:

MessageEncodingException - on error building the parameters

doPostEncode

private org.apache.velocity.VelocityContext doPostEncode(@Nonnull
 OIDCLogoutRequest request,
 @Nonnull
 HttpServletResponse httpResponse)
                                                  throws MessageEncodingException

Construct form POST for a logout request.

Parameters:

request - the logout request.

httpResponse - the httpResponse.

Returns:

response message as velocity context.

Throws:

MessageEncodingException - on error building the parameters

createContext

private org.apache.velocity.VelocityContext createContext(@Nonnull
 URI endpoint,
 @Nonnull
 List<Pair<String,String>> params,
 @Nonnull
 HttpServletResponse httpResponse)

Create a Velocity context and encode the response parameters into the context.

Parameters:

endpoint - the URL to add to the form action

params - the parameters to encode in the context

httpResponse - the HTTP response to use

Returns:

the populated Velocity context

doEncode

protected void doEncode()
                 throws MessageEncodingException

Specified by:

doEncode in class AbstractMessageEncoder

Throws:

MessageEncodingException