org.broadleafcommerce.common.security.channel.ProtoChannelBeanPostProcessor Maven / Gradle / Ivy

/*
 * #%L
 * BroadleafCommerce Common Libraries
 * %%
 * Copyright (C) 2009 - 2013 Broadleaf Commerce
 * %%
 * Licensed 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.
 * #L%
 */
package org.broadleafcommerce.common.security.channel;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.core.Ordered;
import org.springframework.security.web.access.channel.ChannelDecisionManagerImpl;
import org.springframework.security.web.access.channel.ChannelProcessor;
import org.springframework.security.web.access.channel.InsecureChannelProcessor;
import org.springframework.security.web.access.channel.SecureChannelProcessor;

import java.lang.reflect.Field;
import java.util.List;

import javax.servlet.ServletRequest;

/**
 * This class is designed to work in both a load-balanced and non load-balanced environment by replacing the existing
 * default Spring channel processors which do not work in a load balanced environment. Configuration should be done
 * as follows in your applicationContext-security:
 * 
 * Deploying to a load balanced environment with SSL termination at the load balancer as well as an environment
 * with SSL termination at Tomcat/Apache:
 * 
 *  * {@code
 *   
 *       
 *           
 *              
 *              
 *          
 *      
 *  
 *  }
 * 
 * 
 * That said, this solution only overrides the Spring Security directives but does not make any attempts to override
 * any invocations to {@link ServletRequest#isSecure}. If your application server supports it, we recommend instead using
 * that approach which will encapsulate any functionality encapsulated within the Proto processors. For more information
 * on configuring your specific servlet container, see
 * this issue report
 * 
 * 
 * @author Jeff Fischer
 * @author Phillip Verheyden (phillipuniverse)
 * @see {@link ProtoSecureChannelProcessor}
 * @see {@link ProtoInsecureChannelProcessor}
 * @see {@link SecureChannelProcessor}
 * @see {@link InsecureChannelProcessor}
 */
public class ProtoChannelBeanPostProcessor implements BeanPostProcessor, Ordered {

    Log LOG = LogFactory.getLog(ProtoChannelBeanPostProcessor.class);
    
    protected List channelProcessorOverrides;
    
    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        if (bean instanceof ChannelDecisionManagerImpl) {
            try {
                ChannelDecisionManagerImpl manager = (ChannelDecisionManagerImpl) bean;
                Field channelProcessors = manager.getClass().getDeclaredField("channelProcessors");
                channelProcessors.setAccessible(true);
                List list = (List) channelProcessors.get(manager);
                list.clear();
                manager.setChannelProcessors(channelProcessorOverrides);
                LOG.info("Replacing the standard Spring Security channel processors with custom processors that look for a " +
                		"'X-Forwarded-Proto' request header. This allows Spring Security to sit behind a load balancer with SSL termination.");
            } catch (Exception e) {
                throw new RuntimeException(e);
            }
        }
        return bean;
    }

    @Override
    public int getOrder() {
        return 9999;
    }

    /**
     * @return the channelProcessors
     */
    public List getChannelProcessorOverrides() {
        return channelProcessorOverrides;
    }
    
    /**
     * @param channelProcessors the channelProcessors to set
     */
    public void setChannelProcessorOverrides(List channelProcessorOverrides) {
        this.channelProcessorOverrides = channelProcessorOverrides;
    }
    
}