Files
clean-architecture-frontend…/tests/unit/rest-profile-contract.test.ts
T
DongHyeonka 365d8c3c02 fix(contracts): 쿠키 인증 쓰기는 CSRF 헤더를 요구하는 프로필만 조립한다
문제
브라우저는 쿠키를 어느 사이트의 요청에든 붙이므로, 쿠키로 인증하는 쓰기
요청은 페이지만 넣을 수 있는 헤더(CSRF 토큰)가 있어야 서버가 진짜 요청을
가른다. V2 클라이언트는 resolveRestSecurityProfiles로 "쿠키 프로필 + GET·HEAD
밖 method면 HEADER CSRF 프로필"을 강제했다. 048f490·12f3bb7이 V2를 지운 뒤
V3에는 이 검사가 없다. V3 프로필 설치 규칙은 SAME_ORIGIN_COOKIE에 쿠키
전송과 bearer 금지만 요구한다. 그래서 제품이 CSRF 헤더 없는 쿠키 프로필을
POST에 붙여도 조립이 통과한다.

고른 방법
assertHttpContract가 operation의 auth profile을 설치된 레지스트리에서 찾아,
쓰기(GET·HEAD 밖)인데 SAME_ORIGIN_COOKIE이고 requiredCredentialHeaders에
x-csrf-token·x-xsrf-token이 없으면 operation·method·프로필 이름을 담아
거절한다. 읽기 쿠키 프로필은 CSRF 없이 그대로 된다(tech-log·memento 예시와
같다).

버린 대안
- 프로필 설치 때 모든 쿠키 프로필에 CSRF 요구: 읽기 전용 쿠키 프로필
  (MEMENTO_BFF_READ 등)까지 막는다. method는 operation에만 있다.
- 요청 때(attachCredentials) 검사: 조립 때 잡을 수 있는 설정 실수를 사용자
  요청 시점까지 미룬다.

위험·한계
- 이미 CSRF 없는 쿠키 쓰기 프로필을 쓰는 제품은 조립이 실패한다. 의도한
  실패다(CHANGELOG [보안]).
- 헤더 값이 올바른 CSRF 토큰인지는 서버만 안다. 프론트는 헤더가 반드시
  실리는지만 보장한다(requiredCredentialHeaders가 없으면 fetch 0회).

검증
- RED: tests/unit/rest-profile-contract.test.ts "refuses a write whose cookie
  profile requires no CSRF header" 실패(조립이 통과).
- GREEN: 같은 파일 7건 통과. CSRF를 요구하는 쓰기와 CSRF 없는 쿠키 읽기는
  조립된다.
- check:types, lint, check:architecture, check:registries, test:unit 2,568,
  test:integration 117, test:component 245 통과.

Refs: docs/reviews/2026-11-01-maturity-review/README.md 14.7
2026-11-03 22:22:35 +09:00

144 lines
5.0 KiB
TypeScript

import { readdir, readFile } from "node:fs/promises";
import path from "node:path";
import { describe, expect, it } from "vitest";
import {
composeContractContributions,
ContractContributionError,
} from "../../src/contracts/external-contract-runtime.ts";
import {
INSTALLED_REST_AUTH_PROFILES,
installRestAuthProfileRegistry,
REST_AUTH_PROFILES,
} from "../../src/contracts/rest-profiles.ts";
import { TEST_CONTRACT_CONTRIBUTION } from "../helpers/external-contract-fixture.ts";
describe("one installed REST auth profile registry", () => {
it("refuses a raw profile record that is incoherent", () => {
expect(() =>
installRestAuthProfileRegistry({
EXTERNAL_BEARER: {
...REST_AUTH_PROFILES.EXTERNAL_BEARER,
credentials: "same-origin" as const,
},
}),
).toThrow(TypeError);
});
it("does not answer for an inherited profile id", () => {
expect(INSTALLED_REST_AUTH_PROFILES.has("toString")).toBe(false);
expect(INSTALLED_REST_AUTH_PROFILES.get("toString")).toBeUndefined();
});
it("composes contributions against the registry it is given", () => {
const registry = installRestAuthProfileRegistry({
...REST_AUTH_PROFILES,
CUSTOM_BEARER: {
...REST_AUTH_PROFILES.EXTERNAL_BEARER,
authProfileId: "CUSTOM_BEARER",
},
});
const row = TEST_CONTRACT_CONTRIBUTION.http[0]!;
const contribution = {
...TEST_CONTRACT_CONTRIBUTION,
http: [
{ ...row, frontend: { ...row.frontend, authProfileId: "CUSTOM_BEARER" } },
],
};
expect(() => composeContractContributions([contribution])).toThrow(
ContractContributionError,
);
expect(
composeContractContributions([contribution], registry).httpByOperationId
.size,
).toBe(1);
});
});
/**
* A cookie-authenticated write must carry a CSRF proof header: the browser
* attaches the cookie to any site's request, so the header is what tells the
* server the page itself sent it. The V2 client refused such a binding; the
* installed HTTP contract has to refuse it too.
*/
describe("cookie profiles on writes", () => {
const cookie = (authProfileId: string, csrf: readonly ("x-csrf-token" | "x-xsrf-token")[]) => ({
authProfileId,
transport: "SAME_ORIGIN_COOKIE" as const,
credentials: "include" as const,
allowedCredentialHeaders: [...csrf],
requiredCredentialHeaders: [...csrf],
});
const registry = installRestAuthProfileRegistry({
...REST_AUTH_PROFILES,
COOKIE_READ: cookie("COOKIE_READ", []),
COOKIE_WRITE: cookie("COOKIE_WRITE", ["x-xsrf-token"]),
});
const withProfile = (index: number, authProfileId: string) => {
const row = TEST_CONTRACT_CONTRIBUTION.http[index]!;
return {
...TEST_CONTRACT_CONTRIBUTION,
http: [{ ...row, frontend: { ...row.frontend, authProfileId } }],
};
};
// TEST_CONTRACT_CONTRIBUTION.http: [list (GET), detail (GET), create (POST)]
it("refuses a write whose cookie profile requires no CSRF header", () => {
expect(() =>
composeContractContributions([withProfile(2, "COOKIE_READ")], registry),
).toThrow(
expect.objectContaining({
reason:
"test-feature/TEST_CREATE_ENTITY: POST with cookie profile COOKIE_READ must require x-csrf-token or x-xsrf-token",
}),
);
});
it("accepts a write that requires a CSRF header, and a cookie read without one", () => {
expect(
composeContractContributions([withProfile(2, "COOKIE_WRITE")], registry)
.httpByOperationId.size,
).toBe(1);
expect(
composeContractContributions([withProfile(0, "COOKIE_READ")], registry)
.httpByOperationId.size,
).toBe(1);
});
});
/**
* 1101/16-03. The only bearer profile is the platform's, not the sample's:
* `EXTERNAL_BEARER`. The old name stays for one release as a deprecated alias
* that resolves to the same transport and headers.
*/
describe("EXTERNAL_BEARER and its deprecated alias (16-03)", () => {
it("resolves the alias exactly like EXTERNAL_BEARER but for its id", () => {
expect(INSTALLED_REST_AUTH_PROFILES.get("EXTERNAL_BEARER")).toMatchObject({
transport: "BEARER_HEADER",
requiredCredentialHeaders: ["authorization"],
});
expect({
...INSTALLED_REST_AUTH_PROFILES.get("REFERENCE_EXTERNAL_BEARER"),
authProfileId: "EXTERNAL_BEARER",
}).toEqual(INSTALLED_REST_AUTH_PROFILES.get("EXTERNAL_BEARER"));
});
it("keeps the old name in src only on the alias line", async () => {
const files = (await readdir("src", { recursive: true }))
.filter((file) => /\.tsx?$/u.test(file))
.map((file) => path.join("src", file));
const lines: string[] = [];
for (const file of files) {
for (const line of (await readFile(file, "utf8")).split("\n")) {
if (line.includes("REFERENCE_EXTERNAL_BEARER")) {
lines.push(`${file}: ${line.trim()}`);
}
}
}
expect(lines).toEqual([
'src/contracts/rest-profiles.ts: REFERENCE_EXTERNAL_BEARER: Object.freeze({ ...EXTERNAL_BEARER, authProfileId: "REFERENCE_EXTERNAL_BEARER" }),',
]);
});
});