play.filters.csrf

CSRFFilter

class CSRFFilter extends EssentialFilter

A filter that provides CSRF protection.

These must be by name parameters because the typical use case for instantiating the filter is in Global, which happens before the application is started. Since the default values for the parameters are loaded from config and hence depend on a started application, they must be by name.

Source
CSRFFilter.scala
Linear Supertypes
EssentialFilter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CSRFFilter
  2. EssentialFilter
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CSRFFilter()

    Default constructor, useful from Java

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

    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.

    tokenProvider

    A token provider to use.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

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

    Definition Classes
    CSRFFilterEssentialFilter
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

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

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

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  19. def toString(): String

    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from EssentialFilter

Inherited from AnyRef

Inherited from Any

Ungrouped