Trait

org.http4s.server.middleware.authentication

Authentication

Related Doc: package authentication

Permalink

trait Authentication extends HttpMiddleware

Authentication instances are middleware that provide a HttpService with HTTP authentication.

Linear Supertypes
(Service[Request, Response]) ⇒ Service[Request, Response], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Authentication
  2. Function1
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def getChallenge(req: Request): Task[\/[Challenge, Request]]

    Permalink

    Check if req contains valid credentials.

    Check if req contains valid credentials. You may assume that the returned Task is executed at most once (to allow for side-effects, e.g. the incrementation of a nonce counter in DigestAuthentication).

    req

    The request received from the client.

    returns

    If req contains valid credentials, a copy of req is returned that contains additional attributes pertaining to authentication such as the username and realm from the valid credentials. If req does not contain valid credentials, a challenge is returned. This challenge will be included in the HTTP 401 Unauthorized response that is returned to the client.

    Attributes
    protected

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addUserRealmAttributes(req: Request, user: String, realm: String): Request

    Permalink
    Attributes
    protected
  5. def andThen[A](g: (Service[Request, Response]) ⇒ A): (Service[Request, Response]) ⇒ A

    Permalink
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  6. def apply(service: HttpService): HttpService

    Permalink
    Definition Classes
    Authentication → Function1
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def compose[A](g: (A) ⇒ Service[Request, Response]): (A) ⇒ Service[Request, Response]

    Permalink
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  10. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

    Permalink
    Definition Classes
    Function1 → AnyRef → Any
  21. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from (Service[Request, Response]) ⇒ Service[Request, Response]

Inherited from AnyRef

Inherited from Any

Ungrouped