fix(host-console): audit session lifecycle and harden path, resize, and route gating (#1263)

* fix(host-console): audit session lifecycle and harden path, resize, and route gating

Record an audit-log entry when a host console session opens and when it
closes (capturing user, node, client IP, and timestamp), so interactive
host-shell access leaves a durable, accountable trail instead of only an
ephemeral log line.

Fix a stack-path boundary check that allowed a sibling directory sharing
the base path's prefix to pass; directory resolution now uses the
canonical within-base check via a small testable helper.

Validate terminal resize frames (positive integers within a sane bound)
before forwarding them to the PTY, dropping malformed frames instead of
passing them through.

Mirror the backend admin-only console permission on the frontend route so
a non-admin who reaches the view cannot mount a console the server would
reject, and log (rather than silently swallow) a working-directory
resolution failure.

Add unit coverage for the path helper, audit open/close rows, resize
validation, and the spawn-error path, plus a WebSocket-upgrade integration
test exercising the full gate chain and a live session-open audit row.

* fix(host-console): record the node the shell actually runs in

When the requested node's directory cannot be resolved, the session falls
back to the default node's base directory. Record that fallback node in the
session audit row (and log it) so the audit trail names the node the shell
actually runs in rather than the originally requested one. Strengthen the
upgrade integration test to assert the open row captures the user, node, and
client IP.
This commit is contained in:
Anso
2026-05-31 20:29:30 -04:00
committed by GitHub
parent 7e65a2ae19
commit d4fa4a4965
6 changed files with 452 additions and 19 deletions
@@ -0,0 +1,140 @@
/**
* Integration tests for the Host Console WebSocket upgrade. These drive the
* real upgrade handler through a listening server (no mocked sockets) to verify
* the gate chain end-to-end: unauthenticated, machine-credential, RBAC, and
* tier rejections, plus the accepted path (which must record an audit row) and
* the stack-path boundary rejection.
*/
import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest';
import jwt from 'jsonwebtoken';
import bcrypt from 'bcrypt';
import WebSocket from 'ws';
import { setupTestDb, cleanupTestDb, TEST_USERNAME, TEST_JWT_SECRET } from './helpers/setupTestDb';
const HOST_CONSOLE_PATH = '/api/system/host-console';
describe('WebSocket upgrade - host console auth enforcement', () => {
let tmpDir: string;
let server: import('http').Server;
let getTierSpy: ReturnType<typeof vi.spyOn>;
beforeAll(async () => {
vi.restoreAllMocks();
tmpDir = await setupTestDb();
// Host console requires paid + admiral; mock the license so the tier gate
// passes for the admin/accepted cases. Individual tests override as needed.
const { LicenseService } = await import('../services/LicenseService');
getTierSpy = vi.spyOn(LicenseService.getInstance(), 'getTier').mockReturnValue('paid');
vi.spyOn(LicenseService.getInstance(), 'getVariant').mockReturnValue('admiral');
const mod = await import('../index');
server = mod.server;
await new Promise<void>((resolve) => server.listen(0, resolve));
});
afterAll(async () => {
await new Promise<void>((resolve) => server.close(() => resolve()));
vi.restoreAllMocks();
cleanupTestDb(tmpDir);
});
function wsUrl(query = ''): string {
const addr = server.address();
if (!addr || typeof addr === 'string') throw new Error('Server not listening');
return `ws://127.0.0.1:${addr.port}${HOST_CONSOLE_PATH}${query}`;
}
function adminToken(): string {
return jwt.sign({ username: TEST_USERNAME, role: 'admin' }, TEST_JWT_SECRET, { expiresIn: '1m' });
}
/** Resolve to the HTTP status of a rejected upgrade (0 if no response). */
function expectRejected(ws: WebSocket): Promise<number> {
return new Promise<number>((resolve) => {
ws.on('unexpected-response', (_req, res) => resolve(res.statusCode ?? 0));
ws.on('open', () => { ws.close(); resolve(200); });
ws.on('error', () => resolve(0));
});
}
it('rejects an upgrade with no token (401)', async () => {
expect(await expectRejected(new WebSocket(wsUrl()))).toBe(401);
});
it('rejects a node_proxy machine token (403)', async () => {
const token = jwt.sign({ scope: 'node_proxy' }, TEST_JWT_SECRET, { expiresIn: '1m' });
const ws = new WebSocket(wsUrl(), { headers: { Authorization: `Bearer ${token}` } });
expect(await expectRejected(ws)).toBe(403);
});
it('rejects a non-admin user without system:console (403)', async () => {
const { DatabaseService } = await import('../services/DatabaseService');
const hash = await bcrypt.hash('viewerpass', 1);
try {
DatabaseService.getInstance().addUser({ username: 'hc_viewer', password_hash: hash, role: 'viewer' });
} catch {
// already exists from a prior run in the same worker
}
const token = jwt.sign({ username: 'hc_viewer', role: 'viewer' }, TEST_JWT_SECRET, { expiresIn: '1m' });
const ws = new WebSocket(wsUrl(), { headers: { Cookie: `sencho_token=${token}` } });
expect(await expectRejected(ws)).toBe(403);
});
it('rejects an admin on a sub-Admiral tier (403)', async () => {
getTierSpy.mockReturnValueOnce('free');
const ws = new WebSocket(wsUrl(), { headers: { Cookie: `sencho_token=${adminToken()}` } });
expect(await expectRejected(ws)).toBe(403);
});
it('accepts an admin on Admiral and records an open audit row', async () => {
const { DatabaseService } = await import('../services/DatabaseService');
const insertSpy = vi.spyOn(DatabaseService.getInstance(), 'insertAuditLog');
const ws = new WebSocket(wsUrl(), { headers: { Cookie: `sencho_token=${adminToken()}` } });
const opened = await new Promise<boolean>((resolve) => {
ws.on('open', () => resolve(true));
ws.on('error', () => resolve(false));
ws.on('unexpected-response', () => resolve(false));
});
expect(opened).toBe(true);
// The session-open audit row is written server-side just after the PTY
// spawns; poll briefly for it, then assert it captures the real identity.
let openRow: Omit<import('../services/DatabaseService').AuditLogEntry, 'id'> | undefined;
await waitFor(() => {
const call = insertSpy.mock.calls.find(
([entry]) => entry?.path === HOST_CONSOLE_PATH && entry?.summary === 'Opened host console session',
);
if (call) openRow = call[0];
return openRow !== undefined;
});
expect(openRow).toBeDefined();
expect(openRow?.username).toBe(TEST_USERNAME);
expect(typeof openRow?.node_id).toBe('number');
expect(openRow?.ip_address).toBeTruthy();
ws.close();
insertSpy.mockRestore();
});
it('rejects a stack path that escapes the base directory', async () => {
const ws = new WebSocket(wsUrl('?stack=' + encodeURIComponent('../escape-evil')), {
headers: { Cookie: `sencho_token=${adminToken()}` },
});
const firstMessage = await new Promise<string>((resolve) => {
ws.on('message', (data) => resolve(data.toString()));
ws.on('error', () => resolve(''));
ws.on('unexpected-response', () => resolve(''));
});
expect(firstMessage).toContain('Invalid stack path');
ws.close();
});
});
/** Poll a predicate up to ~1s; resolve true as soon as it passes. */
async function waitFor(predicate: () => boolean): Promise<boolean> {
for (let i = 0; i < 50; i++) {
if (predicate()) return true;
await new Promise((r) => setTimeout(r, 20));
}
return predicate();
}