feat: implement plugin management UI

This commit is contained in:
LukeGus committed 2026-10-06 10:35:56 -05:00
1 parent 88d7bc5525
commit 3ed5775ed5
52 files changed
+20072 -41

No files matched your search

+314
View File
@@ -0,0 +1,314 @@
/**
* The official plugin registry: fetching its index and downloading a release.
*
* The index is a plain JSON file in Termix-SSH/Termix-Registry. Nothing in it
* is trusted on its own: every download is checked against the sha256 and
* Ed25519 signature listed for it, and the signature must come from a key
* pinned in trust.ts. A tampered index can at most point at a file that then
* fails the check.
*/
import crypto from "node:crypto";
import fs from "node:fs";
import path from "node:path";
import semver from "semver";
import { SUPPORTED_PLUGIN_API_VERSION } from "@termix-ssh/plugin-sdk/manifest";
import { safeOutboundFetch } from "../utils/safe-outbound-fetch.js";
import { pluginLogger } from "../utils/logger.js";
import { verifyPluginArtifact } from "./trust.js";
import { getPluginsDir } from "./paths.js";
export const OFFICIAL_REGISTRY_ID = "official";
export const OFFICIAL_REGISTRY_URL =
"https://raw.githubusercontent.com/Termix-SSH/Termix-Registry/main/official/index.json";
const CACHE_MS = 15 * 60_000;
const MAX_INDEX_BYTES = 5 * 1024 * 1024;
const MAX_ARTIFACT_BYTES = 200 * 1024 * 1024;
const MAX_REDIRECTS = 5;
const ID_PATTERN = /^[a-z0-9][a-z0-9-]*$/;
export interface RegistryVersion {
version: string;
api: string;
url: string;
sha256: string;
signature: string;
size: number;
capabilities: string[];
releaseNotesUrl?: string;
publishedAt?: string;
}
export interface RegistryPlugin {
id: string;
name: string;
description: string;
author: string;
category: string;
repository?: string;
icon?: string;
/** Newest first. */
versions: RegistryVersion[];
}
export interface RegistryIndex {
registry: string;
name: string;
updatedAt?: string;
plugins: RegistryPlugin[];
}
export function getRegistryUrl(): string {
return process.env.TERMIX_PLUGIN_REGISTRY_URL || OFFICIAL_REGISTRY_URL;
}
function asString(value: unknown): string | undefined {
return typeof value === "string" ? value : undefined;
}
function parseVersion(raw: unknown): RegistryVersion | null {
if (!raw || typeof raw !== "object") return null;
const entry = raw as Record<string, unknown>;
const version = asString(entry.version);
const url = asString(entry.url);
const sha256 = asString(entry.sha256);
const signature = asString(entry.signature);
if (!version || !semver.valid(version) || !url || !sha256 || !signature) {
return null;
}
if (!/^[a-f0-9]{64}$/i.test(sha256)) return null;
try {
if (new URL(url).protocol !== "https:") return null;
} catch {
return null;
}
return {
version,
api: asString(entry.api) ?? "",
url,
sha256: sha256.toLowerCase(),
signature,
size: typeof entry.size === "number" ? entry.size : 0,
capabilities: Array.isArray(entry.capabilities)
? entry.capabilities.filter((c): c is string => typeof c === "string")
: [],
releaseNotesUrl: asString(entry.releaseNotesUrl),
publishedAt: asString(entry.publishedAt),
};
}
/** Validates a fetched index. Malformed entries are dropped, not fatal. */
export function parseRegistryIndex(raw: unknown): RegistryIndex {
if (!raw || typeof raw !== "object") {
throw new Error("registry index is not an object");
}
const index = raw as Record<string, unknown>;
if (!Array.isArray(index.plugins)) {
throw new Error("registry index has no plugins list");
}
const plugins: RegistryPlugin[] = [];
for (const item of index.plugins) {
if (!item || typeof item !== "object") continue;
const entry = item as Record<string, unknown>;
const id = asString(entry.id);
if (!id || !ID_PATTERN.test(id)) continue;
const versions = (Array.isArray(entry.versions) ? entry.versions : [])
.map(parseVersion)
.filter((v): v is RegistryVersion => v !== null)
.sort((a, b) => semver.rcompare(a.version, b.version));
if (versions.length === 0) continue;
plugins.push({
id,
name: asString(entry.name) ?? id,
description: asString(entry.description) ?? "",
author: asString(entry.author) ?? "",
category: asString(entry.category) ?? "",
repository: asString(entry.repository),
icon: asString(entry.icon),
versions,
});
}
return {
registry: asString(index.registry) ?? OFFICIAL_REGISTRY_ID,
name: asString(index.name) ?? "",
updatedAt: asString(index.updatedAt),
plugins,
};
}
/** Whether this build can run a release built against `api`. */
export function isApiCompatible(api: string): boolean {
const major = semver.coerce(api)?.major;
return major !== undefined && String(major) === SUPPORTED_PLUGIN_API_VERSION;
}
/** Follows redirects by hand so each hop still gets the outbound checks. */
async function fetchFollowing(url: string): Promise<Response> {
let current = url;
for (let hop = 0; hop <= MAX_REDIRECTS; hop++) {
const response = await safeOutboundFetch(current, {
method: "GET",
redirect: "manual",
headers: { "User-Agent": "Termix" },
});
if (response.status >= 300 && response.status < 400) {
const location = response.headers.get("location");
if (!location) throw new Error(`redirect without a location: ${current}`);
current = new URL(location, current).toString();
continue;
}
if (!response.ok) {
throw new Error(`${current} answered ${response.status}`);
}
return response;
}
throw new Error(`too many redirects fetching ${url}`);
}
async function readLimited(response: Response, limit: number): Promise<Buffer> {
const declared = Number(response.headers.get("content-length") ?? 0);
if (declared > limit) throw new Error("download is larger than allowed");
if (!response.body) return Buffer.alloc(0);
const chunks: Buffer[] = [];
let total = 0;
const reader = response.body.getReader();
for (;;) {
const { done, value } = await reader.read();
if (done) break;
total += value.byteLength;
if (total > limit) {
await reader.cancel().catch(() => {});
throw new Error("download is larger than allowed");
}
chunks.push(Buffer.from(value));
}
return Buffer.concat(chunks);
}
let cache: { index: RegistryIndex; at: number; hash: string } | null = null;
let inflight: Promise<RegistryIndex> | null = null;
export interface RegistryStatus {
url: string;
lastCheckedAt: string | null;
error: string | null;
}
let lastError: string | null = null;
export function getRegistryStatus(): RegistryStatus {
return {
url: getRegistryUrl(),
lastCheckedAt: cache ? new Date(cache.at).toISOString() : null,
error: lastError,
};
}
export async function fetchRegistryIndex(
options: { force?: boolean } = {},
): Promise<RegistryIndex> {
if (!options.force && cache && Date.now() - cache.at < CACHE_MS) {
return cache.index;
}
if (inflight) return inflight;
inflight = (async () => {
try {
const response = await fetchFollowing(getRegistryUrl());
const body = await readLimited(response, MAX_INDEX_BYTES);
const index = parseRegistryIndex(JSON.parse(body.toString("utf8")));
cache = {
index,
at: Date.now(),
hash: crypto.createHash("sha256").update(body).digest("hex"),
};
lastError = null;
return index;
} catch (error) {
lastError = error instanceof Error ? error.message : String(error);
// A stale index beats none when the registry is briefly unreachable.
if (cache) {
pluginLogger.warn(`Plugin registry check failed: ${lastError}`, {
operation: "plugin_registry",
});
return cache.index;
}
throw error;
} finally {
inflight = null;
}
})();
return inflight;
}
/** Test seam. */
export function resetRegistryCache(): void {
cache = null;
inflight = null;
lastError = null;
}
export function findRelease(
index: RegistryIndex,
pluginId: string,
version?: string,
): { plugin: RegistryPlugin; release: RegistryVersion } | null {
const plugin = index.plugins.find((entry) => entry.id === pluginId);
if (!plugin) return null;
const release = version
? plugin.versions.find((entry) => entry.version === version)
: plugin.versions.find((entry) => isApiCompatible(entry.api));
if (!release) return null;
return { plugin, release };
}
/**
* Downloads a release, verifies it, and leaves it in a staging folder the
* loader never scans. The caller moves it into place.
*/
export async function downloadRelease(
pluginId: string,
release: RegistryVersion,
): Promise<{ file: string; signatureFile: string }> {
if (!isApiCompatible(release.api)) {
throw new Error(
`${pluginId} ${release.version} needs plugin API ${release.api}, this build runs ${SUPPORTED_PLUGIN_API_VERSION}`,
);
}
const limit =
release.size > 0 ? release.size + 1024 * 1024 : MAX_ARTIFACT_BYTES;
const response = await fetchFollowing(release.url);
const buffer = await readLimited(
response,
Math.min(limit, MAX_ARTIFACT_BYTES),
);
const verified = verifyPluginArtifact(
buffer,
release.sha256,
release.signature,
);
if (verified.ok === false) {
throw new Error(`${pluginId} ${release.version}: ${verified.reason}`);
}
const staging = getDownloadsDir();
await fs.promises.mkdir(staging, { recursive: true });
const base = path.join(
staging,
`${pluginId}-${release.version}-${crypto.randomBytes(4).toString("hex")}.tmxplug`,
);
await fs.promises.writeFile(base, buffer);
await fs.promises.writeFile(`${base}.sig`, release.signature.trim());
return { file: base, signatureFile: `${base}.sig` };
}
/** A dot folder inside the plugins dir, which the loader's scan skips. */
export function getDownloadsDir(): string {
return path.join(getPluginsDir(), ".downloads");
}