tauri-plugins-workspace/plugins/http/src/scope.rs

// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT

use glob::Pattern;
use reqwest::Url;
use tauri::utils::config::HttpAllowlistScope;

/// Scope for filesystem access.
#[derive(Debug, Clone)]
pub struct Scope {
    allowed_urls: Vec<Pattern>,
}

impl Scope {
    /// Creates a new scope from the allowlist's `http` scope configuration.
    pub(crate) fn new(scope: &HttpAllowlistScope) -> Self {
        Self {
            allowed_urls: scope
                .0
                .iter()
                .map(|url| {
                    glob::Pattern::new(url.as_str()).unwrap_or_else(|_| {
                        panic!("scoped URL is not a valid glob pattern: `{url}`")
                    })
                })
                .collect(),
        }
    }

    /// Determines if the given URL is allowed on this scope.
    pub fn is_allowed(&self, url: &Url) -> bool {
        self.allowed_urls
            .iter()
            .any(|allowed| allowed.matches(url.as_str()))
    }
}

#[cfg(test)]
mod tests {
    use tauri_utils::config::HttpAllowlistScope;

    #[test]
    fn is_allowed() {
        // plain URL
        let scope = super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://localhost:8080"
            .parse()
            .unwrap()]));
        assert!(scope.is_allowed(&"http://localhost:8080".parse().unwrap()));
        assert!(scope.is_allowed(&"http://localhost:8080/".parse().unwrap()));

        assert!(!scope.is_allowed(&"http://localhost:8080/file".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8080/path/to/asset.png".parse().unwrap()));
        assert!(!scope.is_allowed(&"https://localhost:8080".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8081".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://local:8080".parse().unwrap()));

        // URL with fixed path
        let scope =
            super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://localhost:8080/file.png"
                .parse()
                .unwrap()]));

        assert!(scope.is_allowed(&"http://localhost:8080/file.png".parse().unwrap()));

        assert!(!scope.is_allowed(&"http://localhost:8080".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8080/file".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://localhost:8080/file.png/other.jpg".parse().unwrap()));

        // URL with glob pattern
        let scope =
            super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://localhost:8080/*.png"
                .parse()
                .unwrap()]));

        assert!(scope.is_allowed(&"http://localhost:8080/file.png".parse().unwrap()));
        assert!(scope.is_allowed(&"http://localhost:8080/assets/file.png".parse().unwrap()));

        assert!(!scope.is_allowed(&"http://localhost:8080/file.jpeg".parse().unwrap()));

        let scope =
            super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://*".parse().unwrap()]));

        assert!(scope.is_allowed(&"http://something.else".parse().unwrap()));
        assert!(!scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap()));
        assert!(!scope.is_allowed(&"https://something.else".parse().unwrap()));

        let scope =
            super::Scope::for_http_api(&HttpAllowlistScope(vec!["http://**".parse().unwrap()]));

        assert!(scope.is_allowed(&"http://something.else".parse().unwrap()));
        assert!(scope.is_allowed(&"http://something.else/path/to/file".parse().unwrap()));
    }
}