dsh-mobile 0.5.1 → 0.5.3

package/lib/index.mjs

@@ -6120,13 +6120,51 @@ function tomlString(value) {
 	return JSON.stringify(value);
 }
 /**
+* Legacy proxy name, kept only as the default of {@link createFrpcToml}.
+*
+* A shared frps accepts one proxy per name across *all* its clients, so a fixed
+* name let any other DSH installation — or a not yet reaped session of this one —
+* own `dsh-mobile` first. frpc then logged `start error: proxy name [dsh-mobile]
+* is already in use`, kept running without publishing the entry port, and the
+* start-up self-check ended in `frp_start_timeout` ("the public endpoint did not
+* become ready"). Product callers therefore pass an installation-derived name
+* from {@link frpProxyName}; this constant only keeps the exported API and the
+* byte-for-byte compatibility test working for legacy callers.
+*/
+const FRP_DEFAULT_PROXY_NAME = "dsh-mobile";
+/**
+* Validate a proxy name for the generated frpc configuration.
+*
+* frps accepts one proxy per name on the whole server, so the name must be a
+* single safe token: no whitespace, no quotes, no path or bracket characters.
+*/
+function validateFrpProxyName(value) {
+	if (typeof value !== "string" || value.length < 1 || value.length > 128 || !/^[A-Za-z0-9._-]+$/u.test(value)) throw new Error("frp_proxy_name_invalid");
+	return value;
+}
+/**
+* Proxy name for one DSH installation.
+*
+* Derived from the stable installation identity so two computers sharing one
+* frps never register the same proxy, while a single installation keeps the
+* same name across restarts (so its own stale registration is the only possible
+* conflict, and that one expires with the frps heartbeat).
+*/
+function frpProxyName(instanceId) {
+	if (typeof instanceId !== "string" || !/^[a-f0-9]{64}$/u.test(instanceId)) throw new Error("frp_instance_id_invalid");
+	return `${FRP_DEFAULT_PROXY_NAME}-${instanceId.slice(0, 12)}`;
+}
+/**
 * Build the single-purpose frpc configuration for the current loopback gateway.
 *
 * The default (public-CA) entry is an HTTP vhost behind Caddy and is emitted byte
 * for byte as before. The self-signed entry cannot use a vhost at all: frps only
 * forwards raw TCP, and the gateway terminates TLS on that connection.
+*
+* `proxyName` defaults to the legacy fixed name only for legacy callers; the
+* provider and the attach preview always pass {@link frpProxyName}.
 */
-function createFrpcToml(settings, localPort) {
+function createFrpcToml(settings, localPort, proxyName = FRP_DEFAULT_PROXY_NAME) {
 	if (!Number.isSafeInteger(localPort) || localPort < 1 || localPort > 65535) throw new Error("frp_local_port_invalid");
 	const header = [
 		`serverAddr = ${tomlString(settings.serverAddress)}`,
@@ -6136,7 +6174,7 @@ function createFrpcToml(settings, localPort) {
 		"transport.tls.enable = true",
 		"",
 		"[[proxies]]",
-		"name = \"dsh-mobile\""
+		`name = ${tomlString(validateFrpProxyName(proxyName))}`
 	];
 	if (isFrpSelfSignedIngress(settings)) return [
 		...header,
@@ -6198,13 +6236,22 @@ var FrpConfigStore = class {
 	stateRoot;
 	settingsFile;
 	runtimeConfigFile;
+	/**
+	* Proxy name every generated frpc.toml registers.
+	*
+	* Injected by the composing plugin ({@link frpProxyName}) so one frps can
+	* serve several DSH installations; the legacy fixed name stays the default
+	* for direct constructions in tests and for the exported API.
+	*/
+	proxyName;
 	settingsValue;
 	errorCode;
-	constructor(stateDirectory) {
+	constructor(stateDirectory, proxyName = FRP_DEFAULT_PROXY_NAME) {
 		if (!isAbsolute(stateDirectory)) throw new Error("frp config state directory must be absolute");
 		this.stateRoot = resolve(stateDirectory);
 		this.settingsFile = join(this.stateRoot, "settings.json");
 		this.runtimeConfigFile = join(this.stateRoot, "frpc.toml");
+		this.proxyName = validateFrpProxyName(proxyName);
 	}
 	/** Load private settings while rejecting links, oversized files, and unknown fields. */
 	async initialize() {
@@ -6248,6 +6295,7 @@ var FrpConfigStore = class {
 			},
 			vhostHttpPort: settings === void 0 ? FRP_VHOST_HTTP_PORT : resolveFrpVhostHttpPort(settings),
 			storagePath: this.stateRoot,
+			proxyName: this.proxyName,
 			...this.errorCode === void 0 ? {} : { errorCode: this.errorCode },
 			...mode === void 0 || mode === "deploy" ? {} : { mode },
 			...entryTls === void 0 || entryTls === "public-ip-cert" ? {} : { entryTls },
@@ -6271,7 +6319,7 @@ var FrpConfigStore = class {
 	async writeRuntimeConfig(localPort) {
 		const settings = this.settingsValue;
 		if (settings === void 0) throw new Error("frp_config_missing");
-		await atomicPrivateWrite$2(this.runtimeConfigFile, createFrpcToml(settings, localPort));
+		await atomicPrivateWrite$2(this.runtimeConfigFile, createFrpcToml(settings, localPort, this.proxyName));
 		return this.runtimeConfigFile;
 	}
 	/** Remove only configuration files owned by the FRP provider. */
@@ -6330,7 +6378,7 @@ function redactFrpcTomlToken(frpcToml) {
 * the provider writes stays byte-for-byte identical to the upstream output.
 */
 function createFrpAttachFrpcToml(settings, options = {}) {
-	const frpcToml = createFrpcToml(settings, attachLocalPort(options));
+	const frpcToml = createFrpcToml(settings, attachLocalPort(options), options.proxyName ?? "dsh-mobile");
 	return options.revealToken === true ? frpcToml : redactFrpcTomlToken(frpcToml);
 }
 const DEFAULT_ATTACH_CONFIG_FILE = "<DSH Mobile 私有目录>/remote/frp/config/frpc.toml";
@@ -7522,6 +7570,30 @@ const DISCOVERY_RETRY_MS = 1e3;
 const MAX_DISCOVERY_BYTES = 16384;
 const VHOST_PROBE_TIMEOUT_MS = 1500;
 const INGRESS_CERT_CHECK_MS = 432e5;
+/**
+* frpc start-failure signatures, most specific first.
+*
+* frpc reports a refused proxy registration as a warning and keeps running, so
+* without this mapping the controller only ever saw a healthy child process and
+* an entry port nobody published: the start-up self-check burned its full 45s
+* deadline and reported `frp_start_timeout` ("the public endpoint did not become
+* ready"), which sent users looking at DNS, Caddy, and firewalls.
+*
+* The two real conflicts are a proxy name another client of the same frps holds
+* and an entry port another proxy already owns. Both are reported directly.
+*/
+const CLIENT_FAILURE_CODES = Object.freeze([
+	[/proxy name \[[^\]]*\] is already in use/iu, "frp_proxy_name_in_use"],
+	[/(?:remote )?port (?:\[?[0-9]+\]? )?already (?:used|in use)/iu, "frp_remote_port_in_use"],
+	[/start error:/iu, "frp_proxy_start_failed"]
+]);
+/**
+* Stable error code for a chunk of frpc output, or undefined when it reports no
+* start failure. Exported for the conflict tests.
+*/
+function frpcDiagnosisCode(output) {
+	return CLIENT_FAILURE_CODES.find(([pattern]) => pattern.test(output))?.[1];
+}
 function publicStatus$3(status) {
 	return Object.freeze({
 		enabled: status.enabled,
@@ -7923,15 +7995,37 @@ var FrpController = class {
 			return;
 		}
 		this.child = child;
+		const pending = {
+			stdout: "",
+			stderr: ""
+		};
+		let diagnosed = false;
+		const inspectLine = (line) => {
+			if (diagnosed) return;
+			const code = frpcDiagnosisCode(line);
+			if (code === void 0) return;
+			diagnosed = true;
+			this.enqueue(() => this.failGeneration(generation, code));
+		};
+		const inspect = (stream, chunk) => {
+			if (diagnosed) return;
+			const lines = (pending[stream] + String(chunk)).split(/\r\n|\r|\n/u);
+			pending[stream] = (lines.pop() ?? "").slice(-8192);
+			for (const line of lines) inspectLine(line.slice(-8192));
+		};
+		child.stdout.on("data", (chunk) => inspect("stdout", chunk));
+		child.stderr.on("data", (chunk) => inspect("stderr", chunk));
 		child.stdout.resume();
 		child.stderr.resume();
 		child.once("error", () => {
 			this.enqueue(() => this.failGeneration(generation, "frp_launch_failed"));
 		});
 		child.once("close", (code) => {
+			inspectLine(pending.stdout);
+			inspectLine(pending.stderr);
 			if (generation !== this.generation || this.child !== child) return;
 			this.child = void 0;
-			if (this.enabled) this.enqueue(() => this.failGeneration(generation, code === 0 ? "frp_stopped" : "frp_exited"));
+			if (this.enabled && !diagnosed) this.enqueue(() => this.failGeneration(generation, code === 0 ? "frp_stopped" : "frp_exited"));
 		});
 		this.publish({
 			enabled: true,
@@ -7947,6 +8041,7 @@ var FrpController = class {
 			return;
 		}
 		if (generation !== this.generation || !this.enabled) return;
+		if (diagnosed) return;
 		const controller = new AbortController();
 		this.startupAbort = controller;
 		this.waitForDiscovery(generation, check, gateway.config.instanceId, settings, gateway, controller.signal);
@@ -9571,6 +9666,9 @@ const REMOTE_ERROR_GUIDANCE = Object.freeze({
 	frp_vhost_probe_failed: "确认 VPS 地址可解析后重新连接。",
 	frp_launch_failed: "重新安装 FRP 官方组件后重试。",
 	frp_start_timeout: "确认 frps、Caddy 和域名解析正常后重新连接。",
+	frp_proxy_name_in_use: "该 frps 上已有同名代理：在另一台 DSH 电脑上关闭自建 FRP，或在 frps 上清掉该代理后重新连接。",
+	frp_remote_port_in_use: "公网入口端口被其他代理占用：改用其他入口端口后重新连接。",
+	frp_proxy_start_failed: "查看 frps 日志与 allowPorts，确认它能接受该代理名和入口端口。",
 	frp_discovery_mismatch: "公开域名连接到了另一台电脑，请核对 Caddy 与 frps 配置。",
 	frp_discovery_invalid: "公开域名返回了非 DSH Mobile 响应。",
 	frp_stopped: "点击“重新连接”。",
@@ -12669,6 +12767,36 @@ async function installMobileFileLogger(ctx, stateDirectory) {
 	return file;
 }
 //#endregion
+//#region src/installation-id.ts
+const INSTALLATION_ID_PATTERN = /^[a-f0-9]{64}\n$/u;
+const INSTALLATION_ID_BYTES = 65;
+async function readInstallationId(file) {
+	const entry = await lstat(file);
+	if (!entry.isFile() || entry.isSymbolicLink() || entry.size !== INSTALLATION_ID_BYTES) throw new Error("installation_id_invalid");
+	const contents = await readFile(file, "utf8");
+	if (!INSTALLATION_ID_PATTERN.test(contents)) throw new Error("installation_id_invalid");
+	await restrictPrivateFile(file);
+	return contents.slice(0, -1);
+}
+/** Keep one random plugin identity across setup changes, restarts, and FRP resets. */
+async function loadOrCreateInstallationId(file) {
+	if (!isAbsolute(file)) throw new Error("installation ID path must be absolute");
+	const target = resolve(file);
+	await mkdir(dirname(target), {
+		recursive: true,
+		mode: 448
+	});
+	try {
+		await writeFile(target, `${randomBytes(32).toString("hex")}\n`, {
+			flag: "wx",
+			mode: 384
+		});
+	} catch (error) {
+		if (error.code !== "EEXIST") throw error;
+	}
+	return readInstallationId(target);
+}
+//#endregion
 //#region src/lan-setup.ts
 const FIREWALL_TCP_RULE = "DSH Mobile HTTPS";
 const FIREWALL_UDP_RULE = "DSH Mobile Discovery";
@@ -13066,7 +13194,8 @@ async function apply(ctx, config) {
 	await cloudflaredComponent.initialize();
 	const frpComponent = new FrpComponentManager({ stateDirectory });
 	await frpComponent.initialize();
-	const frpConfig = new FrpConfigStore(join(remoteDirectory, "frp", "config"));
+	const frpIdentity = await loadOrCreateInstallationId(join(stateDirectory, "installation-id"));
+	const frpConfig = new FrpConfigStore(join(remoteDirectory, "frp", "config"), frpProxyName(frpIdentity));
 	await frpConfig.initialize();
 	const originConfig = new OriginConfigStore(join(remoteDirectory, "origin", "config"));
 	await originConfig.initialize();
@@ -13544,7 +13673,10 @@ async function apply(ctx, config) {
 				}
 				if (request.method === "POST" && target.decodedPathname === `/api/mobile-access/remote/frp/attach-plan`) {
 					const settings = mergeSavedFrpSettings(await readJsonObject(request, 8192), frpConfig.settings());
-					const options = { configFile: frpConfig.runtimeConfigFile };
+					const options = {
+						configFile: frpConfig.runtimeConfigFile,
+						proxyName: frpConfig.proxyName
+					};
 					logger.info("frp attach plan requested mode=%s entryTls=%s vhostHttpPort=%d", settings.mode ?? "deploy", settings.entryTls ?? "public-ip-cert", resolveFrpVhostHttpPort(settings));
 					sendJson(response, 200, {
 						...remotePayload(),
@@ -13814,6 +13946,6 @@ async function apply(ctx, config) {
 	}, "dsh-mobile: independent LAN and selectable remote providers with /mobile command");
 }
 //#endregion
-export { AUTH_PREFIX, AccessController, AccessError, BlockedUpgradePathLog, BoundedRateLimiter, CERT_EXPIRING_DAYS, CLOUDFLARED_COMPONENT_RELEASE, CSRF_COOKIE, CSRF_HEADER, CloudflaredComponentManager, CloudflaredController, CloudflaredTunnelStore, Config, DEFAULT_ORIGIN_LISTEN_PORT, FRP_VHOST_HTTP_PORT as DEFAULT_VHOST_HTTP_PORT, FRP_VHOST_HTTP_PORT, DEVICE_COOKIE, EXTENSION_LIMITS, FRP_ATTACH_DISCOVERY_PATH, FRP_ATTACH_LOCAL_DECLARATION, FRP_ATTACH_SELF_SIGNED_DECLARATION, FRP_ATTACH_VPS_DECLARATION, FRP_CADDY_IMPORT_LINE, FRP_CADDY_SNIPPET_MARKER, FRP_CADDY_SNIPPET_PATH, FRP_COMPONENT_RELEASES, FRP_DEFAULT_PUBLIC_PORT, FRP_RESERVED_PORTS, FrpComponentManager, FrpConfigStore, FrpController, JsonDeviceStore, JsonMobileAccessControlStore, JsonRemoteProviderStore, LOCAL_ADMIN_PREFIX, MAX_BLOCKED_UPGRADE_PATHS, MAX_EXTRA_WEBSOCKET_PATHS, MAX_WEBSOCKET_PATH_LENGTH, MemoryDeviceStore, MobileAccessGateway, MobileAccessGatewayController, MobileAccessService, MobileExtensionError, OriginConfigStore, OriginController, REMOTE_PROVIDERS, RequestTrustPolicy, SESSION_COOKIE, TASK_EVENT_DEBOUNCE_MS, TaskEventHub, WS_PATHS, WebSocketPathStore, addressAllowed, apply, assertExtensionId, configuredRemoteProvider, createCaddySite, createFrpAttachPlan, createFrpAttachTemplate, createFrpAttachTemplateParts, createFrpServerTemplate, createFrpcToml, createMobileAccessService, createRestrictedFrpServerTemplate, ensureFrpIngressCertificate, evaluateCertificateLifetime, frpAttachVpsParts, frpIngressPaths, frpIngressSelfCheck, inject, isCloudflaredRegistration, isFrpSelfSignedIngress, isGloballyRoutableIpv4, isLoopbackAddress, issueServerCertificate, mergeSavedCloudflaredTunnelSettings, mergeSavedFrpSettings, mergeSavedFrpTarget, name, normalizeWebSocketPaths, originGatewayConfig, parseAuthority, parseCidr, parseCloudflaredOrigin, parseCloudflaredTunnelSettings, parseControlFile, parseDeviceSnapshot, parseExtensionManifest, parseFrpSettings, parseGatewayConfig, parseMobileAccessControlState, parseOriginSettings, parseRemoteProviderState, probeOriginCertificate, readCertificateRenewal, resolveAuthority, resolveFrpEntryTls, resolveFrpMode, resolveFrpPublicPort, resolveFrpVhostHttpPort, rewriteMobileIndex, validateAttachSettings, validateCloudflaredTunnelHostname, validateCloudflaredTunnelPort, validateCloudflaredTunnelToken, validateFrpEntryTls, validateFrpMode, validateFrpPublicOrigin, validateFrpPublicPort, validateFrpServerAddress, validateFrpServerPort, validateFrpToken, validateFrpVhostHttpPort, validateOriginAllowedCidrs, validateOriginListenHost, validateOriginListenPort, validateOriginPublicOrigin, validateWebSocketPath, watchTaskCompletions };
+export { AUTH_PREFIX, AccessController, AccessError, BlockedUpgradePathLog, BoundedRateLimiter, CERT_EXPIRING_DAYS, CLOUDFLARED_COMPONENT_RELEASE, CSRF_COOKIE, CSRF_HEADER, CloudflaredComponentManager, CloudflaredController, CloudflaredTunnelStore, Config, DEFAULT_ORIGIN_LISTEN_PORT, FRP_VHOST_HTTP_PORT as DEFAULT_VHOST_HTTP_PORT, FRP_VHOST_HTTP_PORT, DEVICE_COOKIE, EXTENSION_LIMITS, FRP_ATTACH_DISCOVERY_PATH, FRP_ATTACH_LOCAL_DECLARATION, FRP_ATTACH_SELF_SIGNED_DECLARATION, FRP_ATTACH_VPS_DECLARATION, FRP_CADDY_IMPORT_LINE, FRP_CADDY_SNIPPET_MARKER, FRP_CADDY_SNIPPET_PATH, FRP_COMPONENT_RELEASES, FRP_DEFAULT_PROXY_NAME, FRP_DEFAULT_PUBLIC_PORT, FRP_RESERVED_PORTS, FrpComponentManager, FrpConfigStore, FrpController, JsonDeviceStore, JsonMobileAccessControlStore, JsonRemoteProviderStore, LOCAL_ADMIN_PREFIX, MAX_BLOCKED_UPGRADE_PATHS, MAX_EXTRA_WEBSOCKET_PATHS, MAX_WEBSOCKET_PATH_LENGTH, MemoryDeviceStore, MobileAccessGateway, MobileAccessGatewayController, MobileAccessService, MobileExtensionError, OriginConfigStore, OriginController, REMOTE_PROVIDERS, RequestTrustPolicy, SESSION_COOKIE, TASK_EVENT_DEBOUNCE_MS, TaskEventHub, WS_PATHS, WebSocketPathStore, addressAllowed, apply, assertExtensionId, configuredRemoteProvider, createCaddySite, createFrpAttachPlan, createFrpAttachTemplate, createFrpAttachTemplateParts, createFrpServerTemplate, createFrpcToml, createMobileAccessService, createRestrictedFrpServerTemplate, ensureFrpIngressCertificate, evaluateCertificateLifetime, frpAttachVpsParts, frpIngressPaths, frpIngressSelfCheck, frpProxyName, inject, isCloudflaredRegistration, isFrpSelfSignedIngress, isGloballyRoutableIpv4, isLoopbackAddress, issueServerCertificate, mergeSavedCloudflaredTunnelSettings, mergeSavedFrpSettings, mergeSavedFrpTarget, name, normalizeWebSocketPaths, originGatewayConfig, parseAuthority, parseCidr, parseCloudflaredOrigin, parseCloudflaredTunnelSettings, parseControlFile, parseDeviceSnapshot, parseExtensionManifest, parseFrpSettings, parseGatewayConfig, parseMobileAccessControlState, parseOriginSettings, parseRemoteProviderState, probeOriginCertificate, readCertificateRenewal, resolveAuthority, resolveFrpEntryTls, resolveFrpMode, resolveFrpPublicPort, resolveFrpVhostHttpPort, rewriteMobileIndex, validateAttachSettings, validateCloudflaredTunnelHostname, validateCloudflaredTunnelPort, validateCloudflaredTunnelToken, validateFrpEntryTls, validateFrpMode, validateFrpProxyName, validateFrpPublicOrigin, validateFrpPublicPort, validateFrpServerAddress, validateFrpServerPort, validateFrpToken, validateFrpVhostHttpPort, validateOriginAllowedCidrs, validateOriginListenHost, validateOriginListenPort, validateOriginPublicOrigin, validateWebSocketPath, watchTaskCompletions };
 
 //# sourceMappingURL=index.mjs.map