Reporting API v1로 이전

Reporting API의 새 버전을 사용할 수 있습니다. 더 개인 정보 보호가 강화되며 여러 브라우저에서 지원될 가능성이 더 높습니다.

Maud Nalpas

Reporting API는 방문자가 사이트를 사용할 때 발생하는 오류에 관해 알려줍니다. 브라우저 개입, 브라우저 비정상 종료, 콘텐츠 보안 정책 위반, COOP/COEP 위반, 지원 중단 경고 등을 확인할 수 있습니다.

Reporting API의 새 버전을 사용할 수 있습니다. 새 API는 더 간소화되었으며 여러 브라우저에서 지원될 가능성이 더 높습니다.

요약

사이트 개발자

사이트에 이미 보고 기능이 있는 경우: 새 헤더(Reporting-Endpoints)를 사용하여 v1로 이전하되 기존 헤더는 잠시 유지합니다(Report-To). 이전: 코드 예시를 참고하세요.

지금 사이트에 보고 기능을 추가하는 경우: 새 헤더(Reporting-Endpoints)만 사용합니다.

⚠️ 두 경우 모두 보고서를 생성할 수 있는 모든 응답에 Reporting-Endpoints 헤더를 설정해야 합니다.

보고 서비스 개발자

엔드포인트 서비스를 유지 관리하거나 자체 엔드포인트 서비스를 운영하는 경우 개발자 또는 외부 개발자가 Reporting API v1(Reporting-Endpoints 헤더)로 이전할 때 트래픽이 증가할 것으로 예상됩니다.

자세한 내용과 코드 예시는 계속 읽어보세요.

네트워크 오류 로깅

네트워크 오류 로깅을 위한 새로운 메커니즘이 개발됩니다. 이 메커니즘이 제공되면 Reporting API v0에서 이 새로운 메커니즘으로 전환하세요.

데모 및 코드

• 데모 사이트: 새로운 보고 API(v1)
• 데모 사이트의 코드

v0과 v1의 차이점

변경사항

• API 노출 영역이 다릅니다.

 Report-To: { group: "main-endpoint", "max_age": 86400, "endpoints": [ { "url": ... }, { "url": ... }] }, { group: "default-endpoint", "max_age": 86400, "endpoints": [ { "url": ... }, { "url": ... }] }
 Document-Policy: ...; report-to main-endpoint

 Reporting-Endpoints: main-endpoint="https://reports.example/main", default="https://reports.example/default"
 Document-Policy: ...; report-to main-endpoint

• 보고서의 범위가 다릅니다.

• 두 API 모두 동일한 보고서 유형을 지원하지만 한 가지 예외가 있습니다. v1은 네트워크 오류 보고서를 지원하지 않습니다. 자세한 내용은 이전 단계를 참고하세요.
• v0은 브라우저에서 지원되지 않으며 앞으로도 지원되지 않을 예정입니다. v1은 향후 여러 브라우저에서 지원될 가능성이 높습니다.

변경되지 않는 사항

• 보고서의 형식과 구조는 변경되지 않습니다.
• 브라우저에서 엔드포인트로 전송한 요청은 Content-typeapplication/reports+json의 POST 요청으로 유지됩니다.
• 특정 엔드포인트를 특정 보고서 유형에 매핑하는 기능은 v0과 v1에서 모두 지원됩니다.
• default 엔드포인트의 역할은 변경되지 않습니다.

• Reporting API v1은 ReportingObserver에 영향을 미치지 않습니다. ReportingObserver는 계속해서 모든 관찰 가능한 보고서에 액세스할 수 있으며 형식은 동일합니다.

v0과 v1의 모든 차이점

엔드포인트 개발자: 트래픽 증가 예상

자체 서버를 보고 엔드포인트로 설정했거나 보고서 수집기를 서비스로 개발 또는 유지관리하는 경우 해당 엔드포인트로 더 많은 트래픽이 발생할 것으로 예상됩니다.

Reporting API v0과 달리 Reporting API v1에서는 보고서가 일괄 처리되지 않기 때문입니다. 따라서 애플리케이션 개발자가 Reporting API v1로 마이그레이션하기 시작하면 보고서 수는 그대로 유지되지만 엔드포인트 서버에 대한 요청 볼륨이 증가합니다.

애플리케이션 개발자: Reporting-Endpoints(v1)로 이전

어떻게 해야 할까요?

새 Reporting API (v1)를 사용하면 다음과 같은 몇 가지 이점이 있습니다 ✅:

• 브라우저 신호가 긍정적입니다. 즉, Chrome 및 Edge에서만 지원되는 v0과 달리 v1에서는 브라우저 간 지원이 예상됩니다.
• API가 더 간소해졌습니다.
• 도구는 새로운 Reporting API (v1)를 중심으로 개발되고 있습니다.

이를 기준으로 보면 다음과 같습니다.

• 사이트에서 이미 Report-To 헤더와 함께 Reporting API v0을 사용하는 경우 Reporting API v1로 이전합니다(이전 단계 참고). 사이트에서 이미 Content-Security-Policy 위반에 대한 보고 기능을 사용하는 경우 구체적인 CSP 보고 이전 단계를 확인하세요.
• 사이트에서 아직 Reporting API를 사용하지 않고 보고 기능을 추가하는 경우 새 Reporting API(v1)(Reporting-Endpoints 헤더)를 사용하세요. 단, 한 가지 예외가 있습니다. 네트워크 오류 로깅을 사용해야 하는 경우에는 Report-To (v0)을 사용하세요. 네트워크 오류 로깅은 현재 Reporting API v1에서 지원되지 않습니다. 네트워크 오류 로깅을 위한 새로운 메커니즘이 개발될 예정입니다. 그러려면 Reporting API v0을 사용하세요. 다른 보고서 유형과 함께 네트워크 오류 로깅이 필요한 경우 Report-To(v0) 및 Reporting-Endpoints(v1)을 모두 사용합니다. v0은 네트워크 오류 로깅을 제공하고 v1은 다른 모든 유형의 보고서를 제공합니다.

이전 단계

이 이전의 목표는 v0에서 가져오던 보고서를 잃지 않는 것입니다.

1. 1단계(지금 실행): Report-To(v0) 및 Reporting-Endpoints(v1) 두 헤더를 모두 사용합니다.

   이 기능을 사용하면 다음과 같은 이점이 있습니다.

   • Reporting-Endpoints(v1) 덕분에 최신 Chrome 및 Edge 클라이언트의 신고
   • Report-To(v0) 덕분에 이전 Chrome 및 Edge 클라이언트의 신고

   Reporting-Endpoints를 지원하는 브라우저 인스턴스는 Reporting-Endpoints를 사용하고 지원하지 않는 인스턴스는 Report-To로 대체됩니다. 요청 및 보고서 형식은 v0과 v1에서 동일합니다.

2. 2단계(지금 실행): 보고서를 생성할 수 있는 모든 응답에 Reporting-Endpoints 헤더가 설정되어 있는지 확인합니다.

   v0에서는 일부 응답에만 보고 엔드포인트를 설정할 수 있으며 해당 출처의 다른 문서(페이지)는 이 '대기' 엔드포인트를 사용합니다. v1에서는 범위 설정의 차이로 인해 보고서를 생성할 수 있는 모든 응답에 Reporting-Endpoints 헤더를 설정해야 합니다.

3. 3단계(나중에 시작): 모든 사용자 또는 대부분의 사용자가 최신 Chrome 또는 Edge 설치(96 이상)로 업데이트되면 Report-To(v0)를 삭제하고 Reporting-Endpoints만 유지합니다.

   한 가지 예외: 네트워크 오류 로깅 보고서가 필요한 경우 네트워크 오류 로깅을 위한 새로운 메커니즘이 마련될 때까지 Report-To를 유지합니다.

이전 쿠킹북에서 코드 예시를 확인하세요.

CSP 보고를 위한 이전 단계

Content-Security-Policy 위반 보고서를 구성하는 방법에는 두 가지가 있습니다.

• report-uri 지시문을 통해 CSP 헤더만 사용 Chrome, Firefox, Safari, Edge 전반에서 폭넓은 브라우저를 지원합니다 보고서는 content-type application/csp-report으로 전송되며 CSP별 형식을 사용합니다. 이러한 보고서를 'CSP 수준 2 보고서'라고 하며 Reporting API를 사용하지 않습니다.
• Reporting API 사용 시 Report-To 헤더 (기존) 또는 최신 Reporting-Endpoints (v1)를 통해 작동합니다. 이 기능은 Chrome 및 Edge에서만 지원됩니다. 보고서 요청은 다른 Reporting API 요청과 동일한 형식과 동일한 콘텐츠 유형 application/reports+json을 사용합니다.

첫 번째 접근 방식(report-uri만 사용)은 더 이상 권장되지 않으며 두 번째 접근 방식을 사용하면 몇 가지 이점이 있습니다. 특히 Reporting API⏤CSP 및 기타를 통해 생성된 모든 보고서 요청은 동일한 형식 application/reports+json이므로 단일 방법을 사용하여 모든 보고서 유형에 대한 보고를 설정하고 일반 엔드포인트를 설정할 수 있습니다.

하지만 report-to를 지원하는 브라우저는 일부에 불과합니다. 따라서 여러 브라우저에서 CSP 위반 신고를 받으려면 Reporting API 접근 방식 (Report-To 이상, Reporting-Endpoints)과 함께 report-uri를 유지하는 것이 좋습니다. report-uri 및 report-to를 인식하는 브라우저에서는 report-to가 있으면 report-uri이 무시됩니다. report-uri만 인식하는 브라우저에서는 report-uri만 고려됩니다.

1. 1단계(지금 실행): 아직 추가하지 않았다면 report-uri와 함께 report-to를 추가합니다. report-uri만 지원하는 브라우저(Firefox)는 report-uri를 사용하고 report-to도 지원하는 브라우저(Chrome, Edge)는 report-to를 사용합니다. report-to에서 사용할 이름이 지정된 엔드포인트를 지정하려면 헤더 Report-To와 Reporting-Endpoints를 모두 사용합니다. 이렇게 하면 이전 Chrome 및 Edge 클라이언트와 최신 Chrome 및 Edge 클라이언트 모두에서 신고를 받을 수 있습니다.

2. 3단계(나중에 시작): 모든 사용자 또는 대부분의 사용자가 최신 Chrome 또는 Edge 설치(96 이상)로 업데이트되면 Report-To(v0)를 삭제하고 Reporting-Endpoints만 유지합니다. report-uri를 유지하면 지원되는 브라우저에 대한 보고서만 계속 받을 수 있습니다.

CSP 보고 이전에서 이러한 단계의 코드 예시를 참고하세요.

이전: 코드 예시

개요

기존 Reporting API (v0)를 사용하여 COOP(Cross-Origin-Opener-Policy 헤더), COEP (Cross-Origin-Embedder-Policy) 또는 문서 정책(Document-Policy 헤더)에 대한 위반 보고서를 가져오는 경우 Reporting API v1로 이전할 때 이러한 정책 헤더를 직접 변경할 필요가 없습니다. 레거시 Report-To 헤더에서 새 Reporting-Endpoints 헤더로 이전해야 합니다.

기존 Reporting API(v0)를 사용하여 CSP(Content-Security-Policy 헤더)의 위반 보고서를 가져오는 경우 새 Reporting API(v1)로 이전하는 과정에서 Content-Security-Policy를 조정해야 할 수 있습니다.

기본 이전

Report-To: { group: "main-endpoint", "endpoints": [ { "url": "https://reports.example/main" }] }, { group: "default-endpoint", "endpoints": [ { "url": "https://reports.example/default" }] }

Reporting-Endpoints: main-endpoint="https://reports.example/main", default="https://reports.example/default"
Report-To: { group: "main-endpoint", "max_age": 86400, "endpoints": [ { "url": "https://reports.example/main" }] }, { group: "default-endpoint", "max_age": 86400, "endpoints": [ { "url": "https://reports.example/default" }] }

Reporting-Endpoints: main-endpoint="https://reports.example/main", default="https://reports.example/default"

v1에서도 특정 보고서 유형을 특정 엔드포인트에 보낼 수 있습니다. 하지만 엔드포인트당 URL은 하나만 있을 수 있습니다.

모든 페이지 관찰

app.get("/", (request, response) => {
  response.set("Report-To", …)
  response.render(...)
});
app.get("/page1", (request, response) => {
  response.render(...)
});

// Use a middleware to set the reporting endpoint(s) for *all* requests.
app.use(function(request, response, next) {
  response.set("Reporting-Endpoints", …);
  next();
});

app.get("/", (request, response) => {
  response.render(...)
});

app.get("/page1", (request, response) => {
  response.render(...)
});

CSP 보고 이전

Content-Security-Policy: ...; report-uri https://reports.example/main

Content-Security-Policy: ...; report-uri https://reports.example/main; report-to main-endpoint
Report-To: main-endpoint="https://reports.example/main"

Content-Security-Policy: ...; report-uri https://reports.example/main; report-to main-endpoint
Reporting-Endpoints: main-endpoint="https://reports.example/main"
Report-To: ...

추가 자료

• Reporting API로 웹 애플리케이션 모니터링 (Reporting API에 대한 기본 게시물)
• 사양: 기존 Reporting API(v0)
• 사양: 새로운 Reporting API(v1)

이 글에 대한 검토와 제안을 제공해 주신 이안 클렐랜드, 에이지 키타무라, 밀리카 미하일리야에게 감사의 인사를 전합니다.