Class BasicAuthFilter<T>`Abstract`

IAuthFilter implementation that supports the HTTP Basic authentication scheme.

Type Parameters

T extends Principal

Implements

IAuthFilter<BasicAuth, T>

Index

Constructors

Properties

authenticationSchemeName name

Methods

authenticate extractAuthData

Constructors

constructor

new BasicAuthFilter<T extends Principal>(): BasicAuthFilter<T>
Type Parameters
- T extends Principal
Returns BasicAuthFilter<T>

Properties

`Readonly`authenticationSchemeName

authenticationSchemeName: string = "Basic"

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

`Abstract` `Readonly`name

name: string

A human readable name for this authentication filter.

Methods

`Abstract`authenticate

authenticate(basicAuth: BasicAuth): Promise<T>
Parameters
- basicAuth: BasicAuth
Returns Promise<T>
Implementation of IAuthFilter.authenticate
- Defined in src/api/security/BasicAuthFilter.ts:39

extractAuthData

extractAuthData(request: Request): Promise<BasicAuth>
If the authentication scheme is 'Basic', returns a BasicAuth instance containing the username and password, otherwise returns undefined.
Parameters
- request: Request
  Request context to use.
Returns Promise<BasicAuth>
Implementation of IAuthFilter.extractAuthData
- Defined in src/api/security/BasicAuthFilter.ts:26