Class DefaultRequestSigner

The default implementation of RequestSigner.

Hierarchy

DefaultRequestSigner

Implements

RequestSigner

Constructors

constructor

Properties

Methods

signHttpRequest

Constructors

constructor

new DefaultRequestSigner(authenticationDetailsProvider: AuthenticationDetailsProvider): DefaultRequestSigner

- Defined in lib/common/lib/signer.ts:62
Construct an instance of DefaultRequestSigner.

Parameters
- authenticationDetailsProvider: AuthenticationDetailsProvider
  
  the authentication details provider.
Returns DefaultRequestSigner

Properties

Private authenticationDetailsProvider

authenticationDetailsProvider: AuthenticationDetailsProvider

the authentication details provider.

Private delegationToken

delegationToken: string = ""

Private privateKey

privateKey: string = ""

Private privateKeyBuffer

privateKeyBuffer: Buffer

Static Private Readonly headersToSign

headersToSign: string[] = ["x-date", "(request-target)", "host"]

Static Private Readonly methodsThatRequireExtraHeaders

methodsThatRequireExtraHeaders: string[] = ["POST", "PUT", "PATCH"]

Methods

signHttpRequest

signHttpRequest(request: HttpRequest, forceExcludeBody?: boolean): Promise<void>

- Defined in lib/common/lib/signer.ts:100
Sign the http request.

Parameters
- request: HttpRequest
  
  http request.
- Default value forceExcludeBody: boolean = false
  
  exclude body or not.
Returns Promise<void>