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

Honor disallow_shell in SSH client feature check #1814

Merged
merged 4 commits into from
Jan 27, 2025
Merged
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
78 changes: 49 additions & 29 deletions gix-transport/src/client/blocking_io/ssh/mod.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
use std::process::Stdio;
use std::{
ffi::OsStr,
process::{Command, Stdio},
};

use gix_url::ArgumentSafety::*;
use gix_url::{ArgumentSafety::*, Url};

use crate::{client::blocking_io, Protocol};
use crate::{client::blocking_io::file::SpawnProcessOnDemand, Protocol};

/// The error used in [`connect()`].
#[derive(Debug, thiserror::Error)]
Expand Down Expand Up @@ -100,40 +103,18 @@ pub mod connect {
/// If `trace` is `true`, all packetlines received or sent will be passed to the facilities of the `gix-trace` crate.
#[allow(clippy::result_large_err)]
pub fn connect(
url: gix_url::Url,
url: Url,
desired_version: Protocol,
options: connect::Options,
trace: bool,
) -> Result<blocking_io::file::SpawnProcessOnDemand, Error> {
) -> Result<SpawnProcessOnDemand, Error> {
if url.scheme != gix_url::Scheme::Ssh || url.host().is_none() {
return Err(Error::UnsupportedScheme(url));
}
let ssh_cmd = options.ssh_command();
let mut kind = options.kind.unwrap_or_else(|| ProgramKind::from(ssh_cmd));
if options.kind.is_none() && kind == ProgramKind::Simple {
let mut cmd = std::process::Command::from(
gix_command::prepare(ssh_cmd)
.stderr(Stdio::null())
.stdout(Stdio::null())
.stdin(Stdio::null())
.command_may_be_shell_script()
.arg("-G")
.arg(match url.host_as_argument() {
Usable(host) => host,
Dangerous(host) => Err(Error::AmbiguousHostName { host: host.into() })?,
Absent => panic!("BUG: host should always be present in SSH URLs"),
}),
);
gix_features::trace::debug!(cmd = ?cmd, "invoking `ssh` for feature check");
kind = if cmd.status().ok().is_some_and(|status| status.success()) {
ProgramKind::Ssh
} else {
ProgramKind::Simple
};
}

let kind = determine_client_kind(options.kind, ssh_cmd, &url, options.disallow_shell)?;
let path = gix_url::expand_path::for_shell(url.path.clone());
Ok(blocking_io::file::SpawnProcessOnDemand::new_ssh(
Ok(SpawnProcessOnDemand::new_ssh(
url,
ssh_cmd,
path,
Expand All @@ -144,5 +125,44 @@ pub fn connect(
))
}

#[allow(clippy::result_large_err)]
fn determine_client_kind(
known_kind: Option<ProgramKind>,
ssh_cmd: &OsStr,
url: &Url,
disallow_shell: bool,
) -> Result<ProgramKind, Error> {
let mut kind = known_kind.unwrap_or_else(|| ProgramKind::from(ssh_cmd));
if known_kind.is_none() && kind == ProgramKind::Simple {
let mut cmd = build_client_feature_check_command(ssh_cmd, url, disallow_shell)?;
gix_features::trace::debug!(cmd = ?cmd, "invoking `ssh` for feature check");
kind = if cmd.status().ok().is_some_and(|status| status.success()) {
ProgramKind::Ssh
} else {
ProgramKind::Simple
};
}
Ok(kind)
}

#[allow(clippy::result_large_err)]
fn build_client_feature_check_command(ssh_cmd: &OsStr, url: &Url, disallow_shell: bool) -> Result<Command, Error> {
let mut prepare = gix_command::prepare(ssh_cmd)
.stderr(Stdio::null())
.stdout(Stdio::null())
.stdin(Stdio::null())
.command_may_be_shell_script()
.arg("-G")
.arg(match url.host_as_argument() {
Usable(host) => host,
Dangerous(host) => Err(Error::AmbiguousHostName { host: host.into() })?,
Absent => panic!("BUG: host should always be present in SSH URLs"),
});
if disallow_shell {
prepare.use_shell = false;
}
Ok(prepare.into())
}

#[cfg(test)]
mod tests;
Loading