mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-10-28 14:15:24 +00:00
* fix: keep concurrent ssh pool connects from overwriting each other (#1619) * fix: stop auto-accepting changed jump host keys (#1620) A jump hop whose key no longer matched the pinned fingerprint was silently accepted and the pin overwritten. Background status probes reconnect to jump hosts every cycle, so a MITM on that hop got the credentials with no user interaction. Changed jump host keys now go through the same path as any other host: prompt when there is a terminal socket, otherwise refuse. * fix(electron): validate external login URL scheme and callback port (#1621) * fix(plugins): read artifact manifest with the same tar parser as the unpack (#1622) The consent check read the first manifest.json with a hand-written tar reader, while the unpack keeps the last one and also follows pax and long-name headers. An archive with two manifests could pass the check with one capability list and get granted another. Read the manifest with node-tar, count only plain files, and refuse archives that hold more than one manifest.json. * fix: only trust the server's origin in the desktop login frame (#1624) The desktop sign-in iframe accepted AUTH_SUCCESS and system browser requests from whatever page it had navigated to, and posted replies (including 2FA temp tokens) to any origin. Messages must now come from the server's origin and replies are posted to it. The web UI also treated any framing page as the desktop app and posted the JWT to it. It now also requires the Termix-Desktop user agent. * fix: check trusted proxy login against nginx's peer, not nginx (#1625) The backend only sees the bundled nginx on loopback, so the allowlist could only work by trusting 127.0.0.1, which let any client that reached nginx log in as anyone by sending the identity headers. nginx now passes its own TCP peer (before real_ip rewriting) in X-Termix-Proxy-Peer, and loopback connections are judged by that address instead. * fix: keep foreign keys on during user data import (#1626) Import credentials before hosts and remap the file's credential ids to the ones created here, so hosts and protocol logins no longer point at another server's ids. With rows written in dependency order, the import no longer turns off SQLite foreign keys on the shared connection. The uploaded file is now removed on every exit path. * fix: enforce unique usernames (#1628) * fix: enforce unique usernames Registration checked for a taken name, hashed the password, then inserted, with nothing in the schema enforcing uniqueness. Concurrent sign-ups could create two accounts with one name, after which login, password reset, proxy login and admin lookups by username picked between them arbitrarily. Add a unique index on users.username for every dialect. Existing duplicates are renamed (later rows get a -<id> suffix, the oldest keeps the name) rather than deleted. Registration and admin user creation now return the same 409 when the insert loses the race. * fix: avoid username collisions during migration * fix: don't auto-enable synced plugins signed only by a server-sent key (#1623) * fix: don't auto-enable synced plugins signed only by a server-sent key Registry keys a linked server sends still let its plugins load on the desktop, but no longer count as a signer for switching them on or copying their grants. Keys the desktop added itself keep their trust. * fix: enforce local plugin trust across remote source labels * fix: require positive local trust for synced plugin keys * fix(desktop): harden external editor and session cookie IPC (#1627) * fix(desktop): stop the renderer choosing the external editor binary or reading the session cookie open-external-editor now launches only the editor saved from a file dialog and refuses to hand executable file types to the OS opener. The unused get-session-cookie and wait-session-cookie channels, which returned the httpOnly jwt, are removed. * fix: validate setting keys before editor authorization * fix(sidebar): sort hosts by IP address numerically (#1629) * fix(desktop): find spawn-helper in universal macOS builds (#1630) The universal build ships app-arm64.asar and app-x64.asar instead of app.asar, so node-pty's helper path rewrite never pointed at the unpacked copy and every local terminal failed with posix_spawnp failed. * fix(sync): send shared hosts with text columns in their stored form (#1631) resolveHostById turns forceKeyboardInteractive into a boolean, and the shared-host export passed it on as is. A desktop could not bind the boolean into the text column, so every shared host failed to apply. * fix: drop ssh_data.vault_profile_id so removing the vault plugin keeps hosts writable (#1633) The vault plugin renames vault_profiles to p_vault_profiles, and SQLite rewrites ssh_data's foreign key to follow it. Uninstalling the plugin then dropped p_vault_profiles and left ssh_data pointing at a missing table, so creating, cloning and deleting hosts failed with "no such table: main.p_vault_profiles". Postgres and MySQL refused the uninstall instead. The column was already copied into the vault plugin's host settings by 2.9, so retire it on every engine. The SQLite boot drop also repairs databases already in the broken state; MySQL drops the column's foreign key first. * fix(sync): let a linked desktop enable mirrored plugins it does not trust on its own (#1632) * fix(sync): let a linked desktop enable mirrored plugins it does not trust on its own * fix(sync): switch off an untrusted mirrored plugin when the server updates it * fix: require local consent for mirrored plugin activation * docs: describe consent fields on the plugin state endpoint * fix(i18n): keep Indonesian technical terms consistent (#1636) Use the English terms Indonesian users know for tunnel, snippet, deploy, file manager, remote desktop, jump host, passphrase, sidebar, toolbar, endpoint, browser and SSH agent, instead of mixing literal translations (terowongan, cuplikan, terapkan, bilah sisi, titik akhir, ...) with the English words. Match the split shortcuts to the split screen menu. Also fix the user data export description, which said secrets are encrypted while the English says they are decrypted. * fix(settings): leave user manage view when switching admin sections (#1649) The admin panel stays mounted across Settings pages, so an open user manage view kept replacing every other admin section until Back to users was clicked. Reset it whenever the selected section changes. * fix(sync): don't delete a local row when the server can't send its copy (#1650) * fix(sync): don't delete a local row when the server can't send its copy A push conflict on a live record whose server row failed to serialize came back as row: null, deleted: false, and the desktop treated that as a delete. The server now rejects that op as unavailable, the desktop never deletes on a conflict without a row, and serialization failures are logged. * fix(sync): retry temporarily unavailable records * fix: smooth host editor jumps to lower sections * chore: add changelog entries for 26.10.2 fixes * fix: stop building ssh2 native crypto in the docker image (#1644) * chore: test that an update keeps a changed auth type (#1601) * feat: option to hide the sidebar after opening a host (#1652) * feat: sort the dashboard host status card (Plugin-Host-Metrics#6) * fix: let the hover side menu overlay content instead of resizing it (Plugin-Remote-Desktop#2) * fix: say the server is down and keep retrying instead of a database error (#1637) * fix: show why a client tunnel failed to start (Plugin-Tunnels#2) * fix(sdk): skip comment-only chunks when splitting migrations * feat: setting to let the hover side menu push content again * fix: use the vite proxy for plugin sockets on any dev port * feat(sdk): let a plugin raise its public route rate limit * chore: update translations * chore: add the overview video to the readme * chore: update the overview video and add a play button to its thumbnail * feat: plugin builds bundle worker entries and import wasm and fonts as bytes * feat: plugin packs include LICENSE and NOTICE * chore: drop guacd from compose files and dev runner * chore: update remote desktop origin comment for the built-in engine * fix: show plugin names and descriptions in the UI language (#1658) * fix: show plugin names and descriptions in the UI language Read plugin.name and plugin.description from each plugin's own locale namespace, falling back to the manifest, everywhere core shows a plugin's name: the Plugins manager, onboarding picker, host editor tabs and sections, host filters and bulk actions, beta updates, interface presets and plugin crash/loading notices. * docs(sdk): document plugin.name and plugin.description locale keys --------- Co-authored-by: ZacharyZcR <zkl205305@gmail.com> * fix(hosts): reject or infer a missing authType on host create (#1664) Creating an SSH host through the API without authType hit the NOT NULL auth_type column and came back as a 500. The create route now infers the type from the credential, key or password in the body, falls back to the host defaults, and otherwise answers 400. A non-string authType is a 400 on create and update. * chore: changelog for merged plugin name and host auth type PRs * fix: move macOS split pane navigation to Cmd+Option+Arrow * fix: pick a free port for the desktop backend when 30001 is taken (#1663) * feat: build the Windows desktop app for ARM64 (#1615) * fix(sync): keep the changes cursor within the 32-bit seq column (#1665) The desktop learned the server's entity types by asking for changes after Number.MAX_SAFE_INTEGER. sync_records.seq is a 32-bit integer on Postgres, which rejects that bound value, so every pass needing the probe failed with 22003 out of range. The server now clamps the cursor to the largest seq the column holds and answers 400 for a cursor or limit that is not a non-negative integer. The desktop asks for a one-row page from its saved cursor instead. * fix(audit): coalesce identical plugin routine audits so they cannot flush the log (#1667) Successful plugin_as_user and plugin_service_* entries written by a plugin with the same user, action, resource and details are recorded once per 10 minutes. Failures and every other action are still written each time. * feat(plugins): publish host.created when a host is added (#1668) Plugins that keep an inventory of hosts had no way to hear about a new one short of polling. Core now publishes host.created with the same { hostId, userId } payload as host.updated wherever a host row is created: the host create route, ctx.hosts.create, JSON and SSH config bulk import, database file import, and sync writing a host it did not have yet. * fix: show the login for signed-out full-screen view links and return to them (#1669) A ?view= link opened without a session spun forever: the gate rendered the bare view when the session check failed, so the plugin runtime never started and the view never registered. A regular browser now keeps the link in sessionStorage, shows the normal login and opens the link again after any login, including redirect logins. Only same-origin paths with a view are restored. The desktop app, embedded sign-in frames and guest views keep their current behavior. * fix(desktop): apply linked server proxy headers and certificate exception to WebSockets (#1670) * fix(desktop): send linked server proxy headers on WebSocket upgrades isLinkedOrigin compared the request origin with the link's http(s) origin, so the terminal WebSocket (wss://host/...) never matched and its upgrade went out without the proxy headers and basic auth. Behind a forward-auth proxy that upgrade was redirected to the login and the terminal closed with "connection closed unexpectedly". ws and wss now count as http and https for the comparison, the same mapping the WebSocket handshake itself uses, with host and port still matched exactly. * fix(desktop): allow a linked server's self-signed certificate for its WebSockets isInvalidCertificateAllowedForUrl compared the URL with a local getOrigin copy, so wss://host never matched the link's https://host origin and an allowed self-signed certificate did not cover the terminal and tunnel sockets. It now uses linkedServer.isLinkedOrigin, which maps ws and wss the same way as the proxy headers, and the local copy is removed. * feat(sdk): let plugins mint a short-lived user session and read a user's locale (#1666) ctx.auth.issueUserToken(userId, { purpose, ttlSeconds }) gives background work a session for calling Termix's own API as an existing user. It needs users:impersonate, defaults to 300s and is capped at 900s, is stored as a normal session row marked as plugin-issued, and every issue is audited. Such sessions are refused on routes that change the user's password, second factors, API keys or linked logins. ctx.users.getLocale(userId) reads the user's UI language under users:read. SDK 1.0.11, plugin API 1.3.0. * chore: changelog for merged sync, audit, event and desktop PRs * feat: add shell.rightEdge slot so plugin panels can push the page over * chore: pin bundled plugins to the latest releases * chore: lint, format, and bump version to 26.10.2 --------- Co-authored-by: ZacharyZcR <zacharyzcr1984@gmail.com> Co-authored-by: Ferdina Kusumah <19812460+FerdinaKusumah@users.noreply.github.com> Co-authored-by: ZacharyZcR <zkl205305@gmail.com> Co-authored-by: Lukas <80832688+0skater0@users.noreply.github.com>
909 lines
30 KiB
TypeScript
909 lines
30 KiB
TypeScript
/**
|
|
* ctx.ssh and ctx.auth.
|
|
*
|
|
* ctx.ssh is a thin, capability-checked door onto core's connect pipeline.
|
|
* ctx.auth registers login methods, second factors and SSH auth types into
|
|
* core's registries, scoped to the plugin's manifest and its disposable bag.
|
|
*/
|
|
|
|
import type {
|
|
PluginAuth,
|
|
PluginVerifiedIdentity,
|
|
PluginSsh,
|
|
PluginSshConnectOptions,
|
|
PluginSshHost,
|
|
} from "@termix-ssh/plugin-sdk/backend";
|
|
import type { PluginManifest } from "@termix-ssh/plugin-sdk/manifest";
|
|
import { PluginSshInteractionError } from "@termix-ssh/plugin-sdk/backend";
|
|
import {
|
|
assertCapability,
|
|
capabilityRefused,
|
|
hasCachedCapability,
|
|
hasCapability,
|
|
warmPluginGrants,
|
|
} from "./permissions.js";
|
|
import { getActor, getActorSessionId } from "./actor.js";
|
|
import type { DisposableBag } from "./disposables.js";
|
|
import { redactHostSecrets } from "./ctx-hosts.js";
|
|
import { issueUserToken } from "./ctx-users.js";
|
|
import {
|
|
getSshAuthProvider,
|
|
listSshAuthProviders,
|
|
registerKeyboardInteractiveInterceptor,
|
|
registerSshAuthProvider,
|
|
} from "../hosts/connect/auth-provider-registry.js";
|
|
import { classifyKeyboardInteractive } from "../hosts/connect/keyboard-interactive.js";
|
|
import { ensureCoreSshAuthProviders } from "../hosts/connect/core-providers.js";
|
|
import {
|
|
getLoginMethod,
|
|
registerLoginMethod,
|
|
registerSecondFactor,
|
|
} from "../auth/registry.js";
|
|
import type { VerifiedIdentity } from "../auth/types.js";
|
|
import type {
|
|
MutableConnectConfig,
|
|
SshAuthProvider,
|
|
SshConnectHost,
|
|
SshConnectProfile,
|
|
SshConnectPurpose,
|
|
} from "../hosts/connect/types.js";
|
|
|
|
type AuditFn = (
|
|
action: string,
|
|
details: string,
|
|
outcome: { success: boolean; errorMessage?: string },
|
|
) => Promise<void>;
|
|
|
|
interface Deps {
|
|
manifest: PluginManifest;
|
|
bag: DisposableBag;
|
|
audit: AuditFn;
|
|
}
|
|
|
|
const PLUGIN_PROFILES = new Set<SshConnectProfile>([
|
|
"terminal",
|
|
"session",
|
|
"stream",
|
|
"forward",
|
|
"background",
|
|
]);
|
|
|
|
function purposeOf(options?: { purpose?: string }): SshConnectPurpose {
|
|
return options?.purpose || "plugin";
|
|
}
|
|
|
|
// "jump" belongs to core's own jump chain; a plugin gets background.
|
|
function profileOf(options?: { profile?: string }): SshConnectProfile {
|
|
const profile = options?.profile as SshConnectProfile | undefined;
|
|
return profile && PLUGIN_PROFILES.has(profile) ? profile : "background";
|
|
}
|
|
|
|
/**
|
|
* The user a connection runs as: the actor, or for a host core resolved
|
|
* earlier, the user it was resolved for. A host object's own userId is plugin
|
|
* data and is never believed, or a plugin could borrow another user's jump
|
|
* hosts and stored credentials by naming them.
|
|
*/
|
|
function actingUser(resolvedFor?: string): string {
|
|
const actor = getActor() ?? resolvedFor;
|
|
if (actor) return actor;
|
|
throw new Error(
|
|
"ctx.ssh needs an acting user: call it inside a request or ctx.asUser",
|
|
);
|
|
}
|
|
|
|
function describeHost(host: number | PluginSshHost): string {
|
|
return typeof host === "number" ? `host ${host}` : `host ${host.id}`;
|
|
}
|
|
|
|
const OVERRIDE_FIELDS = [
|
|
"password",
|
|
"key",
|
|
"privateKey",
|
|
"keyPassword",
|
|
"passphrase",
|
|
] as const;
|
|
|
|
/**
|
|
* A secret the plugin set on its copy (a password the user just typed) wins
|
|
* over the stored one; everything else comes from what core resolved.
|
|
*/
|
|
function withOverrides(
|
|
resolved: SshConnectHost,
|
|
given: PluginSshHost,
|
|
): SshConnectHost {
|
|
if (given === (resolved as unknown)) return resolved;
|
|
const source = given as unknown as Record<string, unknown>;
|
|
const set = OVERRIDE_FIELDS.filter(
|
|
(field) => typeof source[field] === "string" && source[field] !== "",
|
|
);
|
|
if (set.length === 0) return resolved;
|
|
const merged = { ...resolved } as unknown as Record<string, unknown>;
|
|
for (const field of set) merged[field] = source[field];
|
|
if (typeof source.authType === "string") merged.authType = source.authType;
|
|
return merged as unknown as SshConnectHost;
|
|
}
|
|
|
|
export function createPluginSsh({ manifest, bag, audit }: Deps): PluginSsh {
|
|
const pluginId = manifest.id;
|
|
const declared = manifest.capabilities;
|
|
const open = new Set<() => void>();
|
|
// Pool key -> host id, so dropPooled can find a host's keys after its
|
|
// address changed.
|
|
const poolKeys = new Map<string, number>();
|
|
|
|
bag.add(async () => {
|
|
for (const dispose of [...open]) dispose();
|
|
open.clear();
|
|
if (poolKeys.size > 0) {
|
|
const { connectionPool } =
|
|
await import("../hosts/ssh-connection-pool.js");
|
|
for (const key of poolKeys.keys()) {
|
|
connectionPool.clearKeyConnections(key);
|
|
}
|
|
poolKeys.clear();
|
|
}
|
|
}, "SSH connections");
|
|
|
|
const checkSsh = async (withCredentials: boolean) => {
|
|
await assertCapability(pluginId, "ssh:connect", declared);
|
|
if (withCredentials) {
|
|
await assertCapability(pluginId, "credentials:use", declared);
|
|
}
|
|
};
|
|
|
|
// Hosts core resolved, keyed by the redacted copy the plugin was given, so
|
|
// handing that copy back to connect still connects with the real secrets.
|
|
const resolvedHosts = new WeakMap<
|
|
object,
|
|
{ host: SshConnectHost; userId: string }
|
|
>();
|
|
|
|
// Plugins often copy a host before connecting ({ ...host, port }). Spread
|
|
// copies enumerable symbol keys, so the copy keeps this tag. Its value is an
|
|
// opaque token, not the host, so the secrets stay out of the plugin's reach.
|
|
const tag = Symbol("resolvedHost");
|
|
const tokens = new WeakMap<
|
|
object,
|
|
{ host: SshConnectHost; userId: string }
|
|
>();
|
|
|
|
const remember = (key: object, host: SshConnectHost, userId: string) => {
|
|
const entry = { host, userId };
|
|
resolvedHosts.set(key, entry);
|
|
const token = Object.freeze({});
|
|
tokens.set(token, entry);
|
|
if (Object.isExtensible(key)) {
|
|
Object.defineProperty(key, tag, {
|
|
value: token,
|
|
enumerable: true,
|
|
configurable: true,
|
|
});
|
|
}
|
|
};
|
|
|
|
const lookup = (host: object) => {
|
|
const known = resolvedHosts.get(host);
|
|
if (known) return known;
|
|
const token = (host as Record<symbol, unknown>)[tag];
|
|
return token && typeof token === "object"
|
|
? tokens.get(token as object)
|
|
: undefined;
|
|
};
|
|
|
|
const handOut = (host: SshConnectHost, userId: string): PluginSshHost => {
|
|
const redacted = redactHostSecrets(
|
|
host as unknown as Record<string, unknown>,
|
|
) as unknown as PluginSshHost;
|
|
remember(redacted, host, userId);
|
|
return redacted;
|
|
};
|
|
|
|
/** The acting user for a call about this host. */
|
|
const userFor = (host: number | PluginSshHost | undefined): string =>
|
|
actingUser(
|
|
host && typeof host === "object" ? lookup(host)?.userId : undefined,
|
|
);
|
|
|
|
/**
|
|
* A host for core's pipeline. An id stays an id (core resolves it with an
|
|
* access check). An object core handed out maps back to what core resolved;
|
|
* any other object is the plugin's own, so it runs as the actor.
|
|
*/
|
|
const toConnectHost = (
|
|
host: number | PluginSshHost,
|
|
userId: string,
|
|
): number | SshConnectHost => {
|
|
if (typeof host === "number") return host;
|
|
const known = lookup(host);
|
|
if (known) return withOverrides(known.host, host);
|
|
return { ...(host as unknown as SshConnectHost), userId };
|
|
};
|
|
|
|
/** A working login to a saved host core resolved marks it online. */
|
|
const reportLogin = (host: number | PluginSshHost) => {
|
|
const hostId = typeof host === "number" ? host : lookup(host)?.host.id;
|
|
if (!Number.isInteger(hostId) || hostId <= 0) return;
|
|
void import("../hosts/status/host-status-service.js")
|
|
.then(({ hostStatusService }) =>
|
|
hostStatusService.reportLogin(hostId, { ok: true }),
|
|
)
|
|
.catch(() => {});
|
|
};
|
|
|
|
/** Checks, connects and audits one new connection. */
|
|
const connectOnce = async (
|
|
host: number | PluginSshHost,
|
|
options?: PluginSshConnectOptions,
|
|
) => {
|
|
try {
|
|
await checkSsh(true);
|
|
} catch (error) {
|
|
await audit("ssh_connect", describeHost(host), {
|
|
success: false,
|
|
errorMessage: error instanceof Error ? error.message : String(error),
|
|
});
|
|
throw error;
|
|
}
|
|
|
|
let userId: string;
|
|
try {
|
|
userId = userFor(host);
|
|
} catch (error) {
|
|
await audit("ssh_connect", describeHost(host), {
|
|
success: false,
|
|
errorMessage: error instanceof Error ? error.message : String(error),
|
|
});
|
|
throw error;
|
|
}
|
|
const { connectHost } = await import("../hosts/connect/connect-host.js");
|
|
try {
|
|
const connection = await connectHost(toConnectHost(host, userId), {
|
|
userId,
|
|
purpose: purposeOf(options),
|
|
profile: profileOf(options),
|
|
timeoutMs: options?.timeoutMs,
|
|
prompt: options?.prompt,
|
|
overrides: options?.overrides as Partial<MutableConnectConfig>,
|
|
sock: options?.sock as MutableConnectConfig["sock"],
|
|
});
|
|
await audit("ssh_connect", describeHost(host), { success: true });
|
|
reportLogin(host);
|
|
|
|
const dispose = () => {
|
|
open.delete(dispose);
|
|
connection.dispose();
|
|
};
|
|
open.add(dispose);
|
|
connection.client.once("close", () => open.delete(dispose));
|
|
return {
|
|
...connection,
|
|
host: handOut(connection.host as SshConnectHost, userId),
|
|
dispose,
|
|
};
|
|
} catch (error) {
|
|
await audit("ssh_connect", describeHost(host), {
|
|
success: false,
|
|
errorMessage: error instanceof Error ? error.message : String(error),
|
|
});
|
|
throw error;
|
|
}
|
|
};
|
|
|
|
const poolKey = (pool: string, host: PluginSshHost) =>
|
|
`${pool}:${host.userId}:${host.ip}:${host.port}:${host.username}${
|
|
host.useSocks5 ? `:socks5:${host.socks5Host}:${host.socks5Port}` : ""
|
|
}`;
|
|
|
|
return {
|
|
connect: async (host, options) => {
|
|
const connection = await connectOnce(host, options);
|
|
return {
|
|
client: connection.client as never,
|
|
jumpClient: connection.jumpClient as never,
|
|
host: connection.host,
|
|
dispose: connection.dispose,
|
|
};
|
|
},
|
|
|
|
withConnection: async (host, options, fn) => {
|
|
await checkSsh(true);
|
|
const { resolveConnectHost } =
|
|
await import("../hosts/connect/connect-host.js");
|
|
const userId = userFor(host);
|
|
const resolved = await resolveConnectHost(
|
|
toConnectHost(host, userId),
|
|
userId,
|
|
);
|
|
remember(resolved, resolved, userId);
|
|
const key = poolKey(options.pool, resolved as PluginSshHost);
|
|
poolKeys.set(key, resolved.id);
|
|
const { withConnection } =
|
|
await import("../hosts/ssh-connection-pool.js");
|
|
return withConnection(
|
|
key,
|
|
async () =>
|
|
(await connectOnce(resolved as PluginSshHost, options)).client,
|
|
(client) => fn(client as never),
|
|
);
|
|
},
|
|
|
|
jumpChain: async (jumpHosts, chainOptions) => {
|
|
await checkSsh(true);
|
|
const userId = userFor(chainOptions?.forHost);
|
|
const { createJumpHostChain } =
|
|
await import("../hosts/jump-host-chain.js");
|
|
const client = await createJumpHostChain(
|
|
jumpHosts,
|
|
userId,
|
|
chainOptions?.prompt as Parameters<typeof createJumpHostChain>[2],
|
|
);
|
|
const details = `jump chain of ${jumpHosts.length} hop(s)`;
|
|
if (!client) {
|
|
await audit("ssh_jump_chain", details, {
|
|
success: false,
|
|
errorMessage: "Jump host chain could not be established",
|
|
});
|
|
throw new Error("Jump host chain could not be established");
|
|
}
|
|
await audit("ssh_jump_chain", details, { success: true });
|
|
const dispose = () => {
|
|
open.delete(dispose);
|
|
client.end();
|
|
};
|
|
open.add(dispose);
|
|
client.once("close", () => open.delete(dispose));
|
|
// A jump chain ends at a forwarding client, not a single resolved SSH
|
|
// host: report the caller's own host if it gave one, else the last hop.
|
|
const host: PluginSshHost = chainOptions?.forHost
|
|
? (redactHostSecrets(
|
|
chainOptions.forHost as unknown as Record<string, unknown>,
|
|
) as unknown as PluginSshHost)
|
|
: {
|
|
id: jumpHosts[jumpHosts.length - 1]?.hostId ?? 0,
|
|
ip: "",
|
|
port: 22,
|
|
username: "",
|
|
};
|
|
return { client: client as never, jumpClient: null, host, dispose };
|
|
},
|
|
|
|
poolKey,
|
|
|
|
dropPooled: (pool, hostId) => {
|
|
const keys = [...poolKeys.entries()]
|
|
.filter(([key, id]) => id === hostId && key.startsWith(`${pool}:`))
|
|
.map(([key]) => key);
|
|
if (keys.length === 0) return;
|
|
for (const key of keys) poolKeys.delete(key);
|
|
void import("../hosts/ssh-connection-pool.js").then(
|
|
({ connectionPool }) => {
|
|
for (const key of keys) connectionPool.clearKeyConnections(key);
|
|
},
|
|
);
|
|
},
|
|
|
|
resolveHost: async (hostId, options) => {
|
|
await checkSsh(true);
|
|
const userId = actingUser();
|
|
const { resolveHostById, resolveHostBySyncId } =
|
|
await import("../hosts/host-resolver.js");
|
|
const resolved = options?.syncId
|
|
? await resolveHostBySyncId(options.syncId, userId)
|
|
: await resolveHostById(hostId, userId);
|
|
await audit("ssh_resolve_host", describeHost(hostId), {
|
|
success: !!resolved,
|
|
errorMessage: resolved ? undefined : "Host not found",
|
|
});
|
|
if (!resolved) return null;
|
|
// The secrets only go to a plugin that declared it reads them.
|
|
if (await hasCapability(pluginId, "credentials:read", declared)) {
|
|
await audit("credentials_read", describeHost(hostId), {
|
|
success: true,
|
|
});
|
|
const full = resolved as unknown as SshConnectHost;
|
|
remember(full, full, userId);
|
|
return full as unknown as PluginSshHost;
|
|
}
|
|
return handOut(resolved as unknown as SshConnectHost, userId);
|
|
},
|
|
|
|
// The config it returns carries the password and private key, so it
|
|
// needs credentials:read on top of the connect pair.
|
|
prepare: async (host, options) => {
|
|
await checkSsh(true);
|
|
await assertCapability(pluginId, "credentials:read", declared);
|
|
const userId = userFor(host);
|
|
const target = toConnectHost(host, userId) as SshConnectHost;
|
|
const { buildConnectConfig } =
|
|
await import("../hosts/connect/build-connect-config.js");
|
|
const built = await buildConnectConfig(target, {
|
|
userId,
|
|
purpose: purposeOf(options),
|
|
profile: profileOf(options),
|
|
client: options.client as never,
|
|
serverHostId: options.serverHostId,
|
|
log: options.log,
|
|
interactive: options.interactive,
|
|
hostKeySocket: (options.hostKeySocket ?? null) as never,
|
|
});
|
|
await audit("ssh_prepare", describeHost(host), {
|
|
success: built.outcome.status === "ready",
|
|
errorMessage:
|
|
built.outcome.status === "ready" ? undefined : built.outcome.message,
|
|
});
|
|
const provider = built.provider;
|
|
return {
|
|
config: built.config,
|
|
outcome: built.outcome,
|
|
authType: provider?.type ?? null,
|
|
onBanner: provider?.onBanner
|
|
? (banner: string) =>
|
|
provider.onBanner!(banner, target, built.env) as never
|
|
: undefined,
|
|
onAuthFailed: provider?.onAuthFailed
|
|
? (context) => provider.onAuthFailed!(target, built.env, context)
|
|
: undefined,
|
|
};
|
|
},
|
|
|
|
openTransport: async (host, config, transportOptions) => {
|
|
await checkSsh(true);
|
|
const target = toConnectHost(host, userFor(host)) as SshConnectHost;
|
|
const { openSshTransport } =
|
|
await import("../hosts/connect/transport.js");
|
|
let opened: Awaited<ReturnType<typeof openSshTransport>>;
|
|
try {
|
|
opened = await openSshTransport(
|
|
target,
|
|
config as MutableConnectConfig,
|
|
transportOptions,
|
|
);
|
|
} catch (error) {
|
|
await audit("ssh_open_transport", describeHost(host), {
|
|
success: false,
|
|
errorMessage: error instanceof Error ? error.message : String(error),
|
|
});
|
|
throw error;
|
|
}
|
|
await audit("ssh_open_transport", describeHost(host), { success: true });
|
|
if (opened.jumpClient) {
|
|
const jumpClient = opened.jumpClient;
|
|
const dispose = () => {
|
|
open.delete(dispose);
|
|
jumpClient.end();
|
|
};
|
|
open.add(dispose);
|
|
jumpClient.once("close", () => open.delete(dispose));
|
|
}
|
|
return opened;
|
|
},
|
|
|
|
startInteraction: async (interaction, request) => {
|
|
await checkSsh(true);
|
|
const userId = actingUser();
|
|
ensureCoreSshAuthProviders();
|
|
const { PermissionManager } =
|
|
await import("../utils/permission-manager.js");
|
|
const access = await PermissionManager.getInstance().canAccessHost(
|
|
userId,
|
|
request.hostId,
|
|
"connect",
|
|
);
|
|
if (!access.hasAccess) {
|
|
await audit("ssh_start_interaction", describeHost(request.hostId), {
|
|
success: false,
|
|
errorMessage: "Host not found",
|
|
});
|
|
throw new PluginSshInteractionError("Host not found");
|
|
}
|
|
const { createCurrentHostResolutionRepository } =
|
|
await import("../database/repositories/factory.js");
|
|
const host = await createCurrentHostResolutionRepository().findHostById(
|
|
request.hostId,
|
|
userId,
|
|
);
|
|
if (!host) throw new PluginSshInteractionError("Host not found");
|
|
|
|
const own = getSshAuthProvider(host.authType as string);
|
|
const provider =
|
|
own?.interaction === interaction && own.startInteraction
|
|
? own
|
|
: listSshAuthProviders().find(
|
|
(candidate) =>
|
|
candidate.interaction === interaction &&
|
|
candidate.startInteraction,
|
|
);
|
|
if (!provider?.startInteraction) {
|
|
throw new PluginSshInteractionError(
|
|
`No enabled provider handles ${interaction} sign-in`,
|
|
);
|
|
}
|
|
await audit("ssh_start_interaction", describeHost(request.hostId), {
|
|
success: true,
|
|
});
|
|
await provider.startInteraction({
|
|
userId,
|
|
hostId: request.hostId,
|
|
host: {
|
|
name: host.name as string | null,
|
|
ip: host.ip as string,
|
|
username: host.username as string,
|
|
},
|
|
socket: request.socket as never,
|
|
requestOrigin: request.requestOrigin,
|
|
payload: request.payload ?? {},
|
|
});
|
|
},
|
|
|
|
cancelInteraction: async (interaction, request) => {
|
|
await checkSsh(false);
|
|
const userId = actingUser();
|
|
ensureCoreSshAuthProviders();
|
|
for (const provider of listSshAuthProviders()) {
|
|
if (provider.interaction !== interaction) continue;
|
|
if (!provider.cancelInteraction) continue;
|
|
await provider.cancelInteraction({ userId, ...request });
|
|
}
|
|
},
|
|
|
|
classifyKeyboardInteractive: (round, host) => {
|
|
ensureCoreSshAuthProviders();
|
|
return classifyKeyboardInteractive(round, host as SshConnectHost);
|
|
},
|
|
|
|
autoResponses: (prompts, password) =>
|
|
prompts.map((p) =>
|
|
/password/i.test(p.prompt) && password ? password : "",
|
|
),
|
|
|
|
requiresSecret: (authType) => {
|
|
ensureCoreSshAuthProviders();
|
|
return !!getSshAuthProvider(authType)?.requiresSecret;
|
|
},
|
|
|
|
supportsBackground: (authType) => {
|
|
ensureCoreSshAuthProviders();
|
|
const provider = getSshAuthProvider(authType);
|
|
return !!provider && provider.supportsBackground !== false;
|
|
},
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Turns what a plugin method returned into core's identity. Only the fields
|
|
* the SDK documents are copied, so a plugin cannot set core-only extras, and
|
|
* its rate limit key is kept apart from core's and other plugins'.
|
|
*/
|
|
export function toCoreIdentity(
|
|
pluginId: string,
|
|
identity: PluginVerifiedIdentity,
|
|
): VerifiedIdentity {
|
|
if (identity.kind === "user") {
|
|
return {
|
|
kind: "user",
|
|
userId: identity.userId,
|
|
mfaSatisfied: identity.mfaSatisfied,
|
|
password: identity.password,
|
|
returnTo: identity.returnTo,
|
|
rememberMe: identity.rememberMe,
|
|
};
|
|
}
|
|
return {
|
|
kind: "external",
|
|
provider: identity.provider,
|
|
subject: identity.subject,
|
|
email: identity.email,
|
|
name: identity.name,
|
|
groups: identity.groups,
|
|
isAdmin: identity.isAdmin,
|
|
allowedUsers: identity.allowedUsers,
|
|
mfaSatisfied: identity.mfaSatisfied,
|
|
returnTo: identity.returnTo,
|
|
rememberMe: identity.rememberMe,
|
|
legacyIdentifier: identity.legacy?.identifier,
|
|
externalSession: identity.logoutClaims
|
|
? {
|
|
providerId: identity.logoutClaims.providerId ?? null,
|
|
sub: identity.logoutClaims.sub ?? null,
|
|
sid: identity.logoutClaims.sid ?? null,
|
|
}
|
|
: null,
|
|
roleSync: identity.roles
|
|
? {
|
|
desired: [...identity.roles.desired],
|
|
managed: [...identity.roles.managed],
|
|
}
|
|
: undefined,
|
|
rateLimitUsername: identity.rateLimitKey
|
|
? rateLimitKeyFor(pluginId, identity.rateLimitKey)
|
|
: undefined,
|
|
};
|
|
}
|
|
|
|
function rateLimitKeyFor(pluginId: string, key: string): string {
|
|
return `plugin:${pluginId}:${key}`;
|
|
}
|
|
|
|
export function createPluginAuth({ manifest, bag, audit }: Deps): PluginAuth {
|
|
const pluginId = manifest.id;
|
|
const declared = manifest.capabilities;
|
|
const contributes = manifest.contributes?.auth ?? {};
|
|
|
|
// Registration is synchronous so a plugin can call it inline in activate,
|
|
// like ctx.http.router. The declaration is checked here; the grant is
|
|
// checked on every call into what was registered.
|
|
const requireDeclared = (
|
|
list: string[] | undefined,
|
|
id: string,
|
|
field: string,
|
|
) => {
|
|
if (!declared.includes("auth:provide")) {
|
|
throw capabilityRefused(pluginId, "auth:provide");
|
|
}
|
|
if (!list?.includes(id)) {
|
|
throw new Error(
|
|
`Plugin ${pluginId} cannot register "${id}": it is not listed in contributes.auth.${field}`,
|
|
);
|
|
}
|
|
};
|
|
|
|
const granted = () => assertCapability(pluginId, "auth:provide", declared);
|
|
// ssh2 calls some hooks synchronously, so those answer from the grant
|
|
// cache and do nothing until the grant is confirmed.
|
|
const grantedNow = () =>
|
|
hasCachedCapability(pluginId, "auth:provide", declared);
|
|
|
|
const record = (action: string, id: string) =>
|
|
void audit(action, `${pluginId} registered ${id}`, { success: true });
|
|
|
|
return {
|
|
registerSshAuthProvider: (provider) => {
|
|
requireDeclared(contributes.sshAuthTypes, provider.type, "sshAuthTypes");
|
|
const wrapped: SshAuthProvider = {
|
|
...(provider as unknown as SshAuthProvider),
|
|
pluginId,
|
|
prepare: async (config, host, env) => {
|
|
await granted();
|
|
return provider.prepare(
|
|
config,
|
|
host as PluginSshHost,
|
|
env as never,
|
|
) as never;
|
|
},
|
|
};
|
|
if (provider.onBanner) {
|
|
const onBanner = provider.onBanner;
|
|
wrapped.onBanner = (banner, host, env) =>
|
|
grantedNow()
|
|
? (onBanner(banner, host as PluginSshHost, env as never) as never)
|
|
: (undefined as never);
|
|
}
|
|
if (provider.onAuthFailed) {
|
|
const onAuthFailed = provider.onAuthFailed;
|
|
wrapped.onAuthFailed = (host, env, context) =>
|
|
grantedNow()
|
|
? (onAuthFailed(
|
|
host as PluginSshHost,
|
|
env as never,
|
|
context as never,
|
|
) as never)
|
|
: undefined;
|
|
}
|
|
warmPluginGrants(pluginId);
|
|
ensureCoreSshAuthProviders();
|
|
const disposers = [registerSshAuthProvider(wrapped)];
|
|
if (provider.onKeyboardInteractive) {
|
|
const detect = provider.onKeyboardInteractive;
|
|
disposers.push(
|
|
registerKeyboardInteractiveInterceptor({
|
|
id: `${pluginId}:${provider.type}`,
|
|
pluginId,
|
|
detect: (round, host) =>
|
|
host.authType === provider.type && grantedNow()
|
|
? (detect(round, host as PluginSshHost) as never)
|
|
: null,
|
|
}),
|
|
);
|
|
}
|
|
bag.add(
|
|
() => disposers.forEach((dispose) => dispose()),
|
|
`SSH auth type "${provider.type}"`,
|
|
);
|
|
record("auth_register_ssh", provider.type);
|
|
},
|
|
|
|
registerKeyboardInteractiveHandler: (handler) => {
|
|
requireDeclared(
|
|
contributes.keyboardInteractive,
|
|
handler.id,
|
|
"keyboardInteractive",
|
|
);
|
|
// Synchronous hooks inside ssh2's callback, so they answer from the
|
|
// grant cache. Deactivate removes the handler.
|
|
warmPluginGrants(pluginId);
|
|
const settingsFor = (host: SshConnectHost): Record<string, unknown> =>
|
|
host.pluginSettings?.[pluginId] ?? {};
|
|
ensureCoreSshAuthProviders();
|
|
const dispose = registerKeyboardInteractiveInterceptor({
|
|
id: handler.id,
|
|
pluginId,
|
|
detect: (round, host) => {
|
|
if (!grantedNow()) return null;
|
|
const detected = handler.detect(
|
|
round,
|
|
host as PluginSshHost,
|
|
settingsFor(host),
|
|
);
|
|
if (!detected) return null;
|
|
if (detected.kind === "browser") {
|
|
return { ...detected, id: handler.id, label: handler.label };
|
|
}
|
|
return detected;
|
|
},
|
|
autoAnswerPasswords: handler.autoAnswerPasswords
|
|
? (host) =>
|
|
grantedNow() &&
|
|
handler.autoAnswerPasswords!(
|
|
host as PluginSshHost,
|
|
settingsFor(host),
|
|
) === true
|
|
: undefined,
|
|
});
|
|
bag.add(dispose, `keyboard-interactive handler "${handler.id}"`);
|
|
record("auth_register_keyboard_interactive", handler.id);
|
|
},
|
|
|
|
registerLoginMethod: (method) => {
|
|
requireDeclared(contributes.loginMethods, method.id, "loginMethods");
|
|
{
|
|
const dispose = registerLoginMethod({
|
|
...method,
|
|
pluginId,
|
|
start: method.start
|
|
? async (...args) => {
|
|
await granted();
|
|
return method.start!(...args);
|
|
}
|
|
: undefined,
|
|
callback: method.callback
|
|
? async (...args) => {
|
|
await granted();
|
|
return toCoreIdentity(
|
|
pluginId,
|
|
await method.callback!(...args),
|
|
);
|
|
}
|
|
: undefined,
|
|
verify: method.verify
|
|
? async (...args) => {
|
|
await granted();
|
|
return toCoreIdentity(pluginId, await method.verify!(...args));
|
|
}
|
|
: undefined,
|
|
});
|
|
bag.add(dispose, `login method "${method.id}"`);
|
|
}
|
|
record("auth_register_login", method.id);
|
|
},
|
|
|
|
registerSecondFactor: (factor) => {
|
|
requireDeclared(contributes.secondFactors, factor.id, "secondFactors");
|
|
{
|
|
const dispose = registerSecondFactor({
|
|
...factor,
|
|
pluginId,
|
|
verify: async (userId, body) => {
|
|
await granted();
|
|
return factor.verify(userId, body);
|
|
},
|
|
});
|
|
bag.add(dispose, `second factor "${factor.id}"`);
|
|
}
|
|
record("auth_register_factor", factor.id);
|
|
},
|
|
|
|
recordEnrollment: async (userId, factorId) => {
|
|
requireDeclared(contributes.secondFactors, factorId, "secondFactors");
|
|
await granted();
|
|
const { assertSecondFactorEnrollmentAllowed } =
|
|
await import("../auth/core-auth.js");
|
|
assertSecondFactorEnrollmentAllowed();
|
|
const {
|
|
createCurrentSessionRepository,
|
|
createCurrentTrustedDeviceRepository,
|
|
createCurrentUserAuthRepository,
|
|
} = await import("../database/repositories/factory.js");
|
|
await createCurrentUserAuthRepository().recordSecondFactor(
|
|
userId,
|
|
pluginId,
|
|
factorId,
|
|
);
|
|
// A new factor signs the user out everywhere else and forgets trusted
|
|
// devices, so nothing that skipped it before keeps skipping it.
|
|
await createCurrentSessionRepository().revokeAllForUser(
|
|
userId,
|
|
getActor() === userId ? getActorSessionId() : undefined,
|
|
);
|
|
await createCurrentTrustedDeviceRepository().deleteByUserId(userId);
|
|
await audit("auth_factor_enrolled", `${factorId} for ${userId}`, {
|
|
success: true,
|
|
});
|
|
},
|
|
|
|
removeEnrollment: async (userId, factorId) => {
|
|
requireDeclared(contributes.secondFactors, factorId, "secondFactors");
|
|
await granted();
|
|
const { createCurrentUserAuthRepository } =
|
|
await import("../database/repositories/factory.js");
|
|
await createCurrentUserAuthRepository().removeSecondFactor(
|
|
userId,
|
|
pluginId,
|
|
factorId,
|
|
);
|
|
await audit("auth_factor_removed", `${factorId} for ${userId}`, {
|
|
success: true,
|
|
});
|
|
},
|
|
|
|
completeRedirectLogin: async (methodId, req, res) => {
|
|
requireDeclared(contributes.loginMethods, methodId, "loginMethods");
|
|
await granted();
|
|
const method = getLoginMethod(methodId);
|
|
if (!method || method.pluginId !== pluginId) {
|
|
throw new Error(
|
|
`Plugin ${pluginId} has no registered login method "${methodId}"`,
|
|
);
|
|
}
|
|
const { handleRedirectCallback } =
|
|
await import("../database/routes/auth-routes.js");
|
|
await handleRedirectCallback(method, req as never, res as never);
|
|
},
|
|
|
|
revokeSessions: async (match) => {
|
|
await granted();
|
|
if (!match.sub && !match.sid) return 0;
|
|
const { AuthManager } = await import("../utils/auth-manager.js");
|
|
const revoked =
|
|
await AuthManager.getInstance().revokeSessionsByExternalSession({
|
|
providerId: match.providerId ?? null,
|
|
sub: match.sub ?? null,
|
|
sid: match.sid ?? null,
|
|
});
|
|
await audit(
|
|
"auth_sessions_revoked",
|
|
`${revoked} session(s) for provider ${match.providerId ?? "none"}`,
|
|
{ success: true },
|
|
);
|
|
return revoked;
|
|
},
|
|
|
|
loginRateLimit: {
|
|
isLocked: async (ip, key) => {
|
|
await granted();
|
|
const { loginRateLimiter } =
|
|
await import("../utils/login-rate-limiter.js");
|
|
return loginRateLimiter.isLocked(ip, rateLimitKeyFor(pluginId, key));
|
|
},
|
|
recordFailure: async (ip, key) => {
|
|
await granted();
|
|
const { loginRateLimiter } =
|
|
await import("../utils/login-rate-limiter.js");
|
|
loginRateLimiter.recordFailedAttempt(
|
|
ip,
|
|
rateLimitKeyFor(pluginId, key),
|
|
);
|
|
},
|
|
},
|
|
|
|
countLinkedUsers: async (provider) => {
|
|
await granted();
|
|
const { createCurrentUserAuthRepository } =
|
|
await import("../database/repositories/factory.js");
|
|
return createCurrentUserAuthRepository().countUsersForProvider(provider);
|
|
},
|
|
issueUserToken: (userId, options) =>
|
|
issueUserToken(manifest, userId, options),
|
|
};
|
|
}
|