Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix mutating path of URL without authority (idempotency, empty path segments) #996

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 64 additions & 3 deletions url/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1757,6 +1757,39 @@
let old_after_path_pos = to_u32(self.serialization.len()).unwrap();
let cannot_be_a_base = self.cannot_be_a_base();
let scheme_type = SchemeType::from(self.scheme());
let mut path_empty = false;

// Check ':' and then see if the next character is '/'
let mut has_host = if let Some(index) = self.serialization.find(":") {
if self.serialization.len() > index + 1
&& self.serialization.as_bytes().get(index + 1) == Some(&b'/')
{
let rest = &self.serialization[(index + ":/".len())..];
let host_part = rest.split('/').next().unwrap_or("");
path_empty = rest.is_empty();
!host_part.is_empty() && !host_part.contains('@')
} else {
false
}
} else {
false

Check warning on line 1775 in url/src/lib.rs

View check run for this annotation

Codecov / codecov/patch

url/src/lib.rs#L1775

Added line #L1775 was not covered by tests
};

// Ensure the path length is greater than 1 to account
// for cases where "/." is already appended from serialization
// If we set path, then we already checked the other two conditions:
// https://url.spec.whatwg.org/#url-serializing
// 1. The host is null
// 2. the first segment of the URL's path is an empty string
if self.path().len() + path.len() > 1 {
if let Some(index) = self.serialization.find(":") {
let removal_start = index + ":".len();
if self.serialization[removal_start..].starts_with("/.") {
self.path_start = removal_start as u32;
}
}
}

self.serialization.truncate(self.path_start as usize);
self.mutate(|parser| {
if cannot_be_a_base {
Expand All @@ -1766,14 +1799,33 @@
}
parser.parse_cannot_be_a_base_path(parser::Input::new_no_trim(path));
} else {
let mut has_host = true; // FIXME
parser.parse_path_start(
scheme_type,
&mut has_host,
parser::Input::new_no_trim(path),
);
}
});

// For cases where normalization is applied across both the serialization and the path.
// Append "/." immediately after the scheme (up to ":")
// This is done if three conditions are met.
// https://url.spec.whatwg.org/#url-serializing
// 1. The host is null
// 2. The url's path length is greater than 1
// 3. the first segment of the URL's path is an empty string
if !has_host && path.len() > 1 && path_empty {
if let Some(index) = self.serialization.find(":") {
if self.serialization.len() > index + 2
&& self.serialization.as_bytes().get(index + 1) == Some(&b'/')
&& self.serialization.as_bytes().get(index + 2) == Some(&b'/')
{
self.serialization.insert_str(index + ":".len(), "/.");
self.path_start += "/.".len() as u32;
}
}
}

self.restore_after_path(old_after_path_pos, &after_path);
}

Expand Down Expand Up @@ -2077,7 +2129,7 @@
} else {
self.host_end
};
let suffix = self.slice(old_suffix_pos..).to_owned();
let mut suffix = self.slice(old_suffix_pos..).to_owned();
self.serialization.truncate(self.host_start as usize);
if !self.has_authority() {
debug_assert!(self.slice(self.scheme_end..self.host_start) == ":");
Expand All @@ -2097,7 +2149,16 @@
write!(&mut self.serialization, ":{}", port).unwrap();
}
}
let new_suffix_pos = to_u32(self.serialization.len()).unwrap();
let mut new_suffix_pos = to_u32(self.serialization.len()).unwrap();

// Remove starting "/." for empty path segment followed by the host
if suffix.starts_with("/.//") {
let adjustment: usize = "/.".len();
suffix.drain(..adjustment);
// pathname should be "//p" not "p" given that the first segment was empty
new_suffix_pos -= adjustment as u32;
}

self.serialization.push_str(&suffix);

let adjust = |index: &mut u32| {
Expand Down
42 changes: 40 additions & 2 deletions url/src/path_segments.rs
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@
I::Item: AsRef<str>,
{
let scheme_type = SchemeType::from(self.url.scheme());
let path_start = self.url.path_start as usize;
let mut path_start = self.url.path_start as usize;
self.url.mutate(|parser| {
parser.context = parser::Context::PathSegmentSetter;
for segment in segments {
Expand All @@ -253,7 +253,44 @@
{
parser.serialization.push('/');
}
let mut has_host = true; // FIXME account for this?

let mut path_empty = false;

// Check ':' and then see if the next character is '/'
let mut has_host = if let Some(index) = parser.serialization.find(":") {
if parser.serialization.len() > index + 1
&& parser.serialization.as_bytes().get(index + 1) == Some(&b'/')
{
let rest = &parser.serialization[(index + ":/".len())..];
let host_part = rest.split('/').next().unwrap_or("");
path_empty = rest.is_empty();
!host_part.is_empty() && !host_part.contains('@')
} else {
false

Check warning on line 269 in url/src/path_segments.rs

View check run for this annotation

Codecov / codecov/patch

url/src/path_segments.rs#L269

Added line #L269 was not covered by tests
}
} else {
false

Check warning on line 272 in url/src/path_segments.rs

View check run for this annotation

Codecov / codecov/patch

url/src/path_segments.rs#L272

Added line #L272 was not covered by tests
};

// For cases where normalization is applied across both the serialization and the path.
// Append "/." immediately after the scheme (up to ":")
// This is done if three conditions are met.
// https://url.spec.whatwg.org/#url-serializing
// 1. The host is null
// 2. The url's path length is greater than 1
// 3. the first segment of the URL's path is an empty string
if !has_host && segment.len() > 1 && path_empty {
if let Some(index) = parser.serialization.find(":") {
if parser.serialization.len() == index + 2
&& parser.serialization.as_bytes().get(index + 1) == Some(&b'/')
{
// Append an extra '/' to ensure that "/./path" becomes "/.//path"
parser.serialization.insert_str(index + ":".len(), "/./");
path_start += "/.".len();
}
}
}

parser.parse_path(
scheme_type,
&mut has_host,
Expand All @@ -262,6 +299,7 @@
);
}
});
self.url.path_start = path_start as u32;
self
}
}
6 changes: 0 additions & 6 deletions url/tests/expected_failures.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,8 @@
<file:/.//p>
<http://example.net/path> set hostname to <example.com:8080>
<http://example.net:8080/path> set hostname to <example.com:>
<non-spec:/.//p> set hostname to <h>
<non-spec:/.//p> set hostname to <>
<foo:///some/path> set pathname to <>
<file:///var/log/system.log> set href to <http://0300.168.0xF0>
<file://monkey/> set pathname to <\\\\>
<file:///unicorn> set pathname to <//\\/>
<file:///unicorn> set pathname to <//monkey/..//>
<non-spec:/> set pathname to </.//p>
<non-spec:/> set pathname to </..//p>
<non-spec:/> set pathname to <//p>
<non-spec:/.//> set pathname to <p>
124 changes: 124 additions & 0 deletions url/tests/unit.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1379,3 +1379,127 @@ fn serde_error_message() {
r#"relative URL without a base: "§invalid#+#*Ä" at line 1 column 25"#
);
}

#[test]
fn test_fuzzing_uri_failures() {
use url::quirks;
let mut url = Url::parse("data:/.dummy.path").unwrap();
assert!(!url.cannot_be_a_base());

url.set_path(".dummy.path");
assert_eq!(url.as_str(), "data:/.dummy.path");
assert_eq!(url.path(), "/.dummy.path");
url.check_invariants().unwrap();

url.path_segments_mut()
.expect("should have path segments")
.push(".another.dummy.path");
assert_eq!(url.as_str(), "data:/.dummy.path/.another.dummy.path");
assert_eq!(url.path(), "/.dummy.path/.another.dummy.path");
url.check_invariants().unwrap();

url = Url::parse("web+demo:/").unwrap();
assert!(!url.cannot_be_a_base());

url.set_path("//.dummy.path");
assert_eq!(url.path(), "//.dummy.path");

let segments: Vec<_> = url
.path_segments()
.expect("should have path segments")
.collect();
assert_eq!(segments, vec!["", ".dummy.path"]);
assert_eq!(url.as_str(), "web+demo:/.//.dummy.path");

quirks::set_hostname(&mut url, ".dummy.host").unwrap();
assert_eq!(url.as_str(), "web+demo://.dummy.host//.dummy.path");
url.check_invariants().unwrap();

quirks::set_hostname(&mut url, "").unwrap();
assert_eq!(url.as_str(), "web+demo:////.dummy.path");
url.check_invariants().unwrap();
}

#[test]
fn test_can_be_a_base_with_set_path() {
use url::quirks;
let mut url = Url::parse("web+demo:/").unwrap();
assert!(!url.cannot_be_a_base());

url.set_path("//not-a-host");
assert_eq!(url.path(), "//not-a-host");

let segments: Vec<_> = url
.path_segments()
.expect("should have path segments")
.collect();

assert_eq!(segments, vec!["", "not-a-host"]);

url.set_query(Some("query"));
url.set_fragment(Some("frag"));

assert_eq!(url.as_str(), "web+demo:/.//not-a-host?query#frag");
quirks::set_hostname(&mut url, "test").unwrap();
assert_eq!(url.as_str(), "web+demo://test//not-a-host?query#frag");
url.check_invariants().unwrap();
quirks::set_hostname(&mut url, "").unwrap();
assert_eq!(url.as_str(), "web+demo:////not-a-host?query#frag");
url.check_invariants().unwrap();
}

#[test]
fn test_can_be_a_base_with_path_segments_mut() {
let mut url = Url::parse("web+demo:/").unwrap();
assert!(!url.cannot_be_a_base());

url.path_segments_mut()
.expect("should have path segments")
.push("")
.push("not-a-host");

url.set_query(Some("query"));
url.set_fragment(Some("frag"));

assert_eq!(url.as_str(), "web+demo:/.//not-a-host?query#frag");
assert_eq!(url.path(), "//not-a-host");
url.check_invariants().unwrap();

let segments: Vec<_> = url
.path_segments()
.expect("should have path segments")
.collect();
assert_eq!(segments, vec!["", "not-a-host"]);
}

#[test]
fn test_valid_indices_after_set_path() {
// Testing everything
let mut url = Url::parse("moz:/").unwrap();
assert!(!url.cannot_be_a_base());

url.set_path("/.//p");
url.set_host(Some("host")).unwrap();
url.set_query(Some("query"));
url.set_fragment(Some("frag"));
assert_eq!(url.as_str(), "moz://host//p?query#frag");
assert_eq!(url.host(), Some(Host::Domain("host")));
assert_eq!(url.path(), "//p");
assert_eq!(url.query(), Some("query"));
assert_eq!(url.fragment(), Some("frag"));
url.check_invariants().unwrap();

url = Url::parse("moz:/.//").unwrap();
assert!(!url.cannot_be_a_base());

url.set_path("p");
url.set_host(Some("host")).unwrap();
url.set_query(Some("query"));
url.set_fragment(Some("frag"));
assert_eq!(url.as_str(), "moz://host/p?query#frag");
assert_eq!(url.host(), Some(Host::Domain("host")));
assert_eq!(url.path(), "/p");
assert_eq!(url.query(), Some("query"));
assert_eq!(url.fragment(), Some("frag"));
url.check_invariants().unwrap();
}
Loading