@haxall/haxall
    Preparing search index...

    Class AuthServerContext

    AuthServerContext manages the server-side process for authenticating a user. It provides a set of abstract methods to plug into the application user database and session management.

    Hierarchy (View Summary)

    • Obj
      • AuthServerContext
    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Return if the given user's secret matches what is stored

      Parameters

      • secret: string

      Returns boolean

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Parameters

      • msg: string

      Returns void

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Returns boolean

    • Parameters

      • it: boolean

      Returns void

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Log to use for debugging and error reporting

      Returns Log

    • Login the current user successfully and return the authToken

      Returns string

    • Callback when a user fails a login attempt

      Parameters

      Returns void

    • Process authentication request. Return result of sessionByAuthToken if user is authenticated, otherwise send challenge message and return null

      Parameters

      Returns JsObj

    • Current web request

      Returns WebReq

    • Current web request

      Parameters

      Returns void

    • Current web response

      Returns WebRes

    • Current web response

      Parameters

      Returns void

    • Lookup user session by authToken or return null if invalid token

      Parameters

      • authToken: string

      Returns JsObj

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return a string representation of this object.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • User currently being being authenticated

      Returns AuthUser

    • User currently being being authenticated

      Parameters

      Returns void

    • Get an AuthUser for the user with the given username.

      If null is returned, then the Haystack authentication will immediately stop without sending any response to the client. It is the responsibility of the code invoking the AuthServerContext to send an appropriate response in this case. This condition signals that given user is using some alternative form of authentication.

      If the user doesn't exist, but you want a "fake" haystack authentication to occur, then return AuthUser.genFake.

      Parameters

      • username: string

      Returns AuthUser

    • Lookup user's password hash string for validation or return null if the user should not be allowed to log in.

      Returns string

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Returns AtomicInt

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Parameters

      • ...args: unknown[]

      Returns AuthServerContext