dsh-plugin-mcp-apps 0.0.0-stage → 0.5.7

package/lib/oauth.js

@@ -0,0 +1,239 @@
+/**
+ * OAuth 2.0 support for MCP connections.
+ *
+ * The MCP client SDK owns discovery, dynamic client registration, PKCE and the
+ * authorization-code exchange; this module only supplies the persistence hooks
+ * (`OAuthClientProvider`) and the browser-facing redirect address. Tokens and
+ * the client registration live in the connection record, which the host writes
+ * to a 0600 file — the browser never sees them.
+ *
+ * @module dsh-plugin-mcp-apps/oauth
+ */
+import { randomBytes } from "node:crypto";
+
+/** Absolute path the authorization server redirects back to. */
+export const CALLBACK_PATH = "/api/mcp-apps/oauth/callback";
+
+/** Absolute path of the published client metadata document (CIMD). */
+export const CLIENT_METADATA_PATH = "/api/mcp-apps/oauth/client-metadata.json";
+
+/**
+ * Client metadata document for CIMD (SEP-991): the `client_id` is this URL.
+ * @param origin - browser origin the UI is served from, e.g. https://dsh.example.com.
+ * @returns the document to serve, with matching `client_id` and redirect URI.
+ */
+export function clientMetadataDocument(origin) {
+	const base = origin.replace(/\/+$/, "");
+	return {
+		client_id: base + CLIENT_METADATA_PATH,
+		client_name: "DSH 连接应用",
+		redirect_uris: [base + CALLBACK_PATH],
+		grant_types: ["authorization_code", "refresh_token"],
+		response_types: ["code"],
+		token_endpoint_auth_method: "none"
+	};
+}
+
+/**
+ * The public origin the browser used to reach the UI, so the callback lands on
+ * the same host the user actually browses (a reverse proxy may front the
+ * loopback listener).
+ * @param req - incoming HTTP request.
+ * @param fallback - origin to use when the request carries no usable Host.
+ * @returns the origin, without a trailing slash.
+ */
+export function redirectBaseFrom(req, fallback) {
+	const forwardedProto = headerValue(req, "x-forwarded-proto");
+	const forwardedHost = headerValue(req, "x-forwarded-host");
+	const proto = (forwardedProto ?? (req.socket?.encrypted ? "https" : "http")).split(",")[0].trim();
+	const rawHost = forwardedHost ?? headerValue(req, "host");
+	const host = rawHost === undefined ? undefined : rawHost.split(",")[0].trim();
+	const base = host === undefined ? fallback : `${proto}://${host}`;
+	return { proto, base: base.replace(/\/+$/, "") };
+}
+
+/** Read one header as a trimmed string. */
+function headerValue(req, name) {
+	const value = req.headers?.[name];
+	if (typeof value === "string" && value.trim() !== "") return value.trim();
+	return undefined;
+}
+
+/** OAuth storage section of one connection record, created on demand. */
+function section(record) {
+	record.auth = record.auth ?? {};
+	record.auth.oauth = record.auth.oauth ?? {};
+	return record.auth.oauth;
+}
+
+/**
+ * `OAuthClientProvider` over a connection record.
+ */
+export class RecordOAuthProvider {
+	/**
+	 * @param record - connection record mutated in place.
+	 * @param persist - async callback saving the record.
+	 * @param options - scopes and the browser origin for the callback.
+	 */
+	constructor(record, persist, options) {
+		this.record = record;
+		this.persist = persist;
+		this.options = options;
+	}
+
+	/** CIMD mode: the metadata document URL is the client id (HTTPS only). */
+	get clientMetadataUrl() {
+		if (this.options.clientMode !== "cimd") return undefined;
+		const base = this.options.redirectBase ?? "";
+		return /^https:/i.test(base) ? base + CLIENT_METADATA_PATH : undefined;
+	}
+
+	/** Pre-registered client id, when the server does not support registration. */
+	configuredClientId() {
+		const value = this.options.clientId;
+		return typeof value === "string" && value.trim() !== "" ? value.trim() : undefined;
+	}
+
+	/** Where the authorization server sends the browser back. */
+	get redirectUrl() {
+		return this.options.redirectBase + CALLBACK_PATH;
+	}
+
+	/** What this client tells the authorization server about itself. */
+	get clientMetadata() {
+		const metadata = {
+			client_name: "DSH 连接应用",
+			redirect_uris: [this.redirectUrl],
+			grant_types: ["authorization_code", "refresh_token"],
+			response_types: ["code"],
+			token_endpoint_auth_method: this.options.clientSecret ? "client_secret_basic" : "none"
+		};
+		const scope = this.options.scopes;
+		if (typeof scope === "string" && scope.trim() !== "") metadata.scope = scope.trim();
+		return metadata;
+	}
+
+	/** Fresh CSRF state for one authorization request. */
+	state() {
+		const value = randomBytes(16).toString("hex");
+		section(this.record).state = value;
+		return value;
+	}
+
+	/** Recorded CSRF state, for the callback to compare against. */
+	storedState() {
+		return section(this.record).state;
+	}
+
+	/** Registered client information; a configured client id wins over registration. */
+	clientInformation() {
+		const configured = this.configuredClientId();
+		if (configured !== undefined) {
+			const secret = typeof this.options.clientSecret === "string" ? this.options.clientSecret : "";
+			return secret === "" ? { client_id: configured } : { client_id: configured, client_secret: secret };
+		}
+		return section(this.record).clientInformation;
+	}
+
+	/** Persist the client registration. */
+	async saveClientInformation(clientInformation) {
+		section(this.record).clientInformation = clientInformation;
+		await this.persist();
+	}
+
+	/** Current tokens, if any. */
+	tokens() {
+		return section(this.record).tokens;
+	}
+
+	/** Persist fresh tokens (also used by the SDK's refresh path). */
+	async saveTokens(tokens) {
+		section(this.record).tokens = tokens;
+		await this.persist();
+	}
+
+	/** Remember the URL the browser must visit, so the page can open it. */
+	async redirectToAuthorization(url) {
+		section(this.record).authorizationUrl = String(url);
+		await this.persist();
+	}
+
+	/** PKCE verifier saved before the redirect. */
+	codeVerifier() {
+		return section(this.record).codeVerifier;
+	}
+
+	/** Persist the PKCE verifier. */
+	async saveCodeVerifier(verifier) {
+		section(this.record).codeVerifier = verifier;
+		await this.persist();
+	}
+
+	/** SEP-2352 discovery state: binds the callback leg to the discovered server. */
+	discoveryState() {
+		return section(this.record).discoveryState;
+	}
+
+	/** Persist the discovery state alongside the PKCE verifier. */
+	async saveDiscoveryState(state) {
+		section(this.record).discoveryState = state;
+		await this.persist();
+	}
+
+	/** Authorization server identity, replayed on reconnect. */
+	authorizationServerUrl() {
+		return section(this.record).authorizationServerUrl;
+	}
+
+	/** Persist the authorization server URL. */
+	async saveAuthorizationServerUrl(url) {
+		section(this.record).authorizationServerUrl = url;
+		await this.persist();
+	}
+
+	/** Drop stored credentials; `all` also forgets the client registration. */
+	async invalidateCredentials(scope) {
+		const oauth = section(this.record);
+		if (scope === "all" || scope === "client") {
+			delete oauth.clientInformation;
+			delete oauth.authorizationServerUrl;
+		}
+		if (scope === "all" || scope === "tokens") {
+			delete oauth.tokens;
+			delete oauth.authorizationUrl;
+		}
+		if (scope === "all" || scope === "verifier") delete oauth.codeVerifier;
+		if (scope === "all" || scope === "discovery") delete oauth.discoveryState;
+		await this.persist();
+	}
+
+	/** Whether a token is stored (and not expired by the record's own clock). */
+	authorized() {
+		const tokens = section(this.record).tokens;
+		return tokens !== undefined && (tokens.refresh_token !== undefined || tokens.access_token !== undefined);
+	}
+
+	/** Page-facing summary; no secret values. */
+	summary() {
+		const oauth = section(this.record);
+		const tokens = oauth.tokens;
+		const expiresAt = typeof tokens?.expires_in === "number" && typeof oauth.obtainedAt === "number" ? oauth.obtainedAt + tokens.expires_in * 1000 : undefined;
+		return {
+			mode: "oauth",
+			authorized: this.authorized(),
+			scopes: this.options.scopes ?? "",
+			expiresAt: expiresAt ?? null,
+			hasClientRegistration: oauth.clientInformation !== undefined || this.configuredClientId() !== undefined,
+			clientMode: this.options.clientMode ?? "auto",
+			clientId: this.configuredClientId() ?? "",
+			authorizationUrl: typeof oauth.authorizationUrl === "string" ? oauth.authorizationUrl : "",
+			redirectUrl: this.redirectUrl
+		};
+	}
+}
+
+/** Clear the OAuth section of a record (used by 清除授权). */
+export function clearOAuth(record) {
+	if (record.auth === undefined) return;
+	delete record.auth.oauth;
+}

package/package.json

@@ -1,6 +1,85 @@
 {
   "name": "dsh-plugin-mcp-apps",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.5.7",
+  "description": "通用 MCP 连接器 + MCP Apps 工作台：连接应用页管理 MCP 服务器（HTTP/SSE/stdio、API/OAuth 2.0/CIMD 鉴权、启停），带 ui:// 资源的工具在右侧工作台渲染",
+  "type": "module",
+  "main": "lib/index.js",
+  "exports": {
+    ".": {
+      "default": "./lib/index.js"
+    },
+    "./client": {
+      "default": "./lib/client.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "cordis.patch.yml",
+    "lib/auth.js",
+    "lib/client.js",
+    "lib/index.js",
+    "lib/oauth.js",
+    "scripts/install-remote.sh"
+  ],
+  "license": "MIT",
+  "author": "xiaoqin422",
+  "keywords": [
+    "connector",
+    "dsh",
+    "dsh-plugin",
+    "mcp",
+    "mcp-apps",
+    "mcp-client",
+    "oauth",
+    "workbench"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "~4.0.5",
+    "react": "^18.2.0",
+    "@modelcontextprotocol/client": "^2.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@deepseek-ai/cordis": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    },
+    "@modelcontextprotocol/client": {
+      "optional": true
+    }
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "client": {
+      "inject": [
+        "@deepseek-ai/dsh-client-ui-tool",
+        "@deepseek-ai/dsh-client-ui-sidebar-right"
+      ],
+      "platform": "web"
+    },
+    "compatibility": {
+      "dshReleases": {
+        "0.2.1-rc.2": "compatible"
+      }
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xiaoqin422/dsh-plugin-mcp-apps.git"
+  },
+  "homepage": "https://github.com/xiaoqin422/dsh-plugin-mcp-apps#readme",
+  "bugs": {
+    "url": "https://github.com/xiaoqin422/dsh-plugin-mcp-apps/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/scripts/install-remote.sh

@@ -0,0 +1,50 @@
+#!/bin/sh
+# Install dsh-plugin-mcp-apps on another machine, from npm, a git URL or a tarball.
+#
+#   sh scripts/install-remote.sh                            # npm, profile web
+#   sh scripts/install-remote.sh dsh-plugin-mcp-apps web
+#   sh scripts/install-remote.sh https://github.com/xiaoqin422/dsh-plugin-mcp-apps web
+#   sh scripts/install-remote.sh ./dsh-plugin-mcp-apps-0.5.6.tgz web
+#
+# Needs a DSH install (`dsh` on PATH). Does the same three things as
+# scripts/install.sh: pnpm add through the official forwarder, register the
+# bundle in `dsh.profile.bundles`, and drop a legacy hand-written insert so the
+# plugin cannot be composed twice. Restart dsh yourself afterwards.
+set -eu
+
+SPEC=${1:-dsh-plugin-mcp-apps}
+PROFILE=${2:-${DSH_PROFILE:-web}}
+DSH_HOME=${DSH_HOME:-/data}
+PROFILE_DIR="$DSH_HOME/profiles/$PROFILE"
+PKG=dsh-plugin-mcp-apps
+
+command -v dsh >/dev/null 2>&1 || { echo "dsh is not on PATH: install DSH first" >&2; exit 2; }
+if [ ! -f "$PROFILE_DIR/package.json" ]; then
+	echo "==> initializing profile '$PROFILE'"
+	dsh plugin --profile "$PROFILE" --help >/dev/null 2>&1 || true
+fi
+[ -f "$PROFILE_DIR/package.json" ] || { echo "profile '$PROFILE' could not be initialized at $PROFILE_DIR" >&2; exit 2; }
+
+STAMP=$(date +%Y%m%d-%H%M%S)
+cp -a "$PROFILE_DIR/package.json" "$PROFILE_DIR/package.json.bak-$STAMP"
+
+echo "==> dsh plugin --profile $PROFILE add $SPEC"
+dsh plugin --profile "$PROFILE" add "$SPEC"
+
+echo "==> register $PKG in dsh.profile.bundles"
+node - "$PROFILE_DIR/package.json" "$PKG" <<'NODE'
+const fs = require("fs");
+const [file, name] = process.argv.slice(2);
+const data = JSON.parse(fs.readFileSync(file, "utf8"));
+data.dsh = data.dsh || {};
+data.dsh.profile = data.dsh.profile || {};
+if (!Array.isArray(data.dsh.profile.bundles)) data.dsh.profile.bundles = [];
+if (!data.dsh.profile.bundles.includes(name)) data.dsh.profile.bundles.push(name);
+fs.writeFileSync(file, JSON.stringify(data, null, 2) + "\n");
+NODE
+
+echo
+echo "installed into profile '$PROFILE'. restart dsh to load it:"
+echo "  docker restart dsh     # or however this host runs dsh"
+echo "  then hard-reload the browser page"
+echo "backup: $PROFILE_DIR/package.json.bak-$STAMP"