Files
clean-architecture-backend-…/docs/runbooks/auth-token-rotation-failure.md
T
DongHyeonka 0fded57cb3
pr / done (pull_request) Canceled after 0s
docs(runbooks): runbook 신호를 지금 코드가 내는 응답·로그·지표로 고친다
runbook이 코드가 내지 않는 신호로 장애를 찾게 한다. actuator·cross-tenant
runbook은 아무 코드도 내지 않는 ACTUATOR_FORBIDDEN·AUTHZ_TENANT_MISMATCH를
증상으로 적고, 없는 경보·지표·로그 칸을 적는다. auth runbook은 로그에서
token payload·Authorization 원문을 보라고 하고(남지도 않고 남겨서도 안
된다), 없는 JWKS 캐시 손잡이와 decoder가 읽지 않는 Spring issuer 키를
적는다. rate-limit·dependency runbook은 없는 gateway 지표·헤더·
CACHE_UNAVAILABLE·dependency_name 칸을, web runbook은 연산마다의 TTL,
시험 도구 GracefulShutdownProbe, 없는 tag routeTemplate, 기동이 거부하는
CORS 설정을 「기동은 된다」고 적는다. job runbook은 내는 코드가 없는
JOB_DEAD_LETTER·JOB_TIMEOUT과 job.* 지표에 경보를 걸게 한다.

각 runbook을 지금 코드가 내는 신호로 다시 쓴다: 응답 코드·헤더, 보안
로그 줄 `security failure: code=… path=…`, 요청 로그 줄, ServerFailureLog
의 고정 문구(`dependency failure classified as … dependency=<이름>`,
`persistence failure classified as …`), 실제 설정 키
APP_SECURITY_JWT_ISSUER, registry에 있는 지표. 이 템플릿에 경보 규칙이
없다는 것, 내는 코드가 없는 코드·지표는 서비스가 낼 때만 있다는 것을
적는다. 진단 순서도 고친다: actuator 노출은 관리 포트 9001로 가르고,
INTERNAL_AUTH_MISCONFIGURATION은 issuer discovery(4xx·issuer 불일치·
jwks_uri 없음은 500, 연결 실패·5xx·JSON 아님은 503)부터, 종료 예산은
웹 drain 30s + async 19s + preStop의 합으로 본다. 같은 원인의 다른
자리(경보 이름을 지어 적은 job·outbox·internal-error-spike, traceId로
적은 칸, 지적 밖 auth·dependency·db·outbox runbook, error-codes.yaml 주석,
같은 틀린 신호를 적은 shared-contract README·web README·
DependencyFailureException Javadoc)도 고치고, 본문의 리뷰 ID는 지운다.

버린 안: 선언만 있는 두 코드를 내는 WARN·counter를 새로 만들기. actuator
노출 밖 경로는 메인 chain이 401 AUTH_TOKEN_MISSING(익명)·404(인증됨)로
답해 403 상황이 없고, cross-tenant는 정한 규칙(남의 것은 404)이라 판정
자리가 서비스 코드에 있다. 새 신호는 서비스가 더할 일로 runbook에 적는다.

위험: 문서만 바뀐다. runbook은 모두 status 초안으로 둔다.
dependency-unavailable이 적은 hikaricp.connections.pending·timeout 행과
job.* 행의 emitted_when은 관측 registry 변경(같은 묶음의 다른 PR)이
더하고, auth-jwks-unavailable의 「캐시가 지난 뒤 503」은 인증 PR의 JWKS
재조회 분류 수정이 만든다. 세 PR을 함께 병합한다.

검증: python3 scripts/check-docs.py·check-work-docs.py OK, desktop
:app-bootstrap:documentContractTest :app-bootstrap:repositoryContractTest,
scripts/verify.sh pr rc=0.

Refs: RR9-02-04, RR9-02-24, RR9-04-34, RR9-04-37
2026-11-13 09:35:50 +09:00

2.7 KiB

title, category, error_codes, severity, owner, last_updated, status
title category error_codes severity owner last_updated status
Runbook — JWT key rotation 시 인증 실패 spike AUTH
AUTH_TOKEN_EXPIRED
AUTH_KID_UNKNOWN
AUTH_JWKS_UNAVAILABLE
AUTH_TOKEN_INVALID_SIGNATURE
P1 oncall 2026-11-13 초안

Runbook: JWT key rotation 시 인증 실패 spike

증상

  • 401이 몰리고 코드가 AUTH_KID_UNKNOWN(retryable, Retry-After: 5)·AUTH_TOKEN_INVALID_SIGNATURE·AUTH_TOKEN_EXPIRED, 또는 503 AUTH_JWKS_UNAVAILABLE(Retry-After: 30)이다.
  • WARN 로그 줄 security failure: code=<CODE> category=<CATEGORY> method=… path=…(logger AuthErrorResponseWriter). 4xx는 WARN, 5xx는 ERROR다. code=·category=는 메시지 글자이고 구조화 칸이 아니다. AUTH_JWKS_UNAVAILABLE의 category는 TRANSIENT_DEPENDENCY다.
  • 이 템플릿은 경보 규칙·대시보드를 두지 않는다. 서비스가 위 security failure 줄의 code=·path=나 http.server.requests의 tag status로 만든다. 보안 chain이 거부한 요청은 handler가 없어 tag uri가 UNKNOWN이니 경로로 가르지 못한다. 이 경로의 로그에는 dependency_name 칸이 없다.

진단

  • JWKS 주소는 issuer discovery로 정해진다: app.security.issuer-uri(APP_SECURITY_JWT_ISSUER)의 /.well-known/openid-configuration에 있는 jwks_uri다(JwtDecoderConfig). 그 주소를 앱이 도는 곳에서 curl -sf로 읽어 새 kid가 있는지 본다.
  • JWKS 캐시 TTL·강제 새로 고침 손잡이는 없다. decoder는 처음 쓸 때 discovery를 하고, 실패하면 다음 요청에서 다시 한다. 한 번 성공한 뒤에는 라이브러리 기본 캐시로 jwks_uri를 다시 읽는다.
  • 시계 차이 허용은 60초다(JwtDecoderConfig). 만료가 몰리면 발급 호스트의 NTP를 본다.
  • 토큰, Authorization 헤더, JWT payload는 로그에 남지 않고 남겨서도 안 된다. 값을 봐야 하면 클라이언트 쪽에서 재현한다.

조치

  • IdP가 새 키를 게시하기 전에 그 키로 서명한 token을 냈으면 IdP 쪽에서 「게시 → 대기 → 전환」 순서를 지킨다. 앱 쪽 kid 허용 목록은 없다.
  • 모르는 kid가 오면 decoder가 JWKS를 다시 받으므로 키 교체에 재시작은 필요 없다. 재시작이 필요한 경우는 IdP가 jwks_uri를 옮겼을 때뿐이다. discovery는 decoder를 처음 만들 때 한 번만 읽기 때문이다(JwtDecoderConfig).

에스컬레이션

  • 10분 안에 회복하지 않으면 IdP 팀에 넘긴다.

Stub 상태 안내: 이 runbook은 skeleton 단계의 stub. 도메인 도입 시 실제 IdP 종류·rotation 정책·JWKS endpoint URL·dashboard 링크로 보강 필요.