org.http4s.server.middleware.authentication

Authentication

trait Authentication extends (Service[Request, Response]) ⇒ Service[Request, Response]

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

Linear Supertypes
(Service[Request, Response]) ⇒ Service[Request, Response], AnyRef, Any
Known Subclasses
BasicAuthentication, DigestAuthentication
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Authentication
  2. Function1
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

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

    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: 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 addUserRealmAttributes(req: Request, user: String, realm: String): Request

    Attributes
    protected

  7. def andThen[A](g: (Service[Request, Response]) ⇒ A): (Service[Request, Response]) ⇒ A

    Definition Classes
    Function1
    Annotations
    @unspecialized()

  8. def apply(service: HttpService): HttpService

    Definition Classes
    Authentication → Function1

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. def compose[A](g: (A) ⇒ Service[Request, Response]): (A) ⇒ Service[Request, Response]

    Definition Classes
    Function1
    Annotations
    @unspecialized()

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  16. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  22. def toString(): String

    Definition Classes
    Function1 → AnyRef → Any

  23. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

Inherited from AnyRef

Inherited from Any

Ungrouped