mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-07-31 20:32:20 +03:00
* fix(dashboard): allow anonymous WS handshake + public /api/health/ping
The live-dashboard WebSocket descriptor handshake (GET /api/v1/ws?handshake=1)
and the lightweight GET /api/health/ping liveness probe both 401'd for
unauthenticated callers, even though both are metadata-only reads intended
to be public. clientApiPolicy required a bearer/dashboard-session before the
WS route handler could even return its own wsAuth/protocol descriptor, and
/api/health/ping was never added to PUBLIC_READONLY_API_ROUTE_PREFIXES
despite its own docstring documenting it as "No auth required".
clientApiPolicy.evaluate() now allows an anonymous
{kind:"anonymous", id:"ws-handshake"} subject for GET/HEAD/OPTIONS on
/api/v1/ws?handshake=1 — the route handler still performs its own real
wsAuth/dashboard/API-key decision before opening the socket — and
/api/health/ping is now in PUBLIC_READONLY_API_ROUTE_PREFIXES.
Re-scoped from the original PR per review-group-prs analysis: the
overlapping hardcoded /live-ws path-derivation change (useLiveDashboard.ts,
ws/route.ts) is dropped here since it conflicts with #6072's different
(dynamic, env-derived) approach to the same problem; only the
non-overlapping auth-policy win ships in this PR.
Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>
* chore(changelog): resync CHANGELOG.md after merging release/v3.8.47
Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>
---------
Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>
Co-authored-by: Diego Rodrigues de Sa e Souza <diegosouza.pw@gmail.com>
Co-authored-by: JxnLexn <JxnLexn@users.noreply.github.com>
253 lines
8.6 KiB
TypeScript
253 lines
8.6 KiB
TypeScript
import test from "node:test";
|
|
import assert from "node:assert/strict";
|
|
import fs from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { SignJWT } from "jose";
|
|
|
|
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omr-clientapi-policy-"));
|
|
process.env.DATA_DIR = TEST_DATA_DIR;
|
|
process.env.API_KEY_SECRET = "test-secret";
|
|
|
|
const apiKeysDb = await import("../../../src/lib/db/apiKeys.ts");
|
|
const featureFlagsDb = await import("../../../src/lib/db/featureFlags.ts");
|
|
const core = await import("../../../src/lib/db/core.ts");
|
|
|
|
const ORIGINAL_OMNIROUTE_API_KEY = process.env.OMNIROUTE_API_KEY;
|
|
const ORIGINAL_ROUTER_API_KEY = process.env.ROUTER_API_KEY;
|
|
const ORIGINAL_JWT_SECRET = process.env.JWT_SECRET;
|
|
const ORIGINAL_REQUIRE_API_KEY = process.env.REQUIRE_API_KEY;
|
|
|
|
function resetStorage() {
|
|
core.resetDbInstance();
|
|
apiKeysDb.resetApiKeyState();
|
|
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
|
|
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
|
|
delete process.env.OMNIROUTE_API_KEY;
|
|
delete process.env.ROUTER_API_KEY;
|
|
delete process.env.JWT_SECRET;
|
|
process.env.REQUIRE_API_KEY = "true";
|
|
}
|
|
|
|
test.beforeEach(() => {
|
|
resetStorage();
|
|
});
|
|
|
|
test.after(() => {
|
|
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
|
|
if (ORIGINAL_OMNIROUTE_API_KEY === undefined) delete process.env.OMNIROUTE_API_KEY;
|
|
else process.env.OMNIROUTE_API_KEY = ORIGINAL_OMNIROUTE_API_KEY;
|
|
if (ORIGINAL_ROUTER_API_KEY === undefined) delete process.env.ROUTER_API_KEY;
|
|
else process.env.ROUTER_API_KEY = ORIGINAL_ROUTER_API_KEY;
|
|
if (ORIGINAL_JWT_SECRET === undefined) delete process.env.JWT_SECRET;
|
|
else process.env.JWT_SECRET = ORIGINAL_JWT_SECRET;
|
|
if (ORIGINAL_REQUIRE_API_KEY === undefined) delete process.env.REQUIRE_API_KEY;
|
|
else process.env.REQUIRE_API_KEY = ORIGINAL_REQUIRE_API_KEY;
|
|
});
|
|
|
|
async function loadPolicy() {
|
|
const mod = await import(`../../../src/server/authz/policies/clientApi.ts?ts=${Date.now()}`);
|
|
return mod.clientApiPolicy;
|
|
}
|
|
|
|
function ctx(headers: Headers, method = "POST", normalizedPath = "/api/v1/chat/completions") {
|
|
const pathOnly = normalizedPath.split("?")[0];
|
|
return {
|
|
request: { method, headers, url: `http://localhost${normalizedPath}` },
|
|
classification: {
|
|
routeClass: "CLIENT_API" as const,
|
|
reason: "client_api_v1" as const,
|
|
normalizedPath: pathOnly,
|
|
},
|
|
requestId: "req_test",
|
|
};
|
|
}
|
|
|
|
function relativeUrlCtx(
|
|
headers: Headers,
|
|
method = "POST",
|
|
normalizedPath = "/api/v1/chat/completions"
|
|
) {
|
|
const pathOnly = normalizedPath.split("?")[0];
|
|
return {
|
|
request: { method, headers, url: normalizedPath },
|
|
classification: {
|
|
routeClass: "CLIENT_API" as const,
|
|
reason: "client_api_v1" as const,
|
|
normalizedPath: pathOnly,
|
|
},
|
|
requestId: "req_test",
|
|
};
|
|
}
|
|
|
|
async function dashboardCookie(): Promise<string> {
|
|
process.env.JWT_SECRET = "client-api-dashboard-jwt-secret";
|
|
const secret = new TextEncoder().encode(process.env.JWT_SECRET);
|
|
const token = await new SignJWT({ authenticated: true })
|
|
.setProtectedHeader({ alg: "HS256" })
|
|
.setExpirationTime("1h")
|
|
.sign(secret);
|
|
return `auth_token=${token}`;
|
|
}
|
|
|
|
test("clientApiPolicy: missing bearer is rejected with 401", async () => {
|
|
const policy = await loadPolicy();
|
|
const out = await policy.evaluate(ctx(new Headers()));
|
|
assert.equal(out.allow, false);
|
|
if (!out.allow) {
|
|
assert.equal(out.status, 401);
|
|
assert.equal(out.code, "AUTH_002");
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: websocket descriptor handshake can reach the route handler", async () => {
|
|
const policy = await loadPolicy();
|
|
const out = await policy.evaluate(ctx(new Headers(), "GET", "/api/v1/ws?handshake=1"));
|
|
|
|
assert.equal(out.allow, true);
|
|
if (out.allow) {
|
|
assert.equal(out.subject.kind, "anonymous");
|
|
assert.equal(out.subject.id, "ws-handshake");
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: websocket descriptor handshake accepts relative request URLs", async () => {
|
|
const policy = await loadPolicy();
|
|
const out = await policy.evaluate(relativeUrlCtx(new Headers(), "GET", "/api/v1/ws?handshake=1"));
|
|
|
|
assert.equal(out.allow, true);
|
|
if (out.allow) {
|
|
assert.equal(out.subject.kind, "anonymous");
|
|
assert.equal(out.subject.id, "ws-handshake");
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: REQUIRE_API_KEY DB feature flag override rejects anonymous", async () => {
|
|
process.env.REQUIRE_API_KEY = "false";
|
|
featureFlagsDb.setFeatureFlagOverride("REQUIRE_API_KEY", "true");
|
|
|
|
const policy = await loadPolicy();
|
|
const out = await policy.evaluate(ctx(new Headers()));
|
|
assert.equal(out.allow, false);
|
|
if (!out.allow) {
|
|
assert.equal(out.status, 401);
|
|
assert.equal(out.code, "AUTH_002");
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: REQUIRE_API_KEY DB feature flag override can disable env requirement", async () => {
|
|
process.env.REQUIRE_API_KEY = "true";
|
|
featureFlagsDb.setFeatureFlagOverride("REQUIRE_API_KEY", "false");
|
|
|
|
const policy = await loadPolicy();
|
|
const out = await policy.evaluate(ctx(new Headers()));
|
|
assert.equal(out.allow, true);
|
|
if (out.allow) {
|
|
assert.equal(out.subject.kind, "anonymous");
|
|
assert.equal(out.subject.id, "local");
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: dashboard session can read the model catalog without bearer", async () => {
|
|
const policy = await loadPolicy();
|
|
const out = await policy.evaluate(
|
|
ctx(new Headers({ cookie: await dashboardCookie() }), "GET", "/api/v1/models")
|
|
);
|
|
|
|
assert.equal(out.allow, true);
|
|
if (out.allow) {
|
|
assert.equal(out.subject.kind, "dashboard_session");
|
|
assert.equal(out.subject.id, "dashboard");
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: dashboard session is accepted for client API routes without bearer", async () => {
|
|
const policy = await loadPolicy();
|
|
const out = await policy.evaluate(
|
|
ctx(new Headers({ cookie: await dashboardCookie() }), "POST", "/api/v1/chat/completions")
|
|
);
|
|
|
|
assert.equal(out.allow, true);
|
|
if (out.allow) {
|
|
assert.equal(out.subject.kind, "dashboard_session");
|
|
assert.equal(out.subject.id, "dashboard");
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: invalid bearer is rejected with 401", async () => {
|
|
const policy = await loadPolicy();
|
|
const headers = new Headers({ authorization: "Bearer sk-totally-bogus" });
|
|
const out = await policy.evaluate(ctx(headers));
|
|
assert.equal(out.allow, false);
|
|
if (!out.allow) {
|
|
assert.equal(out.status, 401);
|
|
assert.equal(out.code, "AUTH_002");
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: valid bearer is accepted as client_api_key subject", async () => {
|
|
const created = await apiKeysDb.createApiKey("policy-test-key", "machine-test-1234");
|
|
assert.ok(created?.key, "createApiKey must return a key");
|
|
|
|
const policy = await loadPolicy();
|
|
const headers = new Headers({ authorization: `Bearer ${created.key}` });
|
|
const out = await policy.evaluate(ctx(headers));
|
|
assert.equal(out.allow, true);
|
|
if (out.allow) {
|
|
assert.equal(out.subject.kind, "client_api_key");
|
|
assert.match(out.subject.id, /^key_/);
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: revoked bearer is rejected", async () => {
|
|
const created = await apiKeysDb.createApiKey("policy-revoked-key", "machine-revoked");
|
|
assert.ok(await apiKeysDb.revokeApiKey(created.id));
|
|
|
|
const policy = await loadPolicy();
|
|
const headers = new Headers({ authorization: `Bearer ${created.key}` });
|
|
const out = await policy.evaluate(ctx(headers));
|
|
assert.equal(out.allow, false);
|
|
});
|
|
|
|
test("clientApiPolicy: environment API key remains accepted for client API routes", async () => {
|
|
process.env.OMNIROUTE_API_KEY = "sk-env-policy-test";
|
|
|
|
const policy = await loadPolicy();
|
|
const out = await policy.evaluate(
|
|
ctx(new Headers({ authorization: "Bearer sk-env-policy-test" }))
|
|
);
|
|
|
|
assert.equal(out.allow, true);
|
|
if (out.allow) {
|
|
assert.equal(out.subject.kind, "client_api_key");
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: x-api-key header is accepted as client_api_key subject", async () => {
|
|
const created = await apiKeysDb.createApiKey("policy-test-xkey", "machine-xkey-1234");
|
|
assert.ok(created?.key, "createApiKey must return a key");
|
|
|
|
const policy = await loadPolicy();
|
|
const headers = new Headers({ "x-api-key": created.key });
|
|
const out = await policy.evaluate(ctx(headers));
|
|
assert.equal(out.allow, true);
|
|
if (out.allow) {
|
|
assert.equal(out.subject.kind, "client_api_key");
|
|
assert.match(out.subject.id, /^key_/);
|
|
}
|
|
});
|
|
|
|
test("clientApiPolicy: ROUTER_API_KEY remains accepted for client API routes", async () => {
|
|
process.env.ROUTER_API_KEY = "sk-router-policy-test";
|
|
|
|
const policy = await loadPolicy();
|
|
const out = await policy.evaluate(
|
|
ctx(new Headers({ authorization: "Bearer sk-router-policy-test" }))
|
|
);
|
|
|
|
assert.equal(out.allow, true);
|
|
if (out.allow) {
|
|
assert.equal(out.subject.kind, "client_api_key");
|
|
}
|
|
});
|