SCM-Manager/scm-webapp/src/main/java/sonia/scm/security/XsrfCookies.java

/**
 * Copyright (c) 2014, Sebastian Sdorra
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of SCM-Manager; nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * http://bitbucket.org/sdorra/scm-manager
 *
 */
package sonia.scm.security;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Util methods to handle XsrfCookies.
 *
 * @author Sebastian Sdorra
 * @version 1.47
 */
public final class XsrfCookies
{

  private XsrfCookies()
  {
  }
  
  /**
   * Creates a new xsrf protection cookie and add it to the response.
   * 
   * @param request http servlet request
   * @param response http servlet response
   * @param token xsrf token
   */
  public static void create(HttpServletRequest request, HttpServletResponse response, String token){
    applyCookie(request, response, new Cookie(XsrfProtectionFilter.KEY, token));

  }
  
  /**
   * Removes the current xsrf protection cookie from response.
   * 
   * @param request http servlet request
   * @param response http servlet response
   */
  public static void remove(HttpServletRequest request, HttpServletResponse response)
  {
    Cookie[] cookies = request.getCookies();
    if ( cookies != null ){
      for ( Cookie c : cookies ){
        if ( XsrfProtectionFilter.KEY.equals(c.getName()) ){
          c.setMaxAge(0);
          c.setValue(null);
          applyCookie(request, response, c);
        }
      }
    }
  }
  
  private static void applyCookie(HttpServletRequest request, HttpServletResponse response, Cookie cookie){
    cookie.setPath(request.getContextPath());
    response.addCookie(cookie);
  }
  
}