chromiumoxide/handler/
network.rs

1use super::blockers::{
2    block_websites::block_xhr,
3    ignore_script_embedded, ignore_script_xhr, ignore_script_xhr_media,
4    intercept_manager::NetworkInterceptManager,
5    scripts::{
6        URL_IGNORE_SCRIPT_BASE_PATHS, URL_IGNORE_SCRIPT_STYLES_PATHS, URL_IGNORE_TRIE,
7        URL_IGNORE_TRIE_PATHS,
8    },
9    xhr::IGNORE_XHR_ASSETS,
10};
11use crate::auth::Credentials;
12use crate::cmd::CommandChain;
13use crate::handler::http::HttpRequest;
14use aho_corasick::AhoCorasick;
15use case_insensitive_string::CaseInsensitiveString;
16use chromiumoxide_cdp::cdp::browser_protocol::network::{
17    EmulateNetworkConditionsParams, EventLoadingFailed, EventLoadingFinished,
18    EventRequestServedFromCache, EventRequestWillBeSent, EventResponseReceived, Headers,
19    InterceptionId, RequestId, ResourceType, Response, SetCacheDisabledParams,
20    SetExtraHttpHeadersParams,
21};
22use chromiumoxide_cdp::cdp::browser_protocol::{
23    fetch::{
24        self, AuthChallengeResponse, AuthChallengeResponseResponse, ContinueRequestParams,
25        ContinueWithAuthParams, DisableParams, EventAuthRequired, EventRequestPaused,
26        RequestPattern,
27    },
28    network::SetBypassServiceWorkerParams,
29};
30use chromiumoxide_cdp::cdp::browser_protocol::{
31    network::EnableParams, security::SetIgnoreCertificateErrorsParams,
32};
33use chromiumoxide_types::{Command, Method, MethodId};
34use hashbrown::{HashMap, HashSet};
35use lazy_static::lazy_static;
36use reqwest::header::PROXY_AUTHORIZATION;
37use std::collections::VecDeque;
38use std::time::Duration;
39
40lazy_static! {
41    /// General patterns for popular libraries and resources
42    static ref JS_FRAMEWORK_ALLOW: Vec<&'static str> = vec![
43        "jquery",           // Covers jquery.min.js, jquery.js, etc.
44        "angular",
45        "react",            // Covers all React-related patterns
46        "vue",              // Covers all Vue-related patterns
47        "bootstrap",
48        "d3",
49        "lodash",
50        "ajax",
51        "application",
52        "app",              // Covers general app scripts like app.js
53        "main",
54        "index",
55        "bundle",
56        "vendor",
57        "runtime",
58        "polyfill",
59        "scripts",
60        "es2015.",
61        "es2020.",
62        "webpack",
63        "/wp-content/js/",  // Covers Wordpress content
64        // Verified 3rd parties for request
65        "https://m.stripe.network/",
66        "https://challenges.cloudflare.com/",
67        "https://www.google.com/recaptcha/api.js",
68        "https://google.com/recaptcha/api.js",
69        "https://js.stripe.com/",
70        "https://cdn.prod.website-files.com/", // webflow cdn scripts
71        "https://cdnjs.cloudflare.com/",        // cloudflare cdn scripts
72        "https://code.jquery.com/jquery-"
73    ];
74
75    /// Determine if a script should be rendered in the browser by name.
76    pub static ref ALLOWED_MATCHER: AhoCorasick = AhoCorasick::new(JS_FRAMEWORK_ALLOW.iter()).unwrap();
77
78    /// path of a js framework
79    pub static ref JS_FRAMEWORK_PATH: phf::Set<&'static str> = {
80        phf::phf_set! {
81            // Add allowed assets from JS_FRAMEWORK_ASSETS except the excluded ones
82            "_next/static/", "_astro/", "_app/immutable"
83        }
84    };
85
86    /// Ignore the content types.
87    pub static ref IGNORE_CONTENT_TYPES: phf::Set<&'static str> = phf::phf_set! {
88        "application/pdf",
89        "application/zip",
90        "application/x-rar-compressed",
91        "application/x-tar",
92        "image/png",
93        "image/jpeg",
94        "image/gif",
95        "image/bmp",
96        "image/svg+xml",
97        "video/mp4",
98        "video/x-msvideo",
99        "video/x-matroska",
100        "video/webm",
101        "audio/mpeg",
102        "audio/ogg",
103        "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
104        "application/vnd.ms-excel",
105        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
106        "application/vnd.ms-powerpoint",
107        "application/vnd.openxmlformats-officedocument.presentationml.presentation",
108        "application/x-7z-compressed",
109        "application/x-rpm",
110        "application/x-shockwave-flash",
111        "application/rtf",
112    };
113
114    /// Ignore the resources for visual content types.
115    pub static ref IGNORE_VISUAL_RESOURCE_MAP: phf::Set<&'static str> = phf::phf_set! {
116        "Image",
117        "Media",
118        "Font"
119    };
120
121    /// Ignore the resources for visual content types.
122    pub static ref IGNORE_NETWORKING_RESOURCE_MAP: phf::Set<&'static str> = phf::phf_set! {
123        "CspViolationReport",
124        "Manifest",
125        "Other",
126        "Prefetch",
127        "Ping",
128    };
129
130    /// Case insenstive css matching
131    pub static ref CSS_EXTENSION: CaseInsensitiveString = CaseInsensitiveString::from("css");
132
133    /// The command chain.
134    pub static ref INIT_CHAIN: Vec<(std::borrow::Cow<'static, str>, serde_json::Value)>  = {
135        let enable = EnableParams::default();
136
137        if let Ok(c) = serde_json::to_value(&enable) {
138            vec![(enable.identifier(), c)]
139        } else {
140            vec![]
141        }
142    };
143
144    /// The command chain with https ignore.
145    pub static ref INIT_CHAIN_IGNORE_HTTP_ERRORS: Vec<(std::borrow::Cow<'static, str>, serde_json::Value)>  = {
146        let enable = EnableParams::default();
147        let mut v = vec![];
148        if let Ok(c) = serde_json::to_value(&enable) {
149            v.push((enable.identifier(), c));
150        }
151        let ignore = SetIgnoreCertificateErrorsParams::new(true);
152        if let Ok(ignored) = serde_json::to_value(&ignore) {
153            v.push((ignore.identifier(), ignored));
154        }
155
156        v
157    };
158
159    /// Enable the fetch intercept command
160    pub static ref ENABLE_FETCH: chromiumoxide_cdp::cdp::browser_protocol::fetch::EnableParams = {
161        fetch::EnableParams::builder()
162        .handle_auth_requests(true)
163        .pattern(RequestPattern::builder().url_pattern("*").build())
164        .build()
165    };
166}
167
168/// Determine if a redirect is true.
169pub(crate) fn is_redirect_status(status: i64) -> bool {
170    matches!(status, 301 | 302 | 303 | 307 | 308)
171}
172
173#[derive(Debug)]
174/// The base network manager.
175pub struct NetworkManager {
176    queued_events: VecDeque<NetworkEvent>,
177    ignore_httpserrors: bool,
178    requests: HashMap<RequestId, HttpRequest>,
179    // TODO put event in an Arc?
180    requests_will_be_sent: HashMap<RequestId, EventRequestWillBeSent>,
181    extra_headers: std::collections::HashMap<String, String>,
182    request_id_to_interception_id: HashMap<RequestId, InterceptionId>,
183    user_cache_disabled: bool,
184    attempted_authentications: HashSet<RequestId>,
185    credentials: Option<Credentials>,
186    // unused atm for remote connections, needs to be used for self launches.
187    user_request_interception_enabled: bool,
188    protocol_request_interception_enabled: bool,
189    offline: bool,
190    request_timeout: Duration,
191    // made_request: bool,
192    /// Ignore visuals (no pings, prefetching, and etc).
193    pub ignore_visuals: bool,
194    /// Block CSS stylesheets.
195    pub block_stylesheets: bool,
196    /// Block javascript that is not critical to rendering.
197    pub block_javascript: bool,
198    /// Block analytics from rendering
199    pub block_analytics: bool,
200    /// Only html from loading.
201    pub only_html: bool,
202    /// Is xml document?
203    pub xml_document: bool,
204    /// The custom intercept handle logic to run on the website.
205    pub intercept_manager: NetworkInterceptManager,
206    /// Track the amount of times the document reloaded.
207    pub document_reload_tracker: u8,
208    /// The initial target domain.
209    pub document_target_domain: String,
210}
211
212impl NetworkManager {
213    pub fn new(ignore_httpserrors: bool, request_timeout: Duration) -> Self {
214        Self {
215            queued_events: Default::default(),
216            ignore_httpserrors,
217            requests: Default::default(),
218            requests_will_be_sent: Default::default(),
219            extra_headers: Default::default(),
220            request_id_to_interception_id: Default::default(),
221            user_cache_disabled: false,
222            attempted_authentications: Default::default(),
223            credentials: None,
224            user_request_interception_enabled: false,
225            protocol_request_interception_enabled: false,
226            offline: false,
227            request_timeout,
228            ignore_visuals: false,
229            block_javascript: false,
230            block_stylesheets: false,
231            block_analytics: true,
232            only_html: false,
233            xml_document: false,
234            intercept_manager: NetworkInterceptManager::Unknown,
235            document_reload_tracker: 0,
236            document_target_domain: String::new(),
237        }
238    }
239
240    pub fn init_commands(&self) -> CommandChain {
241        let cmds = if self.ignore_httpserrors {
242            INIT_CHAIN_IGNORE_HTTP_ERRORS.clone()
243        } else {
244            INIT_CHAIN.clone()
245        };
246
247        CommandChain::new(cmds, self.request_timeout)
248    }
249
250    pub(crate) fn push_cdp_request<T: Command>(&mut self, cmd: T) {
251        let method = cmd.identifier();
252        if let Ok(params) = serde_json::to_value(cmd) {
253            self.queued_events
254                .push_back(NetworkEvent::SendCdpRequest((method, params)));
255        }
256    }
257
258    /// The next event to handle
259    pub fn poll(&mut self) -> Option<NetworkEvent> {
260        self.queued_events.pop_front()
261    }
262
263    pub fn extra_headers(&self) -> &std::collections::HashMap<String, String> {
264        &self.extra_headers
265    }
266
267    pub fn set_extra_headers(&mut self, headers: std::collections::HashMap<String, String>) {
268        self.extra_headers = headers;
269        self.extra_headers.remove(PROXY_AUTHORIZATION.as_str());
270        if let Ok(headers) = serde_json::to_value(&self.extra_headers) {
271            self.push_cdp_request(SetExtraHttpHeadersParams::new(Headers::new(headers)));
272        }
273    }
274
275    pub fn set_service_worker_enabled(&mut self, bypass: bool) {
276        self.push_cdp_request(SetBypassServiceWorkerParams::new(bypass));
277    }
278
279    pub fn set_request_interception(&mut self, enabled: bool) {
280        self.user_request_interception_enabled = enabled;
281        self.update_protocol_request_interception();
282    }
283
284    pub fn set_cache_enabled(&mut self, enabled: bool) {
285        let run = self.user_cache_disabled != !enabled;
286        self.user_cache_disabled = !enabled;
287        if run {
288            self.update_protocol_cache_disabled();
289        }
290    }
291
292    pub fn disable_request_intercept(&mut self) {
293        self.protocol_request_interception_enabled = true;
294    }
295
296    pub fn update_protocol_cache_disabled(&mut self) {
297        self.push_cdp_request(SetCacheDisabledParams::new(self.user_cache_disabled));
298    }
299
300    pub fn authenticate(&mut self, credentials: Credentials) {
301        self.credentials = Some(credentials);
302        self.update_protocol_request_interception()
303    }
304
305    fn update_protocol_request_interception(&mut self) {
306        let enabled = self.user_request_interception_enabled || self.credentials.is_some();
307
308        if enabled == self.protocol_request_interception_enabled {
309            return;
310        }
311
312        if enabled {
313            self.push_cdp_request(ENABLE_FETCH.clone())
314        } else {
315            self.push_cdp_request(DisableParams::default())
316        }
317    }
318
319    /// Url matches analytics that we want to ignore or trackers.
320    pub(crate) fn ignore_script(
321        &self,
322        url: &str,
323        block_analytics: bool,
324        intercept_manager: NetworkInterceptManager,
325    ) -> bool {
326        let mut ignore_script = block_analytics && URL_IGNORE_TRIE.contains_prefix(url);
327
328        if !ignore_script {
329            if let Some(index) = url.find("//") {
330                let pos = index + 2;
331
332                // Ensure there is something after `//`
333                if pos < url.len() {
334                    // Find the first slash after the `//`
335                    if let Some(slash_index) = url[pos..].find('/') {
336                        let base_path_index = pos + slash_index + 1;
337
338                        if url.len() > base_path_index {
339                            let new_url: &str = &url[base_path_index..];
340
341                            // ignore assets we do not need for frameworks
342                            if !ignore_script
343                                && intercept_manager == NetworkInterceptManager::Unknown
344                            {
345                                let hydration_file =
346                                    JS_FRAMEWORK_PATH.iter().any(|p| new_url.starts_with(p));
347
348                                // ignore astro paths
349                                if hydration_file && new_url.ends_with(".js") {
350                                    ignore_script = true;
351                                }
352                            }
353
354                            if !ignore_script
355                                && URL_IGNORE_SCRIPT_BASE_PATHS.contains_prefix(new_url)
356                            {
357                                ignore_script = true;
358                            }
359
360                            if !ignore_script
361                                && self.ignore_visuals
362                                && URL_IGNORE_SCRIPT_STYLES_PATHS.contains_prefix(new_url)
363                            {
364                                ignore_script = true;
365                            }
366                        }
367                    }
368                }
369            }
370        }
371
372        // fallback for file ending in analytics.js
373        if !ignore_script && block_analytics {
374            ignore_script = URL_IGNORE_TRIE_PATHS.contains_prefix(url);
375        }
376
377        ignore_script
378    }
379
380    /// Determine if the request should be skipped.
381    fn skip_xhr(
382        &self,
383        skip_networking: bool,
384        event: &EventRequestPaused,
385        network_event: bool,
386    ) -> bool {
387        // XHR check
388        if !skip_networking && network_event {
389            let request_url = event.request.url.as_str();
390
391            // check if part of ignore scripts.
392            let skip_analytics =
393                self.block_analytics && (ignore_script_xhr(request_url) || block_xhr(request_url));
394
395            if skip_analytics {
396                true
397            } else if self.block_stylesheets || self.ignore_visuals {
398                let block_css = self.block_stylesheets;
399                let block_media = self.ignore_visuals;
400
401                let mut block_request = false;
402
403                if let Some(position) = request_url.rfind('.') {
404                    let hlen = request_url.len();
405                    let has_asset = hlen - position;
406
407                    if has_asset >= 3 {
408                        let next_position = position + 1;
409
410                        if block_media
411                            && IGNORE_XHR_ASSETS.contains::<CaseInsensitiveString>(
412                                &request_url[next_position..].into(),
413                            )
414                        {
415                            block_request = true;
416                        } else if block_css {
417                            block_request =
418                                CaseInsensitiveString::from(request_url[next_position..].as_bytes())
419                                    .contains(&**CSS_EXTENSION)
420                        }
421                    }
422                }
423
424                if !block_request {
425                    block_request = ignore_script_xhr_media(request_url);
426                }
427
428                block_request
429            } else {
430                skip_networking
431            }
432        } else {
433            skip_networking
434        }
435    }
436
437    #[cfg(not(feature = "adblock"))]
438    pub fn on_fetch_request_paused(&mut self, event: &EventRequestPaused) {
439        use super::blockers::block_websites::block_website;
440
441        if self.user_request_interception_enabled && self.protocol_request_interception_enabled {
442            return;
443        }
444
445        if !self.user_request_interception_enabled && self.protocol_request_interception_enabled {
446            self.push_cdp_request(ContinueRequestParams::new(event.request_id.clone()))
447        } else {
448            if let Some(network_id) = event.network_id.as_ref() {
449                if let Some(request_will_be_sent) =
450                    self.requests_will_be_sent.remove(network_id.as_ref())
451                {
452                    self.on_request(&request_will_be_sent, Some(event.request_id.clone().into()));
453                } else {
454                    let current_url = event.request.url.as_str();
455                    let javascript_resource = event.resource_type == ResourceType::Script;
456                    let document_resource = event.resource_type == ResourceType::Document;
457                    let network_resource = !document_resource
458                        && (event.resource_type == ResourceType::Xhr
459                            || event.resource_type == ResourceType::Fetch
460                            || event.resource_type == ResourceType::WebSocket);
461
462                    let skip_networking =
463                        IGNORE_NETWORKING_RESOURCE_MAP.contains(event.resource_type.as_ref());
464
465                    let skip_networking = skip_networking || self.document_reload_tracker >= 3;
466                    let mut replacer = None;
467
468                    if document_resource {
469                        if self.document_target_domain == current_url {
470                            // this will prevent the domain from looping (3 times is enough).
471                            self.document_reload_tracker += 1;
472                        } else if !self.document_target_domain.is_empty()
473                            && event.redirected_request_id.is_some()
474                        {
475                            let (http_document_replacement, mut https_document_replacement) =
476                                if self.document_target_domain.starts_with("http://") {
477                                    (
478                                        self.document_target_domain.replace("http://", "http//"),
479                                        self.document_target_domain.replace("http://", "https://"),
480                                    )
481                                } else {
482                                    (
483                                        self.document_target_domain.replace("https://", "https//"),
484                                        self.document_target_domain.replace("https://", "http://"),
485                                    )
486                                };
487
488                            let trailing = https_document_replacement.ends_with('/');
489
490                            if trailing {
491                                https_document_replacement.pop();
492                            }
493
494                            if https_document_replacement.ends_with('/') {
495                                https_document_replacement.pop();
496                            }
497
498                            let redirect_mask = format!(
499                                "{}{}",
500                                https_document_replacement, http_document_replacement
501                            );
502
503                            // handle redirect masking
504                            if current_url == redirect_mask {
505                                replacer = Some(if trailing {
506                                    format!("{}/", https_document_replacement)
507                                } else {
508                                    https_document_replacement
509                                });
510                            }
511                        }
512
513                        if self.document_target_domain.is_empty() && current_url.ends_with(".xml") {
514                            self.xml_document = true;
515                        }
516
517                        self.document_target_domain = event.request.url.clone();
518                    }
519
520                    let current_url = match &replacer {
521                        Some(r) => r,
522                        _ => &event.request.url,
523                    }
524                    .as_str();
525
526                    // main initial check
527                    let skip_networking = if !skip_networking {
528                        if self.xml_document && current_url.ends_with("sitemap-style.xsl") {
529                            false
530                        } else {
531                            self.ignore_visuals
532                                && (IGNORE_VISUAL_RESOURCE_MAP
533                                    .contains(event.resource_type.as_ref()))
534                                || self.block_stylesheets
535                                    && ResourceType::Stylesheet == event.resource_type
536                                || self.block_javascript
537                                    && javascript_resource
538                                    && self.intercept_manager == NetworkInterceptManager::Unknown
539                                    && !ALLOWED_MATCHER.is_match(current_url)
540                        }
541                    } else {
542                        skip_networking
543                    };
544
545                    let skip_networking = if !skip_networking
546                        && (self.only_html || self.ignore_visuals)
547                        && (javascript_resource || document_resource)
548                    {
549                        ignore_script_embedded(current_url)
550                    } else {
551                        skip_networking
552                    };
553
554                    // analytics check
555                    let skip_networking = if !skip_networking && javascript_resource {
556                        self.ignore_script(
557                            current_url,
558                            self.block_analytics,
559                            self.intercept_manager,
560                        )
561                    } else {
562                        skip_networking
563                    };
564
565                    // XHR check
566                    let skip_networking = self.skip_xhr(skip_networking, &event, network_resource);
567
568                    // custom interception layer.
569                    let skip_networking = if !skip_networking
570                        && (javascript_resource || network_resource || document_resource)
571                    {
572                        self.intercept_manager.intercept_detection(
573                            &current_url,
574                            self.ignore_visuals,
575                            network_resource,
576                        )
577                    } else {
578                        skip_networking
579                    };
580
581                    let skip_networking =
582                        if !skip_networking && (javascript_resource || network_resource) {
583                            block_website(&current_url)
584                        } else {
585                            skip_networking
586                        };
587
588                    if skip_networking {
589                        tracing::debug!("Blocked: {:?} - {}", event.resource_type, current_url);
590                        let fullfill_params =
591                            crate::handler::network::fetch::FulfillRequestParams::new(
592                                event.request_id.clone(),
593                                200,
594                            );
595                        self.push_cdp_request(fullfill_params);
596                    } else {
597                        tracing::debug!("Allowed: {:?} - {}", event.resource_type, current_url);
598                        let mut continue_params =
599                            ContinueRequestParams::new(event.request_id.clone());
600
601                        if replacer.is_some() {
602                            continue_params.url = Some(current_url.into());
603                            continue_params.intercept_response = Some(false);
604                        }
605
606                        self.push_cdp_request(continue_params)
607                    }
608                }
609            } else {
610                self.push_cdp_request(ContinueRequestParams::new(event.request_id.clone()))
611            }
612        }
613    }
614
615    #[cfg(feature = "adblock")]
616    pub fn on_fetch_request_paused(&mut self, event: &EventRequestPaused) {
617        if self.user_request_interception_enabled && self.protocol_request_interception_enabled {
618            return;
619        }
620
621        if !self.user_request_interception_enabled && self.protocol_request_interception_enabled {
622            self.push_cdp_request(ContinueRequestParams::new(event.request_id.clone()))
623        } else {
624            if let Some(network_id) = event.network_id.as_ref() {
625                if let Some(request_will_be_sent) =
626                    self.requests_will_be_sent.remove(network_id.as_ref())
627                {
628                    self.on_request(&request_will_be_sent, Some(event.request_id.clone().into()));
629                } else {
630                    let current_url = event.request.url.as_str();
631                    let javascript_resource = event.resource_type == ResourceType::Script;
632                    let document_resource = event.resource_type == ResourceType::Document;
633                    let network_resource = !document_resource
634                        && (event.resource_type == ResourceType::Xhr
635                            || event.resource_type == ResourceType::Fetch
636                            || event.resource_type == ResourceType::WebSocket);
637
638                    // block all of these events.
639                    let skip_networking =
640                        IGNORE_NETWORKING_RESOURCE_MAP.contains(event.resource_type.as_ref());
641
642                    let skip_networking = skip_networking || self.document_reload_tracker >= 3;
643
644                    if document_resource {
645                        if self.document_target_domain == current_url {
646                            // this will prevent the domain from looping (3 times is enough).
647                            self.document_reload_tracker += 1;
648                        } else if !self.document_target_domain.is_empty()
649                            && event.redirected_request_id.is_some()
650                        {
651                            let (http_document_replacement, mut https_document_replacement) =
652                                if self.document_target_domain.starts_with("http://") {
653                                    (
654                                        self.document_target_domain.replace("http://", "http//"),
655                                        self.document_target_domain.replace("http://", "https://"),
656                                    )
657                                } else {
658                                    (
659                                        self.document_target_domain.replace("https://", "https//"),
660                                        self.document_target_domain.replace("https://", "http://"),
661                                    )
662                                };
663
664                            let trailing = https_document_replacement.ends_with('/');
665
666                            if trailing {
667                                https_document_replacement.pop();
668                            }
669
670                            if https_document_replacement.ends_with('/') {
671                                https_document_replacement.pop();
672                            }
673
674                            let redirect_mask = format!(
675                                "{}{}",
676                                https_document_replacement, http_document_replacement
677                            );
678
679                            // handle redirect masking
680                            if current_url == redirect_mask {
681                                replacer = Some(if trailing {
682                                    format!("{}/", https_document_replacement)
683                                } else {
684                                    https_document_replacement
685                                });
686                            }
687                        }
688
689                        if self.document_target_domain.is_empty() && current_url.ends_with(".xml") {
690                            self.xml_document = true;
691                        }
692
693                        self.document_target_domain = event.request.url.clone();
694                    }
695
696                    let current_url = match &replacer {
697                        Some(r) => r,
698                        _ => &event.request.url,
699                    }
700                    .as_str();
701
702                    // main initial check
703                    let skip_networking = if !skip_networking {
704                        if self.xml_document && current_url.ends_with("sitemap-style.xsl") {
705                            false
706                        } else {
707                            self.ignore_visuals
708                                && (IGNORE_VISUAL_RESOURCE_MAP
709                                    .contains(event.resource_type.as_ref()))
710                                || self.block_stylesheets
711                                    && ResourceType::Stylesheet == event.resource_type
712                                || self.block_javascript
713                                    && javascript_resource
714                                    && self.intercept_manager == NetworkInterceptManager::Unknown
715                                    && !ALLOWED_MATCHER.is_match(current_url)
716                        }
717                    } else {
718                        skip_networking
719                    };
720
721                    let skip_networking = if !skip_networking {
722                        self.detect_ad(event)
723                    } else {
724                        skip_networking
725                    };
726
727                    let skip_networking = if !skip_networking
728                        && (self.only_html || self.ignore_visuals)
729                        && (javascript_resource || document_resource)
730                    {
731                        ignore_script_embedded(current_url)
732                    } else {
733                        skip_networking
734                    };
735
736                    // analytics check
737                    let skip_networking = if !skip_networking && javascript_resource {
738                        self.ignore_script(
739                            current_url,
740                            self.block_analytics,
741                            self.intercept_manager,
742                        )
743                    } else {
744                        skip_networking
745                    };
746
747                    // XHR check
748                    let skip_networking = self.skip_xhr(skip_networking, &event, network_resource);
749
750                    // custom interception layer.
751                    let skip_networking = if !skip_networking
752                        && (javascript_resource || network_resource || document_resource)
753                    {
754                        self.intercept_manager.intercept_detection(
755                            &event.request.url,
756                            self.ignore_visuals,
757                            network_resource,
758                        )
759                    } else {
760                        skip_networking
761                    };
762
763                    let skip_networking =
764                        if !skip_networking && (javascript_resource || network_resource) {
765                            block_website(&event.request.url)
766                        } else {
767                            skip_networking
768                        };
769
770                    if skip_networking {
771                        tracing::debug!("Blocked: {:?} - {}", event.resource_type, current_url);
772
773                        let fullfill_params =
774                            crate::handler::network::fetch::FulfillRequestParams::new(
775                                event.request_id.clone(),
776                                200,
777                            );
778                        self.push_cdp_request(fullfill_params);
779                    } else {
780                        tracing::debug!("Allowed: {:?} - {}", event.resource_type, current_url);
781
782                        let mut continue_params =
783                            ContinueRequestParams::new(event.request_id.clone());
784
785                        if replacer.is_some() {
786                            continue_params.url = Some(current_url.into());
787                            continue_params.intercept_response = Some(false);
788                        }
789                    }
790                }
791            } else {
792                self.push_cdp_request(ContinueRequestParams::new(event.request_id.clone()))
793            }
794        }
795
796        // if self.only_html {
797        //     self.made_request = true;
798        // }
799    }
800
801    /// Perform a page intercept for chrome
802    #[cfg(feature = "adblock")]
803    pub fn detect_ad(&self, event: &EventRequestPaused) -> bool {
804        use adblock::{
805            lists::{FilterSet, ParseOptions, RuleTypes},
806            Engine,
807        };
808
809        lazy_static::lazy_static! {
810            static ref AD_ENGINE: Engine = {
811                let mut filter_set = FilterSet::new(false);
812                let mut rules = ParseOptions::default();
813                rules.rule_types = RuleTypes::All;
814
815                filter_set.add_filters(
816                    &*crate::handler::blockers::adblock_patterns::ADBLOCK_PATTERNS,
817                    rules,
818                );
819
820                Engine::from_filter_set(filter_set, true)
821            };
822        };
823
824        let blockable = ResourceType::Image == event.resource_type
825            || event.resource_type == ResourceType::Media
826            || event.resource_type == ResourceType::Stylesheet
827            || event.resource_type == ResourceType::Document
828            || event.resource_type == ResourceType::Fetch
829            || event.resource_type == ResourceType::Xhr;
830
831        let u = &event.request.url;
832
833        let block_request = blockable
834            // set it to example.com for 3rd party handling is_same_site
835        && {
836            let request = adblock::request::Request::preparsed(
837                 &u,
838                 "example.com",
839                 "example.com",
840                 &event.resource_type.as_ref().to_lowercase(),
841                 !event.request.is_same_site.unwrap_or_default());
842
843            AD_ENGINE.check_network_request(&request).matched
844        };
845
846        block_request
847    }
848
849    pub fn on_fetch_auth_required(&mut self, event: &EventAuthRequired) {
850        let response = if self
851            .attempted_authentications
852            .contains(event.request_id.as_ref())
853        {
854            AuthChallengeResponseResponse::CancelAuth
855        } else if self.credentials.is_some() {
856            self.attempted_authentications
857                .insert(event.request_id.clone().into());
858            AuthChallengeResponseResponse::ProvideCredentials
859        } else {
860            AuthChallengeResponseResponse::Default
861        };
862
863        let mut auth = AuthChallengeResponse::new(response);
864        if let Some(creds) = self.credentials.clone() {
865            auth.username = Some(creds.username);
866            auth.password = Some(creds.password);
867        }
868        self.push_cdp_request(ContinueWithAuthParams::new(event.request_id.clone(), auth));
869    }
870
871    pub fn set_offline_mode(&mut self, value: bool) {
872        if self.offline == value {
873            return;
874        }
875        self.offline = value;
876        if let Ok(network) = EmulateNetworkConditionsParams::builder()
877            .offline(self.offline)
878            .latency(0)
879            .download_throughput(-1.)
880            .upload_throughput(-1.)
881            .build()
882        {
883            self.push_cdp_request(network);
884        }
885    }
886
887    /// Request interception doesn't happen for data URLs with Network Service.
888    pub fn on_request_will_be_sent(&mut self, event: &EventRequestWillBeSent) {
889        if self.protocol_request_interception_enabled && !event.request.url.starts_with("data:") {
890            if let Some(interception_id) = self
891                .request_id_to_interception_id
892                .remove(event.request_id.as_ref())
893            {
894                self.on_request(event, Some(interception_id));
895            } else {
896                // TODO remove the clone for event
897                self.requests_will_be_sent
898                    .insert(event.request_id.clone(), event.clone());
899            }
900        } else {
901            self.on_request(event, None);
902        }
903    }
904
905    pub fn on_request_served_from_cache(&mut self, event: &EventRequestServedFromCache) {
906        if let Some(request) = self.requests.get_mut(event.request_id.as_ref()) {
907            request.from_memory_cache = true;
908        }
909    }
910
911    pub fn on_response_received(&mut self, event: &EventResponseReceived) {
912        if let Some(mut request) = self.requests.remove(event.request_id.as_ref()) {
913            request.set_response(event.response.clone());
914            self.queued_events
915                .push_back(NetworkEvent::RequestFinished(request))
916        }
917    }
918
919    pub fn on_network_loading_finished(&mut self, event: &EventLoadingFinished) {
920        if let Some(request) = self.requests.remove(event.request_id.as_ref()) {
921            if let Some(interception_id) = request.interception_id.as_ref() {
922                self.attempted_authentications
923                    .remove(interception_id.as_ref());
924            }
925            self.queued_events
926                .push_back(NetworkEvent::RequestFinished(request));
927        }
928    }
929
930    pub fn on_network_loading_failed(&mut self, event: &EventLoadingFailed) {
931        if let Some(mut request) = self.requests.remove(event.request_id.as_ref()) {
932            request.failure_text = Some(event.error_text.clone());
933            if let Some(interception_id) = request.interception_id.as_ref() {
934                self.attempted_authentications
935                    .remove(interception_id.as_ref());
936            }
937            self.queued_events
938                .push_back(NetworkEvent::RequestFailed(request));
939        }
940    }
941
942    fn on_request(
943        &mut self,
944        event: &EventRequestWillBeSent,
945        interception_id: Option<InterceptionId>,
946    ) {
947        let mut redirect_chain = Vec::new();
948        let mut redirect_location = None;
949
950        if let Some(redirect_resp) = &event.redirect_response {
951            if let Some(mut request) = self.requests.remove(event.request_id.as_ref()) {
952                if is_redirect_status(redirect_resp.status) {
953                    if let Some(location) = redirect_resp.headers.inner()["Location"].as_str() {
954                        if redirect_resp.url != location {
955                            let fixed_location = location.replace(&redirect_resp.url, "");
956                            request.response.as_mut().map(|resp| {
957                                resp.headers.0["Location"] =
958                                    serde_json::Value::String(fixed_location.clone());
959                            });
960                            redirect_location = Some(fixed_location);
961                        }
962                    }
963                }
964
965                self.handle_request_redirect(
966                    &mut request,
967                    if let Some(redirect_location) = redirect_location {
968                        let mut redirect_resp = redirect_resp.clone();
969                        redirect_resp.headers.0["Location"] =
970                            serde_json::Value::String(redirect_location);
971                        redirect_resp
972                    } else {
973                        redirect_resp.clone()
974                    },
975                );
976
977                redirect_chain = std::mem::take(&mut request.redirect_chain);
978                redirect_chain.push(request);
979            }
980        }
981
982        let request = HttpRequest::new(
983            event.request_id.clone(),
984            event.frame_id.clone(),
985            interception_id,
986            self.user_request_interception_enabled,
987            redirect_chain,
988        );
989
990        self.requests.insert(event.request_id.clone(), request);
991        self.queued_events
992            .push_back(NetworkEvent::Request(event.request_id.clone()));
993    }
994
995    fn handle_request_redirect(&mut self, request: &mut HttpRequest, response: Response) {
996        request.set_response(response);
997        if let Some(interception_id) = request.interception_id.as_ref() {
998            self.attempted_authentications
999                .remove(interception_id.as_ref());
1000        }
1001    }
1002}
1003
1004#[derive(Debug)]
1005pub enum NetworkEvent {
1006    SendCdpRequest((MethodId, serde_json::Value)),
1007    Request(RequestId),
1008    Response(RequestId),
1009    RequestFailed(HttpRequest),
1010    RequestFinished(HttpRequest),
1011}
chromiumoxide/handler/network.rs

chromiumoxide/handler/
network.rs
