script/dom/reporting/
reportingendpoint.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::collections::HashMap;
6
7use bytes::Bytes;
8use headers::{ContentType, HeaderMapExt};
9use http::HeaderMap;
10use hyper_serde::Serde;
11use malloc_size_of_derive::MallocSizeOf;
12use net_traits::request::{
13    CredentialsMode, Destination, RequestBody, RequestId, RequestMode,
14    create_request_body_with_content,
15};
16use net_traits::{FetchMetadata, NetworkError, ResourceFetchTiming};
17use script_bindings::str::DOMString;
18use serde::Serialize;
19use servo_url::{ImmutableOrigin, ServoUrl};
20
21use crate::dom::bindings::codegen::Bindings::CSPViolationReportBodyBinding::CSPViolationReportBody;
22use crate::dom::bindings::codegen::Bindings::ReportingObserverBinding::Report;
23use crate::dom::bindings::codegen::Bindings::SecurityPolicyViolationEventBinding::SecurityPolicyViolationEventDisposition;
24use crate::dom::bindings::refcounted::Trusted;
25use crate::dom::bindings::root::DomRoot;
26use crate::dom::csp::Violation;
27use crate::dom::csppolicyviolationreport::serialize_disposition;
28use crate::dom::globalscope::GlobalScope;
29use crate::dom::performance::performanceresourcetiming::InitiatorType;
30use crate::fetch::fetch::{RequestWithGlobalScope, create_a_potential_cors_request};
31use crate::fetch::network_listener::{
32    FetchResponseListener, ResourceTimingListener, submit_timing,
33};
34
35/// <https://w3c.github.io/reporting/#endpoint>
36#[derive(Clone, Eq, Hash, MallocSizeOf, PartialEq)]
37pub(crate) struct ReportingEndpoint {
38    /// <https://w3c.github.io/reporting/#dom-endpoint-name>
39    name: DOMString,
40    /// <https://w3c.github.io/reporting/#dom-endpoint-url>
41    url: ServoUrl,
42    /// <https://w3c.github.io/reporting/#dom-endpoint-failures>
43    failures: u32,
44}
45
46impl ReportingEndpoint {
47    /// <https://w3c.github.io/reporting/#process-header>
48    pub(crate) fn parse_reporting_endpoints_header(
49        response_url: &ServoUrl,
50        headers: &Option<Serde<HeaderMap>>,
51    ) -> Option<Vec<ReportingEndpoint>> {
52        let headers = headers.as_ref()?;
53        let reporting_headers = headers.get_all("reporting-endpoints");
54        // Step 2. Let parsed header be the result of executing get a structured field value
55        // given "Reporting-Endpoints" and "dictionary" from response’s header list.
56        let mut parsed_header = Vec::new();
57        for header in reporting_headers.iter() {
58            let Some(header_value) = header.to_str().ok() else {
59                continue;
60            };
61            parsed_header.append(&mut header_value.split(",").map(|s| s.trim()).collect());
62        }
63        // Step 3. If parsed header is null, abort these steps.
64        if parsed_header.is_empty() {
65            return None;
66        }
67        // Step 4. Let endpoints be an empty list.
68        let mut endpoints = Vec::new();
69        // Step 5. For each name → value_and_parameters of parsed header:
70        for header in parsed_header {
71            // There could be a '=' in the URL itself (for example query parameters). Therefore, we can't
72            // split on '=', but instead look for the first one.
73            let Some(split_index) = header.find('=') else {
74                continue;
75            };
76            // Step 5.1. Let endpoint url string be the first element of the tuple value_and_parameters.
77            // If endpoint url string is not a string, then continue.
78            let (name, endpoint_url_string) = header.split_at(split_index);
79            let length = endpoint_url_string.len();
80            let endpoint_bytes = endpoint_url_string.as_bytes();
81            // Note that the first character is the '=' and we check for the next and last character to be '"'
82            if length < 3 || endpoint_bytes[1] != b'"' || endpoint_bytes[length - 1] != b'"' {
83                continue;
84            }
85            // The '="' at the start and '"' at the end removed
86            let endpoint_url_value = &endpoint_url_string[2..length - 1];
87            // Step 5.2. Let endpoint url be the result of executing the URL parser on endpoint url string,
88            // with base URL set to response’s url. If endpoint url is failure, then continue.
89            let Ok(endpoint_url) =
90                ServoUrl::parse_with_base(Some(response_url), endpoint_url_value)
91            else {
92                continue;
93            };
94            // Step 5.3. If endpoint url’s origin is not potentially trustworthy, then continue.
95            if !endpoint_url.is_potentially_trustworthy() {
96                continue;
97            }
98            // Step 5.4. Let endpoint be a new endpoint whose properties are set as follows:
99            // Step 5.5. Add endpoint to endpoints.
100            endpoints.push(ReportingEndpoint {
101                name: name.into(),
102                url: endpoint_url,
103                failures: 0,
104            });
105        }
106        Some(endpoints)
107    }
108}
109
110pub(crate) trait SendReportsToEndpoints {
111    /// <https://w3c.github.io/reporting/#send-reports>
112    fn send_reports_to_endpoints(&self, reports: Vec<Report>, endpoints: Vec<ReportingEndpoint>);
113    /// <https://w3c.github.io/reporting/#try-delivery>
114    fn attempt_to_deliver_reports_to_endpoints(
115        &self,
116        endpoint: &ServoUrl,
117        origin: ImmutableOrigin,
118        reports: &[&Report],
119    );
120    /// <https://w3c.github.io/reporting/#serialize-a-list-of-reports-to-json>
121    fn serialize_list_of_reports(reports: &[&Report]) -> Option<RequestBody>;
122}
123
124impl SendReportsToEndpoints for GlobalScope {
125    fn send_reports_to_endpoints(
126        &self,
127        mut reports: Vec<Report>,
128        endpoints: Vec<ReportingEndpoint>,
129    ) {
130        // Step 1. Let endpoint map be an empty map of endpoint objects to lists of report objects.
131        let mut endpoint_map: HashMap<&ReportingEndpoint, Vec<Report>> = HashMap::new();
132        // Step 2. For each report in reports:
133        reports.retain(|report| {
134            // Step 2.1. If there exists an endpoint (endpoint) in context’s endpoints
135            // list whose name is report’s destination:
136            if let Some(endpoint) = endpoints.iter().find(|e| e.name == report.destination) {
137                // Step 2.1.1. Append report to endpoint map’s list of reports for endpoint.
138                endpoint_map
139                    .entry(endpoint)
140                    .or_default()
141                    .push(report.clone());
142                true
143            } else {
144                // Step 2.1.2. Otherwise, remove report from reports.
145                false
146            }
147        });
148        // Step 3. For each (endpoint, report list) pair in endpoint map:
149        for (endpoint, report_list) in endpoint_map.iter() {
150            // Step 3.1. Let origin map be an empty map of origins to lists of report objects.
151            let mut origin_map: HashMap<ImmutableOrigin, Vec<&Report>> = HashMap::new();
152            // Step 3.2. For each report in report list:
153            for report in report_list {
154                let Ok(url) = ServoUrl::parse(&report.url.str()) else {
155                    continue;
156                };
157                // Step 3.2.1. Let origin be the origin of report’s url.
158                let origin = url.origin();
159                // Step 3.2.2. Append report to origin map’s list of reports for origin.
160                origin_map.entry(origin).or_default().push(report);
161            }
162            // Step 3.3. For each (origin, per-origin reports) pair in origin map,
163            // execute the following steps asynchronously:
164            for (origin, origin_report_list) in origin_map.iter() {
165                // Step 3.3.1. Let result be the result of executing
166                // § 3.5.2 Attempt to deliver reports to endpoint on endpoint, origin, and per-origin reports.
167                self.attempt_to_deliver_reports_to_endpoints(
168                    &endpoint.url,
169                    origin.clone(),
170                    origin_report_list,
171                );
172                // Step 3.3.2. If result is "Failure":
173                // TODO(37238)
174                // Step 3.3.2.1. Increment endpoint’s failures.
175                // TODO(37238)
176                // Step 3.3.3. If result is "Remove Endpoint":
177                // TODO(37238)
178                // Step 3.3.3.1 Remove endpoint from context’s endpoints list.
179                // TODO(37238)
180                // Step 3.3.4. Remove each report from reports.
181                // TODO(37238)
182            }
183        }
184    }
185
186    fn attempt_to_deliver_reports_to_endpoints(
187        &self,
188        endpoint: &ServoUrl,
189        origin: ImmutableOrigin,
190        reports: &[&Report],
191    ) {
192        // Step 1. Let body be the result of executing serialize a list of reports to JSON on reports.
193        let request_body = Self::serialize_list_of_reports(reports);
194        // Step 2. Let request be a new request with the following properties [FETCH]:
195        let mut headers = HeaderMap::with_capacity(1);
196        headers.typed_insert(ContentType::from(
197            "application/reports+json".parse::<mime::Mime>().unwrap(),
198        ));
199        let request = create_a_potential_cors_request(
200            None,
201            endpoint.clone(),
202            Destination::Report,
203            None,
204            None,
205            self.get_referrer(),
206        )
207        .with_global_scope(self)
208        .method(http::Method::POST)
209        .body(request_body)
210        .origin(origin)
211        .mode(RequestMode::CorsMode)
212        .credentials_mode(CredentialsMode::CredentialsSameOrigin)
213        .unsafe_request(true)
214        .headers(headers);
215        // Step 3. Queue a task to fetch request.
216        self.fetch(
217            request,
218            CSPReportEndpointFetchListener {
219                endpoint: endpoint.clone(),
220                global: Trusted::new(self),
221            },
222            self.task_manager().networking_task_source().into(),
223        );
224        // Step 4. Wait for a response (response).
225        // TODO(37238)
226        // Step 5. If response’s status is an OK status (200-299), return "Success".
227        // TODO(37238)
228        // Step 6. If response’s status is 410 Gone [RFC9110], return "Remove Endpoint".
229        // TODO(37238)
230        // Step 7. Return "Failure".
231        // TODO(37238)
232    }
233
234    fn serialize_list_of_reports(reports: &[&Report]) -> Option<RequestBody> {
235        // Step 1. Let collection be an empty list.
236        // Step 2. For each report in reports:
237        let report_body: Vec<SerializedReport> = reports
238            .iter()
239            // Step 2.1. Let data be a map with the following key/value pairs:
240            .map(|r| SerializedReport {
241                // TODO(37238)
242                age: 0,
243                type_: r.type_.to_string(),
244                url: r.url.to_string(),
245                user_agent: String::new(),
246                body: r.body.clone().map(|b| b.into()),
247            })
248            // Step 2.2. Increment report’s attempts.
249            // TODO(37238)
250            // Step 2.3. Append data to collection.
251            .collect();
252        // Step 3. Return the byte sequence resulting from executing serialize an
253        // Infra value to JSON bytes on collection.
254        Some(create_request_body_with_content(
255            serde_json::to_string(&report_body).unwrap_or_default(),
256        ))
257    }
258}
259
260#[derive(Serialize)]
261struct SerializedReport {
262    age: u64,
263    #[serde(rename = "type")]
264    type_: String,
265    url: String,
266    user_agent: String,
267    body: Option<CSPReportingEndpointBody>,
268}
269
270#[derive(Clone, Debug, Serialize)]
271#[serde(rename_all = "camelCase")]
272pub(crate) struct CSPReportingEndpointBody {
273    sample: Option<String>,
274    #[serde(rename = "blockedURL")]
275    blocked_url: Option<String>,
276    referrer: Option<String>,
277    status_code: u16,
278    #[serde(rename = "documentURL")]
279    document_url: String,
280    source_file: Option<String>,
281    effective_directive: String,
282    line_number: Option<u32>,
283    column_number: Option<u32>,
284    original_policy: String,
285    #[serde(serialize_with = "serialize_disposition")]
286    disposition: SecurityPolicyViolationEventDisposition,
287}
288
289impl From<CSPViolationReportBody> for CSPReportingEndpointBody {
290    fn from(value: CSPViolationReportBody) -> Self {
291        CSPReportingEndpointBody {
292            sample: value.sample.map(String::from),
293            blocked_url: value.blockedURL.map(String::from),
294            referrer: value.referrer.map(String::from),
295            status_code: value.statusCode,
296            document_url: String::from(value.documentURL),
297            source_file: value.sourceFile.map(String::from),
298            effective_directive: String::from(value.effectiveDirective),
299            line_number: value.lineNumber,
300            column_number: value.columnNumber,
301            original_policy: value.originalPolicy.into(),
302            disposition: value.disposition,
303        }
304    }
305}
306
307struct CSPReportEndpointFetchListener {
308    /// Endpoint URL of this request.
309    endpoint: ServoUrl,
310    /// The global object fetching the report uri violation
311    global: Trusted<GlobalScope>,
312}
313
314impl FetchResponseListener for CSPReportEndpointFetchListener {
315    fn process_request_body(&mut self, _: RequestId) {}
316
317    fn process_response(
318        &mut self,
319        _: &mut js::context::JSContext,
320        _: RequestId,
321        fetch_metadata: Result<FetchMetadata, NetworkError>,
322    ) {
323        _ = fetch_metadata;
324    }
325
326    fn process_response_chunk(
327        &mut self,
328        _: &mut js::context::JSContext,
329        _: RequestId,
330        chunk: Bytes,
331    ) {
332        _ = chunk;
333    }
334
335    fn process_response_eof(
336        self,
337        cx: &mut js::context::JSContext,
338        _: RequestId,
339        response: Result<(), NetworkError>,
340        timing: ResourceFetchTiming,
341    ) {
342        submit_timing(cx, &self, &response, &timing);
343    }
344
345    fn process_csp_violations(
346        &mut self,
347        _cx: &mut js::context::JSContext,
348        _request_id: RequestId,
349        _violations: Vec<Violation>,
350    ) {
351    }
352}
353
354impl ResourceTimingListener for CSPReportEndpointFetchListener {
355    fn resource_timing_information(&self) -> (InitiatorType, ServoUrl) {
356        (InitiatorType::Other, self.endpoint.clone())
357    }
358
359    fn resource_timing_global(&self) -> DomRoot<GlobalScope> {
360        self.global.root()
361    }
362}
script/dom/reporting/reportingendpoint.rs

script/dom/reporting/
reportingendpoint.rs
