X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcharging-station%2Fui-server%2FAbstractUIServer.ts;h=cd6167389cf159d44c3b6118e20d3446473d01d3;hb=ba9a56a613727d96757690a8b52af6731f3fd8a8;hp=e0b1207106e34ab1755a68cf9d3974d27a8d3088;hpb=02a6943a30a9a6c93e5dcbdb79aa8d9746ae368e;p=e-mobility-charging-stations-simulator.git diff --git a/src/charging-station/ui-server/AbstractUIServer.ts b/src/charging-station/ui-server/AbstractUIServer.ts index e0b12071..cd616738 100644 --- a/src/charging-station/ui-server/AbstractUIServer.ts +++ b/src/charging-station/ui-server/AbstractUIServer.ts @@ -1,24 +1,128 @@ -import { Server as HttpServer } from 'http'; +import { type IncomingMessage, Server, type ServerResponse } from 'node:http' +import { type Http2Server, createServer } from 'node:http2' -import WebSocket from 'ws'; +import type { WebSocket } from 'ws' -import { ChargingStationData } from '../../types/ChargingStationWorker'; -import { ProtocolVersion } from '../../types/UIProtocol'; -import AbstractUIService from './ui-services/AbstractUIService'; +import type { AbstractUIService } from './ui-services/AbstractUIService.js' +import { UIServiceFactory } from './ui-services/UIServiceFactory.js' +import { BaseError } from '../../exception/index.js' +import { + ApplicationProtocolVersion, + AuthenticationType, + type ChargingStationData, + type ProcedureName, + type ProtocolRequest, + type ProtocolResponse, + ProtocolVersion, + type RequestPayload, + type ResponsePayload, + type UIServerConfiguration +} from '../../types/index.js' export abstract class AbstractUIServer { - public readonly chargingStations: Map; - protected readonly uiServices: Map; - protected server: WebSocket.Server | HttpServer; + public readonly chargingStations: Map + protected readonly httpServer: Server | Http2Server + protected readonly responseHandlers: Map + protected readonly uiServices: Map - public constructor() { - this.chargingStations = new Map(); - this.uiServices = new Map(); + public constructor (protected readonly uiServerConfiguration: UIServerConfiguration) { + this.chargingStations = new Map() + switch (this.uiServerConfiguration.version) { + case ApplicationProtocolVersion.VERSION_11: + this.httpServer = new Server() + break + case ApplicationProtocolVersion.VERSION_20: + this.httpServer = createServer() + break + default: + throw new BaseError( + `Unsupported application protocol version ${this.uiServerConfiguration.version}` + ) + } + this.responseHandlers = new Map() + this.uiServices = new Map() } - public abstract start(): void; - public abstract stop(): void; - public abstract sendRequest(request: string): void; - public abstract sendResponse(response: string): void; - public abstract logPrefix(modName?: string, methodName?: string): string; + public buildProtocolRequest ( + id: string, + procedureName: ProcedureName, + requestPayload: RequestPayload + ): ProtocolRequest { + return [id, procedureName, requestPayload] + } + + public buildProtocolResponse (id: string, responsePayload: ResponsePayload): ProtocolResponse { + return [id, responsePayload] + } + + public stop (): void { + this.stopHttpServer() + this.chargingStations.clear() + } + + public async sendInternalRequest (request: ProtocolRequest): Promise { + const protocolVersion = ProtocolVersion['0.0.1'] + this.registerProtocolVersionUIService(protocolVersion) + return await (this.uiServices + .get(protocolVersion) + ?.requestHandler(request) as Promise) + } + + public hasResponseHandler (id: string): boolean { + return this.responseHandlers.has(id) + } + + protected startHttpServer (): void { + if (!this.httpServer.listening) { + this.httpServer.listen(this.uiServerConfiguration.options) + } + } + + protected registerProtocolVersionUIService (version: ProtocolVersion): void { + if (!this.uiServices.has(version)) { + this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this)) + } + } + + protected authenticate (req: IncomingMessage, next: (err?: Error) => void): void { + if (this.isBasicAuthEnabled()) { + if (!this.isValidBasicAuth(req)) { + next(new BaseError('Unauthorized')) + } + next() + } + next() + } + + private stopHttpServer (): void { + if (this.httpServer.listening) { + this.httpServer.close() + } + } + + private isBasicAuthEnabled (): boolean { + return ( + this.uiServerConfiguration.authentication?.enabled === true && + // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition + this.uiServerConfiguration.authentication.type === AuthenticationType.BASIC_AUTH + ) + } + + private isValidBasicAuth (req: IncomingMessage): boolean { + const authorizationHeader = req.headers.authorization ?? '' + const authorizationToken = authorizationHeader.split(/\s+/).pop() ?? '' + const authentication = Buffer.from(authorizationToken, 'base64').toString() + const authenticationParts = authentication.split(/:/) + const username = authenticationParts.shift() + const password = authenticationParts.join(':') + return ( + this.uiServerConfiguration.authentication?.username === username && + this.uiServerConfiguration.authentication?.password === password + ) + } + + public abstract start (): void + public abstract sendRequest (request: ProtocolRequest): void + public abstract sendResponse (response: ProtocolResponse): void + public abstract logPrefix (moduleName?: string, methodName?: string, prefixSuffix?: string): string }