문제
매뉴얼 04 §3.2의 PRODUCT_ENV_REGISTRY 예시 두 행(OIDC_ISSUER,
OIDC_CLIENT_ID)에 defaultValue가 없다. 행 타입은 defaultValue를 필수 칸으로
가진다(src/contracts/env.ts). 그래서 제품이 그대로 붙이면 check:types:app이
env.ts에서 TS2322로, env-registry-coverage가 `row {"required":false}`로
실패한다(리뷰 14-R3). 매뉴얼 03 C절과 product-contracts.ts 주석은
defaultValue를 쓴다.
고른 방법
- 두 행에 `defaultValue: null`을 더하고(.optional() 키), 행 칸의 규칙을
예시 아래 한 줄로 적었다.
- 테스트 tests/unit/manual-paired-backend-settings.test.ts: 매뉴얼 §3.2의 ts
블록을 그대로 저장소 사본의 새 파일로 두고, 사본의 product-contracts.ts가
제품 자신의 파일(옆에 보존)에 그 키를 더해 내보낸다. 그 사본에서
tsconfig.app.json 타입 검사와, env-registry-coverage와 같은 행 대조(키가
없을 때 스키마가 내는 required·defaultValue)를 node로 돌린다. 제품 파일을
덮어쓰지 않으므로 다운스트림에서도 그대로 돈다(1105/09-01과 같은 방식).
- 문서를 읽는 테스트라 REMOVAL_FIXTURE_DOCUMENT_TESTS에 더했다. 그 목록의
항목이 문서를 읽는지 보는 removal-fixture.test.ts 정규식에 `docs/`를
더했다. 문서 대상(REMOVAL_FIXTURE_DOCUMENT_TARGETS)에 docs가 있어 README나
CHANGELOG를 읽지 않는 문서 테스트도 있을 수 있다. 목록의 뜻은 그대로다.
- 버린 대안: 예시 행을 recipe에서 export하고 recipe 테스트가 그것으로
조립하기(리뷰 ②). contracts가 recipe를 import할 수 없어 매뉴얼이 다시
복사를 시킨다. 이번 테스트가 매뉴얼 블록 자체를 지킨다.
위험·한계
- 행 대조는 env-registry-coverage의 schemaDeclaration을 이 테스트 안에 다시
적었다(사본에서 vitest를 띄우지 않으려고). 규칙이 바뀌면 둘을 함께 고친다.
- §3.3·§4.3의 코드 예시는 여전히 컴파일하지 않는다(recipe를 복사한 뒤의
모양이라 사본 구성이 더 크다).
- 테스트가 저장소 사본을 만들고 tsc app 프로그램을 돈다. test:unit이 몇 초
는다.
검증
- desktop batch에서 확인: node scripts/run-vitest.ts run
tests/unit/manual-paired-backend-settings.test.ts
tests/unit/removal-fixture.test.ts, corepack pnpm verify:documentation
Refs: 1105/14-02
20 KiB
04. 짝 백엔드에 처음 붙이기 — 세션 owner
핵심: 짝 백엔드(clean-architecture-backend-template)는 인증 방식이 둘이다. 한 배포는 하나만 쓴다.
프론트는 그 방식에 맞는 세션 owner를 recipes/session-owners/에서 골라 복사하고, composeProductSessionOwner에서 돌려준다.
- 세션 owner: 지금 누가 로그인했는지 알고, 요청에 붙일 자격 증명을 주는 객체다. 계약은
src/adapters/auth/external-session-adapter.ts의ExternalSessionOwner다. - 템플릿에는 demo owner만 있다. demo는
APP_ENV=local에서만 켜지고, 그 표식 토큰은 백엔드 JWT 검증을 통과하지 못한다. AUTH_MODE: "external"인데 owner가 없으면 세션은integration-failed로 닫히고, 인증이 필요한 화면은 "로그인 연동이 필요합니다"를 보인다.
이 문서의 백엔드 사실은 백엔드 bbe944bd 기준이다. 백엔드가 인증 설정을 바꾸면 이 문서와 recipe를 함께 맞춘다.
1. 어느 쪽인가
백엔드의 APP_SECURITY_AUTH_MODE가 정한다. 기본값은 jwt다.
jwt |
redis-session |
|
|---|---|---|
| 백엔드가 받는 것 | Authorization: Bearer <Keycloak access token> |
CA_SESSION 쿠키. 쓰기에는 X-XSRF-TOKEN 헤더도 |
| 프론트 recipe | recipes/session-owners/oidc-pkce-session-owner.ts |
recipes/session-owners/cookie-session-owner.ts |
| operation 인증 프로필 | EXTERNAL_BEARER (템플릿. 생성 뼈대 기본값) |
SESSION_COOKIE_READ, SESSION_COOKIE_WRITE (제품 프로필. recipe에 있다) |
| 백엔드 템플릿에 없어서 제품이 더하는 것 | Keycloak realm의 브라우저용 public client, 사용자 | 로그인·로그아웃·세션 조회 엔드포인트 |
| 브라우저에 남는 것 | 없음. 토큰은 메모리에만 | httpOnly 쿠키. 스크립트는 못 읽는다 |
백엔드 근거 위치:
- 두 모드의 보안 체인:
clean-architecture-backend-template/src/adapter/inbound/web/src/main/java/dev/caskeleton/adapter/inbound/web/auth/SecurityConfig.java - 쿠키·CSRF 이름과 모드 기본값:
clean-architecture-backend-template/src/app-bootstrap/src/main/resources/config/security.yml - local issuer·audience·CORS:
clean-architecture-backend-template/src/app-bootstrap/src/main/resources/application-local.yml - realm:
clean-architecture-backend-template/infra/keycloak/realms/ca-skeleton-realm.json
2. 공통 준비
config/runtime/local.json의AUTH_MODE를"external"로 바꾼다.demo로 두면 owner를 묻지 않는다. 백엔드에 실제로 붙지 않는다.
- 백엔드 local 프로필의 CORS 허용 출처는
http://localhost:3000이다. 프론트를 그 포트로 띄운다.corepack pnpm dev --port 3000- 다른 포트를 쓰면 백엔드의 CORS 허용 출처를 그 출처로 바꾼다.
- owner는
ProductSessionOwnerContext(src/bootstrap/product-composition-contract.ts)에서 만든다.fetch: 요청 하나에 마감이 있다(REQUEST_TIMEOUT_MS가 상한). 본문은 64 KiB까지 읽는다. redirect는 따라가지 않는다.fetcher는 마감이 없다. owner에서 쓰지 않는다. 응답하지 않는 호출 하나가 세션을 "복구 중"에 영원히 둔다.page: 지금 URL, URL 바꾸기, 다른 페이지로 이동. 로그인 리다이렉트에 쓴다.redirectStorage: 페이지의 sessionStorage. 리다이렉트 한 번 동안의 상태만 둔다. 토큰은 두지 않는다(AUTH_TOKEN은src/contracts/storage-keys.ts에서forbidden이다).- 키는 registry의
AUTH_REDIRECT_TRANSACTION(backend: "external")에서 가져온다. 그래야APP_NAMESPACE를 바꿀 때 같이 바뀐다. 새 owner도 키를 글자로 적지 않는다.
- 키는 registry의
readCookie: 페이지 쿠키 읽기.
- recipe는
src/bootstrap/아래로 복사한다. import하지 않는다.src가recipes/를 import하면check:optional-recipes가PRODUCTION_IMPORTS_RECIPE로 막는다.- 복사한 파일의 import 경로에서
../../src/를../로 바꾼다. - 템플릿이 recipe를 고치면 CHANGELOG에 적는다. 복사본에 같은 diff를 옮긴다.
3. jwt 모드 — OIDC PKCE owner
로그인 버튼 → beginSignIn(returnTo)
→ owner가 verifier·state·nonce를 만들어 redirectStorage에 둔다 (10분)
→ Keycloak 로그인 화면 (code_challenge = SHA-256(verifier))
→ 앱 기본 주소로 돌아온다 (?code=…&state=…&iss=…)
→ owner가 저장한 거래를 지우고, URL에서 code를 지우고 returnTo로 바꾼다 [recovery-pending]
→ 토큰 엔드포인트에서 code + verifier를 토큰으로 바꾼다
→ ID token의 iss·aud·nonce·exp·sub를 확인한다 [authenticated, subject = sub]
요청 → attachCredential → Authorization: Bearer <access token> (API origin에만)
만료 30초 전 → refresh token으로 한 번 갱신. 상태 알림이 없어 서버 상태 캐시가 남는다
서버 401 → refresh로 한 번 복구 → 새 토큰도 401이면 로그아웃 [unauthenticated]
- PKCE: 로그인 시작 때 만든 비밀값(verifier)의 해시를 보내고, 토큰을 받을 때 원래 값을 보내는 방식이다. 중간에서 code를 가로채도 토큰으로 바꾸지 못한다.
- 라이브러리는 없다. WebCrypto와 context
fetch만 쓴다.
3.1 Keycloak에 브라우저용 client를 더한다
백엔드 realm에는 서비스용 confidential client ca-skeleton-api 하나뿐이다. 그 client는 브라우저 로그인(standard flow)이 꺼져 있다. 그래서 브라우저가 로그인할 public client를 제품이 더한다.
realm JSON의 clients에 넣거나 Keycloak 관리 화면에서 같은 값으로 만든다.
{
"clientId": "ca-frontend",
"enabled": true,
"protocol": "openid-connect",
"publicClient": true,
"standardFlowEnabled": true,
"implicitFlowEnabled": false,
"directAccessGrantsEnabled": false,
"redirectUris": ["http://localhost:3000/*"],
"webOrigins": ["http://localhost:3000"],
"attributes": {
"pkce.code.challenge.method": "S256",
"post.logout.redirect.uris": "http://localhost:3000/*"
},
"protocolMappers": [
{
"name": "ca-skeleton-api-audience",
"protocol": "openid-connect",
"protocolMapper": "oidc-audience-mapper",
"config": {
"included.client.audience": "ca-skeleton-api",
"id.token.claim": "false",
"access.token.claim": "true"
}
}
]
}
- audience mapper가 꼭 있어야 한다. 백엔드는 access token의
aud에APP_SECURITY_JWT_AUDIENCE(local 기본ca-skeleton-api)가 없으면 401AUTH_AUDIENCE_MISMATCH로 거부한다. webOrigins는 브라우저가 토큰 엔드포인트를 부를 때의 CORS 허용이다.- realm에는 사람 사용자가 없다. local에서는 관리 화면에서 사용자를 하나 만들고 realm role
user를 준다. - 백엔드 권한은
realm_access.roles와resource_access.ca-skeleton-api.roles에서 온다. 쓰기 권한이 필요하면 그 사용자에게ca-skeleton-api의 client role을 준다(clean-architecture-backend-template/docs/manual/07-authorization.md).
3.2 제품 설정 키를 더한다
issuer와 client id는 환경마다 다르다. 그래서 런타임 설정 키로 둔다. src/contracts/product-contracts.ts:
import { z } from "./zod.ts";
export const PRODUCT_RUNTIME_CONFIG_FIELDS = Object.freeze({
OIDC_ISSUER: z.url().optional(),
OIDC_CLIENT_ID: z.string().min(1).optional(),
});
export const PRODUCT_ENV_REGISTRY = Object.freeze({
OIDC_ISSUER: { phase: "runtime", classification: "public", required: false, defaultValue: null },
OIDC_CLIENT_ID: { phase: "runtime", classification: "public", required: false, defaultValue: null },
} as const);
.optional()로 둔다. 값이 비면 owner는integration-failed로 닫힌다. 잘못된 곳으로 로그인하지 않는다.- 행의
required·defaultValue는 그 키가 없을 때 스키마가 하는 것과 같아야 한다..optional()이면required: false, defaultValue: null이다(tests/unit/env-registry-coverage.test.ts). 이 블록은 그대로tests/unit/manual-paired-backend-settings.test.ts가 타입 검사와 그 대조를 돌린다. config/runtime/local.json에"OIDC_ISSUER": "http://localhost:8081/realms/ca-skeleton","OIDC_CLIENT_ID": "ca-frontend"를 더한다.OIDC_ISSUER는 백엔드APP_SECURITY_JWT_ISSUER와 글자 하나까지 같아야 한다. 끝의/도 같아야 한다.- 원격 issuer는 HTTPS만 받는다. HTTP는
localhost,127.0.0.1,[::1]에서만 받는다.
3.3 owner를 돌려준다
recipe를 src/bootstrap/ 아래로 복사한 뒤(예: 같은 이름 oidc-pkce-session-owner.ts) src/bootstrap/product-composition.ts:
import { createOidcPkceSessionOwner } from "./oidc-pkce-session-owner.ts";
export function composeProductSessionOwner(
context: ProductSessionOwnerContext,
): ProductSessionOwner {
const app = new URL(context.page.href());
return createOidcPkceSessionOwner({
issuer: context.config.OIDC_ISSUER ?? "",
clientId: context.config.OIDC_CLIENT_ID ?? "",
// 앱 기본 주소: origin + 라우터 base path. client의 redirect URI와 같아야 한다.
redirectUri: new URL("/", app.origin).href,
postLogoutRedirectUri: new URL("/", app.origin).href,
apiOrigins: [new URL(context.config.API_BASE_URL).origin],
fetch: context.fetch,
page: context.page,
redirectStorage: context.redirectStorage,
});
}
- 라우터 base path가
/가 아니면redirectUri에 그 경로를 넣는다. 돌아온 뒤 owner가 그 경로 아래의returnTo로 URL을 바꾼다. - operation은
EXTERNAL_BEARER그대로 둔다. 바꿀 것이 없다. - 배포 CSP
connect-src 'self' https:는 HTTPS Keycloak을 이미 허용한다(config/hosting/security-headers.json).
3.4 이 owner가 하지 않는 것
- 새로고침하면 로그아웃된다. 토큰이 메모리에만 있기 때문이다. Keycloak SSO 세션이 살아 있으면 로그인 버튼 한 번이 비밀번호 없이 돌아온다.
- 새로고침에도 로그인을 유지하려면
prompt=none리다이렉트를 더하는 것은 제품의 결정이다. 토큰을 storage에 두는 방법은 쓰지 않는다.
- 새로고침에도 로그인을 유지하려면
- ID token 서명은 보지 않는다. 토큰 엔드포인트에서 직접 받은 응답이라 TLS가 출처를 보증한다(OIDC Core 3.1.3.7 (6)). access token 서명은 백엔드가 확인한다.
- 로그아웃 URL에 ID token을 넣지 않는다. 그래서 Keycloak이 "로그아웃할까요?"를 한 번 묻는다.
4. redis-session 모드 — 쿠키 owner와 CSRF provider
부팅 → owner가 세션 엔드포인트를 묻는다 (GET, 쿠키 포함) [recovery-pending]
→ 200 + subject → [authenticated]
→ 401 → [unauthenticated]
→ 그 밖·시간 초과 → 그대로 recovery-pending. "세션 복구" 버튼이 다시 묻는다
읽기 요청 (SESSION_COOKIE_READ) → 쿠키만
쓰기 요청 (SESSION_COOKIE_WRITE) → 쿠키 + X-XSRF-TOKEN: <XSRF-TOKEN 쿠키 값>
서버 401 → onCredentialRejected → 템플릿 세션 [unauthenticated]
- 서버 401이 세션에 닿는 길은 4.3의
onCredentialRejected한 줄뿐이다. 템플릿은 제품 provider가 낸 자격 증명의 401을 제품에만 알린다(02 결정표 5절). 이 줄을 빼면 서버 세션이 끝나도(Redis TTL 만료, 다른 탭·서버에서 로그아웃) 화면은 로그인 상태로 남고, 요청마다AUTH_REQUIRED실패 화면만 보인다. - CSRF: 다른 사이트가 사용자의 쿠키로 쓰기를 보내는 공격이다. 백엔드는 스크립트가 읽을 수 있는
XSRF-TOKEN쿠키를 주고, 쓰기 요청의X-XSRF-TOKEN헤더가 그 값과 같은지 본다. 다른 사이트의 스크립트는 이 쿠키를 읽지 못한다. - 백엔드는 plain 방식이다(
CsrfTokenRequestAttributeHandler). 쿠키 값을 그대로 헤더에 넣는다.
4.1 백엔드에 엔드포인트 셋을 더한다
백엔드 템플릿의 운영 코드에는 로그인·로그아웃·세션 조회 엔드포인트가 없다. 테스트 픽스처(SecurityModeWebContractTest.java의 /csrf, /login-test, /whoami)만 있다. 그래서 recipe는 이 셋의 주소를 기본값 없이 받는다.
- 세션 조회 (GET): 로그인했으면 200과 subject, 아니면 401.
- subject: 사용자마다 다르고 바뀌지 않는 불투명한 id다. 토큰이나 이메일을 쓰지 않는다.
- 이 엔드포인트가 CSRF 토큰을 읽어야 한다(Spring이면
CsrfToken.getToken()). Spring Security는 6부터 GET 요청에서 토큰을 읽을 때까지XSRF-TOKEN쿠키를 쓰지 않는다.
- 로그아웃 (POST): 세션을 끝낸다. CSRF 헤더가 필요하다.
- 로그인: 로그인 화면 POST든
oauth2Login리다이렉트든 제품이 정한다. 끝나면 페이지가recover()를 불러 owner가 세션을 다시 묻게 한다.
4.2 인증 프로필 두 개를 더한다
cookie-session-owner.ts의 SESSION_COOKIE_AUTH_PROFILES 두 행을 src/contracts/product-contracts.ts의 PRODUCT_REST_AUTH_PROFILES에 그대로 옮겨 적는다.
- import하지 않고 옮겨 적는 이유:
src/contracts는src/bootstrap을 import하지 못한다(check:architecture의contracts-do-not-know-presentation-or-bootstrap). - 읽기 operation은
SESSION_COOKIE_READ, 쓰기 operation은SESSION_COOKIE_WRITE를frontend.authProfileId에 적는다. SESSION_COOKIE_WRITE는x-xsrf-token을 요구한다. 쿠키가 없으면 executor가 요청을 하나도 보내지 않고AUTH_INTEGRATION_FAILURE로 닫는다.
4.3 owner와 provider를 돌려준다
recipe를 src/bootstrap/ 아래로 복사한 뒤 src/bootstrap/product-composition.ts:
import {
createCookieSessionOwner,
createSessionCookieCredentialProviders,
createSessionCookieRejectionHandler,
} from "./cookie-session-owner.ts";
export function composeProductSessionOwner(
context: ProductSessionOwnerContext,
): ProductSessionOwner {
const api = new URL(context.config.API_BASE_URL);
return createCookieSessionOwner({
sessionUrl: new URL("api/session", api).href,
signOutUrl: new URL("api/session/sign-out", api).href,
// 백엔드 Envelope: { success: true, data: { subject } }
subjectFrom: (body) => {
const data = (body as { data?: { subject?: unknown } } | null)?.data;
return typeof data?.subject === "string" ? data.subject : null;
},
beginSignIn: async () => context.page.assign(new URL("/login", context.page.href()).href),
fetch: context.fetch,
readCookie: context.readCookie,
});
}
export function composeProduct(context: ProductCompositionContext) {
return {
capabilities: {},
credentialProviders: createSessionCookieCredentialProviders({
readCookie: context.readCookie,
}),
// 서버 401 → 세션 unauthenticated. 빼면 세션이 끝나도 화면은 로그인 상태다.
onCredentialRejected: createSessionCookieRejectionHandler(context),
} satisfies ProductComposition;
}
- 위 경로(
api/session등)는 예시다. 4.1에서 만든 엔드포인트 주소를 쓴다. - provider는 세션 상태를 묻지 않는다. 쿠키가 증명이고 서버가 판정한다.
- 서버의 401은
onCredentialRejected를 거쳐 세션에 간다. handler는SESSION_COOKIE_*프로필의 401만context.notifySessionUnauthenticated()로 넘긴다. 그러면 세션이unauthenticated가 되고 서버 상태 캐시가 비워진다. 다른 제품 프로필(외부 API 토큰 등)의 401은 넘기지 않는다.- 제품에 다른
onCredentialRejected가 이미 있으면 그 함수 안에서 이 handler도 부른다.
- 제품에 다른
4.4 페이지와 API는 같은 host여야 한다
XSRF-TOKEN쿠키는 그 쿠키를 준 host에서만 스크립트가 읽는다. 페이지 host와 API host가 다르면 쓰기가 늘 실패한다.- 운영: 프록시 하나 뒤에 페이지와 API를 같은 origin으로 둔다.
- local: 쿠키는 포트를 가리지 않는다. 그래서
localhost:3000의 페이지가localhost:8080이 준 쿠키를 읽는다. 백엔드 local 프로필은 CORSallow-credentials: true다. - 백엔드는 세션 쿠키를
Secure로만 준다. 브라우저가http://localhost를 안전한 출처로 볼 때만 저장된다. 저장되지 않으면 https 개발 서버를 쓴다.
5. owner가 지킬 상태 전이
정본: src/application/ports/auth-session-port.ts의 SessionState와 SessionGateway.recover 주석. 두 recipe 모두 이를 따른다.
recover() 답 |
답할 때의 상태 |
|---|---|
"restored" |
authenticated, subject 있음 |
"no-session" |
unauthenticated (또는 integration-failed). recovery-pending이 아니다 |
| reject | 바꾸지 않는다. 사용자가 다시 시도한다 |
- 같은 사용자의 토큰 갱신은 상태도 subject도 바꾸지 않는다. 바꾸면 서버 상태 캐시가 비워진다.
- 계약을 어기고
"no-session"뒤에도recovery-pending이면 화면은 owner가 다시 알릴 때까지 로그인 버튼을 보인다.
6. 확인
corepack pnpm test:recipes: 두 recipe의 단위 테스트와, 템플릿 조립 루트에 실제로 붙인 테스트(tests/recipes/session-owners-runtime.test.ts).- 아직 없는 것: 실제 Keycloak·Redis session 백엔드에 붙인 e2e. 처음 붙일 때 손으로 확인한다.
jwt: 로그인 한 번,EXTERNAL_BEARERoperation 한 번이 200.redis-session: 로그인 한 번,SESSION_COOKIE_WRITEoperation 한 번이 성공하고 요청에X-XSRF-TOKEN이 있다.
7. 틀리면
- "로그인 연동이 필요합니다" (
integration-failed)AUTH_MODE가external인데composeProductSessionOwner가null을 돌려준다.- OIDC 설정이 틀렸다:
OIDC_ISSUER·OIDC_CLIENT_ID가 비었다, 원격 issuer가 HTTP다,apiOrigins가 origin이 아니다,redirectStorage가 없다.
- Keycloak이
Invalid parameter: redirect_uri를 보인다: clientredirectUris에 앱 기본 주소가 없다. - 토큰 교환에서 CORS 오류: client
webOrigins에 앱 origin이 없다. - 로그인했는데 API가 401: 백엔드 응답의
error.code를 본다(목록:clean-architecture-backend-template/src/adapter/inbound/web/README.md의SecurityErrorClassifier).AUTH_AUDIENCE_MISMATCH: 3.1의 audience mapper가 없다.AUTH_ISSUER_MISMATCH:OIDC_ISSUER와APP_SECURITY_JWT_ISSUER가 다르다. 컨테이너 안의 백엔드는localhost로 Keycloak에 닿지 못한다는 점도 본다(백엔드application-local.yml주석).AUTH_JWKS_UNAVAILABLE(503): 백엔드가 Keycloak에 닿지 못한다.
- 401 뒤 바로 로그아웃된다: refresh token이 없거나(client 설정), 갱신한 토큰도 401이다. 후자는 갱신으로 풀리지 않는 거부(audience, issuer)다.
- 부팅 뒤 계속 "세션을 복구하고 있습니다" (쿠키 모드): 세션 엔드포인트가 응답하지 않거나 200·401 말고 다른 status를 준다.
- 쓰기가
AUTH_INTEGRATION_FAILURE이고 요청이 0번 (쿠키 모드):XSRF-TOKEN쿠키가 없다. 세션 엔드포인트가 CSRF 토큰을 읽지 않았거나, 페이지와 API host가 다르다. - 쓰기가 403 (쿠키 모드): 헤더 값이 쿠키와 다르거나, 백엔드가
APP_SESSION_CSRF_HEADER_NAME을 바꿨다. 바꿨다면 프로필과 provider의 헤더 이름을 같이 바꾼다. 템플릿이 허용하는 이름은x-xsrf-token,x-csrf-token이다(src/contracts/rest-profiles.ts의CREDENTIAL_HEADER_NAMES).