mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-03 05:59:43 +02:00
Merge pull request #107 from aakhter/cod-29-network-auth-downloads
fix: COD-29 harden network auth and downloads
This commit is contained in:
+135
-38
@@ -3,26 +3,60 @@
|
||||
* 1. Timing-safe password comparison (timingSafeEqual)
|
||||
* 2. Hook event endpoint restricted to localhost
|
||||
* 3. Session cookie TTL refresh on access
|
||||
* 4. Startup warning when no password configured
|
||||
* 4. Startup fails closed when network-bound without auth
|
||||
* 5. SSE client limit enforcement
|
||||
* 6. Logout endpoint invalidates session
|
||||
* 7. Settings schema rejects unknown fields
|
||||
*
|
||||
* Port: 3160 (auth tests), 3161 (no-auth tests)
|
||||
* Port: 3160 (auth tests), 3161 (loopback no-auth tests), 3162 (network override tests)
|
||||
*/
|
||||
import { describe, it, expect, beforeAll, afterAll } from 'vitest';
|
||||
import { describe, it, expect, beforeAll, afterAll, beforeEach, afterEach, vi } from 'vitest';
|
||||
import { WebServer } from '../src/web/server.js';
|
||||
import { TmuxManager } from '../src/tmux-manager.js';
|
||||
import { SettingsUpdateSchema } from '../src/web/schemas.js';
|
||||
|
||||
const AUTH_PORT = 3160;
|
||||
const NOAUTH_PORT = 3161;
|
||||
const NETWORK_OVERRIDE_PORT = 3162;
|
||||
const AUTH_RATE_LIMIT_PORT = 3220;
|
||||
const TEST_USER = 'admin';
|
||||
const TEST_PASS = 'test-password-12345';
|
||||
|
||||
vi.spyOn(TmuxManager, 'isTmuxAvailable').mockReturnValue(true);
|
||||
|
||||
function basicAuthHeader(user: string, pass: string): string {
|
||||
return 'Basic ' + Buffer.from(`${user}:${pass}`).toString('base64');
|
||||
}
|
||||
|
||||
async function startAuthServer(port: number): Promise<{ server: WebServer; baseUrl: string }> {
|
||||
process.env.CODEMAN_PASSWORD = TEST_PASS;
|
||||
process.env.CODEMAN_USERNAME = TEST_USER;
|
||||
const server = new WebServer(port, false, true);
|
||||
await server.start();
|
||||
return { server, baseUrl: `http://localhost:${port}` };
|
||||
}
|
||||
|
||||
async function getSessionCookie(baseUrl: string): Promise<string> {
|
||||
const res = await fetch(`${baseUrl}/api/status`, {
|
||||
headers: { Authorization: basicAuthHeader(TEST_USER, TEST_PASS) },
|
||||
});
|
||||
expect(res.status).toBe(200);
|
||||
const setCookie = res.headers.get('set-cookie');
|
||||
expect(setCookie).toBeTruthy();
|
||||
const cookieMatch = setCookie!.match(/codeman_session=([^;]+)/);
|
||||
expect(cookieMatch).toBeTruthy();
|
||||
return `codeman_session=${cookieMatch![1]}`;
|
||||
}
|
||||
|
||||
async function exhaustAuthFailures(baseUrl: string, prefix: string): Promise<void> {
|
||||
for (let i = 0; i < 10; i++) {
|
||||
const res = await fetch(`${baseUrl}/api/status`, {
|
||||
headers: { Authorization: basicAuthHeader(TEST_USER, `${prefix}-${i}`) },
|
||||
});
|
||||
expect(res.status).toBe(401);
|
||||
}
|
||||
}
|
||||
|
||||
describe('Auth Security', () => {
|
||||
let server: WebServer;
|
||||
let baseUrl: string;
|
||||
@@ -154,29 +188,63 @@ describe('Auth Security', () => {
|
||||
});
|
||||
|
||||
describe('Rate Limiting', () => {
|
||||
it('should block after too many failed attempts', async () => {
|
||||
// Send 10 failed attempts
|
||||
for (let i = 0; i < 10; i++) {
|
||||
await fetch(`${baseUrl}/api/status`, {
|
||||
headers: { Authorization: basicAuthHeader(TEST_USER, 'wrong-' + i) },
|
||||
});
|
||||
}
|
||||
let rateServer: WebServer;
|
||||
let rateBaseUrl: string;
|
||||
|
||||
// 11th attempt should be rate-limited
|
||||
const res = await fetch(`${baseUrl}/api/status`, {
|
||||
headers: { Authorization: basicAuthHeader(TEST_USER, 'wrong-again') },
|
||||
});
|
||||
expect(res.status).toBe(429);
|
||||
beforeEach(async () => {
|
||||
({ server: rateServer, baseUrl: rateBaseUrl } = await startAuthServer(AUTH_RATE_LIMIT_PORT));
|
||||
});
|
||||
|
||||
it('should rate-limit even with correct credentials after lockout', async () => {
|
||||
// After being rate-limited, even correct credentials should fail
|
||||
const res = await fetch(`${baseUrl}/api/status`, {
|
||||
afterEach(async () => {
|
||||
await rateServer.stop();
|
||||
});
|
||||
|
||||
it('should rate-limit wrong credentials after too many failed attempts', async () => {
|
||||
await exhaustAuthFailures(rateBaseUrl, 'cod21-wrong');
|
||||
|
||||
const res = await fetch(`${rateBaseUrl}/api/status`, {
|
||||
headers: { Authorization: basicAuthHeader(TEST_USER, 'wrong-again') },
|
||||
});
|
||||
|
||||
expect(res.status).toBe(429);
|
||||
expect(res.headers.get('retry-after')).toMatch(/^\d+$/);
|
||||
});
|
||||
|
||||
it('should allow an existing valid session cookie during auth failure lockout', async () => {
|
||||
const cookie = await getSessionCookie(rateBaseUrl);
|
||||
await exhaustAuthFailures(rateBaseUrl, 'cod21-cookie');
|
||||
|
||||
const res = await fetch(`${rateBaseUrl}/api/status`, {
|
||||
headers: { Cookie: cookie },
|
||||
});
|
||||
|
||||
expect(res.status).toBe(200);
|
||||
});
|
||||
|
||||
it('should allow correct credentials to recover from auth failure lockout', async () => {
|
||||
await exhaustAuthFailures(rateBaseUrl, 'cod21-recover');
|
||||
|
||||
const res = await fetch(`${rateBaseUrl}/api/status`, {
|
||||
headers: { Authorization: basicAuthHeader(TEST_USER, TEST_PASS) },
|
||||
});
|
||||
// Rate limit is per-IP and the previous test used the same IP
|
||||
// This test verifies rate limiting isn't bypassed by correct creds
|
||||
expect(res.status).toBe(429);
|
||||
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.headers.get('set-cookie')).toContain('codeman_session=');
|
||||
});
|
||||
|
||||
it('should clear failed attempt count after correct credentials recover access', async () => {
|
||||
await exhaustAuthFailures(rateBaseUrl, 'cod21-clear');
|
||||
|
||||
const recoveryRes = await fetch(`${rateBaseUrl}/api/status`, {
|
||||
headers: { Authorization: basicAuthHeader(TEST_USER, TEST_PASS) },
|
||||
});
|
||||
expect(recoveryRes.status).toBe(200);
|
||||
|
||||
const wrongAfterRecovery = await fetch(`${rateBaseUrl}/api/status`, {
|
||||
headers: { Authorization: basicAuthHeader(TEST_USER, 'wrong-after-recovery') },
|
||||
});
|
||||
|
||||
expect(wrongAfterRecovery.status).toBe(401);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -220,7 +288,7 @@ describe('Settings Schema Security', () => {
|
||||
|
||||
it('should enforce tunnelEnabled as boolean', () => {
|
||||
const result = SettingsUpdateSchema.safeParse({
|
||||
tunnelEnabled: 'yes', // truthy string — should be rejected
|
||||
tunnelEnabled: 'yes', // truthy string — should be rejected
|
||||
});
|
||||
expect(result.success).toBe(false);
|
||||
});
|
||||
@@ -264,40 +332,69 @@ describe('Settings Schema Security', () => {
|
||||
expect(validResult.success).toBe(true);
|
||||
|
||||
const invalidResult = SettingsUpdateSchema.safeParse({
|
||||
nice: { enabled: true, niceValue: 100 }, // Out of range
|
||||
nice: { enabled: true, niceValue: 100 }, // Out of range
|
||||
});
|
||||
expect(invalidResult.success).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('No-Auth Server Warning', () => {
|
||||
describe('No-Auth Server Startup Policy', () => {
|
||||
let server: WebServer;
|
||||
let consoleWarnSpy: string[] = [];
|
||||
const originalWarn = console.warn;
|
||||
|
||||
beforeAll(async () => {
|
||||
delete process.env.CODEMAN_PASSWORD;
|
||||
delete process.env.CODEMAN_USERNAME;
|
||||
consoleWarnSpy = [];
|
||||
console.warn = (...args: unknown[]) => {
|
||||
consoleWarnSpy.push(args.map(String).join(' '));
|
||||
};
|
||||
server = new WebServer(NOAUTH_PORT, false, true);
|
||||
delete process.env.CODEMAN_ALLOW_UNAUTHENTICATED_NETWORK;
|
||||
server = new WebServer(NOAUTH_PORT, false, true, '127.0.0.1');
|
||||
await server.start();
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
console.warn = originalWarn;
|
||||
delete process.env.CODEMAN_PASSWORD;
|
||||
delete process.env.CODEMAN_USERNAME;
|
||||
delete process.env.CODEMAN_ALLOW_UNAUTHENTICATED_NETWORK;
|
||||
await server.stop();
|
||||
});
|
||||
|
||||
it('should warn when no CODEMAN_PASSWORD is set', () => {
|
||||
const hasWarning = consoleWarnSpy.some(msg => msg.includes('No CODEMAN_PASSWORD set'));
|
||||
expect(hasWarning).toBe(true);
|
||||
});
|
||||
|
||||
it('should allow requests without auth when no password configured', async () => {
|
||||
it('allows loopback requests without auth when no password is configured', async () => {
|
||||
const res = await fetch(`http://localhost:${NOAUTH_PORT}/api/status`);
|
||||
expect(res.status).toBe(200);
|
||||
});
|
||||
|
||||
it('rejects non-loopback startup without a password or explicit override', async () => {
|
||||
const networkServer = new WebServer(0, false, true, '0.0.0.0');
|
||||
|
||||
await expect(networkServer.start()).rejects.toThrow(/CODEMAN_PASSWORD/);
|
||||
|
||||
await networkServer.stop();
|
||||
});
|
||||
|
||||
it('allows non-loopback startup when CODEMAN_PASSWORD is configured', async () => {
|
||||
process.env.CODEMAN_PASSWORD = TEST_PASS;
|
||||
const networkServer = new WebServer(0, false, true, '0.0.0.0');
|
||||
|
||||
await networkServer.start();
|
||||
await networkServer.stop();
|
||||
|
||||
delete process.env.CODEMAN_PASSWORD;
|
||||
});
|
||||
|
||||
it('allows non-loopback startup with the explicit unauthenticated-network override', async () => {
|
||||
const networkServer = new WebServer(NETWORK_OVERRIDE_PORT, false, true, '0.0.0.0', undefined, true);
|
||||
|
||||
await networkServer.start();
|
||||
const res = await fetch(`http://localhost:${NETWORK_OVERRIDE_PORT}/api/status`);
|
||||
expect(res.status).toBe(200);
|
||||
await networkServer.stop();
|
||||
});
|
||||
|
||||
it('allows non-loopback startup with the explicit unauthenticated-network env override', async () => {
|
||||
process.env.CODEMAN_ALLOW_UNAUTHENTICATED_NETWORK = 'true';
|
||||
const networkServer = new WebServer(0, false, true, '0.0.0.0');
|
||||
|
||||
await networkServer.start();
|
||||
await networkServer.stop();
|
||||
|
||||
delete process.env.CODEMAN_ALLOW_UNAUTHENTICATED_NETWORK;
|
||||
});
|
||||
});
|
||||
|
||||
+34
-16
@@ -5,6 +5,7 @@
|
||||
*/
|
||||
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { program } from '../src/cli.js';
|
||||
|
||||
describe('CLI Command Parsing', () => {
|
||||
describe('Command Structure', () => {
|
||||
@@ -72,11 +73,11 @@ describe('CLI Command Parsing', () => {
|
||||
];
|
||||
|
||||
const findCommand = (name: string): Command | undefined => {
|
||||
return commands.find(c => c.name === name || c.aliases.includes(name));
|
||||
return commands.find((c) => c.name === name || c.aliases.includes(name));
|
||||
};
|
||||
|
||||
const findSubcommand = (parent: Command, name: string): Command | undefined => {
|
||||
return parent.subcommands?.find(c => c.name === name || c.aliases.includes(name));
|
||||
return parent.subcommands?.find((c) => c.name === name || c.aliases.includes(name));
|
||||
};
|
||||
|
||||
it('should find commands by name', () => {
|
||||
@@ -103,7 +104,7 @@ describe('CLI Command Parsing', () => {
|
||||
});
|
||||
|
||||
it('should have descriptions for all commands', () => {
|
||||
commands.forEach(cmd => {
|
||||
commands.forEach((cmd) => {
|
||||
expect(cmd.description).toBeTruthy();
|
||||
});
|
||||
});
|
||||
@@ -267,13 +268,13 @@ describe('CLI Command Parsing', () => {
|
||||
});
|
||||
|
||||
it('should have defaults for web flags', () => {
|
||||
webFlags.forEach(flag => {
|
||||
webFlags.forEach((flag) => {
|
||||
expect(flag.default).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
it('should have defaults for tui flags', () => {
|
||||
tuiFlags.forEach(flag => {
|
||||
tuiFlags.forEach((flag) => {
|
||||
expect(flag.default).toBeDefined();
|
||||
});
|
||||
});
|
||||
@@ -322,7 +323,7 @@ describe('CLI Command Parsing', () => {
|
||||
help += `${description}\n`;
|
||||
if (options.length > 0) {
|
||||
help += '\nOptions:\n';
|
||||
options.forEach(opt => {
|
||||
options.forEach((opt) => {
|
||||
help += ` ${opt}\n`;
|
||||
});
|
||||
}
|
||||
@@ -345,6 +346,15 @@ describe('CLI Command Parsing', () => {
|
||||
expect(help).toContain('--host');
|
||||
});
|
||||
|
||||
it('documents the unauthenticated network override in real web command help', () => {
|
||||
const webCommand = program.commands.find((command) => command.name() === 'web');
|
||||
expect(webCommand).toBeDefined();
|
||||
|
||||
const help = webCommand!.helpInformation();
|
||||
expect(help).toContain('--allow-unauthenticated-network');
|
||||
expect(help).toMatch(/without\s+CODEMAN_PASSWORD/);
|
||||
});
|
||||
|
||||
it('should format properly', () => {
|
||||
const help = generateHelp('test', 'Test command', ['--flag']);
|
||||
const lines = help.split('\n');
|
||||
@@ -474,22 +484,27 @@ describe('CLI Output Formatting', () => {
|
||||
}
|
||||
|
||||
const formatRow = (values: string[], columns: Column[]): string => {
|
||||
return values.map((val, i) => {
|
||||
const width = columns[i]?.width || 10;
|
||||
return val.padEnd(width).substring(0, width);
|
||||
}).join(' ');
|
||||
return values
|
||||
.map((val, i) => {
|
||||
const width = columns[i]?.width || 10;
|
||||
return val.padEnd(width).substring(0, width);
|
||||
})
|
||||
.join(' ');
|
||||
};
|
||||
|
||||
const formatTable = (headers: string[], rows: string[][], widths: number[]): string => {
|
||||
const columns = headers.map((h, i) => ({ header: h, width: widths[i] }));
|
||||
const headerRow = formatRow(headers, columns);
|
||||
const separator = columns.map(c => '-'.repeat(c.width)).join(' ');
|
||||
const dataRows = rows.map(row => formatRow(row, columns));
|
||||
const separator = columns.map((c) => '-'.repeat(c.width)).join(' ');
|
||||
const dataRows = rows.map((row) => formatRow(row, columns));
|
||||
return [headerRow, separator, ...dataRows].join('\n');
|
||||
};
|
||||
|
||||
it('should format single row', () => {
|
||||
const columns = [{ header: 'ID', width: 10 }, { header: 'Status', width: 8 }];
|
||||
const columns = [
|
||||
{ header: 'ID', width: 10 },
|
||||
{ header: 'Status', width: 8 },
|
||||
];
|
||||
const row = formatRow(['123', 'active'], columns);
|
||||
expect(row).toBe('123 active ');
|
||||
});
|
||||
@@ -503,7 +518,10 @@ describe('CLI Output Formatting', () => {
|
||||
it('should format complete table', () => {
|
||||
const table = formatTable(
|
||||
['ID', 'Status'],
|
||||
[['1', 'active'], ['2', 'idle']],
|
||||
[
|
||||
['1', 'active'],
|
||||
['2', 'idle'],
|
||||
],
|
||||
[5, 8]
|
||||
);
|
||||
expect(table).toContain('ID');
|
||||
@@ -587,7 +605,7 @@ describe('CLI Output Formatting', () => {
|
||||
});
|
||||
|
||||
it('should format normal costs with 2 decimals', () => {
|
||||
expect(formatCost(1.50)).toBe('$1.50');
|
||||
expect(formatCost(1.5)).toBe('$1.50');
|
||||
expect(formatCost(0.05)).toBe('$0.05');
|
||||
});
|
||||
|
||||
@@ -633,7 +651,7 @@ describe('CLI Output Formatting', () => {
|
||||
|
||||
describe('List Formatting', () => {
|
||||
const formatList = (items: string[], bullet: string = '-'): string => {
|
||||
return items.map(item => `${bullet} ${item}`).join('\n');
|
||||
return items.map((item) => `${bullet} ${item}`).join('\n');
|
||||
};
|
||||
|
||||
const formatNumberedList = (items: string[]): string => {
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { isExplicitlyEnabled, isLoopbackBindHost } from '../src/web/network-auth-policy.js';
|
||||
|
||||
describe('network auth policy', () => {
|
||||
it.each(['localhost', '127.0.0.1', '127.42.0.9', '::1', '[::1]', '0:0:0:0:0:0:0:1', '::ffff:127.0.0.1'])(
|
||||
'treats %s as loopback',
|
||||
(host) => {
|
||||
expect(isLoopbackBindHost(host)).toBe(true);
|
||||
}
|
||||
);
|
||||
|
||||
it.each(['0.0.0.0', '192.168.1.10', '10.0.0.1', 'example.com', '::', '[::]', '::ffff:192.168.1.10'])(
|
||||
'treats %s as non-loopback',
|
||||
(host) => {
|
||||
expect(isLoopbackBindHost(host)).toBe(false);
|
||||
}
|
||||
);
|
||||
|
||||
it.each(['1', 'true', 'TRUE', ' yes ', 'on'])('treats %s as an explicit opt-in', (value) => {
|
||||
expect(isExplicitlyEnabled(value)).toBe(true);
|
||||
});
|
||||
|
||||
it.each([undefined, '', '0', 'false', 'no', 'off', 'enabled'])('does not treat %s as an explicit opt-in', (value) => {
|
||||
expect(isExplicitlyEnabled(value)).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -47,7 +47,8 @@ interface PushPayload {
|
||||
|
||||
function makeServerWithHost(host: string): WebServer {
|
||||
// Constructor only assigns fields — no network/disk activity until start().
|
||||
const server = new WebServer(0, false, true, host);
|
||||
// 4th arg is the bind host; the title hostname is the 5th arg.
|
||||
const server = new WebServer(0, false, true, '127.0.0.1', host);
|
||||
// Stub push store: one subscription with all events enabled.
|
||||
const fakeSub = {
|
||||
endpoint: 'https://push.example.com/abc',
|
||||
|
||||
@@ -305,6 +305,22 @@ describe('file-routes', () => {
|
||||
expect(res.headers['content-type']).toBe('image/png');
|
||||
});
|
||||
|
||||
it('serves workspace SVG as an untrusted attachment instead of inline image/svg+xml', async () => {
|
||||
const content = Buffer.from('<svg><script>alert("xss")</script></svg>');
|
||||
mockedReadFile.mockResolvedValue(content as never);
|
||||
mockedStat.mockResolvedValue({ size: content.length } as never);
|
||||
|
||||
const res = await harness.app.inject({
|
||||
method: 'GET',
|
||||
url: `/api/sessions/${harness.ctx._sessionId}/file-raw?path=malicious.svg`,
|
||||
});
|
||||
|
||||
expect(res.statusCode).toBe(200);
|
||||
expect(res.headers['content-type']).toBe('application/octet-stream');
|
||||
expect(res.headers['content-disposition']).toContain('attachment; filename="malicious.svg"');
|
||||
expect(res.headers['x-content-type-options']).toBe('nosniff');
|
||||
});
|
||||
|
||||
it('rejects path traversal in raw file serving', async () => {
|
||||
mockedRealpathSync.mockReturnValue('/etc/shadow' as never);
|
||||
|
||||
@@ -363,4 +379,63 @@ describe('file-routes', () => {
|
||||
expect(body.success).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
// ========== GET /api/download ==========
|
||||
|
||||
describe('GET /api/download', () => {
|
||||
it('requires a sessionId to scope downloads', async () => {
|
||||
const res = await harness.app.inject({
|
||||
method: 'GET',
|
||||
url: `/api/download?path=${encodeURIComponent('/tmp/test-workdir/report.txt')}`,
|
||||
});
|
||||
|
||||
expect(res.statusCode).toBe(400);
|
||||
});
|
||||
|
||||
it('downloads files scoped to the session working directory', async () => {
|
||||
const content = Buffer.from('download content');
|
||||
mockedReadFile.mockResolvedValue(content as never);
|
||||
mockedStat.mockResolvedValue({ size: content.length, isFile: () => true } as never);
|
||||
|
||||
const res = await harness.app.inject({
|
||||
method: 'GET',
|
||||
url: `/api/download?sessionId=${harness.ctx._sessionId}&path=report.txt`,
|
||||
});
|
||||
|
||||
expect(res.statusCode).toBe(200);
|
||||
expect(res.headers['content-disposition']).toContain('filename="report.txt"');
|
||||
expect(res.body).toBe('download content');
|
||||
});
|
||||
|
||||
it('rejects absolute paths outside the session working directory', async () => {
|
||||
const res = await harness.app.inject({
|
||||
method: 'GET',
|
||||
url: `/api/download?sessionId=${harness.ctx._sessionId}&path=${encodeURIComponent('/var/log/app.log')}`,
|
||||
});
|
||||
|
||||
expect(res.statusCode).toBe(404);
|
||||
});
|
||||
|
||||
it('rejects symlink targets that escape the session working directory', async () => {
|
||||
mockedRealpathSync.mockReturnValue('/tmp/outside-workdir/link.log' as never);
|
||||
|
||||
const res = await harness.app.inject({
|
||||
method: 'GET',
|
||||
url: `/api/download?sessionId=${harness.ctx._sessionId}&path=${encodeURIComponent(
|
||||
'/tmp/test-workdir/link.log'
|
||||
)}`,
|
||||
});
|
||||
|
||||
expect(res.statusCode).toBe(404);
|
||||
});
|
||||
|
||||
it('blocks sensitive files even when they are inside the session working directory', async () => {
|
||||
const res = await harness.app.inject({
|
||||
method: 'GET',
|
||||
url: `/api/download?sessionId=${harness.ctx._sessionId}&path=.env`,
|
||||
});
|
||||
|
||||
expect(res.statusCode).toBe(403);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -32,36 +32,38 @@ const __dirname = dirname(fileURLToPath(import.meta.url));
|
||||
const indexHtmlPath = join(__dirname, '..', 'src', 'web', 'public', 'index.html');
|
||||
const rawTemplate = readFileSync(indexHtmlPath, 'utf-8');
|
||||
|
||||
function render(host?: string): string {
|
||||
const server = new WebServer(0, false, true, host);
|
||||
return (server as unknown as { renderIndexHtml: () => string }).renderIndexHtml();
|
||||
async function render(host?: string): Promise<string> {
|
||||
// 4th arg is the bind host; the title hostname is the 5th arg.
|
||||
const server = new WebServer(0, false, true, '127.0.0.1', host);
|
||||
// renderIndexHtml is async (it reads settings.json for the gesture bundle).
|
||||
return (server as unknown as { renderIndexHtml: () => Promise<string> }).renderIndexHtml();
|
||||
}
|
||||
|
||||
describe('WebServer index.html <title> templating (#82)', () => {
|
||||
it('substitutes the bare <title>Codeman</title> with codeman:<host>', () => {
|
||||
const html = render('laptop');
|
||||
it('substitutes the bare <title>Codeman</title> with codeman:<host>', async () => {
|
||||
const html = await render('laptop');
|
||||
expect(html).toContain('<title>codeman:laptop</title>');
|
||||
expect(html).not.toContain('<title>Codeman</title>');
|
||||
});
|
||||
|
||||
it('defaults to os.hostname() when no titleHostname is supplied', () => {
|
||||
const html = render();
|
||||
it('defaults to os.hostname() when no titleHostname is supplied', async () => {
|
||||
const html = await render();
|
||||
const expected = `<title>codeman:${osHostname()}</title>`;
|
||||
expect(html).toContain(expected);
|
||||
});
|
||||
|
||||
it('treats an empty-string titleHostname as "not supplied" and falls back to os.hostname()', () => {
|
||||
it('treats an empty-string titleHostname as "not supplied" and falls back to os.hostname()', async () => {
|
||||
// CLI normally guarantees a non-empty string, but the constructor's
|
||||
// `titleHostname || getHostname()` guard makes empty fall through —
|
||||
// pin that behavior so a future refactor doesn't accidentally ship
|
||||
// a `<title>codeman:</title>` to users.
|
||||
const html = render('');
|
||||
const html = await render('');
|
||||
expect(html).toMatch(/<title>codeman:.+<\/title>/);
|
||||
expect(html).not.toContain('<title>codeman:</title>');
|
||||
});
|
||||
|
||||
it('HTML-escapes < > & in the hostname so it cannot break out of the title tag', () => {
|
||||
const html = render('<script>alert(1)</script>');
|
||||
it('HTML-escapes < > & in the hostname so it cannot break out of the title tag', async () => {
|
||||
const html = await render('<script>alert(1)</script>');
|
||||
expect(html).toContain('<title>codeman:<script>alert(1)</script></title>');
|
||||
// The raw closing </title> from the injected payload must NOT appear
|
||||
// outside the actual title element — escape-then-substitute prevents
|
||||
@@ -69,16 +71,18 @@ describe('WebServer index.html <title> templating (#82)', () => {
|
||||
expect(html).not.toContain('<script>alert(1)</script></title>');
|
||||
});
|
||||
|
||||
it('escapes an ampersand without double-encoding existing entities', () => {
|
||||
it('escapes an ampersand without double-encoding existing entities', async () => {
|
||||
// The escaper replaces & first, then < and >. A hostname that already
|
||||
// contains a literal `&` should render as `&` once, not `&amp;`.
|
||||
const html = render('a&b');
|
||||
const html = await render('a&b');
|
||||
expect(html).toContain('<title>codeman:a&b</title>');
|
||||
expect(html).not.toContain('&amp;');
|
||||
});
|
||||
|
||||
it('only substitutes the <title> tag — the rest of the template is byte-for-byte identical', () => {
|
||||
const html = render('laptop');
|
||||
it('only substitutes the <title> tag — the rest of the template is identical (modulo asset cache-busting)', async () => {
|
||||
// renderIndexHtml also appends ?v=<mtime> cache-bust params to same-origin
|
||||
// .js/.css refs; strip them so the title remains the only other change.
|
||||
const html = (await render('laptop')).replace(/(\.(?:js|css))\?v=[^"]*/g, '$1');
|
||||
const beforeTitle = rawTemplate.split('<title>Codeman</title>')[0];
|
||||
const afterTitle = rawTemplate.split('<title>Codeman</title>')[1];
|
||||
expect(html.startsWith(beforeTitle)).toBe(true);
|
||||
@@ -88,8 +92,8 @@ describe('WebServer index.html <title> templating (#82)', () => {
|
||||
expect(html.length - rawTemplate.length).toBe(expectedDelta);
|
||||
});
|
||||
|
||||
it('replaces the <title> placeholder exactly once', () => {
|
||||
const html = render('laptop');
|
||||
it('replaces the <title> placeholder exactly once', async () => {
|
||||
const html = await render('laptop');
|
||||
// Defense against a future regression where the template gains a
|
||||
// second `<title>Codeman</title>` (e.g. inside a <noscript>) and only
|
||||
// the first gets templated — would leave a stale literal in the served
|
||||
@@ -100,9 +104,9 @@ describe('WebServer index.html <title> templating (#82)', () => {
|
||||
expect(occurrencesOfOld).toBe(0);
|
||||
});
|
||||
|
||||
it('two WebServer instances on different hostnames render distinct titles', () => {
|
||||
const htmlA = render('host-a');
|
||||
const htmlB = render('host-b');
|
||||
it('two WebServer instances on different hostnames render distinct titles', async () => {
|
||||
const htmlA = await render('host-a');
|
||||
const htmlB = await render('host-b');
|
||||
expect(htmlA).toContain('<title>codeman:host-a</title>');
|
||||
expect(htmlB).toContain('<title>codeman:host-b</title>');
|
||||
expect(htmlA).not.toContain('host-b');
|
||||
|
||||
Reference in New Issue
Block a user