{"id":13596073,"url":"https://github.com/ndbeals/winssh-pageant","last_synced_at":"2025-04-09T13:34:02.486Z","repository":{"id":39599529,"uuid":"281551487","full_name":"ndbeals/winssh-pageant","owner":"ndbeals","description":"Bridge to Windows OpenSSH agent from Pageant. This means the openssh agent has the keys and this proxies pageant requests to it.","archived":false,"fork":false,"pushed_at":"2024-09-03T21:31:55.000Z","size":156,"stargazers_count":270,"open_issues_count":8,"forks_count":11,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-11-06T18:46:26.578Z","etag":null,"topics":["openssh","pageant","ssh","ssh-agent","windows","windows-openssh-agent","winssh-pageant"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ndbeals.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-22T02:14:45.000Z","updated_at":"2024-11-04T05:50:19.000Z","dependencies_parsed_at":"2023-12-27T21:19:36.947Z","dependency_job_id":"c6a755d4-8336-44ed-b386-b40bb860314c","html_url":"https://github.com/ndbeals/winssh-pageant","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ndbeals%2Fwinssh-pageant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ndbeals%2Fwinssh-pageant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ndbeals%2Fwinssh-pageant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ndbeals%2Fwinssh-pageant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ndbeals","download_url":"https://codeload.github.com/ndbeals/winssh-pageant/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248049854,"owners_count":21039282,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openssh","pageant","ssh","ssh-agent","windows","windows-openssh-agent","winssh-pageant"],"created_at":"2024-08-01T16:02:07.378Z","updated_at":"2025-04-09T13:34:02.100Z","avatar_url":"https://github.com/ndbeals.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"\n# WinSSH-Pageant ![Go](https://github.com/ndbeals/winssh-pageant/workflows/Go/badge.svg)\n\nProxy Pageant requests to the Windows OpenSSH agent (from Microsoft), enabling applications that only support Pageant to use openssh.\n\n## Contents\n\n- [Installation](#installation)\n  - [Winget](#winget)\n  - [MSI Installer](#msi-installer)\n  - [Standalone Binary](#standalone-binary)\n- [Usage](#usage)\n  - [Autostart](#autostart)\n- [Frequently Asked Questions](#frequently-asked-questions)\n- [Building](#building)\n  - [Easy Build Instructions](#easy-build-instructions)\n  - [Advanced Build Instructions](#advanced-build-instructions)\n  - [Antivirus Flagging](#antivirus-flagging)\n- [Bug Reporting, Help \u0026 Feature Requests](#bug-reporting-help--feature-requests)\n- [Credits](#credits)\n\n## Background\n\nI use the Windows OpenSSH agent as my single ssh key backing. Many solutions exist that do the opposite of this, but I prefer the convenience of Windows OpenSSH agent.\n\nThis has been tested on Windows 10 2004 using WSL2. Earlier versions of windows up to 1803 should work too.\n\n# Installation\n\nWinSSH-Pageant now features an MSI installer for easy upgrading and install/uninstall actions. The installer will:\n\n 1. Create an appropriate, user-specific autostart entry which you can manager from Task Manager -\u003e Startup tab\n 2. Autostart the application after the installer is finished\n\n### Prerequisites\n\nInstall the [Microsoft OpenSSH package, found on their Github](https://github.com/PowerShell/Win32-OpenSSH/releases). Do not install this using Windows update, that one is quite outdated, and will not work with this software. [Follow the instructions for adding OpenSSH to your System PATH.](https://github.com/PowerShell/Win32-OpenSSH/wiki/Install-Win32-OpenSSH-Using-MSI)\n\n## Winget\n\nThis application is now available in the offcial [Microsoft Package Manager: `winget`](https://github.com/microsoft/winget-cli) and is the *preferred* way to install and upgrade this software.\n\n| Action | Command |\n| -----: |-------- |\n| Install | `winget install winssh-pageant` |\n| Upgrade | `winget upgrade winssh-pageant` |\n\n## MSI Installer\n\n[Download the latest version from the releases page](https://github.com/ndbeals/winssh-pageant/releases/latest) and install it.\n\n### Standalone Binary\n\nFor those who do not want an installer, there is also an option to download the compiled, standalone executable. [Download the latest .zip](https://github.com/ndbeals/winssh-pageant/releases/latest) and follow the [instructions for configuring autostart](#autostart)\n\n# Usage\n\nRun the executable `winssh-pageant.exe`. There are two (optional) flags:\n\n- `--sshpipe` - name of the windows openssh agent pipe, default is: `\\\\.\\pipe\\openssh-ssh-agent`\n- `--no-pageant-pipe` - disable pageant named pipe proxying\n\n## Autostart\n\nStart Menu Autostart:\n\n 1. Open Windows Explorer and navigate to:\n\n    ```\n    %appdata%\\Microsoft\\Windows\\Start Menu\\Programs\\Startup\n    ```\n\n 2. Inside this folder, Create a shortcut pointing at wherever you put `winssh-pageant.exe`\n 3. If the shortcut is valid, there should be a new `WinSSH-Pageant Bridge` entry found in Task Manager -\u003e Startup\n\nNote: Task Scheduler autostart method is now deprecated and unsupported. It causes possible issues with executable ownership.\n\n---\n\n# Frequently Asked Questions\n\n## How do I add my private keys to pageant?\nYou don't. Add your private keys to the standard ssh-agent with the following command:\n```\nssh-add \u003cyour key\u003e\n```\n[Detailed explanation.](https://github.com/ndbeals/winssh-pageant/issues/14)\n\n---\n\n## Building\n\nclone the repo:\n\n```\ngit clone https://github.com/ndbeals/winssh-pageant.git\ncd winssh-pageant\n```\n\n### Easy Build Instructions\n\n```\ngo build -ldflags=\"-w -s -H=windowsgui\" -trimpath\n```\n\n### Advanced Build Instructions\n\nThe build script `build.ps1` accepts numerous, optional flags and two dev dependencies. Install the dev dependencies:\n\n```\ngo install github.com/josephspurrier/goversioninfo@latest\ngo install github.com/mh-cbon/go-msi@latest\n```\n\nRun the build script:\n\n```\n.\\build.ps1 -Release\n```\n\nThe release flag is *optional*, though highly recommended, if it is omitted you do not need the two aforementioned dev dependencies.\n\n### Antivirus Flagging\n\nYour antivirus software may flag this as malware, It's a false positive and a known quirk with go binaries (\u003chttps://golang.org/doc/faq#virus\u003e). The official releases use reproducible builds via `-trimpath`. The expected checksums are posted with the release they're meant for, some users may choose to build this project themself and confirm the checksums, `sha256sum`.\n\nMore information can be found here: \u003chttps://github.com/ndbeals/winssh-pageant/issues/7#issuecomment-787520972\u003e\n\n## Bug Reporting, Help \u0026 Feature Requests\n\nPlease put report all\n\n- Feature Requests\n- Bugs\n- Help Requests\n- General Questsions\n\n[as an issue.](https://github.com/ndbeals/winssh-pageant/issues)\n\n## Credits\n\nBig thanks to \u003chttps://github.com/benpye/wsl-ssh-pageant\u003e, Ben Pye and the other contributors for the examples of interacting with the win32 api, the build script, and help they have given me directly.\n\n- \u003chttps://github.com/buptczq/WinCryptSSHAgent\u003e for a working example of how to open a file mapping another process created.\n- @meilon for reporting an internationalization bug and testing the fix for me.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fndbeals%2Fwinssh-pageant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fndbeals%2Fwinssh-pageant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fndbeals%2Fwinssh-pageant/lists"}