org.apache.nifi.web.security

Class NiFiAuthenticationFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.apache.nifi.web.security.NiFiAuthenticationFilter

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.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

Direct Known Subclasses:

KnoxAuthenticationFilter, NiFiAnonymousAuthenticationFilter, X509AuthenticationFilter

public abstract class NiFiAuthenticationFilter
extends org.springframework.web.filter.GenericFilterBean

The NiFiAuthenticationFilter abstract class defines the base methods for NiFi's various existing and future authentication mechanisms. The subclassed filters are applied in NiFiWebApiSecurityConfiguration.

Field Summary

Fields

Modifier and Type	Field and Description
private org.springframework.security.authentication.AuthenticationManager	authenticationManager
private static org.slf4j.Logger	log
private NiFiProperties	properties

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

logger

Constructor Summary

Constructors

Constructor and Description
NiFiAuthenticationFilter()

Method Summary

Modifier and Type	Method and Description
abstract org.springframework.security.core.Authentication	attemptAuthentication(javax.servlet.http.HttpServletRequest request) Attempt to extract an authentication attempt from the specified request.
private void	authenticate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
NiFiProperties	getProperties()
private boolean	requiresAuthentication()
void	setAuthenticationManager(org.springframework.security.authentication.AuthenticationManager authenticationManager)
void	setProperties(NiFiProperties properties)
protected void	successfulAuthentication(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.security.core.Authentication authResult) If authentication was successful, apply the successful authentication result to the security context and add proxy headers to the response if the request was made via a proxy.
protected void	unsuccessfulAuthentication(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.springframework.security.core.AuthenticationException ae) If authentication was unsuccessful, update the response with the appropriate status and give the reason for why the user was not able to be authenticated.

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

Field Detail

log

private static final org.slf4j.Logger log

authenticationManager

private org.springframework.security.authentication.AuthenticationManager authenticationManager

properties

private NiFiProperties properties

Constructor Detail

NiFiAuthenticationFilter

public NiFiAuthenticationFilter()

Method Detail

doFilter

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

Throws:

IOException

javax.servlet.ServletException

requiresAuthentication

private boolean requiresAuthentication()

authenticate

private void authenticate(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          javax.servlet.FilterChain chain)
                   throws IOException,
                          javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

attemptAuthentication

public abstract org.springframework.security.core.Authentication attemptAuthentication(javax.servlet.http.HttpServletRequest request)

Attempt to extract an authentication attempt from the specified request.

Parameters:

request - The request

Returns:

The authentication attempt or null if none is found int he request

successfulAuthentication

protected void successfulAuthentication(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        org.springframework.security.core.Authentication authResult)

If authentication was successful, apply the successful authentication result to the security context and add proxy headers to the response if the request was made via a proxy.

Parameters:

request - The original client request that was successfully authenticated.

response - Servlet response to the client containing the successful authentication details.

authResult - The Authentication 'token'/object created by one of the various NiFiAuthenticationFilter subclasses.

unsuccessfulAuthentication

protected void unsuccessfulAuthentication(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response,
                                          org.springframework.security.core.AuthenticationException ae)
                                   throws IOException

If authentication was unsuccessful, update the response with the appropriate status and give the reason for why the user was not able to be authenticated. Update the response with proxy headers if the request was made via a proxy.

Parameters:

request - The original client request that failed to be authenticated.

response - Servlet response to the client containing the unsuccessful authentication attempt details.

ae - The related exception thrown and explanation for the unsuccessful authentication attempt.

Throws:

IOException

setAuthenticationManager

public void setAuthenticationManager(org.springframework.security.authentication.AuthenticationManager authenticationManager)

setProperties

public void setProperties(NiFiProperties properties)

getProperties

public NiFiProperties getProperties()