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

Class AbstractOIDCMessageEncoder

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.messaging.encoder.AbstractMessageEncoder

org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

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

All Implemented Interfaces:

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

Direct Known Subclasses:

HTTPPostAuthnRequestEncoder, HTTPRedirectAuthnRequestEncoder

public abstract class AbstractOIDCMessageEncoder
extends AbstractHttpServletResponseMessageEncoder
implements OIDCMessageEncoder

Base class for OIDC message encoders.

Since:

2.2.0

Field Summary

Fields

Modifier and Type	Field	Description
private Predicate<List<Pair<String,String>>>	authorizationParamsAreValidPredicate	A hook to allow additional checking of the authorization parameters after it is built.
private org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOIDCMessageEncoder()

Method Summary

Modifier and Type	Method	Description
protected List<Pair<String,String>>	createParametersFromRequest(OIDCAuthenticationRequest req)	Create a list of OAuth 2.0 authorization parameters from the OIDCAuthenticationRequest object.
private void	createParametersFromRequestWithoutRequestObject(List<Pair<String,String>> params, OIDCAuthenticationRequest req)	Create the set of OAuth2.0 authorization and and OIDC authentication request parameters when no RequestObject has been built.
private void	createParametersFromRequestWithRequestObject(List<Pair<String,String>> params, OIDCAuthenticationRequest req)	Create the set of OAuth2.0 authorization and and OIDC authentication request parameters when a RequestObject is present.
private boolean	pairFirstEquals(String value, List<Pair<String,String>> params)	Check if the value is contained (exact string match) in the parameter map as the first item of any pair.
private boolean	pairSecondContains(String key, String value, List<Pair<String,String>> params)	Check if the value is contained (string containment) in the parameter map as the second item of a pair.
protected String	serializeAuthorizationParamsToQueryString(OIDCAuthenticationRequest request)	Serialize OAuth 2.0 authorization parameters from the authentication request to a query string.
protected void	serializeAuthorizationParamsToUrl(OIDCAuthenticationRequest request, URLBuilder builder)	Serialize OAuth 2.0 authorization parameters from the authentication request to the query string of the URL.
void	setAuthorizationParamsAreValidPredicate(Predicate<List<Pair<String,String>>> predicate)	Set a hook that allows the built authorization parameters to be validated before they are used.
protected boolean	validateParams(List<Pair<String,String>> params)	Ensure the authorization parameters are valid.

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

doInitialize, getHttpServletResponse, getHttpServletResponseSupplier, setHttpServletResponse, setHttpServletResponseSupplier

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

doDestroy, doEncode, encode, getMessageContext, prepareContext, setMessageContext

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, 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.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.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, test

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

authorizationParamsAreValidPredicate

@Nonnull
private Predicate<List<Pair<String,String>>> authorizationParamsAreValidPredicate

A hook to allow additional checking of the authorization parameters after it is built.

Constructor Detail

AbstractOIDCMessageEncoder

protected AbstractOIDCMessageEncoder()

Method Detail

setAuthorizationParamsAreValidPredicate

public void setAuthorizationParamsAreValidPredicate(@Nullable
                                                    Predicate<List<Pair<String,String>>> predicate)

Set a hook that allows the built authorization parameters to be validated before they are used. This is run in addition too, but before, the built in validation taken from the specification. If this returns false, the built in validation is not run, and validation fails.

Parameters:

predicate - the hook to run

serializeAuthorizationParamsToUrl

protected void serializeAuthorizationParamsToUrl(@Nonnull
                                                 OIDCAuthenticationRequest request,
                                                 @Nonnull
                                                 URLBuilder builder)
                                          throws MessageEncodingException

Serialize OAuth 2.0 authorization parameters from the authentication request to the query string of the URL.

Parameters:

request - the authentication request.

builder - the URL builder to add the query parameters to.

Throws:

MessageEncodingException - on error building the parameters

serializeAuthorizationParamsToQueryString

protected String serializeAuthorizationParamsToQueryString(@Nonnull
                                                           OIDCAuthenticationRequest request)
                                                    throws MessageEncodingException

Serialize OAuth 2.0 authorization parameters from the authentication request to a query string.

Parameters:

request - the authentication request query string.

Returns:

the query string.

Throws:

MessageEncodingException - on error building the parameters

createParametersFromRequest

protected List<Pair<String,String>> createParametersFromRequest(@Nonnull
                                                                      OIDCAuthenticationRequest req)
                                                               throws MessageEncodingException

Create a list of OAuth 2.0 authorization parameters from the OIDCAuthenticationRequest object.

Note, the parameters are not URL encoded here. This is left to the calling code e.g. the URLBuidler in the serializeAuthorizationParamsToQueryString(OIDCAuthenticationRequest) method.

Parameters:

req - the authentication request

Returns:

a list of authorization parameters.

Throws:

MessageEncodingException - on error building the parameters

createParametersFromRequestWithRequestObject

private void createParametersFromRequestWithRequestObject(@Nonnull
                                                          List<Pair<String,String>> params,
                                                          @Nonnull
                                                          OIDCAuthenticationRequest req)
                                                   throws MessageEncodingException

Create the set of OAuth2.0 authorization and and OIDC authentication request parameters when a RequestObject is present.

Parameters:

params - the OAuth2.0 authorization and and OIDC authentication request parameters to set

req - the current authentication request

Throws:

MessageEncodingException - if there is an error building the parameters

createParametersFromRequestWithoutRequestObject

private void createParametersFromRequestWithoutRequestObject(@Nonnull
                                                             List<Pair<String,String>> params,
                                                             @Nonnull
                                                             OIDCAuthenticationRequest req)
                                                      throws MessageEncodingException

Create the set of OAuth2.0 authorization and and OIDC authentication request parameters when no RequestObject has been built. Note, ACRs are encoded into the requested claims as essential claims, the acr_values parameter is not used.

Parameters:

params - the OAuth2.0 authorization and and OIDC authentication request parameters to set

req - the current authentication request

Throws:

MessageEncodingException - if there is an error building the parameters

validateParams

protected boolean validateParams(List<Pair<String,String>> params)

Ensure the authorization parameters are valid.

Parameters:

params - the parameters

Returns:

true if the authorization parameters are valid, false otherwise

pairFirstEquals

private boolean pairFirstEquals(@Nonnull
                                String value,
                                List<Pair<String,String>> params)

Check if the value is contained (exact string match) in the parameter map as the first item of any pair.

Parameters:

value - the value to check exists

params - the parameters to check

Returns:

true iff the value exists as the first item of any pair, false otherwise

pairSecondContains

private boolean pairSecondContains(@Nonnull
                                   String key,
                                   @Nonnull
                                   String value,
                                   List<Pair<String,String>> params)

Check if the value is contained (string containment) in the parameter map as the second item of a pair. The pair is chosen using the first parameter as a key. If they key does not exist in the list, false is returned.

Parameters:

key - the key used to find the pair that should contain the value

value - the value to check exists

params - the parameters to check

Returns:

true iff the value is contained in the second item of the pair referenced by the key, false otherwise