X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fcharging-station%2Fui-server%2FAbstractUIServer.ts;h=d27ea616bfe98591e9afbc8a3dff65c8f7a412df;hb=42b8cf5cdca8eaab1e7442f7c92c2a5ed97434f6;hp=b8e7c46cdf879b1e5d28d65c653085e90c40cf89;hpb=852a4c5f07886502e278d44fda06efdfa8c711d8;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 b8e7c46c..d27ea616 100644 --- a/src/charging-station/ui-server/AbstractUIServer.ts +++ b/src/charging-station/ui-server/AbstractUIServer.ts @@ -1,43 +1,131 @@ -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 type { AbstractUIService } from './ui-services/AbstractUIService'; +import { UIServiceFactory } from './ui-services/UIServiceFactory'; +import { BaseError } from '../../exception'; import { - ProcedureName, - ProtocolRequest, - ProtocolResponse, + ApplicationProtocolVersion, + AuthenticationType, + type ChargingStationData, + type ProcedureName, + type ProtocolRequest, + type ProtocolResponse, ProtocolVersion, - RequestPayload, - ResponsePayload, -} from '../../types/UIProtocol'; -import type AbstractUIService from './ui-services/AbstractUIService'; + type RequestPayload, + type ResponsePayload, + type UIServerConfiguration, +} from '../../types'; export abstract class AbstractUIServer { public readonly chargingStations: Map; + protected readonly httpServer: Server | Http2Server; + protected readonly responseHandlers: Map; protected readonly uiServices: Map; - protected server: WebSocket.Server | HttpServer; - public constructor() { + 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 buildProtocolRequest( id: string, procedureName: ProcedureName, - requestPayload: RequestPayload - ): string { - return JSON.stringify([id, procedureName, requestPayload] as ProtocolRequest); + requestPayload: RequestPayload, + ): ProtocolRequest { + return [id, procedureName, requestPayload]; } - public buildProtocolResponse(id: string, responsePayload: ResponsePayload): string { - return JSON.stringify([id, responsePayload] as ProtocolResponse); + 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 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 === false) { + this.httpServer.listen(this.uiServerConfiguration.options); + } + } + + protected registerProtocolVersionUIService(version: ProtocolVersion): void { + if (this.uiServices.has(version) === false) { + this.uiServices.set(version, UIServiceFactory.getUIServiceImplementation(version, this)); + } + } + + protected authenticate(req: IncomingMessage, next: (err?: Error) => void): void { + if (this.isBasicAuthEnabled() === true) { + if (this.isValidBasicAuth(req) === false) { + next(new BaseError('Unauthorized')); + } + next(); + } + next(); + } + + private stopHttpServer(): void { + if (this.httpServer.listening === true) { + this.httpServer.close(); + } + } + + private isBasicAuthEnabled(): boolean { + return ( + this.uiServerConfiguration.authentication?.enabled === true && + 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 stop(): void; - public abstract sendRequest(request: string): void; - public abstract sendResponse(response: string): void; - public abstract logPrefix(modName?: string, methodName?: string): string; + public abstract sendRequest(request: ProtocolRequest): void; + public abstract sendResponse(response: ProtocolResponse): void; + public abstract logPrefix( + moduleName?: string, + methodName?: string, + prefixSuffix?: string, + ): string; }