org.alfresco.solr.servlet.Solr4X509ServletFilter.java Source code

Introduction

Here is the source code for org.alfresco.solr.servlet.Solr4X509ServletFilter.java

Source

/*
 * #%L
 * Alfresco Solr 4
 * %%
 * Copyright (C) 2005 - 2016 Alfresco Software Limited
 * %%
 * This file is part of the Alfresco software. 
 * If the software was purchased under a paid Alfresco license, the terms of 
 * the paid license agreement will prevail.  Otherwise, the software is 
 * provided under the following open source license terms:
 * 
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

package org.alfresco.solr.servlet;

import javax.servlet.*;
import javax.management.*;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.*;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.solr.core.SolrResourceLoader;
import org.alfresco.web.scripts.servlet.X509ServletFilterBase;

/**
 * The Solr4X509ServletFilter implements the checkEnforce method of the X509ServletFilterBase.
 * This allows the configuration of X509 authentication to be toggled on/off through a
 * configuration outside of the web.xml.
 **/

public class Solr4X509ServletFilter extends X509ServletFilterBase {

    private static final String SECURE_COMMS = "alfresco.secureComms";

    private static Log logger = LogFactory.getLog(Solr4X509ServletFilter.class);

    @Override
    protected boolean checkEnforce(ServletContext context) throws IOException {
        /*
        * Rely on the SolrResourceLoader to locate the solr home directory.
        */

        int httpsPort = getHttpsPort();

        if (httpsPort > -1) {
            setHttpsPort(httpsPort);
        }

        String solrHome = SolrResourceLoader.locateSolrHome();

        if (logger.isDebugEnabled()) {
            logger.debug("solrHome:" + solrHome);
        }

        /*
        * Find the active cores.
        */
        List<File> cores = new ArrayList();
        findCores(new File(solrHome), cores);

        /*
        * Get the alfresco.secureComms value for each core.
        */
        Set<String> secureCommsSet = new HashSet();
        for (File core : cores) {
            collectSecureComms(core, secureCommsSet);
        }

        /*
        * alfresco.secureComms values should be in sync for each core
        */

        if (secureCommsSet.size() > 1) {
            StringBuilder buf = new StringBuilder();
            int i = 0;
            for (String s : secureCommsSet) {
                if (i > 0) {
                    buf.append(" | ");
                }
                buf.append(s);
                i++;
            }

            throw new IOException("More then one distinct value found for alfresco.secureComms:" + buf.toString()
                    + ". All alfresco.secureComms values must be set to the same value.");
        }

        if (secureCommsSet.size() == 0) {
            //No secureComms were found.
            return false;
        }

        String secureComms = secureCommsSet.iterator().next();

        if (logger.isDebugEnabled()) {
            logger.debug("secureComms:" + secureComms);
        }

        if ("none".equals(secureComms)) {
            return false;
        } else {
            return true;
        }
    }

    private void findCores(File dir, List<File> cores) {
        File[] files = dir.listFiles();
        for (File file : files) {
            if (file.isDirectory()) {
                findCores(file, cores);
            } else {
                if ("core.properties".equals(file.getName())) {
                    if (logger.isDebugEnabled()) {
                        logger.debug("Found core:" + dir.getAbsolutePath());
                    }

                    cores.add(dir);
                }
            }
        }
    }
    /*
    * Scan through all the files and folders under a dir looking for solrcore.properties file.
    * Gather the SECURE_COMMS property when found.
    */

    private void collectSecureComms(File base, Set<String> secureCommsSet) throws IOException {
        File[] files = base.listFiles();

        for (File file : files) {
            if (file.isDirectory()) {
                collectSecureComms(file, secureCommsSet);
            } else {

                if (logger.isDebugEnabled()) {
                    logger.debug("scanning file:" + file.getAbsolutePath());
                }

                if ("solrcore.properties".equals(file.getName())) {
                    FileReader propReader = null;
                    Properties props = new Properties();
                    try {
                        propReader = new FileReader(file);
                        props.load(propReader);
                        String prop = props.getProperty(SECURE_COMMS);

                        if (prop != null) {
                            if (logger.isDebugEnabled()) {
                                logger.debug(
                                        "Found alfresco.secureComms in:" + file.getAbsolutePath() + " : " + prop);
                            }
                            secureCommsSet.add(prop);
                        } else {
                            secureCommsSet.add("none");
                        }
                    } finally {
                        propReader.close();
                    }
                }
            }
        }
    }

    private int getHttpsPort() {
        try {
            MBeanServer mBeanServer = MBeanServerFactory.findMBeanServer(null).get(0);
            QueryExp query = Query.eq(Query.attr("Scheme"), Query.value("https"));
            Set<ObjectName> objectNames = mBeanServer.queryNames(null, query);

            if (objectNames != null && objectNames.size() > 0) {
                for (ObjectName objectName : objectNames) {
                    String name = objectName.toString();
                    if (name.indexOf("port=") > -1) {
                        String[] parts = name.split("port=");
                        String port = parts[1];
                        try {
                            int portNum = Integer.parseInt(port);
                            return portNum;
                        } catch (NumberFormatException e) {
                            logger.error("Error parsing https port:" + port);
                            return -1;
                        }
                    }
                }
            }
        } catch (Throwable t) {
            logger.error("Error getting https port:", t);
        }

        return -1;
    }
}