synapse-mcp 1.0.0

package/dist/services/docker.d.ts

@@ -0,0 +1,243 @@
+import Docker from "dockerode";
+import { HostConfig, ContainerInfo, ContainerStats, HostStatus, LogEntry, ImageInfo } from "../types.js";
+import type { IDockerService } from "./interfaces.js";
+/**
+ * Check if a string looks like a Unix socket path
+ */
+export declare function isSocketPath(value: string): boolean;
+/**
+ * DockerService class implementing IDockerService interface
+ * Manages Docker client connections and operations across multiple hosts
+ */
+export declare class DockerService implements IDockerService {
+    private dockerFactory;
+    private clientCache;
+    constructor(dockerFactory?: (config: HostConfig) => Docker);
+    /**
+     * Get or create Docker client for a host
+     */
+    getDockerClient(config: HostConfig): Docker;
+    /**
+     * Clears all cached Docker clients.
+     *
+     * Call this during application shutdown or when you need to force new connections
+     * to all Docker hosts. The cached client instances will be removed, and any
+     * underlying HTTP/socket connections will be cleaned up by garbage collection
+     * when the client objects are no longer referenced.
+     *
+     * Note: Dockerode clients do not have an explicit close() method. The HTTP agent
+     * connections are automatically managed and will be released by the Node.js runtime
+     * when the client objects are garbage collected.
+     *
+     * @example
+     * ```typescript
+     * // Force fresh connections on next access
+     * dockerService.clearClients();
+     *
+     * // Or during shutdown
+     * process.on('SIGTERM', () => {
+     *   dockerService.clearClients();
+     *   process.exit(0);
+     * });
+     * ```
+     */
+    clearClients(): void;
+    /**
+     * List containers across all hosts with filtering (parallel execution)
+     */
+    listContainers(hosts: HostConfig[], options?: {
+        state?: "all" | "running" | "stopped" | "paused";
+        nameFilter?: string;
+        imageFilter?: string;
+        labelFilter?: string;
+    }): Promise<ContainerInfo[]>;
+    /**
+     * List containers on a single host (internal helper)
+     */
+    private listContainersOnHost;
+    /**
+     * Find which host a container is on
+     */
+    findContainerHost(containerId: string, hosts: HostConfig[]): Promise<{
+        host: HostConfig;
+        container: Docker.ContainerInfo;
+    } | null>;
+    /**
+     * Perform action on container
+     */
+    containerAction(containerId: string, action: "start" | "stop" | "restart" | "pause" | "unpause", host: HostConfig): Promise<void>;
+    /**
+     * Get container by ID or name
+     */
+    private getContainer;
+    /**
+     * Get container logs
+     */
+    getContainerLogs(containerId: string, host: HostConfig, options?: {
+        lines?: number;
+        since?: string;
+        until?: string;
+        stream?: "all" | "stdout" | "stderr";
+    }): Promise<LogEntry[]>;
+    /**
+     * Get container stats
+     */
+    getContainerStats(containerId: string, host: HostConfig): Promise<ContainerStats>;
+    /**
+     * Get host status overview (parallel execution)
+     */
+    getHostStatus(hosts: HostConfig[]): Promise<HostStatus[]>;
+    /**
+     * Get status for a single host (internal helper)
+     */
+    private getHostStatusSingle;
+    /**
+     * List images across all hosts (parallel execution)
+     */
+    listImages(hosts: HostConfig[], options?: ListImagesOptions): Promise<ImageInfo[]>;
+    /**
+     * List images from a single host (internal helper)
+     */
+    private listImagesOnHost;
+    /**
+     * Inspect container for detailed info
+     */
+    inspectContainer(containerId: string, host: HostConfig): Promise<Docker.ContainerInspectInfo>;
+    /**
+     * Get Docker system info
+     */
+    getDockerInfo(host: HostConfig): Promise<DockerSystemInfo>;
+    /**
+     * Get Docker disk usage (system df)
+     */
+    getDockerDiskUsage(host: HostConfig): Promise<DockerDiskUsage>;
+    /**
+     * Prune Docker resources
+     */
+    pruneDocker(host: HostConfig, target: "containers" | "images" | "volumes" | "networks" | "buildcache" | "all"): Promise<PruneResult[]>;
+    /**
+     * Pull an image on a host
+     */
+    pullImage(imageName: string, host: HostConfig): Promise<{
+        status: string;
+    }>;
+    /**
+     * Recreate a container (stop, remove, pull latest, start with same config)
+     */
+    recreateContainer(containerId: string, host: HostConfig, options?: {
+        pull?: boolean;
+    }): Promise<{
+        status: string;
+        containerId: string;
+    }>;
+    /**
+     * Remove an image
+     */
+    removeImage(imageId: string, host: HostConfig, options?: {
+        force?: boolean;
+    }): Promise<{
+        status: string;
+    }>;
+    /**
+     * Build an image from a Dockerfile (SSH-based for remote hosts)
+     *
+     * SECURITY: Implements path traversal protection (CWE-22)
+     * - Requires absolute paths for context and dockerfile
+     * - Rejects any path containing .. or . components
+     * - Validates character set to prevent injection
+     *
+     * @param host - Docker host configuration
+     * @param options - Build options (context, tag, dockerfile, noCache)
+     * @returns Promise resolving to build status
+     * @throws Error if paths contain directory traversal or invalid characters
+     */
+    buildImage(host: HostConfig, options: {
+        context: string;
+        tag: string;
+        dockerfile?: string;
+        noCache?: boolean;
+    }): Promise<{
+        status: string;
+    }>;
+}
+/**
+ * Load host configurations from config file, env var, or defaults
+ */
+export declare function loadHostConfigs(): HostConfig[];
+/**
+ * List images options
+ */
+export interface ListImagesOptions {
+    danglingOnly?: boolean;
+}
+/**
+ * Format bytes to human readable
+ */
+export declare function formatBytes(bytes: number): string;
+/**
+ * Format uptime from created timestamp
+ */
+export declare function formatUptime(created: string): string;
+/**
+ * Format Docker image ID (truncate sha256: prefix and limit to 12 chars)
+ */
+export declare function formatImageId(id: string): string;
+/**
+ * Docker system info response
+ */
+export interface DockerSystemInfo {
+    dockerVersion: string;
+    apiVersion: string;
+    os: string;
+    arch: string;
+    kernelVersion: string;
+    cpus: number;
+    memoryBytes: number;
+    storageDriver: string;
+    rootDir: string;
+    containersTotal: number;
+    containersRunning: number;
+    containersPaused: number;
+    containersStopped: number;
+    images: number;
+}
+/**
+ * Docker disk usage response
+ */
+export interface DockerDiskUsage {
+    images: {
+        total: number;
+        active: number;
+        size: number;
+        reclaimable: number;
+    };
+    containers: {
+        total: number;
+        running: number;
+        size: number;
+        reclaimable: number;
+    };
+    volumes: {
+        total: number;
+        active: number;
+        size: number;
+        reclaimable: number;
+    };
+    buildCache: {
+        total: number;
+        size: number;
+        reclaimable: number;
+    };
+    totalSize: number;
+    totalReclaimable: number;
+}
+/**
+ * Prune result
+ */
+export interface PruneResult {
+    type: string;
+    spaceReclaimed: number;
+    itemsDeleted: number;
+    details?: string[];
+}
+//# sourceMappingURL=docker.d.ts.map

package/dist/services/docker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docker.d.ts","sourceRoot":"","sources":["../../src/services/docker.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,WAAW,CAAC;AAI/B,OAAO,EACL,UAAU,EACV,aAAa,EACb,cAAc,EACd,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,aAAa,CAAC;AAGrB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEtD;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAKnD;AAyBD;;;GAGG;AACH,qBAAa,aAAc,YAAW,cAAc;IAGtC,OAAO,CAAC,aAAa;IAFjC,OAAO,CAAC,WAAW,CAA6B;gBAE5B,aAAa,GAAE,CAAC,MAAM,EAAE,UAAU,KAAK,MAAkC;IAE7F;;OAEG;IACH,eAAe,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IAa3C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,YAAY,IAAI,IAAI;IAIpB;;OAEG;IACG,cAAc,CAClB,KAAK,EAAE,UAAU,EAAE,EACnB,OAAO,GAAE;QACP,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;QACjD,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;KACjB,GACL,OAAO,CAAC,aAAa,EAAE,CAAC;IAoB3B;;OAEG;YACW,oBAAoB;IAoElC;;OAEG;IACG,iBAAiB,CACrB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,UAAU,EAAE,GAClB,OAAO,CAAC;QAAE,IAAI,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC,aAAa,CAAA;KAAE,GAAG,IAAI,CAAC;IA8BxE;;OAEG;IACG,eAAe,CACnB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,EAC1D,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,IAAI,CAAC;IAsBhB;;OAEG;YACW,YAAY;IAK1B;;OAEG;IACG,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,UAAU,EAChB,OAAO,GAAE;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;KACjC,GACL,OAAO,CAAC,QAAQ,EAAE,CAAC;IA8BtB;;OAEG;IACG,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC;IAoDvF;;OAEG;IACG,aAAa,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAK/D;;OAEG;YACW,mBAAmB;IA4BjC;;OAEG;IACG,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAU5F;;OAEG;YACW,gBAAgB;IAmB9B;;OAEG;IACG,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC;IAKvC;;OAEG;IACG,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAuBhE;;OAEG;IACG,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,eAAe,CAAC;IAmFpE;;OAEG;IACG,WAAW,CACf,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,GAAG,KAAK,GAC9E,OAAO,CAAC,WAAW,EAAE,CAAC;IAqFzB;;OAEG;IACG,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAyBjF;;OAEG;IACG,iBAAiB,CACrB,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,UAAU,EAChB,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAO,GAC/B,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAuCnD;;OAEG;IACG,WAAW,CACf,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,UAAU,EAChB,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO,GAChC,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAS9B;;;;;;;;;;;;OAYG;IACG,UAAU,CACd,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAC;QAChB,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GACA,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAgE/B;AAmDD;;GAEG;AACH,wBAAgB,eAAe,IAAI,UAAU,EAAE,CAuD9C;AAoDD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMjD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CASpD;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAGhD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB"}