1mod encrypted_password;
2
3pub use encrypted_password::{EncryptedPassword, IKnowWhatIAmDoingAndIHaveReadTheDocs};
4
5use net::async_net::UnixListener;
6use smol::lock::Mutex;
7use util::fs::make_file_executable;
8
9use std::ffi::OsStr;
10use std::ops::ControlFlow;
11use std::sync::Arc;
12use std::sync::OnceLock;
13use std::time::Duration;
14
15use anyhow::{Context as _, Result};
16use futures::channel::{mpsc, oneshot};
17use futures::{
18 AsyncBufReadExt as _, AsyncWriteExt as _, FutureExt as _, SinkExt, StreamExt, io::BufReader,
19 select_biased,
20};
21use gpui::{AsyncApp, BackgroundExecutor, Task};
22use smol::fs;
23use util::{ResultExt as _, debug_panic, maybe, paths::PathExt, shell::ShellKind};
24
25/// Path to the program used for askpass
26///
27/// On Unix and remote servers, this defaults to the current executable
28/// On Windows, this is set to the CLI variant of zed
29static ASKPASS_PROGRAM: OnceLock<std::path::PathBuf> = OnceLock::new();
30
31#[derive(PartialEq, Eq)]
32pub enum AskPassResult {
33 CancelledByUser,
34 Timedout,
35}
36
37pub struct AskPassDelegate {
38 tx: mpsc::UnboundedSender<(String, oneshot::Sender<EncryptedPassword>)>,
39 executor: BackgroundExecutor,
40 _task: Task<()>,
41}
42
43impl AskPassDelegate {
44 pub fn new(
45 cx: &mut AsyncApp,
46 password_prompt: impl Fn(String, oneshot::Sender<EncryptedPassword>, &mut AsyncApp)
47 + Send
48 + Sync
49 + 'static,
50 ) -> Self {
51 let (tx, mut rx) = mpsc::unbounded::<(String, oneshot::Sender<_>)>();
52 let task = cx.spawn(async move |cx: &mut AsyncApp| {
53 while let Some((prompt, channel)) = rx.next().await {
54 password_prompt(prompt, channel, cx);
55 }
56 });
57 Self {
58 tx,
59 _task: task,
60 executor: cx.background_executor().clone(),
61 }
62 }
63
64 pub fn ask_password(&mut self, prompt: String) -> Task<Option<EncryptedPassword>> {
65 let mut this_tx = self.tx.clone();
66 self.executor.spawn(async move {
67 let (tx, rx) = oneshot::channel();
68 this_tx.send((prompt, tx)).await.ok()?;
69 rx.await.ok()
70 })
71 }
72}
73
74pub struct AskPassSession {
75 #[cfg(target_os = "windows")]
76 secret: std::sync::Arc<OnceLock<EncryptedPassword>>,
77 askpass_task: PasswordProxy,
78 askpass_opened_rx: Option<oneshot::Receiver<()>>,
79 askpass_kill_master_rx: Option<oneshot::Receiver<()>>,
80}
81
82#[cfg(not(target_os = "windows"))]
83const ASKPASS_SCRIPT_NAME: &str = "askpass.sh";
84#[cfg(target_os = "windows")]
85const ASKPASS_SCRIPT_NAME: &str = "askpass.ps1";
86
87impl AskPassSession {
88 /// This will create a new AskPassSession.
89 /// You must retain this session until the master process exits.
90 #[must_use]
91 pub async fn new(executor: &BackgroundExecutor, mut delegate: AskPassDelegate) -> Result<Self> {
92 #[cfg(target_os = "windows")]
93 let secret = std::sync::Arc::new(OnceLock::new());
94 let (askpass_opened_tx, askpass_opened_rx) = oneshot::channel::<()>();
95
96 let askpass_opened_tx = Arc::new(Mutex::new(Some(askpass_opened_tx)));
97
98 let (askpass_kill_master_tx, askpass_kill_master_rx) = oneshot::channel::<()>();
99 let kill_tx = Arc::new(Mutex::new(Some(askpass_kill_master_tx)));
100
101 #[cfg(target_os = "windows")]
102 let askpass_secret = secret.clone();
103 let get_password = {
104 let executor = executor.clone();
105
106 move |prompt| {
107 let prompt = delegate.ask_password(prompt);
108 let kill_tx = kill_tx.clone();
109 let askpass_opened_tx = askpass_opened_tx.clone();
110 #[cfg(target_os = "windows")]
111 let askpass_secret = askpass_secret.clone();
112 executor.spawn(async move {
113 if let Some(askpass_opened_tx) = askpass_opened_tx.lock().await.take() {
114 askpass_opened_tx.send(()).ok();
115 }
116 if let Some(password) = prompt.await {
117 #[cfg(target_os = "windows")]
118 {
119 _ = askpass_secret.set(password.clone());
120 }
121 ControlFlow::Continue(Ok(password))
122 } else {
123 if let Some(kill_tx) = kill_tx.lock().await.take() {
124 kill_tx.send(()).log_err();
125 }
126 ControlFlow::Break(())
127 }
128 })
129 }
130 };
131 let askpass_task = PasswordProxy::new(get_password, executor.clone()).await?;
132
133 Ok(Self {
134 #[cfg(target_os = "windows")]
135 secret,
136
137 askpass_task,
138 askpass_kill_master_rx: Some(askpass_kill_master_rx),
139 askpass_opened_rx: Some(askpass_opened_rx),
140 })
141 }
142
143 // This will run the askpass task forever, resolving as many authentication requests as needed.
144 // The caller is responsible for examining the result of their own commands and cancelling this
145 // future when this is no longer needed. Note that this can only be called once, but due to the
146 // drop order this takes an &mut, so you can `drop()` it after you're done with the master process.
147 pub async fn run(&mut self) -> AskPassResult {
148 // This is the default timeout setting used by VSCode.
149 let connection_timeout = Duration::from_secs(17);
150 let askpass_opened_rx = self.askpass_opened_rx.take().expect("Only call run once");
151 let askpass_kill_master_rx = self
152 .askpass_kill_master_rx
153 .take()
154 .expect("Only call run once");
155
156 select_biased! {
157 _ = askpass_opened_rx.fuse() => {
158 // Note: this await can only resolve after we are dropped.
159 askpass_kill_master_rx.await.ok();
160 AskPassResult::CancelledByUser
161 }
162
163 _ = futures::FutureExt::fuse(smol::Timer::after(connection_timeout)) => {
164 AskPassResult::Timedout
165 }
166 }
167 }
168
169 /// This will return the password that was last set by the askpass script.
170 #[cfg(target_os = "windows")]
171 pub fn get_password(&self) -> Option<EncryptedPassword> {
172 self.secret.get().cloned()
173 }
174
175 pub fn script_path(&self) -> impl AsRef<OsStr> {
176 self.askpass_task.script_path()
177 }
178}
179
180pub struct PasswordProxy {
181 _task: Task<()>,
182 #[cfg(not(target_os = "windows"))]
183 askpass_script_path: std::path::PathBuf,
184 #[cfg(target_os = "windows")]
185 askpass_helper: String,
186}
187
188impl PasswordProxy {
189 pub async fn new(
190 mut get_password: impl FnMut(String) -> Task<ControlFlow<(), Result<EncryptedPassword>>>
191 + 'static
192 + Send
193 + Sync,
194 executor: BackgroundExecutor,
195 ) -> Result<Self> {
196 let temp_dir = tempfile::Builder::new().prefix("zed-askpass").tempdir()?;
197 let askpass_socket = temp_dir.path().join("askpass.sock");
198 let askpass_script_path = temp_dir.path().join(ASKPASS_SCRIPT_NAME);
199 let current_exec =
200 std::env::current_exe().context("Failed to determine current zed executable path.")?;
201
202 // TODO: inferred from the use of powershell.exe in askpass_helper_script
203 let shell_kind = if cfg!(windows) {
204 ShellKind::PowerShell
205 } else {
206 ShellKind::Posix
207 };
208 let askpass_program = ASKPASS_PROGRAM
209 .get_or_init(|| current_exec)
210 .try_shell_safe(shell_kind)
211 .context("Failed to shell-escape Askpass program path.")?
212 .to_string();
213 // Create an askpass script that communicates back to this process.
214 let askpass_script = generate_askpass_script(&askpass_program, &askpass_socket);
215 let _task = executor.spawn(async move {
216 maybe!(async move {
217 let listener =
218 UnixListener::bind(&askpass_socket).context("creating askpass socket")?;
219
220 while let Ok((mut stream, _)) = listener.accept().await {
221 let mut buffer = Vec::new();
222 let mut reader = BufReader::new(&mut stream);
223 if reader.read_until(b'\0', &mut buffer).await.is_err() {
224 buffer.clear();
225 }
226 let prompt = String::from_utf8_lossy(&buffer).into_owned();
227 let password = get_password(prompt).await;
228 match password {
229 ControlFlow::Continue(password) => {
230 if let Ok(password) = password
231 && let Ok(decrypted) =
232 password.decrypt(IKnowWhatIAmDoingAndIHaveReadTheDocs)
233 {
234 stream.write_all(decrypted.as_bytes()).await.log_err();
235 }
236 }
237 ControlFlow::Break(()) => {
238 // note: we expect the caller to drop this task when it's done.
239 // We need to keep the stream open until the caller is done to avoid
240 // spurious errors from ssh.
241 std::future::pending::<()>().await;
242 drop(stream);
243 }
244 }
245 }
246 drop(temp_dir);
247 Result::<_, anyhow::Error>::Ok(())
248 })
249 .await
250 .log_err();
251 });
252
253 fs::write(&askpass_script_path, askpass_script)
254 .await
255 .with_context(|| format!("creating askpass script at {askpass_script_path:?}"))?;
256 make_file_executable(&askpass_script_path).await?;
257 #[cfg(target_os = "windows")]
258 let askpass_helper = format!(
259 "powershell.exe -ExecutionPolicy Bypass -File {}",
260 askpass_script_path.display()
261 );
262
263 Ok(Self {
264 _task,
265 #[cfg(not(target_os = "windows"))]
266 askpass_script_path,
267 #[cfg(target_os = "windows")]
268 askpass_helper,
269 })
270 }
271
272 pub fn script_path(&self) -> impl AsRef<OsStr> {
273 #[cfg(not(target_os = "windows"))]
274 {
275 &self.askpass_script_path
276 }
277 #[cfg(target_os = "windows")]
278 {
279 &self.askpass_helper
280 }
281 }
282}
283/// The main function for when Zed is running in netcat mode for use in askpass.
284/// Called from both the remote server binary and the zed binary in their respective main functions.
285pub fn main(socket: &str) {
286 use net::UnixStream;
287 use std::io::{self, Read, Write};
288 use std::process::exit;
289
290 let mut stream = match UnixStream::connect(socket) {
291 Ok(stream) => stream,
292 Err(err) => {
293 eprintln!("Error connecting to socket {}: {}", socket, err);
294 exit(1);
295 }
296 };
297
298 let mut buffer = Vec::new();
299 if let Err(err) = io::stdin().read_to_end(&mut buffer) {
300 eprintln!("Error reading from stdin: {}", err);
301 exit(1);
302 }
303
304 #[cfg(target_os = "windows")]
305 while buffer.last().is_some_and(|&b| b == b'\n' || b == b'\r') {
306 buffer.pop();
307 }
308 if buffer.last() != Some(&b'\0') {
309 buffer.push(b'\0');
310 }
311
312 if let Err(err) = stream.write_all(&buffer) {
313 eprintln!("Error writing to socket: {}", err);
314 exit(1);
315 }
316
317 let mut response = Vec::new();
318 if let Err(err) = stream.read_to_end(&mut response) {
319 eprintln!("Error reading from socket: {}", err);
320 exit(1);
321 }
322
323 if let Err(err) = io::stdout().write_all(&response) {
324 eprintln!("Error writing to stdout: {}", err);
325 exit(1);
326 }
327}
328
329pub fn set_askpass_program(path: std::path::PathBuf) {
330 if ASKPASS_PROGRAM.set(path).is_err() {
331 debug_panic!("askpass program has already been set");
332 }
333}
334
335#[inline]
336#[cfg(not(target_os = "windows"))]
337fn generate_askpass_script(askpass_program: &str, askpass_socket: &std::path::Path) -> String {
338 format!(
339 "{shebang}\n{print_args} | {askpass_program} --askpass={askpass_socket} 2> /dev/null \n",
340 askpass_socket = askpass_socket.display(),
341 print_args = "printf '%s\\0' \"$@\"",
342 shebang = "#!/bin/sh",
343 )
344}
345
346#[inline]
347#[cfg(target_os = "windows")]
348fn generate_askpass_script(askpass_program: &str, askpass_socket: &std::path::Path) -> String {
349 format!(
350 r#"
351 $ErrorActionPreference = 'Stop';
352 ($args -join [char]0) | & {askpass_program} --askpass={askpass_socket} 2> $null
353 "#,
354 askpass_socket = askpass_socket.display(),
355 )
356}