mirror of
https://github.com/Sea-Haven-Industries/sh-mcp.git
synced 2026-09-30 03:03:15 +00:00
Some checks are pending
deploy / deploy (push) Waiting to run
* Add shared transport: dispatch, MCP + OpenAPI adapters, local auth
Add the single authoritative tool-execution path (executeTool) plus the two
universal interfaces over it (design.md §2.5, §7.3):
- dispatch.ts: scope enforcement, ajv input validation, rate limiting, finance
egress redaction (redactDeep), and structured audit emission on one path.
- audit.ts / rate-limit.ts: injected AuditLogger + RateLimiter abstractions.
- mcp.ts: low-level MCP Server with scope-filtered tools/list (tool-hiding) and
tools/call routed through executeTool.
- http.ts: Express host mounting /mcp, /openapi.json, POST /tools/:name, /healthz.
- openapi.ts: buildOpenApiDocument wraps the existing path generator into a full
OpenAPI 3.1 document.
- local-auth.ts: LocalAuthProvider (dev bearer tokens) that refuses to construct
outside SH_MCP_ENV=local and enforces audience binding (design.md §3, §6).
* Add in-memory dev clients; make package tool exports lazy
Add an in-memory Client implementation per integration package (seeded fake
data, no network) selected when SH_MCP_ENV=local (build-plan §4). Gmail/calendar/
tasks dev clients partition by ctx.sub; payments/qbo seed sensitive-looking
fields so the redaction egress path has real targets to mask.
Make the eager default-tool exports in tasks/reminders/qbo LAZY (getDefaultTools)
so importing a package barrel no longer constructs an AWS client at module load
(build-plan §7 'no I/O at import time') — the previous eager construction broke
server startup. Fix payments tsconfig rootDir (src, was '.') so its declarations
resolve under dist/index.d.ts like the other 8 packages.
* Add runnable sh-mcp-ops and sh-mcp-finance servers
Two thin composition-root servers over the shared transport (design.md §3):
- ops: internal-data, knowledge-base, google-maps, gmail, calendar, tasks,
reminders. finance: qbo, payments (audited + redacted on egress).
- config from env only (no hardcoded ids/issuer/tables); SH_MCP_ENV selects
LocalAuthProvider + dev clients (local) vs CognitoAuthProvider + real stubs
(aws). Finance applies the 15-min finance-token TTL ceiling (design.md §2.5).
- index.ts is the only place .listen() is called; a Lambda handler placeholder
is exported but not depended on.
- synth-only CDK stubs (no real IAM/Cognito/WAF) so 'cdk synth' has a valid app
(build-plan §6); READMEs document local run, dev tokens, curl, MCP Inspector.
* Add security-weighted test suite + coverage gate; wire tooling
Add tests for the highest-risk surface (build-plan §5, design.md §7.3):
tool-hiding, server-side scope enforcement (incl. forced hidden calls),
audience binding, input-schema validation, finance redaction on egress, audit
emission with hashed args, prompt-injection regression (tool output is data),
rate limiting, MCP conformance (in-memory transport round-trip), OpenAPI 3.1
validity, and local-auth safety. Add HTTP integration tests (supertest) for both
servers and per-package dev-client tests. 405 tests pass.
Wire the coverage gate into vitest.config.ts: 80% overall, with per-file
thresholds on the auth + dispatch crown jewels; exclude deferred real client
stubs, entrypoints, cdk apps, and aws-only config from the gate (documented).
Extend eslint flat config + add .prettierignore to cover servers/. Commit the
updated package-lock.json.
* Suppress pre-existing dev-tooling + out-of-scope scanner findings
Add written-justification suppressions for the 4 confirmed crit/high pre-push
scanner findings, none of which are in this PR's Phase 1 production code:
- npmaudit vitest / @vitest/coverage-v8 / vite: dev/test-only deps that never
run in the deployed server/Lambda runtime (pins carried from Phase 0b;
Dependabot will bump).
- gitleaks docs/agentforce-plan.md secret: that file is not on this branch and
not in this changeset; flagged for the maintainer to scrub on its own branch.
The deep agentic /sh-security-review (required for this auth/authz-touching PR)
was NOT run by the agent and is flagged outstanding in the PR body.
* Address CodeQL findings: bound ajv error work + edge rate limiting
GHAS code-scanning alerts on this PR:
- dispatch.ts (js/resource-exhaustion): ajv ran with allErrors:true on
untrusted input, letting a crafted payload force unbounded error
enumeration. Switch to allErrors:false (default) so validation
short-circuits on the first failure; the 400 still names that path.
- http.ts (js/missing-rate-limiting): the authenticated routes (/mcp,
/tools/:name) had no edge throttle — auth/JWT verification ran on every
request before the per-sub dispatch limiter could apply. Add an IP-keyed
express-rate-limit in front of authenticate (120/60s default, configurable),
returning the standard 429 shape. Defense-in-depth over the per-sub +
per-tool limiter in executeTool; API GW/WAF remains the production edge.
Tests: +2 cases proving the edge limiter throttles before auth (429, not
401) on /tools and /mcp. 407 pass; tsc/eslint/prettier clean.
* Fix polynomial ReDoS in Bearer-token extraction (CodeQL js/polynomial-redos)
extractBearerToken matched /^Bearer\s+(.+)$/ — \s and . both match a space,
so the two quantifiers overlap and a crafted header can drive polynomial
backtracking. Require the capture to start with a non-whitespace char
(/^Bearer\s+(\S.*)$/), removing the ambiguity → linear match. Behavior is
unchanged for real tokens; +2 regression tests.
* Harden auth + finance redaction (sh-security-review confirmed mediums)
Two confirmed medium findings from the agentic security review:
- Fail-open SH_MCP_ENV: config defaulted to 'local' when the var was unset,
so a deploy that forgot SH_MCP_ENV=aws would silently run LocalAuthProvider
and accept static dev bearer tokens (dev-finance-admin -> finance:admin).
Now fail-closed: SH_MCP_ENV must be explicitly 'local' or 'aws' or the
server refuses to start. Plus an independent guard in LocalAuthProvider
that refuses to construct in an AWS runtime (AWS_LAMBDA_FUNCTION_NAME /
AWS_EXECUTION_ENV present), regardless of the env flag.
- Finance egress redaction gap: redactDeep only wholesale-masked a sensitive
key when its value was a scalar; an object/array under a sensitive key was
recursed into, letting a bare nested value (e.g. {account:{number:...}})
escape the keyword-gated pattern matcher. Now the entire subtree under a
sensitive key is masked. No current finance tool emitted such shapes (all
flat strings), so this closes a latent hole in the universal safety net.
+4 tests (subtree redaction, AWS-runtime guard). 411 pass; coverage gate green.
Review also produced lows (memo free-text digits, unsalted argsHash,
unauth /openapi.json by-design, session-cap no-reset by-design) tracked
separately; 0 confirmed critical/high — review verdict PASS.
194 lines
6.9 KiB
TypeScript
194 lines
6.9 KiB
TypeScript
/**
|
|
* HTTP host — both interfaces over one registry (build-plan §5, design.md §2.5).
|
|
*
|
|
* Drives `createApp` from source via supertest so the Express routing, auth
|
|
* middleware, error mapping, MCP route, and the unauthenticated /healthz +
|
|
* /openapi.json routes are all exercised (and instrumented for coverage).
|
|
*/
|
|
|
|
import { describe, it, expect } from 'vitest';
|
|
import request from 'supertest';
|
|
|
|
import { createApp } from './http.js';
|
|
import { ToolRegistry, defineTool } from './registry.js';
|
|
import { LocalAuthProvider, defaultLocalPrincipals, OPS_AUDIENCE } from './local-auth.js';
|
|
import { NoopAuditLogger } from './audit.js';
|
|
import { InMemoryRateLimiter } from './rate-limit.js';
|
|
import type { DispatchDeps } from './dispatch.js';
|
|
|
|
function build(opts: { edgeRateLimit?: { windowMs: number; limit: number } } = {}) {
|
|
const registry = new ToolRegistry();
|
|
registry.register(
|
|
defineTool<{ id: string }, { id: string; ok: boolean }>({
|
|
name: 'lookup_thing',
|
|
description: 'd',
|
|
tier: 'ops',
|
|
requiredScope: 'ops:read',
|
|
inputSchema: {
|
|
type: 'object',
|
|
required: ['id'],
|
|
properties: { id: { type: 'string' } },
|
|
additionalProperties: false,
|
|
},
|
|
handler: async (input) => ({ id: input.id, ok: true }),
|
|
}),
|
|
);
|
|
registry.register(
|
|
defineTool<{ id: string }, unknown>({
|
|
name: 'boom',
|
|
description: 'always throws',
|
|
tier: 'ops',
|
|
requiredScope: 'ops:read',
|
|
inputSchema: { type: 'object', properties: { id: { type: 'string' } } },
|
|
handler: async () => {
|
|
throw new Error('handler exploded with SENSITIVE detail');
|
|
},
|
|
}),
|
|
);
|
|
registry.register(
|
|
defineTool<{ id: string }, unknown>({
|
|
name: 'gmail_thing',
|
|
description: 'needs gmail',
|
|
tier: 'ops',
|
|
requiredScope: 'gmail:self',
|
|
inputSchema: { type: 'object', properties: { id: { type: 'string' } } },
|
|
handler: async () => ({ ok: true }),
|
|
}),
|
|
);
|
|
|
|
const deps: DispatchDeps = {
|
|
auditLogger: new NoopAuditLogger(),
|
|
rateLimiter: new InMemoryRateLimiter({ sessionCap: 3, perToolLimit: 2, windowMs: 60_000 }),
|
|
};
|
|
|
|
return createApp({
|
|
registry,
|
|
authProvider: new LocalAuthProvider({
|
|
audience: OPS_AUDIENCE,
|
|
principals: defaultLocalPrincipals(),
|
|
env: 'local',
|
|
}),
|
|
deps,
|
|
mcpInfo: { name: 'sh-mcp-test', version: '0.0.1' },
|
|
openApi: { info: { title: 'Test', version: '0.0.1' }, servers: [{ url: 'http://x' }] },
|
|
edgeRateLimit: opts.edgeRateLimit,
|
|
});
|
|
}
|
|
|
|
const auth = (t: string) => ({ Authorization: `Bearer ${t}` });
|
|
|
|
describe('createApp routes', () => {
|
|
it('GET /healthz — unauthenticated', async () => {
|
|
const res = await request(build()).get('/healthz');
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toEqual({ status: 'ok' });
|
|
});
|
|
|
|
it('GET /openapi.json — unauthenticated, valid 3.1', async () => {
|
|
const res = await request(build()).get('/openapi.json');
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.openapi).toBe('3.1.0');
|
|
});
|
|
|
|
it('POST /tools/:name — 401 without a token', async () => {
|
|
const res = await request(build()).post('/tools/lookup_thing').send({ id: 'x' });
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('POST /tools/:name — 200 success', async () => {
|
|
const res = await request(build())
|
|
.post('/tools/lookup_thing')
|
|
.set(auth('dev-ops-only'))
|
|
.send({ id: 'WO-1' });
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toEqual({ id: 'WO-1', ok: true });
|
|
});
|
|
|
|
it('POST /tools/:name — 400 invalid input', async () => {
|
|
const res = await request(build())
|
|
.post('/tools/lookup_thing')
|
|
.set(auth('dev-ops-only'))
|
|
.send({ wrong: true });
|
|
expect(res.status).toBe(400);
|
|
});
|
|
|
|
it('POST /tools/:name — 403 missing scope (server-side, not hiding)', async () => {
|
|
const res = await request(build())
|
|
.post('/tools/gmail_thing')
|
|
.set(auth('dev-ops-only'))
|
|
.send({ id: 'x' });
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.requiredScope).toBe('gmail:self');
|
|
});
|
|
|
|
it('POST /tools/:name — 404 unknown tool', async () => {
|
|
const res = await request(build()).post('/tools/nope').set(auth('dev-ops-only')).send({});
|
|
expect(res.status).toBe(404);
|
|
});
|
|
|
|
it('POST /tools/:name — 500 hides the handler error detail', async () => {
|
|
const res = await request(build())
|
|
.post('/tools/boom')
|
|
.set(auth('dev-ops-only'))
|
|
.send({ id: 'x' });
|
|
expect(res.status).toBe(500);
|
|
expect(JSON.stringify(res.body)).not.toContain('SENSITIVE');
|
|
});
|
|
|
|
it('POST /tools/:name — 429 when the rate limit is exceeded', async () => {
|
|
const app = build();
|
|
await request(app).post('/tools/lookup_thing').set(auth('dev-ops-only')).send({ id: '1' });
|
|
await request(app).post('/tools/lookup_thing').set(auth('dev-ops-only')).send({ id: '2' });
|
|
const res = await request(app)
|
|
.post('/tools/lookup_thing')
|
|
.set(auth('dev-ops-only'))
|
|
.send({ id: '3' });
|
|
expect(res.status).toBe(429);
|
|
});
|
|
|
|
it('edge rate limiter — throttles by IP BEFORE auth (429 on an unauthenticated flood)', async () => {
|
|
// limit 2/window. Unauthenticated requests would normally 401, but the edge
|
|
// limiter sits in front of `authenticate`, so the 3rd request is throttled
|
|
// (429), not 401 — proving floods are capped before any JWT verification.
|
|
const app = build({ edgeRateLimit: { windowMs: 60_000, limit: 2 } });
|
|
expect((await request(app).post('/tools/lookup_thing').send({ id: '1' })).status).toBe(401);
|
|
expect((await request(app).post('/tools/lookup_thing').send({ id: '2' })).status).toBe(401);
|
|
const res = await request(app).post('/tools/lookup_thing').send({ id: '3' });
|
|
expect(res.status).toBe(429);
|
|
expect(res.body).toEqual({ error: 'rate_limited' });
|
|
});
|
|
|
|
it('edge rate limiter — also fronts /mcp', async () => {
|
|
const app = build({ edgeRateLimit: { windowMs: 60_000, limit: 1 } });
|
|
expect((await request(app).post('/mcp').send({})).status).toBe(401);
|
|
const res = await request(app).post('/mcp').send({});
|
|
expect(res.status).toBe(429);
|
|
});
|
|
|
|
it('POST /mcp — 401 without a token', async () => {
|
|
const res = await request(build())
|
|
.post('/mcp')
|
|
.set('Accept', 'application/json, text/event-stream')
|
|
.send({ jsonrpc: '2.0', id: 1, method: 'tools/list', params: {} });
|
|
expect(res.status).toBe(401);
|
|
});
|
|
|
|
it('POST /mcp — initialize handshake succeeds with a token', async () => {
|
|
const res = await request(build())
|
|
.post('/mcp')
|
|
.set(auth('dev-ops-only'))
|
|
.set('Accept', 'application/json, text/event-stream')
|
|
.send({
|
|
jsonrpc: '2.0',
|
|
id: 1,
|
|
method: 'initialize',
|
|
params: {
|
|
protocolVersion: '2025-06-18',
|
|
capabilities: {},
|
|
clientInfo: { name: 'c', version: '0' },
|
|
},
|
|
});
|
|
expect(res.status).toBe(200);
|
|
expect(res.text).toContain('serverInfo');
|
|
});
|
|
});
|