Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benpye/wsl-ssh-pageant
A Pageant -> TCP bridge for use with WSL, allowing for Pageant to be used as an ssh-ageant within the WSL environment.
https://github.com/benpye/wsl-ssh-pageant
linux openssh pageant putty ssh windows windows-10 windows-11 windows-subsystem-linux wsl
Last synced: 27 days ago
JSON representation
A Pageant -> TCP bridge for use with WSL, allowing for Pageant to be used as an ssh-ageant within the WSL environment.
- Host: GitHub
- URL: https://github.com/benpye/wsl-ssh-pageant
- Owner: benpye
- License: bsd-2-clause
- Created: 2016-12-22T22:15:36.000Z (almost 8 years ago)
- Default Branch: golang
- Last Pushed: 2023-02-25T05:26:17.000Z (over 1 year ago)
- Last Synced: 2024-09-28T22:42:28.843Z (about 1 month ago)
- Topics: linux, openssh, pageant, putty, ssh, windows, windows-10, windows-11, windows-subsystem-linux, wsl
- Language: Go
- Homepage:
- Size: 121 KB
- Stars: 618
- Watchers: 22
- Forks: 40
- Open Issues: 16
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - benpye/wsl-ssh-pageant - A Pageant -> TCP bridge for use with WSL, allowing for Pageant to be used as an ssh-ageant within the WSL environment. (Go)
README
# wsl-ssh-pageant
[](https://benpye.visualstudio.com/benpye/_build/latest?definitionId=1&branchName=golang)
## Why
I use a Yubikey to store a GPG key pair and I like to use this key pair as my SSH key too. GPG on Windows exposes a Pageant style SSH agent and I wanted a way to use this key within WSL. I have rewritten this in Go as it means the release is a single simple binary, and I like Go.
## How to use with WSL
1. On the Windows side start Pageant (or compatible agent such as gpg4win).
2. Run `wsl-ssh-pageant.exe --wsl C:\wsl-ssh-pageant\ssh-agent.sock` (or any other path, max ~100 characters)
3. In WSL export the `SSH_AUTH_SOCK` environment variable to point at the socket, for example, if you have `ssh-agent.sock` in `C:\wsl-ssh-pageant`
```
$ export SSH_AUTH_SOCK=/mnt/c/wsl-ssh-pageant/ssh-agent.sock
```
4. The SSH keys from Pageant should now be usable by `ssh`
## How to use with Windows 10 native OpenSSH client
1. On the Windows side start Pageant (or compatible agent such as gpg4win).
2. Run `wsl-ssh-pageant.exe --winssh ssh-pageant` (or any other name)
3. In `cmd` export the `SSH_AUTH_SOCK` environment variable or define it in your Environment Variables on Windows. Use the name you gave the pipe, for example:
```
$ set SSH_AUTH_SOCK=\\.\pipe\ssh-pageant
```
4. The SSH keys from Pageant should now be usable by the native Windows SSH client, try using `ssh` in `cmd.exe`
## Systray Integration
To add an icon to the systray run `wsl-ssh-pageant.exe --systray --winssh ssh-pageant` (or using `--wsl`).
## Note
You can use both `--winssh` and `--wsl` parameters at the same time with the same process to proxy for both
# Frequently asked questions
## How do I download it?
Grab the latest release on the [releases page](https://github.com/benpye/wsl-ssh-pageant/releases).
## How do I build this?
For WSL support you will need Go 1.12 or later,. Go 1.12 added support for `AF_UNIX` sockets on Windows.
To create the assets.go run:
```
go generate
```
To create a build without a console window:
```
go build -ldflags -H=windowsgui
```
## What version of Windows do I need?
You need Windows 10 1803 or later for WSL support as it is the first version supporting `AF_UNIX` sockets. You can still use this with the native [Windows SSH client](https://github.com/PowerShell/Win32-OpenSSH/releases) on earlier builds.
## The -gui.exe binary doesn't have a GUI? (immediately closes)
The difference between the gui.exe binary and the regular binaries is the subsystem as set in the PE header. The gui.exe binary is set with the Win32 subsystem so that it doesn't spawn a command line, allowing it to be launched on startup. The regular binary has the console subsystem so it does launch a command line if double clicked, and will block the command line as expected. Note: You may launch either binary with the `-systray` flag to have a systray icon whilst the tool is running, this only provides a way to quit the application.
## You didn't answer my question!
Please open an issue, I do try and keep on top of them, promise.
# Credit
* Thanks to [John Starks](https://github.com/jstarks/) for [npiperelay](https://github.com/jstarks/npiperelay/) for an example of a more secure way to create a stream between WSL and Linux before `AF_UNIX` sockets were available.
* Thanks for [Mark Dietzer](https://github.com/Doridian) for several contributions to the old .NET implementation.