@mcpfn/auth 0.0.3 → 0.0.4

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/dist/index.d.cts CHANGED
@@ -46,10 +46,21 @@ interface DiagnoseMcpAuthorizationOptions {
46
46
  /** Read-only discovery probe. It does not open a browser or exchange credentials. */
47
47
  declare function diagnoseMcpAuthorization(target: string | URL, options?: DiagnoseMcpAuthorizationOptions): Promise<McpFnAuthorizationDiagnosticReport>;
48
48
 
49
+ type McpFnPrivateUseSchemePolicy = "disabled" | "rfc8252" | "compatible";
49
50
  interface McpFnRedirectPolicy {
50
51
  allowDynamicLoopbackPort?: boolean;
51
52
  allowLocalhostLoopback?: boolean;
53
+ /** @deprecated Use `privateUseSchemePolicy` instead. */
52
54
  allowPrivateUseSchemes?: boolean;
55
+ /**
56
+ * Private-use native-app redirect handling. Defaults to `rfc8252`.
57
+ * `disabled` rejects all private-use schemes. `rfc8252` requires a
58
+ * reverse-domain scheme. `compatible` additionally accepts well-formed
59
+ * non-web schemes such as Cursor's `cursor:` callback.
60
+ */
61
+ privateUseSchemePolicy?: McpFnPrivateUseSchemePolicy;
62
+ /** Lowercase scheme names, without `:`, admitted by `compatible` mode. */
63
+ compatiblePrivateUseSchemes?: ReadonlyArray<string>;
53
64
  }
54
65
  interface McpFnRedirectMatch {
55
66
  requested: string;
@@ -69,6 +80,8 @@ declare class McpFnRedirectMismatchError extends Error {
69
80
  declare function normalizeMcpRedirectUri(value: string | URL, policy?: McpFnRedirectPolicy): string;
70
81
  /** Exact matching, with RFC 8252 loopback ports enabled unless explicitly disabled. */
71
82
  declare function matchMcpRedirectUri(requested: string | URL, registeredRedirectUris: ReadonlyArray<string | URL>, policy?: McpFnRedirectPolicy): McpFnRedirectMatch;
83
+ /** True when a redirect needs `compatible` rather than RFC 8252 policy. */
84
+ declare function isMcpFnCompatiblePrivateUseRedirect(value: string | URL): boolean;
72
85
 
73
86
  type McpFnClientRegistrationSource = "pre-registered" | "dynamic" | "client-metadata-document" | "enterprise";
74
87
  interface McpFnNormalizedClientRegistration {
@@ -409,4 +422,4 @@ interface McpFnAuthProviderAdapter<TSession extends McpFnAuthSessionLike> {
409
422
  declare function createMcpFnAuthProviderAdapter<TSession extends McpFnAuthSessionLike>(options: McpFnAuthProviderAdapterOptions<TSession>): McpFnAuthProviderAdapter<TSession>;
410
423
  declare function createAuthProviderMcpHandler<TSession extends McpFnAuthSessionLike>(mcpHandler: McpFnWebStandardHandler, options: McpFnAuthProviderAdapterOptions<TSession>): (request: Request) => Promise<Response>;
411
424
 
412
- export { type DiagnoseMcpAuthorizationOptions, MCP_ENTERPRISE_MANAGED_AUTHORIZATION_EXTENSION_ID, MCP_ID_JAG_GRANT_PROFILE, type McpFnAuthProviderAdapter, type McpFnAuthProviderAdapterOptions, type McpFnAuthProviderLike, type McpFnAuthSessionLike, type McpFnAuthorizationCompatibilityOptions, type McpFnAuthorizationDiagnosticReport, type McpFnAuthorizationDiagnosticStep, type McpFnAuthorizationServerMetadata, type McpFnAuthorizationServerMetadataOptions, type McpFnBearerAuthProviderLike, type McpFnClientRegistrationSource, type McpFnEncryptedSessionRecord, type McpFnEncryptedSessionRecordStore, type McpFnHostedAuthorizationCapabilities, McpFnHostedAuthorizationError, type McpFnHostedClientAuthentication, type McpFnHostedClientRegistry, type McpFnHostedTokenAuthority, type McpFnHostedTokenEndpointAuthMethod, type McpFnHostedTokenSet, type McpFnNormalizedClientRegistration, type McpFnOAuthClientDiagnostic, type McpFnOAuthClientPhase, McpFnOAuthClientProvider, type McpFnOAuthClientProviderOptions, type McpFnOAuthCredentialScope, type McpFnOAuthResourceServerOptions, type McpFnOAuthSessionStore, type McpFnPrincipal, type McpFnProtectedResourceMetadata, type McpFnProtectedResourceOptions, type McpFnRedirectMatch, McpFnRedirectMismatchError, type McpFnRedirectPolicy, type McpFnRequestAuthProviderLike, type McpFnValidatedAuthorizationRequest, type McpFnWebStandardHandler, MemoryMcpFnOAuthSessionStore, bearerChallengeResponse, createAuthProviderMcpHandler, createEncryptedMcpFnOAuthSessionStore, createMcpAuthorizationCompatibilityHandler, createMcpAuthorizationServerMetadata, createMcpFnAuthProviderAdapter, createMcpFnOAuthClientProvider, createOAuthResourceServerHandler, createProtectedResourceMetadata, diagnoseMcpAuthorization, enterpriseManagedAuthorizationClientMetadata, matchMcpRedirectUri, normalizeMcpClientRegistration, normalizeMcpRedirectUri, protectedResourceMetadataUrl, readBearerToken, validateMcpAuthorizationRequest, withEnterpriseManagedAuthorization };
425
+ export { type DiagnoseMcpAuthorizationOptions, MCP_ENTERPRISE_MANAGED_AUTHORIZATION_EXTENSION_ID, MCP_ID_JAG_GRANT_PROFILE, type McpFnAuthProviderAdapter, type McpFnAuthProviderAdapterOptions, type McpFnAuthProviderLike, type McpFnAuthSessionLike, type McpFnAuthorizationCompatibilityOptions, type McpFnAuthorizationDiagnosticReport, type McpFnAuthorizationDiagnosticStep, type McpFnAuthorizationServerMetadata, type McpFnAuthorizationServerMetadataOptions, type McpFnBearerAuthProviderLike, type McpFnClientRegistrationSource, type McpFnEncryptedSessionRecord, type McpFnEncryptedSessionRecordStore, type McpFnHostedAuthorizationCapabilities, McpFnHostedAuthorizationError, type McpFnHostedClientAuthentication, type McpFnHostedClientRegistry, type McpFnHostedTokenAuthority, type McpFnHostedTokenEndpointAuthMethod, type McpFnHostedTokenSet, type McpFnNormalizedClientRegistration, type McpFnOAuthClientDiagnostic, type McpFnOAuthClientPhase, McpFnOAuthClientProvider, type McpFnOAuthClientProviderOptions, type McpFnOAuthCredentialScope, type McpFnOAuthResourceServerOptions, type McpFnOAuthSessionStore, type McpFnPrincipal, type McpFnPrivateUseSchemePolicy, type McpFnProtectedResourceMetadata, type McpFnProtectedResourceOptions, type McpFnRedirectMatch, McpFnRedirectMismatchError, type McpFnRedirectPolicy, type McpFnRequestAuthProviderLike, type McpFnValidatedAuthorizationRequest, type McpFnWebStandardHandler, MemoryMcpFnOAuthSessionStore, bearerChallengeResponse, createAuthProviderMcpHandler, createEncryptedMcpFnOAuthSessionStore, createMcpAuthorizationCompatibilityHandler, createMcpAuthorizationServerMetadata, createMcpFnAuthProviderAdapter, createMcpFnOAuthClientProvider, createOAuthResourceServerHandler, createProtectedResourceMetadata, diagnoseMcpAuthorization, enterpriseManagedAuthorizationClientMetadata, isMcpFnCompatiblePrivateUseRedirect, matchMcpRedirectUri, normalizeMcpClientRegistration, normalizeMcpRedirectUri, protectedResourceMetadataUrl, readBearerToken, validateMcpAuthorizationRequest, withEnterpriseManagedAuthorization };
package/dist/index.d.ts CHANGED
@@ -46,10 +46,21 @@ interface DiagnoseMcpAuthorizationOptions {
46
46
  /** Read-only discovery probe. It does not open a browser or exchange credentials. */
47
47
  declare function diagnoseMcpAuthorization(target: string | URL, options?: DiagnoseMcpAuthorizationOptions): Promise<McpFnAuthorizationDiagnosticReport>;
48
48
 
49
+ type McpFnPrivateUseSchemePolicy = "disabled" | "rfc8252" | "compatible";
49
50
  interface McpFnRedirectPolicy {
50
51
  allowDynamicLoopbackPort?: boolean;
51
52
  allowLocalhostLoopback?: boolean;
53
+ /** @deprecated Use `privateUseSchemePolicy` instead. */
52
54
  allowPrivateUseSchemes?: boolean;
55
+ /**
56
+ * Private-use native-app redirect handling. Defaults to `rfc8252`.
57
+ * `disabled` rejects all private-use schemes. `rfc8252` requires a
58
+ * reverse-domain scheme. `compatible` additionally accepts well-formed
59
+ * non-web schemes such as Cursor's `cursor:` callback.
60
+ */
61
+ privateUseSchemePolicy?: McpFnPrivateUseSchemePolicy;
62
+ /** Lowercase scheme names, without `:`, admitted by `compatible` mode. */
63
+ compatiblePrivateUseSchemes?: ReadonlyArray<string>;
53
64
  }
54
65
  interface McpFnRedirectMatch {
55
66
  requested: string;
@@ -69,6 +80,8 @@ declare class McpFnRedirectMismatchError extends Error {
69
80
  declare function normalizeMcpRedirectUri(value: string | URL, policy?: McpFnRedirectPolicy): string;
70
81
  /** Exact matching, with RFC 8252 loopback ports enabled unless explicitly disabled. */
71
82
  declare function matchMcpRedirectUri(requested: string | URL, registeredRedirectUris: ReadonlyArray<string | URL>, policy?: McpFnRedirectPolicy): McpFnRedirectMatch;
83
+ /** True when a redirect needs `compatible` rather than RFC 8252 policy. */
84
+ declare function isMcpFnCompatiblePrivateUseRedirect(value: string | URL): boolean;
72
85
 
73
86
  type McpFnClientRegistrationSource = "pre-registered" | "dynamic" | "client-metadata-document" | "enterprise";
74
87
  interface McpFnNormalizedClientRegistration {
@@ -409,4 +422,4 @@ interface McpFnAuthProviderAdapter<TSession extends McpFnAuthSessionLike> {
409
422
  declare function createMcpFnAuthProviderAdapter<TSession extends McpFnAuthSessionLike>(options: McpFnAuthProviderAdapterOptions<TSession>): McpFnAuthProviderAdapter<TSession>;
410
423
  declare function createAuthProviderMcpHandler<TSession extends McpFnAuthSessionLike>(mcpHandler: McpFnWebStandardHandler, options: McpFnAuthProviderAdapterOptions<TSession>): (request: Request) => Promise<Response>;
411
424
 
412
- export { type DiagnoseMcpAuthorizationOptions, MCP_ENTERPRISE_MANAGED_AUTHORIZATION_EXTENSION_ID, MCP_ID_JAG_GRANT_PROFILE, type McpFnAuthProviderAdapter, type McpFnAuthProviderAdapterOptions, type McpFnAuthProviderLike, type McpFnAuthSessionLike, type McpFnAuthorizationCompatibilityOptions, type McpFnAuthorizationDiagnosticReport, type McpFnAuthorizationDiagnosticStep, type McpFnAuthorizationServerMetadata, type McpFnAuthorizationServerMetadataOptions, type McpFnBearerAuthProviderLike, type McpFnClientRegistrationSource, type McpFnEncryptedSessionRecord, type McpFnEncryptedSessionRecordStore, type McpFnHostedAuthorizationCapabilities, McpFnHostedAuthorizationError, type McpFnHostedClientAuthentication, type McpFnHostedClientRegistry, type McpFnHostedTokenAuthority, type McpFnHostedTokenEndpointAuthMethod, type McpFnHostedTokenSet, type McpFnNormalizedClientRegistration, type McpFnOAuthClientDiagnostic, type McpFnOAuthClientPhase, McpFnOAuthClientProvider, type McpFnOAuthClientProviderOptions, type McpFnOAuthCredentialScope, type McpFnOAuthResourceServerOptions, type McpFnOAuthSessionStore, type McpFnPrincipal, type McpFnProtectedResourceMetadata, type McpFnProtectedResourceOptions, type McpFnRedirectMatch, McpFnRedirectMismatchError, type McpFnRedirectPolicy, type McpFnRequestAuthProviderLike, type McpFnValidatedAuthorizationRequest, type McpFnWebStandardHandler, MemoryMcpFnOAuthSessionStore, bearerChallengeResponse, createAuthProviderMcpHandler, createEncryptedMcpFnOAuthSessionStore, createMcpAuthorizationCompatibilityHandler, createMcpAuthorizationServerMetadata, createMcpFnAuthProviderAdapter, createMcpFnOAuthClientProvider, createOAuthResourceServerHandler, createProtectedResourceMetadata, diagnoseMcpAuthorization, enterpriseManagedAuthorizationClientMetadata, matchMcpRedirectUri, normalizeMcpClientRegistration, normalizeMcpRedirectUri, protectedResourceMetadataUrl, readBearerToken, validateMcpAuthorizationRequest, withEnterpriseManagedAuthorization };
425
+ export { type DiagnoseMcpAuthorizationOptions, MCP_ENTERPRISE_MANAGED_AUTHORIZATION_EXTENSION_ID, MCP_ID_JAG_GRANT_PROFILE, type McpFnAuthProviderAdapter, type McpFnAuthProviderAdapterOptions, type McpFnAuthProviderLike, type McpFnAuthSessionLike, type McpFnAuthorizationCompatibilityOptions, type McpFnAuthorizationDiagnosticReport, type McpFnAuthorizationDiagnosticStep, type McpFnAuthorizationServerMetadata, type McpFnAuthorizationServerMetadataOptions, type McpFnBearerAuthProviderLike, type McpFnClientRegistrationSource, type McpFnEncryptedSessionRecord, type McpFnEncryptedSessionRecordStore, type McpFnHostedAuthorizationCapabilities, McpFnHostedAuthorizationError, type McpFnHostedClientAuthentication, type McpFnHostedClientRegistry, type McpFnHostedTokenAuthority, type McpFnHostedTokenEndpointAuthMethod, type McpFnHostedTokenSet, type McpFnNormalizedClientRegistration, type McpFnOAuthClientDiagnostic, type McpFnOAuthClientPhase, McpFnOAuthClientProvider, type McpFnOAuthClientProviderOptions, type McpFnOAuthCredentialScope, type McpFnOAuthResourceServerOptions, type McpFnOAuthSessionStore, type McpFnPrincipal, type McpFnPrivateUseSchemePolicy, type McpFnProtectedResourceMetadata, type McpFnProtectedResourceOptions, type McpFnRedirectMatch, McpFnRedirectMismatchError, type McpFnRedirectPolicy, type McpFnRequestAuthProviderLike, type McpFnValidatedAuthorizationRequest, type McpFnWebStandardHandler, MemoryMcpFnOAuthSessionStore, bearerChallengeResponse, createAuthProviderMcpHandler, createEncryptedMcpFnOAuthSessionStore, createMcpAuthorizationCompatibilityHandler, createMcpAuthorizationServerMetadata, createMcpFnAuthProviderAdapter, createMcpFnOAuthClientProvider, createOAuthResourceServerHandler, createProtectedResourceMetadata, diagnoseMcpAuthorization, enterpriseManagedAuthorizationClientMetadata, isMcpFnCompatiblePrivateUseRedirect, matchMcpRedirectUri, normalizeMcpClientRegistration, normalizeMcpRedirectUri, protectedResourceMetadataUrl, readBearerToken, validateMcpAuthorizationRequest, withEnterpriseManagedAuthorization };
package/dist/index.js CHANGED
@@ -169,7 +169,7 @@ function normalizeMcpRedirectUri(value, policy = {}) {
169
169
  }
170
170
  if (url.protocol === "https:") return url.toString();
171
171
  if (url.protocol === "http:" && isLoopback(url, policy)) return url.toString();
172
- if (policy.allowPrivateUseSchemes === true && isReverseDomainPrivateUseScheme(url.protocol)) {
172
+ if (isAllowedPrivateUseRedirect(url, policy)) {
173
173
  return url.toString();
174
174
  }
175
175
  throw new McpFnRedirectMismatchError(url.toString());
@@ -195,6 +195,68 @@ function matchMcpRedirectUri(requested, registeredRedirectUris, policy = {}) {
195
195
  }
196
196
  throw new McpFnRedirectMismatchError(actual.toString());
197
197
  }
198
+ function isMcpFnCompatiblePrivateUseRedirect(value) {
199
+ let url;
200
+ try {
201
+ url = new URL(value.toString());
202
+ } catch {
203
+ return false;
204
+ }
205
+ return isSafePrivateUseRedirect(url) && !isReverseDomainPrivateUseScheme(url.protocol);
206
+ }
207
+ var unsafeNativeProtocols = /* @__PURE__ */ new Set([
208
+ "about:",
209
+ "android-app:",
210
+ "blob:",
211
+ "chrome:",
212
+ "chrome-extension:",
213
+ "data:",
214
+ "facetime:",
215
+ "file:",
216
+ "filesystem:",
217
+ "ftp:",
218
+ "ftps:",
219
+ "geo:",
220
+ "gopher:",
221
+ "intent:",
222
+ "javascript:",
223
+ "ldap:",
224
+ "ldaps:",
225
+ "mailto:",
226
+ "market:",
227
+ "ms-settings:",
228
+ "ms-windows-store:",
229
+ "nntp:",
230
+ "resource:",
231
+ "sftp:",
232
+ "shell:",
233
+ "smb:",
234
+ "sms:",
235
+ "ssh:",
236
+ "tel:",
237
+ "urn:",
238
+ "vbscript:",
239
+ "view-source:",
240
+ "ws:",
241
+ "wss:"
242
+ ]);
243
+ function isAllowedPrivateUseRedirect(url, policy) {
244
+ const effectivePolicy = policy.privateUseSchemePolicy ?? (policy.allowPrivateUseSchemes === false ? "disabled" : "rfc8252");
245
+ if (effectivePolicy === "disabled") return false;
246
+ if (!isSafePrivateUseRedirect(url)) return false;
247
+ if (isReverseDomainPrivateUseScheme(url.protocol)) return true;
248
+ if (effectivePolicy !== "compatible") return false;
249
+ const scheme = url.protocol.slice(0, -1).toLowerCase();
250
+ return policy.compatiblePrivateUseSchemes?.some(
251
+ (candidate) => candidate === candidate.toLowerCase() && candidate === scheme
252
+ ) === true;
253
+ }
254
+ function isSafePrivateUseRedirect(url) {
255
+ if (url.username || url.password || url.hash || url.hostname.includes("*") || url.protocol === "http:" || url.protocol === "https:" || unsafeNativeProtocols.has(url.protocol) || !url.hostname && !url.pathname.startsWith("/")) {
256
+ return false;
257
+ }
258
+ return true;
259
+ }
198
260
  function isReverseDomainPrivateUseScheme(protocol) {
199
261
  const scheme = protocol.slice(0, -1).toLowerCase();
200
262
  return /^[a-z](?:[a-z0-9-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)+$/.test(
@@ -577,9 +639,22 @@ async function handleRegistrationRequest(options, request) {
577
639
  redirectPolicy: options.redirectPolicy
578
640
  });
579
641
  assertCompatibleClientRegistration(registration, supportedMethods, options.supportedScopes);
642
+ const compatibilityRedirects = registration.redirectUris.filter(
643
+ isMcpFnCompatiblePrivateUseRedirect
644
+ );
645
+ const compatibilityRedirectSchemes = unique(
646
+ compatibilityRedirects.map(
647
+ (redirect) => new URL(redirect).protocol.slice(0, -1)
648
+ )
649
+ );
580
650
  await emit(options, "client-registration", "succeeded", void 0, {
581
651
  clientId: registration.clientId,
582
- source: registration.source
652
+ source: registration.source,
653
+ ...compatibilityRedirectSchemes.length > 0 ? {
654
+ privateUseSchemePolicy: "compatible",
655
+ compatibilityRedirectSchemes,
656
+ compatibilityRedirectCount: compatibilityRedirects.length
657
+ } : {}
583
658
  });
584
659
  return json2(201, {
585
660
  ...registration.metadata,
@@ -1909,6 +1984,6 @@ function defaultPrincipal(session) {
1909
1984
  };
1910
1985
  }
1911
1986
 
1912
- export { MCP_ENTERPRISE_MANAGED_AUTHORIZATION_EXTENSION_ID, MCP_ID_JAG_GRANT_PROFILE, McpFnHostedAuthorizationError, McpFnOAuthClientProvider, McpFnRedirectMismatchError, MemoryMcpFnOAuthSessionStore, bearerChallengeResponse, createAuthProviderMcpHandler, createEncryptedMcpFnOAuthSessionStore, createMcpAuthorizationCompatibilityHandler, createMcpAuthorizationServerMetadata, createMcpFnAuthProviderAdapter, createMcpFnOAuthClientProvider, createOAuthResourceServerHandler, createProtectedResourceMetadata, diagnoseMcpAuthorization, enterpriseManagedAuthorizationClientMetadata, matchMcpRedirectUri, normalizeMcpClientRegistration, normalizeMcpRedirectUri, protectedResourceMetadataUrl, readBearerToken, validateMcpAuthorizationRequest, withEnterpriseManagedAuthorization };
1987
+ export { MCP_ENTERPRISE_MANAGED_AUTHORIZATION_EXTENSION_ID, MCP_ID_JAG_GRANT_PROFILE, McpFnHostedAuthorizationError, McpFnOAuthClientProvider, McpFnRedirectMismatchError, MemoryMcpFnOAuthSessionStore, bearerChallengeResponse, createAuthProviderMcpHandler, createEncryptedMcpFnOAuthSessionStore, createMcpAuthorizationCompatibilityHandler, createMcpAuthorizationServerMetadata, createMcpFnAuthProviderAdapter, createMcpFnOAuthClientProvider, createOAuthResourceServerHandler, createProtectedResourceMetadata, diagnoseMcpAuthorization, enterpriseManagedAuthorizationClientMetadata, isMcpFnCompatiblePrivateUseRedirect, matchMcpRedirectUri, normalizeMcpClientRegistration, normalizeMcpRedirectUri, protectedResourceMetadataUrl, readBearerToken, validateMcpAuthorizationRequest, withEnterpriseManagedAuthorization };
1913
1988
  //# sourceMappingURL=index.js.map
1914
1989
  //# sourceMappingURL=index.js.map