diff --git a/apps/web/sentry.edge.config.ts b/apps/web/sentry.edge.config.ts index ad529a59..8851c854 100644 --- a/apps/web/sentry.edge.config.ts +++ b/apps/web/sentry.edge.config.ts @@ -6,6 +6,7 @@ import * as Sentry from "@sentry/nextjs"; import { SENTRY_DSN } from "./src/constants/sentry"; +import { scrubSensitiveData } from "./src/utils/sentryScrub"; Sentry.init({ // 개발 배포는 NEXT_PUBLIC_SENTRY_DSN으로 개발용 프로젝트에 보낸다 (기본값은 운영 DSN) @@ -26,4 +27,8 @@ Sentry.init({ // Enable sending user PII (Personally Identifiable Information) // https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/options/#sendDefaultPii sendDefaultPii: true, + + // PII 전송은 켜 두되, 인증 쿠키·토큰·일회용 로그인 code는 보내기 전에 지움 (GLB-182) + beforeSend: scrubSensitiveData, + beforeSendTransaction: scrubSensitiveData, }); diff --git a/apps/web/sentry.server.config.ts b/apps/web/sentry.server.config.ts index 2b2006df..27f3ec4b 100644 --- a/apps/web/sentry.server.config.ts +++ b/apps/web/sentry.server.config.ts @@ -5,6 +5,7 @@ import * as Sentry from "@sentry/nextjs"; import { SENTRY_DSN } from "./src/constants/sentry"; +import { scrubSensitiveData } from "./src/utils/sentryScrub"; Sentry.init({ // 개발 배포는 NEXT_PUBLIC_SENTRY_DSN으로 개발용 프로젝트에 보낸다 (기본값은 운영 DSN) @@ -25,4 +26,8 @@ Sentry.init({ // Enable sending user PII (Personally Identifiable Information) // https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/options/#sendDefaultPii sendDefaultPii: true, + + // PII 전송은 켜 두되, 인증 쿠키·토큰·일회용 로그인 code는 보내기 전에 지움 (GLB-182) + beforeSend: scrubSensitiveData, + beforeSendTransaction: scrubSensitiveData, }); diff --git a/apps/web/src/instrumentation-client.ts b/apps/web/src/instrumentation-client.ts index 90c50462..219db065 100644 --- a/apps/web/src/instrumentation-client.ts +++ b/apps/web/src/instrumentation-client.ts @@ -6,6 +6,7 @@ import * as Sentry from "@sentry/nextjs"; import { env } from "@/config/env"; import { SENTRY_DSN } from "@/constants/sentry"; +import { scrubSensitiveData } from "@/utils/sentryScrub"; Sentry.init({ // 개발 배포는 NEXT_PUBLIC_SENTRY_DSN으로 개발용 프로젝트에 보낸다 (기본값은 운영 DSN) @@ -39,6 +40,10 @@ Sentry.init({ // 사용자 PII(개인 식별 정보) 전송을 활성화한다 // https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/options/#sendDefaultPii sendDefaultPii: true, + + // PII 전송은 켜 두되, 인증 쿠키·토큰·일회용 로그인 code는 보내기 전에 지움 (GLB-182) + beforeSend: scrubSensitiveData, + beforeSendTransaction: scrubSensitiveData, }); export const onRouterTransitionStart = Sentry.captureRouterTransitionStart; diff --git a/apps/web/src/middleware.ts b/apps/web/src/middleware.ts index 4d8b5731..486a01e2 100644 --- a/apps/web/src/middleware.ts +++ b/apps/web/src/middleware.ts @@ -15,6 +15,9 @@ const PUBLIC_PATHS: readonly string[] = [ "/assets", "/data", "/favicon.png", + // 브라우저가 로그인 전에도 탭 아이콘을 요청하므로 로그인 화면으로 보내지 않음 (GLB-244) + "/favicon.svg", + "/favicon.ico", "/robots.txt", "/sitemap.xml", "/public", diff --git a/apps/web/src/utils/sentryScrub.test.ts b/apps/web/src/utils/sentryScrub.test.ts new file mode 100644 index 00000000..f43cc4b8 --- /dev/null +++ b/apps/web/src/utils/sentryScrub.test.ts @@ -0,0 +1,62 @@ +import type { Event } from "@sentry/nextjs"; +import { describe, expect, it } from "vitest"; + +import { maskSensitiveUrl, scrubSensitiveData } from "./sentryScrub"; + +describe("maskSensitiveUrl", () => { + it("로그인 code와 토큰 쿼리 값을 가림", () => { + expect(maskSensitiveUrl("https://globber.world/login/oauth/success?code=abc&firstLogin=true")).toBe( + "https://globber.world/login/oauth/success?code=%5BFiltered%5D&firstLogin=true" + ); + expect(maskSensitiveUrl("/callback?accessToken=xyz#top")).toBe("/callback?accessToken=%5BFiltered%5D#top"); + }); + + it("민감한 쿼리가 없으면 원래 문자열을 그대로 돌려줌", () => { + expect(maskSensitiveUrl("/globe/W0kTg5?view=list")).toBe("/globe/W0kTg5?view=list"); + expect(maskSensitiveUrl("/record")).toBe("/record"); + }); +}); + +describe("scrubSensitiveData", () => { + it("요청의 쿠키·인증 헤더를 지우고 URL·쿼리 문자열의 code를 가림", () => { + const event: Event = { + request: { + url: "https://globber.world/login/oauth/success?code=abc", + query_string: "code=abc&uuid=W0kTg5", + cookies: { kakao_access_token: "secret" }, + headers: { Cookie: "kakao_access_token=secret", Authorization: "Bearer secret", "User-Agent": "test" }, + }, + }; + + const result = scrubSensitiveData(event); + + expect(result.request?.cookies).toBeUndefined(); + expect(result.request?.headers).toEqual({ "User-Agent": "test" }); + expect(result.request?.url).toBe("https://globber.world/login/oauth/success?code=%5BFiltered%5D"); + expect(result.request?.query_string).toBe("code=%5BFiltered%5D&uuid=W0kTg5"); + }); + + it("객체 형태 쿼리와 breadcrumb URL도 가림", () => { + const event: Event = { + request: { query_string: { code: "abc", view: "list" } }, + breadcrumbs: [ + { category: "navigation", data: { from: "/login/oauth/success?code=abc", to: "/globe/W0kTg5" } }, + { category: "fetch", data: { url: "/api/auth/token?token=t", method: "POST" } }, + ], + }; + + const result = scrubSensitiveData(event); + + expect(result.request?.query_string).toEqual({ code: "[Filtered]", view: "list" }); + expect(result.breadcrumbs?.[0]?.data).toEqual({ + from: "/login/oauth/success?code=%5BFiltered%5D", + to: "/globe/W0kTg5", + }); + expect(result.breadcrumbs?.[1]?.data).toEqual({ url: "/api/auth/token?token=%5BFiltered%5D", method: "POST" }); + }); + + it("요청 정보가 없는 이벤트는 그대로 돌려줌", () => { + const event: Event = { message: "hello" }; + expect(scrubSensitiveData(event)).toEqual({ message: "hello" }); + }); +}); diff --git a/apps/web/src/utils/sentryScrub.ts b/apps/web/src/utils/sentryScrub.ts new file mode 100644 index 00000000..70440615 --- /dev/null +++ b/apps/web/src/utils/sentryScrub.ts @@ -0,0 +1,92 @@ +import type { Event } from "@sentry/nextjs"; + +// 루트의 sentry.*.config.ts에서 상대 경로로 가져오므로 @/ 별칭을 쓰지 않음 + +const FILTERED = "[Filtered]"; + +/** 값을 가려야 하는 쿼리 이름 (로그인 토큰과 일회용 로그인 code) */ +const SENSITIVE_QUERY_KEYS = new Set(["accesstoken", "access_token", "token", "code"]); + +/** 통째로 지워야 하는 요청 헤더 (인증 쿠키와 토큰) */ +const SENSITIVE_HEADER_KEYS = new Set(["cookie", "set-cookie", "authorization"]); + +const BREADCRUMB_URL_KEYS = ["url", "to", "from"] as const; + +const maskSearchParams = (params: URLSearchParams): boolean => { + // 순회 중에 값을 바꾸지 않도록 키 목록을 먼저 복사함 + const sensitiveKeys = [...new Set(params.keys())].filter(key => SENSITIVE_QUERY_KEYS.has(key.toLowerCase())); + for (const key of sensitiveKeys) params.set(key, FILTERED); + return sensitiveKeys.length > 0; +}; + +/** + * URL 문자열에서 민감한 쿼리 값을 [Filtered]로 바꿈 + * @param url - 절대 또는 상대 URL + * @returns 민감한 쿼리가 없으면 원래 문자열, 있으면 값을 가린 URL + */ +export const maskSensitiveUrl = (url: string): string => { + const queryStart = url.indexOf("?"); + if (queryStart === -1) return url; + + const hashStart = url.indexOf("#", queryStart); + const queryEnd = hashStart === -1 ? url.length : hashStart; + const params = new URLSearchParams(url.slice(queryStart + 1, queryEnd)); + if (!maskSearchParams(params)) return url; + + return `${url.slice(0, queryStart)}?${params.toString()}${url.slice(queryEnd)}`; +}; + +type QueryString = NonNullable["query_string"]; + +const maskQueryString = (queryString: QueryString): QueryString => { + if (typeof queryString === "string") { + const params = new URLSearchParams(queryString); + return maskSearchParams(params) ? params.toString() : queryString; + } + if (Array.isArray(queryString)) { + return queryString.map(([key, value]): [string, string] => [ + key, + SENSITIVE_QUERY_KEYS.has(key.toLowerCase()) ? FILTERED : value, + ]); + } + if (queryString && typeof queryString === "object") { + return Object.fromEntries( + Object.entries(queryString).map(([key, value]) => [ + key, + SENSITIVE_QUERY_KEYS.has(key.toLowerCase()) ? FILTERED : value, + ]) + ); + } + return queryString; +}; + +/** + * Sentry 이벤트(에러·트랜잭션)를 보내기 전에 인증 쿠키·토큰·로그인 code를 지움 (GLB-182) + * beforeSend와 beforeSendTransaction에 그대로 넘겨 씀 + * @param event - Sentry가 보내려는 이벤트 + * @returns 민감 정보를 지운 같은 이벤트 + */ +export const scrubSensitiveData = (event: T): T => { + const { request } = event; + if (request) { + delete request.cookies; + if (request.headers) { + for (const key of Object.keys(request.headers)) { + if (SENSITIVE_HEADER_KEYS.has(key.toLowerCase())) delete request.headers[key]; + } + } + if (typeof request.url === "string") request.url = maskSensitiveUrl(request.url); + if (request.query_string !== undefined) request.query_string = maskQueryString(request.query_string); + } + + for (const breadcrumb of event.breadcrumbs ?? []) { + const { data } = breadcrumb; + if (!data) continue; + for (const key of BREADCRUMB_URL_KEYS) { + const value = data[key]; + if (typeof value === "string") data[key] = maskSensitiveUrl(value); + } + } + + return event; +};