CSRFFilter

A filter that provides CSRF protection.

tokenName: The key used to store the token in the Play session. Defaults to csrfToken.
cookieName: If defined, causes the filter to store the token in a Cookie with this name instead of the session.
secureCookie: If storing the token in a cookie, whether this Cookie should set the secure flag. Defaults to whether the session cookie is configured to be secure.
createIfNotFound: Whether a new CSRF token should be created if it's not found. Default creates one if it's a GET request that accepts HTML.

Source: CSRFFilter.scala

Linear Supertypes

Serializable, Serializable, Product, Equals, EssentialFilter, AnyRef, Any

Instance Constructors

new CSRFFilter()

Default constructor, useful from Java
new CSRFFilter(tokenName: String = CSRFConf.TokenName, cookieName: Option[String] = CSRFConf.CookieName, secureCookie: Boolean = CSRFConf.SecureCookie, createIfNotFound: (RequestHeader) ⇒ Boolean = ...)

tokenName
The key used to store the token in the Play session. Defaults to csrfToken.
cookieName
If defined, causes the filter to store the token in a Cookie with this name instead of the session.
secureCookie
If storing the token in a cookie, whether this Cookie should set the secure flag. Defaults to whether the session cookie is configured to be secure.
createIfNotFound
Whether a new CSRF token should be created if it's not found. Default creates one if it's a GET request that accepts HTML.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def apply(next: EssentialAction): EssentialAction

Definition Classes
CSRFFilter → EssentialFilter
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val cookieName: Option[String]

If defined, causes the filter to store the token in a Cookie with this name instead of the session.
val createIfNotFound: (RequestHeader) ⇒ Boolean

Whether a new CSRF token should be created if it's not found.
Whether a new CSRF token should be created if it's not found. Default creates one if it's a GET request that accepts HTML.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val secureCookie: Boolean

If storing the token in a cookie, whether this Cookie should set the secure flag.
If storing the token in a cookie, whether this Cookie should set the secure flag. Defaults to whether the session cookie is configured to be secure.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tokenName: String

The key used to store the token in the Play session.
The key used to store the token in the Play session. Defaults to csrfToken.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

case class CSRFFilter(tokenName: String = CSRFConf.TokenName, cookieName: Option[String] = CSRFConf.CookieName, secureCookie: Boolean = CSRFConf.SecureCookie, createIfNotFound: (RequestHeader) ⇒ Boolean = ...) extends EssentialFilter with Product with Serializable

Instance Constructors

new CSRFFilter()

new CSRFFilter(tokenName: String = CSRFConf.TokenName, cookieName: Option[String] = CSRFConf.CookieName, secureCookie: Boolean = CSRFConf.SecureCookie, createIfNotFound: (RequestHeader) ⇒ Boolean = ...)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def apply(next: EssentialAction): EssentialAction

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val cookieName: Option[String]

val createIfNotFound: (RequestHeader) ⇒ Boolean

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val secureCookie: Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

val tokenName: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from EssentialFilter

Inherited from AnyRef

Inherited from Any

Ungrouped