mirror of
https://github.com/outline/outline.git
synced 2026-11-22 14:01:41 +03:00
* feat: Align MCP server and OAuth provider with newer MCP spec recommendations - Upgrade @modelcontextprotocol/sdk to 1.31.0 - Include iss in authorization responses and advertise support (RFC 9207) - Include required scopes in the WWW-Authenticate challenge on /mcp - Expose title, website and icons in the MCP server info - Centralise issuer, scopes, grant types and client type mapping in OAuthHelper * Remove OAuth authorization issuer changes
83 lines
2.8 KiB
TypeScript
83 lines
2.8 KiB
TypeScript
import type { Context } from "koa";
|
|
import type { OAuthClientValidation } from "@shared/validations";
|
|
import env from "@server/env";
|
|
|
|
type ClientType = (typeof OAuthClientValidation.clientTypes)[number];
|
|
|
|
export class OAuthHelper {
|
|
/**
|
|
* The OAuth scopes that the MCP endpoint advertises to clients.
|
|
*/
|
|
public static mcpScopes = ["read", "write"];
|
|
|
|
/**
|
|
* The OAuth grant types that the authorization server supports.
|
|
*/
|
|
public static grantTypes = ["authorization_code", "refresh_token"] as const;
|
|
|
|
/**
|
|
* The OAuth response types that the authorization server supports.
|
|
*/
|
|
public static responseTypes = ["code"] as const;
|
|
|
|
/**
|
|
* The client authentication methods that the token endpoint supports.
|
|
*/
|
|
public static tokenEndpointAuthMethods = [
|
|
"client_secret_post",
|
|
"none",
|
|
] as const;
|
|
|
|
/**
|
|
* Returns the client type that corresponds to a token endpoint
|
|
* authentication method. Clients that authenticate with a secret are
|
|
* confidential, all others are public.
|
|
*
|
|
* @param method - the token endpoint authentication method.
|
|
* @returns the client type.
|
|
*/
|
|
public static clientTypeForAuthMethod(
|
|
method: (typeof OAuthHelper.tokenEndpointAuthMethods)[number]
|
|
): ClientType {
|
|
return method === "client_secret_post" ? "confidential" : "public";
|
|
}
|
|
|
|
/**
|
|
* Returns the token endpoint authentication method that a client of the
|
|
* given type must use.
|
|
*
|
|
* @param clientType - the client type.
|
|
* @returns the token endpoint authentication method.
|
|
*/
|
|
public static authMethodForClientType(
|
|
clientType: ClientType
|
|
): (typeof OAuthHelper.tokenEndpointAuthMethods)[number] {
|
|
return clientType === "confidential" ? "client_secret_post" : "none";
|
|
}
|
|
|
|
/**
|
|
* Returns the origin that identifies this deployment as an OAuth issuer and
|
|
* resource server. Cloud-hosted deployments use the request origin so each
|
|
* team subdomain is its own issuer; self-hosted deployments use the
|
|
* configured URL so a reverse proxy that strips the port does not change it.
|
|
*
|
|
* @param ctx - the Koa request context.
|
|
* @returns the origin, e.g. "https://app.getoutline.com".
|
|
*/
|
|
public static getIssuer(ctx: Context): string {
|
|
return env.isCloudHosted ? ctx.request.URL.origin : new URL(env.URL).origin;
|
|
}
|
|
|
|
/**
|
|
* Builds the `WWW-Authenticate` challenge value for the MCP endpoint,
|
|
* pointing clients at the protected resource metadata document and the
|
|
* scopes required to use the resource (RFC 6750 §3, RFC 9728 §5.1).
|
|
*
|
|
* @param issuer - the origin of this deployment.
|
|
* @returns the header value for a Bearer challenge.
|
|
*/
|
|
public static mcpBearerChallenge(issuer: string): string {
|
|
return `Bearer resource_metadata="${issuer}/.well-known/oauth-protected-resource/mcp", scope="${OAuthHelper.mcpScopes.join(" ")}"`;
|
|
}
|
|
}
|