skybridge 0.0.0-dev.a05e8da → 0.0.0-dev.a08278b
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -14
- package/dist/cli/run-plain.js +2 -1
- package/dist/cli/run-plain.js.map +1 -1
- package/dist/cli/telemetry.js +2 -0
- package/dist/cli/telemetry.js.map +1 -1
- package/dist/cli/use-nodemon.d.ts +11 -1
- package/dist/cli/use-nodemon.js +19 -5
- package/dist/cli/use-nodemon.js.map +1 -1
- package/dist/commands/dev.js +3 -3
- package/dist/commands/dev.js.map +1 -1
- package/dist/server/auth/providers/custom.d.ts +5 -3
- package/dist/server/auth/providers/custom.js +1 -1
- package/dist/server/auth/providers/custom.js.map +1 -1
- package/dist/server/auth/providers/workos.d.ts +3 -2
- package/dist/server/auth/providers/workos.js +2 -1
- package/dist/server/auth/providers/workos.js.map +1 -1
- package/dist/server/auth/verify.d.ts +5 -3
- package/dist/server/auth/verify.js.map +1 -1
- package/dist/server/auth/verify.test.js +16 -0
- package/dist/server/auth/verify.test.js.map +1 -1
- package/dist/server/auth.d.ts +3 -3
- package/dist/server/auth.js +1 -1
- package/dist/server/auth.js.map +1 -1
- package/dist/server/events.d.ts +113 -0
- package/dist/server/events.js +318 -0
- package/dist/server/events.js.map +1 -0
- package/dist/server/events.test.d.ts +1 -0
- package/dist/server/events.test.js +172 -0
- package/dist/server/events.test.js.map +1 -0
- package/dist/server/index.d.ts +3 -2
- package/dist/server/index.js +2 -1
- package/dist/server/index.js.map +1 -1
- package/dist/server/register-tool.test.js +83 -0
- package/dist/server/register-tool.test.js.map +1 -1
- package/dist/server/server.d.ts +153 -9
- package/dist/server/server.js +121 -8
- package/dist/server/server.js.map +1 -1
- package/dist/web/bridges/adaptor.d.ts +8 -3
- package/dist/web/bridges/adaptor.js +83 -13
- package/dist/web/bridges/adaptor.js.map +1 -1
- package/dist/web/bridges/adaptor.test.js +45 -6
- package/dist/web/bridges/adaptor.test.js.map +1 -1
- package/dist/web/bridges/apps-sdk/bridge.js +1 -1
- package/dist/web/bridges/apps-sdk/bridge.js.map +1 -1
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.d.ts +3 -3
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js +3 -3
- package/dist/web/bridges/apps-sdk/use-apps-sdk-context.js.map +1 -1
- package/dist/web/bridges/mcp-app/bridge.d.ts +1 -1
- package/dist/web/bridges/mcp-app/bridge.js +9 -2
- package/dist/web/bridges/mcp-app/bridge.js.map +1 -1
- package/dist/web/bridges/mcp-app/types.d.ts +18 -3
- package/dist/web/bridges/mcp-app/types.js.map +1 -1
- package/dist/web/bridges/mcp-app/use-mcp-app-context.d.ts +2 -2
- package/dist/web/bridges/mcp-app/use-mcp-app-context.js +1 -1
- package/dist/web/bridges/mcp-app/use-mcp-app-context.js.map +1 -1
- package/dist/web/bridges/types.d.ts +30 -4
- package/dist/web/bridges/types.js +1 -1
- package/dist/web/bridges/types.js.map +1 -1
- package/dist/web/data-llm.js +3 -2
- package/dist/web/data-llm.js.map +1 -1
- package/dist/web/data-llm.test.js +6 -0
- package/dist/web/data-llm.test.js.map +1 -1
- package/dist/web/generate-helpers.d.ts +2 -2
- package/dist/web/generate-helpers.js +2 -2
- package/dist/web/generate-helpers.js.map +1 -1
- package/dist/web/hooks/index.d.ts +4 -1
- package/dist/web/hooks/index.js +4 -1
- package/dist/web/hooks/index.js.map +1 -1
- package/dist/web/hooks/openai-extensions.test.d.ts +1 -0
- package/dist/web/hooks/openai-extensions.test.js +107 -0
- package/dist/web/hooks/openai-extensions.test.js.map +1 -0
- package/dist/web/hooks/use-call-tool.d.ts +2 -2
- package/dist/web/hooks/use-call-tool.js +15 -10
- package/dist/web/hooks/use-call-tool.js.map +1 -1
- package/dist/web/hooks/use-call-tool.test.js +13 -2
- package/dist/web/hooks/use-call-tool.test.js.map +1 -1
- package/dist/web/hooks/use-deep-link.d.ts +22 -0
- package/dist/web/hooks/use-deep-link.js +34 -0
- package/dist/web/hooks/use-deep-link.js.map +1 -0
- package/dist/web/hooks/use-host.d.ts +27 -5
- package/dist/web/hooks/use-host.js +20 -5
- package/dist/web/hooks/use-host.js.map +1 -1
- package/dist/web/hooks/use-model-context.d.ts +44 -0
- package/dist/web/hooks/use-model-context.js +63 -0
- package/dist/web/hooks/use-model-context.js.map +1 -0
- package/dist/web/hooks/use-open-file.d.ts +20 -0
- package/dist/web/hooks/use-open-file.js +25 -0
- package/dist/web/hooks/use-open-file.js.map +1 -0
- package/dist/web/hooks/use-register-view-tool.d.ts +1 -1
- package/dist/web/hooks/use-register-view-tool.js +1 -1
- package/dist/web/hooks/use-register-view-tool.js.map +1 -1
- package/dist/web/hooks/use-send-follow-up-message.d.ts +8 -2
- package/dist/web/hooks/use-send-follow-up-message.js +6 -0
- package/dist/web/hooks/use-send-follow-up-message.js.map +1 -1
- package/package.json +8 -6
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"verify.js","sourceRoot":"","sources":["../../../src/server/auth/verify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"verify.js","sourceRoot":"","sources":["../../../src/server/auth/verify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAuC7B;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,kBAAkB,CAChC,MAAwB;IAExB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,OAAO,GACX,MAAM,CAAC,OAAO;QACd,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,wBAAwB,CAAC;IAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IAEvD,OAAO;QACL,KAAK,CAAC,iBAAiB,CACrB,KAAa;YAEb,IAAI,OAAwB,CAAC;YAC7B,IAAI,CAAC;gBACH,CAAC,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE;oBAC/C,MAAM,EAAE,MAAM,CAAC,MAAM;oBACrB,yDAAyD;oBACzD,GAAG,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;iBACpE,CAAC,CAAC,CAAC;YACN,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACjE,+DAA+D;gBAC/D,6DAA6D;gBAC7D,oEAAoE;gBACpE,gEAAgE;gBAChE,qEAAqE;gBACrE,sEAAsE;gBACtE,iCAAiC;gBACjC,MAAM,IAAI,GAAG,OAAO;qBACjB,OAAO,CAAC,kCAAkC,EAAE,GAAG,CAAC;qBAChD,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,UAAU,CAClB,eAAe,EACf,8BAA8B,IAAI,EAAE,CACrC,CAAC;YACJ,CAAC;YAED,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,OAQ/C,CAAC;YAEF,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBACjC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC;gBACnB,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ;oBACzB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;oBACpC,CAAC,CAAC,EAAE,CAAC;YAET,OAAO;gBACL,KAAK;gBACL,QAAQ,EAAE,SAAS,IAAI,EAAE;gBACzB,MAAM;gBACN,SAAS,EAAE,GAAG;gBACd,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,IAAI,EACZ;aACnB,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { OAuthError } from \"@modelcontextprotocol/server\";\nimport * as jose from \"jose\";\nimport type { AuthInfo, ExtraClaims, TokenVerifier } from \"../auth.js\";\n\nexport type JwksVerifyConfig = {\n /** Expected `iss` claim. */\n issuer: string;\n /** Expected `aud` claim, or several: a token passes when its `aud` matches\n * any of them, for a server reached at more than one URL (a local port and a\n * dev tunnel). Omit to skip audience verification — for IdPs that don't bind\n * an audience to their access tokens (e.g. Clerk). */\n audience?: string | string[];\n /** Defaults to `${issuer}/.well-known/jwks.json`. */\n jwksUri?: string;\n};\n\n/**\n * Claims a JWKS-verified token always carries into `extra`, whatever the IdP:\n * `subject` (the renamed `sub`) plus the registered claims that survive the\n * mapping. `client_id`, `scope` and `exp` do not appear here, since they become\n * `AuthInfo` fields instead. Intersected into every claim shape a JWKS verifier\n * resolves.\n *\n * @see https://datatracker.ietf.org/doc/html/rfc7519#section-4.1\n */\nexport type RegisteredClaims = {\n /** The token's `sub`, renamed on the way into `extra`. */\n subject?: string;\n /** Issuer of the token. */\n iss?: string;\n /** Audience the token was minted for. */\n aud?: string | string[];\n /** Issued-at, in unix seconds. */\n iat?: number;\n /** Not-valid-before, in unix seconds. */\n nbf?: number;\n /** Unique token id. */\n jti?: string;\n};\n\n/**\n * Builds a {@link TokenVerifier} that validates JWTs against a remote JWKS.\n *\n * `extra` receives the token's claims with `sub` renamed to `subject`, minus\n * `client_id`, `scope` and `exp`, which map onto `AuthInfo` fields instead. Pass\n * `TExtra` to declare what your IdP puts there; the branded providers do this\n * for you. {@link RegisteredClaims} is always included, since those claims\n * survive the mapping.\n *\n * @typeParam TExtra - Claims the verified token carries in `extra`. An\n * assertion, not a runtime check: nothing rejects a token whose claims differ.\n */\nexport function createJwksVerifier<TExtra extends ExtraClaims = ExtraClaims>(\n config: JwksVerifyConfig,\n): TokenVerifier<TExtra & RegisteredClaims> {\n if (!config.issuer) {\n throw new Error(\"createJwksVerifier requires an `issuer`\");\n }\n const jwksUri =\n config.jwksUri ??\n `${config.issuer.replace(/\\/$/, \"\")}/.well-known/jwks.json`;\n const jwks = jose.createRemoteJWKSet(new URL(jwksUri));\n\n return {\n async verifyAccessToken(\n token: string,\n ): Promise<AuthInfo<TExtra & RegisteredClaims>> {\n let payload: jose.JWTPayload;\n try {\n ({ payload } = await jose.jwtVerify(token, jwks, {\n issuer: config.issuer,\n // jose skips the aud check when `audience` is undefined.\n ...(config.audience !== undefined && { audience: config.audience }),\n }));\n } catch (err) {\n const message = err instanceof Error ? err.message : String(err);\n // This reaches the `error_description` of a `WWW-Authenticate`\n // challenge, whose value must not include characters outside\n // %x20-21 / %x23-5B / %x5D-7E (OAuth 2.1 §5.3.1, RFC 6750 §3). jose\n // quotes claim names in its messages, and a quote would end the\n // parameter early, dropping the `resource_metadata` that follows it.\n // Each run becomes a space rather than being dropped, so removing one\n // never runs two words together.\n const safe = message\n .replace(/[^\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]+/g, \" \")\n .trim();\n throw new OAuthError(\n \"invalid_token\",\n `Token verification failed: ${safe}`,\n );\n }\n\n const { client_id, scope, exp, sub, ...rest } = payload as Record<\n string,\n unknown\n > & {\n client_id?: string;\n scope?: string | string[];\n exp?: number;\n sub?: string;\n };\n\n const scopes = Array.isArray(scope)\n ? scope.map(String)\n : typeof scope === \"string\"\n ? scope.split(/\\s+/).filter(Boolean)\n : [];\n\n return {\n token,\n clientId: client_id ?? \"\",\n scopes,\n expiresAt: exp,\n extra: { subject: sub, ...rest } as unknown as TExtra &\n RegisteredClaims,\n };\n },\n };\n}\n"]}
|
|
@@ -112,6 +112,22 @@ describe("createJwksVerifier", () => {
|
|
|
112
112
|
// OAuth 2.1 §5.3.1: %x20-21 / %x23-5B / %x5D-7E and nothing else.
|
|
113
113
|
expect(error?.message).not.toMatch(/[^\x20-\x21\x23-\x5B\x5D-\x7E]/);
|
|
114
114
|
});
|
|
115
|
+
it("accepts a token minted for any of several audiences", async () => {
|
|
116
|
+
const { privateKey, jwksUri } = await startJwks();
|
|
117
|
+
// A server reached at a local port and through a dev tunnel: tokens carry
|
|
118
|
+
// whichever resource the client discovered.
|
|
119
|
+
const verifier = createJwksVerifier({
|
|
120
|
+
issuer: ISSUER,
|
|
121
|
+
audience: [AUDIENCE, "https://tunnel.test"],
|
|
122
|
+
jwksUri,
|
|
123
|
+
});
|
|
124
|
+
const tunnelToken = await sign(privateKey, { client_id: "c" }, { audience: "https://tunnel.test" });
|
|
125
|
+
expect((await verifier.verifyAccessToken(tunnelToken)).clientId).toBe("c");
|
|
126
|
+
const localToken = await sign(privateKey, { client_id: "c" });
|
|
127
|
+
expect((await verifier.verifyAccessToken(localToken)).clientId).toBe("c");
|
|
128
|
+
const otherToken = await sign(privateKey, {}, { audience: "api://other" });
|
|
129
|
+
await expect(verifier.verifyAccessToken(otherToken)).rejects.toThrow(/unexpected {2}aud {2}claim value/);
|
|
130
|
+
});
|
|
115
131
|
it("skips the aud check when no audience is configured (e.g. Clerk)", async () => {
|
|
116
132
|
const { privateKey, jwksUri } = await startJwks();
|
|
117
133
|
const verifier = createJwksVerifier({ issuer: ISSUER, jwksUri });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"verify.test.js","sourceRoot":"","sources":["../../../src/server/auth/verify.test.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD,MAAM,MAAM,GAAG,qBAAqB,CAAC;AACrC,MAAM,QAAQ,GAAG,eAAe,CAAC;AAEjC,IAAI,UAAmC,CAAC;AACxC,SAAS,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;AAErC,KAAK,UAAU,SAAS;IACtB,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACtE,MAAM,GAAG,GAAG;QACV,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpC,GAAG,EAAE,UAAU;QACf,GAAG,EAAE,OAAO;QACZ,GAAG,EAAE,KAAK;KACX,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAC7C,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAClD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAChE,UAAU,GAAG,MAAM,CAAC;IACpB,MAAM,IAAI,GAAI,MAAM,CAAC,OAAO,EAAuB,CAAC,IAAI,CAAC;IACzD,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,oBAAoB,IAAI,OAAO,EAAE,CAAC;AAClE,CAAC;AAED,SAAS,IAAI,CACX,GAAc,EACd,MAA+B,EAC/B,OAAmE,EAAE;IAErE,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;SAC5B,kBAAkB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;SACrD,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC;SAChC,WAAW,CAAC,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC;SACtC,iBAAiB,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;SACzC,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;IACzC,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CACtD,sBAAsB,CACvB,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YAClC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,OAAO;SACR,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE;YACnC,SAAS,EAAE,UAAU;YACrB,KAAK,EAAE,cAAc;YACrB,GAAG,EAAE,QAAQ;YACb,KAAK,EAAE,UAAU;SAClB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAErD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QACjD,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YAClC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,OAAO;SACR,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CACtB,UAAU,EACV,EAAE,SAAS,EAAE,GAAG,EAAE,EAClB,EAAE,QAAQ,EAAE,aAAa,EAAE,CAC5B,CAAC;QAEF,MAAM,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAC7D,2BAA2B,CAC5B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,8EAA8E;IAC9E,8EAA8E;IAC9E,0EAA0E;IAC1E,EAAE,CAAC,IAAI,CAAC;QACN;YACE,kBAAkB;YAClB,CAAC,GAAc,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;YACvD,6CAA6C;YAC7C,8DAA8D;SAC/D;QACD;YACE,qCAAqC;YACrC,CAAC,GAAc,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;YAC9D,uCAAuC;YACvC,yDAAyD;SAC1D;QACD;YACE,6BAA6B;YAC7B,CAAC,GAAc,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC;YACnE,uCAAuC;YACvC,yDAAyD;SAC1D;QACD;YACE,+BAA+B;YAC/B,CAAC,GAAc,EAAE,EAAE,CACjB,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;iBACjB,kBAAkB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;iBACrD,SAAS,CAAC,MAAM,CAAC;iBACjB,iBAAiB,CAAC,IAAI,CAAC;iBACvB,IAAI,CAAC,GAAG,CAAC;YACd,uCAAuC;YACvC,yDAAyD;SAC1D;KACF,CAAC,CACA,oDAAoD,EACpD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QAC1B,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YAClC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,MAAM,QAAQ;aACzB,iBAAiB,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;aACzC,IAAI,CACH,GAAG,EAAE,CAAC,SAAS,EACf,CAAC,CAAQ,EAAE,EAAE,CAAC,CAAC,CAChB,CAAC;QAEJ,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtC,kEAAkE;QAClE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC;IACvE,CAAC,CACF,CAAC;IAEF,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;QACjE,oDAAoD;QACpD,MAAM,KAAK,GAAG,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;aAC/D,kBAAkB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;aACrD,SAAS,CAAC,MAAM,CAAC;aACjB,iBAAiB,CAAC,IAAI,CAAC;aACvB,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YAClC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE;YACxC,KAAK,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;SAC3B,CAAC,CAAC;QACH,MAAM,CAAC,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACpE,QAAQ;YACR,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,CAAC,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACpE,QAAQ;YACR,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["// @vitest-environment node\nimport http from \"node:http\";\nimport * as jose from \"jose\";\nimport { afterEach, describe, expect, it } from \"vitest\";\nimport { createJwksVerifier } from \"./verify.js\";\n\nconst ISSUER = \"https://issuer.test\";\nconst AUDIENCE = \"api://default\";\n\nlet jwksServer: http.Server | undefined;\nafterEach(() => jwksServer?.close());\n\nasync function startJwks() {\n const { publicKey, privateKey } = await jose.generateKeyPair(\"RS256\");\n const jwk = {\n ...(await jose.exportJWK(publicKey)),\n kid: \"test-key\",\n alg: \"RS256\",\n use: \"sig\",\n };\n const server = http.createServer((_req, res) => {\n res.setHeader(\"content-type\", \"application/json\");\n res.end(JSON.stringify({ keys: [jwk] }));\n });\n await new Promise<void>((resolve) => server.listen(0, resolve));\n jwksServer = server;\n const port = (server.address() as { port: number }).port;\n return { privateKey, jwksUri: `http://localhost:${port}/jwks` };\n}\n\nfunction sign(\n key: CryptoKey,\n claims: Record<string, unknown>,\n opts: { issuer?: string; audience?: string; expiresAt?: string } = {},\n) {\n return new jose.SignJWT(claims)\n .setProtectedHeader({ alg: \"RS256\", kid: \"test-key\" })\n .setIssuer(opts.issuer ?? ISSUER)\n .setAudience(opts.audience ?? AUDIENCE)\n .setExpirationTime(opts.expiresAt ?? \"1h\")\n .sign(key);\n}\n\nit(\"rejects a config with no issuer\", () => {\n expect(() => createJwksVerifier({ issuer: \"\" })).toThrow(\n /requires an `issuer`/,\n );\n});\n\ndescribe(\"createJwksVerifier\", () => {\n it(\"verifies a valid token and maps claims to AuthInfo\", async () => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({\n issuer: ISSUER,\n audience: AUDIENCE,\n jwksUri,\n });\n const token = await sign(privateKey, {\n client_id: \"client-1\",\n scope: \"openid email\",\n sub: \"user-1\",\n email: \"a@b.test\",\n });\n\n const auth = await verifier.verifyAccessToken(token);\n\n expect(auth.token).toBe(token);\n expect(auth.clientId).toBe(\"client-1\");\n expect(auth.scopes).toEqual([\"openid\", \"email\"]);\n expect(auth.extra?.subject).toBe(\"user-1\");\n expect(auth.extra?.email).toBe(\"a@b.test\");\n });\n\n it(\"rejects a token with the wrong audience\", async () => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({\n issuer: ISSUER,\n audience: AUDIENCE,\n jwksUri,\n });\n const token = await sign(\n privateKey,\n { client_id: \"c\" },\n { audience: \"api://other\" },\n );\n\n await expect(verifier.verifyAccessToken(token)).rejects.toThrow(\n /Token verification failed/,\n );\n });\n\n // jose quotes claim names — `\"exp\" claim timestamp check failed`, `unexpected\n // \"aud\" claim value`. Those quotes would close `error_description=\"…\"` early,\n // dropping the `resource_metadata` that MCP clients start discovery from.\n it.each([\n [\n \"an expired token\",\n (key: CryptoKey) => sign(key, {}, { expiresAt: \"-1h\" }),\n // jose: `\"exp\" claim timestamp check failed`\n \"Token verification failed: exp claim timestamp check failed\",\n ],\n [\n \"a token issued for another resource\",\n (key: CryptoKey) => sign(key, {}, { audience: \"api://other\" }),\n // jose: `unexpected \"aud\" claim value`\n \"Token verification failed: unexpected aud claim value\",\n ],\n [\n \"a token from another issuer\",\n (key: CryptoKey) => sign(key, {}, { issuer: \"https://other.test\" }),\n // jose: `unexpected \"iss\" claim value`\n \"Token verification failed: unexpected iss claim value\",\n ],\n [\n \"a token carrying no aud claim\",\n (key: CryptoKey) =>\n new jose.SignJWT({})\n .setProtectedHeader({ alg: \"RS256\", kid: \"test-key\" })\n .setIssuer(ISSUER)\n .setExpirationTime(\"1h\")\n .sign(key),\n // jose: `missing required \"aud\" claim`\n \"Token verification failed: missing required aud claim\",\n ],\n ])(\n \"keeps the message safe inside the challenge for %s\",\n async (_, mint, expected) => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({\n issuer: ISSUER,\n audience: AUDIENCE,\n jwksUri,\n });\n\n const error = await verifier\n .verifyAccessToken(await mint(privateKey))\n .then(\n () => undefined,\n (e: Error) => e,\n );\n\n expect(error?.message).toBe(expected);\n // OAuth 2.1 §5.3.1: %x20-21 / %x23-5B / %x5D-7E and nothing else.\n expect(error?.message).not.toMatch(/[^\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]/);\n },\n );\n\n it(\"skips the aud check when no audience is configured (e.g. Clerk)\", async () => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({ issuer: ISSUER, jwksUri });\n // Clerk-shaped access token: no `aud` claim at all.\n const token = await new jose.SignJWT({ client_id: \"c\", sub: \"u\" })\n .setProtectedHeader({ alg: \"RS256\", kid: \"test-key\" })\n .setIssuer(ISSUER)\n .setExpirationTime(\"1h\")\n .sign(privateKey);\n\n const auth = await verifier.verifyAccessToken(token);\n expect(auth.clientId).toBe(\"c\");\n expect(auth.extra?.subject).toBe(\"u\");\n });\n\n it(\"parses array scope claims and trims extra whitespace\", async () => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({\n issuer: ISSUER,\n audience: AUDIENCE,\n jwksUri,\n });\n\n const arrayToken = await sign(privateKey, {\n scope: [\"openid\", \"email\"],\n });\n expect((await verifier.verifyAccessToken(arrayToken)).scopes).toEqual([\n \"openid\",\n \"email\",\n ]);\n\n const messyToken = await sign(privateKey, { scope: \" openid email \" });\n expect((await verifier.verifyAccessToken(messyToken)).scopes).toEqual([\n \"openid\",\n \"email\",\n ]);\n });\n});\n"]}
|
|
1
|
+
{"version":3,"file":"verify.test.js","sourceRoot":"","sources":["../../../src/server/auth/verify.test.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD,MAAM,MAAM,GAAG,qBAAqB,CAAC;AACrC,MAAM,QAAQ,GAAG,eAAe,CAAC;AAEjC,IAAI,UAAmC,CAAC;AACxC,SAAS,CAAC,GAAG,EAAE,CAAC,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;AAErC,KAAK,UAAU,SAAS;IACtB,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IACtE,MAAM,GAAG,GAAG;QACV,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpC,GAAG,EAAE,UAAU;QACf,GAAG,EAAE,OAAO;QACZ,GAAG,EAAE,KAAK;KACX,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAC7C,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAClD,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IACH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAChE,UAAU,GAAG,MAAM,CAAC;IACpB,MAAM,IAAI,GAAI,MAAM,CAAC,OAAO,EAAuB,CAAC,IAAI,CAAC;IACzD,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,oBAAoB,IAAI,OAAO,EAAE,CAAC;AAClE,CAAC;AAED,SAAS,IAAI,CACX,GAAc,EACd,MAA+B,EAC/B,OAAmE,EAAE;IAErE,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;SAC5B,kBAAkB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;SACrD,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC;SAChC,WAAW,CAAC,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC;SACtC,iBAAiB,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;SACzC,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;IACzC,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CACtD,sBAAsB,CACvB,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YAClC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,OAAO;SACR,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE;YACnC,SAAS,EAAE,UAAU;YACrB,KAAK,EAAE,cAAc;YACrB,GAAG,EAAE,QAAQ;YACb,KAAK,EAAE,UAAU;SAClB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAErD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QACjD,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YAClC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,OAAO;SACR,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CACtB,UAAU,EACV,EAAE,SAAS,EAAE,GAAG,EAAE,EAClB,EAAE,QAAQ,EAAE,aAAa,EAAE,CAC5B,CAAC;QAEF,MAAM,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAC7D,2BAA2B,CAC5B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,8EAA8E;IAC9E,8EAA8E;IAC9E,0EAA0E;IAC1E,EAAE,CAAC,IAAI,CAAC;QACN;YACE,kBAAkB;YAClB,CAAC,GAAc,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;YACvD,6CAA6C;YAC7C,8DAA8D;SAC/D;QACD;YACE,qCAAqC;YACrC,CAAC,GAAc,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;YAC9D,uCAAuC;YACvC,yDAAyD;SAC1D;QACD;YACE,6BAA6B;YAC7B,CAAC,GAAc,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC;YACnE,uCAAuC;YACvC,yDAAyD;SAC1D;QACD;YACE,+BAA+B;YAC/B,CAAC,GAAc,EAAE,EAAE,CACjB,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;iBACjB,kBAAkB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;iBACrD,SAAS,CAAC,MAAM,CAAC;iBACjB,iBAAiB,CAAC,IAAI,CAAC;iBACvB,IAAI,CAAC,GAAG,CAAC;YACd,uCAAuC;YACvC,yDAAyD;SAC1D;KACF,CAAC,CACA,oDAAoD,EACpD,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;QAC1B,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YAClC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,KAAK,GAAG,MAAM,QAAQ;aACzB,iBAAiB,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;aACzC,IAAI,CACH,GAAG,EAAE,CAAC,SAAS,EACf,CAAC,CAAQ,EAAE,EAAE,CAAC,CAAC,CAChB,CAAC;QAEJ,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtC,kEAAkE;QAClE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,gCAAgC,CAAC,CAAC;IACvE,CAAC,CACF,CAAC;IAEF,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,0EAA0E;QAC1E,4CAA4C;QAC5C,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YAClC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,CAAC,QAAQ,EAAE,qBAAqB,CAAC;YAC3C,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,MAAM,IAAI,CAC5B,UAAU,EACV,EAAE,SAAS,EAAE,GAAG,EAAE,EAClB,EAAE,QAAQ,EAAE,qBAAqB,EAAE,CACpC,CAAC;QACF,MAAM,CAAC,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE3E,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;QAC9D,MAAM,CAAC,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE1E,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC,CAAC;QAC3E,MAAM,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAClE,kCAAkC,CACnC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC/E,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;QACjE,oDAAoD;QACpD,MAAM,KAAK,GAAG,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;aAC/D,kBAAkB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC;aACrD,SAAS,CAAC,MAAM,CAAC;aACjB,iBAAiB,CAAC,IAAI,CAAC;aACvB,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,SAAS,EAAE,CAAC;QAClD,MAAM,QAAQ,GAAG,kBAAkB,CAAC;YAClC,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE;YACxC,KAAK,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;SAC3B,CAAC,CAAC;QACH,MAAM,CAAC,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACpE,QAAQ;YACR,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC,CAAC;QACxE,MAAM,CAAC,CAAC,MAAM,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACpE,QAAQ;YACR,OAAO;SACR,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["// @vitest-environment node\nimport http from \"node:http\";\nimport * as jose from \"jose\";\nimport { afterEach, describe, expect, it } from \"vitest\";\nimport { createJwksVerifier } from \"./verify.js\";\n\nconst ISSUER = \"https://issuer.test\";\nconst AUDIENCE = \"api://default\";\n\nlet jwksServer: http.Server | undefined;\nafterEach(() => jwksServer?.close());\n\nasync function startJwks() {\n const { publicKey, privateKey } = await jose.generateKeyPair(\"RS256\");\n const jwk = {\n ...(await jose.exportJWK(publicKey)),\n kid: \"test-key\",\n alg: \"RS256\",\n use: \"sig\",\n };\n const server = http.createServer((_req, res) => {\n res.setHeader(\"content-type\", \"application/json\");\n res.end(JSON.stringify({ keys: [jwk] }));\n });\n await new Promise<void>((resolve) => server.listen(0, resolve));\n jwksServer = server;\n const port = (server.address() as { port: number }).port;\n return { privateKey, jwksUri: `http://localhost:${port}/jwks` };\n}\n\nfunction sign(\n key: CryptoKey,\n claims: Record<string, unknown>,\n opts: { issuer?: string; audience?: string; expiresAt?: string } = {},\n) {\n return new jose.SignJWT(claims)\n .setProtectedHeader({ alg: \"RS256\", kid: \"test-key\" })\n .setIssuer(opts.issuer ?? ISSUER)\n .setAudience(opts.audience ?? AUDIENCE)\n .setExpirationTime(opts.expiresAt ?? \"1h\")\n .sign(key);\n}\n\nit(\"rejects a config with no issuer\", () => {\n expect(() => createJwksVerifier({ issuer: \"\" })).toThrow(\n /requires an `issuer`/,\n );\n});\n\ndescribe(\"createJwksVerifier\", () => {\n it(\"verifies a valid token and maps claims to AuthInfo\", async () => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({\n issuer: ISSUER,\n audience: AUDIENCE,\n jwksUri,\n });\n const token = await sign(privateKey, {\n client_id: \"client-1\",\n scope: \"openid email\",\n sub: \"user-1\",\n email: \"a@b.test\",\n });\n\n const auth = await verifier.verifyAccessToken(token);\n\n expect(auth.token).toBe(token);\n expect(auth.clientId).toBe(\"client-1\");\n expect(auth.scopes).toEqual([\"openid\", \"email\"]);\n expect(auth.extra?.subject).toBe(\"user-1\");\n expect(auth.extra?.email).toBe(\"a@b.test\");\n });\n\n it(\"rejects a token with the wrong audience\", async () => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({\n issuer: ISSUER,\n audience: AUDIENCE,\n jwksUri,\n });\n const token = await sign(\n privateKey,\n { client_id: \"c\" },\n { audience: \"api://other\" },\n );\n\n await expect(verifier.verifyAccessToken(token)).rejects.toThrow(\n /Token verification failed/,\n );\n });\n\n // jose quotes claim names — `\"exp\" claim timestamp check failed`, `unexpected\n // \"aud\" claim value`. Those quotes would close `error_description=\"…\"` early,\n // dropping the `resource_metadata` that MCP clients start discovery from.\n it.each([\n [\n \"an expired token\",\n (key: CryptoKey) => sign(key, {}, { expiresAt: \"-1h\" }),\n // jose: `\"exp\" claim timestamp check failed`\n \"Token verification failed: exp claim timestamp check failed\",\n ],\n [\n \"a token issued for another resource\",\n (key: CryptoKey) => sign(key, {}, { audience: \"api://other\" }),\n // jose: `unexpected \"aud\" claim value`\n \"Token verification failed: unexpected aud claim value\",\n ],\n [\n \"a token from another issuer\",\n (key: CryptoKey) => sign(key, {}, { issuer: \"https://other.test\" }),\n // jose: `unexpected \"iss\" claim value`\n \"Token verification failed: unexpected iss claim value\",\n ],\n [\n \"a token carrying no aud claim\",\n (key: CryptoKey) =>\n new jose.SignJWT({})\n .setProtectedHeader({ alg: \"RS256\", kid: \"test-key\" })\n .setIssuer(ISSUER)\n .setExpirationTime(\"1h\")\n .sign(key),\n // jose: `missing required \"aud\" claim`\n \"Token verification failed: missing required aud claim\",\n ],\n ])(\n \"keeps the message safe inside the challenge for %s\",\n async (_, mint, expected) => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({\n issuer: ISSUER,\n audience: AUDIENCE,\n jwksUri,\n });\n\n const error = await verifier\n .verifyAccessToken(await mint(privateKey))\n .then(\n () => undefined,\n (e: Error) => e,\n );\n\n expect(error?.message).toBe(expected);\n // OAuth 2.1 §5.3.1: %x20-21 / %x23-5B / %x5D-7E and nothing else.\n expect(error?.message).not.toMatch(/[^\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]/);\n },\n );\n\n it(\"accepts a token minted for any of several audiences\", async () => {\n const { privateKey, jwksUri } = await startJwks();\n // A server reached at a local port and through a dev tunnel: tokens carry\n // whichever resource the client discovered.\n const verifier = createJwksVerifier({\n issuer: ISSUER,\n audience: [AUDIENCE, \"https://tunnel.test\"],\n jwksUri,\n });\n\n const tunnelToken = await sign(\n privateKey,\n { client_id: \"c\" },\n { audience: \"https://tunnel.test\" },\n );\n expect((await verifier.verifyAccessToken(tunnelToken)).clientId).toBe(\"c\");\n\n const localToken = await sign(privateKey, { client_id: \"c\" });\n expect((await verifier.verifyAccessToken(localToken)).clientId).toBe(\"c\");\n\n const otherToken = await sign(privateKey, {}, { audience: \"api://other\" });\n await expect(verifier.verifyAccessToken(otherToken)).rejects.toThrow(\n /unexpected {2}aud {2}claim value/,\n );\n });\n\n it(\"skips the aud check when no audience is configured (e.g. Clerk)\", async () => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({ issuer: ISSUER, jwksUri });\n // Clerk-shaped access token: no `aud` claim at all.\n const token = await new jose.SignJWT({ client_id: \"c\", sub: \"u\" })\n .setProtectedHeader({ alg: \"RS256\", kid: \"test-key\" })\n .setIssuer(ISSUER)\n .setExpirationTime(\"1h\")\n .sign(privateKey);\n\n const auth = await verifier.verifyAccessToken(token);\n expect(auth.clientId).toBe(\"c\");\n expect(auth.extra?.subject).toBe(\"u\");\n });\n\n it(\"parses array scope claims and trims extra whitespace\", async () => {\n const { privateKey, jwksUri } = await startJwks();\n const verifier = createJwksVerifier({\n issuer: ISSUER,\n audience: AUDIENCE,\n jwksUri,\n });\n\n const arrayToken = await sign(privateKey, {\n scope: [\"openid\", \"email\"],\n });\n expect((await verifier.verifyAccessToken(arrayToken)).scopes).toEqual([\n \"openid\",\n \"email\",\n ]);\n\n const messyToken = await sign(privateKey, { scope: \" openid email \" });\n expect((await verifier.verifyAccessToken(messyToken)).scopes).toEqual([\n \"openid\",\n \"email\",\n ]);\n });\n});\n"]}
|
package/dist/server/auth.d.ts
CHANGED
|
@@ -8,7 +8,7 @@ export type ExtraClaims = Record<string, unknown>;
|
|
|
8
8
|
/**
|
|
9
9
|
* A validated access token, as resolved by a
|
|
10
10
|
* [verifier](https://docs.skybridge.tech/api-reference/verifier) and handed to
|
|
11
|
-
* handlers on `extra.authInfo`.
|
|
11
|
+
* handlers on `extra.http?.authInfo`.
|
|
12
12
|
*
|
|
13
13
|
* Unparameterized, `extra` stays the SDK's `Record<string, unknown>` bag. The
|
|
14
14
|
* claims are owned by whoever verifies the token: parameterize the verifier and
|
|
@@ -30,7 +30,7 @@ export type AuthInfo<TExtra extends ExtraClaims = ExtraClaims> = Omit<SdkAuthInf
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* Checks a bearer token and resolves the claims it carries. The type parameter
|
|
33
|
-
* is what makes `extra.authInfo.extra` typed downstream, so a verifier is the
|
|
33
|
+
* is what makes `extra.http?.authInfo.extra` typed downstream, so a verifier is the
|
|
34
34
|
* single source for the claim shape.
|
|
35
35
|
*
|
|
36
36
|
* Pass one to {@link requireBearerAuth} or {@link optionalBearerAuth} directly,
|
|
@@ -45,7 +45,7 @@ export type TokenVerifier<TExtra extends ExtraClaims = ExtraClaims> = {
|
|
|
45
45
|
* Like `requireBearerAuth`, but lets requests through when no
|
|
46
46
|
* `Authorization` header is present. Used for mixed-auth servers where some
|
|
47
47
|
* tools are public and others require sign-in: each tool enforces its own
|
|
48
|
-
* `securitySchemes` against `extra.authInfo`.
|
|
48
|
+
* `securitySchemes` against `extra.http?.authInfo`.
|
|
49
49
|
*
|
|
50
50
|
* Behavior:
|
|
51
51
|
* - No `Authorization` header → `next()` without `req.auth`.
|
package/dist/server/auth.js
CHANGED
|
@@ -5,7 +5,7 @@ export { OAuthError, OAuthErrorCode } from "@modelcontextprotocol/server";
|
|
|
5
5
|
* Like `requireBearerAuth`, but lets requests through when no
|
|
6
6
|
* `Authorization` header is present. Used for mixed-auth servers where some
|
|
7
7
|
* tools are public and others require sign-in: each tool enforces its own
|
|
8
|
-
* `securitySchemes` against `extra.authInfo`.
|
|
8
|
+
* `securitySchemes` against `extra.http?.authInfo`.
|
|
9
9
|
*
|
|
10
10
|
* Behavior:
|
|
11
11
|
* - No `Authorization` header → `next()` without `req.auth`.
|
package/dist/server/auth.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/server/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,GAClB,MAAM,+BAA+B,CAAC;AAKvC,OAAO,EAGL,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AA2C1E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAoC;IAEpC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC5C,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAC/B,IAAI,EAAE,CAAC;YACP,OAAO;QACT,CAAC;QACD,OAAO,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import {\n type BearerAuthMiddlewareOptions,\n requireBearerAuth,\n} from \"@modelcontextprotocol/express\";\nimport type { AuthInfo as SdkAuthInfo } from \"@modelcontextprotocol/server\";\n\nimport type { RequestHandler } from \"express\";\n\nexport {\n type AuthMetadataOptions,\n type BearerAuthMiddlewareOptions,\n mcpAuthMetadataRouter,\n requireBearerAuth,\n} from \"@modelcontextprotocol/express\";\nexport { OAuthError, OAuthErrorCode } from \"@modelcontextprotocol/server\";\n/** Claims a verifier puts in `AuthInfo[\"extra\"]`: any JSON-ish bag of them. */\nexport type ExtraClaims = Record<string, unknown>;\n\n/**\n * A validated access token, as resolved by a\n * [verifier](https://docs.skybridge.tech/api-reference/verifier) and handed to\n * handlers on `extra.authInfo`.\n *\n * Unparameterized, `extra` stays the SDK's `Record<string, unknown>` bag. The\n * claims are owned by whoever verifies the token: parameterize the verifier and\n * the shape flows through {@link OAuthConfig} to every handler.\n *\n * @typeParam TExtra - Claims populated in `extra`.\n *\n * @example\n * ```ts\n * type Claims = { subject?: string; email?: string };\n *\n * async function verifyAccessToken(token: string): Promise<AuthInfo<Claims>> {\n * // ...\n * }\n * ```\n */\nexport type AuthInfo<TExtra extends ExtraClaims = ExtraClaims> = Omit<\n SdkAuthInfo,\n \"extra\"\n> & { extra?: TExtra };\n\n/**\n * Checks a bearer token and resolves the claims it carries. The type parameter\n * is what makes `extra.authInfo.extra` typed downstream, so a verifier is the\n * single source for the claim shape.\n *\n * Pass one to {@link requireBearerAuth} or {@link optionalBearerAuth} directly,\n * or hand it to the `oauth` server option inside an {@link OAuthConfig}.\n *\n * @typeParam TExtra - Claims this verifier populates in `AuthInfo[\"extra\"]`.\n */\nexport type TokenVerifier<TExtra extends ExtraClaims = ExtraClaims> = {\n verifyAccessToken(token: string): Promise<AuthInfo<TExtra>>;\n};\n\n/**\n * Like `requireBearerAuth`, but lets requests through when no\n * `Authorization` header is present. Used for mixed-auth servers where some\n * tools are public and others require sign-in: each tool enforces its own\n * `securitySchemes` against `extra.authInfo`.\n *\n * Behavior:\n * - No `Authorization` header → `next()` without `req.auth`.\n * - Valid Bearer token → `req.auth` set, same as `requireBearerAuth`.\n * - Invalid / malformed / expired / insufficient-scope → same error response\n * as `requireBearerAuth` (401/403). Sending a bad token is still a client\n * error.\n */\nexport function optionalBearerAuth(\n options: BearerAuthMiddlewareOptions,\n): RequestHandler {\n const required = requireBearerAuth(options);\n return (req, res, next) => {\n if (!req.headers.authorization) {\n next();\n return;\n }\n return required(req, res, next);\n };\n}\n"]}
|
|
1
|
+
{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/server/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,GAClB,MAAM,+BAA+B,CAAC;AAKvC,OAAO,EAGL,qBAAqB,EACrB,iBAAiB,GAClB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AA2C1E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAoC;IAEpC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAC5C,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACxB,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAC/B,IAAI,EAAE,CAAC;YACP,OAAO;QACT,CAAC;QACD,OAAO,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import {\n type BearerAuthMiddlewareOptions,\n requireBearerAuth,\n} from \"@modelcontextprotocol/express\";\nimport type { AuthInfo as SdkAuthInfo } from \"@modelcontextprotocol/server\";\n\nimport type { RequestHandler } from \"express\";\n\nexport {\n type AuthMetadataOptions,\n type BearerAuthMiddlewareOptions,\n mcpAuthMetadataRouter,\n requireBearerAuth,\n} from \"@modelcontextprotocol/express\";\nexport { OAuthError, OAuthErrorCode } from \"@modelcontextprotocol/server\";\n/** Claims a verifier puts in `AuthInfo[\"extra\"]`: any JSON-ish bag of them. */\nexport type ExtraClaims = Record<string, unknown>;\n\n/**\n * A validated access token, as resolved by a\n * [verifier](https://docs.skybridge.tech/api-reference/verifier) and handed to\n * handlers on `extra.http?.authInfo`.\n *\n * Unparameterized, `extra` stays the SDK's `Record<string, unknown>` bag. The\n * claims are owned by whoever verifies the token: parameterize the verifier and\n * the shape flows through {@link OAuthConfig} to every handler.\n *\n * @typeParam TExtra - Claims populated in `extra`.\n *\n * @example\n * ```ts\n * type Claims = { subject?: string; email?: string };\n *\n * async function verifyAccessToken(token: string): Promise<AuthInfo<Claims>> {\n * // ...\n * }\n * ```\n */\nexport type AuthInfo<TExtra extends ExtraClaims = ExtraClaims> = Omit<\n SdkAuthInfo,\n \"extra\"\n> & { extra?: TExtra };\n\n/**\n * Checks a bearer token and resolves the claims it carries. The type parameter\n * is what makes `extra.http?.authInfo.extra` typed downstream, so a verifier is the\n * single source for the claim shape.\n *\n * Pass one to {@link requireBearerAuth} or {@link optionalBearerAuth} directly,\n * or hand it to the `oauth` server option inside an {@link OAuthConfig}.\n *\n * @typeParam TExtra - Claims this verifier populates in `AuthInfo[\"extra\"]`.\n */\nexport type TokenVerifier<TExtra extends ExtraClaims = ExtraClaims> = {\n verifyAccessToken(token: string): Promise<AuthInfo<TExtra>>;\n};\n\n/**\n * Like `requireBearerAuth`, but lets requests through when no\n * `Authorization` header is present. Used for mixed-auth servers where some\n * tools are public and others require sign-in: each tool enforces its own\n * `securitySchemes` against `extra.http?.authInfo`.\n *\n * Behavior:\n * - No `Authorization` header → `next()` without `req.auth`.\n * - Valid Bearer token → `req.auth` set, same as `requireBearerAuth`.\n * - Invalid / malformed / expired / insufficient-scope → same error response\n * as `requireBearerAuth` (401/403). Sending a bad token is still a client\n * error.\n */\nexport function optionalBearerAuth(\n options: BearerAuthMiddlewareOptions,\n): RequestHandler {\n const required = requireBearerAuth(options);\n return (req, res, next) => {\n if (!req.headers.authorization) {\n next();\n return;\n }\n return required(req, res, next);\n };\n}\n"]}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { type McpServer as SdkMcpServer, type StandardSchemaV1, type StandardSchemaWithJSON } from "@modelcontextprotocol/server";
|
|
2
|
+
/**
|
|
3
|
+
* A webhook subscription, as passed to `onSubscribe`. Whatever delivers the
|
|
4
|
+
* events POSTs them to `url`, signed with `secret`, until `expiresAt`.
|
|
5
|
+
*/
|
|
6
|
+
export interface EventSubscription {
|
|
7
|
+
/** Stable across refreshes: the same user subscribing to the same event with the same arguments and callback gets the same `id`. */
|
|
8
|
+
id: string;
|
|
9
|
+
/** Callback URL deliveries are POSTed to. */
|
|
10
|
+
url: string;
|
|
11
|
+
/** Standard Webhooks signing secret (`whsec_…`). A refresh may carry a new one. */
|
|
12
|
+
secret: string;
|
|
13
|
+
/** When the subscription lapses unless the host refreshes it. */
|
|
14
|
+
expiresAt: Date;
|
|
15
|
+
}
|
|
16
|
+
/** An event occurrence, as passed to {@link deliverEvent}. */
|
|
17
|
+
export interface EventOccurrence {
|
|
18
|
+
/** Event type name, as registered with `registerEvent`. */
|
|
19
|
+
name: string;
|
|
20
|
+
/** Stable identifier the host uses to drop duplicates, ideally the upstream's. Reuse it when retrying. */
|
|
21
|
+
id: string;
|
|
22
|
+
/** When the event happened. Defaults to now. */
|
|
23
|
+
timestamp?: Date;
|
|
24
|
+
/** Payload matching the event's `payloadSchema`. */
|
|
25
|
+
data: unknown;
|
|
26
|
+
}
|
|
27
|
+
/** Outcome of {@link deliverEvent}. Retry with the same event `id` when `retryable`. */
|
|
28
|
+
export type DeliveryResult = {
|
|
29
|
+
ok: true;
|
|
30
|
+
} | {
|
|
31
|
+
ok: false;
|
|
32
|
+
reason: string;
|
|
33
|
+
retryable: boolean;
|
|
34
|
+
status?: number;
|
|
35
|
+
};
|
|
36
|
+
type EventSchema = Record<string, StandardSchemaWithJSON> | StandardSchemaWithJSON;
|
|
37
|
+
export type InferEventSchema<T extends EventSchema> = T extends StandardSchemaWithJSON ? StandardSchemaV1.InferOutput<T> : T extends Record<string, StandardSchemaWithJSON> ? {
|
|
38
|
+
[K in keyof T as undefined extends StandardSchemaV1.InferOutput<T[K]> ? never : K]: StandardSchemaV1.InferOutput<T[K]>;
|
|
39
|
+
} & {
|
|
40
|
+
[K in keyof T as undefined extends StandardSchemaV1.InferOutput<T[K]> ? K : never]?: StandardSchemaV1.InferOutput<T[K]>;
|
|
41
|
+
} : never;
|
|
42
|
+
/** The `registerEvent` config: how the event type is described in `events/list`. */
|
|
43
|
+
export interface EventConfig<TInput extends EventSchema> {
|
|
44
|
+
/** Stable, specific name such as `comment.created`. */
|
|
45
|
+
name: string;
|
|
46
|
+
/** What the event is and when it fires. */
|
|
47
|
+
description?: string;
|
|
48
|
+
/** Subscription arguments (filters): a Zod shape or a Standard Schema object. */
|
|
49
|
+
inputSchema?: TInput;
|
|
50
|
+
/** Shape of the delivered `data`: a Zod shape or a Standard Schema object. */
|
|
51
|
+
payloadSchema: EventSchema;
|
|
52
|
+
_meta?: Record<string, unknown>;
|
|
53
|
+
}
|
|
54
|
+
/** What `registerEvent` does when the host subscribes and unsubscribes. */
|
|
55
|
+
export interface EventHooks<TArguments, TExtra> {
|
|
56
|
+
/**
|
|
57
|
+
* Runs on every `events/subscribe`, including the host's refreshes, once
|
|
58
|
+
* the callback URL is verified. Hand the subscription to whatever delivers
|
|
59
|
+
* the events, keyed by `subscription.id`. Throw (e.g. a `ProtocolError`) to
|
|
60
|
+
* reject it, for instance when the user may not access what the arguments
|
|
61
|
+
* point to.
|
|
62
|
+
*/
|
|
63
|
+
onSubscribe(args: TArguments, context: {
|
|
64
|
+
subscription: EventSubscription;
|
|
65
|
+
extra: TExtra;
|
|
66
|
+
}): void | Promise<void>;
|
|
67
|
+
/** Runs on `events/unsubscribe`. Stop delivering to `subscription.id`. */
|
|
68
|
+
onUnsubscribe(args: TArguments, context: {
|
|
69
|
+
subscription: Pick<EventSubscription, "id">;
|
|
70
|
+
extra: TExtra;
|
|
71
|
+
}): void | Promise<void>;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* @experimental POST one event to a subscription handed out by `onSubscribe`,
|
|
75
|
+
* as MCP Events expects: the event envelope, Standard Webhooks signature
|
|
76
|
+
* headers, a 10 second deadline and, outside development, no requests to
|
|
77
|
+
* private addresses. Pass the old and new secrets during a rotation so both
|
|
78
|
+
* sign the delivery. A subscription past `expiresAt` is not posted to.
|
|
79
|
+
* Retrying is up to the caller. API may change.
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```ts
|
|
83
|
+
* const result = await deliverEvent(subscription, {
|
|
84
|
+
* name: "comment.created",
|
|
85
|
+
* id: comment.id,
|
|
86
|
+
* data: { documentId: comment.documentId, excerpt: comment.text.slice(0, 280) },
|
|
87
|
+
* });
|
|
88
|
+
* if (!result.ok && result.retryable) {
|
|
89
|
+
* await queue.retryLater(subscription, comment);
|
|
90
|
+
* }
|
|
91
|
+
* ```
|
|
92
|
+
*
|
|
93
|
+
* @see https://docs.skybridge.tech/api-reference/register-event
|
|
94
|
+
*/
|
|
95
|
+
export declare function deliverEvent(subscription: Pick<EventSubscription, "id" | "url"> & {
|
|
96
|
+
secret: string | string[];
|
|
97
|
+
expiresAt: Date | string;
|
|
98
|
+
}, event: EventOccurrence): Promise<DeliveryResult>;
|
|
99
|
+
/**
|
|
100
|
+
* The event types registered on one server, and the `events/*` handlers that
|
|
101
|
+
* serve them.
|
|
102
|
+
*
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
export declare class EventRegistry {
|
|
106
|
+
private readonly server;
|
|
107
|
+
private readonly events;
|
|
108
|
+
constructor(server: Pick<SdkMcpServer["server"], "setRequestHandler">);
|
|
109
|
+
add(config: EventConfig<EventSchema>, hooks: EventHooks<never, never>): void;
|
|
110
|
+
private install;
|
|
111
|
+
private resolve;
|
|
112
|
+
}
|
|
113
|
+
export {};
|
|
@@ -0,0 +1,318 @@
|
|
|
1
|
+
import { createHash, randomBytes, timingSafeEqual } from "node:crypto";
|
|
2
|
+
import http from "node:http";
|
|
3
|
+
import https from "node:https";
|
|
4
|
+
import { INVALID_PARAMS, ProtocolError, } from "@modelcontextprotocol/server";
|
|
5
|
+
import { globalHttpAgent, globalHttpsAgent } from "request-filtering-agent";
|
|
6
|
+
import { Webhook } from "standardwebhooks";
|
|
7
|
+
import { z } from "zod/v4";
|
|
8
|
+
const EVENTS_ERROR = {
|
|
9
|
+
NotFound: -32011,
|
|
10
|
+
Forbidden: -32012,
|
|
11
|
+
Unsupported: -32014,
|
|
12
|
+
CallbackEndpointError: -32015,
|
|
13
|
+
};
|
|
14
|
+
const MAX_PAYLOAD_BYTES = 256 * 1024;
|
|
15
|
+
const DELIVERY_TIMEOUT_MS = 10_000;
|
|
16
|
+
const VERIFICATION_CACHE_MS = 60 * 60_000;
|
|
17
|
+
const MIN_TTL_MS = 60_000;
|
|
18
|
+
const DEFAULT_TTL_MS = 30 * 60_000;
|
|
19
|
+
const MAX_TTL_MS = 24 * 60 * 60_000;
|
|
20
|
+
function toStandardSchema(schema) {
|
|
21
|
+
return "~standard" in schema
|
|
22
|
+
? schema
|
|
23
|
+
: z.object(schema);
|
|
24
|
+
}
|
|
25
|
+
async function validate(schema, value) {
|
|
26
|
+
const result = await schema["~standard"].validate(value);
|
|
27
|
+
if (result.issues) {
|
|
28
|
+
throw new ProtocolError(INVALID_PARAMS, `Invalid arguments: ${result.issues.map((issue) => issue.message).join(", ")}`);
|
|
29
|
+
}
|
|
30
|
+
return result.value;
|
|
31
|
+
}
|
|
32
|
+
function canonicalJson(value) {
|
|
33
|
+
if (Array.isArray(value)) {
|
|
34
|
+
return `[${value.map(canonicalJson).join(",")}]`;
|
|
35
|
+
}
|
|
36
|
+
if (value && typeof value === "object") {
|
|
37
|
+
return `{${Object.keys(value)
|
|
38
|
+
.sort()
|
|
39
|
+
.map((key) => `${JSON.stringify(key)}:${canonicalJson(value[key])}`)
|
|
40
|
+
.join(",")}}`;
|
|
41
|
+
}
|
|
42
|
+
return JSON.stringify(value);
|
|
43
|
+
}
|
|
44
|
+
function subscriberOf(ctx) {
|
|
45
|
+
const authInfo = ctx.http?.authInfo;
|
|
46
|
+
const subject = authInfo?.extra?.subject;
|
|
47
|
+
const subscriber = typeof subject === "string" ? subject : authInfo?.clientId;
|
|
48
|
+
if (!subscriber) {
|
|
49
|
+
throw new ProtocolError(EVENTS_ERROR.Forbidden, "Webhook subscriptions require an authenticated caller");
|
|
50
|
+
}
|
|
51
|
+
return subscriber;
|
|
52
|
+
}
|
|
53
|
+
function isValidSecret(secret) {
|
|
54
|
+
const encoded = secret.startsWith("whsec_") ? secret.slice(6) : "";
|
|
55
|
+
if (!/^[A-Za-z0-9+/]+={0,2}$/.test(encoded)) {
|
|
56
|
+
return false;
|
|
57
|
+
}
|
|
58
|
+
const length = Buffer.from(encoded, "base64").length;
|
|
59
|
+
return length >= 24 && length <= 64;
|
|
60
|
+
}
|
|
61
|
+
const insecureCallbacksAllowed = () => process.env.NODE_ENV !== "production";
|
|
62
|
+
function checkCallbackUrl(raw) {
|
|
63
|
+
let url;
|
|
64
|
+
try {
|
|
65
|
+
url = new URL(raw);
|
|
66
|
+
}
|
|
67
|
+
catch {
|
|
68
|
+
throw new ProtocolError(INVALID_PARAMS, "delivery.url is not a valid URL");
|
|
69
|
+
}
|
|
70
|
+
const allowed = url.protocol === "https:" ||
|
|
71
|
+
(url.protocol === "http:" && insecureCallbacksAllowed());
|
|
72
|
+
if (!allowed) {
|
|
73
|
+
throw new ProtocolError(INVALID_PARAMS, "delivery.url must use https");
|
|
74
|
+
}
|
|
75
|
+
return url.href;
|
|
76
|
+
}
|
|
77
|
+
function post(url, headers, body) {
|
|
78
|
+
const signal = AbortSignal.timeout(DELIVERY_TIMEOUT_MS);
|
|
79
|
+
const failure = (error) => ({
|
|
80
|
+
ok: false,
|
|
81
|
+
reason: signal.aborted
|
|
82
|
+
? "timeout"
|
|
83
|
+
: error?.code?.startsWith("ERR_TLS") || error?.code?.includes("CERT")
|
|
84
|
+
? "tls_error"
|
|
85
|
+
: "connection_refused",
|
|
86
|
+
});
|
|
87
|
+
const [client, agent] = url.startsWith("https:")
|
|
88
|
+
? [https, globalHttpsAgent]
|
|
89
|
+
: [http, globalHttpAgent];
|
|
90
|
+
return new Promise((resolve) => {
|
|
91
|
+
const request = client.request(url, {
|
|
92
|
+
method: "POST",
|
|
93
|
+
headers: { ...headers, "content-length": Buffer.byteLength(body) },
|
|
94
|
+
signal,
|
|
95
|
+
...(!insecureCallbacksAllowed() && { agent }),
|
|
96
|
+
}, (response) => {
|
|
97
|
+
const status = response.statusCode ?? 0;
|
|
98
|
+
const chunks = [];
|
|
99
|
+
let size = 0;
|
|
100
|
+
response.on("data", (chunk) => {
|
|
101
|
+
size += chunk.length;
|
|
102
|
+
if (size <= 64 * 1024) {
|
|
103
|
+
chunks.push(chunk);
|
|
104
|
+
}
|
|
105
|
+
});
|
|
106
|
+
response.on("end", () => {
|
|
107
|
+
if (status >= 200 && status < 300) {
|
|
108
|
+
resolve({ ok: true, body: Buffer.concat(chunks).toString() });
|
|
109
|
+
}
|
|
110
|
+
else {
|
|
111
|
+
resolve({
|
|
112
|
+
ok: false,
|
|
113
|
+
status,
|
|
114
|
+
reason: status >= 500 ? "http_5xx" : "http_4xx",
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
});
|
|
118
|
+
response.on("error", (error) => resolve(failure(error)));
|
|
119
|
+
response.on("close", () => resolve(failure()));
|
|
120
|
+
});
|
|
121
|
+
request.on("error", (error) => resolve(failure(error)));
|
|
122
|
+
request.end(body);
|
|
123
|
+
});
|
|
124
|
+
}
|
|
125
|
+
function signedPost(subscription, messageId, body) {
|
|
126
|
+
const signedAt = new Date();
|
|
127
|
+
const secrets = [subscription.secret].flat();
|
|
128
|
+
return post(subscription.url, {
|
|
129
|
+
"content-type": "application/json",
|
|
130
|
+
"webhook-id": messageId,
|
|
131
|
+
"webhook-timestamp": String(Math.floor(signedAt.getTime() / 1000)),
|
|
132
|
+
"webhook-signature": secrets
|
|
133
|
+
.map((secret) => new Webhook(secret).sign(messageId, signedAt, body))
|
|
134
|
+
.join(" "),
|
|
135
|
+
"x-mcp-subscription-id": subscription.id,
|
|
136
|
+
}, body);
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* @experimental POST one event to a subscription handed out by `onSubscribe`,
|
|
140
|
+
* as MCP Events expects: the event envelope, Standard Webhooks signature
|
|
141
|
+
* headers, a 10 second deadline and, outside development, no requests to
|
|
142
|
+
* private addresses. Pass the old and new secrets during a rotation so both
|
|
143
|
+
* sign the delivery. A subscription past `expiresAt` is not posted to.
|
|
144
|
+
* Retrying is up to the caller. API may change.
|
|
145
|
+
*
|
|
146
|
+
* @example
|
|
147
|
+
* ```ts
|
|
148
|
+
* const result = await deliverEvent(subscription, {
|
|
149
|
+
* name: "comment.created",
|
|
150
|
+
* id: comment.id,
|
|
151
|
+
* data: { documentId: comment.documentId, excerpt: comment.text.slice(0, 280) },
|
|
152
|
+
* });
|
|
153
|
+
* if (!result.ok && result.retryable) {
|
|
154
|
+
* await queue.retryLater(subscription, comment);
|
|
155
|
+
* }
|
|
156
|
+
* ```
|
|
157
|
+
*
|
|
158
|
+
* @see https://docs.skybridge.tech/api-reference/register-event
|
|
159
|
+
*/
|
|
160
|
+
export async function deliverEvent(subscription, event) {
|
|
161
|
+
if (!(new Date(subscription.expiresAt).getTime() > Date.now())) {
|
|
162
|
+
return { ok: false, reason: "expired", retryable: false };
|
|
163
|
+
}
|
|
164
|
+
const body = JSON.stringify({
|
|
165
|
+
eventId: event.id,
|
|
166
|
+
name: event.name,
|
|
167
|
+
timestamp: (event.timestamp ?? new Date()).toISOString(),
|
|
168
|
+
data: event.data,
|
|
169
|
+
cursor: null,
|
|
170
|
+
});
|
|
171
|
+
if (Buffer.byteLength(body) > MAX_PAYLOAD_BYTES) {
|
|
172
|
+
throw new Error(`Event "${event.name}" payload exceeds ${MAX_PAYLOAD_BYTES} bytes; send a summary and expose a tool to fetch the rest.`);
|
|
173
|
+
}
|
|
174
|
+
const outcome = await signedPost(subscription, event.id, body);
|
|
175
|
+
if (outcome.ok) {
|
|
176
|
+
return { ok: true };
|
|
177
|
+
}
|
|
178
|
+
const status = outcome.status ?? 0;
|
|
179
|
+
return {
|
|
180
|
+
...outcome,
|
|
181
|
+
retryable: status !== 410 && status !== 413 && (status < 300 || status >= 400),
|
|
182
|
+
};
|
|
183
|
+
}
|
|
184
|
+
const verifiedCallbacks = new Map();
|
|
185
|
+
async function verifyCallback(subscriber, subscription) {
|
|
186
|
+
const key = `${subscriber}\n${subscription.url}`;
|
|
187
|
+
const now = Date.now();
|
|
188
|
+
if ((verifiedCallbacks.get(key) ?? 0) > now) {
|
|
189
|
+
return;
|
|
190
|
+
}
|
|
191
|
+
const challenge = randomBytes(24).toString("base64url");
|
|
192
|
+
const outcome = await signedPost(subscription, `msg_verification_${randomBytes(12).toString("hex")}`, JSON.stringify({ type: "verification", challenge }));
|
|
193
|
+
let echoed;
|
|
194
|
+
if (outcome.ok) {
|
|
195
|
+
try {
|
|
196
|
+
echoed = JSON.parse(outcome.body)?.challenge;
|
|
197
|
+
}
|
|
198
|
+
catch { }
|
|
199
|
+
}
|
|
200
|
+
const matched = typeof echoed === "string" &&
|
|
201
|
+
echoed.length === challenge.length &&
|
|
202
|
+
timingSafeEqual(Buffer.from(echoed), Buffer.from(challenge));
|
|
203
|
+
if (!matched) {
|
|
204
|
+
throw new ProtocolError(EVENTS_ERROR.CallbackEndpointError, "Callback endpoint verification failed", { reason: outcome.ok ? "challenge_failed" : outcome.reason });
|
|
205
|
+
}
|
|
206
|
+
for (const [cached, until] of verifiedCallbacks) {
|
|
207
|
+
if (until <= now) {
|
|
208
|
+
verifiedCallbacks.delete(cached);
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
verifiedCallbacks.set(key, now + VERIFICATION_CACHE_MS);
|
|
212
|
+
}
|
|
213
|
+
const SubscriptionKeySchema = z.object({
|
|
214
|
+
name: z.string(),
|
|
215
|
+
arguments: z.record(z.string(), z.unknown()).optional(),
|
|
216
|
+
delivery: z.object({ url: z.string() }),
|
|
217
|
+
});
|
|
218
|
+
const SubscribeParamsSchema = SubscriptionKeySchema.extend({
|
|
219
|
+
delivery: z.object({
|
|
220
|
+
mode: z.string().optional(),
|
|
221
|
+
url: z.string(),
|
|
222
|
+
secret: z.string(),
|
|
223
|
+
}),
|
|
224
|
+
cursor: z.string().nullable().optional(),
|
|
225
|
+
ttlMs: z.number().nullable().optional(),
|
|
226
|
+
});
|
|
227
|
+
/**
|
|
228
|
+
* The event types registered on one server, and the `events/*` handlers that
|
|
229
|
+
* serve them.
|
|
230
|
+
*
|
|
231
|
+
* @internal
|
|
232
|
+
*/
|
|
233
|
+
export class EventRegistry {
|
|
234
|
+
server;
|
|
235
|
+
events = new Map();
|
|
236
|
+
constructor(server) {
|
|
237
|
+
this.server = server;
|
|
238
|
+
}
|
|
239
|
+
add(config, hooks) {
|
|
240
|
+
if (this.events.has(config.name)) {
|
|
241
|
+
throw new Error(`Event "${config.name}" is already registered.`);
|
|
242
|
+
}
|
|
243
|
+
if (this.events.size === 0) {
|
|
244
|
+
this.install();
|
|
245
|
+
}
|
|
246
|
+
this.events.set(config.name, {
|
|
247
|
+
name: config.name,
|
|
248
|
+
description: config.description,
|
|
249
|
+
inputSchema: toStandardSchema(config.inputSchema ?? {}),
|
|
250
|
+
payloadSchema: toStandardSchema(config.payloadSchema),
|
|
251
|
+
_meta: config._meta,
|
|
252
|
+
hooks,
|
|
253
|
+
});
|
|
254
|
+
}
|
|
255
|
+
install() {
|
|
256
|
+
this.server.setRequestHandler("events/list", { params: z.object({ cursor: z.string().optional() }).optional() }, () => ({
|
|
257
|
+
events: [...this.events.values()].map((event) => ({
|
|
258
|
+
name: event.name,
|
|
259
|
+
...(event.description && { description: event.description }),
|
|
260
|
+
delivery: ["webhook"],
|
|
261
|
+
inputSchema: event.inputSchema["~standard"].jsonSchema.input({
|
|
262
|
+
target: "draft-2020-12",
|
|
263
|
+
}),
|
|
264
|
+
payloadSchema: event.payloadSchema["~standard"].jsonSchema.output({
|
|
265
|
+
target: "draft-2020-12",
|
|
266
|
+
}),
|
|
267
|
+
...(event._meta && { _meta: event._meta }),
|
|
268
|
+
})),
|
|
269
|
+
}));
|
|
270
|
+
this.server.setRequestHandler("events/subscribe", { params: SubscribeParamsSchema }, async (params, ctx) => {
|
|
271
|
+
if (params.delivery.mode && params.delivery.mode !== "webhook") {
|
|
272
|
+
throw new ProtocolError(EVENTS_ERROR.Unsupported, `Unsupported delivery mode: ${params.delivery.mode}`, { feature: "deliveryMode", value: params.delivery.mode });
|
|
273
|
+
}
|
|
274
|
+
if (!isValidSecret(params.delivery.secret)) {
|
|
275
|
+
throw new ProtocolError(INVALID_PARAMS, "delivery.secret must be whsec_ followed by base64 of 24 to 64 bytes");
|
|
276
|
+
}
|
|
277
|
+
const { event, subscriber, args, id, url } = await this.resolve(params, ctx);
|
|
278
|
+
const ttl = params.ttlMs === null ? MAX_TTL_MS : (params.ttlMs ?? DEFAULT_TTL_MS);
|
|
279
|
+
const subscription = {
|
|
280
|
+
id,
|
|
281
|
+
url,
|
|
282
|
+
secret: params.delivery.secret,
|
|
283
|
+
expiresAt: new Date(Date.now() + Math.min(Math.max(ttl, MIN_TTL_MS), MAX_TTL_MS)),
|
|
284
|
+
};
|
|
285
|
+
await verifyCallback(subscriber, subscription);
|
|
286
|
+
await event.hooks.onSubscribe(args, { subscription, extra: ctx });
|
|
287
|
+
return {
|
|
288
|
+
id,
|
|
289
|
+
refreshBefore: subscription.expiresAt.toISOString(),
|
|
290
|
+
cursor: null,
|
|
291
|
+
truncated: false,
|
|
292
|
+
};
|
|
293
|
+
});
|
|
294
|
+
this.server.setRequestHandler("events/unsubscribe", { params: SubscriptionKeySchema }, async (params, ctx) => {
|
|
295
|
+
const { event, args, id } = await this.resolve(params, ctx);
|
|
296
|
+
await event.hooks.onUnsubscribe(args, {
|
|
297
|
+
subscription: { id },
|
|
298
|
+
extra: ctx,
|
|
299
|
+
});
|
|
300
|
+
return {};
|
|
301
|
+
});
|
|
302
|
+
}
|
|
303
|
+
async resolve(params, ctx) {
|
|
304
|
+
const event = this.events.get(params.name);
|
|
305
|
+
if (!event) {
|
|
306
|
+
throw new ProtocolError(EVENTS_ERROR.NotFound, `Unknown event: ${params.name}`, { kind: "event" });
|
|
307
|
+
}
|
|
308
|
+
const url = checkCallbackUrl(params.delivery.url);
|
|
309
|
+
const subscriber = subscriberOf(ctx);
|
|
310
|
+
const rawArguments = params.arguments ?? {};
|
|
311
|
+
const args = await validate(event.inputSchema, rawArguments);
|
|
312
|
+
const hash = createHash("sha256")
|
|
313
|
+
.update(canonicalJson([subscriber, url, event.name, rawArguments]))
|
|
314
|
+
.digest("hex");
|
|
315
|
+
return { event, subscriber, args, url, id: `sub_${hash.slice(0, 32)}` };
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
//# sourceMappingURL=events.js.map
|