Play Framework/Scala example source code file (CSRF.scala)

This example Play Framework source code file (CSRF.scala) is included in my "Source Code Warehouse" project. The intent of this project is to help you more easily find Play Framework (and Scala) source code examples by using tags.

All credit for the original source code belongs to Play Framework; I'm just trying to make examples easier to find. (For my Scala work, see my Scala examples and tutorials.)

Play Framework tags/keywords

api, call, csrf, helper, html, mvc, play, play framework, view, views

The CSRF.scala Play Framework example source code

/*
 * Copyright (C) 2009-2013 Typesafe Inc. <http://www.typesafe.com>
 */
package views.html.helper

import play.api.mvc._
import play.twirl.api.{ Html, HtmlFormat }

/**
 * CSRF helper for Play calls
 */
object CSRF {

  /**
   * Add the CSRF token as a query String parameter to this reverse router request
   */
  def apply(call: Call)(implicit token: play.filters.csrf.CSRF.Token): Call = {
    new Call(
      call.method,
      call.url + {
        if (call.url.contains("?")) "&" else "?"
      } + play.filters.csrf.CSRF.TokenName + "=" + token.value
    )
  }

  /**
   * Render a CSRF form field token
   */
  def formField(implicit token: play.filters.csrf.CSRF.Token): Html = {
    // probably not possible for an attacker to XSS with a CSRF token, but just to be on the safe side...
    Html(s"""<input type="hidden" name="${play.filters.csrf.CSRF.TokenName}" value="${HtmlFormat.escape(token.value)}"/>""")
  }

}