a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * opensso/legal/CDDLv1.0.txt
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * at opensso/legal/CDDLv1.0.txt.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: Utils.java,v 1.4 2008/11/10 22:57:00 veiming Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
34fca4d58470ae2714c1961ec4e0b8bacac9ca18Mark de Reeper * Portions Copyrighted 2013-2015 ForgeRock AS.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.sae.api;
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeperimport org.owasp.esapi.ESAPI;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport javax.servlet.http.HttpServletResponse;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport javax.servlet.http.HttpServletRequest;
0fdab8904a8fe223f6934b878769fe45e7651c60Andrew Forrestimport java.io.PrintWriter;
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeperimport java.net.URLEncoder;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Map;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Iterator;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Enumeration;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Util class to implement simple Http request/response transactions.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class Utils
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster{
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Http POST
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public static final String POST = "POST";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Http GET
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public static final String GET = "GET";
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Redirects to <code>redirectUrl</code> as a GET or a POST
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * based on <code>action</code> parameter provided.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * in case of POST all params need to be specified in <code>pmap</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * parameter.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param hres HttpSevletResponse to be used for the redirect
0fdab8904a8fe223f6934b878769fe45e7651c60Andrew Forrest * @param out the print writer for writing out presentation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param redirectUrl URL to redirect to.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param pmap http parameters to be sent as part of the redirect
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param action http action to be executed : GET or POST
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
0fdab8904a8fe223f6934b878769fe45e7651c60Andrew Forrest public static void redirect(HttpServletResponse hres, PrintWriter out, String redirectUrl,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Map pmap, String action)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster throws Exception
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (action.equals("GET")) {
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper StringBuilder buf = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (pmap != null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster // Put it all together in query part of Url
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String query = queryStringFromMap(pmap);
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper buf = new StringBuilder();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster buf.append(redirectUrl);
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper if (!redirectUrl.contains("?")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster buf.append("?");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster buf.append(query);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String finalRedirectUrl = redirectUrl;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (buf != null)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster finalRedirectUrl = buf.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster hres.sendRedirect(finalRedirectUrl);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String html = formFromMap(redirectUrl, pmap, true);
0fdab8904a8fe223f6934b878769fe45e7651c60Andrew Forrest out.write(html);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Generates a query string from the parameters in the request.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param request http request to pick params from.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return query string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public static String queryStringFromRequest(HttpServletRequest request)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Enumeration en = request.getParameterNames();
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper StringBuilder buf = new StringBuilder();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster boolean priorparam = false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster while (en.hasMoreElements()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String name = (String) en.nextElement();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String val = request.getParameter(name);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (priorparam)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster buf.append("&");
34fca4d58470ae2714c1961ec4e0b8bacac9ca18Mark de Reeper buf.append(name).append("=").append(val);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster priorparam = true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return buf.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Generates a query string from the a <code>Map</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param pmap params to be added to the query string.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return query string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public static String queryStringFromMap(Map pmap)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster Iterator iter = pmap.keySet().iterator();
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper StringBuilder buf = new StringBuilder();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster boolean priorparam = false;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster while (iter.hasNext()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String name = (String) iter.next();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String val = (String) pmap.get(name);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (priorparam)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster buf.append("&");
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper buf.append(name).append("=").append(URLEncoder.encode(val));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster priorparam = true;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return buf.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Generates a html hidden form to acccomplish a auto POST from the browser
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Form is assigned an id=saeform
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param redirectUrl URL to post teh form to.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param pmap parameters to be sent in the POST
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param addAutoSubmit adds html and javascript to autosubmit form
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return html code
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public static String formFromMap(String redirectUrl, Map pmap,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster boolean addAutoSubmit)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster {
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper StringBuilder buf = new StringBuilder();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (addAutoSubmit) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster buf.append("<HTML><HEAD><TITLE>SAE POST</TITLE></HEAD>");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster buf.append("<BODY Onload=\"document.forms[0].submit()\">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper buf.append("<FORM id=\"saeform\" METHOD=\"POST\" ACTION=\"").append(redirectUrl).append("\">");
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper for (Object name : pmap.keySet()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster String val = (String) pmap.get(name);
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper buf.append("<INPUT TYPE=\"HIDDEN\" NAME=\"").append(name).append("\" VALUE=\"");
3bb11fd7fc91ad0fdc12b196bcbdd79f483fced7Mark de Reeper buf.append(ESAPI.encoder().encodeForHTML(val)).append("\">");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster buf.append("</FORM>");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster if (addAutoSubmit) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster buf.append("</BODY></HTML>");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return buf.toString();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}