release-2.9.0 (#1532)

* fix(macos): skip single-instance lock in Mac App Store builds (#1454)

fix(macos): skip single-instance lock in Mac App Store builds

* Fix/backend optional sharp (#1455)

Fix/backend optional sharp

* feat: issue #1218 (#1218)

https://github.com/Termix-SSH/Support/issues/1218

* feat: Add option to use saved global custom theme under Connection Defaults (#1209)

https://github.com/Termix-SSH/Support/issues/1209

* feat: Add Fleet Sharing functionality to the UI (#1228)

https://github.com/Termix-SSH/Support/issues/1228

* feat: Add a list view to the Docker management page (#1237)

https://github.com/Termix-SSH/Support/issues/1237

* feat: issue #1264 (#1264)

https://github.com/Termix-SSH/Support/issues/1264

* feat: 2FA With FortiToken (#1288)

https://github.com/Termix-SSH/Support/issues/1288

* feat: Allow to disable showing paths to folders (#1274)

https://github.com/Termix-SSH/Support/issues/1274

* feat: Sync Network Graph between Desktop and Remote Server (#1245)

https://github.com/Termix-SSH/Support/issues/1245

* feat: Version Number on offline servers (#1291)

https://github.com/Termix-SSH/Support/issues/1291

* feat: Support OrbStack Docker socket path on macOS / Fix "Docker is not installed" on mac... (#1302)

https://github.com/Termix-SSH/Support/issues/1302

* feat: Sidebar host click should focus existing tab instead of opening a new connection (#1289)

https://github.com/Termix-SSH/Support/issues/1289

* fix: Search in side bar shows overlapping hosts when grouped by tags (#1303)

https://github.com/Termix-SSH/Support/issues/1303

* fix: I can't send a file on its own. (#1304)

https://github.com/Termix-SSH/Support/issues/1304

* fix: sudo password not autofilling (#1248)

https://github.com/Termix-SSH/Support/issues/1248

* fix: node-MainThread (#1300)

https://github.com/Termix-SSH/Support/issues/1300

* fix: Tunnel authentication with shared credentials (#1295)

https://github.com/Termix-SSH/Support/issues/1295

* fix: host key updates not syncing, metrics 404 race on first connect

Host key writes never bumped updatedAt so sync never picked them up.
Also retry the first metrics fetch briefly instead of failing right away.

* chore: increment ver

* feat: add category and icon fields to plugin manifest schema

* ci(deps): bump the github-actions group with 2 updates (#1458)

Bumps the github-actions group with 2 updates: [crowdin/github-action](https://github.com/crowdin/github-action) and [actions/github-script](https://github.com/actions/github-script).


Updates `crowdin/github-action` from 2 to 3
- [Release notes](https://github.com/crowdin/github-action/releases)
- [Commits](https://github.com/crowdin/github-action/compare/v2...v3)

Updates `actions/github-script` from 7 to 9
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](https://github.com/actions/github-script/compare/v7...v9)

---
updated-dependencies:
- dependency-name: crowdin/github-action
  dependency-version: '3'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: actions/github-script
  dependency-version: '9'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): bump the dev-patch-updates group with 13 updates (#1459)

Bumps the dev-patch-updates group with 13 updates:

| Package | From | To |
| --- | --- | --- |
| [@codemirror/commands](https://github.com/codemirror/commands) | `6.11.0` | `6.11.1` |
| [@codemirror/search](https://github.com/codemirror/search) | `6.7.1` | `6.7.2` |
| [@codemirror/view](https://github.com/codemirror/view) | `6.43.9` | `6.43.12` |
| [@testing-library/dom](https://github.com/testing-library/dom-testing-library) | `10.4.1` | `10.4.2` |
| [@testing-library/react](https://github.com/testing-library/react-testing-library) | `16.3.2` | `16.3.3` |
| [@testing-library/user-event](https://github.com/testing-library/user-event) | `14.6.5` | `14.6.7` |
| [@types/ssh2](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ssh2) | `1.15.5` | `1.15.6` |
| [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/tree/HEAD/packages/plugin-react) | `6.1.0` | `6.1.1` |
| [cytoscape](https://github.com/cytoscape/cytoscape.js) | `3.34.1` | `3.34.3` |
| [eslint-plugin-react-refresh](https://github.com/ArnaudBarre/eslint-plugin-react-refresh) | `0.5.4` | `0.5.7` |
| [i18next](https://github.com/i18next/i18next) | `26.4.0` | `26.4.2` |
| [prettier](https://github.com/prettier/prettier) | `3.9.6` | `3.9.8` |
| [react-i18next](https://github.com/i18next/react-i18next) | `17.0.12` | `17.0.14` |


Updates `@codemirror/commands` from 6.11.0 to 6.11.1
- [Changelog](https://github.com/codemirror/commands/blob/main/CHANGELOG.md)
- [Commits](https://github.com/codemirror/commands/commits)

Updates `@codemirror/search` from 6.7.1 to 6.7.2
- [Changelog](https://github.com/codemirror/search/blob/main/CHANGELOG.md)
- [Commits](https://github.com/codemirror/search/commits)

Updates `@codemirror/view` from 6.43.9 to 6.43.12
- [Changelog](https://github.com/codemirror/view/blob/main/CHANGELOG.md)
- [Commits](https://github.com/codemirror/view/commits)

Updates `@testing-library/dom` from 10.4.1 to 10.4.2
- [Release notes](https://github.com/testing-library/dom-testing-library/releases)
- [Changelog](https://github.com/testing-library/dom-testing-library/blob/main/CHANGELOG.md)
- [Commits](https://github.com/testing-library/dom-testing-library/compare/v10.4.1...v10.4.2)

Updates `@testing-library/react` from 16.3.2 to 16.3.3
- [Release notes](https://github.com/testing-library/react-testing-library/releases)
- [Changelog](https://github.com/testing-library/react-testing-library/blob/main/CHANGELOG.md)
- [Commits](https://github.com/testing-library/react-testing-library/compare/v16.3.2...v16.3.3)

Updates `@testing-library/user-event` from 14.6.5 to 14.6.7
- [Release notes](https://github.com/testing-library/user-event/releases)
- [Changelog](https://github.com/testing-library/user-event/blob/main/CHANGELOG.md)
- [Commits](https://github.com/testing-library/user-event/compare/v14.6.5...v14.6.7)

Updates `@types/ssh2` from 1.15.5 to 1.15.6
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ssh2)

Updates `@vitejs/plugin-react` from 6.1.0 to 6.1.1
- [Release notes](https://github.com/vitejs/vite-plugin-react/releases)
- [Changelog](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite-plugin-react/commits/plugin-react@6.1.1/packages/plugin-react)

Updates `cytoscape` from 3.34.1 to 3.34.3
- [Release notes](https://github.com/cytoscape/cytoscape.js/releases)
- [Commits](https://github.com/cytoscape/cytoscape.js/compare/v3.34.1...v3.34.3)

Updates `eslint-plugin-react-refresh` from 0.5.4 to 0.5.7
- [Release notes](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/releases)
- [Changelog](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/blob/main/CHANGELOG.md)
- [Commits](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/compare/v0.5.4...v0.5.7)

Updates `i18next` from 26.4.0 to 26.4.2
- [Release notes](https://github.com/i18next/i18next/releases)
- [Changelog](https://github.com/i18next/i18next/blob/master/CHANGELOG.md)
- [Commits](https://github.com/i18next/i18next/compare/v26.4.0...v26.4.2)

Updates `prettier` from 3.9.6 to 3.9.8
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](https://github.com/prettier/prettier/compare/3.9.6...3.9.8)

Updates `react-i18next` from 17.0.12 to 17.0.14
- [Changelog](https://github.com/i18next/react-i18next/blob/master/CHANGELOG.md)
- [Commits](https://github.com/i18next/react-i18next/compare/v17.0.12...v17.0.14)

---
updated-dependencies:
- dependency-name: "@codemirror/commands"
  dependency-version: 6.11.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: "@codemirror/search"
  dependency-version: 6.7.2
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: "@codemirror/view"
  dependency-version: 6.43.12
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: "@testing-library/dom"
  dependency-version: 10.4.2
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: "@testing-library/react"
  dependency-version: 16.3.3
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: "@testing-library/user-event"
  dependency-version: 14.6.7
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: "@types/ssh2"
  dependency-version: 1.15.6
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: "@vitejs/plugin-react"
  dependency-version: 6.1.1
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: cytoscape
  dependency-version: 3.34.3
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: eslint-plugin-react-refresh
  dependency-version: 0.5.7
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: i18next
  dependency-version: 26.4.2
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: prettier
  dependency-version: 3.9.8
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
- dependency-name: react-i18next
  dependency-version: 17.0.14
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: dev-patch-updates
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump the prod-patch-updates group with 6 updates (#1461)

Bumps the prod-patch-updates group with 6 updates:

| Package | From | To |
| --- | --- | --- |
| [@tanstack/react-virtual](https://github.com/TanStack/virtual/tree/HEAD/packages/react-virtual) | `3.14.10` | `3.14.13` |
| [compression](https://github.com/expressjs/compression) | `1.8.1` | `1.8.2` |
| [jose](https://github.com/panva/jose) | `6.2.9` | `6.2.12` |
| [jszip](https://github.com/Stuk/jszip) | `3.10.1` | `3.10.2` |
| [socks](https://github.com/JoshGlazebrook/socks) | `2.8.9` | `2.8.10` |
| [undici](https://github.com/nodejs/undici) | `8.10.0` | `8.10.2` |


Updates `@tanstack/react-virtual` from 3.14.10 to 3.14.13
- [Release notes](https://github.com/TanStack/virtual/releases)
- [Changelog](https://github.com/TanStack/virtual/blob/main/packages/react-virtual/CHANGELOG.md)
- [Commits](https://github.com/TanStack/virtual/commits/@tanstack/react-virtual@3.14.13/packages/react-virtual)

Updates `compression` from 1.8.1 to 1.8.2
- [Release notes](https://github.com/expressjs/compression/releases)
- [Changelog](https://github.com/expressjs/compression/blob/master/HISTORY.md)
- [Commits](https://github.com/expressjs/compression/compare/v1.8.1...v1.8.2)

Updates `jose` from 6.2.9 to 6.2.12
- [Release notes](https://github.com/panva/jose/releases)
- [Changelog](https://github.com/panva/jose/blob/main/CHANGELOG.md)
- [Commits](https://github.com/panva/jose/compare/v6.2.9...v6.2.12)

Updates `jszip` from 3.10.1 to 3.10.2
- [Changelog](https://github.com/Stuk/jszip/blob/main/CHANGES.md)
- [Commits](https://github.com/Stuk/jszip/compare/v3.10.1...v3.10.2)

Updates `socks` from 2.8.9 to 2.8.10
- [Release notes](https://github.com/JoshGlazebrook/socks/releases)
- [Commits](https://github.com/JoshGlazebrook/socks/compare/2.8.9...2.8.10)

Updates `undici` from 8.10.0 to 8.10.2
- [Release notes](https://github.com/nodejs/undici/releases)
- [Commits](https://github.com/nodejs/undici/compare/v8.10.0...v8.10.2)

---
updated-dependencies:
- dependency-name: "@tanstack/react-virtual"
  dependency-version: 3.14.13
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: prod-patch-updates
- dependency-name: compression
  dependency-version: 1.8.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: prod-patch-updates
- dependency-name: jose
  dependency-version: 6.2.12
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: prod-patch-updates
- dependency-name: jszip
  dependency-version: 3.10.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: prod-patch-updates
- dependency-name: socks
  dependency-version: 2.8.10
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: prod-patch-updates
- dependency-name: undici
  dependency-version: 8.10.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: prod-patch-updates
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* feat: add plugin worker protocol, bootstrap and plugin_storage table

Worker-side ctx proxy plus the message envelope it talks over, and the
per-plugin key/value table behind ctx.storage with migrations for all
three dialects. Rows cascade with the plugin so uninstalling leaves
nothing behind.

* feat: add allowlisted host view for plugins

An allowlist rather than a list of fields to strip. A blocklist rots:
the moment a new secret-bearing column lands on SSHHost it starts
leaking silently. With an allowlist a new field stays invisible to
plugins until someone adds it here on purpose.

* feat: add plugin loader with manifest validation and crash restart

Validates an unpacked plugin, spawns a worker_threads worker and manages
activate/deactivate/crash-restart with backoff, disabling after three
tries.

The crash counter clears only after a plugin stays up past a stability
window, not on activation. Clearing it on activation let a plugin that
activates cleanly and then dies restart forever, because every attempt
looked like the first.

loader.ts documents what the worker boundary does and does not buy you.
Node's permission model is process-wide, not per-worker, so it cannot be
enabled for plugin workers alone and is not claimed here.

* feat: route internal events through a shared plugin event bus

Formalises three ad-hoc publish paths that already existed:
automation-events.ts, metrics/automation-bridge.ts and the
hostSessionStatus singleton, now the host.session.status topic.

Both invariants the old code relied on are preserved. Publishing stays
fire-and-forget, so a failing subscriber cannot disturb a metrics poll or
a host delete. The automations engine subscribes to the bus at scheduler
start instead of being imported ad hoc, which keeps the edge
one-directional: automations may import repositories, hosts modules must
not import automations.

* feat: add plugin ctx broker with permission gate and audit

Every ctx call a plugin makes is checked against its granted
capabilities, performed by the main thread, then audited. A capability
must be both declared in the manifest and granted in the database, so
widening a plugin's reach always needs a new manifest the user can see,
never just a database row.

Audit attribution is set by the broker, not the plugin. The plugin
supplies only the details, so it cannot forge the actor.

fix: stop plugin workers seeing plaintext credentials in error messages

A failing ctx.ssh.connect handed the worker the raw error from deep in
the SSH stack, which embeds the connect config. The worker received, in
full:

  Authentication failed for root using password <SECRET>

where <SECRET> was the host's real plaintext password. Any plugin with
ssh.exec could read it by catching the error, defeating the whole point
of the handle-based ssh API.

Errors crossing the boundary are now sanitised. Only PluginFacingError
and PluginPermissionError, both authored here, reach a plugin verbatim;
anything else becomes a generic message and the real one goes to the
log. This uses a marker class rather than matching on message text,
because matching would start leaking again the moment an upstream error
happened to contain a familiar phrase.

Covered by credential-isolation.test.ts, which plants a sentinel in
every secret-bearing field and asserts it appears in no message the
worker ever receives.

* feat: dispatch plugin HTTP routes and wire the runtime into startup

ctx.http.route now registers a real router on the /plugin-api/:pluginId
dispatcher, replacing its stub 404. A plugin never touches the Express
req/res: it gets a plain summary and returns a plain object, so sockets
and session cookies stay on this side of the boundary. Authorization and
cookie headers are not forwarded.

Plugins load last in the start-up sequence, after the server is fully
wired, and are terminated before the database on shutdown so none can
outlive it. A plugin that fails to load cannot stop the backend.

fix: correct the nginx plugin-api location regex

The pattern was ^/plugin-api/(/.*)?$, which needs a double slash and so
never matched /plugin-api/<id>/<route>. Every other block in the file
uses ^/prefix(/.*)?$. Left alone, plugin routes would work in dev and
404 only behind Docker.

* fix: update stale SFTP transfer test for single file destination paths

The test still asserted transferToHost was called with the destination
directory "/srv". Commit 7727fa09 (#1304) deliberately changed a single
file transfer to send the full destination path including the filename,
so the correct expectation is "/srv/remote-1.txt". The code was right
and the test was left behind.

* feat: ship the ssh terminal as a first-party in-process plugin

Adds a hardcoded process:transport-owner tier so the terminal can own its
WebSocket server and ssh2 clients, which cannot cross the worker boundary.

* feat: ship docker as a first-party in-process plugin

Moves docker backend and frontend into plugins/docker/, alongside
ssh-terminal. Adds a host editor tab seam, a dashboard card registry,
and a build step to compile plugin backends into dist.

* feat: ship host metrics as a first-party in-process plugin

* fix: harden plugin auth and add per-request identity for ctx calls

Require auth on /plugin-api, gate plugin enable/grant/revoke routes
behind admin.plugins.manage, and thread the calling user through
worker ctx.hosts/ctx.ssh calls instead of always using the install
owner. Also adds the plugin permissions grant/revoke UI.

* feat: ship the AI assistant as a first-party in-process plugin

Moves src/backend/ai and its routes into plugins/ai, mounted through a
small /ai dispatcher instead of its own port. Moves the ai-enabled and
ai-private-endpoints settings routes out of user-settings-routes.ts
into the plugin too, so it has no leftover core dependents.

* fix: remove compiled plugin JS left behind in plugins/ after build

copy-bundled-plugins.cjs compiled and rewrote plugin backend TS in
place, copied it to dist/plugins, but never deleted the .js it had
just emitted next to the .ts sources. Those files shadowed the real
source for vitest/tsx and had import paths rewritten for the dist
layout, so tests failed with "Cannot find module" once a local build
had run. Affects docker, host-metrics and ai, not just this one.

* feat: add a permission-gated backend service registry for plugins

* feat: add a permission-gated UI action registry and action slots for plugins

Moves the terminal toolbar's hardwired AI button into a slot the ssh-terminal
plugin offers and the ai plugin fills, gated on ai.services.use.

* feat: add cross-plugin secret references gated by the provider's RBAC permission

* feat: move proxmox discovery/import/sync into a first-party plugin

* feat: move remote desktop (RDP/VNC/Telnet) into a first-party plugin

Relocates guacamole backend/frontend source and tests into
plugins/remote-desktop, following the ssh-terminal/docker pattern.

* feat: wire remote-desktop plugin into core and rename i18n keys

Repoints core consumers (dispatcher, collab, session-sharing, tab
utils) at the plugin, adds isTabTypeAvailable gating for rdp/vnc/
telnet, widens hostCapability to accept an array, and renames the
guacamole i18n namespace to remoteDesktop.

* feat: move fleets into a first-party plugin

* feat: move automations into a first-party plugin

* feat: remove legacy alert rules, superseded by automations

Alert rules already auto-migrate into automations on boot and the old
engine stands down after. Deletes the rule/firing tables, routes, UI,
and AI tools; keeps notification channels since automations still use
them. Also fixes automations' notify step, which still called the
deleted repository.

* feat: move network topology into a first-party plugin

* feat: move tailscale device discovery and settings into a plugin

Adds plugins/tailscale/ with a devices sidebar tab, admin settings
section, and re-auth dialog. Host Metrics tailscale manager card and
SSH re-auth banner parsing stay in core.

* feat: move workspaces into a first-party plugin

* feat: move web endpoint into a first-party plugin

* feat: collapse plugin runtime to one tier behind a plugin SDK

* feat: make each plugin an npm workspace built by a termix-plugin CLI

* feat: give plugins their own tables, migrations and sync entities

* feat: serve plugin http and websockets from one mount instead of ports

* feat: namespace plugin permissions and keep them valid when a plugin is off

* feat: give plugins their own settings and one settings screen

* feat: load plugin frontends at runtime and remove plugin ids from the shell

* fix: mock the ai status fetch in its activate test

* feat: add auth extension points and one ssh connect pipeline

* feat: rebuild workspaces as the reference plugin

* fix: gate second factors after SSO/LDAP behind an admin setting

* feat: convert network-topology to a full plugin (B1)

* feat: move snippets backend and tables into a plugin (B2)

* feat: point core frontend snippets pickers at the plugin (B2)

* feat: add the snippets plugin (B2)

* feat: wire ai, automations, fleets and ssh-terminal to snippets (B2)

* feat: finish the tailscale plugin, including SSH auth (B3)

* feat: finish the fleets plugin, add ctx.hosts and host-commands SDK (B4)

* chore: update proxmox and host-metrics locale files for B5

* chore: regenerate drizzle migration journals for B5

* feat: add ctx.hosts create/update to the SDK, host-metrics drops proxmox

* feat: move proxmox node stats and collectors into the proxmox plugin

* feat: drop proxmox host columns, use plugin settings instead

* feat: finish the fleets plugin, add ctx.hosts and host-commands SDK (B4)

* feat: convert file manager into a plugin

* feat: convert ssh tunnels into a plugin

* feat: finish the web-endpoint plugin, add ctx.desktop (B8)

* feat: move the terminal fully into the ssh-terminal plugin (B9)

* feat: convert tmux monitoring into a plugin (B10)

* feat: convert serial console into the serial plugin

* feat: move session sharing and collab rooms into a plugin (B12)

* feat: turn session recording into a plugin (B13)

* feat: finish the remote-desktop plugin (B14)

* feat: finish the host-metrics plugin, move host status into core (B16)

* feat: finish the docker plugin (B15)

* feat: finish the automations plugin (B17)

* feat: finish the ai plugin (B18)

* feat: finish the homepage plugin, move service links and canvas out of core (B19)

* feat: convert wake-on-lan into a plugin (B20)

* feat: convert secret-sources into a plugin (B20)

* feat: move totp and passkeys into plugins (C1)

* feat: move sso and ldap logins into plugins (C2)

* feat: move opkssh and warpgate into plugins (C3)

* feat: move step-ca into a plugin (C4)

* feat: move vault ssh signing into a plugin (C5)

* feat: move termix identity into a plugin (C6)

* feat: move acme certificate automation into a plugin (C7)

* fix: finish 2.9.0 plugin moves and get every check green

* chore: lock the plugin boundary and remove 2.9.0 leftovers

* fix: harden the plugin runtime after the 2.9.0 security review

* feat: add plugin packing, signing, pinned trust and tmxplug bundling

* test: prove 2.8 to 2.9.0 upgrade is lossless and fix what it caught

* fix: give bundled plugin backends a real require for CJS deps

* feat: improve UI loading time and jitter

* feat: show credential sharing inline in the sidebar like host sharing

* feat: tailscale add host and copy ip, fix outbound fetch hang and plugin ESM warning

* feat: unify alerts into one plugin, channels, rules and inbox

* feat: rebuild desktop sync as linked server accounts, fix packaged plugin bundles and UI scaling

* fix: set blacksmith builder cache-key to stop broken gha cache fallback

* fix: link plugin-sdk workspace before npm ci in docker deps stage

* fix: link every plugin workspace before npm ci in docker deps stage

* fix(host-metrics): exclude image and firmware filesystems (#1469)

* fix(host-metrics): exclude image and firmware filesystems

* fix(ci): build plugin SDK before dependent checks

* fix(mysql): keep plugin settings scope indexes within limits

* test(mysql): refresh reviewed plugin upgrade SQL

* fix(hosts): normalize imported jump host references (#1470)

* fix(hosts): normalize imported jump host references

* fix(ci): build plugin SDK before dependent checks

* fix(mysql): keep plugin settings scope indexes within limits

* test(mysql): refresh reviewed plugin upgrade SQL

* fix(ci): build plugin SDK and repair MySQL settings migration (#1471)

* fix(ci): build plugin SDK before dependent checks

* fix(mysql): keep plugin settings scope indexes within limits

* test(mysql): refresh reviewed plugin upgrade SQL

* fix(file-manager): keep inline rename consistent (#1476)

* fix(ci): build plugin SDK before dependent checks

* fix(mysql): keep plugin settings scope indexes within limits

* test(mysql): refresh reviewed plugin upgrade SQL

* fix(file-manager): keep inline rename consistent

* fix(dashboard): reuse translated host status labels (#1475)

* fix(ci): build plugin SDK before dependent checks

* fix(mysql): keep plugin settings scope indexes within limits

* test(mysql): refresh reviewed plugin upgrade SQL

* fix(dashboard): reuse translated host status labels

* docs(api): clarify local and remote version fields (#1474)

* fix(ci): build plugin SDK before dependent checks

* fix(mysql): keep plugin settings scope indexes within limits

* test(mysql): refresh reviewed plugin upgrade SQL

* docs(api): clarify local and remote version fields

* fix(file-manager): preserve selected backgrounds on hover (#1473)

* fix(ci): build plugin SDK before dependent checks

* fix(mysql): keep plugin settings scope indexes within limits

* test(mysql): refresh reviewed plugin upgrade SQL

* fix(file-manager): preserve selection feedback on hover

* test(ui): await dialog focus cleanup before teardown

* fix(file-manager): restore Ctrl/Cmd+F file search (#1472)

* fix(ci): build plugin SDK before dependent checks

* fix(mysql): keep plugin settings scope indexes within limits

* test(mysql): refresh reviewed plugin upgrade SQL

* fix(file-manager): focus file search with Ctrl or Cmd F

* fix: keep rounded-full circular in production builds

* fix(file-manager): cancel uploads and stop remote writes (#1477)

* fix(file-manager): cancel uploads and stop remote writes

* test(css): exercise the configured PostCSS plugin chain

* fix(file-manager): apply compact density to directory tree (#1478)

* fix(file-manager): apply compact density to directory tree

* test(css): exercise the configured PostCSS plugin chain

* fix(file-manager): preserve font sizes in compact mode (#1480)

* fix(file-manager): preserve font sizes in compact mode

* test(css): exercise the configured PostCSS plugin chain

* fix(file-manager): prioritize file names in narrow lists (#1483)

* fix(file-manager): prioritize file names in narrow lists

* test(css): exercise the configured PostCSS plugin chain

* test(identity): preserve full Ed25519 public keys in fixtures

* test(remote-desktop): always mutate ciphertext in tamper test

* fix(remote-desktop): probe the saved host guacd endpoint (#1481)

* fix(remote-desktop): probe the saved host guacd endpoint

* test(css): exercise the configured PostCSS plugin chain

* test(identity): preserve full Ed25519 public keys in fixtures

* fix(homepage): check allowlisted private service reachability (#1479)

* fix(homepage): check allowlisted private service reachability

* test(css): exercise the configured PostCSS plugin chain

* fix(remote-desktop): stop unsolicited clipboard read prompts (#1482)

* fix(remote-desktop): read clipboard only on explicit paste

* test(css): exercise the configured PostCSS plugin chain

* test(identity): preserve full Ed25519 public keys in fixtures

* test(remote-desktop): always mutate ciphertext in tamper test

* chore: simplify plugin readmes, changelogs and manifest descriptions

* fix: keep plugins loaded after signing in from the login screen

* fix(file-manager): accept OS file drops over existing rows (#1484)

* fix(file-manager): accept OS file drops over existing rows

* test(file-manager): target the file label in drop tests

* test(css): exercise the configured PostCSS plugin chain

* test(identity): preserve full Ed25519 public keys in fixtures

* test(remote-desktop): always mutate ciphertext in tamper test

* fix(file-manager): pipeline SFTP download reads (#1485)

* feat: add plugin sdk build to beta release

* fix: make link-store secret check immune to random base64 matches

* fix(ldap): preserve the directory-provided bind DN (#1486)

* fix: compute beta changes across dev branches and move the beta tag

* chore: untrack plugin sdk ARCHITECTURE.md

* chore: remove references to plugin sdk ARCHITECTURE.md

* feat: merge host editor terminal tabs into one owned by ssh-terminal

* feat: add descriptions to plugin host enable toggles

* fix(file-manager): show download progress in file viewers (#1487)

* fix(electron): signal backend readiness over IPC (#1488)

* fix(split-screen): allow layout creation without randomUUID (#1490)

* fix(split-screen): allow layout creation without randomUUID

* test(credentials): avoid flaky Ed25519 key generation

* fix(sidebar): remeasure visible rows after density changes (#1489)

* fix(sidebar): remeasure visible rows after density changes

* test(credentials): avoid flaky Ed25519 key generation

* feat(split-screen): redesign split screen with free-form panes and pane picker

* feat(sidebar): add host click behavior setting, default to always opening a new tab

* feat(snippets): redesign panel to match the host list

* fix(session-recording): stop session logs panel from refetching in a loop

* feat(snippets): bring back sharing, target hosts and drag reorder

* feat(ssh-terminal): add toolbar position, start state, display and fade host settings

* feat(ssh-terminal): add host setting to turn off password prompt auto-fill

* fix(ai): stop streams getting cut off and keep tool steps across messages

* feat: improve quick connect system using plugin api

* fix: proxmox guest sync, startup snippet sync, drop dead cloudflare ssh transport

* feat: move terminal settings, look and ssh tools into ssh-terminal plugin

* feat: move snippets, keybinding actions and macros out of core into plugins

* feat: store rdp, vnc and telnet logins in a generic per-protocol table

* feat: type the plugin host record, move plugin strings out of core and add lint checks

* feat: replace core homepage widget registry with generic extension points

* feat: plugins only see their own host settings in the browser

* feat: harden plugin api for separate repos, signed updates and generic external login

* fix: keep plugin css below core utilities and version plugin assets by their css

* fix: load and save plugin host settings in the editor and tighten settings row spacing

* feat: redesign user host defaults system

* fix(remote-desktop): release held keys on focus loss (#1498)

* fix(session-sharing): replace local presentation after takeover (#1500)

* fix(file-manager): refresh disk usage with directory listing (#1503)

* fix(ssh-terminal): preserve input order during local echo reconciliation (#1505)

* feat(remote-desktop): expose display zoom controls for RDP (#1514)

* fix(file-manager): restore text selection and copying in Markdown previews (#1518)

* fix(sidebar): keep compact host addresses visible (#1524)

* fix(hosts): preserve plugin settings when reopening the editor (#1499)

* fix(ssh-terminal): close owner sockets when presentations unmount (#1501)

* fix(session-sharing): synchronize shared SSH terminal dimensions (#1502)

* fix(session-sharing): show participant presence in member terminals (#1504)

* fix(ai): sync provider configuration and keys across linked devices (#1506)

* feat(ssh-terminal): add a duplicate tab action (#1510)

* feat(file-manager): allow disabling move-to-trash confirmation (#1511)

* feat(file-manager): default to the remote login directory (#1512)

* feat(homepage): synchronize canvas layouts across devices (#1515)

* fix(shortcuts): prevent accidental double-Shift palette activation (#1519)

* feat(tmux-monitor): add a unified multi-host view (#1520)

* fix(electron): allow explicit quit with active connections (#1522)

* feat: reconnect all disconnected terminal tabs (#1523)

* fix(hosts): preserve recording and sharing settings in the dev editor (#1509)

* fix(database): preserve RDP domain during startup backfill (#1497)

* feat(sidebar): add keyboard type-ahead search for hosts (#1516)

* feat(automations): add per-host maintenance mode and recurring schedules (#1521)

* feat(tmux): add a per-host mouse toggle and preserve remote configuration (#1513)

* fix(session-sharing): use the linked server for desktop meetings and links (#1507)

* fix(tunnels): support TOTP for client tunnels and jump hosts (#1508)

* fix: type errors and lint failures from merged plugin prs

* feat(installer): make the Windows desktop shortcut optional (#1517)

* fix: ship the plugin sdk and serialport in desktop builds

* fix: prefer ipv4 when resolving ssh host names (#1365)

* fix: readable terminal selection with the light theme (#1319)

* fix: build desktop session share links on the linked server (#1350)

* fix: show meeting guests to members and hide the roster from guests (#1353)

* fix: reliable file manager saves with sudo prompt and no base64 guessing (#1335)

* fix: show disk usage for the mount being browsed (#1347)

* fix: load the linux tray icon reliably and log tray failures (#1332)

* fix: cover the gnome close path in the desktop quit test (#1332)

* fix: prompt for jump host TOTP in terminal, file manager and metrics (#1312)

* feat: optional auto reconnect for dropped ssh sessions (#1321)

* feat: tighter compact host rows with inline tags (#1325)

* feat: bring back the alert feed homepage widget

* feat: pick target terminals for snippets again

* feat: share button on connection tabs again

* feat: recent servers list when linking the desktop app

* feat: list the fixed app shortcuts in keyboard shortcuts

* fix: translate hardcoded toasts and drop em dashes from ui text

* fix: translate leftover hardcoded ui text

* fix: toolbar files button opens at the shell directory again

* fix: show the remote desktop note under connection origin again

* chore: openapi docs for host metrics manager routes

* chore: openapi docs for undocumented routes and fix two broken doc blocks

* fix: declare terminal.listSessions use for snippet targets

* revert: drop the alert feed widget, the notification center replaces it

* feat: restore the alert feed homepage widget

* fix: quick connect fills the host address from plugin auth editors like tailscale

* fix: docker container logs use the base background color

* chore: fix dependabot alerts and apply safe npm upgrades

* fix: proxmox stats tab reads its switch from plugin host settings

* fix: count plugin ssh logins toward host status and stop showing reachable as a warning

* fix: hide the built-in source pill in the host editor

* fix: host status shows online when the port answers and only warns on a failed login

* fix: drop the top border on the split layout menu

* fix: host defaults tabs sit where the host editor puts them and skip plugins with nothing to default

* fix: remote desktop auth method labels and notes for vnc and telnet

* fix: add description to the web endpoint enable switch

* fix: crowdin sync and pretranslate for plugin locales, run plugin tests on release

* feat: move telemetry out of core into a usage statistics plugin

* fix: recent activity card no longer cuts off host names early

* fix: remove duplicate top border on split screen menu

* fix: redesign session log player controls, fix tooltip overlap and drop dot separators

* fix: file manager and sftp text showing raw i18n keys

* fix: onboarding rerunning for existing users after upgrading

* fix: fleet detail buttons overflowing the sidebar

* fix: session log player scrolling off screen horizontally

* fix: network graph lag when adding hosts and on every render

* fix: maintenance index name, shared host read only view and badge polling

* fix: meeting tabs, workspace tab merging, rail panels as tabs and general ui lag

* chore: update release notes

* fix: remote desktop tabs reconnecting on every tab switch

* fix: build plugin sdk before linting in release workflow

* chore: lint, format, and bump version to 2.9.0

* chore: skip crowdin pre-translate in release for now

* chore: sync Crowdin translations for 2.9.0

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Koi <38512047+datlt4@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: ZacharyZcR <zacharyzcr1984@gmail.com>
This commit is contained in:
authored and GitHub committed 2026-10-01 16:20:16 -05:00
1 parent 49fa488093
commit 3643e7af97
4405 files changed
+1341026 -289722

No files matched your search

@@ -0,0 +1,132 @@
/**
* Every SSH auth type the server knows how to connect with.
*
* Core registers password, key, credential, agent and none. The rest come from
* plugins through ctx.auth.registerSshAuthProvider. A type with no provider fails the
* connect with a message naming the plugin that would provide it.
*/
import type {
KeyboardInteractiveInterceptor,
SshAuthProvider,
} from "./types.js";
const providers = new Map<string, SshAuthProvider>();
const interceptors = new Map<string, KeyboardInteractiveInterceptor>();
export interface SshAuthTypeOwner {
pluginId: string;
pluginName: string;
}
/**
* Which plugin declares which auth type, from every manifest on disk
* including disabled ones. Set by the plugin runtime.
*/
let ownerSource: () => Array<SshAuthTypeOwner & { type: string }> = () => [];
export function setSshAuthTypeOwnerSource(
source: () => Array<SshAuthTypeOwner & { type: string }>,
): void {
ownerSource = source;
}
export function listSshAuthTypeOwners(): Array<
SshAuthTypeOwner & { type: string }
> {
return ownerSource();
}
function findSshAuthTypeOwner(type: string): SshAuthTypeOwner | null {
const owner = ownerSource().find((entry) => entry.type === type);
return owner
? { pluginId: owner.pluginId, pluginName: owner.pluginName }
: null;
}
export class SshAuthProviderMissingError extends Error {
readonly code = "SSH_AUTH_PROVIDER_MISSING";
constructor(
readonly authType: string,
readonly owner: SshAuthTypeOwner | null,
) {
super(
owner
? `This host uses ${authType}, which needs the ${owner.pluginName} plugin`
: `This host uses ${authType}, which no enabled plugin provides`,
);
this.name = "SshAuthProviderMissingError";
}
}
export function registerSshAuthProvider(provider: SshAuthProvider): () => void {
const existing = providers.get(provider.type);
if (existing && existing.pluginId !== provider.pluginId) {
throw new Error(
`SSH auth type "${provider.type}" is already provided by ${existing.pluginId}`,
);
}
providers.set(provider.type, provider);
return () => {
if (providers.get(provider.type) === provider) {
providers.delete(provider.type);
}
};
}
export function getSshAuthProvider(type: string): SshAuthProvider | undefined {
return providers.get(type);
}
/** Throws SshAuthProviderMissingError when nothing provides the type. */
export function requireSshAuthProvider(type: string): SshAuthProvider {
const provider = providers.get(type);
if (!provider) {
throw new SshAuthProviderMissingError(type, findSshAuthTypeOwner(type));
}
return provider;
}
export function listSshAuthProviders(): SshAuthProvider[] {
return [...providers.values()];
}
/** Whether a registered provider works for a host that is never saved. */
export function isQuickConnectAuthType(type: string): boolean {
return providers.get(type)?.quickConnect === true;
}
/** Types a stored credential may use. */
export function listCredentialTypes(): string[] {
return listSshAuthProviders()
.filter((provider) => provider.credentialType)
.map((provider) => provider.type);
}
export function registerKeyboardInteractiveInterceptor(
interceptor: KeyboardInteractiveInterceptor,
): () => void {
const existing = interceptors.get(interceptor.id);
if (existing && existing.pluginId !== interceptor.pluginId) {
throw new Error(
`Keyboard-interactive handler "${interceptor.id}" is already provided by ${existing.pluginId}`,
);
}
interceptors.set(interceptor.id, interceptor);
return () => {
if (interceptors.get(interceptor.id) === interceptor) {
interceptors.delete(interceptor.id);
}
};
}
export function listKeyboardInteractiveInterceptors(): KeyboardInteractiveInterceptor[] {
return [...interceptors.values()];
}
/** Test helper. */
export function resetSshAuthRegistryForTests(): void {
providers.clear();
interceptors.clear();
ownerSource = () => [];
}
@@ -0,0 +1,228 @@
import type { Client } from "ssh2";
import type { WebSocket } from "ws";
import { buildSSHAlgorithms } from "../../utils/ssh-algorithms.js";
import { SSHHostKeyVerifier } from "../host-key-verifier.js";
import { resolveSshKeepalive } from "../ssh-keepalive.js";
import {
SshAuthProviderMissingError,
requireSshAuthProvider,
} from "./auth-provider-registry.js";
import { ensureCoreSshAuthProviders } from "./core-providers.js";
import type {
MutableConnectConfig,
SshAuthEnv,
SshAuthLog,
SshAuthOutcome,
SshAuthProvider,
SshConnectHost,
SshConnectProfile,
SshConnectPurpose,
} from "./types.js";
interface PurposeDefaults {
keepaliveIntervalMs: number;
keepaliveCountMax: number;
/** Let the host's sshOptions.keepalive* override the defaults. */
hostKeepalive: boolean;
readyTimeout: number;
/** Socket idle timeout, when the transport set one. */
socketTimeout?: number;
env: Record<string, string> | null;
}
const TERMINAL_ENV: Record<string, string> = {
TERM: "xterm-256color",
LANG: "en_US.UTF-8",
LC_ALL: "en_US.UTF-8",
LC_CTYPE: "en_US.UTF-8",
LC_MESSAGES: "en_US.UTF-8",
LC_MONETARY: "en_US.UTF-8",
LC_NUMERIC: "en_US.UTF-8",
LC_TIME: "en_US.UTF-8",
LC_COLLATE: "en_US.UTF-8",
COLORTERM: "truecolor",
};
const BASIC_ENV: Record<string, string> = {
TERM: "xterm-256color",
LANG: "en_US.UTF-8",
LC_ALL: "en_US.UTF-8",
};
const PROFILE_DEFAULTS: Record<SshConnectProfile, PurposeDefaults> = {
terminal: {
keepaliveIntervalMs: 30000,
keepaliveCountMax: 5,
hostKeepalive: true,
readyTimeout: 120000,
socketTimeout: 120000,
env: TERMINAL_ENV,
},
session: {
keepaliveIntervalMs: 60000,
keepaliveCountMax: 5,
hostKeepalive: true,
readyTimeout: 60000,
env: TERMINAL_ENV,
},
stream: {
keepaliveIntervalMs: 30000,
keepaliveCountMax: 120,
hostKeepalive: false,
readyTimeout: 60000,
env: null,
},
forward: {
keepaliveIntervalMs: 30000,
keepaliveCountMax: 3,
hostKeepalive: true,
readyTimeout: 60000,
env: null,
},
background: {
keepaliveIntervalMs: 30000,
keepaliveCountMax: 3,
hostKeepalive: false,
readyTimeout: 30000,
env: BASIC_ENV,
},
jump: {
keepaliveIntervalMs: 30000,
keepaliveCountMax: 3,
hostKeepalive: false,
readyTimeout: 60000,
env: null,
},
};
export function getProfileDefaults(
profile: SshConnectProfile = "background",
): PurposeDefaults {
return PROFILE_DEFAULTS[profile];
}
export interface BuildConnectConfigOptions {
/** Acting user: host key trust, certificates and tokens are per user. */
userId: string;
purpose: SshConnectPurpose;
/** Keepalive and timeout defaults. Defaults to "background". */
profile?: SshConnectProfile;
client: Client;
/** Server-side host id when it differs from host.id (sync-id lookups). */
serverHostId?: number;
/** Terminal socket for the changed-host-key prompt. */
hostKeySocket?: WebSocket | null;
interactive?: boolean;
log?: SshAuthLog;
/** Applied after the purpose defaults and before auth is prepared. */
overrides?: Partial<MutableConnectConfig>;
}
export interface BuiltConnectConfig {
config: MutableConnectConfig;
provider: SshAuthProvider | null;
outcome: SshAuthOutcome;
env: SshAuthEnv;
}
const noopLog: SshAuthLog = () => {};
function stripIpv6Brackets(ip: string): string {
return ip?.replace(/^\[|\]$/g, "") || ip;
}
/**
* Builds the ssh2 config for one host: base settings for the purpose, the
* host verifier, then the auth provider's prepare step. Never connects.
*/
export async function buildConnectConfig(
host: SshConnectHost,
options: BuildConnectConfigOptions,
): Promise<BuiltConnectConfig> {
ensureCoreSshAuthProviders();
const profile = options.profile ?? "background";
const defaults = PROFILE_DEFAULTS[profile];
const authType = host.authType || "none";
const serverHostId = options.serverHostId ?? host.id;
const isJumpHost = profile === "jump";
const sshOptions = host.sshOptions ?? undefined;
const keepalive = defaults.hostKeepalive
? resolveSshKeepalive(
sshOptions?.keepaliveInterval,
sshOptions?.keepaliveCountMax,
defaults.keepaliveIntervalMs,
defaults.keepaliveCountMax,
)
: {
keepaliveInterval: defaults.keepaliveIntervalMs,
keepaliveCountMax: defaults.keepaliveCountMax,
};
const preloaded = serverHostId
? await SSHHostKeyVerifier.preloadHostData(serverHostId)
: null;
const config: MutableConnectConfig = {
host: stripIpv6Brackets(host.ip),
port: host.port || 22,
username: host.username,
// A jump hop with no auth never answered prompts before either.
tryKeyboard: isJumpHost ? authType !== "none" : true,
...keepalive,
readyTimeout: defaults.readyTimeout,
tcpKeepAlive: true,
tcpKeepAliveInitialDelay: 30000,
hostVerifier: await SSHHostKeyVerifier.createHostVerifier(
serverHostId,
host.ip,
host.port || 22,
options.hostKeySocket ?? null,
options.userId,
isJumpHost,
preloaded,
),
algorithms: buildSSHAlgorithms(sshOptions?.allowLegacyAlgorithms !== false),
};
if (defaults.env) config.env = { ...defaults.env };
if (defaults.socketTimeout) config.timeout = defaults.socketTimeout;
const env: SshAuthEnv = {
client: options.client,
userId: options.userId,
hostId: serverHostId,
purpose: options.purpose,
interactive: options.interactive ?? false,
log: options.log ?? noopLog,
};
let provider: SshAuthProvider;
try {
provider = requireSshAuthProvider(authType);
} catch (error) {
if (error instanceof SshAuthProviderMissingError) {
return {
config,
provider: null,
env,
outcome: {
status: "error",
code: "provider-missing",
message: error.message,
},
};
}
throw error;
}
if (provider.connectOptions) {
Object.assign(config, provider.connectOptions(host, options.purpose));
}
if (options.overrides) {
Object.assign(config, options.overrides);
}
const outcome = await provider.prepare(config, host, env);
return { config, provider, outcome, env };
}
@@ -0,0 +1,218 @@
/**
* The SSH auth types core always provides: password, key, credential, agent
* and none. Everything else is a plugin, through ctx.auth.
*/
import ssh2 from "ssh2";
import { getErrorMessage } from "../../utils/error-message.js";
import {
isPrivateKeyPassphraseError,
preparePrivateKeyForSSH2,
} from "../../utils/ssh-key-utils.js";
import { applyAgentAuth } from "../terminal-auth-helpers.js";
import { registerSshAuthProvider } from "./auth-provider-registry.js";
import type {
MutableConnectConfig,
SshAuthEnv,
SshAuthOutcome,
SshAuthProvider,
SshConnectHost,
} from "./types.js";
function keyText(key: SshConnectHost["key"]): string {
if (!key) return "";
return Buffer.isBuffer(key) ? key.toString("utf8") : key;
}
async function preparePassword(
config: MutableConnectConfig,
host: SshConnectHost,
env: SshAuthEnv,
): Promise<SshAuthOutcome> {
if (!host.password) {
return {
status: "error",
code: "missing-secret",
message: "Password authentication requested but no password provided",
};
}
// Forced keyboard-interactive answers the password prompt from the same
// value instead of offering it up front.
if (!host.forceKeyboardInteractive) {
config.password = host.password;
}
env.log("info", "Using password authentication");
return { status: "ready" };
}
async function prepareKey(
config: MutableConnectConfig,
host: SshConnectHost,
env: SshAuthEnv,
): Promise<SshAuthOutcome> {
const key = keyText(host.key);
if (!key.trim()) {
return {
status: "error",
code: "missing-secret",
message: "SSH key authentication requested but no key provided",
};
}
const passphrase = host.keyPassword || undefined;
try {
config.privateKey = preparePrivateKeyForSSH2(key, passphrase);
} catch (error) {
if (isPrivateKeyPassphraseError(error)) {
return {
status: "error",
code: "passphrase-required",
message:
"The SSH key is encrypted. Please enter the passphrase to unlock it.",
};
}
return {
status: "error",
code: "invalid-key",
message: `SSH key format error: ${getErrorMessage(error, "Invalid private key format")}`,
};
}
// A key that parses in our own helper can still be encrypted with no
// passphrase given; ssh2 only notices at connect time otherwise.
const parsed = ssh2.utils.parseKey(config.privateKey as Buffer, passphrase);
if (parsed instanceof Error) {
if (isPrivateKeyPassphraseError(parsed)) {
return {
status: "error",
code: "passphrase-required",
message:
"The SSH key is encrypted. Please enter the passphrase to unlock it.",
};
}
return {
status: "error",
code: "invalid-key",
message: `SSH key format error: ${parsed.message}`,
};
}
if (passphrase) config.passphrase = passphrase;
// Lets a server that wants key then password (or password only) still work.
if (host.password) config.password = host.password;
const certPublicKey = host.certPublicKey;
if (certPublicKey && certPublicKey.trim()) {
try {
const { applyCertificateAuth } =
await import("@termix/plugin-sdk/ssh-certs");
await applyCertificateAuth(
config,
env.client,
{
privateKey: config.privateKey as Buffer,
certificate: certPublicKey,
passphrase,
},
host.username,
);
env.log("info", "Using SSH key authentication with CA certificate");
return { status: "ready" };
} catch (certError) {
env.log(
"warning",
`CA certificate setup failed, falling back to key only: ${getErrorMessage(certError)}`,
);
}
}
env.log("info", "Using SSH key authentication");
return { status: "ready" };
}
const passwordProvider: SshAuthProvider = {
type: "password",
pluginId: "core",
labelKey: "hosts.filterAuthPassword",
quickConnect: true,
credentialType: true,
requiresSecret: true,
prepare: preparePassword,
};
const keyProvider: SshAuthProvider = {
type: "key",
pluginId: "core",
labelKey: "hosts.filterAuthKey",
quickConnect: true,
credentialType: true,
requiresSecret: true,
prepare: prepareKey,
};
/**
* The resolver expands a credential into key or password before connect, so
* this only runs when that expansion found something odd, like an unresolved
* reference. It behaves like whichever secret is present.
*/
const credentialProvider: SshAuthProvider = {
type: "credential",
pluginId: "core",
labelKey: "hosts.filterAuthCredential",
quickConnect: true,
requiresSecret: true,
prepare: async (config, host, env) => {
if (keyText(host.key).trim()) return prepareKey(config, host, env);
if (host.password) return preparePassword(config, host, env);
return {
status: "error",
code: "missing-secret",
message: "The stored credential for this host could not be resolved",
};
},
};
const agentProvider: SshAuthProvider = {
type: "agent",
pluginId: "core",
labelKey: "hosts.filterAuthAgent",
quickConnect: true,
requiresSecret: true,
prepare: async (config, host, env) => {
const result = await applyAgentAuth(config, host.sshOptions);
if ("error" in result) {
return { status: "error", code: "failed", message: result.error };
}
env.log("info", `SSH agent configured (socket: ${result.socketPath})`);
return { status: "ready" };
},
};
const noneProvider: SshAuthProvider = {
type: "none",
pluginId: "core",
labelKey: "hosts.filterAuthNone",
quickConnect: true,
// Keyboard-interactive only: a background poll would fire a live prompt
// (a RADIUS or Duo push) with nobody there to answer it.
supportsBackground: false,
prepare: async (_config, _host, env) => {
env.log("info", "Using keyboard-interactive authentication");
return { status: "ready" };
},
};
const BUILTIN_SSH_AUTH_PROVIDERS: readonly SshAuthProvider[] = [
passwordProvider,
keyProvider,
credentialProvider,
agentProvider,
noneProvider,
];
export function registerBuiltinSshAuthProviders(): () => void {
const disposers = BUILTIN_SSH_AUTH_PROVIDERS.map((provider) =>
registerSshAuthProvider(provider),
);
return () => disposers.forEach((dispose) => dispose());
}
+223
View File
@@ -0,0 +1,223 @@
/**
* connectHost: the one way core and plugins open an SSH connection.
*
* Resolve the host (shared overrides, external secrets and owner decryption
* all happen in resolveHostById), build the config through the host's auth
* provider, open the transport, then connect with a keyboard-interactive
* handler that either asks through a prompt channel or fills in the stored
* password.
*/
import { Client } from "ssh2";
import { withConnection } from "../ssh-connection-pool.js";
import { resolveHostById } from "../host-resolver.js";
import { buildConnectConfig } from "./build-connect-config.js";
import {
createAutoKeyboardInteractiveHandler,
createPromptKeyboardInteractiveHandler,
type KeyboardInteractiveListener,
} from "./keyboard-interactive.js";
import { openSshTransport, type OpenTransportOptions } from "./transport.js";
import type {
MutableConnectConfig,
SshAuthLog,
SshAuthOutcome,
SshConnectHost,
SshConnectProfile,
SshConnectPurpose,
SshPromptChannel,
} from "./types.js";
export class SshConnectError extends Error {
readonly code: string;
constructor(readonly outcome: Exclude<SshAuthOutcome, { status: "ready" }>) {
super(outcome.message);
this.name = "SshConnectError";
this.code =
outcome.status === "error"
? outcome.code
: outcome.status === "interaction-required"
? `${outcome.interaction}-required`
: "retry";
}
}
class SshHostNotFoundError extends Error {
constructor(readonly hostId: number) {
super("Host not found or access denied");
this.name = "SshHostNotFoundError";
}
}
export interface ConnectHostOptions {
/** Acting user. Access and credentials are resolved for them. */
userId: string;
purpose: SshConnectPurpose;
/** Keepalive and timeout defaults. Defaults to "background". */
profile?: SshConnectProfile;
/** Ask a person for keyboard-interactive answers. Without it, auto-fill. */
prompt?: SshPromptChannel;
/** Replaces the keyboard-interactive handler entirely. */
keyboardInteractive?: KeyboardInteractiveListener;
/** Config fields to force, e.g. a longer readyTimeout. */
overrides?: Partial<MutableConnectConfig>;
/** Overall timeout for reaching "ready". Defaults to 30s. */
timeoutMs?: number;
/** Use this client instead of a new one. */
client?: Client;
transport?: OpenTransportOptions;
/**
* An already-open stream to the host (a forwardOut channel through another
* host). Skips openSshTransport entirely.
*/
sock?: MutableConnectConfig["sock"];
log?: SshAuthLog;
}
export interface SshConnection {
client: Client;
jumpClient: Client | null;
host: SshConnectHost;
config: MutableConnectConfig;
/** Ends the connection and its jump chain. Safe to call twice. */
dispose: () => void;
}
export async function resolveConnectHost(
target: number | SshConnectHost,
userId: string,
): Promise<SshConnectHost> {
if (typeof target !== "number") return target;
const host = await resolveHostById(target, userId);
if (!host) throw new SshHostNotFoundError(target);
return host as unknown as SshConnectHost;
}
export async function connectHost(
target: number | SshConnectHost,
options: ConnectHostOptions,
): Promise<SshConnection> {
const host = await resolveConnectHost(target, options.userId);
const client = options.client ?? new Client();
const { config, provider, outcome, env } = await buildConnectConfig(host, {
userId: options.userId,
purpose: options.purpose,
profile: options.profile,
client,
hostKeySocket: options.prompt?.hostKeySocket ?? null,
interactive: !!options.prompt,
log: options.log,
overrides: options.overrides,
});
if (outcome.status !== "ready") {
throw new SshConnectError(outcome);
}
let jumpClient: Client | null = null;
if (options.sock) {
config.sock = options.sock;
} else {
({ jumpClient } = await openSshTransport(host, config, {
log: options.log,
prompt: options.prompt,
...options.transport,
}));
}
const keyboardInteractive =
options.keyboardInteractive ??
(options.prompt
? createPromptKeyboardInteractiveHandler(host, options.prompt)
: createAutoKeyboardInteractiveHandler(host));
let disposed = false;
const dispose = () => {
if (disposed) return;
disposed = true;
try {
client.end();
} catch {
// already closed
}
jumpClient?.end();
};
await new Promise<void>((resolve, reject) => {
let settled = false;
const timeout = setTimeout(() => {
if (settled) return;
settled = true;
dispose();
reject(new Error("SSH connection timeout"));
}, options.timeoutMs ?? 30000);
client.on("ready", () => {
if (settled) return;
settled = true;
clearTimeout(timeout);
resolve();
});
client.on("error", (error: Error) => {
if (settled) return;
settled = true;
clearTimeout(timeout);
jumpClient?.end();
const authFailed = /All configured authentication methods failed/i.test(
error.message,
);
if (authFailed && provider?.onAuthFailed) {
try {
provider.onAuthFailed(host, env, {
error,
retries: 0,
canRetry: false,
methodNotAvailable: false,
});
} catch {
// cleanup hooks never mask the connect error
}
}
reject(error);
});
client.on("close", () => {
jumpClient?.end();
});
client.on("keyboard-interactive", keyboardInteractive);
client.connect(config);
});
return { client, jumpClient, host, config, dispose };
}
/** Pool key for a host and purpose, matching the keys the transports used. */
export function getConnectionPoolKey(
prefix: string,
host: SshConnectHost,
): string {
const socks5Key = host.useSocks5
? `:socks5:${host.socks5Host}:${host.socks5Port}`
: "";
return `${prefix}:${host.userId}:${host.ip}:${host.port}:${host.username}${socks5Key}`;
}
/**
* Runs fn on a pooled connection. The pool calls the factory only when it
* has no idle connection for the key.
*/
export async function withHostConnection<T>(
poolKey: string,
target: number | SshConnectHost,
options: ConnectHostOptions,
fn: (client: Client) => Promise<T>,
): Promise<T> {
const host = await resolveConnectHost(target, options.userId);
return withConnection(
poolKey,
async () => (await connectHost(host, options)).client,
fn,
);
}
@@ -0,0 +1,13 @@
import { registerBuiltinSshAuthProviders } from "./builtin-providers.js";
let registered = false;
/**
* Registers core's providers once. Called lazily by the pipeline so tests and
* scripts get the same set as a running server without a start-up hook.
*/
export function ensureCoreSshAuthProviders(): void {
if (registered) return;
registered = true;
registerBuiltinSshAuthProviders();
}
@@ -0,0 +1,195 @@
/**
* One classifier for keyboard-interactive rounds, shared by every transport.
*
* It only decides what a round is. Answering is up to the transport: the
* terminal asks over its socket, the file manager parks the connection, and
* background work fills in the stored password and nothing else.
*/
import { listKeyboardInteractiveInterceptors } from "./auth-provider-registry.js";
import type {
KeyboardInteractiveDecision,
KeyboardInteractivePrompt,
SshConnectHost,
SshPromptChannel,
} from "./types.js";
const PASSWORD_PATTERN = /password/i;
// FortiToken asks for a code OR the word "push", so it needs a text field and
// must not be treated as a confirm-only push. Checked before the push pattern
// because its text also says "push notification".
const FORTI_TOKEN_PATTERN = /type\s+['"]?push['"]?/i;
// JumpCloud Protect / DUO: a menu choice, then an empty-answerable confirm.
// Checked before TOTP because "...or [2] TOTP:" would match that pattern.
const PUSH_PROMPT_PATTERN =
/choose.*push.*totp|press enter.*(push|send)|push notification|authentication by phone/i;
const TOTP_PATTERN =
/verification code|verification_code|token|otp|2fa|authenticator|google.*auth/i;
export interface KeyboardInteractiveRound {
name: string;
instructions: string;
prompts: KeyboardInteractivePrompt[];
}
/** Stored password for every password prompt, empty for the rest. */
function autoResponses(
prompts: KeyboardInteractivePrompt[],
password: string | null | undefined,
): string[] {
return prompts.map((p) =>
PASSWORD_PATTERN.test(p.prompt) && password ? password : "",
);
}
/** Puts the user's answer at one index and auto-fills the rest. */
function responsesWithAnswer(
prompts: KeyboardInteractivePrompt[],
answerIndex: number,
answer: string,
password: string | null | undefined,
): string[] {
return prompts.map((p, index) => {
if (index === answerIndex) return answer;
if (PASSWORD_PATTERN.test(p.prompt) && password) return password;
return "";
});
}
function shouldAutoAnswerPasswords(host: SshConnectHost): boolean {
return listKeyboardInteractiveInterceptors().some(
(interceptor) => interceptor.autoAnswerPasswords?.(host) === true,
);
}
export function classifyKeyboardInteractive(
round: KeyboardInteractiveRound,
host: SshConnectHost,
): KeyboardInteractiveDecision {
for (const interceptor of listKeyboardInteractiveInterceptors()) {
const decision = interceptor.detect(round, host);
if (decision) return decision;
}
const { prompts } = round;
const texts = prompts.map((p) => p.prompt);
const isFortiToken = texts.some((p) => FORTI_TOKEN_PATTERN.test(p));
const isPush =
!isFortiToken && texts.some((p) => PUSH_PROMPT_PATTERN.test(p));
if (!isPush) {
const totpIndex = prompts.findIndex((p) => TOTP_PATTERN.test(p.prompt));
if (totpIndex !== -1) return { kind: "totp", promptIndex: totpIndex };
}
if (shouldAutoAnswerPasswords(host)) {
return { kind: "auto", responses: autoResponses(prompts, host.password) };
}
const hasStoredPassword = !!host.password && host.authType !== "none";
const passwordIndex = prompts.findIndex((p) =>
PASSWORD_PATTERN.test(p.prompt),
);
// DUO/PAM challenges often don't say "password" at all.
const firstUnanswered = prompts.findIndex(
(p) => !(PASSWORD_PATTERN.test(p.prompt) && hasStoredPassword),
);
if (firstUnanswered === -1) {
return { kind: "auto", responses: autoResponses(prompts, host.password) };
}
const promptIndex =
passwordIndex !== -1 && !hasStoredPassword
? passwordIndex
: firstUnanswered;
return {
kind: "input",
promptIndex,
isPush: PUSH_PROMPT_PATTERN.test(prompts[promptIndex].prompt),
};
}
export type KeyboardInteractiveListener = (
name: string,
instructions: string,
lang: string,
prompts: KeyboardInteractivePrompt[],
finish: (responses: string[]) => void,
) => void;
/**
* The handler for connections with nobody to ask: the stored password goes
* to password prompts, everything else gets an empty answer. That is what
* every background path did before the pipeline.
*/
export function createAutoKeyboardInteractiveHandler(
host: SshConnectHost,
): KeyboardInteractiveListener {
return (_name, _instructions, _lang, prompts, finish) => {
finish(autoResponses(prompts, host.password));
};
}
/**
* The handler for connections with a prompt channel. One question per round;
* a second TOTP round means the last code was wrong.
*/
export function createPromptKeyboardInteractiveHandler(
host: SshConnectHost,
channel: SshPromptChannel,
): KeyboardInteractiveListener {
let totpAsked = false;
return (name, instructions, _lang, prompts, finish) => {
const decision = classifyKeyboardInteractive(
{ name, instructions, prompts },
host,
);
const ask = async (): Promise<string[]> => {
switch (decision.kind) {
case "auto":
return decision.responses;
case "browser": {
await channel.ask(decision);
return prompts.map(() => "");
}
case "totp": {
const answer = await channel.ask({
kind: "totp",
prompt: prompts[decision.promptIndex].prompt,
retry: totpAsked,
});
totpAsked = true;
return responsesWithAnswer(
prompts,
decision.promptIndex,
(answer ?? "").trim(),
host.password,
);
}
case "input": {
const prompt = prompts[decision.promptIndex];
const answer = await channel.ask({
kind: "input",
prompt: prompt.prompt,
echo: prompt.echo,
isPush: decision.isPush,
});
return responsesWithAnswer(
prompts,
decision.promptIndex,
(answer ?? "").trim(),
host.password,
);
}
}
};
ask().then(finish, () => finish(prompts.map(() => "")));
};
}
@@ -0,0 +1,104 @@
/**
* Which plugin resolves a "<scheme>://..." secret reference in a host's
* secret fields ("op://vault/item/field" for 1Password Connect, and so on).
*
* Core registers nothing here: every scheme comes from a plugin through
* ctx.credentials.registerSecretResolver. A reference whose scheme has no
* resolver fails the connect with a message naming the plugin that would
* provide it, the same shape as SshAuthProviderMissingError.
*/
export interface SecretResolverOwner {
pluginId: string;
pluginName: string;
}
export type SecretResolveFn = (
userId: string,
reference: string,
) => Promise<string>;
interface SecretResolverRegistration extends SecretResolverOwner {
resolve: SecretResolveFn;
}
const resolvers = new Map<string, SecretResolverRegistration>();
/**
* Which plugin declares which secret scheme, from every manifest on disk
* including disabled ones. Set by the plugin runtime, mirroring
* setSshAuthTypeOwnerSource.
*/
let ownerSource: () => Array<
SecretResolverOwner & { scheme: string }
> = () => [];
export function setSecretResolverOwnerSource(
source: () => Array<SecretResolverOwner & { scheme: string }>,
): void {
ownerSource = source;
}
function findSchemeOwner(scheme: string): SecretResolverOwner | null {
const owner = ownerSource().find((entry) => entry.scheme === scheme);
return owner
? { pluginId: owner.pluginId, pluginName: owner.pluginName }
: null;
}
class SecretResolverMissingError extends Error {
readonly code = "SECRET_RESOLVER_MISSING";
constructor(
readonly scheme: string,
readonly owner: SecretResolverOwner | null,
) {
super(
owner
? `This host uses a "${scheme}://" secret reference, which needs the ${owner.pluginName} plugin`
: `This host uses a "${scheme}://" secret reference, which no enabled plugin resolves`,
);
this.name = "SecretResolverMissingError";
}
}
export function registerSecretResolver(
scheme: string,
owner: SecretResolverOwner,
resolve: SecretResolveFn,
): () => void {
const existing = resolvers.get(scheme);
if (existing && existing.pluginId !== owner.pluginId) {
throw new Error(
`Secret scheme "${scheme}" is already resolved by ${existing.pluginId}`,
);
}
const registration = { ...owner, resolve };
resolvers.set(scheme, registration);
return () => {
if (resolvers.get(scheme) === registration) {
resolvers.delete(scheme);
}
};
}
export function getSecretResolver(
scheme: string,
): SecretResolverRegistration | undefined {
return resolvers.get(scheme);
}
export function requireSecretResolver(
scheme: string,
): SecretResolverRegistration {
const resolver = resolvers.get(scheme);
if (!resolver) {
throw new SecretResolverMissingError(scheme, findSchemeOwner(scheme));
}
return resolver;
}
/** Test seam. */
export function resetSecretResolverRegistryForTests(): void {
resolvers.clear();
ownerSource = () => [];
}
+162
View File
@@ -0,0 +1,162 @@
/**
* How the bytes get to a host: port knocking, a jump host chain or a SOCKS5
* proxy, in that order. Sets config.sock and
* returns the jump client so the caller can close it with the connection.
*/
import type { Client } from "ssh2";
import { getErrorMessage } from "../../utils/error-message.js";
import { logger } from "../../utils/logger.js";
import {
createSocks5Connection,
type SOCKS5Config,
} from "../../utils/socks5-helper.js";
import type { ProxyNode } from "../../../types/index.js";
import { createJumpHostChain } from "../jump-host-chain.js";
import { resolveSshConnectConfigHost } from "../ssh-dns.js";
import { performPortKnocking } from "../terminal-auth-helpers.js";
import type {
MutableConnectConfig,
SshAuthLog,
SshConnectHost,
SshPromptChannel,
} from "./types.js";
function getHostSocks5Config(host: SshConnectHost): SOCKS5Config | null {
const chain = Array.isArray(host.socks5ProxyChain)
? (host.socks5ProxyChain as ProxyNode[])
: [];
if (!host.useSocks5 || (!host.socks5Host && chain.length === 0)) return null;
return {
useSocks5: host.useSocks5,
socks5Host: host.socks5Host ?? undefined,
socks5Port: host.socks5Port ?? undefined,
socks5Username: host.socks5Username ?? undefined,
socks5Password: host.socks5Password ?? undefined,
socks5ProxyChain: chain,
};
}
class SshTransportError extends Error {
constructor(
message: string,
readonly stage: "jump-host" | "jump-forward" | "proxy",
options?: { cause?: unknown },
) {
super(message, options);
this.name = "SshTransportError";
}
}
export interface OpenTransportOptions {
prompt?: SshPromptChannel;
/** Knock before connecting when the host has a sequence. Default true. */
portKnock?: boolean;
/** Resolve DNS up front for a direct connection. Default true. */
resolveDns?: boolean;
log?: SshAuthLog;
}
export interface OpenedTransport {
jumpClient: Client | null;
via: "direct" | "proxy" | "jump";
}
function forwardThrough(
jumpClient: Client,
host: SshConnectHost,
): Promise<NonNullable<MutableConnectConfig["sock"]>> {
return new Promise((resolve, reject) => {
jumpClient.forwardOut(
"127.0.0.1",
0,
host.ip,
host.port || 22,
(err, stream) => {
if (err) {
reject(
new SshTransportError(
"Failed to forward through jump host: " + err.message,
"jump-forward",
{ cause: err },
),
);
return;
}
resolve(stream);
},
);
});
}
export async function openSshTransport(
host: SshConnectHost,
config: MutableConnectConfig,
options: OpenTransportOptions = {},
): Promise<OpenedTransport> {
if (
options.portKnock !== false &&
Array.isArray(host.portKnockSequence) &&
host.portKnockSequence.length > 0
) {
try {
await performPortKnocking(host.ip, host.portKnockSequence);
} catch {
logger.warn("Port knocking failed, attempting connection anyway", {
operation: "port_knock",
hostId: host.id,
});
}
}
let via: OpenedTransport["via"] = "direct";
const jumpUserId = host.userId || "";
if (host.jumpHosts && host.jumpHosts.length > 0 && jumpUserId) {
const jumpClient = await createJumpHostChain(
host.jumpHosts,
jumpUserId,
options.prompt,
);
if (!jumpClient) {
throw new SshTransportError(
"Failed to connect through jump hosts",
"jump-host",
);
}
try {
config.sock = await forwardThrough(jumpClient, host);
} catch (error) {
jumpClient.end();
throw error;
}
return { jumpClient, via: "jump" };
}
const proxyConfig = getHostSocks5Config(host);
if (proxyConfig && via === "direct") {
try {
const proxySocket = await createSocks5Connection(
host.ip,
host.port || 22,
proxyConfig,
);
if (proxySocket) {
config.sock = proxySocket;
via = "proxy";
}
} catch (error) {
throw new SshTransportError(
"Proxy connection failed: " + getErrorMessage(error),
"proxy",
{ cause: error },
);
}
}
if (via === "direct" && options.resolveDns !== false) {
await resolveSshConnectConfigHost(config);
}
return { jumpClient: null, via };
}
+296
View File
@@ -0,0 +1,296 @@
import type { Client, ConnectConfig } from "ssh2";
import type { WebSocket } from "ws";
import type { HostSshOptions } from "../ssh-options.js";
/**
* What a connection is for, as a free label ("terminal", "metrics"). Auth
* providers see it; core attaches no meaning to any value.
*/
export type SshConnectPurpose = string;
/**
* Keepalive, timeout and environment defaults for a kind of connection.
* terminal: an interactive shell. session: a long-lived browsing session.
* stream: a long transfer or console. forward: port forwarding. background:
* short exec work such as polling. jump: a hop in a jump chain (core only).
*/
export type SshConnectProfile =
"terminal" | "session" | "stream" | "forward" | "background" | "jump";
/** The resolved host fields the pipeline reads. */
export interface SshConnectHost {
id: number;
ip: string;
port: number;
username: string;
userId?: string | null;
authType?: string | null;
password?: string | null;
key?: string | Buffer | null;
keyPassword?: string | null;
keyType?: string | null;
certPublicKey?: string | null;
/**
* Host-scope plugin settings by plugin id, filled in by the resolver so
* synchronous hooks (keyboard-interactive handlers) can read them.
*/
pluginSettings?: Record<string, Record<string, unknown>> | null;
forceKeyboardInteractive?: boolean | null;
sshOptions?: HostSshOptions | null;
jumpHosts?: Array<{ hostId: number }> | null;
useSocks5?: boolean | null;
socks5Host?: string | null;
socks5Port?: number | null;
socks5Username?: string | null;
socks5Password?: string | null;
socks5ProxyChain?: unknown;
portKnockSequence?: Array<{
port: number;
protocol?: string;
delay?: number;
}> | null;
[key: string]: unknown;
}
export type MutableConnectConfig = ConnectConfig & Record<string, unknown>;
export type SshAuthLog = (
level: "info" | "warning" | "error",
message: string,
) => void;
export interface SshAuthEnv {
/** The client about to connect; certificate auth patches it. */
client: Client;
/** The acting user. Certificates and tokens are cached per user. */
userId: string;
/** Server-side host id, used for per-host caches. */
hostId: number;
purpose: SshConnectPurpose;
/** True when a person can answer prompts or finish a browser sign-in. */
interactive: boolean;
log: SshAuthLog;
}
/**
* What preparing auth produced.
*
* `interaction-required` means a browser step has to happen first; the
* transport turns `interaction` into its own message, for example
* `opkssh_auth_required` over the terminal socket.
*/
export type SshAuthOutcome =
| { status: "ready" }
| {
status: "interaction-required";
interaction: string;
message: string;
/** Extra boolean the HTTP transports set in their 401 body. */
flag?: string;
}
| {
status: "error";
code:
| "missing-secret"
| "invalid-key"
| "passphrase-required"
| "provider-missing"
| "failed";
message: string;
}
| {
/** Try once more with these config changes. Used by Tailscale. */
status: "retry";
patch: Partial<MutableConnectConfig>;
message: string;
};
export interface SshAuthFailureContext {
error: Error;
/** How many retries this connection already made. */
retries: number;
/** A tunnelled socket cannot be reused for a retry. */
canRetry: boolean;
/** The server refused keyboard-interactive or none. */
methodNotAvailable: boolean;
}
export interface SshInteractionRequest {
userId: string;
hostId: number;
/** Host row as stored, not resolved. */
host: { name?: string | null; ip: string; username: string };
socket: WebSocket;
requestOrigin: string;
/** Anything the client sent with the start message. */
payload: Record<string, unknown>;
}
export interface SshAuthField {
key: string;
type:
| "boolean"
| "string"
| "number"
| "select"
| "secret"
| "textarea"
| "custom";
labelKey?: string;
descriptionKey?: string;
placeholderKey?: string;
default?: unknown;
options?: Array<{ value: string; labelKey: string }>;
component?: string;
}
export interface SshAuthProvider {
/** Stored in ssh_data.auth_type. */
type: string;
/** "core" for the built-ins, otherwise the registering plugin's id. */
pluginId: string;
labelKey: string;
descriptionKey?: string;
/** Editor fields, rendered by core unless the frontend registered an editor. */
fields?: SshAuthField[];
/** Also offered as a stored credential type. */
credentialType?: boolean;
/** Needs a browser sign-in or a person at the keyboard. */
needsUserInteraction?: boolean;
/** Carries a secret, so a shared host needs one resolved for the recipient. */
requiresSecret?: boolean;
/**
* Can connect with nobody watching, for polling and batch work. Defaults to
* true; false for types that need a person or a fresh browser sign-in.
*/
supportsBackground?: boolean;
/**
* Works for a host that was never saved, so Quick Connect offers it.
* Default false.
*/
quickConnect?: boolean;
/** Overrides applied to the base config before prepare runs. */
connectOptions?: (
host: SshConnectHost,
purpose: SshConnectPurpose,
) => Partial<MutableConnectConfig>;
/** The interaction name this provider's outcomes use, e.g. "browser-signin". */
interaction?: string;
/**
* Starts the browser step behind an `interaction-required` outcome, for
* transports that can show one (the terminal today).
*/
startInteraction?: (request: SshInteractionRequest) => Promise<void>;
/** Cancels a pending browser step, by request id or by host. */
cancelInteraction?: (request: {
userId: string;
hostId?: number;
requestId?: string;
}) => void | Promise<void>;
prepare: (
config: MutableConnectConfig,
host: SshConnectHost,
env: SshAuthEnv,
) => Promise<SshAuthOutcome>;
/**
* Called when the server rejected auth. Synchronous on purpose: transports
* decide on a retry before the socket's close event arrives. Cache cleanup
* inside runs in the background.
*/
onAuthFailed?: (
host: SshConnectHost,
env: SshAuthEnv,
context: SshAuthFailureContext,
) => SshAuthOutcome | undefined;
/**
* Claims an ssh2 "banner" event during the handshake, for a provider whose
* server holds the connection open pending an out-of-band step (Tailscale
* SSH check mode). A transport that can show this to a person sends
* `<type>_check_required` / `<type>_check_completed` over its socket;
* `details` is merged into that message. Returning nothing leaves the
* banner unhandled.
*/
onBanner?: (
banner: string,
host: SshConnectHost,
env: SshAuthEnv,
) => SshBannerDecision | undefined;
}
export type SshBannerDecision =
| {
/** Hold the connect timeout open and wait for the out-of-band step. */
action: "hold";
/** How long to wait before failing the connection. */
timeoutMs: number;
message: string;
details?: Record<string, unknown>;
}
| {
/** The out-of-band step finished; resume the normal connect timeout. */
action: "release";
details?: Record<string, unknown>;
};
export interface KeyboardInteractivePrompt {
prompt: string;
echo?: boolean;
}
/**
* A round finished in a browser: open the URL, compare the code, continue.
* `id` names the handler that claimed it; transports name their messages
* after it.
*/
export interface BrowserSignInRound {
kind: "browser";
id: string;
label: string;
url: string | null;
code: string;
instructions: string;
}
/** What to do with one keyboard-interactive round. */
export type KeyboardInteractiveDecision =
| { kind: "auto"; responses: string[] }
| BrowserSignInRound
| { kind: "totp"; promptIndex: number }
| { kind: "input"; promptIndex: number; isPush: boolean };
/**
* Interceptors run before the built-in classifier. A plugin that owns a
* prompt style returns a decision; everyone else returns null.
*/
export interface KeyboardInteractiveInterceptor {
id: string;
pluginId: string;
detect: (
round: {
name: string;
instructions: string;
prompts: KeyboardInteractivePrompt[];
},
host: SshConnectHost,
) => KeyboardInteractiveDecision | null;
/** Answer password prompts silently instead of asking the user. */
autoAnswerPasswords?: (host: SshConnectHost) => boolean;
}
/**
* How a transport asks a person something mid-connect.
*
* `ask` resolves with the typed answer, or null when the user gave up or the
* transport has nobody to ask. The terminal answers over its WebSocket, the
* file manager parks the connection and answers over HTTP.
*/
export interface SshPromptChannel {
ask: (request: SshPromptRequest) => Promise<string | null>;
/** Terminal socket used for the host key prompt, when there is one. */
hostKeySocket?: WebSocket | null;
}
export type SshPromptRequest =
| { kind: "totp"; prompt: string; retry: boolean }
| { kind: "input"; prompt: string; echo: boolean; isPush: boolean }
| BrowserSignInRound;