Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Algorithm

Algorithm: string = "MD5"

Only support MD5 for now.

Name

Name: string = "Digest"

Password

Password: string

QOP

QOP: string = "auth, auth-int"

Indicates the "quality of protection" options applied to the response by the server.

The value "auth" indicates authentication;

the value "auth-int" indicates authentication with integrity protection.

The server SHOULD use the same value for the qop parameter in the response as was sent by the client in the corresponding request.

Realm

Realm: string = "Kaven Basic Authentication"

A string to be displayed to users so they know which username and password to use.

This string should contain at least the name of the host performing the authentication and might additionally indicate the collection of users who might have access.

RequestHandler

RequestHandler: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>> = ...

UserName

UserName: string

Accessors

Nonce

  • get Nonce(): string
  • A server-specified string which should be uniquely generated each time a 401 response is made. It is advised that this string be Base64 or hexadecimal data. Specifically, since the string is passed in the header field lines as a quoted string, the double- quote character is not allowed, unless suitably escaped.

    Returns string

Opaque

  • get Opaque(): string
  • A string of data, specified by the server, that SHOULD be returned by the client unchanged in the Authorization header field of subsequent requests with URIs in the same protection space. It is RECOMMENDED that this string be Base64 or hexadecimal data.

    Returns string

Methods

Authenticate

  • Authenticate(res: Response<any, Record<string, any>>): void
  • Parameters

    • res: Response<any, Record<string, any>>

    Returns void

CheckCredentials

  • CheckCredentials(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): boolean
  • Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

    Returns boolean

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Class
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Inherited constructor
  • Inherited property
  • Enumeration

Generated using TypeDoc