feat(provider): add support for ssh-agent on Windows

[Sparta142]

Contributor's Note

• I have added / updated documentation in /docs for any user-facing features or additions.
• I have added / updated acceptance tests in /fwprovider/tests for any new or updated resources / data sources.
• I have ran make example to verify that the change works as expected.

Proof of Work

Community Note

• Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Closes #1257

[Sparta142]

One concern I had: ssh-agent on Windows doesn't set the SSH_AUTH_SOCK env, which might be surprising behavior to some users.

A couple of possible solutions: either add a fallback to \\.\pipe\openssh-ssh-agent on Windows like other SSH binaries do, or make a note of this in the docs. Any opinion?

[Sparta142]

@bpg For consistency, I think assuming the socket path (if the user doesn't provide one) is the right behavior. I made a note of this in the documentation.

[bpg]

Hi @Sparta142, thanks a lot for contributing this!

I've made a few comments, could you please take a look?

Other than that, it is good to go! 🙂

[bpg]

I think it would be better to move this block to windows-specific proxmox/ssh/client_windows.go, inside the dialSocket func

[Sparta142]

dialSocket will never get an empty address because of this:

terraform-provider-proxmox/proxmox/ssh/client.go

Lines 534 to 537 in 6ae9b58

	if c.agentSocket == "" {
	return nil, errors.New("failed connecting to SSH agent socket: the socket file is not defined, " +
	"authentication will fall back to password")
	}

What if I change this so that it fills in the default socket address on Windows, and returns the error otherwise?

[bpg]

Ah, good point, missed that. This check can be moved into platform-specific dialSocket as well. So if address is missing we'll supply the default value on Windows or throw an error on other platforms.

[Sparta142]

Made the change, let me know what you think

[bpg]

LGTM! 🚀

[bpg]

@all-contributors please add @Sparta142 for code

[allcontributors]

@bpg

I've put up a pull request to add @Sparta142! 🎉