diff --git a/server/src/service/network/DockerProvider.ts b/server/src/service/network/DockerProvider.ts index 776da3f92..e365534c9 100644 --- a/server/src/service/network/DockerProvider.ts +++ b/server/src/service/network/DockerProvider.ts @@ -1,5 +1,7 @@ +import https from "node:https"; + import { IStatusProvider } from "@/service/network/IStatusProvider.js"; -import { DockerStatusPayload, MonitorStatusResponse } from "@/types/network.js"; +import { CheckContext, DockerStatusPayload, MonitorStatusResponse } from "@/types/network.js"; import { DOCKER_LOG_TAIL_LINES, @@ -23,13 +25,20 @@ import { AppError } from "@/utils/AppError.js"; import Dockerode from "dockerode"; import { timeRequest } from "@/service/network/utils.js"; import { NETWORK_ERROR } from "@/types/network.js"; +import { IEncryptionService } from "@/service/encryptionService.js"; + type DockerodeType = typeof Dockerode; +type DockerOptions = Dockerode.DockerOptions & { agent?: https.Agent }; +type TlsCredentials = { ok: true; key: string } | { ok: false; message: string }; const SERVICE_NAME = "DockerProvider"; const STATS_CONCURRENCY = 5; const DOCKER_LOG_MAX_LINE_BYTES = 4096; const DOCKER_LOG_TRUNCATION_MARKER = " …[truncated]"; const DOCKER_LOG_TS_REGEX = /^(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2})(?:\.(\d{1,9}))?Z /; +const DOCKER_TLS_DEFAULT_PORT = 2376; +const DOCKER_TLS_URL = /^(tcp|https):\/\/([^\/\s:]+)(?::(\d+))?\/?$/; +const PEM_CERT_BLOCK = /-----BEGIN CERTIFICATE-----[\s\S]*?-----END CERTIFICATE-----/g; export interface DockerError extends Error { statusCode?: number; @@ -42,20 +51,46 @@ export class DockerProvider implements IStatusProvider { constructor( private logger: ILogger, - private DockerLib: DockerodeType + private DockerLib: DockerodeType, + private encryptionService: IEncryptionService ) {} supports(type: MonitorType): boolean { return type === "docker"; } + private resolveTlsCredentials = (monitor: Monitor, ctx?: CheckContext): TlsCredentials | undefined => { + const url = monitor.url?.trim() ?? ""; + if (!DOCKER_TLS_URL.test(url)) return undefined; + if (!ctx?.dockerTlsKey) return { ok: false, message: "Docker TLS key is missing" }; + try { + return { ok: true, key: this.encryptionService.decrypt(ctx.dockerTlsKey) }; + } catch (error) { + if (error instanceof AppError) { + const keyId = typeof error.details?.keyId === "string" ? ` (key id ${error.details.keyId})` : ""; + return { ok: false, message: `${error.message}${keyId}` }; + } + return { ok: false, message: "Docker TLS client key could not be decrypted" }; + } + }; + private isDockerError(error: unknown): error is DockerError { return error instanceof Error && ("statusCode" in error || "reason" in error || "json" in error); } - private toDockerOptions = (monitor: Monitor): Dockerode.DockerOptions => { + private splitCaBundle = (pem: string | undefined): string[] | undefined => { + if (!pem) return undefined; + const blocks = pem.match(PEM_CERT_BLOCK); + return blocks && blocks.length > 0 ? blocks : undefined; + }; + + private invalidUrl = (message: string) => new AppError({ message, status: 422, service: SERVICE_NAME, method: "toDockerOptions" }); + + private toDockerOptions = (monitor: Monitor, credentials?: TlsCredentials): DockerOptions => { const url = monitor.url?.trim(); - if (!url) throw new AppError({ message: "Docker host URL is required", status: 422, service: SERVICE_NAME, method: "toDockerOptions" }); + if (!url) throw this.invalidUrl("Docker host URL is required"); + + // Unix socket if (url.startsWith("unix://")) { const socketPath = url.slice("unix://".length); if (!socketPath.startsWith("/")) @@ -63,7 +98,28 @@ export class DockerProvider implements IStatusProvider { return { socketPath }; } if (url.startsWith("/")) return { socketPath: url }; - throw new AppError({ message: `Invalid Docker host URL: ${url}`, status: 422, service: SERVICE_NAME, method: "toDockerOptions" }); + + // Docker TLS + const match = DOCKER_TLS_URL.exec(url); + if (!match) throw this.invalidUrl(`Invalid Docker host URL: ${url}`); + if (!credentials?.ok) throw this.invalidUrl(credentials?.message ?? "Docker TLS key is missing"); + const [, , host, port] = match; + const ca = monitor.ignoreTlsErrors ? undefined : this.splitCaBundle(monitor.dockerTlsCa); + const cert = monitor.dockerTlsCert; + const key = credentials.key; + return { + host, + port: port ? Number(port) : DOCKER_TLS_DEFAULT_PORT, + protocol: "https", + ca, + cert, + key, + agent: new https.Agent({ ca, cert, key, rejectUnauthorized: !monitor.ignoreTlsErrors }), + socketPath: undefined, + username: undefined, + sshOptions: undefined, + timeout: undefined, + }; }; private async mapWithConcurrency(items: T[], limit: number, fn: (item: T) => Promise): Promise { @@ -260,9 +316,23 @@ export class DockerProvider implements IStatusProvider { return rawLogs.filter((log) => log !== null); }; - handle = async (monitor: Monitor): Promise> => { + private failed = (monitor: Monitor, code: number, message: string, responseTime: number): MonitorStatusResponse => ({ + monitorId: monitor.id, + teamId: monitor.teamId, + type: monitor.type, + status: false, + code, + message, + responseTime, + payload: null, + }); + + handle = async (monitor: Monitor, ctx?: CheckContext): Promise> => { try { - const docker = new this.DockerLib(this.toDockerOptions(monitor)); + const credentials = this.resolveTlsCredentials(monitor, ctx); + if (credentials && !credentials.ok) return this.failed(monitor, NETWORK_ERROR, credentials.message, 0); + + const docker = new this.DockerLib(this.toDockerOptions(monitor, credentials)); // Host reachability is the monitor's status; ping latency is the responseTime const { responseTime, error } = await timeRequest(() => docker.ping()); if (error) { @@ -274,16 +344,7 @@ export class DockerProvider implements IStatusProvider { } else if (error instanceof Error) { message = error.message; } - return { - monitorId: monitor.id, - teamId: monitor.teamId, - type: monitor.type, - status: false, - code, - message, - responseTime, - payload: null, - }; + return this.failed(monitor, code, message, responseTime); } const summaries = await docker.listContainers({ all: true });