Skip to main content

net/
resource_thread.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
5//! A thread that takes a URL and streams back the binary data.
6
7use std::borrow::ToOwned;
8use std::collections::HashMap;
9use std::fs::File;
10use std::io::{self, BufReader};
11use std::path::{Path, PathBuf};
12use std::sync::{Arc, Weak};
13use std::thread;
14
15use cookie::Cookie;
16use crossbeam_channel::Sender;
17use devtools_traits::DevtoolsControlMsg;
18use embedder_traits::GenericEmbedderProxy;
19use hyper_serde::Serde;
20use ipc_channel::ipc::IpcSender;
21use log::{debug, trace, warn};
22use net_traits::blob_url_store::{BlobTokenCommunicator, parse_blob_url};
23use net_traits::filemanager_thread::FileTokenCheck;
24use net_traits::pub_domains::public_suffix_list_size_of;
25use net_traits::request::{Destination, PreloadEntry, PreloadId, RequestBuilder, RequestId};
26use net_traits::response::{Response, ResponseInit};
27use net_traits::{
28    AsyncRuntime, CookieAsyncResponse, CookieData, CookieSource, CoreResourceMsg,
29    CoreResourceThread, CustomResponseMediator, DiscardFetch, FetchChannels, FetchTaskTarget,
30    ResourceFetchTiming, ResourceThreads, ResourceTimingType, WebSocketDomAction,
31    WebSocketNetworkEvent,
32};
33use parking_lot::{Mutex, RwLock};
34use profile_traits::mem::{
35    ProcessReports, ProfilerChan as MemProfilerChan, Report, ReportKind, ReportsChan,
36    perform_memory_report,
37};
38use profile_traits::path;
39use profile_traits::time::ProfilerChan;
40use rustc_hash::FxHashMap;
41use rustls_pki_types::CertificateDer;
42use rustls_pki_types::pem::PemObject;
43use serde::{Deserialize, Serialize};
44use servo_base::generic_channel::{
45    self, CallbackSetter, GenericCallback, GenericReceiver, GenericReceiverSet,
46    GenericSelectionResult,
47};
48use servo_base::id::CookieStoreId;
49use servo_url::{ImmutableOrigin, ServoUrl};
50use tokio::sync::Mutex as TokioMutex;
51
52use crate::async_runtime::{init_async_runtime, spawn_task};
53use crate::connector::{
54    CACertificates, CertificateErrorOverrideManager, create_http_client, create_tls_config,
55};
56use crate::cookie::ServoCookie;
57use crate::cookie_storage::CookieStorage;
58use crate::embedder::NetToEmbedderMsg;
59use crate::fetch::cors_cache::CorsCache;
60use crate::fetch::fetch_params::{FetchParams, SharedPreloadedResources};
61use crate::fetch::methods::{
62    AutoRequestBodyStreamCloser, CancellationListener, FetchContext,
63    SharedInflightKeepAliveRecords, WebSocketChannel, fetch,
64    transfers_request_body_stream_to_later_manual_redirect,
65};
66use crate::filemanager_thread::FileManager;
67use crate::hsts::{self, HstsList};
68use crate::http_cache::HttpCache;
69use crate::http_loader::{HttpState, http_redirect_fetch};
70use crate::protocols::ProtocolRegistry;
71use crate::request_interceptor::RequestInterceptor;
72use crate::websocket_loader::create_handshake_request;
73
74/// Load a file with CA certificate and produce a RootCertStore with the results.
75fn load_root_cert_store_from_file(file_path: String) -> io::Result<Vec<CertificateDer<'static>>> {
76    let mut pem = BufReader::new(File::open(file_path)?);
77
78    let certs = CertificateDer::pem_reader_iter(&mut pem)
79        .filter_map(|cert| {
80            cert.inspect_err(|e| log::error!("Could not load certificate ({e}). Ignoring it."))
81                .ok()
82        })
83        .collect();
84    Ok(certs)
85}
86
87/// Returns a tuple of (public, private) senders to the new threads.
88#[expect(clippy::too_many_arguments)]
89pub fn new_resource_threads(
90    devtools_sender: Option<Sender<DevtoolsControlMsg>>,
91    time_profiler_chan: ProfilerChan,
92    mem_profiler_chan: MemProfilerChan,
93    embedder_proxy: GenericEmbedderProxy<NetToEmbedderMsg>,
94    config_dir: Option<PathBuf>,
95    certificate_path: Option<String>,
96    ignore_certificate_errors: bool,
97    protocols: Arc<ProtocolRegistry>,
98) -> (ResourceThreads, ResourceThreads, Box<dyn AsyncRuntime>) {
99    // Initialize the async runtime, and get a handle to it for use in clean shutdown.
100    let async_runtime = init_async_runtime();
101
102    let ca_certificates = certificate_path
103        .and_then(|path| {
104            Some(CACertificates::Override(
105                load_root_cert_store_from_file(path).ok()?,
106            ))
107        })
108        .unwrap_or_default();
109
110    let (public_core, private_core) = new_core_resource_thread(
111        devtools_sender,
112        time_profiler_chan,
113        mem_profiler_chan,
114        embedder_proxy,
115        config_dir,
116        ca_certificates,
117        ignore_certificate_errors,
118        protocols,
119    );
120    (
121        ResourceThreads::new(public_core),
122        ResourceThreads::new(private_core),
123        async_runtime,
124    )
125}
126
127/// Create a CoreResourceThread
128#[expect(clippy::too_many_arguments)]
129pub fn new_core_resource_thread(
130    devtools_sender: Option<Sender<DevtoolsControlMsg>>,
131    time_profiler_chan: ProfilerChan,
132    mem_profiler_chan: MemProfilerChan,
133    embedder_proxy: GenericEmbedderProxy<NetToEmbedderMsg>,
134    config_dir: Option<PathBuf>,
135    ca_certificates: CACertificates<'static>,
136    ignore_certificate_errors: bool,
137    protocols: Arc<ProtocolRegistry>,
138) -> (CoreResourceThread, CoreResourceThread) {
139    let (public_setup_chan, public_setup_port) = generic_channel::channel().unwrap();
140    let (private_setup_chan, private_setup_port) = generic_channel::channel().unwrap();
141    let (report_chan, report_port) = generic_channel::channel().unwrap();
142    let (revoke_sender, revoke_receiver) = generic_channel::channel().unwrap();
143    let (refresh_sender, refresh_receiver) = generic_channel::channel().unwrap();
144
145    let blob_token_communicator = Arc::new(Mutex::new(BlobTokenCommunicator {
146        revoke_sender,
147        refresh_token_sender: refresh_sender,
148    }));
149    thread::Builder::new()
150        .name("ResourceManager".to_owned())
151        .spawn(move || {
152            let resource_manager = CoreResourceManager::new(
153                devtools_sender,
154                time_profiler_chan,
155                embedder_proxy.clone(),
156                ca_certificates.clone(),
157                ignore_certificate_errors,
158                blob_token_communicator,
159            );
160
161            let mut channel_manager = ResourceChannelManager {
162                resource_manager,
163                config_dir,
164                ca_certificates,
165                ignore_certificate_errors,
166                cancellation_listeners: Default::default(),
167                cookie_listeners: Default::default(),
168            };
169
170            mem_profiler_chan.run_with_memory_reporting(
171                || {
172                    channel_manager.start(
173                        public_setup_port,
174                        private_setup_port,
175                        report_port,
176                        revoke_receiver,
177                        refresh_receiver,
178                        protocols,
179                        embedder_proxy,
180                    )
181                },
182                String::from("network-cache-reporter"),
183                report_chan,
184                CoreResourceMsg::CollectMemoryReport,
185            );
186        })
187        .expect("Thread spawning failed");
188    (public_setup_chan, private_setup_chan)
189}
190
191struct ResourceChannelManager {
192    resource_manager: CoreResourceManager,
193    config_dir: Option<PathBuf>,
194    ca_certificates: CACertificates<'static>,
195    ignore_certificate_errors: bool,
196    cancellation_listeners: FxHashMap<RequestId, Weak<CancellationListener>>,
197    cookie_listeners: FxHashMap<CookieStoreId, GenericCallback<CookieAsyncResponse>>,
198}
199
200/// This returns a tuple HttpState and a private HttpState.
201fn create_http_states(
202    config_dir: Option<&Path>,
203    ca_certificates: CACertificates<'static>,
204    ignore_certificate_errors: bool,
205    embedder_proxy: GenericEmbedderProxy<NetToEmbedderMsg>,
206) -> (Arc<HttpState>, Arc<HttpState>) {
207    let mut hsts_list = HstsList::default();
208    let mut auth_cache = AuthCache::default();
209    let mut cookie_jar = CookieStorage::new(150);
210    if let Some(config_dir) = config_dir {
211        servo_base::read_json_from_file(&mut auth_cache, config_dir, "auth_cache.json");
212        servo_base::read_json_from_file(&mut hsts_list, config_dir, "hsts_list.json");
213        servo_base::read_json_from_file(&mut cookie_jar, config_dir, "cookie_jar.json");
214    }
215
216    let override_manager = CertificateErrorOverrideManager::new();
217    let http_state = HttpState {
218        hsts_list: RwLock::new(hsts_list),
219        cookie_jar: RwLock::new(cookie_jar),
220        auth_cache: RwLock::new(auth_cache),
221        history_states: RwLock::new(FxHashMap::default()),
222        http_cache: HttpCache::default(),
223        client: create_http_client(create_tls_config(
224            ca_certificates.clone(),
225            ignore_certificate_errors,
226            override_manager.clone(),
227        )),
228        override_manager,
229        embedder_proxy: embedder_proxy.clone(),
230    };
231
232    let override_manager = CertificateErrorOverrideManager::new();
233    let private_http_state = HttpState {
234        hsts_list: RwLock::new(HstsList::default()),
235        cookie_jar: RwLock::new(CookieStorage::new(150)),
236        auth_cache: RwLock::new(AuthCache::default()),
237        history_states: RwLock::new(FxHashMap::default()),
238        http_cache: HttpCache::default(),
239        client: create_http_client(create_tls_config(
240            ca_certificates,
241            ignore_certificate_errors,
242            override_manager.clone(),
243        )),
244        override_manager,
245        embedder_proxy,
246    };
247
248    (Arc::new(http_state), Arc::new(private_http_state))
249}
250
251impl ResourceChannelManager {
252    #[expect(clippy::too_many_arguments)]
253    fn start(
254        &mut self,
255        public_receiver: GenericReceiver<CoreResourceMsg>,
256        private_receiver: GenericReceiver<CoreResourceMsg>,
257        memory_reporter: GenericReceiver<CoreResourceMsg>,
258        revoke_receiver: GenericReceiver<CoreResourceMsg>,
259        refresh_receiver: GenericReceiver<CoreResourceMsg>,
260        protocols: Arc<ProtocolRegistry>,
261        embedder_proxy: GenericEmbedderProxy<NetToEmbedderMsg>,
262    ) {
263        let (public_http_state, private_http_state) = create_http_states(
264            self.config_dir.as_deref(),
265            self.ca_certificates.clone(),
266            self.ignore_certificate_errors,
267            embedder_proxy,
268        );
269
270        let mut rx_set = GenericReceiverSet::new();
271        let private_id = rx_set.add(private_receiver);
272        let public_id = rx_set.add(public_receiver);
273        let reporter_id = rx_set.add(memory_reporter);
274        let revoker_id = rx_set.add(revoke_receiver);
275        let refresh_id = rx_set.add(refresh_receiver);
276        let mut selector = rx_set.selector();
277
278        loop {
279            for received in selector.select().into_iter() {
280                // Handles case where profiler thread shuts down before resource thread.
281                match received {
282                    GenericSelectionResult::ChannelClosed(_) => continue,
283                    GenericSelectionResult::Error(error) => {
284                        log::error!("Found selection error: {error}")
285                    },
286                    GenericSelectionResult::MessageReceived(id, msg) => {
287                        if id == revoker_id {
288                            let CoreResourceMsg::RevokeTokenForFile(revocation_request) = msg
289                            else {
290                                log::error!("Blob revocation channel received unexpected message");
291                                continue;
292                            };
293                            self.resource_manager.filemanager.invalidate_token(
294                                &FileTokenCheck::Required(revocation_request.token),
295                                &revocation_request.blob_id,
296                            )
297                        } else if id == refresh_id {
298                            let CoreResourceMsg::RefreshTokenForFile(refresh_request) = msg else {
299                                log::error!("Blob revocation channel received unexpected message");
300                                continue;
301                            };
302
303                            let FileTokenCheck::Required(refreshed_token) = self
304                                .resource_manager
305                                .filemanager
306                                .get_token_for_file(&refresh_request.blob_id, true)
307                            else {
308                                unreachable!();
309                            };
310                            let _ = refresh_request.new_token_sender.send(refreshed_token);
311                        } else if id == reporter_id {
312                            if let CoreResourceMsg::CollectMemoryReport(report_chan) = msg {
313                                self.process_report(
314                                    report_chan,
315                                    &public_http_state,
316                                    &private_http_state,
317                                );
318                                continue;
319                            } else {
320                                log::error!("memory reporter should only send CollectMemoryReport");
321                            }
322                        } else {
323                            let group = if id == private_id {
324                                &private_http_state
325                            } else {
326                                assert_eq!(id, public_id);
327                                &public_http_state
328                            };
329                            if !self.process_msg(msg, group, Arc::clone(&protocols)) {
330                                return;
331                            }
332                        }
333                    },
334                }
335            }
336        }
337    }
338
339    fn process_report(
340        &mut self,
341        msg: ReportsChan,
342        public_http_state: &Arc<HttpState>,
343        private_http_state: &Arc<HttpState>,
344    ) {
345        perform_memory_report(|ops| {
346            let mut reports = public_http_state.memory_reports("public", ops);
347            reports.extend(private_http_state.memory_reports("private", ops));
348            reports.extend(vec![
349                Report {
350                    path: path!["hsts-preload-list"],
351                    kind: ReportKind::ExplicitJemallocHeapSize,
352                    size: hsts::hsts_preload_size_of(ops),
353                },
354                Report {
355                    path: path!["public-suffix-list"],
356                    kind: ReportKind::ExplicitJemallocHeapSize,
357                    size: public_suffix_list_size_of(ops),
358                },
359            ]);
360            msg.send(ProcessReports::new(reports));
361        })
362    }
363
364    fn cancellation_listener(&self, request_id: RequestId) -> Option<Arc<CancellationListener>> {
365        self.cancellation_listeners
366            .get(&request_id)
367            .and_then(Weak::upgrade)
368    }
369
370    fn get_or_create_cancellation_listener(
371        &mut self,
372        request_id: RequestId,
373    ) -> Arc<CancellationListener> {
374        if let Some(listener) = self.cancellation_listener(request_id) {
375            return listener;
376        }
377
378        // Clear away any cancellation listeners that are no longer valid.
379        self.cancellation_listeners
380            .retain(|_, listener| listener.strong_count() > 0);
381
382        let cancellation_listener = Arc::new(Default::default());
383        self.cancellation_listeners
384            .insert(request_id, Arc::downgrade(&cancellation_listener));
385        cancellation_listener
386    }
387
388    fn send_cookie_response(&self, store_id: CookieStoreId, data: CookieData) {
389        let Some(sender) = self.cookie_listeners.get(&store_id) else {
390            warn!(
391                "Async cookie request made for store id that is non-existent {:?}",
392                store_id
393            );
394            return;
395        };
396        let res = sender.send(CookieAsyncResponse { data });
397        if res.is_err() {
398            warn!("Unable to send cookie response to script thread");
399        }
400    }
401
402    /// Returns false if the thread should exit.
403    fn process_msg(
404        &mut self,
405        msg: CoreResourceMsg,
406        http_state: &Arc<HttpState>,
407        protocols: Arc<ProtocolRegistry>,
408    ) -> bool {
409        match msg {
410            CoreResourceMsg::Fetch(request_builder, channels) => match channels {
411                FetchChannels::ResponseMsg(sender) => {
412                    let cancellation_listener =
413                        self.get_or_create_cancellation_listener(request_builder.id);
414                    self.resource_manager.fetch(
415                        request_builder,
416                        None,
417                        sender,
418                        http_state,
419                        cancellation_listener,
420                        protocols,
421                    );
422                },
423                FetchChannels::WebSocket {
424                    event_sender,
425                    action_receiver,
426                } => {
427                    let cancellation_listener =
428                        self.get_or_create_cancellation_listener(request_builder.id);
429
430                    self.resource_manager.websocket_connect(
431                        request_builder,
432                        event_sender,
433                        action_receiver,
434                        http_state,
435                        cancellation_listener,
436                        protocols,
437                    )
438                },
439                FetchChannels::Prefetch => self.resource_manager.fetch(
440                    request_builder,
441                    None,
442                    DiscardFetch,
443                    http_state,
444                    Arc::new(Default::default()),
445                    protocols,
446                ),
447            },
448            CoreResourceMsg::Cancel(request_ids) => {
449                for cancellation_listener in request_ids
450                    .into_iter()
451                    .filter_map(|request_id| self.cancellation_listener(request_id))
452                {
453                    cancellation_listener.cancel();
454                }
455            },
456            CoreResourceMsg::DeleteCookiesForSites(sites, sender) => {
457                http_state
458                    .cookie_jar
459                    .write()
460                    .delete_cookies_for_sites(&sites);
461                let _ = sender.send(());
462            },
463            CoreResourceMsg::DeleteSessionCookies(sender) => {
464                http_state.cookie_jar.write().clear_session_cookies();
465                let _ = sender.send(());
466            },
467            CoreResourceMsg::DeleteCookies(request, sender) => {
468                http_state
469                    .cookie_jar
470                    .write()
471                    .clear_storage(request.as_ref());
472                if let Some(sender) = sender {
473                    let _ = sender.send(());
474                }
475                return true;
476            },
477            CoreResourceMsg::DeleteCookie(request, name) => {
478                http_state
479                    .cookie_jar
480                    .write()
481                    .delete_cookie_with_name(&request, name);
482                return true;
483            },
484            CoreResourceMsg::DeleteCookieAsync(cookie_store_id, url, name) => {
485                http_state
486                    .cookie_jar
487                    .write()
488                    .delete_cookie_with_name(&url, name);
489                self.send_cookie_response(cookie_store_id, CookieData::Delete(Ok(())));
490            },
491            CoreResourceMsg::FetchRedirect(request_builder, res_init, sender) => {
492                let cancellation_listener =
493                    self.get_or_create_cancellation_listener(request_builder.id);
494                self.resource_manager.fetch(
495                    request_builder,
496                    Some(res_init),
497                    sender,
498                    http_state,
499                    cancellation_listener,
500                    protocols,
501                )
502            },
503            CoreResourceMsg::SetCookieForUrl(request, cookie, source, sender) => {
504                self.resource_manager.set_cookie_for_url(
505                    &request,
506                    cookie.into_inner().to_owned(),
507                    source,
508                    http_state,
509                );
510                if let Some(sender) = sender {
511                    let _ = sender.send(());
512                }
513            },
514            CoreResourceMsg::SetCookiesForUrl(request, cookies, source) => {
515                for cookie in cookies {
516                    self.resource_manager.set_cookie_for_url(
517                        &request,
518                        cookie.into_inner(),
519                        source,
520                        http_state,
521                    );
522                }
523            },
524            CoreResourceMsg::SetCookieForUrlAsync(cookie_store_id, url, cookie, source) => {
525                self.resource_manager.set_cookie_for_url(
526                    &url,
527                    cookie.into_inner().to_owned(),
528                    source,
529                    http_state,
530                );
531                self.send_cookie_response(cookie_store_id, CookieData::Set(Ok(())));
532            },
533            CoreResourceMsg::GetCookieStringForUrl(url, consumer, source) => {
534                let mut cookie_jar = http_state.cookie_jar.write();
535                cookie_jar.remove_expired_cookies_for_url(&url);
536                consumer
537                    .send(cookie_jar.cookies_for_url(&url, source))
538                    .unwrap();
539            },
540            CoreResourceMsg::GetCookiesForUrl(url, consumer, source) => {
541                let mut cookie_jar = http_state.cookie_jar.write();
542                cookie_jar.remove_expired_cookies_for_url(&url);
543                let cookies = cookie_jar
544                    .cookies_data_for_url(&url, source)
545                    .map(Serde)
546                    .collect();
547                consumer.send(cookies).unwrap();
548            },
549            CoreResourceMsg::GetCookieDataForUrlAsync(cookie_store_id, url, name) => {
550                let mut cookie_jar = http_state.cookie_jar.write();
551                cookie_jar.remove_expired_cookies_for_url(&url);
552                let cookie = cookie_jar
553                    .query_cookies(&url, name)
554                    .into_iter()
555                    .map(Serde)
556                    .next();
557                self.send_cookie_response(cookie_store_id, CookieData::Get(cookie));
558            },
559            CoreResourceMsg::GetAllCookieDataForUrlAsync(cookie_store_id, url, name) => {
560                let mut cookie_jar = http_state.cookie_jar.write();
561                cookie_jar.remove_expired_cookies_for_url(&url);
562                let cookies = cookie_jar
563                    .query_cookies(&url, name)
564                    .into_iter()
565                    .map(Serde)
566                    .collect();
567                self.send_cookie_response(cookie_store_id, CookieData::GetAll(cookies));
568            },
569            CoreResourceMsg::EmbedderGetCookiesForUrl(operation_id, url, source) => {
570                let mut cookie_jar = http_state.cookie_jar.write();
571                cookie_jar.remove_expired_cookies_for_url(&url);
572                let cookies: Vec<Cookie<'static>> =
573                    cookie_jar.cookies_data_for_url(&url, source).collect();
574                http_state
575                    .embedder_proxy
576                    .send(NetToEmbedderMsg::EmbedderGetCookiesForUrlResponse(
577                        operation_id,
578                        cookies,
579                    ));
580            },
581            CoreResourceMsg::EmbedderSetCookieForUrl(operation_id, url, cookie, source) => {
582                self.resource_manager.set_cookie_for_url(
583                    &url,
584                    cookie.into_inner(),
585                    source,
586                    http_state,
587                );
588                http_state
589                    .embedder_proxy
590                    .send(NetToEmbedderMsg::EmbedderSetCookieForUrlResponse(
591                        operation_id,
592                    ));
593            },
594            CoreResourceMsg::NewCookieListener(cookie_store_id, callback, _url) => {
595                // TODO: Use the URL for setting up the actual monitoring
596                self.cookie_listeners.insert(cookie_store_id, callback);
597            },
598            CoreResourceMsg::RemoveCookieListener(cookie_store_id) => {
599                self.cookie_listeners.remove(&cookie_store_id);
600            },
601            CoreResourceMsg::NetworkMediator(mediator_chan, origin) => {
602                self.resource_manager
603                    .sw_managers
604                    .insert(origin, mediator_chan);
605            },
606            CoreResourceMsg::ListCookies(sender) => {
607                let mut cookie_jar = http_state.cookie_jar.write();
608                cookie_jar.remove_all_expired_cookies();
609                let _ = sender.send(cookie_jar.cookie_site_descriptors());
610            },
611            CoreResourceMsg::GetHistoryState(history_state_id, consumer) => {
612                let history_states = http_state.history_states.read();
613                consumer
614                    .send(history_states.get(&history_state_id).cloned())
615                    .unwrap();
616            },
617            CoreResourceMsg::SetHistoryState(history_state_id, structured_data) => {
618                let mut history_states = http_state.history_states.write();
619                history_states.insert(history_state_id, structured_data);
620            },
621            CoreResourceMsg::RemoveHistoryStates(states_to_remove) => {
622                let mut history_states = http_state.history_states.write();
623                for history_state in states_to_remove {
624                    history_states.remove(&history_state);
625                }
626            },
627            CoreResourceMsg::GetCacheEntries(sender) => {
628                let _ = sender.send(http_state.http_cache.cache_entry_descriptors());
629            },
630            CoreResourceMsg::ClearCache(sender) => {
631                http_state.http_cache.clear();
632                if let Some(sender) = sender {
633                    let _ = sender.send(());
634                }
635            },
636            CoreResourceMsg::ToFileManager(msg) => self.resource_manager.filemanager.handle(msg),
637            CoreResourceMsg::StorePreloadedResponse(preload_id, response) => self
638                .resource_manager
639                .handle_preloaded_response(preload_id, response),
640            CoreResourceMsg::TotalSizeOfInFlightKeepAliveRecords(pipeline_id, sender) => {
641                let total = self
642                    .resource_manager
643                    .in_flight_keep_alive_records
644                    .lock()
645                    .get(&pipeline_id)
646                    .map(|records| {
647                        records
648                            .iter()
649                            .map(|record| record.keep_alive_body_length)
650                            .sum()
651                    })
652                    .unwrap_or_default();
653                let _ = sender.send(total);
654            },
655            CoreResourceMsg::Exit(sender) => {
656                if let Some(ref config_dir) = self.config_dir {
657                    let auth_cache = http_state.auth_cache.read();
658                    servo_base::write_json_to_file(&*auth_cache, config_dir, "auth_cache.json");
659                    let jar = http_state.cookie_jar.read();
660                    servo_base::write_json_to_file(&*jar, config_dir, "cookie_jar.json");
661                    let hsts = http_state.hsts_list.read();
662                    servo_base::write_json_to_file(&*hsts, config_dir, "hsts_list.json");
663                }
664                self.resource_manager.exit();
665                let _ = sender.send(());
666                return false;
667            },
668            // Ignore these messages as they are only sent on very specific channels.
669            CoreResourceMsg::CollectMemoryReport(_) |
670            CoreResourceMsg::RevokeTokenForFile(..) |
671            CoreResourceMsg::RefreshTokenForFile(..) => {},
672        }
673        true
674    }
675}
676
677#[derive(Clone, Debug, Deserialize, Serialize)]
678pub struct AuthCacheEntry {
679    pub user_name: String,
680    pub password: String,
681}
682
683impl Default for AuthCache {
684    fn default() -> Self {
685        Self {
686            version: 1,
687            entries: HashMap::new(),
688        }
689    }
690}
691
692#[derive(Clone, Debug, Deserialize, Serialize)]
693pub struct AuthCache {
694    pub version: u32,
695    pub entries: HashMap<String, AuthCacheEntry>,
696}
697
698pub struct CoreResourceManager {
699    devtools_sender: Option<Sender<DevtoolsControlMsg>>,
700    sw_managers: HashMap<ImmutableOrigin, IpcSender<CustomResponseMediator>>,
701    filemanager: FileManager,
702    request_interceptor: RequestInterceptor,
703    ca_certificates: CACertificates<'static>,
704    ignore_certificate_errors: bool,
705    preloaded_resources: SharedPreloadedResources,
706    /// <https://fetch.spec.whatwg.org/#concept-fetch-record>
707    in_flight_keep_alive_records: SharedInflightKeepAliveRecords,
708}
709
710impl CoreResourceManager {
711    pub fn new(
712        devtools_sender: Option<Sender<DevtoolsControlMsg>>,
713        _profiler_chan: ProfilerChan,
714        embedder_proxy: GenericEmbedderProxy<NetToEmbedderMsg>,
715        ca_certificates: CACertificates<'static>,
716        ignore_certificate_errors: bool,
717        blob_token_communicator: Arc<Mutex<BlobTokenCommunicator>>,
718    ) -> CoreResourceManager {
719        CoreResourceManager {
720            devtools_sender,
721            sw_managers: Default::default(),
722            filemanager: FileManager::new(embedder_proxy.clone(), blob_token_communicator),
723            request_interceptor: RequestInterceptor::new(embedder_proxy),
724            ca_certificates,
725            ignore_certificate_errors,
726            preloaded_resources: Default::default(),
727            in_flight_keep_alive_records: Default::default(),
728        }
729    }
730
731    fn handle_preloaded_response(&self, preload_id: PreloadId, response: Response) {
732        let mut preloaded_resources = self.preloaded_resources.lock().unwrap();
733        if let Some(entry) = preloaded_resources.get_mut(&preload_id) {
734            entry.with_response(response);
735        }
736    }
737
738    /// Exit the core resource manager.
739    pub fn exit(&mut self) {
740        debug!("Exited CoreResourceManager");
741    }
742
743    fn set_cookie_for_url(
744        &mut self,
745        request: &ServoUrl,
746        cookie: Cookie<'static>,
747        source: CookieSource,
748        http_state: &Arc<HttpState>,
749    ) {
750        if let Some(cookie) = ServoCookie::new_wrapped(cookie, request, source) {
751            let mut cookie_jar = http_state.cookie_jar.write();
752            cookie_jar.push(cookie, request, source)
753        }
754    }
755
756    fn fetch<Target: 'static + FetchTaskTarget + Send>(
757        &self,
758        request_builder: RequestBuilder,
759        res_init_: Option<ResponseInit>,
760        mut sender: Target,
761        http_state: &Arc<HttpState>,
762        cancellation_listener: Arc<CancellationListener>,
763        protocols: Arc<ProtocolRegistry>,
764    ) {
765        let http_state = http_state.clone();
766        let devtools_chan = self.devtools_sender.clone();
767        let filemanager = self.filemanager.clone();
768        let request_interceptor = self.request_interceptor.clone();
769
770        let timing_type = match request_builder.destination {
771            Destination::Document => ResourceTimingType::Navigation,
772            _ => ResourceTimingType::Resource,
773        };
774
775        let request = request_builder.build();
776        let url = request.current_url();
777
778        // In the case of a valid blob URL, acquiring a token granting access to a file,
779        // regardless if the URL is revoked after token acquisition.
780        //
781        // Ideally all callers should have claimed the blob entry themselves, but we're not there
782        // yet.
783        let (file_token, blob_url_file_id) = match url.scheme() {
784            "blob" => {
785                if let Some(token) = request.current_url_with_blob_claim().token() {
786                    (FileTokenCheck::Required(token.token), Some(token.file_id))
787                } else if let Ok((id, _)) = parse_blob_url(&url) {
788                    // See https://github.com/servo/servo/issues/25226
789                    log::warn!(
790                        "Failed to claim blob URL entry of valid blob URL before passing it to `net`. This causes race conditions."
791                    );
792                    (self.filemanager.get_token_for_file(&id, false), Some(id))
793                } else {
794                    (FileTokenCheck::ShouldFail, None)
795                }
796            },
797            _ => (FileTokenCheck::NotRequired, None),
798        };
799
800        let ca_certificates = self.ca_certificates.clone();
801        let ignore_certificate_errors = self.ignore_certificate_errors;
802        let in_flight_keep_alive_records = self.in_flight_keep_alive_records.clone();
803        let preloaded_resources = self.preloaded_resources.clone();
804        if let Some(ref preload_id) = request.preload_id {
805            let mut preloaded_resources = self.preloaded_resources.lock().unwrap();
806            let entry = PreloadEntry::new(request.integrity_metadata.clone());
807            preloaded_resources.insert(preload_id.clone(), entry);
808        }
809
810        spawn_task(async move {
811            // XXXManishearth: Check origin against pipeline id (also ensure that the mode is allowed)
812            // todo load context / mimesniff in fetch
813            // todo referrer policy?
814            // todo service worker stuff
815            let context = FetchContext {
816                state: http_state,
817                user_agent: servo_config::pref!(user_agent),
818                devtools_chan,
819                filemanager,
820                file_token,
821                request_interceptor: Arc::new(TokioMutex::new(request_interceptor)),
822                cancellation_listener,
823                timing: ResourceFetchTiming::new(request.timing_type()).into(),
824                protocols,
825                websocket_chan: None,
826                ca_certificates,
827                ignore_certificate_errors,
828                preloaded_resources,
829                in_flight_keep_alive_records,
830            };
831
832            match res_init_ {
833                Some(res_init) => {
834                    let response = Response::from_init(res_init, timing_type);
835
836                    let mut fetch_params = FetchParams::new(request);
837                    let mut request_body_stream_closer =
838                        AutoRequestBodyStreamCloser::new(fetch_params.request.body.as_ref());
839                    let response = http_redirect_fetch(
840                        &mut fetch_params,
841                        &mut CorsCache::default(),
842                        response,
843                        true,
844                        &mut sender,
845                        &mut None,
846                        &context,
847                    )
848                    .await;
849                    if transfers_request_body_stream_to_later_manual_redirect(
850                        &fetch_params.request,
851                        &response,
852                    ) {
853                        request_body_stream_closer.disarm();
854                    }
855                },
856                None => {
857                    fetch(request, &mut sender, &context).await;
858                },
859            };
860
861            // Remove token after fetch.
862            if let Some(id) = blob_url_file_id.as_ref() {
863                context
864                    .filemanager
865                    .invalidate_token(&context.file_token, id);
866            }
867        });
868    }
869
870    /// <https://websockets.spec.whatwg.org/#concept-websocket-establish>
871    fn websocket_connect(
872        &self,
873        mut request: RequestBuilder,
874        event_sender: IpcSender<WebSocketNetworkEvent>,
875        action_receiver: CallbackSetter<WebSocketDomAction>,
876        http_state: &Arc<HttpState>,
877        cancellation_listener: Arc<CancellationListener>,
878        protocols: Arc<ProtocolRegistry>,
879    ) {
880        let http_state = http_state.clone();
881        let devtools_chan = self.devtools_sender.clone();
882        let filemanager = self.filemanager.clone();
883        let request_interceptor = self.request_interceptor.clone();
884
885        let ca_certificates = self.ca_certificates.clone();
886        let ignore_certificate_errors = self.ignore_certificate_errors;
887        let in_flight_keep_alive_records = self.in_flight_keep_alive_records.clone();
888        let preloaded_resources = self.preloaded_resources.clone();
889
890        spawn_task(async move {
891            let mut event_sender = event_sender;
892
893            // Let requestURL be a copy of url, with its scheme set to "http", if url’s scheme is
894            // "ws"; otherwise to "https"
895            let scheme = match request.url.scheme() {
896                "ws" => "http",
897                _ => "https",
898            };
899            request
900                .url
901                .as_mut_url()
902                .set_scheme(scheme)
903                .unwrap_or_else(|_| panic!("Can't set scheme to {scheme}"));
904
905            match create_handshake_request(request, http_state.clone()) {
906                Ok(request) => {
907                    let context = FetchContext {
908                        state: http_state,
909                        user_agent: servo_config::pref!(user_agent),
910                        devtools_chan,
911                        filemanager,
912                        file_token: FileTokenCheck::NotRequired,
913                        request_interceptor: Arc::new(TokioMutex::new(request_interceptor)),
914                        cancellation_listener,
915                        timing: ResourceFetchTiming::new(request.timing_type()).into(),
916                        protocols: protocols.clone(),
917                        websocket_chan: Some(Arc::new(Mutex::new(WebSocketChannel::new(
918                            event_sender.clone(),
919                            Some(action_receiver),
920                        )))),
921                        ca_certificates,
922                        ignore_certificate_errors,
923                        preloaded_resources,
924                        in_flight_keep_alive_records,
925                    };
926                    fetch(request, &mut event_sender, &context).await;
927                },
928                Err(e) => {
929                    trace!("unable to create websocket handshake request {:?}", e);
930                    let _ = event_sender.send(WebSocketNetworkEvent::Fail);
931                },
932            }
933        });
934    }
935}