Interface IAuthFilter<T, U>

Authentication filter that can extract authentication data from a HTTP request and preform authentication using that data.

Type Parameters

  • T

    Authentication data type

  • U extends Principal

    Principal data type, the type must extend Principal

Hierarchy

  • IAuthFilter

Implemented by

Properties

authenticationSchemeName name

Methods

authenticate extractAuthData

Properties

Readonly authenticationSchemeName

authenticationSchemeName: string

String to use in WWW-Authenticate header when returing a HTTP 401 response, see: https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml

Readonly name

name: string

A human readable name for this authentication filter.

Methods

authenticate

  • Attempt to authorise a user suing the authentication data supplied. An instance of the principal type U should be returned on authentication success, otherwise undefined should be returned.

    Parameters

    • authData: T

      An instance of the authentication data type T.

    Returns Promise<U>

    Instance of type U or undefined on authentication failure.

extractAuthData

  • Extract an instance of the authentication data type T from a HTTP request. If extraction is not possible due to missing request headers/data, undefined should be returned.

    Parameters

    • request: Request

      Request context to use.

    Returns Promise<T>

    Instance of type T or undefined on extraction failure.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc