@payloadcms/plugin-mcp 4.0.0-internal.a2d053c → 4.0.0-internal.a5acc33

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.
Files changed (42) hide show
  1. package/dist/endpoint/access.d.ts.map +1 -1
  2. package/dist/endpoint/access.js +3 -23
  3. package/dist/endpoint/access.js.map +1 -1
  4. package/dist/endpoint/index.d.ts.map +1 -1
  5. package/dist/endpoint/index.js +0 -13
  6. package/dist/endpoint/index.js.map +1 -1
  7. package/dist/index.d.ts +2 -10
  8. package/dist/index.d.ts.map +1 -1
  9. package/dist/index.js +2 -15
  10. package/dist/index.js.map +1 -1
  11. package/dist/mcp/sanitizeMCPConfig.d.ts.map +1 -1
  12. package/dist/mcp/sanitizeMCPConfig.js +0 -3
  13. package/dist/mcp/sanitizeMCPConfig.js.map +1 -1
  14. package/dist/types.d.ts +0 -82
  15. package/dist/types.d.ts.map +1 -1
  16. package/dist/types.js.map +1 -1
  17. package/package.json +3 -3
  18. package/src/endpoint/access.ts +3 -22
  19. package/src/endpoint/index.ts +0 -8
  20. package/src/index.ts +4 -39
  21. package/src/mcp/sanitizeMCPConfig.ts +0 -1
  22. package/src/types.ts +0 -83
  23. package/dist/endpoint/oauth.d.ts +0 -39
  24. package/dist/endpoint/oauth.d.ts.map +0 -1
  25. package/dist/endpoint/oauth.js +0 -94
  26. package/dist/endpoint/oauth.js.map +0 -1
  27. package/dist/endpoint/oauthLoginToken.d.ts +0 -21
  28. package/dist/endpoint/oauthLoginToken.d.ts.map +0 -1
  29. package/dist/endpoint/oauthLoginToken.js +0 -79
  30. package/dist/endpoint/oauthLoginToken.js.map +0 -1
  31. package/dist/endpoint/oauthServer.d.ts +0 -12
  32. package/dist/endpoint/oauthServer.d.ts.map +0 -1
  33. package/dist/endpoint/oauthServer.js +0 -362
  34. package/dist/endpoint/oauthServer.js.map +0 -1
  35. package/dist/utils/seal.d.ts +0 -18
  36. package/dist/utils/seal.d.ts.map +0 -1
  37. package/dist/utils/seal.js +0 -27
  38. package/dist/utils/seal.js.map +0 -1
  39. package/src/endpoint/oauth.ts +0 -92
  40. package/src/endpoint/oauthLoginToken.ts +0 -91
  41. package/src/endpoint/oauthServer.ts +0 -396
  42. package/src/utils/seal.ts +0 -46
@@ -1,396 +0,0 @@
1
- import type {
2
- OAuthClientInformationFull,
3
- OAuthTokens,
4
- OpenIdProviderDiscoveryMetadata,
5
- } from '@modelcontextprotocol/server'
6
- import type { Endpoint, PayloadHandler, PayloadRequest } from 'payload'
7
-
8
- import { OAuthErrorCode } from '@modelcontextprotocol/server'
9
- import { createHash } from 'crypto'
10
- import { formatAdminURL } from 'payload/shared'
11
-
12
- import type { MCPBuiltinOAuthConfig, MCPOAuthTokens } from '../types.js'
13
-
14
- import { getPluginConfig } from '../utils/getPluginConfig.js'
15
- import { seal, unseal } from '../utils/seal.js'
16
- import { getMCPURL } from './oauth.js'
17
- import { issueLoginToken, refreshLoginToken } from './oauthLoginToken.js'
18
-
19
- type Client = { name: string; redirectURIs: string[] }
20
-
21
- type Consent = {
22
- clientID: string
23
- codeChallenge: string
24
- collection: string
25
- redirectURI: string
26
- state: null | string
27
- userID: number | string
28
- }
29
-
30
- type Code = {
31
- clientID: string
32
- codeChallenge: string
33
- redirectURI: string
34
- tokens: MCPOAuthTokens
35
- }
36
-
37
- type RefreshToken = {
38
- clientID: string
39
- refreshToken: string
40
- }
41
-
42
- /**
43
- * Turns Payload into the OAuth authorization server for MCP clients when `oauth.type` is
44
- * `'builtin'`. Clients register, the user allows them after logging in to the admin panel, and
45
- * the client receives the tokens `issueToken` creates.
46
- *
47
- * Clients, consent forms, authorization codes, and refresh tokens are encrypted and handed to the
48
- * client instead of being stored. Only the default tokens write to the database, to the user's
49
- * login sessions.
50
- */
51
- export const oauthServerEndpoints: Endpoint[] = [
52
- {
53
- disableAuth: true,
54
- handler: (req) => withIssuer(req, (issuer) => metadataResponse(issuer)),
55
- method: 'get',
56
- // OpenID discovery is the only metadata location MCP clients check below the issuer's path,
57
- // which lets this work under /api without a route at the site root
58
- path: '/mcp/oauth/.well-known/openid-configuration',
59
- },
60
- {
61
- disableAuth: true,
62
- handler: (req) => withIssuer(req, () => Response.json({ keys: [] })),
63
- method: 'get',
64
- path: '/mcp/oauth/jwks',
65
- },
66
- {
67
- disableAuth: true,
68
- handler: (req) => withIssuer(req, () => register(req)),
69
- method: 'post',
70
- path: '/mcp/oauth/register',
71
- },
72
- {
73
- handler: (req) => withIssuer(req, () => authorize(req)),
74
- method: 'get',
75
- path: '/mcp/oauth/authorize',
76
- },
77
- {
78
- handler: (req) => withIssuer(req, () => approve(req)),
79
- method: 'post',
80
- path: '/mcp/oauth/authorize',
81
- },
82
- {
83
- disableAuth: true,
84
- handler: (req) => withIssuer(req, () => token(req)),
85
- method: 'post',
86
- path: '/mcp/oauth/token',
87
- },
88
- ]
89
-
90
- /** The authorization server URL, or `undefined` when Payload isn't the authorization server. */
91
- const getIssuer = (req: PayloadRequest): string | undefined =>
92
- getPluginConfig({ config: req.payload.config }).oauth?.type === 'builtin'
93
- ? `${getMCPURL({ config: req.payload.config, url: req.url! })}/oauth`
94
- : undefined
95
-
96
- const withIssuer = (
97
- req: PayloadRequest,
98
- handler: (issuer: string) => Promise<Response> | Response,
99
- ): Promise<Response> | Response => {
100
- const issuer = getIssuer(req)
101
- return issuer ? handler(issuer) : new Response(null, { status: 404 })
102
- }
103
-
104
- /**
105
- * The user logged in to this browser, who can allow MCP clients. Tokens and API keys in the
106
- * `Authorization` header can't, or an MCP client could use its access token to approve itself a
107
- * new, separate login.
108
- */
109
- const getBrowserUser = (req: PayloadRequest): PayloadRequest['user'] =>
110
- req.headers.has('Authorization') ? null : req.user
111
-
112
- const metadataResponse = (issuer: string): Response =>
113
- Response.json(
114
- {
115
- authorization_endpoint: `${issuer}/authorize`,
116
- code_challenge_methods_supported: ['S256'],
117
- grant_types_supported: ['authorization_code', 'refresh_token'],
118
- // Required by OpenID discovery. No ID tokens are issued.
119
- id_token_signing_alg_values_supported: ['RS256'],
120
- issuer,
121
- jwks_uri: `${issuer}/jwks`,
122
- registration_endpoint: `${issuer}/register`,
123
- response_types_supported: ['code'],
124
- subject_types_supported: ['public'],
125
- token_endpoint: `${issuer}/token`,
126
- token_endpoint_auth_methods_supported: ['none'],
127
- } satisfies OpenIdProviderDiscoveryMetadata,
128
- // Not cached, since without `serverURL` its URLs come from the request
129
- { headers: { 'Access-Control-Allow-Origin': '*', 'Cache-Control': 'no-store' } },
130
- )
131
-
132
- const register: PayloadHandler = async (req) => {
133
- const { client_name, redirect_uris } = await req.json!().catch(() => ({}))
134
-
135
- if (
136
- !Array.isArray(redirect_uris) ||
137
- !redirect_uris.length ||
138
- !redirect_uris.every(
139
- (uri) => typeof uri === 'string' && URL.canParse(uri) && !uri.includes('#'),
140
- )
141
- ) {
142
- return Response.json({ error: OAuthErrorCode.InvalidRedirectUri }, { status: 400 })
143
- }
144
-
145
- const client: Client = {
146
- name: typeof client_name === 'string' ? client_name : 'An MCP client',
147
- redirectURIs: redirect_uris,
148
- }
149
-
150
- return Response.json(
151
- {
152
- client_id: seal({ type: 'client', data: client, req }),
153
- client_name: client.name,
154
- grant_types: ['authorization_code', 'refresh_token'],
155
- redirect_uris: client.redirectURIs,
156
- response_types: ['code'],
157
- token_endpoint_auth_method: 'none',
158
- } satisfies OAuthClientInformationFull,
159
- { status: 201 },
160
- )
161
- }
162
-
163
- const authorize: PayloadHandler = (req) => {
164
- const url = new URL(req.url!)
165
- const params = url.searchParams
166
- const clientID = params.get('client_id')
167
- const client = unseal<Client>({ type: 'client', req, value: clientID })
168
- const redirectURI = params.get('redirect_uri')
169
-
170
- // Never redirect to an address the client didn't register
171
- if (!client || !redirectURI || !client.redirectURIs.includes(redirectURI)) {
172
- return page({
173
- content: '<p>Start the sign-in again from your MCP client.</p>',
174
- status: 400,
175
- title: 'This sign-in link is invalid',
176
- })
177
- }
178
-
179
- const state = params.get('state')
180
- const codeChallenge = params.get('code_challenge')
181
-
182
- if (
183
- params.get('response_type') !== 'code' ||
184
- params.get('code_challenge_method') !== 'S256' ||
185
- !codeChallenge
186
- ) {
187
- return redirect({ params: { error: OAuthErrorCode.InvalidRequest, state }, redirectURI })
188
- }
189
-
190
- const user = getBrowserUser(req)
191
-
192
- if (!user) {
193
- const loginURL = formatAdminURL({ adminRoute: req.payload.config.routes.admin, path: '/login' })
194
-
195
- return new Response(null, {
196
- headers: {
197
- Location: `${loginURL}?redirect=${encodeURIComponent(url.pathname + url.search)}`,
198
- },
199
- status: 302,
200
- })
201
- }
202
-
203
- const consent: Consent = {
204
- clientID: clientID!,
205
- codeChallenge,
206
- collection: user.collection,
207
- redirectURI,
208
- state,
209
- userID: user.id,
210
- }
211
-
212
- return page({
213
- content: `<p>It will be able to use this app's MCP tools as ${escapeHTML(String(user.email ?? user.id))}, and you will return to ${escapeHTML(new URL(redirectURI).host || redirectURI)}.</p>
214
- <form method="post">
215
- <input name="consent" type="hidden" value="${seal({ type: 'consent', data: consent, expiresIn: 20 * 60 * 60, req })}">
216
- <button name="decision" type="submit" value="allow">Allow</button>
217
- <button name="decision" type="submit" value="deny">Deny</button>
218
- </form>`,
219
- status: 200,
220
- title: `Allow ${client.name} to use your account?`,
221
- })
222
- }
223
-
224
- const approve: PayloadHandler = async (req) => {
225
- const form = new URLSearchParams(await req.text!())
226
- const consent = unseal<Consent>({ type: 'consent', req, value: form.get('consent') })
227
- const user = getBrowserUser(req)
228
-
229
- // The form is only valid for the user it was shown to
230
- if (!consent || user?.id !== consent.userID || user.collection !== consent.collection) {
231
- return page({
232
- content: '<p>Start the sign-in again from your MCP client.</p>',
233
- status: 400,
234
- title: 'This sign-in request expired',
235
- })
236
- }
237
-
238
- const { clientID, codeChallenge, redirectURI, state } = consent
239
-
240
- if (form.get('decision') !== 'allow') {
241
- return redirect({ params: { error: OAuthErrorCode.AccessDenied, state }, redirectURI })
242
- }
243
-
244
- const code: Code = {
245
- clientID,
246
- codeChallenge,
247
- redirectURI,
248
- tokens: await getTokenHooks(req).issueToken({ req }),
249
- }
250
-
251
- return redirect({
252
- params: { code: seal({ type: 'code', data: code, expiresIn: 60, req }), state },
253
- redirectURI,
254
- })
255
- }
256
-
257
- const token: PayloadHandler = async (req) => {
258
- const form = new URLSearchParams(await req.text!())
259
- const clientID = form.get('client_id')
260
- const tokens =
261
- clientID &&
262
- (form.get('grant_type') === 'refresh_token'
263
- ? await refresh({ clientID, form, req })
264
- : redeemCode({ clientID, form, req }))
265
-
266
- if (!clientID || !tokens) {
267
- return Response.json({ error: OAuthErrorCode.InvalidGrant }, { status: 400 })
268
- }
269
-
270
- return Response.json(
271
- {
272
- access_token: tokens.accessToken,
273
- expires_in: tokens.expiresIn,
274
- refresh_token:
275
- tokens.refreshToken &&
276
- seal({
277
- type: 'refresh',
278
- data: { clientID, refreshToken: tokens.refreshToken } satisfies RefreshToken,
279
- req,
280
- }),
281
- token_type: 'Bearer',
282
- } satisfies OAuthTokens,
283
- { headers: { 'Cache-Control': 'no-store' } },
284
- )
285
- }
286
-
287
- const redeemCode = ({
288
- clientID,
289
- form,
290
- req,
291
- }: {
292
- clientID: string
293
- form: URLSearchParams
294
- req: PayloadRequest
295
- }): MCPOAuthTokens | undefined => {
296
- const code = unseal<Code>({ type: 'code', req, value: form.get('code') })
297
-
298
- if (
299
- form.get('grant_type') === 'authorization_code' &&
300
- code?.clientID === clientID &&
301
- code.redirectURI === form.get('redirect_uri') &&
302
- // PKCE: only the client that started the sign-in knows the verifier
303
- createHash('sha256')
304
- .update(form.get('code_verifier') ?? '')
305
- .digest('base64url') === code.codeChallenge
306
- ) {
307
- return code.tokens
308
- }
309
- }
310
-
311
- const refresh = async ({
312
- clientID,
313
- form,
314
- req,
315
- }: {
316
- clientID: string
317
- form: URLSearchParams
318
- req: PayloadRequest
319
- }): Promise<MCPOAuthTokens | null | undefined> => {
320
- const refreshToken = unseal<RefreshToken>({
321
- type: 'refresh',
322
- req,
323
- value: form.get('refresh_token'),
324
- })
325
-
326
- // Only the client a refresh token was issued to can use it
327
- if (refreshToken?.clientID === clientID) {
328
- return await getTokenHooks(req).refreshToken?.({
329
- refreshToken: refreshToken.refreshToken,
330
- req,
331
- })
332
- }
333
- }
334
-
335
- /** `issueToken` and `refreshToken`, or the defaults for Payload login tokens. */
336
- const getTokenHooks = (req: PayloadRequest) => {
337
- const oauth = getPluginConfig({ config: req.payload.config }).oauth as MCPBuiltinOAuthConfig
338
-
339
- return oauth.issueToken
340
- ? { issueToken: oauth.issueToken, refreshToken: oauth.refreshToken }
341
- : { issueToken: issueLoginToken, refreshToken: refreshLoginToken }
342
- }
343
-
344
- const redirect = ({
345
- params,
346
- redirectURI,
347
- }: {
348
- params: Record<string, null | string>
349
- redirectURI: string
350
- }): Response => {
351
- const location = new URL(redirectURI)
352
-
353
- for (const [key, value] of Object.entries(params)) {
354
- if (value) {
355
- location.searchParams.set(key, value)
356
- }
357
- }
358
-
359
- return new Response(null, { headers: { Location: location.href }, status: 302 })
360
- }
361
-
362
- const page = ({
363
- content,
364
- status,
365
- title,
366
- }: {
367
- content: string
368
- status: number
369
- title: string
370
- }): Response =>
371
- new Response(
372
- `<!doctype html>
373
- <html lang="en">
374
- <head>
375
- <meta charset="utf-8">
376
- <meta name="viewport" content="width=device-width, initial-scale=1">
377
- <title>${escapeHTML(title)}</title>
378
- <style>
379
- body { font-family: system-ui, sans-serif; margin: 4rem auto; max-width: 32rem; overflow-wrap: anywhere; padding: 0 1rem }
380
- button { font: inherit; margin-inline-end: 0.5rem; padding: 0.5rem 1rem }
381
- </style>
382
- </head>
383
- <body><h1>${escapeHTML(title)}</h1>${content}</body>
384
- </html>`,
385
- {
386
- headers: {
387
- // Stop other sites from framing the page to trick users into clicking Allow
388
- 'Content-Security-Policy': "frame-ancestors 'none'",
389
- 'Content-Type': 'text/html; charset=utf-8',
390
- },
391
- status,
392
- },
393
- )
394
-
395
- const escapeHTML = (value: string): string =>
396
- value.replace(/[&<>"']/g, (character) => `&#${character.charCodeAt(0)};`)
package/src/utils/seal.ts DELETED
@@ -1,46 +0,0 @@
1
- import type { PayloadRequest } from 'payload'
2
-
3
- /**
4
- * Encrypts data for the client to hold, so it doesn't need to be stored. `type` keeps one kind
5
- * from being used as another, e.g. a client ID as an authorization code.
6
- */
7
- export const seal = ({
8
- type,
9
- data,
10
- expiresIn,
11
- req,
12
- }: {
13
- data: object
14
- /** Seconds */
15
- expiresIn?: number
16
- req: PayloadRequest
17
- type: string
18
- }): string =>
19
- req.payload.encrypt(
20
- JSON.stringify({ ...data, type, exp: expiresIn && Date.now() + expiresIn * 1000 }),
21
- )
22
-
23
- export const unseal = <T>({
24
- type,
25
- req,
26
- value,
27
- }: {
28
- req: PayloadRequest
29
- type: string
30
- value: null | string
31
- }): T | undefined => {
32
- // Only the v1 format is authenticated. Older formats decrypt anything without an error.
33
- if (!value?.startsWith('v1:')) {
34
- return undefined
35
- }
36
-
37
- try {
38
- // Previous secrets can be public, like a default secret from source code, so only client IDs
39
- // accept them. Client IDs grant nothing, and this keeps clients registered when the secret changes.
40
- const secret = type === 'client' ? undefined : req.payload.config.secret
41
- const data = JSON.parse(req.payload.decrypt(value, { secret }))
42
- return data.type === type && (!data.exp || data.exp > Date.now()) ? data : undefined
43
- } catch {
44
- return undefined
45
- }
46
- }