object CSRF

Source
CSRF.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CSRF
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type CSRFCheckFailed = CSRFCheckFailed.type
  2. abstract type CSRFToken

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val CSRFTokenLength: Int
  5. val SHA1ByteLen: Int
  6. val SigningAlgo: String
  7. def apply[F[_], G[_]](headerName: CaseInsensitiveString = ..., cookieName: String = "csrf-token", clock: Clock = Clock.systemUTC(), secure: Boolean = false, onFailure: Response[G] = Response[G](Status.Forbidden), createIfNotFound: Boolean = true, key: SecretKey, headerCheck: (Request[G]) ⇒ Boolean)(implicit arg0: Sync[F], arg1: Applicative[G]): CSRF[F, G]

    Default method for constructing CSRF middleware *

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def buildSigningKey[F[_]](array: Array[Byte])(implicit F: Sync[F]): F[SecretKey]

    Build a new HMACSHA1 Key for our CSRF Middleware from key bytes.

    Build a new HMACSHA1 Key for our CSRF Middleware from key bytes. This operation is unsafe, in that any amount less than 20 bytes will throw an exception when loaded into Mac, and any value above will be truncated (not good for entropy).

    Use for loading a key from a config file, after having generated one safely

  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  11. def default[F[_], G[_]](headerName: CaseInsensitiveString = ..., cookieName: String = "csrf-token", clock: Clock = Clock.systemUTC(), secure: Boolean = false, onFailure: Response[G] = Response[G](Status.Forbidden), createIfNotFound: Boolean = true, key: SecretKey, host: String, sc: Scheme, port: Option[Int])(implicit arg0: Sync[F], arg1: Applicative[G]): CSRF[F, G]

    Default method for constructing CSRF middleware *

  12. def defaultOriginCheck[F[_]](r: Request[F], host: String, sc: Scheme, port: Option[Int]): Boolean

    Check origin matches our proposed origin.

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def generateSigningKey[F[_]]()(implicit F: Sync[F]): F[SecretKey]

    Generate a signing Key for the CSRF token *

  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def isEqual(s1: String, s2: String): Boolean

    A Constant-time string equality *

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def proxyOriginCheck[F[_]](r: Request[F], host: Host, xff: X-Forwarded-For): Boolean
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def tokensEqual(s1: CSRFToken, s2: CSRFToken): Boolean

    A Constant-time string equality *

  28. def unlift(s: CSRFToken): String
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  32. def withGeneratedKey[F[_], G[_]](headerName: CaseInsensitiveString = ..., cookieName: String = "csrf-token", clock: Clock = Clock.systemUTC(), secure: Boolean = false, onFailure: Response[G] = Response[G](Status.Forbidden), createIfNotFound: Boolean = true, headerCheck: (Request[G]) ⇒ Boolean)(implicit arg0: Sync[F], arg1: Applicative[G]): F[CSRF[F, G]]

    Sugar for instantiating a middleware by generating a key *

  33. def withKeyBytes[F[_], G[_]](keyBytes: Array[Byte], headerName: CaseInsensitiveString = ..., cookieName: String = "csrf-token", clock: Clock = Clock.systemUTC(), onFailure: Response[G] = Response[G](Status.Forbidden), secure: Boolean = false, createIfNotFound: Boolean = true, headerCheck: (Request[G]) ⇒ Boolean)(implicit arg0: Sync[F], arg1: Applicative[G]): F[CSRF[F, G]]

    Sugar for pre-loading a key *

  34. object CSRFCheckFailed extends Exception with NoStackTrace with Product with Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped