/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.gateway;
import org.apache.hadoop.gateway.audit.api.Action;
import org.apache.hadoop.gateway.audit.api.ActionOutcome;
import org.apache.hadoop.gateway.audit.api.AuditContext;
import org.apache.hadoop.gateway.audit.api.AuditService;
import org.apache.hadoop.gateway.audit.api.AuditServiceFactory;
import org.apache.hadoop.gateway.audit.api.Auditor;
import org.apache.hadoop.gateway.audit.api.CorrelationContext;
import org.apache.hadoop.gateway.audit.api.CorrelationServiceFactory;
import org.apache.hadoop.gateway.audit.api.ResourceType;
import org.apache.hadoop.gateway.audit.log4j.audit.AuditConstants;
import org.apache.hadoop.gateway.filter.AbstractGatewayFilter;
import org.apache.hadoop.gateway.i18n.messages.MessagesFactory;
import org.apache.hadoop.gateway.i18n.resources.ResourcesFactory;
import org.apache.hadoop.gateway.util.urltemplate.Matcher;
import org.apache.hadoop.gateway.util.urltemplate.Parser;
import org.apache.hadoop.gateway.util.urltemplate.Template;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
/**
*
*/
public class GatewayFilter implements Filter {
private static final FilterChain EMPTY_CHAIN = new FilterChain() {
public void doFilter( ServletRequest servletRequest, ServletResponse servletResponse ) throws IOException, ServletException {
}
};
private static final GatewayMessages LOG = MessagesFactory.get( GatewayMessages.class );
private static final GatewayResources RES = ResourcesFactory.get( GatewayResources.class );
private static AuditService auditService = AuditServiceFactory.getAuditService();
private static Auditor auditor = auditService.getAuditor(
AuditConstants.DEFAULT_AUDITOR_NAME, AuditConstants.KNOX_SERVICE_NAME,
AuditConstants.KNOX_COMPONENT_NAME );
private Set<Holder> holders;
private Matcher<Chain> chains;
private FilterConfig config;
public GatewayFilter() {
holders = new HashSet<Holder>();
chains = new Matcher<Chain>();
}
@Override
public void init( FilterConfig filterConfig ) throws ServletException {
this.config = filterConfig;
}
@Override
public void doFilter( ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain ) throws IOException, ServletException {
doFilter( servletRequest, servletResponse );
}
@SuppressWarnings("unckecked")
public void doFilter( ServletRequest servletRequest, ServletResponse servletResponse ) throws IOException, ServletException {
HttpServletRequest httpRequest = (HttpServletRequest)servletRequest;
HttpServletResponse httpResponse = (HttpServletResponse)servletResponse;
//TODO: The resulting pathInfo + query needs to be added to the servlet context somehow so that filters don't need to rebuild it. This is done in HttpClientDispatch right now for example.
String query = httpRequest.getQueryString();
String path = httpRequest.getPathInfo() + ( query == null ? "" : "?" + query );
Template pathTemplate;
try {
pathTemplate = Parser.parse( path );
} catch( URISyntaxException e ) {
throw new ServletException( e );
}
String pathWithContext = httpRequest.getContextPath() + path;
LOG.receivedRequest( httpRequest.getMethod(), pathTemplate );
servletRequest.setAttribute( AbstractGatewayFilter.SOURCE_REQUEST_URL_ATTRIBUTE_NAME, pathTemplate );
servletRequest.setAttribute( AbstractGatewayFilter.SOURCE_REQUEST_CONTEXT_URL_ATTRIBUTE_NAME, pathWithContext );
Matcher<Chain>.Match match = chains.match( pathTemplate );
assignCorrelationRequestId();
// Populate Audit/correlation parameters
AuditContext auditContext = auditService.createContext();
auditContext.setTargetServiceName( match == null ? null : match.getValue().getResourceRole() );
auditContext.setRemoteIp( servletRequest.getRemoteAddr() );
auditContext.setRemoteHostname( servletRequest.getRemoteHost() );
auditor.audit( Action.ACCESS, pathWithContext, ResourceType.URI, ActionOutcome.UNAVAILABLE );
if( match != null ) {
Chain chain = match.getValue();
try {
chain.doFilter( servletRequest, servletResponse );
} catch( IOException e ) {
LOG.failedToExecuteFilter( e );
auditor.audit( Action.ACCESS, pathWithContext, ResourceType.URI, ActionOutcome.FAILURE );
throw e;
} catch( ServletException e ) {
LOG.failedToExecuteFilter( e );
auditor.audit( Action.ACCESS, pathWithContext, ResourceType.URI, ActionOutcome.FAILURE );
throw e;
} catch( RuntimeException e ) {
LOG.failedToExecuteFilter( e );
auditor.audit( Action.ACCESS, pathWithContext, ResourceType.URI, ActionOutcome.FAILURE );
throw e;
} catch( ThreadDeath e ) {
LOG.failedToExecuteFilter( e );
auditor.audit( Action.ACCESS, pathWithContext, ResourceType.URI, ActionOutcome.FAILURE );
throw e;
} catch( Throwable e ) {
LOG.failedToExecuteFilter( e );
auditor.audit( Action.ACCESS, pathWithContext, ResourceType.URI, ActionOutcome.FAILURE );
throw new ServletException( e );
}
} else {
LOG.failedToMatchPath( path );
httpResponse.setStatus( HttpServletResponse.SC_NOT_FOUND );
}
//KAM[ Don't do this or the Jetty default servlet will overwrite any response setup by the filter.
// filterChain.doFilter( servletRequest, servletResponse );
//]
}
@Override
public void destroy() {
for( Holder holder : holders ) {
holder.destroy();
}
}
private void addHolder( Holder holder ) {
holders.add( holder );
Chain chain = chains.get( holder.template );
if( chain == null ) {
chain = new Chain();
chain.setResourceRole( holder.getResourceRole() );
chains.add( holder.template, chain );
}
chain.chain.add( holder );
}
public void addFilter( String path, String name, Filter filter, Map<String,String> params, String resourceRole ) throws URISyntaxException {
Holder holder = new Holder( path, name, filter, params, resourceRole );
addHolder( holder );
}
// public void addFilter( String path, String name, Class<WarDirFilter> clazz, Map<String,String> params ) throws URISyntaxException {
// Holder holder = new Holder( path, name, clazz, params );
// addHolder( holder );
// }
public void addFilter( String path, String name, String clazz, Map<String,String> params, String resourceRole ) throws URISyntaxException {
Holder holder = new Holder( path, name, clazz, params, resourceRole );
addHolder( holder );
}
private void assignCorrelationRequestId() {
CorrelationContext correlationContext = CorrelationServiceFactory.getCorrelationService().createContext();
correlationContext.setRequestId( UUID.randomUUID().toString() );
}
private class Chain implements FilterChain {
private List<Holder> chain;
private String resourceRole;
private Chain() {
this.chain = new ArrayList<Holder>();
}
private Chain( List<Holder> chain ) {
this.chain = chain;
}
public void doFilter( ServletRequest servletRequest, ServletResponse servletResponse ) throws IOException, ServletException {
if( chain != null && !chain.isEmpty() ) {
chain.get( 0 ).doFilter( servletRequest, servletResponse, subChain() );
}
}
private FilterChain subChain() {
if( chain != null && chain.size() > 1 ) {
return new Chain( chain.subList( 1, chain.size() ) );
} else {
return EMPTY_CHAIN;
}
}
private String getResourceRole() {
return resourceRole;
}
private void setResourceRole( String resourceRole ) {
this.resourceRole = resourceRole;
}
}
private class Holder implements Filter, FilterConfig {
// private String path;
private Template template;
private String name;
private Map<String,String> params;
private Filter instance;
private Class<? extends Filter> clazz;
private String type;
private String resourceRole;
private Holder( String path, String name, Filter filter, Map<String,String> params, String resourceRole ) throws URISyntaxException {
// this.path = path;
this.template = Parser.parse( path );
this.name = name;
this.params = params;
this.instance = filter;
this.clazz = filter.getClass();
this.type = clazz.getCanonicalName();
this.resourceRole = resourceRole;
}
// private Holder( String path, String name, Class<WarDirFilter> clazz, Map<String,String> params ) throws URISyntaxException {
// this.path = path;
// this.template = Parser.parse( path );
// this.name = name;
// this.params = params;
// this.instance = null;
// this.clazz = clazz;
// this.type = clazz.getCanonicalName();
// }
private Holder( String path, String name, String clazz, Map<String,String> params, String resourceRole ) throws URISyntaxException {
// this.path = path;
this.template = Parser.parse( path );
this.name = name;
this.params = params;
this.instance = null;
this.clazz = null;
this.type = clazz;
this.resourceRole = resourceRole;
}
@Override
public String getFilterName() {
return name;
}
@Override
public ServletContext getServletContext() {
return GatewayFilter.this.config.getServletContext();
}
@Override
public String getInitParameter( String name ) {
String value = null;
if( params != null ) {
value = params.get( name );
}
return value;
}
@Override
public Enumeration<String> getInitParameterNames() {
Enumeration<String> names = null;
if( params != null ) {
names = Collections.enumeration( params.keySet() );
}
return names;
}
@Override
public void init( FilterConfig filterConfig ) throws ServletException {
getInstance().init( filterConfig );
}
@Override
public void doFilter( ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain ) throws IOException, ServletException {
getInstance().doFilter( servletRequest, servletResponse, filterChain );
}
@Override
public void destroy() {
if( instance != null ) {
instance.destroy();
instance = null;
}
}
@SuppressWarnings("unchecked")
private Class<? extends Filter> getClazz() throws ClassNotFoundException {
if( clazz == null ) {
ClassLoader loader = Thread.currentThread().getContextClassLoader();
if( loader == null ) {
loader = this.getClass().getClassLoader();
}
clazz = (Class)loader.loadClass( type );
}
return clazz;
}
private Filter getInstance() throws ServletException {
if( instance == null ) {
try {
if( clazz == null ) {
clazz = getClazz();
}
instance = clazz.newInstance();
instance.init( this );
} catch( Exception e ) {
throw new ServletException( e );
}
}
return instance;
}
private String getResourceRole() {
return resourceRole;
}
}
}