mirror of
https://github.com/Sea-Haven-Industries/sh-mcp.git
synced 2026-09-30 08:53:18 +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.
132 lines
5.2 KiB
TypeScript
132 lines
5.2 KiB
TypeScript
/**
|
|
* Local development AuthProvider.
|
|
*
|
|
* Lets the servers run end-to-end WITHOUT Cognito (design.md §6 phase-1 goal,
|
|
* build-plan §3). It maps a small set of static dev bearer tokens to fully-formed
|
|
* `AuthContext`s so tool-hiding, tiering, audience binding, and finance redaction
|
|
* are all exercisable locally and in tests.
|
|
*
|
|
* SAFETY (build-plan §3, §5 "Local-auth safety"): this provider MUST refuse to
|
|
* construct unless `SH_MCP_ENV === 'local'`, so it can never run in production.
|
|
*
|
|
* It also enforces audience binding the same way the real provider does: a
|
|
* principal whose `aud` does not match this server's configured `audience` is
|
|
* rejected with an `AuthError('client_not_allowed')`, mirroring the Cognito
|
|
* client_id allow-list boundary (design.md §2.5). That keeps the local and AWS
|
|
* paths behaviourally aligned for the audience-binding tests.
|
|
*/
|
|
|
|
import { AuthError, extractBearerToken } from './cognito-auth.js';
|
|
import type { AuthProvider } from './auth.js';
|
|
import type { AuthContext, Scope } from './types.js';
|
|
|
|
/** A dev principal: the identity a dev bearer token resolves to. */
|
|
export interface LocalPrincipal {
|
|
sub: string;
|
|
scopes: Scope[];
|
|
/** Audience this principal's token is "minted" for (e.g. "sh-mcp-ops"). */
|
|
aud: string;
|
|
}
|
|
|
|
export interface LocalAuthConfig {
|
|
/** This server's audience; a principal with a different `aud` is rejected. */
|
|
audience: string;
|
|
/** token → principal map (dev bearer tokens). */
|
|
principals: Record<string, LocalPrincipal>;
|
|
/** The value of `SH_MCP_ENV`; the provider refuses to build unless 'local'. */
|
|
env: string | undefined;
|
|
}
|
|
|
|
/** Resource-server identifiers for the two launch tiers. */
|
|
export const OPS_AUDIENCE = 'sh-mcp-ops';
|
|
export const FINANCE_AUDIENCE = 'sh-mcp-finance';
|
|
|
|
/**
|
|
* Build the default dev-principal map (build-plan §3). Tokens are deliberately
|
|
* obvious dev strings; they grant exactly the scopes named so tests can assert
|
|
* tool-hiding and tiering.
|
|
*
|
|
* Audiences are FIXED to each principal's home tier (NOT auto-set to the server
|
|
* that loads them) so audience binding is demonstrable locally: the same global
|
|
* map is given to both servers, and an ops principal presented to the finance
|
|
* server is rejected because its `aud` is `sh-mcp-ops` (design.md §2.5). Each
|
|
* tier also gets its own admin principal so an admin can reach its own server.
|
|
*/
|
|
export function defaultLocalPrincipals(): Record<string, LocalPrincipal> {
|
|
return {
|
|
'dev-ops-only': {
|
|
sub: 'ops-only@seahavenind.com',
|
|
scopes: ['ops:read', 'ops:tasks'],
|
|
aud: OPS_AUDIENCE,
|
|
},
|
|
'dev-assistant': {
|
|
sub: 'lauren@seahavenind.com',
|
|
scopes: ['ops:read', 'ops:tasks', 'gmail:self', 'calendar:self'],
|
|
aud: OPS_AUDIENCE,
|
|
},
|
|
'dev-ops-admin': {
|
|
sub: 'adam@seahavenind.com',
|
|
scopes: ['ops:read', 'ops:tasks', 'gmail:self', 'calendar:self'],
|
|
aud: OPS_AUDIENCE,
|
|
},
|
|
'dev-finance': {
|
|
sub: 'accounting@seahavenind.com',
|
|
scopes: ['ops:read', 'finance:read'],
|
|
aud: FINANCE_AUDIENCE,
|
|
},
|
|
'dev-finance-admin': {
|
|
sub: 'adam@seahavenind.com',
|
|
scopes: ['ops:read', 'finance:read', 'finance:admin'],
|
|
aud: FINANCE_AUDIENCE,
|
|
},
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Resolves dev bearer tokens to `AuthContext`s. Only constructible in
|
|
* `SH_MCP_ENV=local`.
|
|
*/
|
|
export class LocalAuthProvider implements AuthProvider {
|
|
private readonly principals: Record<string, LocalPrincipal>;
|
|
private readonly audience: string;
|
|
|
|
constructor(config: LocalAuthConfig) {
|
|
if (config.env !== 'local') {
|
|
throw new Error(
|
|
'LocalAuthProvider may only be constructed when SH_MCP_ENV=local ' +
|
|
`(got SH_MCP_ENV=${JSON.stringify(config.env)}). It must never run in production.`,
|
|
);
|
|
}
|
|
// Defense in depth, independent of the env flag: refuse to run in a real AWS
|
|
// runtime. The env check above can be defeated by a misconfiguration that
|
|
// resolves env to 'local' in a deployed context; this positive prod signal
|
|
// (set by Lambda / the AWS runtime) cannot. Static dev tokens must never
|
|
// authenticate anywhere AWS is executing this code.
|
|
if (process.env['AWS_LAMBDA_FUNCTION_NAME'] || process.env['AWS_EXECUTION_ENV']) {
|
|
throw new Error(
|
|
'LocalAuthProvider refuses to run inside an AWS Lambda/execution context ' +
|
|
'(AWS_LAMBDA_FUNCTION_NAME / AWS_EXECUTION_ENV present). Dev auth is local-only.',
|
|
);
|
|
}
|
|
this.audience = config.audience;
|
|
this.principals = config.principals;
|
|
}
|
|
|
|
async authenticate(req: unknown): Promise<AuthContext> {
|
|
const token = extractBearerToken(req); // throws AuthError('missing_token')
|
|
const principal = this.principals[token];
|
|
if (!principal) {
|
|
throw new AuthError('invalid_token', 'Unknown dev bearer token.');
|
|
}
|
|
// Audience binding: an ops principal presented to the finance server (or
|
|
// vice versa) is rejected — same boundary the Cognito client_id allow-list
|
|
// enforces in AWS mode (design.md §2.5).
|
|
if (principal.aud !== this.audience) {
|
|
throw new AuthError(
|
|
'client_not_allowed',
|
|
`Dev principal audience "${principal.aud}" is not permitted for "${this.audience}".`,
|
|
);
|
|
}
|
|
return { sub: principal.sub, scopes: [...principal.scopes], aud: this.audience };
|
|
}
|
|
}
|