Package org.springframework.security.saml2.provider.service.servlet.filter

Class Saml2WebSsoAuthenticationRequestFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.security.saml2.provider.service.servlet.filter.Saml2WebSsoAuthenticationRequestFilter

All Implemented Interfaces:

jakarta.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public class Saml2WebSsoAuthenticationRequestFilter
extends org.springframework.web.filter.OncePerRequestFilter

This Filter formulates a SAML 2.0 AuthnRequest (line 1968) and redirects to a configured asserting party.

It supports the HTTP-Redirect (line 520) and HTTP-POST (line 753) bindings.

By default, this Filter responds to authentication requests at the URI /saml2/authenticate/{registrationId}. The URI template variable {registrationId} represents the registration identifier of the relying party that is used for initiating the authentication request.

Since:

5.2

Field Summary

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Constructor Summary

Constructors

Constructor	Description
Saml2WebSsoAuthenticationRequestFilter(RelyingPartyRegistrationRepository relyingPartyRegistrationRepository)	Deprecated. use the constructor that takes a Saml2AuthenticationRequestFactory
Saml2WebSsoAuthenticationRequestFilter(Saml2AuthenticationRequestResolver authenticationRequestResolver)	Construct a Saml2WebSsoAuthenticationRequestFilter with the strategy for resolving the AuthnRequest
Saml2WebSsoAuthenticationRequestFilter(Saml2AuthenticationRequestContextResolver authenticationRequestContextResolver, Saml2AuthenticationRequestFactory authenticationRequestFactory)	Construct a Saml2WebSsoAuthenticationRequestFilter with the provided parameters

Method Summary

Modifier and Type	Method	Description
protected void	doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain)
void	setAuthenticationRequestFactory(Saml2AuthenticationRequestFactory authenticationRequestFactory)	Deprecated. use the constructor instead
void	setAuthenticationRequestRepository(Saml2AuthenticationRequestRepository<AbstractSaml2AuthenticationRequest> authenticationRequestRepository)	Use the given Saml2AuthenticationRequestRepository to save the authentication request
void	setRedirectMatcher(RequestMatcher redirectMatcher)	Deprecated. Configure the request matcher in an implementation of Saml2AuthenticationRequestResolver instead

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Constructor Details

Saml2WebSsoAuthenticationRequestFilter

@Deprecated
public Saml2WebSsoAuthenticationRequestFilter(RelyingPartyRegistrationRepository relyingPartyRegistrationRepository)

Deprecated.

use the constructor that takes a Saml2AuthenticationRequestFactory

Construct a Saml2WebSsoAuthenticationRequestFilter with the provided parameters

Parameters:

relyingPartyRegistrationRepository - a repository for relying party configurations

Saml2WebSsoAuthenticationRequestFilter

public Saml2WebSsoAuthenticationRequestFilter(Saml2AuthenticationRequestContextResolver authenticationRequestContextResolver,
 Saml2AuthenticationRequestFactory authenticationRequestFactory)

Construct a Saml2WebSsoAuthenticationRequestFilter with the provided parameters

Parameters:

authenticationRequestContextResolver - a strategy for formulating a Saml2AuthenticationRequestContext

authenticationRequestFactory - strategy for formulating a <saml2:AuthnRequest>

Since:

5.4

Saml2WebSsoAuthenticationRequestFilter

public Saml2WebSsoAuthenticationRequestFilter(Saml2AuthenticationRequestResolver authenticationRequestResolver)

Construct a Saml2WebSsoAuthenticationRequestFilter with the strategy for resolving the AuthnRequest

Parameters:

authenticationRequestResolver - the strategy for resolving the AuthnRequest

Since:

5.7

Method Details

setAuthenticationRequestFactory

@Deprecated
public void setAuthenticationRequestFactory(Saml2AuthenticationRequestFactory authenticationRequestFactory)

Deprecated.

use the constructor instead

Use the given Saml2AuthenticationRequestFactory for formulating the SAML 2.0 AuthnRequest

Parameters:

authenticationRequestFactory - the Saml2AuthenticationRequestFactory to use

setRedirectMatcher

@Deprecated
public void setRedirectMatcher(RequestMatcher redirectMatcher)

Deprecated.

Configure the request matcher in an implementation of Saml2AuthenticationRequestResolver instead

Use the given RequestMatcher that activates this filter for a given request

Parameters:

redirectMatcher - the RequestMatcher to use

setAuthenticationRequestRepository

public void setAuthenticationRequestRepository(Saml2AuthenticationRequestRepository<AbstractSaml2AuthenticationRequest> authenticationRequestRepository)

Use the given Saml2AuthenticationRequestRepository to save the authentication request

Parameters:

authenticationRequestRepository - the Saml2AuthenticationRequestRepository to use

Since:

5.6

doFilterInternal

protected void doFilterInternal(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 jakarta.servlet.FilterChain filterChain)
                         throws jakarta.servlet.ServletException,
IOException

Specified by:

doFilterInternal in class org.springframework.web.filter.OncePerRequestFilter

Throws:

jakarta.servlet.ServletException

IOException