edu.ucmerced.cas.web.support.CasShibUtil.java Source code

Introduction

Here is the source code for edu.ucmerced.cas.web.support.CasShibUtil.java

Source

/*
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig 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 the following location:
 *
 *   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 edu.ucmerced.cas.web.support;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import javax.servlet.http.HttpServletRequest;
import org.jasig.cas.services.UnauthorizedServiceException;
import edu.ucmerced.cas.services.CasShibServiceRegistrar;
import edu.ucmerced.cas.services.CasShibRegisteredService;

/**
 * General web utility methods for CASShib functionality.
 * 
 * @author Brian Koehmstedt
 * @version $Revision$ $Date$
 * @since 3.3.1a
 */
public class CasShibUtil {
    /** Log instance for logging events, info, warnings, errors, etc. */
    private static final Log log = LogFactory.getLog(CasShibUtil.class);

    /**
     * This parses out the application name from the request URI.
     * 
     * <p/>
     * 
     * Convention is as follows: /<contextPath>/shib/<appName>/...<br/>
     * Registrations are typically in casshib-service-registrations.xml.
     * 
     * @see AbstractShibEnabledArgumentExtractor
     * 
     * @throws UnauthorizedServiceException
     *             Thrown if the application name is not registered.
     * @param request
     *            <code>HttpServletRequest</code> object
     * @param registrar
     *            The CASShib service registrar
     * @return The application name from the request URI.
     */
    public static String getAppNameFromRequestURI(HttpServletRequest request, CasShibServiceRegistrar registrar) {
        // If the request URI follows the form of
        // <contextPath>/shib/<appName>/<service> then we can determine
        // appName from the requestURI. This is needed for cookie paths (so
        // we have a cookie-per-app) and also redirecting to Shibboleth
        // logout URLs.

        if (request == null || request.getRequestURI() == null)
            return null;

        String appName = null;
        String prefix = (request.getContextPath() != null ? request.getContextPath() : "") + "/shib/";
        if (request.getRequestURI().startsWith(prefix)) {
            appName = request.getRequestURI().substring(prefix.length(), request.getRequestURI().lastIndexOf('/'));
        }

        // Verify the app is a valid registered app. Note if CAS login URLs
        // are protected by the Shibboleth SP web server module then
        // Shibboleth may pre-emptively error out before we ever get here
        // (it might not error out either if you map to a valid default
        // service in shibboleth2.xml).
        try {
            CasShibRegisteredService service = registrar.findServiceByAppName(appName);
            if (service == null) {
                log.warn("Application with name of " + appName + " is not registered.");
                throw new UnauthorizedServiceException("Application name is not registered.");
            }
        } catch (CasShibServiceRegistrar.CasShibServiceRegistrarException e) {
            log.warn("Exception trying to look up application with name of " + appName + ": " + e.getMessage());
            throw new UnauthorizedServiceException("Application name is not registered.", e);
        }

        return (appName);
    }
}