import { type IncomingMessage, Server, type ServerResponse } from 'node:http'
-import { type Http2Server, createServer } from 'node:http2'
+import { createServer, type Http2Server } from 'node:http2'
import type { WebSocket } from 'ws'
-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,
+ ConfigurationSection,
type ProcedureName,
type ProtocolRequest,
type ProtocolResponse,
type ResponsePayload,
type UIServerConfiguration
} from '../../types/index.js'
+import { logger } from '../../utils/index.js'
+import type { AbstractUIService } from './ui-services/AbstractUIService.js'
+import { UIServiceFactory } from './ui-services/UIServiceFactory.js'
+import { getUsernameAndPasswordFromAuthorizationToken } from './UIServerUtils.js'
+
+const moduleName = 'AbstractUIServer'
export abstract class AbstractUIServer {
public readonly chargingStations: Map<string, ChargingStationData>
public readonly chargingStationTemplates: Set<string>
protected readonly httpServer: Server | Http2Server
- protected readonly responseHandlers: Map<string, ServerResponse | WebSocket>
+ protected readonly responseHandlers: Map<
+ `${string}-${string}-${string}-${string}-${string}`,
+ ServerResponse | WebSocket
+ >
+
protected readonly uiServices: Map<ProtocolVersion, AbstractUIService>
public constructor (protected readonly uiServerConfiguration: UIServerConfiguration) {
break
default:
throw new BaseError(
- `Unsupported application protocol version ${this.uiServerConfiguration.version}`
+ `Unsupported application protocol version ${this.uiServerConfiguration.version} in '${ConfigurationSection.uiServer}' configuration section`
)
}
- this.responseHandlers = new Map<string, ServerResponse | WebSocket>()
+ this.responseHandlers = new Map<
+ `${string}-${string}-${string}-${string}-${string}`,
+ ServerResponse | WebSocket
+ >()
this.uiServices = new Map<ProtocolVersion, AbstractUIService>()
}
public buildProtocolRequest (
- id: string,
+ uuid: `${string}-${string}-${string}-${string}-${string}`,
procedureName: ProcedureName,
requestPayload: RequestPayload
): ProtocolRequest {
- return [id, procedureName, requestPayload]
+ return [uuid, procedureName, requestPayload]
}
- public buildProtocolResponse (id: string, responsePayload: ResponsePayload): ProtocolResponse {
- return [id, responsePayload]
+ public buildProtocolResponse (
+ uuid: `${string}-${string}-${string}-${string}-${string}`,
+ responsePayload: ResponsePayload
+ ): ProtocolResponse {
+ return [uuid, responsePayload]
}
public stop (): void {
for (const uiService of this.uiServices.values()) {
uiService.stop()
}
+ this.clearCaches()
+ }
+
+ public clearCaches (): void {
this.chargingStations.clear()
this.chargingStationTemplates.clear()
}
?.requestHandler(request) as Promise<ProtocolResponse>)
}
- public hasResponseHandler (id: string): boolean {
- return this.responseHandlers.has(id)
+ public hasResponseHandler (uuid: `${string}-${string}-${string}-${string}-${string}`): boolean {
+ return this.responseHandlers.has(uuid)
}
protected startHttpServer (): void {
+ this.httpServer.on('error', error => {
+ logger.error(
+ `${this.logPrefix(moduleName, 'start.httpServer.on.error')} HTTP server error:`,
+ error
+ )
+ })
if (!this.httpServer.listening) {
this.httpServer.listen(this.uiServerConfiguration.options)
}
}
protected authenticate (req: IncomingMessage, next: (err?: Error) => void): void {
+ const authorizationError = new BaseError('Unauthorized')
if (this.isBasicAuthEnabled()) {
- if (!this.isValidBasicAuth(req)) {
- next(new BaseError('Unauthorized'))
+ if (!this.isValidBasicAuth(req, next)) {
+ next(authorizationError)
}
next()
+ } else if (this.isProtocolBasicAuthEnabled()) {
+ if (!this.isValidProtocolBasicAuth(req, next)) {
+ next(authorizationError)
+ }
+ next()
+ } else if (this.uiServerConfiguration.authentication?.enabled === true) {
+ next(authorizationError)
}
next()
}
private stopHttpServer (): void {
if (this.httpServer.listening) {
this.httpServer.close()
+ this.httpServer.removeAllListeners()
}
}
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(':')
+ private isProtocolBasicAuthEnabled (): boolean {
+ return (
+ this.uiServerConfiguration.authentication?.enabled === true &&
+ this.uiServerConfiguration.authentication.type === AuthenticationType.PROTOCOL_BASIC_AUTH
+ )
+ }
+
+ private isValidBasicAuth (req: IncomingMessage, next: (err?: Error) => void): boolean {
+ const [username, password] = getUsernameAndPasswordFromAuthorizationToken(
+ req.headers.authorization?.split(/\s+/).pop() ?? '',
+ next
+ )
+ return this.isValidUsernameAndPassword(username, password)
+ }
+
+ private isValidProtocolBasicAuth (req: IncomingMessage, next: (err?: Error) => void): boolean {
+ const authorizationProtocol = req.headers['sec-websocket-protocol']?.split(/,\s+/).pop()
+ const [username, password] = getUsernameAndPasswordFromAuthorizationToken(
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ `${authorizationProtocol}${Array(((4 - (authorizationProtocol!.length % 4)) % 4) + 1).join(
+ '='
+ )}`
+ .split('.')
+ .pop() ?? '',
+ next
+ )
+ return this.isValidUsernameAndPassword(username, password)
+ }
+
+ private isValidUsernameAndPassword (username: string, password: string): boolean {
return (
this.uiServerConfiguration.authentication?.username === username &&
- this.uiServerConfiguration.authentication?.password === password
+ this.uiServerConfiguration.authentication.password === password
)
}