identity/setup/AMSetupFilter.java

	AMSetupFilter.java revision 2d148ab324513a084980477239a7892b43c125d0
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
 *
 * The contents of this file are subject to the terms
 * of the Common Development and Distribution License
 * (the License). You may not use this file except in
 * compliance with the License.
 *
 * You can obtain a copy of the License at
 * https://opensso.dev.java.net/public/CDDLv1.0.html or
 * opensso/legal/CDDLv1.0.txt
 * See the License for the specific language governing
 * permission and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL
 * Header Notice in each file and include the License file
 * at opensso/legal/CDDLv1.0.txt.
 * If applicable, add the following below the CDDL Header,
 * with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * $Id: AMSetupFilter.java,v 1.12 2008/07/13 06:06:49 kevinserwin Exp $
 *
 * Portions Copyrighted 2011-2015 ForgeRock AS.
 */

package com.sun.identity.setup;

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.File;
import java.io.IOException;

import com.sun.identity.common.configuration.ConfigurationException;
import com.sun.identity.shared.Constants;
import org.forgerock.openam.upgrade.VersionUtils;
import org.forgerock.util.annotations.VisibleForTesting;

/**
 * This filter brings administrator to a configuration page
 * where the product can be configured if the product is not
 * yet configured.
*/
public final class AMSetupFilter implements Filter {

    private boolean passthrough;
    private static final String SETUP_URI = "/config/options.htm";
    private static final String UPGRADE_URI = "/config/upgrade/upgrade.htm";
    private static final String SETUP_PROGRESS_URI = "/setup/setSetupProgress";
    private static final String UPGRADE_PROGESS_URI = "/upgrade/setUpgradeProgress";
    private static final String NOWRITE_PERMISSION = "/nowritewarning.jsp";

    private static String[] fList = {
        ".ico", ".htm", ".css", ".js", ".jpg", ".gif", ".png",".JPG", "SMSObjectIF" , "setSetupProgress",
        "setUpgradeProgress", "/legal-notices/"
    };

    private final AMSetupWrapper setupWrapper;

    public AMSetupFilter() {
        this(new AMSetupWrapper());
    }

    @VisibleForTesting
    AMSetupFilter(AMSetupWrapper setupWrapper) {
        this.setupWrapper = setupWrapper;
    }

    /**
     * Redirects request to configuration page if the product is not yet
     * configured.
     *
     * @param request Servlet Request.
     * @param response Servlet Response.
     * @param filterChain Filter Chain.
     * @throws IOException if configuration file cannot be read.
     * @throws ServletException if there are errors in the servlet space.
     */
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException,
            ServletException {
        HttpServletRequest  httpRequest = (HttpServletRequest) request;
        HttpServletResponse httpResponse = (HttpServletResponse) response;
        try {
            if (setupWrapper.isCurrentConfigurationValid()) {
                String incomingURL = httpRequest.getRequestURI();
                if (incomingURL.endsWith(SETUP_URI) || incomingURL.endsWith(UPGRADE_URI)
                        || incomingURL.endsWith(SETUP_PROGRESS_URI) || incomingURL.endsWith(UPGRADE_PROGESS_URI)) {
                    String url = httpRequest.getScheme() + "://" + httpRequest.getServerName() + ":"
                            + httpRequest.getServerPort() + httpRequest.getContextPath();
                    httpResponse.sendRedirect(url);
                } else {
                    filterChain.doFilter(httpRequest, httpResponse);
                }
            } else {
                if (setupWrapper.getBootStrapFile() != null && !setupWrapper.isVersionNewer()
                        && !setupWrapper.isUpgradeCompleted()) {
                    String redirectUrl = System.getProperty(Constants.CONFIG_STORE_DOWN_REDIRECT_URL);
                    if (redirectUrl != null && redirectUrl.length() > 0) {
                        httpResponse.sendRedirect(redirectUrl);
                    } else {
                        throw new ConfigurationException("configstore.down", null);
                    }
                } else {
                    if (isPassthrough() && validateStream(httpRequest)) {
                        filterChain.doFilter(httpRequest, httpResponse);
                    } else {
                        String incomingURL = httpRequest.getRequestURI();
                        if (incomingURL.endsWith("configurator")) {
                            filterChain.doFilter(httpRequest, httpResponse);
                        } else {
                            String url = httpRequest.getScheme() + "://" + httpRequest.getServerName() + ":"
                                    + httpRequest.getServerPort() + httpRequest.getContextPath();
                            if (setupWrapper.getUserHomeDirectory().canWrite()) {
                                url += SETUP_URI;
                            } else {
                                url += NOWRITE_PERMISSION;
                            }
                            httpResponse.sendRedirect(url);
                            markPassthrough();
                        }
                    }
                }
            }
        } catch (Exception ex) {
            ex.printStackTrace();
            throw new ServletException("AMSetupFilter.doFilter", ex);
        }
    }

    /**
     * Returns <code>true</code> if the request for resources.
     *
     * @param httpRequest HTTP Servlet request.
     * @return <code>true</code> if the request for resources.
     */
    private boolean validateStream(HttpServletRequest httpRequest) {
        String uri = httpRequest.getRequestURI();
        boolean ok = false;
        for (int i = 0; (i < fList.length) && !ok; i++) {
            ok = uri.contains(fList[i]);
        }
        return ok;
    }

    /**
     * Destroy the filter config on sever shutdowm
     */
    public void destroy() {
    }

    /**
     * Initializes the filter.
     *
     * @param filterConfig Filter Configuration.
     */
    public void init(FilterConfig filterConfig) {
        ServletContext servletCtx = filterConfig.getServletContext();
        if (!setupWrapper.checkInitState(servletCtx)) {
            //Set the encryption Key
            servletCtx.setAttribute("am.enc.pwd", setupWrapper.getRandomString());
        }
    }

    /**
     * Returns <code>true</code> if the request is allowed without processing.
     *
     * @return <code>true</code> if the request is allowed without processing.
     */
    private boolean isPassthrough() {
        return passthrough;
    }

    /**
     * Sets the request for images such that they are not processed.
     */
    private void markPassthrough() {
        passthrough = true;
    }

    static class AMSetupWrapper {

        boolean checkInitState(ServletContext context) {
            return AMSetupServlet.checkInitState(context);
        }

        String getRandomString() {
            return AMSetupUtils.getRandomString();
        }

        boolean isCurrentConfigurationValid() {
            return AMSetupServlet.isCurrentConfigurationValid();
        }

        String getBootStrapFile() {
            return AMSetupServlet.getBootStrapFile();
        }

        boolean isVersionNewer() {
            return VersionUtils.isVersionNewer();
        }

        boolean isUpgradeCompleted() {
            return AMSetupServlet.isUpgradeCompleted();
        }

        File getUserHomeDirectory() {
            return new File(System.getProperty("user.home"));
        }
    }
}