Class DPoPWebIdExtractor

Credentials extractor that extracts a WebID from a DPoP-bound access token.

Hierarchy

CredentialsExtractor
- DPoPWebIdExtractor

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DPoPWebIdExtractor(originalUrlExtractor: TargetExtractor): DPoPWebIdExtractor

Overrides CredentialsExtractor.constructor
- Defined in src/authentication/DPoPWebIdExtractor.ts:24
Parameters
- originalUrlExtractor: TargetExtractor
  
  Reconstructs the original URL as requested by the client
Returns DPoPWebIdExtractor

Properties

Protected Readonly logger

logger: Logger = ...

Private Readonly originalUrlExtractor

originalUrlExtractor: TargetExtractor

Private Readonly verify

verify: SolidTokenVerifierFunction = ...

Methods

canHandle

canHandle(__namedParameters: HttpRequest): Promise<void>

Overrides CredentialsExtractor.canHandle
- Defined in src/authentication/DPoPWebIdExtractor.ts:29
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- __namedParameters: HttpRequest
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.

handle

handle(request: HttpRequest): Promise<Partial<Record<CredentialGroup, Credential>>>

Overrides CredentialsExtractor.handle
- Defined in src/authentication/DPoPWebIdExtractor.ts:36
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- request: HttpRequest
Returns Promise<Partial<Record<CredentialGroup, Credential>>>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: HttpRequest): Promise<Partial<Record<CredentialGroup, Credential>>>

Inherited from CredentialsExtractor.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.

Parameters
- input: HttpRequest
  
  Input data that will be handled if it can be handled.
Returns Promise<Partial<Record<CredentialGroup, Credential>>>
A promise resolving if the input can be handled, rejecting with an Error if not.