Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
Fix SSH askpass on Windows by invoking `cli.exe` directly (#52491)
Zaenalos2b2536de0f9d
diff --git a/([email protected]) Password b/([email protected]) Passwordnew file mode 100644index 00000000000..e69de29bb2ddiff --git a/crates/askpass/src/askpass.rs b/crates/askpass/src/askpass.rsindex c550d95979f..e887841b584 100644--- a/crates/askpass/src/askpass.rs+++ b/crates/askpass/src/askpass.rs@@ -4,6 +4,7 @@ pub use encrypted_password::{EncryptedPassword, IKnowWhatIAmDoingAndIHaveReadTheuse net::async_net::UnixListener;use smol::lock::Mutex;+#[cfg(not(target_os = "windows"))]use util::fs::make_file_executable;use std::ffi::OsStr;@@ -19,13 +20,20 @@ use futures::{select_biased,};use gpui::{AsyncApp, BackgroundExecutor, Task};+#[cfg(not(target_os = "windows"))]use smol::fs;-use util::{ResultExt as _, debug_panic, maybe, paths::PathExt, shell::ShellKind};+use util::{ResultExt as _, debug_panic, maybe};++#[cfg(not(target_os = "windows"))]+use util::{paths::PathExt, shell::ShellKind};/// Path to the program used for askpass///-/// On Unix and remote servers, this defaults to the current executable-/// On Windows, this is set to the CLI variant of zed+/// On Unix and remote servers, this defaults to the current executable.+/// On Windows, this must be set to the CLI variant of zed via set_askpass_program(),+/// because SSH_ASKPASS must point to a directly executable binary. The CLI binary+/// handles the ZED_ASKPASS_SOCKET env var to communicate with Zed over a Unix socket+/// without needing a wrapper script.static ASKPASS_PROGRAM: OnceLock<std::path::PathBuf> = OnceLock::new();#[derive(PartialEq, Eq)]@@ -80,11 +88,8 @@ pub struct AskPassSession {executor: BackgroundExecutor,}-const ASKPASS_SCRIPT_NAME: &str = if cfg!(target_os = "windows") {- "askpass.ps1"-} else {- "askpass.sh"-};+#[cfg(not(target_os = "windows"))]+const ASKPASS_SCRIPT_NAME: &str = "askpass.sh";impl AskPassSession {/// This will create a new AskPassSession.@@ -177,17 +182,34 @@ impl AskPassSession {self.secret.lock().ok()?.clone()}+ /// Returns the value to set as SSH_ASKPASS.+ /// On Unix this is the path to the generated shell script.+ /// On Windows this is the path to cli.exe directly — no script needed.pub fn script_path(&self) -> impl AsRef<OsStr> {self.askpass_task.script_path()}++ /// Returns the socket path to set as ZED_ASKPASS_SOCKET.+ ///+ /// On Windows, SSH_ASKPASS points directly to cli.exe. SSH passes only+ /// the prompt string as argv[1] with no mechanism for extra arguments,+ /// so the socket path is communicated via this environment variable instead.+ /// cli.exe must check ZED_ASKPASS_SOCKET before clap parses args.+ #[cfg(target_os = "windows")]+ pub fn socket_path(&self) -> impl AsRef<OsStr> {+ self.askpass_task.socket_path()+ }}pub struct PasswordProxy {_task: Task<()>,- #[cfg(not(target_os = "windows"))]+ /// On Unix: path to the generated .sh askpass script (set as SSH_ASKPASS).+ /// On Windows: path to cli.exe (set as SSH_ASKPASS directly — no script needed).askpass_script_path: std::path::PathBuf,+ /// On Windows only: path to the Unix socket, passed as ZED_ASKPASS_SOCKET+ /// so cli.exe can find it without --askpass argument parsing.#[cfg(target_os = "windows")]- askpass_helper: String,+ askpass_socket_path: std::path::PathBuf,}impl PasswordProxy {@@ -202,19 +224,20 @@ impl PasswordProxy {) -> Result<Self> {let temp_dir = tempfile::Builder::new().prefix("zed-askpass").tempdir()?;let askpass_socket = temp_dir.path().join("askpass.sock");- let askpass_script_path = temp_dir.path().join(ASKPASS_SCRIPT_NAME);let current_exec =std::env::current_exe().context("Failed to determine current zed executable path.")?;- // TODO: inferred from the use of powershell.exe in askpass_helper_script- let shell_kind = if cfg!(windows) {- ShellKind::PowerShell- } else {- ShellKind::Posix- };let askpass_program = ASKPASS_PROGRAM.get_or_init(|| current_exec);- // Create an askpass script that communicates back to this process.- let askpass_script = generate_askpass_script(shell_kind, askpass_program, &askpass_socket)?;++ // Unix: SSH_ASKPASS = path to generated .sh script in temp dir.+ // Windows: SSH_ASKPASS = path to cli.exe directly. No script is written.+ #[cfg(not(target_os = "windows"))]+ let askpass_script_path = temp_dir.path().join(ASKPASS_SCRIPT_NAME);+ #[cfg(target_os = "windows")]+ let askpass_script_path = askpass_program.to_path_buf();++ let askpass_socket_path = askpass_socket.clone();+let _task = executor.spawn(async move {maybe!(async move {let listener =@@ -253,44 +276,60 @@ impl PasswordProxy {.log_err();});- fs::write(&askpass_script_path, askpass_script)- .await- .with_context(|| format!("creating askpass script at {askpass_script_path:?}"))?;- make_file_executable(&askpass_script_path)- .await- .with_context(|| {- format!("marking askpass script executable at {askpass_script_path:?}")- })?;- // todo(shell): There might be no powershell on the system- #[cfg(target_os = "windows")]- let askpass_helper = format!(- "powershell.exe -ExecutionPolicy Bypass -File \"{}\"",- askpass_script_path.display()- );+ // Unix only: write the shell script and mark it executable.+ // On Windows cli.exe is invoked directly, so no script is needed.+ #[cfg(not(target_os = "windows"))]+ {+ let askpass_script = generate_askpass_script(askpass_program, &askpass_socket_path)?;+ fs::write(&askpass_script_path, askpass_script)+ .await+ .with_context(|| format!("creating askpass script at {askpass_script_path:?}"))?;+ make_file_executable(&askpass_script_path)+ .await+ .with_context(|| {+ format!("marking askpass script executable at {askpass_script_path:?}")+ })?;+ }Ok(Self {_task,- #[cfg(not(target_os = "windows"))]askpass_script_path,#[cfg(target_os = "windows")]- askpass_helper,+ askpass_socket_path,})}pub fn script_path(&self) -> impl AsRef<OsStr> {- #[cfg(not(target_os = "windows"))]- {- &self.askpass_script_path- }- #[cfg(target_os = "windows")]- {- &self.askpass_helper- }+ &self.askpass_script_path+ }++ #[cfg(target_os = "windows")]+ pub fn socket_path(&self) -> impl AsRef<OsStr> {+ &self.askpass_socket_path}}-/// The main function for when Zed is running in netcat mode for use in askpass.-/// Called from both the remote server binary and the zed binary in their respective main functions.++/// Runs Zed in netcat mode for use in askpass.pub fn main(socket: &str) {+ use std::io::{self, Read};+ use std::process::exit;++ let mut buffer = Vec::new();+ if let Err(err) = io::stdin().read_to_end(&mut buffer) {+ eprintln!("Error reading from stdin: {}", err);+ exit(1);+ }++ connect_and_write_prompt(socket, buffer)+}++/// Runs Zed in askpass mode using prompts passed as arguments.+pub fn main_from_args(socket: &str, args: impl IntoIterator<Item = String>) {+ let prompt = args.into_iter().collect::<Vec<_>>().join("\0");+ connect_and_write_prompt(socket, prompt.into_bytes())+}++fn connect_and_write_prompt(socket: &str, mut buffer: Vec<u8>) {use net::UnixStream;use std::io::{self, Read, Write};use std::process::exit;@@ -303,12 +342,6 @@ pub fn main(socket: &str) {}};- let mut buffer = Vec::new();- if let Err(err) = io::stdin().read_to_end(&mut buffer) {- eprintln!("Error reading from stdin: {}", err);- exit(1);- }-#[cfg(target_os = "windows")]while buffer.last().is_some_and(|&b| b == b'\n' || b == b'\r') {buffer.pop();@@ -340,13 +373,14 @@ pub fn set_askpass_program(path: std::path::PathBuf) {}}-#[inline]+/// Generates the Unix shell askpass script.+/// Not used on Windows — cli.exe is invoked directly as SSH_ASKPASS.#[cfg(not(target_os = "windows"))]fn generate_askpass_script(- shell_kind: ShellKind,askpass_program: &std::path::Path,askpass_socket: &std::path::Path,) -> Result<String> {+ let shell_kind = ShellKind::Posix;let askpass_program = shell_kind.prepend_command_prefix(askpass_program.to_str()@@ -364,29 +398,3 @@ fn generate_askpass_script("{shebang}\n{print_args} | {askpass_program} --askpass={askpass_socket} 2> /dev/null \n",))}--#[inline]-#[cfg(target_os = "windows")]-fn generate_askpass_script(- shell_kind: ShellKind,- askpass_program: &std::path::Path,- askpass_socket: &std::path::Path,-) -> Result<String> {- let askpass_program = shell_kind.prepend_command_prefix(- askpass_program- .to_str()- .context("Askpass program is on a non-utf8 path")?,- );- let askpass_program = shell_kind- .try_quote_prefix_aware(&askpass_program)- .context("Failed to shell-escape Askpass program path")?;- let askpass_socket = askpass_socket- .try_shell_safe(shell_kind)- .context("Failed to shell-escape Askpass socket path")?;- Ok(format!(- r#"- $ErrorActionPreference = 'Stop';- ($args -join [char]0) | {askpass_program} --askpass={askpass_socket} 2> $null- "#,- ))-}diff --git a/crates/cli/src/main.rs b/crates/cli/src/main.rsindex 6f0c86f940b..d9c976b688c 100644--- a/crates/cli/src/main.rs+++ b/crates/cli/src/main.rs@@ -487,6 +487,14 @@ fn run() -> Result<()> {return mac_os::spawn_channel_cli(channel, std::env::args().skip(2).collect());}}++ // Must happen before clap — SSH invokes cli.exe directly as SSH_ASKPASS+ // and passes the socket path via env var to avoid argument parsing.+ if let Ok(socket) = std::env::var("ZED_ASKPASS_SOCKET") {+ askpass::main_from_args(&socket, std::env::args().skip(1));+ return Ok(());+ }+let args = Args::parse();// `zed --askpass` Makes zed operate in nc/netcat mode for use with askpassdiff --git a/crates/git/src/repository.rs b/crates/git/src/repository.rsindex 93f53e44972..c4849f9f0c5 100644--- a/crates/git/src/repository.rs+++ b/crates/git/src/repository.rs@@ -3590,6 +3590,8 @@ async fn run_git_command(.env("GIT_ASKPASS", ask_pass.script_path()).env("SSH_ASKPASS", ask_pass.script_path()).env("SSH_ASKPASS_REQUIRE", "force");+ #[cfg(target_os = "windows")]+ command.env("ZED_ASKPASS_SOCKET", ask_pass.socket_path());let git_process = command.spawn()?;run_askpass_command(ask_pass, git_process).awaitdiff --git a/crates/remote/src/transport/ssh.rs b/crates/remote/src/transport/ssh.rsindex ac549a6e7c5..2beae54f2f5 100644--- a/crates/remote/src/transport/ssh.rs+++ b/crates/remote/src/transport/ssh.rs@@ -204,6 +204,7 @@ impl MasterProcess {pub fn new(askpass_script_path: &std::ffi::OsStr,+ askpass_socket_path: &std::ffi::OsStr,additional_args: Vec<String>,destination: &str,) -> Result<Self> {@@ -226,6 +227,7 @@ impl MasterProcess {.stderr(Stdio::piped()).env("SSH_ASKPASS_REQUIRE", "force").env("SSH_ASKPASS", askpass_script_path)+ .env("ZED_ASKPASS_SOCKET", askpass_socket_path).args(additional_args).arg(destination).args(args);@@ -693,6 +695,7 @@ impl SshRemoteConnection {let mut master_process = MasterProcess::new(askpass.script_path().as_ref(),+ askpass.socket_path().as_ref(),connection_options.additional_args(),&destination,)?;@@ -1270,6 +1273,10 @@ impl SshSocket {"SSH_ASKPASS".into(),_proxy.script_path().as_ref().display().to_string(),);+ envs.insert(+ "ZED_ASKPASS_SOCKET".into(),+ _proxy.socket_path().as_ref().display().to_string(),+ );Ok(Self {connection_options: options,