Skip to content

fix(git): convert SCP-like submodule URLs to ssh:// format #16727

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.

Sign up for GitHub

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

Merged
weihanglo merged 2 commits into from
Mar 12, 2026
+91 −10
Merged

fix(git): convert SCP-like submodule URLs to ssh:// format #16727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e73307
test(git): Add test to fetch SCP-like submodule
cibil47 Mar 11, 2026
dbb2b56
fix(git): convert SCP-like submodule URLs to ssh:// format
cibil47 Mar 10, 2026
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
30 changes: 20 additions & 10 deletions src/cargo/sources/git/utils.rs
View file
Open in desktop
Copy link
Member

@weihanglo weihanglo Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking a stab. This is indeed a regression.

Since Cargo doesn't support SCP-like git dependency URL in Cargo.toml, this case was overlooked. However, libgit2 supports SCP-like URL, so we should follow if it is in .gitmodules not in Cargo.toml. I think it is fine we scope this for supporting submodule only. For general SCP-like URL support, we track in #1851.

Original file line number Diff line number Diff line change
Expand Up @@ -511,8 +511,9 @@ impl CheckoutGuard {
/// (`git@github.com:rust-lang/cargo.git` is not a valid WHATWG URL)
///
/// To overcome these, this patch always tries [`Url::parse`] first to normalize
/// the path. If it couldn't, append the relative path as the last resort and
/// pray the remote git service supports non-normalized URLs.
/// the path. If it couldn't, append the relative path and/or convert SCP-like URLs
/// to ssh:// format as the last resorts and pray the remote git service supports
/// non-normalized URLs.
///
/// See also rust-lang/cargo#12404 and rust-lang/cargo#12295.
///
Expand Down Expand Up @@ -546,6 +547,15 @@ fn absolute_submodule_url<'s>(base_url: &str, submodule_url: &'s str) -> CargoRe
Cow::from(submodule_url)
};

let absolute_url = match gix::url::parse(gix::bstr::BStr::new(absolute_url.as_ref().as_bytes()))
{
Ok(mut url) if url.serialize_alternative_form && url.scheme == gix::url::Scheme::Ssh => {
url.serialize_alternative_form = false;
Cow::from(url.to_bstring().to_string())
}
_ => absolute_url,
};

Ok(absolute_url)
}

Expand Down Expand Up @@ -1623,7 +1633,7 @@ mod tests {
(
"ssh://git@gitub.com/rust-lang/cargo",
"git@github.com:rust-lang/cargo.git",
"git@github.com:rust-lang/cargo.git",
"ssh://git@github.com/rust-lang/cargo.git",
),
(
"ssh://git@gitub.com/rust-lang/cargo",
Expand Down Expand Up @@ -1668,37 +1678,37 @@ mod tests {
(
"git@github.com:rust-lang/cargo.git",
"./",
"git@github.com:rust-lang/cargo.git/./",
"ssh://git@github.com/rust-lang/cargo.git/./",
),
(
"git@github.com:rust-lang/cargo.git",
"../",
"git@github.com:rust-lang/cargo.git/../",
"ssh://git@github.com/rust-lang/cargo.git/../",
),
(
"git@github.com:rust-lang/cargo.git",
"./foo",
"git@github.com:rust-lang/cargo.git/./foo",
"ssh://git@github.com/rust-lang/cargo.git/./foo",
),
(
"git@github.com:rust-lang/cargo.git/",
"./foo",
"git@github.com:rust-lang/cargo.git/./foo",
"ssh://git@github.com/rust-lang/cargo.git/./foo",
),
(
"git@github.com:rust-lang/cargo.git",
"../foo",
"git@github.com:rust-lang/cargo.git/../foo",
"ssh://git@github.com/rust-lang/cargo.git/../foo",
),
(
"git@github.com:rust-lang/cargo.git/",
"../foo",
"git@github.com:rust-lang/cargo.git/../foo",
"ssh://git@github.com/rust-lang/cargo.git/../foo",
),
(
"git@github.com:rust-lang/cargo.git",
"../foo/bar/../baz",
"git@github.com:rust-lang/cargo.git/../foo/bar/../baz",
"ssh://git@github.com/rust-lang/cargo.git/../foo/bar/../baz",
),
];

Expand Down
71 changes: 71 additions & 0 deletions tests/testsuite/git.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4379,3 +4379,74 @@ fn dep_with_cached_submodule() {
.collect::<Vec<_>>();
assert_eq!(db_paths.len(), 1, "submodule db created once");
}

#[cargo_test]
fn dep_with_scp_like_submodule_url() {
// Regression test for https://github.com/rust-lang/cargo/pull/16727
let git_project = git::new("dep1", |project| {
project
.file("Cargo.toml", &basic_manifest("dep1", "0.5.0"))
.file("src/lib.rs", "pub fn dep() {}")
});
let git_project2 = git::new("dep2", |project| project.file("lib.rs", "pub fn dep2() {}"));

let repo = git2::Repository::open(&git_project.root()).unwrap();
let url = git_project2.root().to_url().to_string();
git::add_submodule(&repo, &url, Path::new("submod"));
git::commit(&repo);

git_project.change_file(
".gitmodules",
"[submodule \"submod\"]\n\tpath = submod\n\turl = git@github.com:foo/bar.git",
);
git::add(&repo);
git::commit(&repo);

let p = project()
.file(
"Cargo.toml",
&format!(
r#"
[package]
name = "foo"
version = "0.5.0"
edition = "2015"

[dependencies.dep1]
git = '{}'
"#,
git_project.url()
),
)
.file("src/lib.rs", "extern crate dep1;")
.build();

// With the SCP-like URL fix, Cargo converts `git@github.com:foo/bar.git`
// to `ssh://git@github.com/foo/bar.git` and tries to fetch, which fails
// with other errors like authentication failure or SSH server not reachable.
p.cargo("fetch")
.env(
"GIT_SSH_COMMAND",
"ssh -o StrictHostKeyChecking=no -o LogLevel=ERROR",
)
.with_status(101)
.with_stderr_data(str![[r#"
[UPDATING] git repository `[ROOTURL]/dep1`
[UPDATING] git submodule `ssh://git@github.com/foo/bar.git`
[ERROR] failed to get `dep1` as a dependency of package `foo v0.5.0 ([ROOT]/foo)`

Caused by:
failed to load source for dependency `dep1`

Caused by:
unable to update [ROOTURL]/dep1

Caused by:
failed to update submodule `submod`

Caused by:
failed to fetch submodule `submod` from ssh://git@github.com/foo/bar.git
...
"#]])
.run();
}