Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

http_proxy: Add hostname allowlist policy types (#59217)

Richard Feldmanf73b9daf3b2d
diff --git a/Cargo.lock b/Cargo.lock
index d3d73884776..6f62243ae9a 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -8546,6 +8546,14 @@ dependencies = [
"rustls-platform-verifier",
]
+[[package]]
+name = "http_proxy"
+version = "0.1.0"
+dependencies = [
+ "idna",
+ "thiserror 2.0.17",
+]
+
[[package]]
name = "httparse"
version = "1.10.1"
diff --git a/Cargo.toml b/Cargo.toml
index 969572b92f2..64948aaab24 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -103,6 +103,7 @@ members = [
"crates/html_to_markdown",
"crates/http_client",
"crates/http_client_tls",
+ "crates/http_proxy",
"crates/icons",
"crates/image_viewer",
"crates/input_latency_ui",
@@ -357,6 +358,7 @@ gpui_util = { path = "crates/gpui_util" }
html_to_markdown = { path = "crates/html_to_markdown" }
http_client = { path = "crates/http_client" }
http_client_tls = { path = "crates/http_client_tls" }
+http_proxy = { path = "crates/http_proxy" }
icons = { path = "crates/icons" }
image_viewer = { path = "crates/image_viewer" }
edit_prediction_types = { path = "crates/edit_prediction_types" }
@@ -604,6 +606,7 @@ human_bytes = "0.4.1"
html5ever = "0.27.0"
http = "1.1"
http-body = "1.0"
+idna = "1.0"
ignore = "0.4.22"
image = "0.25.1"
imara-diff = "0.1.8"
diff --git a/crates/http_proxy/Cargo.toml b/crates/http_proxy/Cargo.toml
new file mode 100644
index 00000000000..90e7677d453
--- /dev/null
+++ b/crates/http_proxy/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "http_proxy"
+version = "0.1.0"
+edition.workspace = true
+publish.workspace = true
+license = "GPL-3.0-or-later"
+
+[lints]
+workspace = true
+
+[lib]
+path = "src/http_proxy.rs"
+
+[dependencies]
+idna.workspace = true
+thiserror.workspace = true
diff --git a/crates/http_proxy/LICENSE-GPL b/crates/http_proxy/LICENSE-GPL
new file mode 120000
index 00000000000..89e542f750c
--- /dev/null
+++ b/crates/http_proxy/LICENSE-GPL
@@ -0,0 +1 @@
+../../LICENSE-GPL
\ No newline at end of file
diff --git a/crates/http_proxy/src/allowlist.rs b/crates/http_proxy/src/allowlist.rs
new file mode 100644
index 00000000000..e674c4c9c4f
--- /dev/null
+++ b/crates/http_proxy/src/allowlist.rs
@@ -0,0 +1,483 @@
+//! Hostname allowlist for the proxy's policy decisions.
+//!
+//! Patterns are either exact hostnames (`github.com`) or leading-`*.`
+//! subdomain wildcards (`*.example.com` matches `a.example.com` and
+//! `a.b.example.com`, but **not** `example.com` itself — that's the
+//! convention for subdomain wildcards). No middle wildcards, no regex,
+//! no port matching.
+//!
+//! Hostnames are matched case-insensitively (DNS hostnames are case-insensitive
+//! per RFC 1035 §2.3.3) with any trailing dot stripped (so `example.com.` and
+//! `example.com` are equivalent). Internationalized domain names supplied as
+//! UTF-8 are auto-converted to A-label (Punycode) form so callers don't have
+//! to think about it.
+//!
+//! IP literals (IPv4 / IPv6 / `localhost`) are rejected when constructing a
+//! `HostPattern` — hostname-based allowlisting cannot meaningfully apply to
+//! them, and accepting them would be a policy footgun.
+
+use std::fmt;
+use std::net::IpAddr;
+use thiserror::Error;
+
+/// A hostname pattern accepted by the allowlist.
+#[derive(Debug, Clone, PartialEq, Eq, Hash)]
+pub enum HostPattern {
+ /// Matches exactly one hostname (case-insensitive, trailing-dot tolerant).
+ Exact(String),
+ /// Matches subdomains of the contained hostname. `*.example.com` matches
+ /// `a.example.com` and `a.b.example.com`, but not `example.com` itself.
+ Subdomain(String),
+}
+
+impl fmt::Display for HostPattern {
+ /// Renders the pattern back to its canonical user-facing form. The output
+ /// round-trips through [`HostPattern::parse`]: `Exact` prints the bare
+ /// hostname, `Subdomain` prints the leading-`*.` wildcard form.
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ HostPattern::Exact(host) => write!(f, "{host}"),
+ HostPattern::Subdomain(parent) => write!(f, "*.{parent}"),
+ }
+ }
+}
+
+/// Errors returned when parsing a host pattern from a user-provided string.
+#[derive(Debug, Error)]
+pub enum HostPatternError {
+ /// The pattern was empty after trimming.
+ #[error("host pattern cannot be empty")]
+ Empty,
+ /// The pattern contained an IP literal (IPv4, IPv6) or a local hostname
+ /// (`localhost`, `*.localhost`). Hostname-based allowlisting cannot
+ /// meaningfully apply to the local machine.
+ #[error(
+ "host pattern '{0}' is an IP literal or local hostname; only remote hostnames are allowed"
+ )]
+ IpLiteral(String),
+ /// The pattern contained a wildcard somewhere other than as a leading
+ /// label. We support `*.foo.com` but not `foo.*.com`, `*.com`, etc.
+ #[error("host pattern '{0}' has a wildcard somewhere other than the leading label")]
+ InvalidWildcard(String),
+ /// The pattern was syntactically invalid (e.g., empty labels, contained
+ /// characters that no IDN-form hostname could contain).
+ #[error("host pattern '{pattern}' is not a valid hostname: {reason}")]
+ Invalid { pattern: String, reason: String },
+}
+
+impl HostPattern {
+ /// Parse a host pattern from a user-provided string.
+ ///
+ /// Accepts ASCII hostnames or UTF-8 IDN forms (auto-converted to Punycode),
+ /// case-insensitively. A leading `*.` indicates a subdomain wildcard.
+ /// Trailing dots are stripped.
+ ///
+ /// Rejects IP literals, middle/trailing wildcards, empty labels, and
+ /// hostnames `idna` declines to convert.
+ pub fn parse(input: &str) -> Result<Self, HostPatternError> {
+ let trimmed = input.trim();
+ if trimmed.is_empty() {
+ return Err(HostPatternError::Empty);
+ }
+
+ let (is_subdomain, rest) = if let Some(rest) = trimmed.strip_prefix("*.") {
+ (true, rest)
+ } else {
+ (false, trimmed)
+ };
+
+ // Reject any further wildcards. `foo.*.com`, `*.foo.*`, etc.
+ if rest.contains('*') {
+ return Err(HostPatternError::InvalidWildcard(input.to_string()));
+ }
+
+ // Strip a single trailing dot — `example.com.` and `example.com` are
+ // the same host. Comment per project convention: hostnames are
+ // case-insensitive (RFC 1035 §2.3.3) and trailing-dot tolerant.
+ let without_trailing_dot = rest.strip_suffix('.').unwrap_or(rest);
+ if without_trailing_dot.is_empty() {
+ return Err(HostPatternError::Empty);
+ }
+
+ // IDN auto-conversion to Punycode (A-labels). For pure-ASCII inputs
+ // this is a no-op; for UTF-8 it produces the `xn--` form that TLS
+ // SNI and HTTP `Host:` headers actually carry over the wire.
+ let ascii =
+ idna::domain_to_ascii(without_trailing_dot).map_err(|e| HostPatternError::Invalid {
+ pattern: input.to_string(),
+ reason: format!("idna conversion failed: {e}"),
+ })?;
+
+ if ascii.is_empty() {
+ return Err(HostPatternError::Empty);
+ }
+
+ // Reject IP literals (v4 and v6) so that hostname-based allowlisting
+ // can't be subverted by listing an IP. IPv6 literals in hostname
+ // contexts arrive bracketed (`[::1]`); we strip the brackets before
+ // checking.
+ let ip_check_input = ascii
+ .strip_prefix('[')
+ .and_then(|s| s.strip_suffix(']'))
+ .unwrap_or(&ascii);
+ if ip_check_input.parse::<IpAddr>().is_ok() {
+ return Err(HostPatternError::IpLiteral(input.to_string()));
+ }
+ // Final sanity: no empty labels (`foo..bar`), no leading/trailing
+ // dots after our strip-trailing-dot step.
+ if ascii.starts_with('.') || ascii.ends_with('.') || ascii.contains("..") {
+ return Err(HostPatternError::Invalid {
+ pattern: input.to_string(),
+ reason: "empty label".to_string(),
+ });
+ }
+
+ // `idna` lowercases ASCII labels for us; lowercasing again here is a
+ // safety net and a comment that case-insensitive matching is the
+ // model.
+ let canonical = ascii.to_ascii_lowercase();
+
+ // `localhost` (and the whole `.localhost` special-use domain, which
+ // resolvers treat as loopback per RFC 6761) isn't an IP literal but
+ // is treated like one for the purposes of network policy: nothing
+ // about a "hostname allowlist" makes sense for loopback names, and
+ // allowing them would punch a hole through the proxy back into the
+ // host machine.
+ if canonical == "localhost" || canonical.ends_with(".localhost") {
+ return Err(HostPatternError::IpLiteral(input.to_string()));
+ }
+
+ Ok(if is_subdomain {
+ HostPattern::Subdomain(canonical)
+ } else {
+ HostPattern::Exact(canonical)
+ })
+ }
+
+ /// Returns true if this pattern matches the given hostname. The hostname
+ /// should already be in ASCII (Punycode) form — that's how it arrives in
+ /// `CONNECT`/`Host:` lines on the wire.
+ pub fn matches(&self, host: &str) -> bool {
+ // Hostnames are case-insensitive (RFC 1035 §2.3.3) and trailing-dot
+ // tolerant.
+ let canonical = host.strip_suffix('.').unwrap_or(host).to_ascii_lowercase();
+ match self {
+ HostPattern::Exact(pattern) => canonical == *pattern,
+ HostPattern::Subdomain(parent) => {
+ // `*.example.com` matches `a.example.com` and `a.b.example.com`
+ // but **not** `example.com` itself. Some tools include the
+ // bare parent in subdomain wildcards; we don't, by design.
+ canonical
+ .strip_suffix(parent.as_str())
+ .map(|prefix| prefix.ends_with('.') && !prefix.is_empty())
+ .unwrap_or(false)
+ }
+ }
+ }
+
+ /// Returns true if granting this pattern subsumes granting `other` — i.e.
+ /// every host `other` would permit is also permitted by `self`.
+ ///
+ /// This is the host-pattern analogue of filesystem subtree containment,
+ /// used to decide whether an already-granted network permission covers a
+ /// newly requested one (so the user isn't re-prompted). Examples:
+ ///
+ /// - `github.com` covers `github.com` (identical).
+ /// - `*.github.com` covers `api.github.com` and `*.api.github.com`.
+ /// - `*.github.com` does **not** cover `github.com` (the bare parent is
+ /// not a subdomain), and a narrower grant never covers a broader one.
+ pub fn covers(&self, other: &HostPattern) -> bool {
+ match (self, other) {
+ (HostPattern::Exact(a), HostPattern::Exact(b)) => a == b,
+ // An exact grant can only cover that one host, never a wildcard.
+ (HostPattern::Exact(_), HostPattern::Subdomain(_)) => false,
+ (HostPattern::Subdomain(parent), HostPattern::Exact(host)) => {
+ is_subdomain_of(host, parent)
+ }
+ (HostPattern::Subdomain(parent), HostPattern::Subdomain(child)) => {
+ child == parent || is_subdomain_of(child, parent)
+ }
+ }
+ }
+}
+
+/// Whether `host` is a strict subdomain of `parent`. Both are expected to be
+/// in canonical form (lowercase, no trailing dot), as produced by
+/// [`HostPattern::parse`]. `is_subdomain_of("a.example.com", "example.com")`
+/// is true; `is_subdomain_of("example.com", "example.com")` is false.
+fn is_subdomain_of(host: &str, parent: &str) -> bool {
+ host.strip_suffix(parent)
+ .and_then(|prefix| prefix.strip_suffix('.'))
+ .is_some_and(|label| !label.is_empty())
+}
+
+/// Set of host patterns. Construct with `Allowlist::from_patterns` or via
+/// `FromIterator<HostPattern>`.
+#[derive(Debug, Clone, Default)]
+pub struct Allowlist {
+ patterns: Vec<HostPattern>,
+ /// When true, every host is allowed regardless of `patterns`. The proxy
+ /// still observes traffic and emits events; it just doesn't deny.
+ allow_any: bool,
+}
+
+impl Allowlist {
+ /// An allowlist that denies everything. Equivalent to `Allowlist::default()`.
+ pub fn empty() -> Self {
+ Self::default()
+ }
+
+ /// An allowlist that allows any host. Useful for `allow_all_hosts: true`
+ /// approval flow — we still proxy and observe, but skip the policy check.
+ pub fn any() -> Self {
+ Self {
+ patterns: Vec::new(),
+ allow_any: true,
+ }
+ }
+
+ /// Build from an iterator of patterns.
+ pub fn from_patterns<I: IntoIterator<Item = HostPattern>>(patterns: I) -> Self {
+ Self {
+ patterns: patterns.into_iter().collect(),
+ allow_any: false,
+ }
+ }
+
+ /// Returns `true` if the host should be allowed through.
+ pub fn allows(&self, host: &str) -> bool {
+ if self.allow_any {
+ return true;
+ }
+ self.patterns.iter().any(|p| p.matches(host))
+ }
+
+ /// Patterns in this allowlist (for diagnostics / system prompt rendering).
+ pub fn patterns(&self) -> &[HostPattern] {
+ &self.patterns
+ }
+
+ /// Whether this allowlist permits any host without a policy check.
+ pub fn allows_any(&self) -> bool {
+ self.allow_any
+ }
+
+ /// Whether this allowlist denies every host — i.e. it grants nothing,
+ /// so no network plumbing is needed at all.
+ pub fn is_deny_all(&self) -> bool {
+ !self.allow_any && self.patterns.is_empty()
+ }
+}
+
+impl FromIterator<HostPattern> for Allowlist {
+ fn from_iter<I: IntoIterator<Item = HostPattern>>(iter: I) -> Self {
+ Self::from_patterns(iter)
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn parse_exact_hostname() {
+ let p = HostPattern::parse("github.com").unwrap();
+ assert_eq!(p, HostPattern::Exact("github.com".into()));
+ }
+
+ #[test]
+ fn parse_is_case_insensitive() {
+ let p = HostPattern::parse("GitHub.COM").unwrap();
+ assert_eq!(p, HostPattern::Exact("github.com".into()));
+ }
+
+ #[test]
+ fn parse_strips_trailing_dot() {
+ let p = HostPattern::parse("example.com.").unwrap();
+ assert_eq!(p, HostPattern::Exact("example.com".into()));
+ }
+
+ #[test]
+ fn parse_subdomain_wildcard() {
+ let p = HostPattern::parse("*.example.com").unwrap();
+ assert_eq!(p, HostPattern::Subdomain("example.com".into()));
+ }
+
+ #[test]
+ fn parse_idn_to_punycode() {
+ let p = HostPattern::parse("münchen.de").unwrap();
+ assert_eq!(p, HostPattern::Exact("xn--mnchen-3ya.de".into()));
+ }
+
+ #[test]
+ fn parse_rejects_empty() {
+ assert!(matches!(
+ HostPattern::parse("").unwrap_err(),
+ HostPatternError::Empty
+ ));
+ assert!(matches!(
+ HostPattern::parse(" ").unwrap_err(),
+ HostPatternError::Empty
+ ));
+ assert!(matches!(
+ HostPattern::parse("*.").unwrap_err(),
+ HostPatternError::Empty
+ ));
+ }
+
+ #[test]
+ fn parse_rejects_ip_literals() {
+ for ip in ["1.2.3.4", "127.0.0.1", "0.0.0.0", "::1", "[::1]", "fe80::1"] {
+ assert!(
+ matches!(
+ HostPattern::parse(ip).unwrap_err(),
+ HostPatternError::IpLiteral(_)
+ ),
+ "expected IpLiteral for {ip}"
+ );
+ }
+ }
+
+ #[test]
+ fn parse_rejects_localhost() {
+ // The whole `.localhost` special-use domain is loopback per RFC 6761,
+ // not just the bare name.
+ for pattern in [
+ "localhost",
+ "LOCALHOST",
+ "localhost.",
+ "foo.localhost",
+ "*.localhost",
+ "a.b.localhost",
+ ] {
+ assert!(
+ matches!(
+ HostPattern::parse(pattern).unwrap_err(),
+ HostPatternError::IpLiteral(_)
+ ),
+ "expected IpLiteral for {pattern}"
+ );
+ }
+ }
+
+ #[test]
+ fn parse_rejects_middle_wildcards() {
+ for pat in ["foo.*.com", "*.foo.*", "*.*", "foo.*"] {
+ assert!(
+ matches!(
+ HostPattern::parse(pat).unwrap_err(),
+ HostPatternError::InvalidWildcard(_)
+ ),
+ "expected InvalidWildcard for {pat}"
+ );
+ }
+ }
+
+ #[test]
+ fn parse_rejects_empty_labels() {
+ let err = HostPattern::parse("foo..bar").unwrap_err();
+ assert!(matches!(err, HostPatternError::Invalid { .. }));
+ }
+
+ #[test]
+ fn matches_exact_is_case_insensitive() {
+ let p = HostPattern::parse("github.com").unwrap();
+ assert!(p.matches("github.com"));
+ assert!(p.matches("GITHUB.COM"));
+ assert!(p.matches("GitHub.com"));
+ assert!(p.matches("github.com.")); // trailing dot
+ assert!(!p.matches("example.com"));
+ assert!(!p.matches("a.github.com")); // exact does not match subdomains
+ }
+
+ #[test]
+ fn matches_subdomain_wildcard() {
+ let p = HostPattern::parse("*.example.com").unwrap();
+ assert!(p.matches("a.example.com"));
+ assert!(p.matches("a.b.example.com"));
+ assert!(p.matches("A.B.EXAMPLE.COM"));
+ // `*.example.com` does NOT match the bare parent.
+ assert!(!p.matches("example.com"));
+ // Sibling not a subdomain.
+ assert!(!p.matches("notexample.com"));
+ assert!(!p.matches("malicious-example.com"));
+ }
+
+ #[test]
+ fn matches_idn_via_punycode() {
+ let p = HostPattern::parse("münchen.de").unwrap();
+ assert!(p.matches("xn--mnchen-3ya.de"));
+ // Hosts arrive on the wire as Punycode, so we don't try to match the
+ // UTF-8 form. Just make sure that path works.
+ }
+
+ #[test]
+ fn allowlist_allows_member() {
+ let list = Allowlist::from_patterns(vec![
+ HostPattern::parse("github.com").unwrap(),
+ HostPattern::parse("*.npmjs.org").unwrap(),
+ ]);
+ assert!(list.allows("github.com"));
+ assert!(list.allows("registry.npmjs.org"));
+ assert!(!list.allows("example.com"));
+ assert!(!list.allows("npmjs.org")); // bare parent doesn't match wildcard
+ }
+
+ #[test]
+ fn empty_allowlist_denies_everything() {
+ let list = Allowlist::empty();
+ assert!(!list.allows("anything.com"));
+ }
+
+ #[test]
+ fn any_allowlist_allows_everything() {
+ let list = Allowlist::any();
+ assert!(list.allows("anything.com"));
+ assert!(list.allows("evil.org"));
+ assert!(list.allows("a.b.c.d.e"));
+ assert!(list.allows_any());
+ }
+
+ #[test]
+ fn display_round_trips_through_parse() {
+ for input in ["github.com", "*.example.com", "xn--mnchen-3ya.de"] {
+ let pattern = HostPattern::parse(input).unwrap();
+ let rendered = pattern.to_string();
+ assert_eq!(HostPattern::parse(&rendered).unwrap(), pattern);
+ }
+ assert_eq!(
+ HostPattern::parse("GitHub.com").unwrap().to_string(),
+ "github.com"
+ );
+ assert_eq!(
+ HostPattern::parse("*.NPMJS.org").unwrap().to_string(),
+ "*.npmjs.org"
+ );
+ }
+
+ #[test]
+ fn covers_exact_only_matches_identical() {
+ let github = HostPattern::parse("github.com").unwrap();
+ assert!(github.covers(&HostPattern::parse("github.com").unwrap()));
+ assert!(!github.covers(&HostPattern::parse("api.github.com").unwrap()));
+ assert!(!github.covers(&HostPattern::parse("*.github.com").unwrap()));
+ assert!(!github.covers(&HostPattern::parse("example.com").unwrap()));
+ }
+
+ #[test]
+ fn covers_subdomain_wildcard_subsumes_descendants() {
+ let wildcard = HostPattern::parse("*.github.com").unwrap();
+ // Covers exact subdomains, at any depth.
+ assert!(wildcard.covers(&HostPattern::parse("api.github.com").unwrap()));
+ assert!(wildcard.covers(&HostPattern::parse("a.b.github.com").unwrap()));
+ // Covers narrower wildcards.
+ assert!(wildcard.covers(&HostPattern::parse("*.api.github.com").unwrap()));
+ assert!(wildcard.covers(&HostPattern::parse("*.github.com").unwrap()));
+ // Does NOT cover the bare parent or unrelated hosts.
+ assert!(!wildcard.covers(&HostPattern::parse("github.com").unwrap()));
+ assert!(!wildcard.covers(&HostPattern::parse("notgithub.com").unwrap()));
+ // A narrower wildcard does not cover a broader one.
+ let narrow = HostPattern::parse("*.api.github.com").unwrap();
+ assert!(!narrow.covers(&HostPattern::parse("*.github.com").unwrap()));
+ }
+}
diff --git a/crates/http_proxy/src/http_proxy.rs b/crates/http_proxy/src/http_proxy.rs
new file mode 100644
index 00000000000..6d978b89dfd
--- /dev/null
+++ b/crates/http_proxy/src/http_proxy.rs
@@ -0,0 +1,14 @@
+//! Hostname-allowlisting primitives for confining sandboxed network access.
+//!
+//! This crate grows over a short stack of PRs:
+//!
+//! - [`allowlist`]: the policy types ([`HostPattern`], [`Allowlist`]) that
+//! decide which hosts a sandboxed command may reach.
+//! - `upstream` (next): parsing an upstream HTTP proxy from the environment.
+//! - the proxy server itself (last): an in-process HTTP/HTTPS proxy that
+//! enforces an [`Allowlist`] and is the only network egress a sandboxed
+//! command is permitted.
+
+mod allowlist;
+
+pub use allowlist::{Allowlist, HostPattern, HostPatternError};