Files
OmniRoute/tests/unit/cli-machine-token.test.ts
desamours-hub d93b24e761 feat(api): add provider quota telemetry, adaptive routing, and status inventory (#10148)
* feat(api): add provider quota telemetry, adaptive routing, and status inventory

Adds a read-only OmniRoute status/inventory surface plus supporting
resilience and usage-tracking infrastructure:

- src/lib/quota/providerQuotaTelemetry.ts, providerCapabilities.ts:
  provider quota state and capability signals, sourced from configured
  metadata rather than invented values; unknown stays unknown.
- src/lib/resilience/adaptiveCircuit.ts, failureClassification.ts:
  circuit state with lazy recovery and explicit failure classification.
- src/lib/usage/usageLedger.ts, budgetGuard.ts, modelPricingRegistry.ts:
  internal usage tracking and budget allow/warn/deny decisions, kept
  separate from upstream-reported quota (never conflated).
- src/lib/routing/adaptiveRouting.ts: excludes exhausted-quota and
  open-circuit candidates from routing, penalizes approaching-limit.
- src/lib/omnirouteStatus.ts + src/app/api/omniroute/status,
  route/preview: read-only status endpoint; never issues a live
  upstream model request (asserted via liveRequestExecuted: false).
- src/lib/db/quotaPools.ts: adds ensurePool() for idempotent pool
  management by automation/CLI callers, following the existing
  group-demo default-group convention.
- scripts/omniroute-verify.mjs (+ omniroute:verify script): local
  verification against the running gateway.

9 new unit tests, all passing. typecheck:core clean relative to base
(release/v3.8.50) -- the 2 pre-existing gateways.ts errors are tracked
separately in #9985 and untouched by this change.

* test(cli): align cli-machine-token assertions with HMAC-SHA256 64-char format

The quota-telemetry feature hardens cliToken to HMAC-SHA256(machineId, SALT)
(64-char hex, pristine machine id). Update the regression test to the new
format and mirror the production derivation in the different-machine-id check.

Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>

---------

Co-authored-by: adevwithpurpose <adevwithpurpose@users.noreply.github.com>
Co-authored-by: desamours-hub <desamours-hub@users.noreply.github.com>
Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>
2026-08-18 11:31:53 -03:00

165 lines
6.9 KiB
TypeScript

import test from "node:test";
import assert from "node:assert/strict";
import crypto from "node:crypto";
import { execFileSync } from "node:child_process";
import { join } from "node:path";
import { fileURLToPath, pathToFileURL } from "node:url";
test("cliToken.mjs pode ser importado sem erro", async () => {
const mod = await import("../../bin/cli/utils/cliToken.mjs");
assert.equal(typeof mod.getCliToken, "function");
assert.equal(typeof mod.CLI_TOKEN_HEADER, "string");
assert.equal(mod.CLI_TOKEN_HEADER, "x-omniroute-cli-token");
});
test("getCliToken retorna string de 64 chars ou string vazia", async () => {
const { getCliToken } = await import("../../bin/cli/utils/cliToken.mjs");
const token = await getCliToken();
assert.ok(typeof token === "string");
// Pode ser "" se node-machine-id falhar, ou 64 chars se funcionar
// (HMAC-SHA256 digest hex — see #10148 cliToken hardening).
assert.ok(token === "" || token.length === 64, `expected 0 or 64 chars, got ${token.length}`);
});
test("getCliToken deriva token de 64 chars sob o node puro que a CLI usa", async () => {
const mod = await import("node-machine-id");
const machineIdSync = mod.machineIdSync ?? mod.default?.machineIdSync;
// Sem machine-id nesta plataforma não há token a derivar — nada a afirmar.
if (typeof machineIdSync !== "function") return;
// Precisa rodar em `node` puro, sem o loader tsx/esm: o tsx resolve os named
// exports de um CJS e mascara o bug de interop. `omniroute` roda sob node puro,
// onde `const { machineIdSync } = await import(...)` dava undefined, o catch
// zerava o token e TODA requisição de management saía sem autenticação.
const repoRoot = fileURLToPath(new URL("../..", import.meta.url));
const entry = pathToFileURL(join(repoRoot, "bin/cli/utils/cliToken.mjs")).href;
const out = execFileSync(
process.execPath,
[
"-e",
`import(${JSON.stringify(entry)}).then(m => m.getCliToken()).then(t => console.log(t.length))`,
],
{ cwd: repoRoot, encoding: "utf8" }
);
// HMAC-SHA256 digest hex = 64 chars (#10148 cliToken hardening).
assert.equal(out.trim(), "64", `expected a derived 64-char token, got length ${out.trim()}`);
});
test("getCliToken retorna mesmo valor em chamadas repetidas (cache)", async () => {
const { getCliToken } = await import("../../bin/cli/utils/cliToken.mjs");
const t1 = await getCliToken();
const t2 = await getCliToken();
assert.equal(t1, t2);
});
test("getCliToken respeita rotação de OMNIROUTE_CLI_SALT", async () => {
const mod = await import("node-machine-id");
const machineIdSync = mod.machineIdSync ?? mod.default?.machineIdSync;
if (typeof machineIdSync !== "function") return;
const { getCliToken } = await import("../../bin/cli/utils/cliToken.mjs");
const original = process.env.OMNIROUTE_CLI_SALT;
try {
delete process.env.OMNIROUTE_CLI_SALT;
const withDefaultSalt = await getCliToken();
process.env.OMNIROUTE_CLI_SALT = "rotated-salt-for-test";
const withRotatedSalt = await getCliToken();
// docs/security/CLI_TOKEN.md promete que a rotação alcança os processos CLI;
// o SALT hardcoded ignorava a env var e devolvia sempre o mesmo token.
assert.notEqual(withRotatedSalt, withDefaultSalt);
// HMAC-SHA256 digest hex = 64 chars (#10148 cliToken hardening).
assert.equal(withRotatedSalt.length, 64);
} finally {
if (original === undefined) delete process.env.OMNIROUTE_CLI_SALT;
else process.env.OMNIROUTE_CLI_SALT = original;
}
});
test("getCliToken produz apenas hex lowercase se não-vazio", async () => {
const { getCliToken } = await import("../../bin/cli/utils/cliToken.mjs");
const token = await getCliToken();
if (token.length > 0) {
// HMAC-SHA256 digest hex = 64 chars (#10148 cliToken hardening).
assert.match(token, /^[0-9a-f]{64}$/);
}
});
test("OMNIROUTE_CLI_TOKEN env sobrescreve token gerado em apiFetch", async () => {
const orig = process.env.OMNIROUTE_CLI_TOKEN;
process.env.OMNIROUTE_CLI_TOKEN = "test-override-token-12345";
try {
// Re-import api.mjs não funciona por cache ESM — validamos apenas que env é lido.
assert.equal(process.env.OMNIROUTE_CLI_TOKEN, "test-override-token-12345");
} finally {
if (orig === undefined) delete process.env.OMNIROUTE_CLI_TOKEN;
else process.env.OMNIROUTE_CLI_TOKEN = orig;
}
});
// --- testes server-side: isLoopback ---
test("isLoopback aceita 127.0.0.1", async () => {
const { isLoopback } = await import("../../src/lib/middleware/cliTokenAuth");
assert.ok(isLoopback("127.0.0.1"));
});
test("isLoopback aceita ::1", async () => {
const { isLoopback } = await import("../../src/lib/middleware/cliTokenAuth");
assert.ok(isLoopback("::1"));
});
test("isLoopback aceita ::ffff:127.0.0.1 (IPv4-mapped)", async () => {
const { isLoopback } = await import("../../src/lib/middleware/cliTokenAuth");
assert.ok(isLoopback("::ffff:127.0.0.1"));
});
test("isLoopback rejeita IP público", async () => {
const { isLoopback } = await import("../../src/lib/middleware/cliTokenAuth");
assert.ok(!isLoopback("192.168.1.100"));
assert.ok(!isLoopback("10.0.0.1"));
assert.ok(!isLoopback("8.8.8.8"));
});
test("token derivado de machine-id diferente produz hash diferente", () => {
const SALT = "omniroute-cli-auth-v1";
// Mirror the production derivation (#10148): HMAC-SHA256(machineId, SALT) hex.
const hash = (mid: string) =>
crypto
.createHmac("sha256", mid)
.update(SALT)
.digest("hex");
const t1 = hash("machine-id-host-A");
const t2 = hash("machine-id-host-B");
assert.notEqual(t1, t2);
assert.match(t1, /^[0-9a-f]{64}$/);
assert.match(t2, /^[0-9a-f]{64}$/);
});
test("OMNIROUTE_DISABLE_CLI_TOKEN desabilita auth (estrutura verificada)", async () => {
const { readFileSync } = await import("node:fs");
const { join, dirname } = await import("node:path");
const { fileURLToPath } = await import("node:url");
const dir = dirname(fileURLToPath(import.meta.url));
const src = readFileSync(join(dir, "../../src/lib/middleware/cliTokenAuth.ts"), "utf8");
assert.ok(src.includes("OMNIROUTE_DISABLE_CLI_TOKEN"));
});
test("cliTokenAuth must NOT derive loopback from the spoofable Host header", async () => {
const { readFileSync } = await import("node:fs");
const { join, dirname } = await import("node:path");
const { fileURLToPath } = await import("node:url");
const dir = dirname(fileURLToPath(import.meta.url));
const src = readFileSync(join(dir, "../../src/lib/middleware/cliTokenAuth.ts"), "utf8");
// Regression guard: a remote caller with a stolen CLI token could send
// Host: 127.0.0.1 if locality came from new URL(request.url).hostname.
assert.ok(
!/isLoopback\(\s*new URL\(request\.url\)\.hostname/.test(src),
"must not call isLoopback(new URL(request.url).hostname)"
);
assert.ok(
src.includes("AUTHZ_HEADER_PEER_LOCALITY"),
"must trust the middleware-stamped locality verdict instead"
);
});