c

tsec.authentication

Authenticator

abstract class Authenticator[F[_], I, V, A] extends AnyRef

A base typeclass for generating authenticators, i.e cookies, tokens, JWTs etc.

I

The Identifier type

V

The value type, i.e user, or possibly only partial information

A

the type of authenticator

Source
Authenticator.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
BearerTokenAuthenticator, EncryptedCookieAuthenticator, JWTAuthenticator, SignedCookieAuthenticator, StatefulECAuthenticator, StatelessECAuthenticator
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Authenticator
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Authenticator()(implicit arg0: Sync[F])

Abstract Value Members

  1. abstract def afterBlock(response: Response[F], authenticator: A): OptionT[F, Response[F]]

    Handles the embedding of the authenticator (if necessary) in the response, and any other actions that should happen after a request related to authenticators

  2. abstract def create(body: I): F[A]

    Create an authenticator from an identifier.

  3. abstract def discard(authenticator: A): F[A]

    Delete an authenticator from a backing store, or invalidate it.

  4. abstract def embed(response: Response[F], authenticator: A): Response[F]

    Embed an authenticator directly into a response.

    Embed an authenticator directly into a response. Particularly useful for adding an authenticator into unauthenticated actions

  5. abstract def expiry: FiniteDuration
  6. abstract def extractRawOption(request: Request[F]): Option[String]

    Attempt to retrieve the raw representation of an A This is primarily useful when attempting to combine AuthenticatorService, to be able to evaluate an endpoint with more than one token type.

    Attempt to retrieve the raw representation of an A This is primarily useful when attempting to combine AuthenticatorService, to be able to evaluate an endpoint with more than one token type. or simply just to prod whether the request is malformed.

  7. abstract def maxIdle: Option[FiniteDuration]
  8. abstract def parseRaw(raw: String, request: Request[F]): OptionT[F, SecuredRequest[F, V, A]]

    Parse the raw representation from extractRawOption

  9. abstract def refresh(authenticator: A): F[A]

    Refresh an authenticator: Primarily used for sliding window expiration

  10. abstract def renew(authenticator: A): F[A]

    Renew an authenticator: Reset it's expiry and whatnot.

  11. abstract def update(authenticator: A): F[A]

    Update the altered authenticator

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def extractAndValidate(request: Request[F]): OptionT[F, SecuredRequest[F, V, A]]

    Return a secured request from a request, that carries our authenticator

  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped