@bitkyc08/opencodex 2.100.2 → 2.100.4

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.
Files changed (644) hide show
  1. package/AGENTS_INSTALL.md +23 -1
  2. package/README.md +1 -1
  3. package/bin/ocx.mjs +40 -19
  4. package/gui/dist/assets/{App-COo8Yopd.css → App-BGP8I0V4.css} +1 -1
  5. package/gui/dist/assets/App-DcpyI78f.js +60 -0
  6. package/gui/dist/assets/{Tray-BcaI-VCr.js → Tray-CzjPJprT.js} +1 -1
  7. package/gui/dist/assets/brand-mark-BTIi7e69.js +1 -0
  8. package/gui/dist/assets/index-DJxM-imn.css +2 -0
  9. package/gui/dist/assets/index-DVgU6S3y.js +138 -0
  10. package/gui/dist/assets/{segment-thumb-features-e9A_FogJ.js → segment-thumb-features-Bn6Y-g3R.js} +1 -1
  11. package/gui/dist/classic/assets/App-eYJAyNHM.js +59 -0
  12. package/gui/dist/classic/assets/{Tray-DT146AhS.js → Tray-xHMYxLkV.js} +1 -1
  13. package/gui/dist/classic/assets/index-DSaVRW4F.js +138 -0
  14. package/gui/dist/classic/assets/quota-summary-DyzHlkFl.js +1 -0
  15. package/gui/dist/classic/index.html +1 -1
  16. package/gui/dist/index.html +2 -2
  17. package/native/ocx-child/Cargo.toml +9 -0
  18. package/native/ocx-child/src/cli.rs +404 -20
  19. package/native/ocx-child/src/codex_home.rs +99 -14
  20. package/native/ocx-child/src/daemon.rs +2 -1
  21. package/native/ocx-child/src/lib.rs +3 -0
  22. package/native/ocx-child/src/link_ws.rs +2598 -0
  23. package/native/ocx-child/src/link_ws_advert.rs +346 -0
  24. package/native/ocx-child/src/link_ws_frame.rs +749 -0
  25. package/native/ocx-child/src/parity.rs +5 -1
  26. package/native/ocx-child/src/platform.rs +152 -6
  27. package/native/ocx-child/src/relay.rs +150 -19
  28. package/package.json +3 -3
  29. package/src/adapters/anthropic/advisor-tool.ts +176 -0
  30. package/src/adapters/anthropic/beta-body-pairs.ts +6 -0
  31. package/src/adapters/anthropic/client-identity.ts +3 -1
  32. package/src/adapters/anthropic/passthrough.ts +9 -3
  33. package/src/adapters/anthropic/per-message-effort.ts +296 -0
  34. package/src/adapters/anthropic.ts +34 -14
  35. package/src/adapters/claude-cli/adapter.ts +1 -0
  36. package/src/adapters/client-fingerprint.ts +3 -3
  37. package/src/adapters/cursor/discovery.ts +17 -0
  38. package/src/adapters/cursor/native-exec-desktop.ts +2 -1
  39. package/src/adapters/cursor/native-exec-shell.ts +2 -1
  40. package/src/adapters/cursor/protobuf-request.ts +8 -8
  41. package/src/adapters/cursor.ts +7 -6
  42. package/src/adapters/devin/cloud-direct/chat.ts +71 -14
  43. package/src/adapters/google-antigravity-wire.ts +7 -5
  44. package/src/adapters/google-errors.ts +14 -2
  45. package/src/adapters/google-wire-compiler.ts +2 -2
  46. package/src/adapters/google.ts +9 -2
  47. package/src/adapters/kiro/payload.ts +7 -4
  48. package/src/adapters/kiro/reasoning.ts +44 -1
  49. package/src/adapters/kiro/structured-output.ts +10 -8
  50. package/src/adapters/kiro-tools.ts +61 -15
  51. package/src/adapters/openai-chat/destination-policy.ts +16 -0
  52. package/src/adapters/openai-chat/reasoning-replay.ts +4 -1
  53. package/src/adapters/qoder/adapter.ts +9 -1
  54. package/src/adapters/zed.ts +7 -2
  55. package/src/advisor/consult.ts +15 -4
  56. package/src/advisor/context.ts +12 -3
  57. package/src/advisor/runtime.ts +35 -5
  58. package/src/advisor/settings.ts +8 -0
  59. package/src/advisor/synthetic-tool.ts +21 -8
  60. package/src/bridge/response-json.ts +11 -2
  61. package/src/bridge/sse.ts +43 -8
  62. package/src/claude/auth-detect.ts +21 -33
  63. package/src/claude/desktop-3p.ts +11 -5
  64. package/src/claude/desktop-gateway-state.ts +2 -0
  65. package/src/claude/desktop-remote-store-artifact.ts +14 -3
  66. package/src/claude/desktop-remote-store.ts +82 -12
  67. package/src/claude/inbound-content-options.ts +31 -16
  68. package/src/claude/outbound.ts +13 -3
  69. package/src/cli/account-api.ts +21 -1
  70. package/src/cli/account-auth.ts +83 -22
  71. package/src/cli/account-extended.ts +33 -2
  72. package/src/cli/account-key-quota.ts +34 -5
  73. package/src/cli/account.ts +4 -2
  74. package/src/cli/advisor.ts +7 -4
  75. package/src/cli/alias.ts +38 -1
  76. package/src/cli/capabilities-access-remote.ts +128 -3
  77. package/src/cli/capabilities-accounts.ts +6 -6
  78. package/src/cli/capabilities-agents-routing.ts +17 -10
  79. package/src/cli/capabilities-base.ts +49 -19
  80. package/src/cli/capabilities-integrations.ts +2 -2
  81. package/src/cli/capabilities-observe-system.ts +2 -2
  82. package/src/cli/capabilities-provider-models.ts +18 -2
  83. package/src/cli/capabilities-route-to.ts +43 -0
  84. package/src/cli/capabilities.ts +2 -0
  85. package/src/cli/capability-contracts.ts +1 -1
  86. package/src/cli/claude-desktop.ts +30 -11
  87. package/src/cli/claude.ts +17 -3
  88. package/src/cli/codex-launcher.ts +3 -1
  89. package/src/cli/codex-shim-autorestore.ts +5 -42
  90. package/src/cli/config-command.ts +14 -1
  91. package/src/cli/config-root-startup.ts +34 -0
  92. package/src/cli/connect.ts +88 -16
  93. package/src/cli/desktop-runtime-guidance.ts +1 -1
  94. package/src/cli/disconnect-runtime.ts +178 -0
  95. package/src/cli/dispatch.ts +61 -13
  96. package/src/cli/export-command.ts +1 -1
  97. package/src/cli/gui-pair-client.ts +6 -3
  98. package/src/cli/gui.ts +10 -5
  99. package/src/cli/help-catalog.ts +11 -0
  100. package/src/cli/help.ts +4 -3
  101. package/src/cli/index.ts +85 -94
  102. package/src/cli/inspect.ts +11 -2
  103. package/src/cli/integrations.ts +26 -1
  104. package/src/cli/link-apply-restart.ts +4 -2
  105. package/src/cli/link-capture.ts +64 -0
  106. package/src/cli/link-child-ops.ts +218 -40
  107. package/src/cli/link-cleanup.ts +8 -5
  108. package/src/cli/link-diagnostics.ts +67 -0
  109. package/src/cli/link-enrollment.ts +158 -12
  110. package/src/cli/link-operations.ts +52 -0
  111. package/src/cli/link-recover.ts +152 -0
  112. package/src/cli/link-routes.ts +90 -0
  113. package/src/cli/link-status-child.ts +44 -1
  114. package/src/cli/link-status-traffic.ts +34 -0
  115. package/src/cli/link.ts +315 -37
  116. package/src/cli/message-command.ts +1 -1
  117. package/src/cli/message-mcp-command.ts +23 -10
  118. package/src/cli/models-runtime.ts +3 -3
  119. package/src/cli/opencode.ts +3 -1
  120. package/src/cli/pi-sync.ts +35 -0
  121. package/src/cli/preflight-exemptions.ts +49 -0
  122. package/src/cli/registry.ts +33 -14
  123. package/src/cli/resolve.ts +23 -8
  124. package/src/cli/restart-failure.ts +15 -2
  125. package/src/cli/root.ts +5 -1
  126. package/src/cli/route-to.ts +172 -0
  127. package/src/cli/runtime-api.ts +9 -8
  128. package/src/cli/status.ts +7 -2
  129. package/src/cli/stop-approval.ts +66 -19
  130. package/src/cli/stop-report.ts +23 -0
  131. package/src/cli/stop-windows-checked.ts +304 -0
  132. package/src/cli/sync-command.ts +70 -15
  133. package/src/cli/sync-fanout.ts +74 -19
  134. package/src/cli/sync-flags.ts +40 -3
  135. package/src/cli/sync-link-status.ts +18 -2
  136. package/src/cli/sync-update-guard.ts +7 -2
  137. package/src/cli/system-command.ts +1 -1
  138. package/src/cli/system-restart-client.ts +10 -3
  139. package/src/cli/system-settings-parity.ts +2 -1
  140. package/src/cli/uninstall-plan.ts +77 -5
  141. package/src/cli/uninstall-stop.ts +152 -0
  142. package/src/cli/v2-input.ts +10 -6
  143. package/src/cli/v2-local-output.ts +3 -2
  144. package/src/cli/v2-runtime.ts +10 -3
  145. package/src/cli/v2.ts +22 -7
  146. package/src/client/connect.ts +376 -35
  147. package/src/client/desktop-refusal.ts +38 -0
  148. package/src/client/lifecycle-lock.ts +29 -4
  149. package/src/client/link-home-features.ts +27 -0
  150. package/src/client/link-home.ts +92 -4
  151. package/src/client/link-ingress.ts +21 -3
  152. package/src/client/link-join.ts +12 -2
  153. package/src/client/link-parity-reporter.ts +60 -6
  154. package/src/client/link-relay-transport.ts +161 -36
  155. package/src/client/link-relay.ts +150 -6
  156. package/src/client/link-request-compression.ts +84 -0
  157. package/src/client/link-state.ts +11 -5
  158. package/src/client/link-status.ts +39 -1
  159. package/src/client/link-teardown.ts +1 -0
  160. package/src/client/link-tunnel.ts +56 -5
  161. package/src/client/link-websocket-limits.ts +89 -0
  162. package/src/client/link-websocket.ts +586 -0
  163. package/src/client/link-ws-advertisement.ts +100 -0
  164. package/src/client/link-ws-framer.ts +241 -0
  165. package/src/client/link-ws-transport.ts +177 -0
  166. package/src/client/machine-api.ts +13 -2
  167. package/src/client/machine-listener.ts +48 -7
  168. package/src/client/route-intent-apply.ts +293 -0
  169. package/src/client/route-intent-file-originals.ts +97 -0
  170. package/src/client/route-intent-native-originals.ts +201 -0
  171. package/src/client/route-intent-watch.ts +141 -0
  172. package/src/client/runtime-restart.ts +141 -7
  173. package/src/client/runtime.ts +63 -15
  174. package/src/client/state.ts +44 -0
  175. package/src/client/sync-expectation.ts +36 -2
  176. package/src/client/sync-runtime.ts +7 -0
  177. package/src/clients/config-export/alias-selectors.ts +63 -40
  178. package/src/clients/config-export/contracts.ts +2 -0
  179. package/src/clients/config-export/nested-selectors.ts +42 -0
  180. package/src/clients/config-export.ts +22 -3
  181. package/src/codex/account-pause.ts +4 -0
  182. package/src/codex/account-runtime-state.ts +4 -0
  183. package/src/codex/account-store.ts +12 -3
  184. package/src/codex/account-usability.ts +13 -0
  185. package/src/codex/auth-api/account-list.ts +29 -3
  186. package/src/codex/auth-api/main-account-probe.ts +3 -1
  187. package/src/codex/auth-api/main-hard-lock-refusal-read.ts +172 -0
  188. package/src/codex/auth-collision.ts +23 -22
  189. package/src/codex/auth-context.ts +61 -8
  190. package/src/codex/catalog/build-entries.ts +10 -0
  191. package/src/codex/catalog/derive-entry.ts +7 -0
  192. package/src/codex/catalog/gather-capture.ts +8 -2
  193. package/src/codex/catalog/parsing.ts +7 -3
  194. package/src/codex/catalog/provider-models.ts +54 -15
  195. package/src/codex/catalog/reserve-warn.ts +7 -5
  196. package/src/codex/catalog/reserve.ts +4 -3
  197. package/src/codex/catalog/retained-sync.ts +4 -1
  198. package/src/codex/catalog/routed-defaults.ts +35 -0
  199. package/src/codex/catalog/routed-gather.ts +1 -1
  200. package/src/codex/catalog-auto-refresh.ts +11 -0
  201. package/src/codex/cli-update-job.ts +35 -13
  202. package/src/codex/convergence.ts +4 -2
  203. package/src/codex/desktop-compatibility/native-identity.ts +4 -8
  204. package/src/codex/features.ts +2 -2
  205. package/src/codex/history-provider.ts +31 -0
  206. package/src/codex/inject/multi-agent-v2.ts +9 -3
  207. package/src/codex/inject/paginated-openai-compat.ts +54 -1
  208. package/src/codex/inject/plan.ts +20 -2
  209. package/src/codex/inject.ts +2 -0
  210. package/src/codex/journal-config-restore.ts +217 -0
  211. package/src/codex/journal.ts +75 -6
  212. package/src/codex/loopback-target.ts +22 -8
  213. package/src/codex/main-account.ts +109 -57
  214. package/src/codex/native-main-auth-file.ts +118 -0
  215. package/src/codex/native-main-credentials.ts +270 -0
  216. package/src/codex/native-main-owner.ts +3 -0
  217. package/src/codex/native-main-refresh-mode.ts +14 -1
  218. package/src/codex/native-profile-manager.ts +4 -3
  219. package/src/codex/native-profile-store.ts +3 -61
  220. package/src/codex/orca-import.ts +10 -1
  221. package/src/codex/quota-history.ts +13 -0
  222. package/src/codex/quota-window-conflict.ts +103 -0
  223. package/src/codex/quota.ts +86 -15
  224. package/src/codex/subagent-model-fallback.ts +3 -1
  225. package/src/codex/websocket-activity.ts +171 -16
  226. package/src/codex/websocket-registry.ts +11 -4
  227. package/src/combos/cooldown-store.ts +25 -5
  228. package/src/combos/failover.ts +342 -3
  229. package/src/combos/index.ts +5 -0
  230. package/src/combos/resolve.ts +115 -19
  231. package/src/config/dashboard-trusted-proxy.ts +83 -0
  232. package/src/config/diagnostics.ts +31 -0
  233. package/src/config/feature-flags.ts +9 -0
  234. package/src/config/live-reconcile.ts +16 -4
  235. package/src/config/load-degrade.ts +14 -1
  236. package/src/config/multi-agent-surface.ts +28 -5
  237. package/src/config/pending-teardown.ts +60 -3
  238. package/src/config/persisted-mutation.ts +2 -2
  239. package/src/config/persisted-projections.ts +18 -0
  240. package/src/config/process-state.ts +176 -4
  241. package/src/config/provider-validation.ts +4 -4
  242. package/src/config/reserve-capability.ts +96 -0
  243. package/src/config/schema/config-schema.ts +12 -0
  244. package/src/config/schema/leaf-validators.ts +11 -2
  245. package/src/config/schema/routed-catalog-defaults.ts +49 -0
  246. package/src/config/windows-process-command-line.ts +107 -0
  247. package/src/config.ts +7 -7
  248. package/src/desktop-update/acquire.ts +202 -0
  249. package/src/desktop-update/cli.ts +168 -0
  250. package/src/desktop-update/drain.ts +40 -0
  251. package/src/desktop-update/headless.ts +285 -0
  252. package/src/desktop-update/image.ts +85 -0
  253. package/src/desktop-update/install.ts +53 -0
  254. package/src/desktop-update/msi.ts +72 -0
  255. package/src/desktop-update/release.ts +128 -0
  256. package/src/desktop-update/runtime.ts +155 -0
  257. package/src/desktop-update/staging.ts +118 -0
  258. package/src/desktop-update/trust.ts +45 -0
  259. package/src/generated/compatibility-version.json +1114 -442
  260. package/src/generated/model-metadata.ts +1 -1
  261. package/src/images/fulfill-video.ts +3 -3
  262. package/src/images/loop.ts +9 -2
  263. package/src/images/plan.ts +147 -11
  264. package/src/images/types.ts +13 -4
  265. package/src/images/xai-video-client.ts +72 -10
  266. package/src/integrations/model-name-guard.ts +25 -0
  267. package/src/integrations/route-intent-catalog.ts +26 -0
  268. package/src/integrations/route-intent-connected.ts +262 -0
  269. package/src/integrations/route-intent-contract.ts +55 -0
  270. package/src/integrations/route-intent-disconnect.ts +109 -0
  271. package/src/integrations/route-intent-initial.ts +64 -0
  272. package/src/integrations/route-intent-state.ts +117 -0
  273. package/src/integrations/route-intent-tick.ts +65 -0
  274. package/src/integrations/route-intent.ts +212 -0
  275. package/src/integrations/writer.ts +44 -11
  276. package/src/lib/client-retry-after.ts +29 -0
  277. package/src/lib/config-ownership.ts +13 -0
  278. package/src/lib/desktop-gui-origin.ts +28 -0
  279. package/src/lib/errors.ts +1 -1
  280. package/src/lib/gcp-adc.ts +48 -4
  281. package/src/lib/gui-pair-capability.ts +2 -1
  282. package/src/lib/messages-error-body.ts +4 -1
  283. package/src/lib/offline-resend.ts +150 -0
  284. package/src/lib/outbound-credential-registry.ts +362 -4
  285. package/src/lib/paced-stream.ts +34 -0
  286. package/src/lib/passive-key-fetch-proof.ts +30 -0
  287. package/src/lib/passive-read.ts +5 -0
  288. package/src/lib/process-control.ts +76 -12
  289. package/src/lib/provider-outbound.ts +17 -6
  290. package/src/lib/redact.ts +84 -8
  291. package/src/lib/request-failure-model.ts +2 -0
  292. package/src/lib/response-body-inactivity.ts +23 -1
  293. package/src/lib/state-store-registrations.ts +11 -0
  294. package/src/lib/state-store-sweeper.ts +4 -0
  295. package/src/lib/supervisor-markers.ts +18 -0
  296. package/src/lib/terminal-safe-text.ts +58 -0
  297. package/src/lib/translator-budget.ts +3 -2
  298. package/src/lib/upstream-retry.ts +52 -9
  299. package/src/link/alias-lock.ts +119 -0
  300. package/src/link/child-activity.ts +28 -2
  301. package/src/link/child-binary-cache-fill.d.mts +50 -0
  302. package/src/link/child-binary-cache-fill.mjs +494 -0
  303. package/src/link/child-binary-cache-start.ts +73 -0
  304. package/src/link/child-binary-source.ts +12 -5
  305. package/src/link/child-gated-ocx.ts +29 -11
  306. package/src/link/child-observations.ts +2 -1
  307. package/src/link/child-observe.ts +2 -2
  308. package/src/link/child-ops-engine.ts +159 -91
  309. package/src/link/child-ops-host.ts +138 -0
  310. package/src/link/child-ops-runners.ts +319 -0
  311. package/src/link/child-ops-scheduler.ts +207 -0
  312. package/src/link/child-ops-types.ts +89 -0
  313. package/src/link/child-parity.ts +23 -4
  314. package/src/link/child-policy.ts +93 -0
  315. package/src/link/child-update-contract.ts +12 -3
  316. package/src/link/codex-settings.ts +1 -1
  317. package/src/link/compatibility.ts +18 -1
  318. package/src/link/diagnostics-read.ts +163 -0
  319. package/src/link/diagnostics.ts +20 -7
  320. package/src/link/explicit-route.ts +209 -0
  321. package/src/link/link-recover.ts +113 -0
  322. package/src/link/management-routes.ts +3 -1
  323. package/src/link/operation-recovery-slot.ts +44 -0
  324. package/src/link/operations-journal.ts +408 -0
  325. package/src/link/peer-report.ts +1 -1
  326. package/src/link/relay-auth.ts +14 -0
  327. package/src/link/remote-plant.ts +152 -14
  328. package/src/link/remote-platform.ts +21 -10
  329. package/src/link/remote-probe.ts +11 -3
  330. package/src/link/remote-windows.ts +124 -36
  331. package/src/link/request-compression.ts +30 -0
  332. package/src/link/residual-recovery.ts +66 -0
  333. package/src/link/retirement.ts +128 -0
  334. package/src/link/route-intent-watch.ts +41 -0
  335. package/src/link/route-intent.ts +209 -0
  336. package/src/link/route-proof.ts +82 -0
  337. package/src/link/route-rounds.ts +579 -0
  338. package/src/link/route-select.ts +95 -0
  339. package/src/link/route-trust.ts +96 -0
  340. package/src/link/ssh-argv.ts +172 -24
  341. package/src/link/ssh-capture-redact.ts +253 -0
  342. package/src/link/ssh-capture.ts +497 -0
  343. package/src/link/ssh-runner.ts +141 -14
  344. package/src/link/status-projection.ts +87 -0
  345. package/src/link/store.ts +54 -1
  346. package/src/link/supervisor.ts +543 -55
  347. package/src/link/sync-fanout-classify.ts +16 -0
  348. package/src/link/sync-then-restart.ts +65 -0
  349. package/src/link/tombstones.ts +209 -0
  350. package/src/link/traffic.ts +178 -0
  351. package/src/link/ws-activity-holds.ts +474 -0
  352. package/src/local-credentials/publication-fence.ts +20 -1
  353. package/src/messaging/budget.ts +23 -5
  354. package/src/messaging/mcp-queue-rpc.ts +1 -1
  355. package/src/messaging/mcp-queue-server.ts +16 -1
  356. package/src/messaging/mcp-resume-tools.ts +25 -0
  357. package/src/messaging/remote-enrollment.ts +3 -3
  358. package/src/messaging/remote-tunnels.ts +2 -2
  359. package/src/messaging/resume-permissions.ts +27 -0
  360. package/src/messaging/rpc.ts +50 -6
  361. package/src/oauth/anthropic-continuity.ts +23 -7
  362. package/src/oauth/anthropic-routing.ts +5 -2
  363. package/src/oauth/anthropic.ts +22 -2
  364. package/src/oauth/antigravity-risk.ts +126 -0
  365. package/src/oauth/claude-keychain-read.ts +78 -68
  366. package/src/oauth/generic-account-failover.ts +89 -18
  367. package/src/oauth/generic-session-affinity.ts +10 -3
  368. package/src/oauth/index.ts +24 -6
  369. package/src/oauth/local-token-detect.ts +8 -29
  370. package/src/oauth/login-cli-errors.ts +5 -1
  371. package/src/oauth/login-cli.ts +68 -19
  372. package/src/oauth/login-flow-state.ts +26 -3
  373. package/src/oauth/meta-muse.ts +1 -1
  374. package/src/oauth/pool-kernel.ts +3 -3
  375. package/src/oauth/store.ts +7 -0
  376. package/src/oauth/xai.ts +248 -14
  377. package/src/protocols/contract.ts +4 -0
  378. package/src/protocols/encoders/messages.ts +1 -0
  379. package/src/providers/alias-template.ts +48 -0
  380. package/src/providers/anthropic-billing-ownership.ts +2 -0
  381. package/src/providers/anthropic-billing-refusal.ts +27 -3
  382. package/src/providers/anthropic-output-caps.ts +46 -0
  383. package/src/providers/anthropic-reset-grant-ledger.ts +9 -3
  384. package/src/providers/antigravity-effort-families.ts +11 -3
  385. package/src/providers/antigravity-models.ts +32 -9
  386. package/src/providers/antigravity-wire-snapshot.ts +3 -2
  387. package/src/providers/api-key-pause.ts +3 -0
  388. package/src/providers/api-key-resolve.ts +49 -7
  389. package/src/providers/api-key-response-ownership.ts +2 -0
  390. package/src/providers/api-key-selection.ts +51 -9
  391. package/src/providers/api-keys.ts +6 -2
  392. package/src/providers/cache-affinity-identity.ts +73 -0
  393. package/src/providers/cache-affinity.ts +256 -0
  394. package/src/providers/default-aliases.ts +98 -20
  395. package/src/providers/google-vertex-model-discovery.ts +515 -0
  396. package/src/providers/key-failover.ts +123 -8
  397. package/src/providers/key-store.ts +3 -3
  398. package/src/providers/kiro-models.ts +3 -5
  399. package/src/providers/label.ts +31 -5
  400. package/src/providers/mistral-transport.ts +17 -4
  401. package/src/providers/model-rename-fields.ts +5 -0
  402. package/src/providers/muse-key-quota.ts +14 -6
  403. package/src/providers/new-model-policy-runtime.ts +17 -4
  404. package/src/providers/new-model-policy.ts +30 -4
  405. package/src/providers/passive-key-observation.ts +252 -0
  406. package/src/providers/quota/account-cache.ts +2 -1
  407. package/src/providers/quota/anthropic-cooldown-recovery-worker.ts +121 -0
  408. package/src/providers/quota/passive-key-limits.ts +272 -0
  409. package/src/providers/quota/passive-wire-model.ts +126 -0
  410. package/src/providers/quota/report-cache.ts +61 -2
  411. package/src/providers/quota/workbuddy.ts +6 -2
  412. package/src/providers/quota-key-accounts.ts +11 -6
  413. package/src/providers/quota-types.ts +18 -0
  414. package/src/providers/quota.ts +11 -12
  415. package/src/providers/registry/entries-core.ts +34 -16
  416. package/src/providers/registry/entries-extended.ts +32 -0
  417. package/src/providers/registry/model-seeds.ts +35 -0
  418. package/src/providers/resolved-model-policy.ts +7 -0
  419. package/src/providers/routed-config.ts +8 -3
  420. package/src/providers/workbuddy-credit-balance.ts +125 -16
  421. package/src/providers/xai-transport.ts +3 -0
  422. package/src/remote/features.ts +17 -0
  423. package/src/responses/anthropic-progress.ts +10 -4
  424. package/src/responses/citation-markers.ts +231 -0
  425. package/src/responses/effort-history.ts +732 -0
  426. package/src/responses/spill-store.ts +5 -1
  427. package/src/responses/state/replay-input.ts +50 -0
  428. package/src/responses/state/replay-owner.ts +24 -0
  429. package/src/responses/state/snapshot-codec.ts +9 -0
  430. package/src/responses/state/spill-queue.ts +1 -0
  431. package/src/responses/state.ts +42 -60
  432. package/src/router.ts +2 -2
  433. package/src/routing/history/integrity.ts +41 -4
  434. package/src/routing/home-route-capture.ts +123 -0
  435. package/src/routing/home-route-intent.ts +200 -0
  436. package/src/routing/route-intent-state.ts +178 -0
  437. package/src/routing/route-to-live-settings.ts +35 -0
  438. package/src/routing/route-to-local.ts +145 -0
  439. package/src/routing/route-to-status.ts +94 -0
  440. package/src/routing/route-to-sync-child.ts +32 -0
  441. package/src/server/adapter-resolve.ts +21 -1
  442. package/src/server/admitted-http-turn.ts +3 -0
  443. package/src/server/auth-cors.ts +111 -3
  444. package/src/server/bare-upstream-error.ts +220 -0
  445. package/src/server/chat-native.ts +14 -5
  446. package/src/server/claude-messages.ts +6 -4
  447. package/src/server/codex-model-list.ts +4 -2
  448. package/src/server/configured-credentials.ts +37 -5
  449. package/src/server/direct-local-http.ts +26 -3
  450. package/src/server/gui-desktop-authorization.ts +36 -0
  451. package/src/server/gui-pair-delivery.ts +6 -3
  452. package/src/server/gui-session.ts +10 -1
  453. package/src/server/inbound-body-admission.ts +17 -4
  454. package/src/server/index/link-listener.ts +196 -12
  455. package/src/server/index/link-management.ts +15 -1
  456. package/src/server/index/link-relay-sessions.ts +87 -8
  457. package/src/server/index/link-websocket-limits.ts +136 -0
  458. package/src/server/index/link-websocket.ts +692 -0
  459. package/src/server/index/optional-listeners.ts +97 -7
  460. package/src/server/index/route-intent-watch.ts +47 -0
  461. package/src/server/index/serve-contract.ts +86 -0
  462. package/src/server/index/serve-options.ts +36 -86
  463. package/src/server/index/startup-warnings.ts +8 -2
  464. package/src/server/index/websocket-handler.ts +26 -4
  465. package/src/server/index.ts +15 -4
  466. package/src/server/inference/client-encoder-delivery.ts +2 -0
  467. package/src/server/inspection-tee.ts +39 -2
  468. package/src/server/lifecycle.ts +2 -0
  469. package/src/server/link-turn.ts +149 -0
  470. package/src/server/management/advisor-routes.ts +10 -2
  471. package/src/server/management/agent-settings-routes.ts +50 -16
  472. package/src/server/management/anthropic-reset-grant-routes.ts +1 -1
  473. package/src/server/management/config-routes.ts +39 -3
  474. package/src/server/management/context.ts +9 -2
  475. package/src/server/management/desktop-authorization.ts +41 -0
  476. package/src/server/management/desktop-compatibility-routes.ts +9 -8
  477. package/src/server/management/desktop-compatibility-runtime-routes.ts +3 -2
  478. package/src/server/management/desktop-compatibility-settings-routes.ts +5 -3
  479. package/src/server/management/home-integration-decision.ts +89 -0
  480. package/src/server/management/integration-routes.ts +208 -81
  481. package/src/server/management/link-child-ops-routes.ts +145 -43
  482. package/src/server/management/link-child-preflight.ts +31 -0
  483. package/src/server/management/link-diagnostics-route.ts +29 -0
  484. package/src/server/management/link-enrollment.ts +199 -47
  485. package/src/server/management/link-operation.ts +609 -0
  486. package/src/server/management/link-recover-route.ts +103 -0
  487. package/src/server/management/link-route-edit.ts +192 -0
  488. package/src/server/management/link-route-request.ts +62 -0
  489. package/src/server/management/link-route-state.ts +83 -7
  490. package/src/server/management/link-routes.ts +553 -51
  491. package/src/server/management/link-traffic-status.ts +13 -0
  492. package/src/server/management/model-routes.ts +122 -36
  493. package/src/server/management/model-rows.ts +2 -1
  494. package/src/server/management/native-integration-routes.ts +176 -70
  495. package/src/server/management/oauth-account-routes.ts +58 -18
  496. package/src/server/management/protocol-routes.ts +7 -0
  497. package/src/server/management/provider-completion-test.ts +4 -4
  498. package/src/server/management/provider-overwrite-carry.ts +14 -0
  499. package/src/server/management/provider-routes.ts +68 -65
  500. package/src/server/management/provider-routing-quota.ts +45 -0
  501. package/src/server/management/route-registry.ts +22 -3
  502. package/src/server/management/route-to-routes.ts +257 -0
  503. package/src/server/management/static-catalog-probe.ts +33 -0
  504. package/src/server/management/system-restart.ts +4 -2
  505. package/src/server/management/usage-aggregate-cache.ts +101 -66
  506. package/src/server/management-api.ts +17 -3
  507. package/src/server/management-auth.ts +13 -1
  508. package/src/server/messages-native-preflight.ts +27 -4
  509. package/src/server/messages-native.ts +17 -5
  510. package/src/server/persistent-gui-session.ts +6 -3
  511. package/src/server/proxy-liveness.ts +87 -15
  512. package/src/server/relay-eager.ts +36 -12
  513. package/src/server/relay.ts +189 -117
  514. package/src/server/request-body-facts.ts +48 -0
  515. package/src/server/request-decompress.ts +65 -2
  516. package/src/server/request-log-account-rotation.ts +6 -0
  517. package/src/server/request-log-attempt-usage.ts +69 -0
  518. package/src/server/request-log-cache-affinity.ts +60 -0
  519. package/src/server/request-log-conversation.ts +45 -2
  520. package/src/server/request-log-terminal-status.ts +210 -24
  521. package/src/server/request-log.ts +76 -80
  522. package/src/server/reserve-capability-startup.ts +32 -0
  523. package/src/server/responses/adapter-continuation.ts +2 -1
  524. package/src/server/responses/adapter-delivery.ts +4 -0
  525. package/src/server/responses/adapter-dispatch.ts +36 -17
  526. package/src/server/responses/advisor-plan-slot.ts +33 -1
  527. package/src/server/responses/advisor-question.ts +21 -0
  528. package/src/server/responses/advisor-slot.ts +10 -3
  529. package/src/server/responses/antigravity-fault-rotation.ts +24 -0
  530. package/src/server/responses/antigravity-validation-refusal.ts +43 -6
  531. package/src/server/responses/bare-namespace-aliases.ts +18 -0
  532. package/src/server/responses/buffered-sse-json.ts +9 -3
  533. package/src/server/responses/code-mode-collab-surface.ts +11 -0
  534. package/src/server/responses/codex-tool-catalog.ts +156 -0
  535. package/src/server/responses/combo-required-tool-fulfillments.ts +4 -2
  536. package/src/server/responses/combo-selection-keepalive.ts +254 -0
  537. package/src/server/responses/combo-stream-preflight.ts +557 -54
  538. package/src/server/responses/compact.ts +32 -8
  539. package/src/server/responses/core-codex-account.ts +17 -3
  540. package/src/server/responses/core-combo-failure.ts +8 -0
  541. package/src/server/responses/core-combo.ts +55 -12
  542. package/src/server/responses/core-errors.ts +13 -7
  543. package/src/server/responses/core-lifetime.ts +3 -2
  544. package/src/server/responses/core-normalize.ts +3 -1
  545. package/src/server/responses/core-options.ts +14 -0
  546. package/src/server/responses/core.ts +23 -0
  547. package/src/server/responses/estimated-usage.ts +115 -0
  548. package/src/server/responses/fetch-helpers.ts +15 -10
  549. package/src/server/responses/jev-model-invoke.ts +7 -2
  550. package/src/server/responses/native-replay-guard.ts +57 -0
  551. package/src/server/responses/opengateway-completion-guard.ts +10 -4
  552. package/src/server/responses/outbound-request-body.ts +29 -0
  553. package/src/server/responses/passthrough-completion.ts +109 -9
  554. package/src/server/responses/passthrough-delivery.ts +77 -18
  555. package/src/server/responses/passthrough-dispatch.ts +77 -73
  556. package/src/server/responses/policy-fallback.ts +13 -1
  557. package/src/server/responses/request-prepare.ts +59 -11
  558. package/src/server/responses/request-transport.ts +10 -3
  559. package/src/server/responses/reset-replay.ts +46 -2
  560. package/src/server/responses/run-turn-execution.ts +2 -0
  561. package/src/server/responses/sidecar-execution.ts +19 -0
  562. package/src/server/responses/terminal-error-redaction.ts +222 -25
  563. package/src/server/responses/ws-upstream.ts +2 -2
  564. package/src/server/sse-payload-rewrite.ts +3 -2
  565. package/src/server/stop-service-route.ts +85 -0
  566. package/src/server/system-env-shell.ts +12 -1
  567. package/src/server/system-env.ts +5 -3
  568. package/src/server/windows-tcp-drop.ts +21 -4
  569. package/src/server/workflow-refusal.ts +8 -0
  570. package/src/server/ws-bridge.ts +191 -12
  571. package/src/service/cli-windows-stop.ts +189 -0
  572. package/src/service/cli.ts +41 -12
  573. package/src/service/desktop-supervision.d.mts +2 -0
  574. package/src/service/desktop-supervision.mjs +5 -0
  575. package/src/service/disconnected-client-restart.ts +60 -0
  576. package/src/service/guarded-manager-target.ts +18 -1
  577. package/src/service/health.ts +99 -6
  578. package/src/service/launchd.ts +84 -31
  579. package/src/service/orchestration.ts +418 -91
  580. package/src/service/repair.ts +223 -6
  581. package/src/service/restart-proxy-stop.ts +79 -0
  582. package/src/service/service-child-ownership.ts +6 -2
  583. package/src/service/windows-checked-stop-live.ts +467 -0
  584. package/src/service/windows-checked-stop.ts +435 -0
  585. package/src/service/windows-command-line-token.ts +23 -0
  586. package/src/service/windows-guarded-manager.ts +77 -34
  587. package/src/service/windows-ops.ts +38 -56
  588. package/src/service/windows-process-evidence.ts +292 -0
  589. package/src/service/windows-process-native.ts +262 -0
  590. package/src/service/windows-service-stop.ts +321 -0
  591. package/src/service/windows-stop-binding.ts +187 -0
  592. package/src/service/windows-stop-budget.ts +123 -0
  593. package/src/service/windows-stop-confirm.ts +158 -0
  594. package/src/service/windows-stop-deadline.ts +56 -0
  595. package/src/service.ts +2 -2
  596. package/src/stall-timeout.ts +11 -0
  597. package/src/types/config.ts +57 -110
  598. package/src/types/link.ts +20 -0
  599. package/src/types/multi-agent.ts +13 -0
  600. package/src/types/provider.ts +60 -2
  601. package/src/types/request.ts +23 -0
  602. package/src/types/routed-catalog-defaults.ts +17 -0
  603. package/src/types/routing-profile.ts +90 -0
  604. package/src/types.ts +4 -0
  605. package/src/update/guarded-runtime-ops.ts +5 -7
  606. package/src/update/index.ts +26 -11
  607. package/src/update/install-detection.mjs +3 -1
  608. package/src/update/job-pinned-start.ts +2 -0
  609. package/src/update/job-windows-restart.ts +19 -32
  610. package/src/update/job.ts +12 -5
  611. package/src/update/npm-install.d.mts +11 -0
  612. package/src/update/npm-install.mjs +44 -7
  613. package/src/update/orchestrated-entry.ts +1 -1
  614. package/src/update/orchestrated-node-driver.mjs +3 -2
  615. package/src/update/orchestrated-pnpm.d.mts +4 -0
  616. package/src/update/orchestrated-pnpm.mjs +50 -6
  617. package/src/update/orchestrated-session.d.mts +3 -1
  618. package/src/update/orchestrated-session.mjs +21 -6
  619. package/src/update/pnpm-global-install.d.mts +21 -3
  620. package/src/update/pnpm-global-install.mjs +322 -19
  621. package/src/update/pnpm-store-layout.mjs +46 -0
  622. package/src/update/sync-update-mutex.d.mts +3 -2
  623. package/src/update/sync-update-mutex.mjs +57 -8
  624. package/src/update/transactional-install.d.mts +3 -1
  625. package/src/update/transactional-install.mjs +545 -12
  626. package/src/update/windows-installer-marker.d.mts +1 -0
  627. package/src/update/windows-installer-marker.mjs +44 -0
  628. package/src/usage/expected-prices.ts +8 -0
  629. package/src/usage/filter-index.ts +326 -77
  630. package/src/usage/ledger-scanner.ts +15 -0
  631. package/src/usage/link-log-fields.ts +48 -0
  632. package/src/usage/log.ts +57 -6
  633. package/src/usage/request-body.ts +37 -0
  634. package/src/usage/telemetry-contract.ts +1 -0
  635. package/src/web-search/loop.ts +3 -0
  636. package/src/web-search/passthrough-bridge.ts +7 -0
  637. package/gui/dist/assets/App-BpJOzw4F.js +0 -59
  638. package/gui/dist/assets/brand-mark-DU-0Vdkr.js +0 -1
  639. package/gui/dist/assets/index-Bbor_y80.js +0 -94
  640. package/gui/dist/assets/index-DJEkIDAi.css +0 -2
  641. package/gui/dist/classic/assets/App-BrIlUiLc.js +0 -58
  642. package/gui/dist/classic/assets/index-DyJHagvT.js +0 -94
  643. package/gui/dist/classic/assets/quota-summary-CakPe9Ni.js +0 -1
  644. package/src/server/management/desktop-compatibility-authorization.ts +0 -12
@@ -0,0 +1,749 @@
1
+ //! RFC 6455 framing for the Responses WebSocket over a Remote Link (design T4 3.3).
2
+ //!
3
+ //! ocx-child is both ends of the relay: a server toward Codex (frames Codex sends are masked, frames it
4
+ //! receives must not be) and a client toward the Home (the reverse). One reader handles both roles and
5
+ //! enforces the same rules the TypeScript Child's framer does:
6
+ //!
7
+ //! - RSV bits zero; opcodes 0, 1, 2, 8, 9 and 10 only;
8
+ //! - control frames of at most 125 bytes and never fragmented;
9
+ //! - continuation frames only inside a message, and a new data frame only outside one;
10
+ //! - minimal length encoding, with the top bit of a 64-bit length zero;
11
+ //! - masking as the role requires: frames from a client masked, frames from a server unmasked;
12
+ //! - UTF-8 validation of complete text messages and close reasons (a leading U+FEFF is kept);
13
+ //! - close codes 1000-1003, 1007-1014 and 3000-4999 only;
14
+ //! - a message limit checked before a payload is held, and at most a bounded number of fragments;
15
+ //! - at most the limit plus a 14-byte header held: an unfragmented message gets a buffer of its exact
16
+ //! size, a fragmented one is written into one buffer reserved once at the limit (no growth), and a
17
+ //! control frame between fragments uses its own buffer of at most 125 bytes.
18
+ //!
19
+ //! A violation returns the fault whose close code to send; events completed earlier in the same input
20
+ //! are already in the caller's vector. The reader never interprets a message.
21
+
22
+ /// Largest control-frame payload.
23
+ pub const MAX_CONTROL_PAYLOAD: usize = 125;
24
+
25
+ /// Which peer the bytes come from.
26
+ #[derive(Debug, Clone, Copy, PartialEq, Eq)]
27
+ pub enum Role {
28
+ /// Frames a client sent (Codex): each must be masked.
29
+ FromClient,
30
+ /// Frames a server sent (the Home): none may be masked.
31
+ FromServer,
32
+ }
33
+
34
+ #[derive(Debug, PartialEq, Eq)]
35
+ pub enum FrameEvent {
36
+ Text(String),
37
+ /// A binary message, by size only.
38
+ Binary(usize),
39
+ Ping(Vec<u8>),
40
+ Pong(Vec<u8>),
41
+ /// A close frame: its code (None when it carried none) and reason.
42
+ Close(Option<u16>, String),
43
+ }
44
+
45
+ #[derive(Debug, Clone, Copy, PartialEq, Eq)]
46
+ pub enum ProtocolFault {
47
+ Protocol,
48
+ Utf8,
49
+ TooLarge,
50
+ }
51
+
52
+ impl ProtocolFault {
53
+ /// The close code to send for this fault.
54
+ pub fn close_code(self) -> u16 {
55
+ match self {
56
+ ProtocolFault::Protocol => 1002,
57
+ ProtocolFault::Utf8 => 1007,
58
+ ProtocolFault::TooLarge => 1009,
59
+ }
60
+ }
61
+ }
62
+
63
+ /// A close code that may appear in a close frame on the wire (1004, 1005, 1006 and 1015 never may).
64
+ pub fn is_wire_close_code(code: u16) -> bool {
65
+ (1000..=1003).contains(&code) || (1007..=1014).contains(&code) || (3000..=4999).contains(&code)
66
+ }
67
+
68
+ struct Frame {
69
+ fin: bool,
70
+ opcode: u8,
71
+ mask: Option<[u8; 4]>,
72
+ len: usize,
73
+ filled: usize,
74
+ /// True when the payload goes into the reassembly buffer.
75
+ fragment: bool,
76
+ own: Vec<u8>,
77
+ }
78
+
79
+ pub struct FrameReader {
80
+ role: Role,
81
+ max_message: usize,
82
+ max_fragments: usize,
83
+ header: [u8; 14],
84
+ header_len: usize,
85
+ header_needed: usize,
86
+ frame: Option<Frame>,
87
+ assembly: Option<Vec<u8>>,
88
+ fragment_count: usize,
89
+ /// Opcode of the message in progress (1 or 2), or 0 outside a message.
90
+ message_opcode: u8,
91
+ done: bool,
92
+ }
93
+
94
+ impl FrameReader {
95
+ pub fn new(role: Role, max_message: usize, max_fragments: usize) -> Self {
96
+ Self {
97
+ role,
98
+ max_message,
99
+ max_fragments,
100
+ header: [0; 14],
101
+ header_len: 0,
102
+ header_needed: 2,
103
+ frame: None,
104
+ assembly: None,
105
+ fragment_count: 0,
106
+ message_opcode: 0,
107
+ done: false,
108
+ }
109
+ }
110
+
111
+ /// True once a close frame was read or a fault was returned; later bytes are ignored.
112
+ pub fn closed(&self) -> bool {
113
+ self.done
114
+ }
115
+
116
+ /// Payload and header bytes this reader holds right now.
117
+ pub fn held_bytes(&self) -> usize {
118
+ let own = self.frame.as_ref().map_or(0, |f| f.own.capacity());
119
+ self.assembly.as_ref().map_or(0, |a| a.capacity()) + own + self.header_len
120
+ }
121
+
122
+ /// Feed bytes off the socket. Completed events are appended to `events` in wire order, also when a
123
+ /// later frame in the same input is refused.
124
+ pub fn push(&mut self, data: &[u8], events: &mut Vec<FrameEvent>) -> Result<(), ProtocolFault> {
125
+ let result = self.push_inner(data, events);
126
+ if result.is_err() {
127
+ self.done = true;
128
+ self.frame = None;
129
+ self.assembly = None;
130
+ }
131
+ result
132
+ }
133
+
134
+ fn push_inner(
135
+ &mut self,
136
+ data: &[u8],
137
+ events: &mut Vec<FrameEvent>,
138
+ ) -> Result<(), ProtocolFault> {
139
+ let mut offset = 0;
140
+ while offset < data.len() && !self.done {
141
+ if self.frame.is_none() {
142
+ let take = (self.header_needed - self.header_len).min(data.len() - offset);
143
+ self.header[self.header_len..self.header_len + take]
144
+ .copy_from_slice(&data[offset..offset + take]);
145
+ self.header_len += take;
146
+ offset += take;
147
+ if self.header_len < self.header_needed {
148
+ continue;
149
+ }
150
+ if self.header_needed == 2 {
151
+ self.header_needed = self.first_two()?;
152
+ if self.header_len < self.header_needed {
153
+ continue;
154
+ }
155
+ }
156
+ self.start_frame(events)?;
157
+ continue;
158
+ }
159
+ let frame = self.frame.as_mut().expect("frame in progress");
160
+ let take = (frame.len - frame.filled).min(data.len() - offset);
161
+ let chunk = &data[offset..offset + take];
162
+ let target: &mut Vec<u8> = if frame.fragment {
163
+ self.assembly.as_mut().expect("reassembly buffer")
164
+ } else {
165
+ &mut frame.own
166
+ };
167
+ match frame.mask {
168
+ Some(mask) => {
169
+ let base = frame.filled;
170
+ target.extend(
171
+ chunk
172
+ .iter()
173
+ .enumerate()
174
+ .map(|(i, b)| b ^ mask[(base + i) & 3]),
175
+ );
176
+ }
177
+ None => target.extend_from_slice(chunk),
178
+ }
179
+ frame.filled += take;
180
+ offset += take;
181
+ if frame.filled == frame.len {
182
+ let done = self.frame.take().expect("frame in progress");
183
+ self.end_frame(done, events)?;
184
+ }
185
+ }
186
+ Ok(())
187
+ }
188
+
189
+ /// Validate the first two header bytes; returns the full header length.
190
+ fn first_two(&self) -> Result<usize, ProtocolFault> {
191
+ let (b0, b1) = (self.header[0], self.header[1]);
192
+ let fin = b0 & 0x80 != 0;
193
+ let opcode = b0 & 0x0f;
194
+ let masked = b1 & 0x80 != 0;
195
+ let len7 = b1 & 0x7f;
196
+ if b0 & 0x70 != 0 || ![0, 1, 2, 8, 9, 10].contains(&opcode) {
197
+ return Err(ProtocolFault::Protocol);
198
+ }
199
+ if masked != (self.role == Role::FromClient) {
200
+ return Err(ProtocolFault::Protocol);
201
+ }
202
+ if opcode >= 8 && (!fin || len7 > 125) {
203
+ return Err(ProtocolFault::Protocol);
204
+ }
205
+ if opcode == 0 && self.message_opcode == 0 {
206
+ return Err(ProtocolFault::Protocol);
207
+ }
208
+ if (opcode == 1 || opcode == 2) && self.message_opcode != 0 {
209
+ return Err(ProtocolFault::Protocol);
210
+ }
211
+ let extended = match len7 {
212
+ 126 => 2,
213
+ 127 => 8,
214
+ _ => 0,
215
+ };
216
+ Ok(2 + extended + if masked { 4 } else { 0 })
217
+ }
218
+
219
+ fn start_frame(&mut self, events: &mut Vec<FrameEvent>) -> Result<(), ProtocolFault> {
220
+ let (b0, b1) = (self.header[0], self.header[1]);
221
+ let fin = b0 & 0x80 != 0;
222
+ let opcode = b0 & 0x0f;
223
+ let masked = b1 & 0x80 != 0;
224
+ let len7 = (b1 & 0x7f) as u64;
225
+ let (len, mask_at) = match len7 {
226
+ 126 => {
227
+ let len = u16::from_be_bytes([self.header[2], self.header[3]]) as u64;
228
+ if len < 126 {
229
+ return Err(ProtocolFault::Protocol);
230
+ }
231
+ (len, 4)
232
+ }
233
+ 127 => {
234
+ let mut bytes = [0u8; 8];
235
+ bytes.copy_from_slice(&self.header[2..10]);
236
+ let len = u64::from_be_bytes(bytes);
237
+ if len & (1 << 63) != 0 {
238
+ return Err(ProtocolFault::Protocol);
239
+ }
240
+ if len <= 0xffff {
241
+ return Err(ProtocolFault::Protocol);
242
+ }
243
+ (len, 10)
244
+ }
245
+ short => (short, 2),
246
+ };
247
+ let mask = if masked {
248
+ let mut m = [0u8; 4];
249
+ m.copy_from_slice(&self.header[mask_at..mask_at + 4]);
250
+ Some(m)
251
+ } else {
252
+ None
253
+ };
254
+ let fragment = opcode < 8 && (opcode == 0 || !fin);
255
+ if opcode < 8 {
256
+ if self.fragment_count + 1 > self.max_fragments {
257
+ return Err(ProtocolFault::TooLarge);
258
+ }
259
+ let held = self.assembly.as_ref().map_or(0, |a| a.len()) as u64;
260
+ if held.saturating_add(len) > self.max_message as u64 {
261
+ return Err(ProtocolFault::TooLarge);
262
+ }
263
+ }
264
+ let len = len as usize;
265
+ if fragment && self.assembly.is_none() {
266
+ self.assembly = Some(Vec::with_capacity(self.max_message));
267
+ }
268
+ self.header_len = 0;
269
+ self.header_needed = 2;
270
+ let frame = Frame {
271
+ fin,
272
+ opcode,
273
+ mask,
274
+ len,
275
+ filled: 0,
276
+ fragment,
277
+ own: if fragment {
278
+ Vec::new()
279
+ } else {
280
+ Vec::with_capacity(len)
281
+ },
282
+ };
283
+ if len == 0 {
284
+ self.end_frame(frame, events)
285
+ } else {
286
+ self.frame = Some(frame);
287
+ Ok(())
288
+ }
289
+ }
290
+
291
+ fn end_frame(
292
+ &mut self,
293
+ frame: Frame,
294
+ events: &mut Vec<FrameEvent>,
295
+ ) -> Result<(), ProtocolFault> {
296
+ match frame.opcode {
297
+ 9 => {
298
+ events.push(FrameEvent::Ping(frame.own));
299
+ return Ok(());
300
+ }
301
+ 10 => {
302
+ events.push(FrameEvent::Pong(frame.own));
303
+ return Ok(());
304
+ }
305
+ 8 => {
306
+ self.done = true;
307
+ let payload = frame.own;
308
+ if payload.is_empty() {
309
+ events.push(FrameEvent::Close(None, String::new()));
310
+ return Ok(());
311
+ }
312
+ if payload.len() == 1 {
313
+ return Err(ProtocolFault::Protocol);
314
+ }
315
+ let code = u16::from_be_bytes([payload[0], payload[1]]);
316
+ if !is_wire_close_code(code) {
317
+ return Err(ProtocolFault::Protocol);
318
+ }
319
+ let reason =
320
+ String::from_utf8(payload[2..].to_vec()).map_err(|_| ProtocolFault::Utf8)?;
321
+ events.push(FrameEvent::Close(Some(code), reason));
322
+ return Ok(());
323
+ }
324
+ _ => {}
325
+ }
326
+ if frame.opcode != 0 {
327
+ self.message_opcode = frame.opcode;
328
+ }
329
+ self.fragment_count += 1;
330
+ if !frame.fin {
331
+ return Ok(());
332
+ }
333
+ let message = if frame.fragment {
334
+ self.assembly.take().unwrap_or_default()
335
+ } else {
336
+ frame.own
337
+ };
338
+ let opcode = self.message_opcode;
339
+ self.fragment_count = 0;
340
+ self.message_opcode = 0;
341
+ if opcode == 1 {
342
+ let text = String::from_utf8(message).map_err(|_| ProtocolFault::Utf8)?;
343
+ events.push(FrameEvent::Text(text));
344
+ } else {
345
+ events.push(FrameEvent::Binary(message.len()));
346
+ }
347
+ Ok(())
348
+ }
349
+ }
350
+
351
+ /// The header of one final frame of `len` payload bytes; with a mask, the caller masks the payload
352
+ /// (mask_in_place) before writing it after this header.
353
+ pub fn frame_header(opcode: u8, len: usize, mask: Option<[u8; 4]>) -> Vec<u8> {
354
+ let mut out = Vec::with_capacity(14);
355
+ out.push(0x80 | opcode);
356
+ let mask_bit = if mask.is_some() { 0x80 } else { 0 };
357
+ if len < 126 {
358
+ out.push(mask_bit | len as u8);
359
+ } else if len <= 0xffff {
360
+ out.push(mask_bit | 126);
361
+ out.extend_from_slice(&(len as u16).to_be_bytes());
362
+ } else {
363
+ out.push(mask_bit | 127);
364
+ out.extend_from_slice(&(len as u64).to_be_bytes());
365
+ }
366
+ if let Some(m) = mask {
367
+ out.extend_from_slice(&m);
368
+ }
369
+ out
370
+ }
371
+
372
+ pub fn mask_in_place(payload: &mut [u8], mask: [u8; 4]) {
373
+ for (i, b) in payload.iter_mut().enumerate() {
374
+ *b ^= mask[i & 3];
375
+ }
376
+ }
377
+
378
+ /// A whole control frame (at most 125 bytes of payload), masked when a mask is given.
379
+ pub fn control_frame(opcode: u8, payload: &[u8], mask: Option<[u8; 4]>) -> Vec<u8> {
380
+ let payload = &payload[..payload.len().min(MAX_CONTROL_PAYLOAD)];
381
+ let mut out = frame_header(opcode, payload.len(), mask);
382
+ let start = out.len();
383
+ out.extend_from_slice(payload);
384
+ if let Some(m) = mask {
385
+ mask_in_place(&mut out[start..], m);
386
+ }
387
+ out
388
+ }
389
+
390
+ /// A close payload: a code that may not appear on the wire gives an empty payload; the reason is cut
391
+ /// to 123 bytes on a character boundary.
392
+ pub fn close_payload(code: Option<u16>, reason: &str) -> Vec<u8> {
393
+ let Some(code) = code.filter(|c| is_wire_close_code(*c)) else {
394
+ return Vec::new();
395
+ };
396
+ let mut end = reason.len().min(123);
397
+ while !reason.is_char_boundary(end) {
398
+ end -= 1;
399
+ }
400
+ let mut out = Vec::with_capacity(2 + end);
401
+ out.extend_from_slice(&code.to_be_bytes());
402
+ out.extend_from_slice(&reason.as_bytes()[..end]);
403
+ out
404
+ }
405
+
406
+ #[cfg(test)]
407
+ mod tests {
408
+ use super::*;
409
+
410
+ const MASK: [u8; 4] = [1, 2, 3, 4];
411
+
412
+ fn frame(opcode: u8, payload: &[u8], fin: bool, masked: bool) -> Vec<u8> {
413
+ let mut out = vec![(if fin { 0x80 } else { 0 }) | opcode];
414
+ let bit = if masked { 0x80 } else { 0 };
415
+ let len = payload.len();
416
+ if len < 126 {
417
+ out.push(bit | len as u8);
418
+ } else if len <= 0xffff {
419
+ out.push(bit | 126);
420
+ out.extend_from_slice(&(len as u16).to_be_bytes());
421
+ } else {
422
+ out.push(bit | 127);
423
+ out.extend_from_slice(&(len as u64).to_be_bytes());
424
+ }
425
+ if masked {
426
+ out.extend_from_slice(&MASK);
427
+ out.extend(payload.iter().enumerate().map(|(i, b)| b ^ MASK[i & 3]));
428
+ } else {
429
+ out.extend_from_slice(payload);
430
+ }
431
+ out
432
+ }
433
+
434
+ fn server(opcode: u8, payload: &[u8]) -> Vec<u8> {
435
+ frame(opcode, payload, true, false)
436
+ }
437
+ fn client(opcode: u8, payload: &[u8]) -> Vec<u8> {
438
+ frame(opcode, payload, true, true)
439
+ }
440
+
441
+ fn read(role: Role, max: usize, chunks: &[&[u8]]) -> Result<Vec<FrameEvent>, ProtocolFault> {
442
+ let mut reader = FrameReader::new(role, max, 4);
443
+ let mut events = Vec::new();
444
+ for chunk in chunks {
445
+ reader.push(chunk, &mut events)?;
446
+ }
447
+ Ok(events)
448
+ }
449
+
450
+ fn close(code: u16, reason: &str) -> Vec<u8> {
451
+ let mut p = code.to_be_bytes().to_vec();
452
+ p.extend_from_slice(reason.as_bytes());
453
+ p
454
+ }
455
+
456
+ #[test]
457
+ fn text_from_either_role_whatever_the_chunking() {
458
+ let f = server(1, "h\u{e9}llo".as_bytes());
459
+ let whole = read(Role::FromServer, 1024, &[&f]).unwrap();
460
+ assert_eq!(whole, vec![FrameEvent::Text("h\u{e9}llo".into())]);
461
+ let bytes: Vec<&[u8]> = f.chunks(1).collect();
462
+ assert_eq!(read(Role::FromServer, 1024, &bytes).unwrap(), whole);
463
+ let c = client(1, b"masked");
464
+ assert_eq!(
465
+ read(Role::FromClient, 1024, &[&c]).unwrap(),
466
+ vec![FrameEvent::Text("masked".into())]
467
+ );
468
+ }
469
+
470
+ #[test]
471
+ fn masking_must_match_the_role() {
472
+ assert_eq!(
473
+ read(Role::FromServer, 1024, &[&client(1, b"a")]),
474
+ Err(ProtocolFault::Protocol)
475
+ );
476
+ assert_eq!(
477
+ read(Role::FromClient, 1024, &[&server(1, b"a")]),
478
+ Err(ProtocolFault::Protocol)
479
+ );
480
+ }
481
+
482
+ #[test]
483
+ fn rsv_opcodes_and_control_rules() {
484
+ let mut rsv = server(1, b"a");
485
+ rsv[0] |= 0x40;
486
+ assert_eq!(
487
+ read(Role::FromServer, 1024, &[&rsv]),
488
+ Err(ProtocolFault::Protocol)
489
+ );
490
+ for op in [3u8, 7, 11, 15] {
491
+ assert_eq!(
492
+ read(Role::FromServer, 1024, &[&server(op, b"a")]),
493
+ Err(ProtocolFault::Protocol)
494
+ );
495
+ }
496
+ assert_eq!(
497
+ read(Role::FromServer, 1024, &[&server(9, &[0; 126])]),
498
+ Err(ProtocolFault::Protocol)
499
+ );
500
+ assert_eq!(
501
+ read(Role::FromServer, 1024, &[&frame(9, b"x", false, false)]),
502
+ Err(ProtocolFault::Protocol)
503
+ );
504
+ }
505
+
506
+ #[test]
507
+ fn continuation_order() {
508
+ assert_eq!(
509
+ read(Role::FromServer, 1024, &[&server(0, b"a")]),
510
+ Err(ProtocolFault::Protocol)
511
+ );
512
+ assert_eq!(
513
+ read(
514
+ Role::FromServer,
515
+ 1024,
516
+ &[&frame(1, b"a", false, false), &server(1, b"b")]
517
+ ),
518
+ Err(ProtocolFault::Protocol)
519
+ );
520
+ let events = read(
521
+ Role::FromServer,
522
+ 1024,
523
+ &[
524
+ &frame(1, b"he", false, false),
525
+ &server(9, b"p"),
526
+ &frame(0, b"ll", false, false),
527
+ &server(0, b"o"),
528
+ ],
529
+ )
530
+ .unwrap();
531
+ assert_eq!(
532
+ events,
533
+ vec![
534
+ FrameEvent::Ping(b"p".to_vec()),
535
+ FrameEvent::Text("hello".into())
536
+ ]
537
+ );
538
+ }
539
+
540
+ #[test]
541
+ fn length_encodings() {
542
+ let mut short16 = vec![0x81, 126, 0, 5];
543
+ short16.extend_from_slice(b"short");
544
+ assert_eq!(
545
+ read(Role::FromServer, 1024, &[&short16]),
546
+ Err(ProtocolFault::Protocol)
547
+ );
548
+ let mut short64 = vec![0x81, 127, 0, 0, 0, 0, 0, 0, 0, 5];
549
+ short64.extend_from_slice(b"short");
550
+ assert_eq!(
551
+ read(Role::FromServer, 1024, &[&short64]),
552
+ Err(ProtocolFault::Protocol)
553
+ );
554
+ assert_eq!(
555
+ read(
556
+ Role::FromServer,
557
+ 1024,
558
+ &[&[0x81, 127, 0x80, 0, 0, 0, 0, 0, 0, 1]]
559
+ ),
560
+ Err(ProtocolFault::Protocol)
561
+ );
562
+ assert_eq!(
563
+ read(
564
+ Role::FromServer,
565
+ 1024,
566
+ &[&[0x81, 127, 0, 0, 0, 1, 0, 0, 0, 1]]
567
+ ),
568
+ Err(ProtocolFault::TooLarge)
569
+ );
570
+ let big = vec![b'y'; 70_000];
571
+ assert_eq!(
572
+ read(Role::FromServer, 70_000, &[&server(1, &big)]).unwrap(),
573
+ vec![FrameEvent::Text(String::from_utf8(big).unwrap())]
574
+ );
575
+ }
576
+
577
+ #[test]
578
+ fn limits_and_utf8() {
579
+ assert_eq!(
580
+ read(Role::FromServer, 1024, &[&[0x81, 126, 0x04, 0x01]]),
581
+ Err(ProtocolFault::TooLarge)
582
+ );
583
+ assert_eq!(
584
+ read(
585
+ Role::FromServer,
586
+ 1024,
587
+ &[
588
+ &frame(1, &[b'x'; 600], false, false),
589
+ &server(0, &[b'y'; 600])
590
+ ]
591
+ ),
592
+ Err(ProtocolFault::TooLarge)
593
+ );
594
+ let five: Vec<Vec<u8>> = (0..5)
595
+ .map(|i| frame(if i == 0 { 1 } else { 0 }, b"a", i == 4, false))
596
+ .collect();
597
+ let refs: Vec<&[u8]> = five.iter().map(|v| v.as_slice()).collect();
598
+ assert_eq!(
599
+ read(Role::FromServer, 1024, &refs),
600
+ Err(ProtocolFault::TooLarge)
601
+ );
602
+ assert_eq!(
603
+ read(Role::FromServer, 1024, &[&server(1, &[0xc3, 0x28])]),
604
+ Err(ProtocolFault::Utf8)
605
+ );
606
+ let e = "\u{e9}".as_bytes();
607
+ assert_eq!(
608
+ read(
609
+ Role::FromServer,
610
+ 1024,
611
+ &[&frame(1, &e[..1], false, false), &server(0, &e[1..])]
612
+ )
613
+ .unwrap(),
614
+ vec![FrameEvent::Text("\u{e9}".into())]
615
+ );
616
+ assert_eq!(
617
+ read(
618
+ Role::FromServer,
619
+ 1024,
620
+ &[&server(1, "\u{feff}bom".as_bytes())]
621
+ )
622
+ .unwrap(),
623
+ vec![FrameEvent::Text("\u{feff}bom".into())]
624
+ );
625
+ }
626
+
627
+ #[test]
628
+ fn close_frames() {
629
+ assert_eq!(
630
+ read(
631
+ Role::FromServer,
632
+ 1024,
633
+ &[&server(8, &close(4401, "link revoked"))]
634
+ )
635
+ .unwrap(),
636
+ vec![FrameEvent::Close(Some(4401), "link revoked".into())]
637
+ );
638
+ assert_eq!(
639
+ read(Role::FromServer, 1024, &[&server(8, &[])]).unwrap(),
640
+ vec![FrameEvent::Close(None, String::new())]
641
+ );
642
+ assert_eq!(
643
+ read(Role::FromServer, 1024, &[&server(8, &[3])]),
644
+ Err(ProtocolFault::Protocol)
645
+ );
646
+ for code in [999u16, 1004, 1005, 1006, 1015, 2999, 5000] {
647
+ assert_eq!(
648
+ read(Role::FromServer, 1024, &[&server(8, &close(code, ""))]),
649
+ Err(ProtocolFault::Protocol)
650
+ );
651
+ }
652
+ for code in [1012u16, 1013, 1014] {
653
+ assert_eq!(
654
+ read(Role::FromServer, 1024, &[&server(8, &close(code, ""))]).unwrap(),
655
+ vec![FrameEvent::Close(Some(code), String::new())]
656
+ );
657
+ }
658
+ let mut bad = close(1000, "");
659
+ bad.push(0xff);
660
+ assert_eq!(
661
+ read(Role::FromServer, 1024, &[&server(8, &bad)]),
662
+ Err(ProtocolFault::Utf8)
663
+ );
664
+ }
665
+
666
+ #[test]
667
+ fn events_before_a_fault_are_kept_and_nothing_is_read_after() {
668
+ let mut reader = FrameReader::new(Role::FromServer, 1024, 4);
669
+ let mut events = Vec::new();
670
+ let mut input = server(1, b"done");
671
+ input.extend_from_slice(&[0xc1, 1, b'x']);
672
+ assert_eq!(
673
+ reader.push(&input, &mut events),
674
+ Err(ProtocolFault::Protocol)
675
+ );
676
+ assert_eq!(events, vec![FrameEvent::Text("done".into())]);
677
+ assert!(reader.closed());
678
+ let mut after = Vec::new();
679
+ assert_eq!(reader.push(&server(1, b"later"), &mut after), Ok(()));
680
+ assert!(after.is_empty());
681
+ }
682
+
683
+ #[test]
684
+ fn held_bytes_stay_within_the_limit() {
685
+ let mut reader = FrameReader::new(Role::FromServer, 1024, 8);
686
+ let mut events = Vec::new();
687
+ reader
688
+ .push(&frame(1, &[b'a'; 600], false, false), &mut events)
689
+ .unwrap();
690
+ reader.push(&server(0, &[b'b'; 400]), &mut events).unwrap();
691
+ assert_eq!(reader.held_bytes(), 0);
692
+ let big = server(1, &[b'c'; 1020]);
693
+ reader.push(&big[..big.len() - 10], &mut events).unwrap();
694
+ assert!(reader.held_bytes() <= 1024 + 14);
695
+ reader.push(&big[big.len() - 10..], &mut events).unwrap();
696
+ reader
697
+ .push(&frame(1, &[b'd'; 500], false, false), &mut events)
698
+ .unwrap();
699
+ assert_eq!(reader.held_bytes(), 1024);
700
+ }
701
+
702
+ #[test]
703
+ fn binary_by_size() {
704
+ assert_eq!(
705
+ read(Role::FromServer, 1024, &[&server(2, &[1, 2, 3])]).unwrap(),
706
+ vec![FrameEvent::Binary(3)]
707
+ );
708
+ }
709
+
710
+ #[test]
711
+ fn writing() {
712
+ let mut payload = b"ab".to_vec();
713
+ let header = frame_header(1, payload.len(), Some([0, 0, 0, 0]));
714
+ mask_in_place(&mut payload, [0, 0, 0, 0]);
715
+ assert_eq!(
716
+ [header, payload].concat(),
717
+ vec![0x81, 0x82, 0, 0, 0, 0, b'a', b'b']
718
+ );
719
+ for size in [0usize, 125, 126, 65_535, 65_536] {
720
+ let text = vec![b'z'; size];
721
+ let mut body = text.clone();
722
+ let mut wire = frame_header(1, size, Some(MASK));
723
+ mask_in_place(&mut body, MASK);
724
+ wire.extend_from_slice(&body);
725
+ let events = read(Role::FromClient, 70_000, &[&wire]).unwrap();
726
+ assert_eq!(
727
+ events,
728
+ vec![FrameEvent::Text(String::from_utf8(text).unwrap())]
729
+ );
730
+ }
731
+ let unmasked = control_frame(10, b"hi", None);
732
+ assert_eq!(unmasked, vec![0x8a, 2, b'h', b'i']);
733
+ assert_eq!(close_payload(Some(1006), "x"), Vec::<u8>::new());
734
+ assert_eq!(close_payload(None, "x"), Vec::<u8>::new());
735
+ let long = close_payload(Some(1000), &"\u{e9}".repeat(100));
736
+ assert!(long.len() <= 125);
737
+ assert!(std::str::from_utf8(&long[2..]).is_ok());
738
+ assert!(
739
+ [1000u16, 1003, 1007, 1011, 1012, 1013, 1014, 3000, 4999]
740
+ .iter()
741
+ .all(|c| is_wire_close_code(*c))
742
+ );
743
+ assert!(
744
+ ![999u16, 1004, 1005, 1006, 1015, 2999, 5000]
745
+ .iter()
746
+ .any(|c| is_wire_close_code(*c))
747
+ );
748
+ }
749
+ }