Gjsify LogoGjsify Logo

Hierarchy

  • AuthHandler

Callable

  • AuthHandler(context: AuthContext, username: string): boolean
  • Functions implementing this callback shall return %TRUE when the credentials provided by the authentication request grant access to the resource described by context.

    The username is %NULL when no creditials were passed, and anonymous access is tried.

    See also #epc_publisher_set_auth_flags. When EPC_AUTH_DEFAULT is used, you should call #epc_auth_context_check_password to verify that the password passed in the request matches the known password for that user. In this case there is no way to retrieve the password from the #EpcAuthContext because the network protocol transfers just a hash code, not the actual password.

    However, when EPC_AUTH_PASSWORD_TEXT_NEEDED is used, you should call epc_auth_context_get_password() and then do your own authentication check. For instance, you might need to delegate the authentication to some other code or server, such as a database server.

    Parameters

    • context: AuthContext

      the #EpcAuthContext

    • username: string

      the username provided for authentication, or %NULL

    Returns boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method