Class ElectronTokenValidator

On Electron, we want to make sure that only Electron's browser-windows access the backend services.

Hierarchy

ElectronTokenValidator

Implements

WsRequestValidatorContribution

Index

Constructors

constructor

Properties

electronSecurityToken

Methods

Constructors

constructor

new ElectronTokenValidator(): ElectronTokenValidator

Returns ElectronTokenValidator

Properties

Protected electronSecurityToken

electronSecurityToken: ElectronSecurityToken

Methods

allowRequest

allowRequest(request: IncomingMessage): boolean

- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:45
Expects the token to be passed via cookies by default.

Parameters
- request: IncomingMessage
Returns boolean

allowWsUpgrade

allowWsUpgrade(request: IncomingMessage): MaybePromise<boolean>

Implementation of WsRequestValidatorContribution.allowWsUpgrade
- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:38
Parameters
- request: IncomingMessage
Returns MaybePromise<boolean>

Protected getToken

getToken(): ElectronSecurityToken

- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:79
Returns the token to compare to when authorizing requests.

Returns ElectronSecurityToken

Protected init

init(): void

- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:34
Returns void

isTokenValid

isTokenValid(token: unknown): boolean

- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:63
Validates a token.

This method both checks the shape of the parsed token data and its actual value.

Parameters
- token: unknown
  
  Parsed object sent by the client as the token.
Returns boolean