Class ElectronTokenValidator

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

Hierarchy (View Summary)

ElectronTokenValidator
- MetricsElectronTokenValidator

Implements

WsRequestValidatorContribution

Index

Constructors

Properties

electronSecurityToken? logger

Methods

allowRequest allowWsUpgrade getToken init isTokenValid

Constructors

constructor

new ElectronTokenValidator(): ElectronTokenValidator
Returns ElectronTokenValidator

Properties

`Protected` `Optional`electronSecurityToken

electronSecurityToken?: ElectronSecurityToken

`Protected` `Readonly`logger

logger: ILogger

Methods

allowRequest

allowRequest(request: IncomingMessage): boolean
Expects the token to be passed via cookies by default.
Parameters
- request: IncomingMessage
Returns boolean
- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:49

allowWsUpgrade

allowWsUpgrade(request: IncomingMessage): MaybePromise<boolean>
Return false to prevent the protocol upgrade from going through, blocking the WebSocket connection.
Parameters
- request: IncomingMessage
  The HTTP connection upgrade request received by the server.
Returns MaybePromise<boolean>
Implementation of WsRequestValidatorContribution.allowWsUpgrade
- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:42

`Protected`getToken

getToken(): undefined | ElectronSecurityToken
Returns the token to compare to when authorizing requests.

Returns undefined | ElectronSecurityToken
- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:86

`Protected`init

init(): void
Returns void
- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:38

isTokenValid

isTokenValid(token: unknown): boolean
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
- Defined in packages/core/src/electron-node/token/electron-token-validator.ts:70