Class TokenOwnershipValidator

Validates ownership of a WebId by seeing if a specific triple can be added. expiration parameter is how long the token should be valid in minutes.

Hierarchy

OwnershipValidator
- TokenOwnershipValidator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TokenOwnershipValidator(storage: ExpiringStorage<string, string>, expiration?: number): TokenOwnershipValidator

Overrides OwnershipValidator.constructor
- Defined in src/identity/ownership/TokenOwnershipValidator.ts:22
Parameters
- storage: ExpiringStorage<string, string>
- expiration: number = 30
Returns TokenOwnershipValidator

Properties

Private Readonly expiration

expiration: number

Protected Readonly logger

logger: Logger = ...

Private Readonly storage

storage: ExpiringStorage<string, string>

Methods

canHandle

canHandle(input: { webId: string }): Promise<void>

Inherited from OwnershipValidator.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- input: { webId: string }
  
  Input that could potentially be handled.
  - webId: string
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.

Private generateToken

generateToken(): string

- Defined in src/identity/ownership/TokenOwnershipValidator.ts:58
Generates a random verification token;

Returns string

Private getTokenKey

getTokenKey(webId: string): string

- Defined in src/identity/ownership/TokenOwnershipValidator.ts:51
Creates a key to use with the token storage.

Parameters
- webId: string
Returns string

handle

handle(__namedParameters: { webId: string }): Promise<void>

Overrides OwnershipValidator.handle
- Defined in src/identity/ownership/TokenOwnershipValidator.ts:29
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Parameters
- __namedParameters: { webId: string }
  - webId: string
Returns Promise<void>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: { webId: string }): Promise<void>

Inherited from OwnershipValidator.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: { webId: string }
  
  Input data that will be handled if it can be handled.
  - webId: string
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.

Private hasToken

hasToken(webId: string, token: string): Promise<boolean>

- Defined in src/identity/ownership/TokenOwnershipValidator.ts:65
Fetches data from the WebID to determine if the token is present.

Parameters
- webId: string
- token: string
Returns Promise<boolean>

Private throwError

throwError(webId: string, token: string): never

- Defined in src/identity/ownership/TokenOwnershipValidator.ts:81
Throws an error containing the description of which triple is needed for verification.

Parameters
- webId: string
- token: string
Returns never