Files
Gnuboard7/app/Http/Controllers/Api/Identity/IdentityVerificationController.php
T
HeuJung d970117149 fix(core,ecommerce,board,admin_basic): 고아 카탈로그 차단 + 설정 저장 파이프라인 정합
확장이 훅으로 등록한 카탈로그에서 고른 값은 그 확장이 사라져도 저장값으로 남는다.
그 상태에서 값만 보고 판정하면 이미 제공 불가한 항목이 사용자 화면에 그대로 노출된다.
예외도 경고도 로그도 남지 않아 관리자 화면과 나란히 보지 않으면 드러나지 않는다.

- 결제수단에 지정한 PG, 현금영수증 발급사, 검색엔진 드라이버 세 축에 같은 판정을 적용.
 공개 응답에서는 제거하고 관리자 응답에는 표시를 남긴다 — 운영자가 고쳐야 할 대상이라
 감추면 복구 경로가 사라진다. 서버 검증도 같은 판정을 공유해 화면 우회 제출을 막는다.
- 설정 단건 저장이 벌크 저장과 다른 경로를 타던 문제를 코어·이커머스·게시판에서 정리.
 저장은 성공하고 파생 값만 갱신되지 않아 어느 화면에서 저장했느냐로 결과가 갈렸다.
- 단건 저장의 값 형태 계약 신설. 빈 값으로 되돌릴 수 있게 하고, 타입은 defaults.json 의
 기본값을 SSoT 로 삼는다. 해석 불가한 입력은 조용히 캐스팅하지 않고 거절한다.
- 드라이버 셀렉트를 서버 카탈로그에 바인딩하고, 저장값이 카탈로그에 없으면 그 값을
 드러내는 안내를 8곳 전수에 붙인다. 종전에는 빈 칸으로만 보여 무엇이 저장됐는지
 알 수 없었다.

시나리오 매니페스트 8종을 면제 없이 신설했다. `audit:allow` 는 cross product 와 effects
검사를 함께 끄므로, 면제가 걸린 매니페스트에 선언을 추가하면 검증이 회복되지 않는다.
그 아래에서 대응 테스트가 없는 effect 이름 2건이 살아남아 있었고, 함께 정리했다.
2026-08-14 17:28:49 +09:00

378 lines
16 KiB
PHP

<?php
namespace App\Http\Controllers\Api\Identity;
use App\Enums\IdentityOriginType;
use App\Extension\IdentityVerification\IdentityVerificationManager;
use App\Http\Controllers\Api\Base\PublicBaseController;
use App\Http\Requests\Identity\CancelChallengeRequest;
use App\Http\Requests\Identity\IdentityCallbackRequest;
use App\Http\Requests\Identity\ProvidersIndexRequest;
use App\Http\Requests\Identity\PurposesIndexRequest;
use App\Http\Requests\Identity\RequestChallengeRequest;
use App\Http\Requests\Identity\ResolvePolicyRequest;
use App\Http\Requests\Identity\ShowChallengeRequest;
use App\Http\Requests\Identity\VerifyChallengeRequest;
use App\Http\Resources\Identity\ChallengeResource;
use App\Http\Resources\Identity\ProviderResource;
use App\Models\IdentityVerificationLog;
use App\Models\User;
use App\Services\IdentityPolicyService;
use App\Services\IdentityVerificationService;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\RedirectResponse;
/**
* 본인인증 공개 API 컨트롤러.
*
* 비로그인 가입 플로우(Mode B) 에서도 접근하므로 PublicBaseController 를 상속합니다.
* 로그인 필요 엔드포인트는 라우트의 permission 미들웨어가 담당합니다.
*/
class IdentityVerificationController extends PublicBaseController
{
/**
* @param IdentityVerificationService $service 본인인증 유스케이스 Service
* @param IdentityVerificationManager $manager 프로바이더 레지스트리 (Service 역할 겸함)
* @param IdentityPolicyService $policyService 정책 해석 Service (프런트 프리페치용)
*/
public function __construct(
protected IdentityVerificationService $service,
protected IdentityVerificationManager $manager,
protected IdentityPolicyService $policyService,
) {
parent::__construct();
}
/**
* Challenge 를 요청합니다. POST /api/identity/challenges
*
* @param RequestChallengeRequest $request 검증된 요청
* @return JsonResponse 생성된 Challenge 리소스 (201)
*/
public function request(RequestChallengeRequest $request): JsonResponse
{
$validated = $request->validated();
$user = $request->user();
$target = $user ?: ($validated['target'] ?? []);
if (! ($user instanceof User) && empty($target['email']) && empty($target['phone'])) {
return $this->error('identity.errors.missing_target', 422);
}
$providerId = $validated['provider_id'] ?? null;
if (is_string($providerId) && $providerId === '') {
$providerId = null;
}
$challenge = $this->service->start(
purpose: (string) $validated['purpose'],
target: $target,
context: [
'ip_address' => $request->ip(),
'user_agent' => substr((string) $request->userAgent(), 0, 512),
'origin_type' => IdentityOriginType::Api->value,
'origin_identifier' => '/api/identity/challenges',
],
providerId: $providerId,
);
return $this->success(
'identity.messages.challenge_requested',
(new ChallengeResource($challenge))->toArray($request),
201,
);
}
/**
* Challenge 를 검증합니다. POST /api/identity/challenges/{challenge}/verify
*
* 라우트는 `permission:user,core.identity.verify` 미들웨어 + Route::model('challenge') 바인딩으로 보호됩니다.
* 로그인 사용자는 PermissionMiddleware 의 scope=self 가드가 challenge.user_id 일치를 자동 검증합니다.
* 비로그인 게스트는 guest 역할 권한만 통과하면 진입합니다 (Mode B 가입 흐름).
*
* @param VerifyChallengeRequest $request 검증된 요청 (code 또는 token 포함)
* @param IdentityVerificationLog $challenge 라우트 모델 바인딩으로 resolve 된 challenge 로그
* @return JsonResponse 검증 결과 (verification_token 포함)
*/
public function verify(VerifyChallengeRequest $request, IdentityVerificationLog $challenge): JsonResponse
{
$result = $this->service->verify(
challengeId: $challenge->id,
input: $request->validated(),
context: [
'ip_address' => $request->ip(),
'user_agent' => substr((string) $request->userAgent(), 0, 512),
],
);
// verify 실패 시에도 서버 측 시도 횟수를 응답에 포함 — 클라이언트가 자체 카운트를 서버와 동기화하여
// "남은 시도 횟수" UI 가 다른 탭/세션과 불일치하지 않도록.
if (! $result->success) {
$fresh = $challenge->fresh();
return $this->error(
$result->failureReason ?: 'identity.errors.generic',
422,
[
'failure_code' => $result->failureCode,
'attempts' => $fresh ? (int) $fresh->attempts : (int) $challenge->attempts,
'max_attempts' => $fresh ? (int) $fresh->max_attempts : (int) $challenge->max_attempts,
],
);
}
return $this->success('identity.messages.challenge_verified', [
'challenge_id' => $result->challengeId,
'provider_id' => $result->providerId,
'verified_at' => $result->verifiedAt?->toIso8601String(),
'verification_token' => $result->claims['verification_token'] ?? null,
]);
}
/**
* Challenge 를 취소합니다. POST /api/identity/challenges/{challenge}/cancel
*
* 라우트는 `permission:user,core.identity.cancel` 미들웨어 + Route::model('challenge') 바인딩으로 보호됩니다.
* 로그인 사용자는 PermissionMiddleware 의 scope=self 가드가 challenge.user_id 일치를 자동 검증합니다.
* 비로그인 게스트는 guest 역할 권한만 통과하면 진입합니다 (모달 취소 시 audit trail 정합용).
*
* @param CancelChallengeRequest $request 검증된 요청
* @param IdentityVerificationLog $challenge 라우트 모델 바인딩으로 resolve 된 challenge 로그
* @return JsonResponse 취소 결과
*/
public function cancel(CancelChallengeRequest $request, IdentityVerificationLog $challenge): JsonResponse
{
$ok = $this->service->cancel($challenge->id);
if (! $ok) {
return $this->error('identity.errors.challenge_not_found', 404);
}
return $this->success('identity.messages.challenge_cancelled');
}
/**
* Challenge 의 공개 상태를 폴링합니다. GET /api/identity/challenges/{challenge}
*
* 비동기 검증 흐름(Stripe Identity / 토스인증 push / 외부 redirect 콜백 대기) 에서 클라이언트가
* verify 즉시 응답을 받지 못할 때 상태를 추적하기 위한 엔드포인트.
*
* 노출 필드는 공개 안전 항목만 (시도 횟수·코드 본체·metadata 노출 금지) — Service::getStatus 참조.
*
* @param ShowChallengeRequest $request 검증된 요청
* @param IdentityVerificationLog $challenge 라우트 모델 바인딩으로 resolve 된 challenge 로그
* @return JsonResponse 공개 안전 상태 필드
*
* @since engine-v1.46.0
*/
public function show(ShowChallengeRequest $request, IdentityVerificationLog $challenge): JsonResponse
{
$status = $this->service->getStatus($challenge->id);
if ($status === null) {
return $this->error('identity.errors.challenge_not_found', 404);
}
return $this->success('common.success', $status);
}
/**
* 외부 IDV provider 의 redirect 콜백을 수신합니다. POST /api/identity/callback/{providerId}
*
* 외부 본인인증 SDK / OAuth-style provider 가 사용자 브라우저를 우리 서버로 다시 보내는 진입점.
* body/query 에서 challenge_id 를 추출 → Service::handleProviderCallback 위임.
*
* 응답 정책 — 클라이언트가 stash 한 페이지(`return` query) 가 있으면 redirect, 없으면 JSON 응답:
* - 성공 + return 있음: 302 → `{return}?verification_token=...`
* - 성공 + return 없음: 200 JSON `{ verification_token }`
* - 실패 + return 있음: 302 → `{return}?identity_error={failure_code}`
* - 실패 + return 없음: 422 JSON
*
* @param IdentityCallbackRequest $request 검증된 요청
* @param string $providerId 콜백을 보낸 provider 식별자
* @return JsonResponse|RedirectResponse
*
* @since engine-v1.46.0
*/
public function callback(IdentityCallbackRequest $request, string $providerId)
{
$validated = $request->validated();
$challengeId = (string) $validated['challenge_id'];
$returnUrl = (string) $request->query('return', '');
$result = $this->service->handleProviderCallback(
providerId: $providerId,
challengeId: $challengeId,
input: $validated,
context: [
'ip_address' => $request->ip(),
'user_agent' => substr((string) $request->userAgent(), 0, 512),
],
);
if (! $result->success) {
if ($returnUrl !== '' && $this->isSafeReturnUrl($returnUrl)) {
$sep = str_contains($returnUrl, '?') ? '&' : '?';
return redirect()->away(
$returnUrl.$sep.'identity_error='.urlencode($result->failureCode ?? 'UNKNOWN'),
);
}
return $this->error(
$result->failureReason ?: 'identity.errors.generic',
422,
['failure_code' => $result->failureCode],
);
}
$token = $result->claims['verification_token'] ?? '';
if ($returnUrl !== '' && $this->isSafeReturnUrl($returnUrl)) {
$sep = str_contains($returnUrl, '?') ? '&' : '?';
return redirect()->away(
$returnUrl.$sep.'verification_token='.urlencode((string) $token).'&challenge_id='.urlencode($challengeId),
);
}
return $this->success('identity.messages.challenge_verified', [
'challenge_id' => $result->challengeId,
'provider_id' => $result->providerId,
'verified_at' => $result->verifiedAt?->toIso8601String(),
'verification_token' => $token,
]);
}
/**
* `return` 쿼리 URL 이 같은 origin 인지 검증 — open redirect 차단.
*
* 절대 URL 이면 host 가 현재 앱 host 와 일치해야 통과, 상대 경로(`/...`) 는 통과.
*/
private function isSafeReturnUrl(string $url): bool
{
if ($url === '' || $url[0] === '/') {
return ! str_starts_with($url, '//'); // protocol-relative 차단
}
$appHost = parse_url((string) config('app.url'), PHP_URL_HOST);
$urlHost = parse_url($url, PHP_URL_HOST);
return $appHost !== null && $urlHost !== null && $appHost === $urlHost;
}
/**
* 등록된 프로바이더 목록을 반환합니다. GET /api/identity/providers
*
* @param ProvidersIndexRequest $request 검증된 요청
* @return JsonResponse 프로바이더 공개 메타데이터 목록
*/
public function providers(ProvidersIndexRequest $request): JsonResponse
{
$providers = array_values($this->manager->all());
$data = array_map(
fn ($p) => (new ProviderResource($p))->toArray($request),
$providers,
);
return $this->success('common.success', $data);
}
/**
* 등록된 purpose 목록을 반환합니다 (core.identity.purposes 필터 훅 통과).
* GET /api/identity/purposes
*
* @param PurposesIndexRequest $request 검증된 요청
* @return JsonResponse purpose 키 => 메타 매핑
*/
public function purposes(PurposesIndexRequest $request): JsonResponse
{
// 코어 기본 4종 + 활성 모듈/플러그인 `getIdentityPurposes()` 선언 +
// `core.identity.purposes` filter 훅 (서드파티 동적 확장) 을 모두 병합
$purposes = $this->manager->getAllPurposes();
$data = [];
foreach ($purposes as $key => $meta) {
$data[] = [
'id' => $key,
'label' => $this->resolvePurposeText($meta['label'] ?? $key),
'description' => $this->resolvePurposeText($meta['description'] ?? ''),
'default_provider' => $meta['default_provider'] ?? null,
'allowed_channels' => $meta['allowed_channels'] ?? [],
'source_type' => $meta['source_type'] ?? 'core',
'source_identifier' => $meta['source_identifier'] ?? 'core',
];
}
return $this->success('common.success', $data);
}
/**
* purpose meta 의 label/description 값을 현재 로케일 문자열로 정규화합니다.
*
* 입력 형태 3가지 지원:
* - i18n 키 문자열 (예: `identity.purposes.signup.label`) → `__()` 로 풀이
* - 다국어 배열 (`['ko' => ..., 'en' => ...]`) → 현재 로케일 우선, en 폴백
* - 일반 문자열 → 그대로 반환
*
* @param mixed $value
*/
private function resolvePurposeText($value): string
{
if (is_array($value)) {
$locale = app()->getLocale();
return (string) ($value[$locale] ?? $value['en'] ?? reset($value) ?: '');
}
if (! is_string($value) || $value === '') {
return '';
}
// i18n 키처럼 보이는 경우 (`identity.*` 또는 `*.purposes.*` 등)
if (str_contains($value, '.')) {
$translated = __($value);
return is_string($translated) ? $translated : $value;
}
return $value;
}
/**
* 지정된 scope+target 조합에 대한 정책을 조회합니다 (프론트엔드 프리페치용).
*
* GET /api/identity/policies/resolve?scope=route&target=api.me.password.update
* → 레이아웃 마운트 시 "이 페이지에서 IDV 가 요구될 수 있는 API" 를 미리 파악해
* UI 힌트(버튼 배지 "확인 필요" 등) 를 표시하기 위한 엔드포인트.
*
* @param ResolvePolicyRequest $request 검증된 요청 (scope+target query)
* @return JsonResponse 매칭 정책 요약 또는 null
*/
public function resolvePolicy(ResolvePolicyRequest $request): JsonResponse
{
$validated = $request->validated();
$scope = (string) $validated['scope'];
$target = (string) $validated['target'];
$policy = $this->policyService->resolve($scope, $target);
if (! $policy || ! $policy->enabled) {
return $this->success('common.success', null);
}
// 민감 필드는 노출하지 않고 UI 힌트에 필요한 최소 필드만 반환
return $this->success('common.success', [
'policy_key' => $policy->key,
'scope' => $policy->scope,
'target' => $policy->target,
'purpose' => $policy->purpose,
// 저장값을 그대로 내보내지 않는다 — 제거된 플러그인의 provider ID 가 공개 응답에
// 남지 않도록, 428 강제 경로와 같은 게터로 레지스트리 대조·폴백을 거친다 (A6a).
'provider_id' => $this->policyService->resolveProviderId($policy),
'grace_minutes' => $policy->grace_minutes,
'applies_to' => $policy->applies_to,
'fail_mode' => $policy->fail_mode,
]);
}
}