Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
name: Clean Install CI
on:
push:
branches: [main, master, develop]
branches: [main, master, develop, feat/**]
pull_request:
branches: [main, master, develop]
jobs:
clean-install:
runs-on: ubuntu-latest
env:
OMNIROUTE_BASE_URL: http://127.0.0.1:20132/v1
steps:
- uses: actions/checkout@v7
- uses: actions/setup-node@v7
Expand Down
29 changes: 29 additions & 0 deletions docs/adr/ADR-001-execution-envelope-enforcement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ADR-021: ExecutionEnvelope Edge Enforcement for Gateway Adapters

- **Status:** Accepted — Implemented in NOD-002
- **Date:** 2026-08-03
- **Scope:** Cross-language contract enforcement between Verdict Core and Verdict Node (`@bodanglin/verdict-node`)

## Context

Verdict Core is the authoritative policy-gated execution control plane. To ensure that transport middleware (such as `verdict-node`) cannot execute requests outside Core-authorized boundaries, edge adapters must enforce canonical `ExecutionEnvelope` constraints before forwarding requests upstream.

## Decision

We establish edge-level `ExecutionEnvelope` validation rules in Verdict Node (`src/middleware/forwarder.ts`):

1. **Pre-Forward Validation:** Edge middleware MUST validate the presence, schema version (`1`), expiration time, and policy digest of an incoming `ExecutionEnvelope` before initiating any HTTP/SSE forwarding.
2. **Fail-Closed Policy Enforcement:**
- Missing or unparseable envelopes fail closed with `envelope_missing` / `envelope_invalid` (HTTP 403).
- Expired envelopes fail closed with `envelope_expired` (HTTP 403).
- Policy digest mismatches fail closed with `envelope_tampered` (HTTP 403).
- Requests specifying models outside `execution_constraints.allowed_models` fail closed with `model_disallowed` (HTTP 403).
- Requests invoking tools outside `execution_constraints.allowed_tools` fail closed with `tool_disallowed` (HTTP 403).
- Requests exceeding `execution_constraints.budget_usd` or `max_request_usd` fail closed with `budget_exceeded` (HTTP 403).
3. **Parity Assurance:** The TypeScript middleware consumes canonical `@bodanglin/verdict-contracts` definitions and does not re-implement eligibility or policy evaluation.

## Consequences

- Edge gateway adapters guarantee that no un-authorized, expired, or out-of-bounds requests reach upstream model providers.
- Enforcement is applied uniformly to both non-streaming (JSON) and streaming (SSE) request flows.
- All denial responses return standardized, machine-readable `EnvelopeDenialCode` payloads.
6 changes: 5 additions & 1 deletion jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@ module.exports = {
testMatch: ['**/*.test.ts'],
moduleFileExtensions: ['ts', 'js', 'json', 'node'],
transform: {
'^.+\\.ts$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.test.json' }],
'^.+\\.(ts|js)$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.test.json' }],
},
moduleNameMapper: {
'^@bodanglin/verdict-contracts$': '<rootDir>/node_modules/@bodanglin/verdict-contracts',
},
transformIgnorePatterns: ['/node_modules/(?!@bodanglin/verdict-contracts)'],
collectCoverageFrom: ['src/**/*.ts', '!src/**/*.d.ts', '!src/**/*.test.ts'],
coverageDirectory: 'coverage',
verbose: true,
Expand Down
7 changes: 7 additions & 0 deletions scripts/verify-package.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,14 @@ try {
'--eval',
`const root = await import(${JSON.stringify(packageName)});
const middleware = await import(${JSON.stringify(`${packageName}/middleware`)});
const contracts = await import('@bodanglin/verdict-contracts');
if (typeof root.LlmGateNode !== 'function' || typeof middleware.validate !== 'function') {
throw new Error('package exports are incomplete');
}
const fallback = contracts.contractSchemas.routing_decision.safeParse({ selected_route: {} });
const unknown = contracts.contractSchemas.routing_decision.safeParse({ selected_route: {}, unexpected: true });
if (!fallback.success || unknown.success) {
throw new Error('canonical routing contract strictness changed');
}`,
],
{ cwd: consumerDirectory }
Expand Down Expand Up @@ -155,6 +161,7 @@ void validate;
try {
run(tsc, ['--project', join(consumerDirectory, 'tsconfig.json')], {
cwd: consumerDirectory,
env: { ...process.env, NODE_OPTIONS: '--max-old-space-size=4096' },
});
} catch (error) {
throw new Error(
Expand Down
150 changes: 141 additions & 9 deletions src/middleware/forwarder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,50 @@ type FetchResponse = Response;
// Configuration Types
// ============================================================================

export interface ExecutionEnvelope {
schema_version: '1';
policy_digest: string;
execution_constraints?: {
allowed_models?: string[];
allowed_tools?: string[];
budget_usd?: number;
max_request_usd?: number;
[key: string]: unknown;
};
expires_at?: string;
[key: string]: unknown;
}

export type EnvelopeDenialCode =
| 'envelope_missing'
| 'envelope_invalid'
| 'envelope_expired'
| 'envelope_tampered'
| 'model_disallowed'
| 'tool_disallowed'
| 'budget_exceeded';

export class ExecutionEnvelopeError extends Error {
readonly code: EnvelopeDenialCode;

constructor(code: EnvelopeDenialCode, message: string) {
super(message);
this.name = 'ExecutionEnvelopeError';
this.code = code;
}
}

export interface ForwarderConfig {
/** Upstream base URL (e.g., 'http://localhost:20132/v1') */
baseUrl: string;
/** API key for upstream authentication */
apiKey?: string;
/** Optional Core-authorized envelope. Required when enforcement is enabled. */
executionEnvelope?: unknown;
/** Enforce the Core envelope before forwarding. */
requireExecutionEnvelope?: boolean;
/** Optional expected policy digest for tamper detection. */
expectedPolicyDigest?: string;
/** Request timeout in milliseconds (default: 60000) */
timeoutMs?: number;
/** Maximum number of retries for retryable errors (default: 3) */
Expand All @@ -53,6 +92,77 @@ export interface ForwarderConfig {
onError?: (error: UpstreamError, req: Request, res: ExpressResponse) => void;
}

export function enforceExecutionEnvelope(
envelope: unknown,
request: { model: string; tools?: Array<{ function?: { name?: string } }> },
options: { expectedPolicyDigest?: string; estimatedCostUsd?: number; required?: boolean } = {}
): void {
if (!envelope && !options.required) return;
if (!envelope || typeof envelope !== 'object' || Array.isArray(envelope)) {
throw new ExecutionEnvelopeError('envelope_missing', 'Core execution envelope is required');
}
const candidate = envelope as Record<string, unknown>;
if (candidate.schema_version !== '1' || typeof candidate.policy_digest !== 'string') {
throw new ExecutionEnvelopeError('envelope_invalid', 'Core execution envelope is invalid');
}
if (
options.expectedPolicyDigest !== undefined &&
candidate.policy_digest !== options.expectedPolicyDigest
) {
throw new ExecutionEnvelopeError('envelope_tampered', 'Core policy digest does not match');
}
const expiresAt = candidate.expires_at;
if (
typeof expiresAt === 'string' &&
(!Number.isFinite(Date.parse(expiresAt)) || Date.parse(expiresAt) <= Date.now())
) {
throw new ExecutionEnvelopeError('envelope_expired', 'Core execution envelope has expired');
}
const constraints = candidate.execution_constraints;
if (!constraints || typeof constraints !== 'object' || Array.isArray(constraints)) return;
const bounded = constraints as Record<string, unknown>;
const allowedModels = bounded.allowed_models;
if (
Array.isArray(allowedModels) &&
allowedModels.every(item => typeof item === 'string') &&
!allowedModels.includes(request.model)
) {
throw new ExecutionEnvelopeError(
'model_disallowed',
'Requested model is outside the Core envelope'
);
}
const requestTools = (request.tools ?? [])
.map(tool => tool.function?.name)
.filter((name): name is string => typeof name === 'string');
const allowedTools = bounded.allowed_tools;
if (
Array.isArray(allowedTools) &&
allowedTools.every(item => typeof item === 'string') &&
requestTools.some(name => !allowedTools.includes(name))
) {
throw new ExecutionEnvelopeError(
'tool_disallowed',
'Requested tool is outside the Core envelope'
);
}
const maxCost = bounded.max_request_usd ?? bounded.budget_usd;
if (
typeof maxCost === 'number' &&
typeof options.estimatedCostUsd === 'number' &&
options.estimatedCostUsd > maxCost
) {
throw new ExecutionEnvelopeError('budget_exceeded', 'Request exceeds the Core envelope budget');
}
}

export function createEnvelopeDenial(error: ExecutionEnvelopeError): {
error: string;
code: EnvelopeDenialCode;
} {
return { error: error.message, code: error.code };
}

export interface UsageInfo {
promptTokens: number;
completionTokens: number;
Expand Down Expand Up @@ -311,9 +421,19 @@ const HOP_BY_HOP_HEADERS = new Set([
// Default Configuration
// ============================================================================

const DEFAULT_CONFIG: Required<ForwarderConfig> = {
const DEFAULT_CONFIG: Omit<
Required<ForwarderConfig>,
'executionEnvelope' | 'requireExecutionEnvelope' | 'expectedPolicyDigest'
> & {
executionEnvelope?: unknown;
requireExecutionEnvelope?: boolean;
expectedPolicyDigest?: string;
} = {
baseUrl: '',
apiKey: '',
executionEnvelope: undefined,
requireExecutionEnvelope: false,
expectedPolicyDigest: undefined,
timeoutMs: 60000,
maxRetries: 3,
retryDelayMs: 1000,
Expand Down Expand Up @@ -359,10 +479,7 @@ function calculateRetryDelay(attempt: number, baseDelay: number): number {
return Math.min(delay + jitter, 30000); // Cap at 30 seconds
}

function buildUpstreamHeaders(
req: Request,
config: Required<ForwarderConfig>
): Record<string, string> {
function buildUpstreamHeaders(req: Request, config: ForwarderConfig): Record<string, string> {
const headers: Record<string, string> = {
'Content-Type': 'application/json',
};
Expand All @@ -375,7 +492,7 @@ function buildUpstreamHeaders(
}

// Forward allowed headers
for (const header of config.forwardHeaders) {
for (const header of config.forwardHeaders ?? DEFAULT_CONFIG.forwardHeaders) {
const value = req.headers[header.toLowerCase()];
if (value) {
headers[header] = Array.isArray(value) ? value[0] : value;
Expand All @@ -387,7 +504,7 @@ function buildUpstreamHeaders(

function filterResponseHeaders(
upstreamHeaders: Headers,
config: Required<ForwarderConfig>
config: ForwarderConfig
): Record<string, string> {
const filtered: Record<string, string> = {};

Expand All @@ -396,7 +513,10 @@ function filterResponseHeaders(
// Strip hop-by-hop headers
if (HOP_BY_HOP_HEADERS.has(lowerKey)) return;
// Strip configured headers
if (config.stripHeaders.some(h => h.toLowerCase() === lowerKey)) return;
if (
(config.stripHeaders ?? DEFAULT_CONFIG.stripHeaders).some(h => h.toLowerCase() === lowerKey)
)
return;
filtered[key] = value;
});

Expand All @@ -417,7 +537,7 @@ function createAbortController(timeoutMs: number): {
// ============================================================================

export class Forwarder {
private config: Required<ForwarderConfig>;
private config: ForwarderConfig & typeof DEFAULT_CONFIG;
private usageCache: Map<string, UsageInfo> = new Map();

constructor(config: ForwarderConfig) {
Expand Down Expand Up @@ -450,6 +570,18 @@ export class Forwarder {
}

const requestBody = parsedRequest.data;
try {
enforceExecutionEnvelope(this.config.executionEnvelope, requestBody, {
expectedPolicyDigest: this.config.expectedPolicyDigest,
required: this.config.requireExecutionEnvelope,
});
} catch (error) {
if (error instanceof ExecutionEnvelopeError) {
res.status(403).json(createEnvelopeDenial(error));
return;
}
throw error;
}
const isStream = requestBody.stream === true;
const model = requestBody.model;

Expand Down
Loading