dsh-webui-oauth 0.7.0 → 0.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,86 @@
2
2
 
3
3
  本文件记录每个版本的**用户可见**变更。破坏性变更与升级动作单独标注。
4
4
 
5
+ ## 0.7.2
6
+
7
+ 合并上游(Yuuz12/dsh-webui-auth)0.3.5–0.3.7 中**可安全合并**的部分;
8
+ 宿主载体桥 / 桌面端锁因会绕过现有门禁,未合并。
9
+
10
+ ### 合并:DSH Desktop 标记透传(upstream 0.3.5 / #8)
11
+
12
+ - 新增 `lib/desktop-adapter.js`(自包含、可整体摘除);
13
+ - 渲染器加载时把 `dsh-desktop-*` 标记写入 HttpOnly Cookie(`dsh_wua_desktop`,12h);
14
+ - 之后落到干净 `/` 时 302 回带标记的 URL,修复桌面端 advanced/extended 模式下
15
+ 12 个 layout 依赖插件停在 pending 的问题。
16
+ - **不影响门禁**:`remember()` 在认证判定之前调用但只写 Cookie;`restore()` 只在
17
+ `checkRequest()` 通过之后调用。未登录请求带标记仍然去登录页。
18
+ - 已加 9 项集成断言(oidc-bind 1f)+ 24 项纯函数断言。
19
+
20
+ ### 合并:审计日志 null/boolean 不再被字符串化(upstream 0.3.6)
21
+
22
+ `auditLog` 原先把非 string/number 一律 `String()`,导致日志里出现字符串
23
+ `"null"` / `"true"`。现在 null 与 boolean 原样保留。
24
+
25
+ ### 合并:fallback 诊断增强(upstream 0.3.7)
26
+
27
+ 我们在 0.7.1 已独立修复 `{ resource }` 兼容;本次补上可观测性:
28
+
29
+ - `status` 新增 `fallback: 'handler' | 'resource' | 'absent' | 'unknown'`;
30
+ - 启动日志输出 `core fallback seat: handler/resource`,unknown 时 error;
31
+ - 形态不认识时输出**一次性**诊断,并返回带说明的 404(不再是空 body)。
32
+
33
+ ### 未合并(有意)
34
+
35
+ - **宿主载体桥(0.3.6 C6)**:其 `isLoopbackPeer()` 只看 socket 地址。
36
+ 本部署是 nginx 同机反代,所有请求的 socket 都是 127.0.0.1,等于"持有核心
37
+ Cookie 即可绕过插件会话/SSO",与「仅允许 SSO」直接冲突。
38
+ - **桌面端锁(0.3.6 C8)**:UI 级锁,对 Web 部署无价值。
39
+ - **exact 路由覆盖(0.3.6 C7)**:我们的 deny-by-default 已覆盖全部 exact
40
+ (实测 `/plugins/events` 匿名 401),无需合并。
41
+
42
+ ### 测试
43
+
44
+ - 新增 `test/desktop-marker.test.mjs`(24 项)、`test/audit-null.test.mjs`(7 项);
45
+ `test/fallback-shape.test.mjs` 增加 7 项形状判定;`test/oidc-bind.test.mjs`
46
+ 增加 9 项"桌面标记不影响门禁"集成断言。
47
+ - 全量 20 个测试文件、535 项断言通过。
48
+
49
+ ## 0.7.1
50
+
51
+ 兼容 dsh **0.2.2-rc.1**:`webServer.fallback` 从函数改成了 `{ resource }`。
52
+
53
+ ### 修复:访问 `/` 返回 500 空响应(nginx 日志 `500 0`)
54
+
55
+ - **现象**:升级到 dsh 0.2.2-rc.1 后,访问 `/` 在完成核心 token 交换后返回
56
+ `500`,body 为空;nginx 访问日志表现为 `500 0`。
57
+ - **原因**:0.2.2-rc.1 起 `webServer.fallback` 不再一定是函数——
58
+ `dsh-host-frontend-static` 注册的是 `{ resource }`(Fetch 风格
59
+ `resource(request, peer) -> Response`)。插件仍按 `await fallback(req, res)`
60
+ 调用,抛 `TypeError: fallback is not a function`,被外层 `catch` 兜成
61
+ `500` + 空 body。
62
+ - **修复**:新增 `serveFallback()` 统一分派三种形状:
63
+ 1. 函数(旧核心);
64
+ 2. `{ resource }` + `webServer.serveResource`(0.2.2-rc.1+);
65
+ 3. `{ handler }`(部分中间版本)。
66
+ 没有 fallback 时返回 `false`,由调用方 404——不再把"形状不匹配"误报成 500。
67
+
68
+ ### 安全:资源型 fallback 也必须上闸门
69
+
70
+ 此前 `wrapExistingFallback` 只处理 `typeof === 'function'`,遇到 `{ resource }`
71
+ 直接跳过,等于把兜底入口留给匿名请求。现在:
72
+
73
+ - `resource(request, peer)` 会被包装:从 Fetch Request 的 `cookie` 头取会话,
74
+ 未登录返回 `401 Response`,已登录原样放行;
75
+ - `registerFallback` 注册时的三种形状都会在注册那一刻上闸门;
76
+ - `undo` 会把 `resource` / `handler` 原样还原。
77
+
78
+ ### 测试
79
+
80
+ - 新增 `test/fallback-shape.test.mjs`(19 项):三种形状分派、无 fallback /
81
+ 未知形状 / 缺 `serveResource` 均不抛异常、资源型 fallback 的匿名拒绝与
82
+ 登录放行、`undo` 还原。
83
+ - 全量 18 个测试文件、488 项断言通过。
84
+
5
85
  ## 0.7.0
6
86
 
7
87
  新增**「仅允许 SSO」**开关;同时修复一个会把 OIDC 绑定悄悄弄丢的老问题。
package/README.en.md CHANGED
@@ -401,6 +401,15 @@ wired into `npm test`).
401
401
 
402
402
  ## Known limits
403
403
 
404
+ - **DSH Desktop**: `dsh-desktop-*` marker pass-through is supported (markers survive login and
405
+ re-login), but upstream 0.3.6's **host carrier bridge is intentionally not included**. That bridge
406
+ decides "loopback" purely from the socket address, and this deployment sits behind an nginx proxy on
407
+ the same host — every request's socket is `127.0.0.1`, so enabling it would mean "a core cookie is
408
+ enough to bypass the plugin session / SSO", which conflicts with the SSO-only policy. If you must use
409
+ DSH Desktop's shell-direct mode, use the upstream plugin and evaluate that bypass yourself.
410
+ - **Audit field types**: since 0.7.2 `null` and booleans are written as-is (no longer stringified to
411
+ `"null"` / `"true"`); any log consumer that assumed every field is a string must be adjusted.
412
+ - **Fallback shape on dsh 0.2.2-rc.1**: since that version `webServer.fallback` may be `{ resource }` (that is how `dsh-host-frontend-static` registers it) instead of a function. The plugin now handles function / `{ resource }` / `{ handler }`; a resource fallback is gated as well. If `/` returns an empty `500` after upgrading (nginx logs `500 0`), make sure the plugin is ≥ 0.7.1.
404
413
  - **Inherent runtime-wrapping window**: between a route-object replacement (service hot-reload) and the next rescan (≤10s) there is an unprotected window; the fail-closed check on enabling covers the "initially exposed" case, so this window only affects hot-reload during runtime.
405
414
  - **WebSocket and `trustedHosts`**: in reverse-proxy / LAN deployments (non-loopback Host), WS downlinks need the public hostname added to `client-connection.trustedHosts` in the DSH config (see "Architecture").
406
415
  - **Proxy on a different host**: if the reverse proxy is not on the same machine as DSH (non-loopback peer), the proxy headers are not trusted and rate limiting aggregates per proxy IP (degrades to a global bucket).
package/README.md CHANGED
@@ -411,6 +411,9 @@ IdP 侧日志确认完整往返:`discovery → jwks → authorize(issued code)
411
411
 
412
412
  ## 已知边界
413
413
 
414
+ - **DSH Desktop**:支持 `dsh-desktop-*` 标记透传(登录 / 退出后重登不再丢失标记),但**不提供**上游 0.3.6 的「宿主载体桥」。该桥只用 socket 是否回环来判定,而本部署是 nginx 同机反代——所有请求的 socket 都是 `127.0.0.1`,启用它等于"持有核心 Cookie 即可绕过插件会话 / SSO",与「仅允许 SSO」冲突。若必须使用 DSH Desktop 的 shell 直连模式,请改用上游原版插件,并自行评估该旁路风险。
415
+ - **审计日志字段类型**:0.7.2 起 `null` 与 boolean 原样写入(不再变成字符串 `"null"` / `"true"`);旧日志解析代码若假设"所有字段都是字符串",需相应调整。
416
+ - **dsh 0.2.2-rc.1 的 fallback 形状**:该版本起 `webServer.fallback` 可能是 `{ resource }`(`dsh-host-frontend-static` 就是这样注册的),而不再是函数。插件已兼容函数 / `{ resource }` / `{ handler }` 三种形状;资源型 fallback 同样会被闸门包装。若升级后 `/` 返回 `500` 且 body 为空(nginx 日志 `500 0`),请确认插件版本 ≥ 0.7.1。
414
417
  - **运行时包装的固有窗口**:路由对象被替换(服务热重载)到下一次重扫之间(≤10s)存在未保护窗口;启用认证时的 fail-closed 已挡住「初始裸奔」,此窗口仅影响运行中的热重载场景。
415
418
  - **WS 与 trustedHosts**:反代/局域网(非回环 Host)下,WS 下行需在 dsh 配置 `client-connection.trustedHosts` 中加入对外域名(见「架构」节)。
416
419
  - **反代不同机**:若反代与 DSH 不在同一台机器(对端非回环),代理头不被信任,限流将按代理 IP 聚合(退化为全局桶)。
package/index.js CHANGED
@@ -157,6 +157,9 @@ import { readFileSync, writeFileSync, appendFileSync, accessSync, mkdirSync, unl
157
157
  import { fileURLToPath } from "node:url";
158
158
  import { resolve as resolvePath } from "node:path";
159
159
  import { promisify } from "node:util";
160
+ // 宿主适配层(DSH Desktop 的 dsh-desktop-* 标记透传)。
161
+ // 整体摘除:删掉本行 + 网关里两处标着「宿主适配层」的代码块 + lib/desktop-adapter.js。
162
+ import { desktopAdapter } from './lib/desktop-adapter.js';
160
163
 
161
164
  export const name = 'dsh-webui-oauth'
162
165
 
@@ -580,7 +583,11 @@ async function auditLog(ctx, event, fields) {
580
583
  let v = fields[key]
581
584
  if (v === undefined) continue
582
585
  if (key === 'ip' && typeof v === 'string') v = anonymizeIp(v)
583
- entry[key] = typeof v === 'string' || typeof v === 'number' ? v : String(v)
586
+ // null / boolean 原样保留:早先一律 String(),日志里会出现字符串 "null"、
587
+ // "true",读起来像出了故障(upstream 0.3.6 的同类修复)。
588
+ entry[key] = (v === null || typeof v === 'string' || typeof v === 'number' || typeof v === 'boolean')
589
+ ? v
590
+ : String(v)
584
591
  }
585
592
  appendFileSync(target, JSON.stringify(entry) + '\n', 'utf8')
586
593
  } catch (e) {
@@ -1154,6 +1161,97 @@ function wantsHtml(req) {
1154
1161
  }
1155
1162
  }
1156
1163
 
1164
+ /**
1165
+ * 把请求交给 webServer 的 fallback。
1166
+ *
1167
+ * 0.2.2-rc.1 起 fallback 不再一定是函数:dsh-host-frontend-static 注册的是
1168
+ * `{ resource }`(Fetch 风格的 `resource(request, peer) -> Response`)。
1169
+ * 旧代码直接 `await fallback(req, res)` 会抛 TypeError(fallback is not a function),
1170
+ * 被外层 catch 兜成 `500` + 空 body——nginx 访问日志里就是 `500 0`。
1171
+ *
1172
+ * 这里统一三种形状:
1173
+ * 1. 函数(旧核心 / 第三方 handler);
1174
+ * 2. `{ resource }` + webServer.serveResource(0.2.2-rc.1+);
1175
+ * 3. `{ handler }`(部分中间版本)。
1176
+ *
1177
+ * @returns {Promise<boolean>} 是否已由 fallback 处理;false 表示没有 fallback,
1178
+ * 调用方应自行返回 404(不要把"没有 fallback"误报成 500)。
1179
+ */
1180
+ export async function serveFallback(ctx, req, res) {
1181
+ const ws = ctx && ctx.webServer
1182
+ if (!ws) return false
1183
+ const fallback = ws.fallback
1184
+ if (typeof fallback === 'function') {
1185
+ await fallback(req, res)
1186
+ return true
1187
+ }
1188
+ if (fallback && typeof fallback.resource === 'function' && typeof ws.serveResource === 'function') {
1189
+ await ws.serveResource(req, res, new URL(req.url || '/', 'http://x'), fallback.resource)
1190
+ return true
1191
+ }
1192
+ if (fallback && typeof fallback.handler === 'function') {
1193
+ await fallback.handler(req, res)
1194
+ return true
1195
+ }
1196
+ return false
1197
+ }
1198
+
1199
+ /**
1200
+ * 判断核心兜底席位的形状。
1201
+ * 核心升级可能再次改变它(函数 → { resource } → ?),把形状单独抽出来,
1202
+ * 既供 status 回显,也供启动自检与一次性诊断使用。
1203
+ *
1204
+ * @returns {'absent'|'handler'|'resource'|'unknown'}
1205
+ */
1206
+ export function fallbackShape(webServer) {
1207
+ if (!webServer) return 'absent'
1208
+ const fallback = webServer.fallback
1209
+ if (fallback === undefined) return 'absent'
1210
+ if (typeof fallback === 'function') return 'handler'
1211
+ if (fallback !== null && typeof fallback === 'object' &&
1212
+ 'resource' in fallback && typeof webServer.serveResource === 'function') return 'resource'
1213
+ return 'unknown'
1214
+ }
1215
+
1216
+ // 形状不兼容只报一次:每个文档请求都刷一条 error 会把日志淹掉。
1217
+ let fallbackProblemReported = false
1218
+
1219
+ /**
1220
+ * 形态不认识时的一次性诊断:说清期望什么、实际是什么,别让 500/空 404 掩盖过去。
1221
+ * 仅写日志,不改变响应(响应由 sendFallbackUnavailable 负责)。
1222
+ */
1223
+ export function reportFallbackProblem(ctx) {
1224
+ if (fallbackProblemReported) return
1225
+ fallbackProblemReported = true
1226
+ try {
1227
+ const ws = ctx && ctx.webServer
1228
+ const fallback = ws ? ws.fallback : undefined
1229
+ const actual = fallback === undefined
1230
+ ? 'undefined'
1231
+ : typeof fallback === 'function'
1232
+ ? 'function'
1233
+ : (fallback !== null && typeof fallback === 'object')
1234
+ ? 'object { ' + Object.keys(fallback).join(', ') + ' }'
1235
+ : typeof fallback
1236
+ const canServe = !!(ws && typeof ws.serveResource === 'function')
1237
+ ctx.logger.error('[dsh-webui-oauth] INCOMPATIBLE CORE: cannot hand the document back to'
1238
+ + ' webServer.fallback — expected a handler function, or { resource } together with'
1239
+ + ' webServer.serveResource(); got ' + actual
1240
+ + ' (serveResource: ' + (canServe ? 'present' : 'missing') + ').'
1241
+ + ' webServer.fallback shape may have changed again; authenticated pages answer 404 until the plugin is updated.')
1242
+ } catch (e) { /* logging must never throw */ }
1243
+ }
1244
+
1245
+ /** 形态不认识时给操作者一句能看懂的话,而不是空白页/500。 */
1246
+ export function sendFallbackUnavailable(res) {
1247
+ res.writeHead(404, {
1248
+ 'content-type': 'text/plain; charset=utf-8',
1249
+ 'x-content-type-options': 'nosniff',
1250
+ 'cache-control': 'no-store',
1251
+ })
1252
+ res.end('dsh-webui-oauth: core webServer.fallback is unavailable or incompatible\n')
1253
+ }
1254
+
1157
1255
  function rejectUpgrade401(socket) {
1158
1256
  try {
1159
1257
  socket.write('HTTP/1.1 401 Unauthorized\r\nConnection: close\r\nContent-Length: 13\r\n\r\nunauthorized\n')
@@ -1373,7 +1471,12 @@ function installRouteGate(ctx, checkRequest, log, options) {
1373
1471
  // ---------------- fallback 也要包 ----------------
1374
1472
  // fallback 是"未被任何具名路由认领"的兜底处理器。它同样可能被第三方插件占据,
1375
1473
  // 若不管,攻击者只要找到一个不存在的路径就可能落到未鉴权的 fallback 上。
1376
- const wrappedFallbacks = new WeakSet()
1474
+ //
1475
+ // 0.2.2-rc.1 起 fallback 还可能是 { resource }(Fetch 风格):既不能当函数调用
1476
+ // (TypeError),也不能放任它绕过闸门。两种形状分别包装。
1477
+ const wrappedFallbacks = new WeakSet() // 原始 handler 函数
1478
+ const wrappedResources = new WeakSet() // 原始 resource 函数
1479
+
1377
1480
  const gateFallback = (handler) => {
1378
1481
  if (typeof handler !== 'function' || wrappedFallbacks.has(handler)) return handler
1379
1482
  const original = handler
@@ -1385,23 +1488,71 @@ function installRouteGate(ctx, checkRequest, log, options) {
1385
1488
  }
1386
1489
  return original(req, res)
1387
1490
  }
1388
- wrappedFallbacks.add(gated)
1491
+ wrappedFallbacks.add(original)
1389
1492
  fallbackWrapped = true
1390
1493
  log('wrapped fallback handler')
1391
1494
  return gated
1392
1495
  }
1393
1496
 
1394
- // 已经就位的 fallback:直接替换属性(保留原函数以便 undo)。
1497
+ const gateResource = (resource) => {
1498
+ if (typeof resource !== 'function' || wrappedResources.has(resource)) return resource
1499
+ const original = resource
1500
+ const gated = async (request, peer) => {
1501
+ // resource 收到的是 Fetch Request;checkRequest 只依赖 cookie 头。
1502
+ const cookie = request && request.headers && typeof request.headers.get === 'function'
1503
+ ? (request.headers.get('cookie') || '')
1504
+ : ''
1505
+ const headers = { cookie }
1506
+ if (!checkRequest({ method: request && request.method, url: request && request.url, headers })) {
1507
+ return new Response('unauthorized', {
1508
+ status: 401,
1509
+ headers: { 'content-type': 'text/plain; charset=utf-8' },
1510
+ })
1511
+ }
1512
+ return original(request, peer)
1513
+ }
1514
+ wrappedResources.add(original)
1515
+ fallbackWrapped = true
1516
+ log('wrapped fallback resource')
1517
+ return gated
1518
+ }
1519
+
1520
+ // 已经就位的 fallback:按形状替换(保留原值以便 undo)。
1395
1521
  const wrapExistingFallback = () => {
1396
1522
  const current = ws.fallback
1397
- if (typeof current !== 'function') return
1398
- if (wrappedFallbacks.has(current)) return
1399
- if (current.__dshWuaGated === true) return
1400
- const gated = gateFallback(current)
1401
- if (gated === current) return
1402
- gated.__dshWuaGated = true
1403
- ws.fallback = gated
1404
- undos.push(() => { if (ws.fallback === gated) ws.fallback = current })
1523
+ if (typeof current === 'function') {
1524
+ if (wrappedFallbacks.has(current)) return
1525
+ if (current.__dshWuaGated === true) return
1526
+ const gated = gateFallback(current)
1527
+ if (gated === current) return
1528
+ gated.__dshWuaGated = true
1529
+ ws.fallback = gated
1530
+ undos.push(() => { if (ws.fallback === gated) ws.fallback = current })
1531
+ return
1532
+ }
1533
+ if (current && typeof current === 'object') {
1534
+ if (typeof current.resource === 'function') {
1535
+ if (wrappedResources.has(current.resource)) { fallbackWrapped = true; return }
1536
+ if (current.resource.__dshWuaGated === true) return
1537
+ const original = current.resource
1538
+ const gated = gateResource(original)
1539
+ if (gated === original) return
1540
+ gated.__dshWuaGated = true
1541
+ current.resource = gated
1542
+ undos.push(() => { if (current.resource === gated) current.resource = original })
1543
+ return
1544
+ }
1545
+ if (typeof current.handler === 'function') {
1546
+ if (wrappedFallbacks.has(current.handler)) { fallbackWrapped = true; return }
1547
+ if (current.handler.__dshWuaGated === true) return
1548
+ const original = current.handler
1549
+ const gated = gateFallback(original)
1550
+ if (gated === original) return
1551
+ gated.__dshWuaGated = true
1552
+ current.handler = gated
1553
+ undos.push(() => { if (current.handler === gated) current.handler = original })
1554
+ }
1555
+ }
1405
1556
  }
1406
1557
 
1407
1558
  // ---------------- 注册时即拦截(消除重扫窗口) ----------------
@@ -1432,8 +1583,28 @@ function installRouteGate(ctx, checkRequest, log, options) {
1432
1583
  // registerFallback 走的是属性赋值而非 Map,单独接管。
1433
1584
  if (typeof ws.registerFallback === 'function') {
1434
1585
  const originalRegisterFallback = ws.registerFallback
1435
- ws.registerFallback = function patchedRegisterFallback (handler) {
1436
- return originalRegisterFallback.call(this, gateFallback(handler))
1586
+ ws.registerFallback = function patchedRegisterFallback (fallback) {
1587
+ // 三种形状都要上闸门:函数 / { resource } / { handler }。
1588
+ try {
1589
+ if (typeof fallback === 'function') {
1590
+ fallback = gateFallback(fallback)
1591
+ } else if (fallback && typeof fallback === 'object') {
1592
+ if (typeof fallback.resource === 'function' && !wrappedResources.has(fallback.resource)) {
1593
+ const gated = gateResource(fallback.resource)
1594
+ if (gated !== fallback.resource) {
1595
+ gated.__dshWuaGated = true
1596
+ fallback.resource = gated
1597
+ }
1598
+ } else if (typeof fallback.handler === 'function' && !wrappedFallbacks.has(fallback.handler)) {
1599
+ const gated = gateFallback(fallback.handler)
1600
+ if (gated !== fallback.handler) {
1601
+ gated.__dshWuaGated = true
1602
+ fallback.handler = gated
1603
+ }
1604
+ }
1605
+ }
1606
+ } catch (e) { /* 包装失败不阻断注册,靠重扫兜底 */ }
1607
+ return originalRegisterFallback.call(this, fallback)
1437
1608
  }
1438
1609
  undos.push(() => { ws.registerFallback = originalRegisterFallback })
1439
1610
  }
@@ -2396,6 +2567,18 @@ export async function apply(ctx) {
2396
2567
  + '. /api and/or WebSocket may be unprotected; the gate will still wrap them if they register later.')
2397
2568
  }
2398
2569
 
2570
+ // 核心兜底席位形状自检:认得出就报一句,认不出就明确报「不兼容当前核心版本」,
2571
+ // 不要等到用户登录换 cookie 时才以 500/空页暴露。'absent' 可能只是
2572
+ // frontend-static 尚未注册,留到首个文档请求时再诊断。
2573
+ {
2574
+ const shape = fallbackShape(ctx.webServer)
2575
+ if (shape === 'handler' || shape === 'resource') {
2576
+ ctx.logger.info('[dsh-webui-oauth] core fallback seat: ' + shape)
2577
+ } else if (shape === 'unknown') {
2578
+ ctx.logger.error('[dsh-webui-oauth] INCOMPATIBLE CORE: webServer.fallback is neither a handler function nor { resource } + webServer.serveResource(); authenticated pages will answer 404')
2579
+ }
2580
+ }
2581
+
2399
2582
  ctx.logger.info('[dsh-webui-oauth] started, credentials file: ' + configPath())
2400
2583
  if (!enabledFlag) {
2401
2584
  // H1: token 同时落盘(0600,仅本机操作者可读),setup 成功后删除。
@@ -2684,6 +2867,9 @@ export async function apply(ctx) {
2684
2867
  username: enabled ? creds.username : null,
2685
2868
  ttl: ttlOf(creds),
2686
2869
  sessionsPersisted: sessions.ok,
2870
+ // 核心兜底席位形态(handler | resource | absent | unknown):核心升级后
2871
+ // 如果这里变成 unknown,文档请求会 404 —— 排查时先看这个字段。
2872
+ fallback: fallbackShape(ctx.webServer),
2687
2873
  gate: {
2688
2874
  ok: gate.ok(),
2689
2875
  problems: gate.problems().slice(0, 3),
@@ -3384,7 +3570,20 @@ export async function apply(ctx) {
3384
3570
  path: '',
3385
3571
  handler: async (req, res) => {
3386
3572
  try {
3573
+ // ─────── 宿主适配层(DSH Desktop)· 整体摘除时删掉本块 ───────
3574
+ // 必须在认证判定之前:退出登录是客户端自己 location.href = '/',
3575
+ // 服务端看不到带标记的 URL 被放弃,只能在加载时提前记住。
3576
+ // 注意:remember() 只写 Cookie,不参与放行;门禁仍由 checkRequest 决定。
3577
+ desktopAdapter.remember(req, res)
3578
+ // ──────────────────────────────────────────────────────────
3387
3579
  if (checkRequest(req)) {
3580
+ // ─────── 宿主适配层(DSH Desktop)· 整体摘除时删掉本块 ───────
3581
+ // 核心 token→cookie 交换会把浏览器 303 到干净的 "/",桌面端
3582
+ // advanced / extended 模式依赖 URL 上的 dsh-desktop-* 标记才会接管
3583
+ // layout 服务,这里把记住的标记补回 URL 再放行。
3584
+ // 只在 checkRequest 通过之后调用:未认证请求绝不会走到这里。
3585
+ if (desktopAdapter.restore(req, res)) return
3586
+ // ──────────────────────────────────────────────────────────
3388
3587
  // alpha.2+:插件会话通过后,核心 BrowserAuth 可能仍未认领该浏览器
3389
3588
  // (核心 cookie 缺失/过期)。主动引导去带 launch token 的根 URL 完成
3390
3589
  // 核心 token→cookie 交换,否则 fallback 的 authorizeIndex 会 401 死锁。
@@ -3399,13 +3598,13 @@ export async function apply(ctx) {
3399
3598
  return
3400
3599
  }
3401
3600
  }
3402
- const fallback = ctx.webServer.fallback
3403
- if (fallback !== undefined) {
3404
- await fallback(req, res)
3405
- return
3406
- }
3407
- res.writeHead(404)
3408
- res.end()
3601
+ // fallback 可能是函数,也可能是 { resource }(0.2.2-rc.1+)。
3602
+ // 交给 serveFallback 统一分派,避免 TypeError → 500 空响应。
3603
+ if (await serveFallback(ctx, req, res)) return
3604
+ // 形态不认识 / 核心还没注册:明确报一次,并回带说明的 404,
3605
+ // 不要留一个空 body 让运维去猜。
3606
+ reportFallbackProblem(ctx)
3607
+ sendFallbackUnavailable(res)
3409
3608
  return
3410
3609
  }
3411
3610
  res.writeHead(302, { location: loginLocation(req) })
@@ -0,0 +1,205 @@
1
+ /**
2
+ * DSH Desktop 适配层。
3
+ *
4
+ * 本模块与认证逻辑**完全解耦**:不 import 主模块的任何东西,只依赖 Node 内置能力,
5
+ * 因此可以整体删除而不影响认证本身。见文末「如何移除整个适配」。
6
+ *
7
+ * ── 为什么需要它(issue #8)────────────────────────────────────────────
8
+ * DSH Desktop 的 advanced / extended 模式会在组合层**禁用核心 `ui-layout` 行**
9
+ * (dsh-plugin-desktop 的 profile 组合按 mode 改写组合表),此时客户端 `layout`
10
+ * 服务的唯一提供者是桌面端自己的客户端插件,而它**只在 URL 带 `dsh-desktop-*`
11
+ * 标记时才生效** —— `parseDesktopClientEnvironment()` 在标记缺失时返回 undefined,
12
+ * `apply()` 随即直接 return,整个桌面端客户端插件不生效。
13
+ *
14
+ * 任何一次落到干净 "/" 的跳转都会丢掉这些标记,于是 12 个依赖 layout 的客户端插件
15
+ * 永远停在 pending,渲染器 30s 不上报健康,宿主弹出恢复模式对话框。已确认两条路径:
16
+ *
17
+ * ① 首次登录:核心 token→cookie 交换把浏览器 303 到干净的 "/";
18
+ * ② 退出后重登:客户端自行 `location.href = '/'`(lib/client.js 的 onLogout 与
19
+ * 401 分支),服务端从头到尾没看到那个带标记的 URL 被放弃。
20
+ *
21
+ * ── 它做什么 ──────────────────────────────────────────────────────────
22
+ * 主动记忆 + 补投,而不是「跳转前才记」:
23
+ *
24
+ * remember() 渲染器正常加载(URL 带标记)时就把标记写进 Cookie;
25
+ * restore() 文档请求落到干净的 "/" 时,302 回带标记的 URL。
26
+ *
27
+ * 为什么必须「主动」:路径 ② 是客户端发起的跳转,服务端根本没有机会在跳转前做任何事,
28
+ * 等它收到 `GET /` 时标记早已不在。只有在加载时就把标记落盘,才能覆盖所有丢失路径。
29
+ *
30
+ * 暂存**刻意不清除**:清除会引入「记住 → 立刻清掉 → 退出后无处可补」的时序陷阱,
31
+ * 过期交给 Cookie 自身的 Max-Age(12h,且每次加载都会刷新)。
32
+ *
33
+ * ── 安全边界 ──────────────────────────────────────────────────────────
34
+ * 标记按 `dsh-desktop-` 前缀**整体透传**(刻意不做硬编码白名单——DSH Desktop 将来
35
+ * 新增一个标记时会再次静默弄坏桌面端启动,正是本 issue 的同类耦合),其中 `mode`
36
+ * 必须是 `compatibility`/`extended`/`advanced` 之一、值长度上限 64。跳转目标恒为
37
+ * 同源相对路径 "/",**无开放重定向面**;网页版(无 `dsh-desktop-*` 标记)零影响。
38
+ *
39
+ * ── 如何移除整个适配 ──────────────────────────────────────────────────
40
+ * 1. 删掉 index.js 里两处标着「宿主适配层」的代码块(网关 handler 内,共 3 行代码);
41
+ * 2. 删掉 index.js 顶部那行 import,连同它上面两行注释;
42
+ * 3. 删掉 index.js 导出块里提到本模块的那行注释;
43
+ * 4. 删掉本文件,并从 package.json 的 `files` 里去掉 `lib/desktop-adapter.js`。
44
+ *
45
+ * 已实测:只做 1+2 后 index.js 即可独立 `node --check` 通过,无任何悬空引用。
46
+ * 认证本身不依赖本模块 —— 移除后行为等价于 0.3.3:网页版不受影响,桌面端
47
+ * advanced / extended 模式会在登录跳转后再次出现 #8。
48
+ *
49
+ * ── 如何新增一个适配 ──────────────────────────────────────────────────
50
+ * 按同样形状导出即可:
51
+ *
52
+ * { remember(req, res) -> boolean, restore(req, res) -> boolean }
53
+ *
54
+ * remember 在网关最前面**无条件**调用;restore 在插件会话校验通过后调用,
55
+ * 返回 true 表示已接管该请求(已发出响应,调用方应立即 return)。
56
+ * 两个函数都只应触碰响应头,不应改变认证判定。
57
+ */
58
+
59
+ const DESKTOP_STASH_COOKIE = 'dsh_wua_desktop'
60
+ const DESKTOP_STASH_TTL_SECONDS = 12 * 60 * 60
61
+
62
+ /** 桌面端标记的统一前缀。 */
63
+ const DESKTOP_MARKER_PREFIX = 'dsh-desktop-'
64
+
65
+ /**
66
+ * 已知标记,仅用于固定补投时的 query 顺序;除此之外任何 `dsh-desktop-*` 键
67
+ * 都会一并透传(前向兼容)。
68
+ */
69
+ const DESKTOP_MARKER_KEYS = [
70
+ 'dsh-desktop-mode',
71
+ 'dsh-desktop-platform',
72
+ 'dsh-desktop-version',
73
+ 'dsh-desktop-material',
74
+ 'dsh-desktop-mica',
75
+ 'dsh-desktop-titlebar-inset',
76
+ ]
77
+
78
+ /** 桌面端合法模式,与 dsh-plugin-desktop 的 MODES 对齐;其它值一律不采信。 */
79
+ const DESKTOP_MODES = new Set(['compatibility', 'extended', 'advanced'])
80
+
81
+ /** 单个标记值的长度上限,防脏 cookie 撑爆响应头。 */
82
+ const DESKTOP_MARKER_MAX_LENGTH = 64
83
+
84
+ /**
85
+ * 读取请求 Cookie。
86
+ * 刻意不 import 主模块的同名工具:本模块要能被单独删掉,不能反向依赖认证实现。
87
+ */
88
+ function cookieOf(req, name) {
89
+ const raw = req.headers && req.headers.cookie
90
+ if (!raw) return null
91
+ for (const part of String(raw).split(';')) {
92
+ const eq = part.indexOf('=')
93
+ if (eq === -1) continue
94
+ if (part.slice(0, eq).trim() === name) return part.slice(eq + 1).trim()
95
+ }
96
+ return null
97
+ }
98
+
99
+ function parseUrl(urlString) {
100
+ try { return new URL(urlString || '/', 'http://dsh.invalid') } catch (e) { return null }
101
+ }
102
+
103
+ /**
104
+ * 从一组 search params 里收集可透传的桌面端标记;没有可透传项时返回 null。
105
+ * 已知键先出(顺序稳定),其余同前缀键按出现顺序跟进。
106
+ */
107
+ function collectDesktopMarkers(params) {
108
+ // mode 是桌面端客户端插件的硬开关:它缺失或非法时 parseDesktopClientEnvironment
109
+ // 会直接 throw,此时补投 platform 之类的其余标记只会把渲染器推向失败,故整体放弃。
110
+ const mode = params.get(DESKTOP_MARKER_PREFIX + 'mode')
111
+ if (mode === null || !DESKTOP_MODES.has(mode)) return null
112
+ const markers = []
113
+ const seen = new Set()
114
+ const take = (key) => {
115
+ if (seen.has(key)) return
116
+ const value = params.get(key)
117
+ if (value === null || value === '' || value.length > DESKTOP_MARKER_MAX_LENGTH) return
118
+ seen.add(key)
119
+ markers.push([key, value])
120
+ }
121
+ for (const key of DESKTOP_MARKER_KEYS) take(key)
122
+ for (const key of params.keys()) {
123
+ if (key.startsWith(DESKTOP_MARKER_PREFIX)) take(key)
124
+ }
125
+ return markers.length > 0 ? markers : null
126
+ }
127
+
128
+ /** 从 URL 中提取可透传的桌面端标记;没有可透传项时返回 null。 */
129
+ function desktopMarkersOf(urlString) {
130
+ const url = parseUrl(urlString)
131
+ if (url === null) return null
132
+ return collectDesktopMarkers(url.searchParams)
133
+ }
134
+
135
+ /** 暂存标记的 Set-Cookie 值。 */
136
+ function desktopStashCookie(markers) {
137
+ const payload = markers.map(([k, v]) => k + '=' + encodeURIComponent(v)).join('&')
138
+ return DESKTOP_STASH_COOKIE + '=' + encodeURIComponent(payload) +
139
+ '; HttpOnly; SameSite=Lax; Path=/; Max-Age=' + DESKTOP_STASH_TTL_SECONDS
140
+ }
141
+
142
+ /** 读出暂存 cookie 并还原成 query 串(不含 "?");不可用/非法时返回 null。 */
143
+ function desktopStashQuery(req) {
144
+ const raw = cookieOf(req, DESKTOP_STASH_COOKIE)
145
+ if (!raw) return null
146
+ let decoded = null
147
+ try { decoded = decodeURIComponent(raw) } catch (e) { return null }
148
+ // 走与提取端同一套规则:暂存内容来自客户端 Cookie,同样要过滤。
149
+ // 这套对称性是有承重的——补投出的 URL 必然能被 desktopMarkersOf 认出来,
150
+ // restore() 才不会在同一份标记上反复跳转。改任一侧都要同步改另一侧。
151
+ const markers = collectDesktopMarkers(new URLSearchParams(decoded))
152
+ if (markers === null) return null
153
+ return markers.map(([k, v]) => k + '=' + encodeURIComponent(v)).join('&')
154
+ }
155
+
156
+ /**
157
+ * 记住本次文档请求 URL 上的桌面端标记。
158
+ *
159
+ * 必须是「主动记忆」而非「跳转前才记」:退出登录是客户端自己 `location.href = '/'`,
160
+ * 服务端根本没机会看到那个带标记的 URL 被放弃——等它看到 `GET /` 时标记早已不在,
161
+ * 无从暂存。因此在渲染器正常加载(URL 带标记)时就落盘,之后无论标记在哪一步丢失
162
+ * (退出重登、会话过期、核心 token 交换、深链)都能补投回来。
163
+ *
164
+ * @returns true 表示写入了暂存 Cookie。
165
+ */
166
+ function remember(req, res) {
167
+ if (req.method !== 'GET') return false
168
+ const url = parseUrl(req.url)
169
+ if (url === null || url.pathname !== '/') return false
170
+ const markers = desktopMarkersOf(req.url)
171
+ if (markers === null) return false
172
+ res.setHeader('Set-Cookie', desktopStashCookie(markers))
173
+ return true
174
+ }
175
+
176
+ /**
177
+ * 文档请求落到干净的 "/" 时,把记住的桌面端标记补回 URL。
178
+ * 刻意不清除暂存(见文件顶部说明),过期交给 Cookie 自身的 Max-Age。
179
+ *
180
+ * @returns true 表示已接管该请求(已发出 302,调用方应立即 return)。
181
+ */
182
+ function restore(req, res) {
183
+ if (req.method !== 'GET') return false
184
+ const pending = desktopStashQuery(req)
185
+ if (pending === null) return false
186
+ const url = parseUrl(req.url)
187
+ if (url === null || url.pathname !== '/') return false
188
+ // 核心正在做 token→cookie 交换:必须放行,交换完成后它自己会 303 到干净的 "/"。
189
+ // 若在这里抢跳,核心的 dsh-auth-* cookie 永远拿不到,/api 会全 401。
190
+ if (url.searchParams.has('token')) return false
191
+ // 本次文档请求已经带标记,桌面端能正常启动,无需干预。
192
+ if (desktopMarkersOf(req.url) !== null) return false
193
+ res.writeHead(302, { location: '/?' + pending })
194
+ res.end()
195
+ return true
196
+ }
197
+
198
+ export const desktopAdapter = { name: 'dsh-desktop', remember, restore }
199
+
200
+ // 纯函数供回归测试直接调用(见 test/redirect-scheme.test.mjs)
201
+ export {
202
+ remember, restore,
203
+ desktopMarkersOf, desktopStashCookie, desktopStashQuery, collectDesktopMarkers,
204
+ DESKTOP_STASH_COOKIE, DESKTOP_MARKER_KEYS, DESKTOP_STASH_TTL_SECONDS,
205
+ }
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "dsh-webui-oauth",
3
- "version": "0.7.0",
3
+ "version": "0.7.2",
4
4
  "type": "module",
5
5
  "main": "index.js",
6
6
  "scripts": {
7
- "test": "node test/redirect-scheme.test.mjs && node test/proxy-host.test.mjs && node test/trusted-origin.test.mjs && node test/oidc.test.mjs && node test/oidc-state-ttl.test.mjs && node test/set-cookie-multi.test.mjs && node test/oidc-integration.test.mjs && node test/oidc-config-store.test.mjs && node test/adopt-data-dir.test.mjs && node test/oidc-ec.test.mjs && node test/jwks-refresh.test.mjs && node test/oidc-bind.test.mjs && node test/client-bundle-id.test.mjs && node test/client-prefill.test.mjs && node test/displace-original.test.mjs && node test/oidc-redirect-matrix.test.mjs && node test/gate-default-deny.test.mjs"
7
+ "test": "node test/redirect-scheme.test.mjs && node test/proxy-host.test.mjs && node test/trusted-origin.test.mjs && node test/oidc.test.mjs && node test/oidc-state-ttl.test.mjs && node test/set-cookie-multi.test.mjs && node test/oidc-integration.test.mjs && node test/oidc-config-store.test.mjs && node test/adopt-data-dir.test.mjs && node test/oidc-ec.test.mjs && node test/jwks-refresh.test.mjs && node test/oidc-bind.test.mjs && node test/client-bundle-id.test.mjs && node test/client-prefill.test.mjs && node test/displace-original.test.mjs && node test/oidc-redirect-matrix.test.mjs && node test/gate-default-deny.test.mjs && node test/fallback-shape.test.mjs && node test/desktop-marker.test.mjs && node test/audit-null.test.mjs"
8
8
  },
9
9
  "exports": {
10
10
  ".": "./index.js",
@@ -16,6 +16,7 @@
16
16
  "files": [
17
17
  "index.js",
18
18
  "lib/client.js",
19
+ "lib/desktop-adapter.js",
19
20
  "cordis.patch.yml",
20
21
  "README.md",
21
22
  "README.en.md",