Packages

trait AuthActions extends AnyRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AuthActions
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait AbstractApiAuthAction extends ActionBuilder[UserRequest, AnyContent]

    Abstraction for API auth actions allowing to mix in custom results for each of the different error scenarios.

  2. trait PlainErrorResponses extends AnyRef

Abstract Value Members

  1. abstract def authCallbackUrl: String

    The auth callback url.

    The auth callback url. This is where the OAuth provider will send the user after authentication. This action on should invoke processOAuthCallback

  2. abstract def controllerComponents: ControllerComponents
  3. abstract def panDomainSettings: PanDomainAuthSettingsRefresher
  4. abstract def validateUser(authedUser: AuthenticatedUser): Boolean

    Returns true if the authed user is valid in the implementing system (meets your multifactor requirements, you recognise the email etc.).

    Returns true if the authed user is valid in the implementing system (meets your multifactor requirements, you recognise the email etc.).

    If your implementing application needs to audit logins / register new users etc then this ia also the place to do it (although in this case you should strongly consider setting cacheValidation to true).

    returns

    true if the user is valid in your app

  5. abstract def wsClient: WSClient

    Play application components that you must provide in order to use AuthActions

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. val ANTI_FORGERY_KEY: String
  5. val LOGIN_ORIGIN_KEY: String

    A Play session key that stores the target URL that was being accessed when redirected for authentication

  6. val OAuth: OAuth
  7. def apiGracePeriod: Long

    Adding an expiry extension to APIAuthActions allows for a delay between an applications authentication and their respective API XHR calls expiring.

    Adding an expiry extension to APIAuthActions allows for a delay between an applications authentication and their respective API XHR calls expiring.

    By default this is 0 and thus disabled.

    This is particularly useful for SPAs where users have third party cookies disabled.

    returns

    the amount of delay between App and API expiry in milliseconds

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def cacheValidation: Boolean

    By default the validity of the user is checked every request.

    By default the validity of the user is checked every request. If your validateUser implementation is expensive or has side effects you can override this to true and validity will only be checked the first time the user visits your app after their login is established.

    Note the the cache is invalidated after the user's session is re-established with the OAuth provider.

    returns

    true if you want to only check the validity of the user once for the lifetime of the user's auth session

  10. def checkMultifactor(authedUser: AuthenticatedUser): Boolean
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def extractAuth(request: RequestHeader): AuthenticationStatus

    Extract the authentication status from the request.

  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def flushCookie(result: Result): Result
  17. def generateCookie(authedUser: AuthenticatedUser): Cookie
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. val groupChecker: Option[GoogleGroupChecker]
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def includeSystemInCookie(authedUser: AuthenticatedUser)(result: Result): Result
  22. def invalidUserMessage(claimedAuth: AuthenticatedUser): String

    Generates the message shown to the user when user validation fails.

    Generates the message shown to the user when user validation fails. override this to add a custom error message

  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val multifactorChecker: Option[Google2FAGroupChecker]
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def processLogout(implicit request: RequestHeader): Result
  29. def processOAuthCallback()(implicit request: RequestHeader): Future[Result]
  30. def readAuthenticatedUser(request: RequestHeader): Option[AuthenticatedUser]
  31. def readCookie(request: RequestHeader): Option[Cookie]
  32. def sendForAuth[A](implicit request: RequestHeader, email: Option[String] = None): Future[Result]

    starts the authentication process for a user.

    starts the authentication process for a user. By default this just sends the user off to the OAuth provider for auth but if you want to show welcome page with a button on it then override.

  33. def showUnauthedMessage(message: String)(implicit request: RequestHeader): Result

    invoked when the user is not logged in a can't be authed - this may be when the user is not valid in yur system or when they have exoplicitly logged out.

    invoked when the user is not logged in a can't be authed - this may be when the user is not valid in yur system or when they have exoplicitly logged out.

    Override this to add a logged out screen and display maeesages for your app. The default implementation is to ust return a 403 response

  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  39. object APIAuthAction extends AbstractApiAuthAction with PlainErrorResponses

    Action that ensures the user is logged in and validated.

    Action that ensures the user is logged in and validated.

    This action is for API / XHR type requests where the user can't be sent to the auth provider for auth. In the cases where the auth is not valid response codes are sent to the requesting app and the javascript that initiated the request should handle these appropriately

    If the user is not authed then a 401 response is sent, if the auth has expired then a 419 response is sent, if the user is authed but not allowed to perform the action a 403 is sent

    If the user is authed or has an expiry extension, a 200 is sent

  40. object AuthAction extends ActionBuilder[UserRequest, AnyContent]

    Action that ensures the user is logged in and validated.

    Action that ensures the user is logged in and validated.

    This action is for page load type requests where it is possible to send the user for auth and for them to interact with the auth provider. For API / XHR type requests use the APIAuthAction

    if the user is not authed or the auth has expired they are sent for authentication

Inherited from AnyRef

Inherited from Any

Ungrouped