org.picketlink.identity.federation.web.filters

Class IDPFilter

java.lang.Object

org.picketlink.identity.federation.web.filters.IDPFilter

All Implemented Interfaces:

Filter

public class IDPFilter
extends Object
implements Filter

A Filter that can be configured to convert a JavaEE Web Application to an IDP

Since:

December 05, 2013

Author:

Anil Saldhana

Field Summary

Fields

Modifier and Type	Field and Description
protected PicketLinkAuditHelper	auditHelper
protected String	authMethod
protected SAMLConfigurationProvider	configProvider The user can inject a fully qualified name of a SAMLConfigurationProvider
protected boolean	enableAudit
protected IDPType	idpConfiguration
protected PicketLinkType	picketLinkConfiguration
protected ServletContext	servletContext
static String	SESSION_PARAM_USER_PRINCIPAL
protected Timer	timer
protected int	timerInterval

Constructor Summary

Constructors

Constructor and Description
IDPFilter()
IDPFilter(IDPType idpType)

Method Summary

Modifier and Type	Method and Description
protected void	cleanUpSessionNote(HttpServletRequest request)
void	destroy() Called by the web container to indicate to a filter that it is being taken out of service.
protected String	determineLoginType(boolean isSecure)
void	doFilter(ServletRequest request, ServletResponse response, FilterChain chain) The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.
SAMLConfigurationProvider	getConfigProvider()
protected PicketLinkType	getConfiguration() Returns the configurations used.
protected String	getIdentityURL()
protected void	handleSAML11UnsolicitedResponse(HttpServletRequest request, HttpServletResponse response)
void	init(FilterConfig filterConfig) Called by the web container to indicate to a filter that it is being placed into service.
protected void	initHandlersChain() Initialize the Handlers chain.
protected void	initIdentityServer() Initializes the IdentityServer.
protected void	initIDPConfiguration(PicketLinkType picketLinkConfiguration) Initializes the IDP configuration.
protected void	initKeyManager()
protected void	initSTSConfiguration() Initializes the STS configuration.
protected void	processSAMLRequestMessage(HttpServletRequest request, HttpServletResponse response, RequestAbstractType requestType, boolean ignoreSignatureValidation)
protected void	processSAMLResponseMessage(HttpServletRequest request, HttpServletResponse response)
protected void	sendErrorResponseToSP(String referrer, HttpServletResponse response, String relayState, IDPWebRequestUtil webRequestUtil)
protected void	startPicketLink()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SESSION_PARAM_USER_PRINCIPAL

public static final String SESSION_PARAM_USER_PRINCIPAL

See Also:

Constant Field Values

servletContext

protected ServletContext servletContext

enableAudit

protected boolean enableAudit

auditHelper

protected PicketLinkAuditHelper auditHelper

idpConfiguration

protected IDPType idpConfiguration

picketLinkConfiguration

protected PicketLinkType picketLinkConfiguration

configProvider

protected SAMLConfigurationProvider configProvider

The user can inject a fully qualified name of a SAMLConfigurationProvider

timerInterval

protected int timerInterval

timer

protected Timer timer

authMethod

protected String authMethod

Constructor Detail

IDPFilter

public IDPFilter()

IDPFilter

public IDPFilter(IDPType idpType)

Method Detail

init

public void init(FilterConfig filterConfig)
          throws ServletException

Description copied from interface: Filter

Called by the web container to indicate to a filter that it is being placed into service.

The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.

The web container cannot place the filter into service if the init method either

1. Throws a ServletException
2. Does not return within a time period defined by the web container

Specified by:

init in interface Filter

Throws:

ServletException

doFilter

public void doFilter(ServletRequest request,
                     ServletResponse response,
                     FilterChain chain)
              throws IOException,
                     ServletException

Description copied from interface: Filter

The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain. The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:

1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. • Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
   • or not pass on the request/response pair to the next entity in the filter chain to block the request processing
5. Directly set headers on the response after invocation of the next entity in the filter chain.

Specified by:

doFilter in interface Filter

Throws:

IOException

ServletException

destroy

public void destroy()

Description copied from interface: Filter

Called by the web container to indicate to a filter that it is being taken out of service.

This method is only called once all threads within the filter's doFilter method have exited or after a timeout period has passed. After the web container calls this method, it will not call the doFilter method again on this instance of the filter.

This method gives the filter an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in memory.

Specified by:

destroy in interface Filter

processSAMLRequestMessage

protected void processSAMLRequestMessage(HttpServletRequest request,
                                         HttpServletResponse response,
                                         RequestAbstractType requestType,
                                         boolean ignoreSignatureValidation)
                                  throws IOException

Throws:

IOException

processSAMLResponseMessage

protected void processSAMLResponseMessage(HttpServletRequest request,
                                          HttpServletResponse response)
                                   throws ServletException,
                                          IOException

Throws:

ServletException

IOException

cleanUpSessionNote

protected void cleanUpSessionNote(HttpServletRequest request)

sendErrorResponseToSP

protected void sendErrorResponseToSP(String referrer,
                                     HttpServletResponse response,
                                     String relayState,
                                     IDPWebRequestUtil webRequestUtil)
                              throws ServletException,
                                     IOException,
                                     ConfigurationException

Throws:

ServletException

IOException

ConfigurationException

initIdentityServer

protected void initIdentityServer()

Initializes the IdentityServer.

initHandlersChain

protected void initHandlersChain()

Initialize the Handlers chain.

initKeyManager

protected void initKeyManager()

initIDPConfiguration

protected void initIDPConfiguration(PicketLinkType picketLinkConfiguration)

Initializes the IDP configuration.

Parameters:

picketLinkConfiguration -

initSTSConfiguration

protected void initSTSConfiguration()

Initializes the STS configuration.

getIdentityURL

protected String getIdentityURL()

determineLoginType

protected String determineLoginType(boolean isSecure)

startPicketLink

protected void startPicketLink()

getConfiguration

protected PicketLinkType getConfiguration()

Returns the configurations used.

Returns:

getConfigProvider

public SAMLConfigurationProvider getConfigProvider()

handleSAML11UnsolicitedResponse

protected void handleSAML11UnsolicitedResponse(HttpServletRequest request,
                                               HttpServletResponse response)
                                        throws ServletException,
                                               IOException

Throws:

ServletException

IOException