org.keycloak.adapters.springsecurity.filter

Class KeycloakAuthenticationProcessingFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

org.keycloak.adapters.springsecurity.filter.KeycloakAuthenticationProcessingFilter

All Implemented Interfaces:

javax.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.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware, org.springframework.context.EnvironmentAware, org.springframework.context.MessageSourceAware, org.springframework.web.context.ServletContextAware

public class KeycloakAuthenticationProcessingFilter
extends org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter
implements org.springframework.context.ApplicationContextAware

Provides a Keycloak authentication processing filter.

Version:

$Revision: 1 $

Author:

Scott Rossillo

Field Summary

Fields

Modifier and Type	Field and Description
static org.springframework.security.web.util.matcher.RequestMatcher	DEFAULT_REQUEST_MATCHER Request matcher that matches requests to the default login URI and any request with a Authorization header.

Fields inherited from class org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

authenticationDetailsSource, eventPublisher, messages, SPRING_SECURITY_LAST_EXCEPTION_KEY

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

logger

Constructor Summary

Constructors

Constructor and Description
KeycloakAuthenticationProcessingFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager) Creates a new Keycloak authentication processing filter with given AuthenticationManager and the default request matcher.
KeycloakAuthenticationProcessingFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager, org.springframework.security.web.util.matcher.RequestMatcher requiresAuthenticationRequestMatcher) Creates a new Keycloak authentication processing filter with given AuthenticationManager and RequestMatcher.

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
org.springframework.security.core.Authentication	attemptAuthentication(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

doFilter, getAllowSessionCreation, getAuthenticationManager, getFailureHandler, getFilterProcessesUrl, getRememberMeServices, getSuccessHandler, requiresAuthentication, setAllowSessionCreation, setApplicationEventPublisher, setAuthenticationDetailsSource, setAuthenticationFailureHandler, setAuthenticationManager, setAuthenticationSuccessHandler, setContinueChainBeforeSuccessfulAuthentication, setFilterProcessesUrl, setMessageSource, setRememberMeServices, setRequiresAuthenticationRequestMatcher, setSessionAuthenticationStrategy, successfulAuthentication, successfulAuthentication, unsuccessfulAuthentication

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

addRequiredProperty, destroy, 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

Field Detail

DEFAULT_REQUEST_MATCHER

public static final org.springframework.security.web.util.matcher.RequestMatcher DEFAULT_REQUEST_MATCHER

Request matcher that matches requests to the default login URI and any request with a Authorization header.

Constructor Detail

KeycloakAuthenticationProcessingFilter

public KeycloakAuthenticationProcessingFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager)

Creates a new Keycloak authentication processing filter with given AuthenticationManager and the default request matcher.

Parameters:

authenticationManager - the AuthenticationManager to authenticate requests (cannot be null)

See Also:

DEFAULT_REQUEST_MATCHER

KeycloakAuthenticationProcessingFilter

public KeycloakAuthenticationProcessingFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager,
                                      org.springframework.security.web.util.matcher.RequestMatcher requiresAuthenticationRequestMatcher)

Creates a new Keycloak authentication processing filter with given AuthenticationManager and RequestMatcher.

Note: the given request matcher must support matching the Authorization header if bearer token authentication is to be accepted.

Parameters:

authenticationManager - the AuthenticationManager to authenticate requests (cannot be null)

requiresAuthenticationRequestMatcher - the RequestMatcher used to determine if authentication is required (cannot be null)

See Also:

RequestHeaderRequestMatcher, OrRequestMatcher

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

attemptAuthentication

public org.springframework.security.core.Authentication attemptAuthentication(javax.servlet.http.HttpServletRequest request,
                                                                     javax.servlet.http.HttpServletResponse response)
                                                                       throws org.springframework.security.core.AuthenticationException,
                                                                              IOException,
                                                                              javax.servlet.ServletException

Specified by:

attemptAuthentication in class org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter

Throws:

org.springframework.security.core.AuthenticationException

IOException

javax.servlet.ServletException

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException