Packages

trait BasicAuth[User] extends Authentication[User]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BasicAuth
  2. Authentication
  3. SessionUserExtractor
  4. SessionInfoRemover
  5. SecurityDirectives
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AsyncAuthenticator[T] = (Credentials) ⇒ Future[Option[T]]
    Definition Classes
    SecurityDirectives
  2. type AsyncAuthenticatorPF[T] = PartialFunction[Credentials, Future[T]]
    Definition Classes
    SecurityDirectives
  3. type AuthenticationResult[+T] = Either[HttpChallenge, T]
    Definition Classes
    SecurityDirectives
  4. type Authenticator[T] = (Credentials) ⇒ Option[T]
    Definition Classes
    SecurityDirectives
  5. type AuthenticatorPF[T] = PartialFunction[Credentials, T]
    Definition Classes
    SecurityDirectives

Abstract Value Members

  1. abstract def authenticateUser(username: String, password: String): Future[Option[User]]
  2. abstract def decodeSession(session: String): Session[User]

    Decodes session.

    Decodes session. Is used in 

    authenticate

    directive which if successful provides user to inner route. authenticate }}} user to inner route.

    Definition Classes
    Authentication
  3. abstract def encodeSession(session: Session[User]): String

    Encodes session.

    Encodes session. Encoded session will be encrypted and set as cookie 

    SessionCookieName
    Definition Classes
    Authentication

Concrete 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. lazy val AppDefaultChallenge: HttpChallenge
    Definition Classes
    Authentication
  5. lazy val BasicChallenge: HttpChallenge
  6. lazy val CustomChallenge: HttpChallenge
  7. lazy val HttpChallengeRealm: String
    Definition Classes
    Authentication
  8. val IP: String
    Attributes
    protected
    Definition Classes
    Authentication
  9. val RequestedUriCookieName: String
    Definition Classes
    Authentication
  10. val SessionCookieName: String
    Definition Classes
    Authentication
  11. val SignInPath: String
    Definition Classes
    Authentication
  12. val SignedInDefaultPath: String
    Definition Classes
    Authentication
  13. val SignedOutPath: String
    Definition Classes
    Authentication
  14. val UserAgent: String
    Attributes
    protected
    Definition Classes
    Authentication
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def authFailureRoute: Route

    Default implementation redirects to 'sign-in' uri

    Default implementation redirects to 'sign-in' uri

    Definition Classes
    Authentication
  17. def authRejectionHandler: RejectionHandler
    Definition Classes
    Authentication
  18. def authenticate: AuthenticationDirective[User]

    Authenticates user and provides authenticated user, updates session cookie.

    Authenticates user and provides authenticated user, updates session cookie. On failure executes 

    authFailureRoute
    Definition Classes
    Authentication
  19. def authenticateBasic[T](realm: String, authenticator: (BasicAuth.this)#Authenticator[T]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  20. def authenticateBasicAsync[T](realm: String, authenticator: (BasicAuth.this)#AsyncAuthenticator[T]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  21. def authenticateBasicPF[T](realm: String, authenticator: (BasicAuth.this)#AuthenticatorPF[T]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  22. def authenticateBasicPFAsync[T](realm: String, authenticator: (BasicAuth.this)#AsyncAuthenticatorPF[T]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  23. def authenticateOAuth2[T](realm: String, authenticator: (BasicAuth.this)#Authenticator[T]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  24. def authenticateOAuth2Async[T](realm: String, authenticator: (BasicAuth.this)#AsyncAuthenticator[T]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  25. def authenticateOAuth2PF[T](realm: String, authenticator: (BasicAuth.this)#AuthenticatorPF[T]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  26. def authenticateOAuth2PFAsync[T](realm: String, authenticator: (BasicAuth.this)#AsyncAuthenticatorPF[T]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  27. def authenticateOrRejectWithChallenge[C <: HttpCredentials, T](authenticator: (Option[C]) ⇒ Future[(BasicAuth.this)#AuthenticationResult[T]])(implicit arg0: ClassTag[C]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  28. def authenticateOrRejectWithChallenge[T](authenticator: (Option[HttpCredentials]) ⇒ Future[(BasicAuth.this)#AuthenticationResult[T]]): AuthenticationDirective[T]
    Definition Classes
    SecurityDirectives
  29. def authenticateUser: AuthenticationDirective[Option[User]]

    Authenticates user from session cookie

    Authenticates user from session cookie

    Definition Classes
    Authentication
  30. def authorize(check: (RequestContext) ⇒ Boolean): Directive0
    Definition Classes
    SecurityDirectives
  31. def authorize(check: ⇒ Boolean): Directive0
    Definition Classes
    SecurityDirectives
  32. def authorizeAsync(check: (RequestContext) ⇒ Future[Boolean]): Directive0
    Definition Classes
    SecurityDirectives
  33. def authorizeAsync(check: ⇒ Future[Boolean]): Directive0
    Definition Classes
    SecurityDirectives
  34. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  35. def decryptSession(session: String): String
    Definition Classes
    Authentication
  36. def encryptSession(session: String): String

    For session debugging, override to disable encryption but ensure session is cookie-compatible:

    For session debugging, override to disable encryption but ensure session is cookie-compatible:

    session.replace(",", "~").replace("\"", "'")

    In that case, 'decryption' would be:

    session.replace("~", ",").replace("'", "\"")
    Definition Classes
    Authentication
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  39. def extractCredentials: Directive1[Option[HttpCredentials]]
    Definition Classes
    SecurityDirectives
  40. def extractSession: Directive1[Option[Session[User]]]

    Extract session from session id cookie.

    Extract session from session id cookie. If cookie does not exist throws rejection

    Definition Classes
    Authentication
  41. def extractSessionToken(user: User): Directive[(String, Long)]
    Definition Classes
    Authentication
  42. def extractUserAgent: Directive[(Option[String])]
    Definition Classes
    Authentication
  43. def extractUserFromSession: Directive1[Option[User]]

    Extracts user from session, returns some user if session cookie is found and can be decoded, however, session is not validated

    Extracts user from session, returns some user if session cookie is found and can be decoded, however, session is not validated

    Definition Classes
    Authentication → SessionUserExtractor
  44. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  45. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  46. val httpOnlyCookies: Boolean
    Definition Classes
    Authentication
  47. val isAjaxRequest: Directive[Unit]
    Definition Classes
    Authentication
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  51. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  52. def remoteAddressToString(a: RemoteAddress): String
    Definition Classes
    Authentication
  53. def removeSessionCookie: Directive0

    Deletes session-id cookie if exists

    Deletes session-id cookie if exists

    Attributes
    protected
    Definition Classes
    Authentication
  54. def removeSessionInfoFromRequest(req: HttpRequest): Self

    Removes session info from request, used by org.wabase.DeferredControl to calculate stable request hash

    Removes session info from request, used by org.wabase.DeferredControl to calculate stable request hash

    Definition Classes
    Authentication → SessionInfoRemover
  55. def reqestedUriCookieTransformer(cookie: HttpCookie): HttpCookie

    On failed authentication sets requested-uri cookie if request has not been Ajax

    On failed authentication sets requested-uri cookie if request has not been Ajax

    Attributes
    protected
    Definition Classes
    Authentication
  56. val secureCookies: Boolean
    Definition Classes
    Authentication
  57. def sessionCookieTransformer(cookie: HttpCookie): HttpCookie
    Attributes
    protected
    Definition Classes
    Authentication
  58. val sessionTimeOut: Long
    Definition Classes
    Authentication
  59. def setRequestedUriCookie: Directive[Unit]
    Attributes
    protected
    Definition Classes
    Authentication
  60. def setSessionCookie(user: User): Directive0
    Definition Classes
    Authentication
  61. def signIn: Route
    Definition Classes
    Authentication
  62. def signInFailedRoute(rejections: Seq[Rejection]): Route

    Default implementation returns http Unauthorized with optional challenge

    Default implementation returns http Unauthorized with optional challenge

    Definition Classes
    Authentication
  63. def signInSuccessRoute(user: User): (RequestContext) ⇒ Future[RouteResult]

    Default implementation redirects to uri value stored in cookie

    Default implementation redirects to uri value stored in cookie 

    RequestedUriCookieName

    or if cookie is missing redirects to /

    Definition Classes
    Authentication
  64. def signInUser: AuthenticationDirective[User]

    Signs in (logs in) user from http request.

    Signs in (logs in) user from http request. Can be implemented as Basic authentication, OAuth ...

    Definition Classes
    BasicAuth → Authentication
  65. def signOut: Route
    Definition Classes
    Authentication
  66. def signOutRoute: Route

    Default implementation redirects to /

    Default implementation redirects to /

    Definition Classes
    Authentication
  67. def signOutUser(user: User): Future[Done]

    Signs out (logs out) user.

    Signs out (logs out) user. Can do all necessary cleanup. Session cookie 

    SessionCookieName

    is deleted by 

    signOut

    directive. Default implementation does nothing. signOut }}}

    Definition Classes
    Authentication
  68. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  69. def toString(): String
    Definition Classes
    AnyRef → Any
  70. def uniqueSessionId: String
    Definition Classes
    Authentication
  71. def userInfo(implicit user: User): String

    String representation of user

    String representation of user

    Definition Classes
    Authentication
  72. def validateSession(session: Session[User], ip: RemoteAddress, userAgent: Option[String]): Boolean

    Checks whether expiration time greater than current time and session ip and user agent matches with those of request

    Checks whether expiration time greater than current time and session ip and user agent matches with those of request

    Definition Classes
    Authentication
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  75. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Authentication[User]

Inherited from SessionUserExtractor[User]

Inherited from SessionInfoRemover

Inherited from SecurityDirectives

Inherited from AnyRef

Inherited from Any

Ungrouped