mirror of
https://github.com/outline/outline.git
synced 2026-11-21 05:24:03 +03:00
* feat: Support OAuth Client ID Metadata Documents for MCP clients MCP clients can send an https URL as their client_id. The server fetches the metadata document at that URL and caches one team-less client row per URL, so MCP works on the root domain without dynamic registration. Closes #14010 * fix: Address review findings for client ID metadata documents - Only count unexpired tokens when cleaning up metadata document clients - Reject backslashes, whitespace and trailing host dots in client_id URLs - Strip trailing dots before installation host comparisons - Type clientSecret as nullable * fix: Keep OAuth clients with pending authorization codes during cleanup * refactor: Simplify client ID metadata document handling - Gate metadata document fetches on the MCP preference inside the helper - Add isMCPClient getter and a shared client ID prefix constant - Enforce the team/metadata document CHECK in both directions - Index oauthClientId on OAuth token and code tables - Reuse parseDomain, clamp and time helpers * revert: Remove pending authorization code check from OAuth client cleanup * fix: Block all special-use addresses when fetching client metadata documents ALLOWED_PRIVATE_IP_ADDRESSES no longer applies to client ID metadata document requests (draft -02 section 8.6). The fetch wrapper takes an allowIPAddressList option to override the environment list. * fix: Reject empty userinfo in client metadata document URLs https://@host and https://:@host have a userinfo component that the URL parser drops, so check the raw authority (draft -02 section 3). * fix: Accept a root path in client metadata document URLs Draft -02 section 3 marks a root path as NOT RECOMMENDED, not invalid, so https://example.com/ is a valid client_id. A URL with no path is still rejected. * fix: Reject client metadata documents with private key material A jwks key with private or symmetric members (d, p, q, dp, dq, qi, oth, k) makes the document invalid, so it is not cached (draft -02 section 4.1). Public keys are still ignored. * fix: Respect no-cache, no-store and Age for client metadata documents no-store and no-cache now expire the cached document at once, so it is fetched again before the next authorization. Freshness from max-age or Expires (measured from Date) is reduced by Age before clamping (draft -02 section 5.2). * feat: Copy DCR and CIMD client logos to file storage in the background logo_uri was rendered directly on the consent screen, which lets the logo host track users and change the image at any time (draft -02 sections 8.8 and 9.2). A background task now fetches the logo with the strict fetch rules, accepts only PNG, JPEG, GIF and WebP by their leading bytes, and stores it content addressed in the public bucket. Requests never wait for the upload. * fix: Match loopback redirect URIs on any port Native apps such as Claude Code register http://localhost/callback and then listen on a free port, so an exact match rejected them. Loopback redirect URIs now match on any port (RFC 8252 section 7.3); the scheme, host and path must still match, and other URIs still match exactly. * fix: Only break the redirect URL mid-word on the consent screen break-all on the whole notice split words such as "continue" in the loopback warning. It now applies only to the redirect URL. * chore: Shorten the loopback warning on the consent screen * fix: Show the punycode host of client metadata documents on the consent screen A lookalike Unicode host was shown as written. Hostnames now come from a shared getHostname helper that returns the punycode form. * refactor: Move image type detection to ImageHelper and use it for avatars Avatars and integration logos copied from a URL are now stored only if they are PNG, JPEG, GIF or WebP, with the content type detected from the file data rather than the remote host. * fix: Address review findings for OAuth client logos and metadata caching - Count the time since the Date header as age when caching metadata documents, so a document is not cached past its Expires time - Log logo scheduling failures instead of failing registration requests - Run dynamic client registration in a transaction - Delete copied logos from storage when no client uses them * fix: Store one logo per OAuth client and return a distinct metadata document error - Logos are stored per client, so a file is only deleted when its own client stops using it. This removes the reference count and its race. - A metadata document that cannot be fetched or is invalid now returns invalid_client_metadata with the reason, not a 404. Network errors are only logged. - Move scheduleOptional to BaseTask so that any task can use it.
236 lines
7.1 KiB
TypeScript
236 lines
7.1 KiB
TypeScript
import { randomUUID } from "node:crypto";
|
|
import { subDays, subHours } from "date-fns";
|
|
import { Scope } from "@shared/types";
|
|
import { OAuthClient } from "@server/models";
|
|
import FileStorage from "@server/storage/files";
|
|
import {
|
|
buildMetadataDocumentOAuthClient,
|
|
buildOAuthAuthentication,
|
|
buildOAuthClient,
|
|
buildUser,
|
|
} from "@server/test/factories";
|
|
import CleanupDynamicOAuthClientsTask from "./CleanupDynamicOAuthClientsTask";
|
|
|
|
const clientExists = async (client: OAuthClient) => {
|
|
const found = await OAuthClient.unscoped().findByPk(client.id);
|
|
return !!found;
|
|
};
|
|
|
|
describe("CleanupDynamicOAuthClientsTask", () => {
|
|
it("should delete never-used dynamic clients older than 48 hours", async () => {
|
|
const client = await buildOAuthClient({
|
|
createdById: null,
|
|
createdAt: subDays(new Date(), 3),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(false);
|
|
});
|
|
|
|
it("should not delete never-used dynamic clients younger than 48 hours", async () => {
|
|
const client = await buildOAuthClient({
|
|
createdById: null,
|
|
createdAt: subHours(new Date(), 12),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(true);
|
|
});
|
|
|
|
it("should delete used dynamic clients inactive for more than 30 days", async () => {
|
|
const client = await buildOAuthClient({
|
|
createdById: null,
|
|
createdAt: subDays(new Date(), 60),
|
|
lastActiveAt: subDays(new Date(), 45),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(false);
|
|
});
|
|
|
|
it("should not delete used dynamic clients active within the last 30 days", async () => {
|
|
const client = await buildOAuthClient({
|
|
createdById: null,
|
|
createdAt: subDays(new Date(), 60),
|
|
lastActiveAt: subDays(new Date(), 5),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(true);
|
|
});
|
|
|
|
it("should not delete non-dynamic clients regardless of age or activity", async () => {
|
|
const user = await buildUser();
|
|
const client = await buildOAuthClient({
|
|
teamId: user.teamId,
|
|
createdAt: subDays(new Date(), 90),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(true);
|
|
});
|
|
|
|
it("should not delete recently active dynamic client even if created long ago", async () => {
|
|
const client = await buildOAuthClient({
|
|
createdById: null,
|
|
createdAt: subDays(new Date(), 90),
|
|
lastActiveAt: subDays(new Date(), 2),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(true);
|
|
});
|
|
|
|
it("should not delete a metadata document client with active tokens", async () => {
|
|
const user = await buildUser();
|
|
const client = await buildMetadataDocumentOAuthClient({
|
|
createdAt: subDays(new Date(), 90),
|
|
lastActiveAt: subDays(new Date(), 45),
|
|
});
|
|
await buildOAuthAuthentication({
|
|
user,
|
|
oauthClientId: client.id,
|
|
scope: [Scope.Read],
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(true);
|
|
});
|
|
|
|
it("should delete a metadata document client whose tokens have expired", async () => {
|
|
const user = await buildUser();
|
|
const client = await buildMetadataDocumentOAuthClient({
|
|
createdAt: subDays(new Date(), 90),
|
|
});
|
|
const authentication = await buildOAuthAuthentication({
|
|
user,
|
|
oauthClientId: client.id,
|
|
scope: [Scope.Read],
|
|
});
|
|
await authentication.update({
|
|
accessTokenExpiresAt: subDays(new Date(), 2),
|
|
refreshTokenExpiresAt: subDays(new Date(), 1),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(false);
|
|
});
|
|
|
|
it("should delete a metadata document client without tokens", async () => {
|
|
const client = await buildMetadataDocumentOAuthClient({
|
|
createdAt: subDays(new Date(), 3),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(false);
|
|
});
|
|
|
|
it("should not delete a new metadata document client without tokens", async () => {
|
|
const client = await buildMetadataDocumentOAuthClient({
|
|
createdAt: subHours(new Date(), 1),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(await clientExists(client)).toBe(true);
|
|
});
|
|
|
|
it("should delete the logo of a deleted client", async () => {
|
|
const deleteFile = vi.spyOn(FileStorage, "deleteFile");
|
|
const id = randomUUID();
|
|
const key = OAuthClient.logoKey(id, "b".repeat(64), "png");
|
|
await buildMetadataDocumentOAuthClient({
|
|
id,
|
|
avatarUrl: FileStorage.getUrlForKey(key),
|
|
createdAt: subDays(new Date(), 3),
|
|
});
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 100,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
expect(deleteFile).toHaveBeenCalledWith(key);
|
|
deleteFile.mockRestore();
|
|
});
|
|
|
|
it("should only run delete hooks for clients within the limit", async () => {
|
|
const deleteFile = vi.spyOn(FileStorage, "deleteFile");
|
|
const clients = await Promise.all(
|
|
[randomUUID(), randomUUID()].map((id) =>
|
|
buildOAuthClient({
|
|
id,
|
|
createdById: null,
|
|
avatarUrl: FileStorage.getUrlForKey(
|
|
OAuthClient.logoKey(id, "c".repeat(64), "png")
|
|
),
|
|
createdAt: subDays(new Date(), 3),
|
|
})
|
|
)
|
|
);
|
|
|
|
const task = new CleanupDynamicOAuthClientsTask();
|
|
await task.perform({
|
|
limit: 1,
|
|
partition: { partitionIndex: 0, partitionCount: 1 },
|
|
});
|
|
|
|
// Other tests can leave clients that match, so count only these.
|
|
const remaining = await Promise.all(clients.map(clientExists));
|
|
const deleted = remaining.filter((exists) => !exists).length;
|
|
expect(deleted).toBeLessThanOrEqual(1);
|
|
expect(deleteFile).toHaveBeenCalledTimes(deleted);
|
|
deleteFile.mockRestore();
|
|
});
|
|
});
|