Windows compatibility

[Frederick888]

Tasks to tackle:

• Socket path

git-credential-keepassxc/src/utils.rs

Lines 29 to 40 in e77960b

	thread_local!(pub static SOCKET_PATH: OnceCell<PathBuf> = OnceCell::new());
	pub fn get_socket_path() -> Result<PathBuf> {
	SOCKET_PATH.with(|s| -> Result<_> {
	Ok(s.get_or_try_init(|| -> Result<_> {
	let xdg_dirs = xdg::BaseDirectories::new().unwrap();
	xdg_dirs
	.find_runtime_file(KEEPASS_SOCKET_NAME)
	.ok_or(anyhow!(SocketPathError {}))
	})?
	.clone())
	})
	}

XDG probably doesn't work under Win. KeePassXC uses named pipes under Win and the path is %TMP%\kpxc_server (e.g. C:\Users\Administrator\AppData\Local\Temp\kpxc_server). It listens on another one called keepassxc-Administrator.socket at the same time, not sure whether it's for browser integration as well or not.

• UnixStream -> Named pipe

git-credential-keepassxc/src/utils.rs

Lines 63 to 72 in e77960b

	fn get_stream() -> Result<Rc<RefCell<UnixStream>>> {
	thread_local!(static STREAM: OnceCell<Rc<RefCell<UnixStream>>> = OnceCell::new());
	Ok(STREAM.with(|s| -> Result<_> {
	Ok(s.get_or_try_init(|| -> Result<_> {
	let path = get_socket_path()?;
	Ok(Rc::new(RefCell::new(UnixStream::connect(path)?)))
	})?
	.clone())
	})?)
	}

Two most popular implementations are:
https://crates.io/crates/named_pipe
https://crates.io/crates/mio-named-pipes

We should probably use the first one as it doesn't seem to require a runtime. It's a synchronous CLI tool at the end of the day and we don't need asynchronous stuff.

git-credential-keepassxc/src/utils.rs

Lines 74 to 91 in e77960b

	pub fn exchange_message(request: String) -> Result<String> {
	debug!(crate::LOGGER.get().unwrap(), "SEND: {}", request);
	let mut stream = get_stream()?.borrow().try_clone()?;
	stream.write_all(request.as_bytes())?;
	stream.write_all(b"\n")?;
	let mut response = String::new();
	const BUF_SIZE: usize = 128;
	let mut buf = [0u8; BUF_SIZE];
	loop {
	let len = stream.read(&mut buf)?;
	response.push_str(str::from_utf8(&buf[0..len]).unwrap());
	if len < BUF_SIZE {
	break;
	}
	}
	debug!(crate::LOGGER.get().unwrap(), "RECV: {}", response);
	Ok(response)
	}

exchange_message() needs to be updated as well.

• Logger

git-credential-keepassxc/src/main.rs

Line 465 in e77960b

let decorator = slog_term::TermDecorator::new().build();

Does TermDecorator work in cmd/PowerShell? Do we need to switch to PlainSyncDecorator under Win?

[Frederick888]

Might be useful: https://crates.io/crates/directories-next

[Frederick888]

@riedel Could you please give 1-windows-support branch a shot?

I cross-compiled to x86_64-pc-windows-gnu using MinGW and I was able to use the program in Cygwin, e.g.

$ git-credential-keepassxc configure
$ git config --global credential.helper keepassxc
$ printf "url=https://example.com\nusername=foo\n" | git credential fill

In CMD/PowerShell the coloured output also looked ok but I don't know how to do I/O redirection in CMD/PowerShell so I didn't test credential retrieval.

And if everything on 1-windows-support looks alright (fingers crossed lol!), is it also possible for you to try targeting x86_64-pc-windows-msvc then test it again? Thanks.

[riedel]

Cool it works on 1-windows-support !!!! Thanks!

However, I had a problem with multiple accounts. I guess I can open a ticket.

I managed to to compile it via with msvc too.

[Frederick888]

@riedel Thanks for testing msvc.

However, I had a problem with multiple accounts. I guess I can open a ticket.

Because currently usernames are not used when retrieving credentials I guess. Anyway, please open another ticket for this and some debug (-vvv) logs would be appreciated.