Object - http : BasicAuthHandler

Defines the Basic Auth header handler for inbound and outbound HTTP traffic.

Constructor

__init

(InboundAuthProvider | OutboundAuthProvider authProvider)

Methods

Fields

canHandle

(Request req)

returns boolean

Checks if the provided request can be authenticated with the Basic Auth header.

Parameters

  • Return Type

    (boolean)
  • Returns true if authentication is successful. Else, returns false.

process

(Request req)

returns boolean | error

Authenticates the incoming request with the use of the credentials passed as the Basic Auth header.

Parameters

  • Return Type

    (boolean | error)
  • Returns true if it is possible to authenticate with Basic Auth. Else, returns false or the error in case of an error.

prepare

(Request req)

returns Request | error

Prepares the request with the Basic Auth header.

Parameters

  • Return Type

    (Request | error)
  • Returns the updated Request instance or theerror in case of an error.

inspect

(Request req, Response resp)

returns Request | error | ()

Inspects the request and response and calls the Auth provider for inspection.

req - The Request instance. resp - The Response instance.

Parameters

  • Return Type

    (Request | error | ())
  • Returns the updated Request instance, the error in case of an error, or () if nothing is to be done.