services/util/CookieUtils.java

/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2005 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: CookieUtils.java,v 1.3 2008/06/25 05:41:41 qcheng Exp $
 *
 */

package com.iplanet.services.util;

import com.iplanet.am.util.SystemProperties;
import com.sun.identity.shared.Constants;
import com.sun.identity.shared.debug.Debug;
import com.sun.identity.shared.encode.URLEncDec;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import java.util.StringTokenizer;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;

/**
 * Implements utility methods for handling Cookie.
 *
 * @deprecated As of OpenSSO version 8.0
 *             {@link com.sun.identity.shared.encode.CookieUtils}
 */

public class CookieUtils {
    static boolean secureCookie = (SystemProperties
            .get(Constants.AM_COOKIE_SECURE) != null && SystemProperties.get(
            Constants.AM_COOKIE_SECURE).equalsIgnoreCase("true"));

    static boolean cookieEncoding = (SystemProperties
            .get(Constants.AM_COOKIE_ENCODE) != null && SystemProperties.get(
            Constants.AM_COOKIE_ENCODE).equalsIgnoreCase("true"));

    static String amCookieName = SystemProperties.get(Constants.AM_COOKIE_NAME);

    static String amPCookieName = SystemProperties
            .get(Constants.AM_PCOOKIE_NAME);

    static String cdssoCookiedomain = SystemProperties
            .get(Constants.SERVICES_CDSSO_COOKIE_DOMAIN);

    static String fedCookieName = SystemProperties
            .get(Constants.FEDERATION_FED_COOKIE_NAME);

    private static Set cookieDomains = null;

    private static int defAge = -1;

    static Debug debug = Debug.getInstance("amCookieUtils");

    /**
     * Gets property value of "com.iplanet.am.cookie.name"
     *
     * @return the property value of "com.iplanet.am.cookie.name"
     */
    public static String getAmCookieName() {
        return amCookieName;
    }

    /**
     * Gets property value of "com.iplanet.am.pcookie.name"
     *
     * @return the property value of "com.iplanet.am.pcookie.name"
     */
    public static String getAmPCookieName() {
        return amPCookieName;
    }

    /**
     * Gets property value of "com.iplanet.services.cdsso.cookiedomain"
     *
     * @return the property value of "com.iplanet.services.cdsso.cookiedomain"
     */
    public static Set getCdssoCookiedomain() {
        if (cookieDomains != null) {
            return cookieDomains;
        }

        Set cookieDomains = new HashSet();
        if (cdssoCookiedomain == null || cdssoCookiedomain.length() < 1) {
            return Collections.EMPTY_SET;
        }

        StringTokenizer st = new StringTokenizer(cdssoCookiedomain, ",");
        while (st.hasMoreTokens()) {
            String token = st.nextToken().trim();
            if (token.length() > 0) {
                cookieDomains.add(token);
            }
        }

        if (cookieDomains.isEmpty()) {
            return Collections.EMPTY_SET;
        }

        return cookieDomains;
    }

    /**
     * Gets property value of "com.sun.identity.federation.fedCookieName"
     *
     * @return the property value of "com.sun.identity.federation.fedCookieName"
     */
    public static String getFedCookieName() {
        return fedCookieName;
    }

    /**
     * Gets property value of "com.iplanet.am.cookie.secure"
     *
     * @return the property value of "com.iplanet.am.cookie.secure"
     */
    public static boolean isCookieSecure() {
        return secureCookie;
    }

    /**
     * Gets value of cookie that has mached name in servlet request
     *
     * @param req
     *            request
     * @param name
     *            name in servlet request
     * @return value of that name of cookie
     */
    public static String getCookieValueFromReq(HttpServletRequest req,
            String name) {
        String cookieValue = null;
        try {
            Cookie cookie = getCookieFromReq(req, name);
            if (cookie != null) {
                return getCookieValue(cookie);
            } else {
                debug.message("No Cookie is in the request");
            }
        } catch (Exception e) {
            debug.error("Error getting cookie  : ", e);
        }

        return cookieValue;
    }

    /**
     * Gets cookie object that has mached name in servlet request
     *
     * @param req
     *            request
     * @param name
     *            name in servlet request
     * @return value of that name of cookie
     */
    public static Cookie getCookieFromReq(HttpServletRequest req, String name) {
        Cookie cookies[] = req.getCookies();
        if (cookies != null) {
            for (int nCookie = 0; nCookie < cookies.length; nCookie++) {
                if (cookies[nCookie].getName().equalsIgnoreCase(name)) {
                    return cookies[nCookie];
                }
            }
        }
        return null;
    }

    /**
     * Gets normalized value of cookie
     *
     * @param cookie
     *            cookie object
     * @return value
     */
    public static String getCookieValue(Cookie cookie) {
        String cookieValue = checkDoubleQuote(cookie.getValue());

        // Check property value and it decode value
        // Bea, IBM
        if (cookieValue != null && cookieEncoding) {
            return URLEncDec.decode(cookieValue);
        }
        return cookieValue;
    }

    /**
     * Gets Array of cookie in servlet request
     *
     * @param req
     *            request
     *
     */
    public static Cookie[] getCookieArrayFromReq(HttpServletRequest req) {
        Cookie cookies[] = req.getCookies();

        if (!cookieEncoding) {
            return cookies;
        }

        if (cookies != null) {
            for (int nCookie = 0; nCookie < cookies.length; nCookie++) {
                String cookieValue = checkDoubleQuote(cookies[nCookie]
                        .getValue());
                if (cookieValue != null) {
                    cookies[nCookie].setValue(URLEncDec.decode(cookieValue));
                }
            }
        }
        return cookies;
    }

    /**
     * Constructs a cookie with a specified name and value.
     *
     * @param name
     *            a String specifying the name of the cookie
     *
     * @param value
     *            a String specifying the value of the cookie
     *
     * @return constructed cookie
     */
    public static Cookie newCookie(String name, String value) {
        return newCookie(name, value, defAge, null, null);
    }

    /**
     * Constructs a cookie with a specified name and value and sets the maximum
     * age of the cookie in seconds.
     *
     * @param name
     *            a String specifying the name of the cookie
     *
     * @param value
     *            a String specifying the value of the cookie
     *
     * @param maxAge
     *            an integer specifying the maximum age of the cookie in
     *            seconds; if negative, means the cookie is not stored; if zero,
     *            deletes the cookie
     *
     * @return constructed cookie
     */
    public static Cookie newCookie(String name, String value, int maxAge) {
        return newCookie(name, value, maxAge, null, null);
    }

    /**
     * Constructs a cookie with a specified name and value and sets a path for
     * the cookie to which the client should return the cookie.
     *
     * @param name
     *            a String specifying the name of the cookie
     *
     * @param value
     *            a String specifying the value of the cookie
     *
     * @param path
     *            a String specifying a path
     *
     * @return constructed cookie
     */
    public static Cookie newCookie(String name, String value, String path) {
        return newCookie(name, value, defAge, path, null);
    }

    /**
     * Constructs a cookie with a specified name and value and sets a path for
     * the cookie to which the client should return the cookie and sets the
     * domain within which this cookie should be presented.
     *
     * @param name
     *            a String specifying the name of the cookie
     *
     * @param value
     *            a String specifying the value of the cookie
     *
     * @param path
     *            a String specifying a path
     *
     * @param domain
     *            a String containing the domain name within which this cookie
     *            is visible; form is according to <code>RFC 2109</code>
     *
     * @return constructed cookie
     */
    public static Cookie newCookie(String name, String value, String path,
            String domain) {
        return newCookie(name, value, defAge, path, domain);
    }

    /**
     * Constructs a cookie with a specified name and value and sets the maximum
     * age of the cookie in seconds and sets a path for the cookie to which the
     * client should return the cookie and sets the domain within which this
     * cookie should be presented.
     *
     * @param name
     *            a String specifying the name of the cookie
     *
     * @param value
     *            a String specifying the value of the cookie
     *
     * @param maxAge
     *            an integer specifying the maximum age of the cookie in
     *            seconds; if negative, means the cookie is not stored; if zero,
     *            deletes the cookie
     *
     * @param path
     *            a String specifying a path
     *
     * @param domain
     *            a String containing the domain name within which this cookie
     *            is visible; form is according to RFC 2109
     *
     * @return constructed cookie
     */
    public static Cookie newCookie(String name, String value, int maxAge,
            String path, String domain) {
        Cookie cookie = null;

        // Based on property value it does url encoding.
        // BEA, IBM
        if (cookieEncoding) {
            cookie = new Cookie(name, URLEncDec.encode(value));
        } else {
            cookie = new Cookie(name, value);
        }

        cookie.setMaxAge(maxAge);

        if ((path != null) && (path.length() > 0)) {
            cookie.setPath(path);
        } else {
            cookie.setPath("/");
        }

        if ((domain != null) && (domain.length() > 0)) {
            cookie.setDomain(domain);
        }

        cookie.setSecure(isCookieSecure());

        return cookie;
    }

    /**
     * Check cookie value whether it has double quote or not. Remove start /
     * ending double quote from cookie and returns cookie value only.
     *
     * @param cookie
     *            a String value of cookie
     *
     * @return cookie value without double quote
     */
    public static String checkDoubleQuote(String cookie) {
        String double_quote = "\"";

        if ((cookie != null) && cookie.startsWith(double_quote)
                && cookie.endsWith(double_quote)) {
            int last = cookie.length() - 1;
            cookie = cookie.substring(1, last);
        }
        return cookie;
    }
}