{"id":13562950,"url":"https://github.com/masahide/OmniSSHAgent","last_synced_at":"2025-04-03T19:31:57.068Z","repository":{"id":36990112,"uuid":"455754019","full_name":"masahide/OmniSSHAgent","owner":"masahide","description":"Integrated ssh-agent for windows. (pageant compatible. openSSH ssh-agent etc ..)","archived":false,"fork":false,"pushed_at":"2025-03-09T11:23:53.000Z","size":1928,"stargazers_count":138,"open_issues_count":12,"forks_count":10,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-02T03:15:53.789Z","etag":null,"topics":["1password","golang","pageant","putty","ssh","ssh-agent","ssh-key","wails","wsl","wsl2"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/masahide.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":"2022-02-05T02:19:11.000Z","updated_at":"2025-03-27T17:37:16.000Z","dependencies_parsed_at":"2024-01-07T13:27:27.443Z","dependency_job_id":"e0ca8ca0-f863-4762-bf82-28ec7c595de7","html_url":"https://github.com/masahide/OmniSSHAgent","commit_stats":null,"previous_names":["masahide/ssh-agent-win"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/masahide%2FOmniSSHAgent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/masahide%2FOmniSSHAgent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/masahide%2FOmniSSHAgent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/masahide%2FOmniSSHAgent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/masahide","download_url":"https://codeload.github.com/masahide/OmniSSHAgent/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247065316,"owners_count":20877757,"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":["1password","golang","pageant","putty","ssh","ssh-agent","ssh-key","wails","wsl","wsl2"],"created_at":"2024-08-01T13:01:13.729Z","updated_at":"2025-04-03T19:31:56.617Z","avatar_url":"https://github.com/masahide.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# OmniSSHAgent\n\n![OmniSSHAgent](https://github.com/masahide/OmniSSHAgent/blob/main/build/appicon.png?raw=true)\n\n## About\n\nUnifies the chaotic ssh-agent state under Windows.\n\n### The Chaotic State of SSH-Agent on Windows\nOn Windows, there are multiple communication methods for SSH agents, leading to complexity in usage and configuration. The following diagram illustrates the current SSH agent communication landscape on Windows.\n![windows-ssh-agent-chaosmap](https://github.com/masahide/OmniSSHAgent/blob/main/doc/windows-ssh-agent-chaosmap.png?raw=true)\n\n\n### OmniSSHAgent Connection Diagram\nOmniSSHAgent simplifies this chaotic situation, as shown in the diagram below.\n![OmniSSHAgentmap](https://github.com/masahide/OmniSSHAgent/blob/main/doc/OmniSSHAgent.png?raw=true)\n\n## System Requirements\n\n- Windows 11\n- [Microsoft Edge WebView2](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) \n\n## Supported Interfaces\n- Pageant.exe (PuTTY) shared memory\n- Unix domain socket for WSL2\n- NamedPipe on Windows\n- Unix domain socket for WSL1\n- Unix domain socket for MSYS2 (Cygwin) ([#1](https://github.com/masahide/OmniSSHAgent/issues/1))\n\n## Usage\n1. Download `OmniSSHAgent-amd64-installer.exe` from [the latest release](https://github.com/masahide/OmniSSHAgent/releases/latest), and run the installer.\n2. If you are using the native Windows SSH agent, you will need to stop and disable it. Open PowerShell with administrator privileges and run the following commands:\n```powershell\nStop-Service ssh-agent\nSet-Service -StartupType Disabled ssh-agent\n```\n  - Alternatively, you can do this through the GUI: open the Start menu, type \"Services,\" and select the Services app. \n  Once open, find the `OpenSSH Authentication Agent` service, set `Service Status` to `Stop`, and `Startup Type` to `Disabled`.\n\n3. If you are using [PuTTY Pageant](https://www.chiark.greenend.org.uk/~sgtatham/putty/index.html), stop it.\n\n4. Launch `OmniSSHAgent.exe` by double-clicking it.\n5. Press the `Open new file` button to add a private key file, or use the `ssh-add` command or [KeePassXC](https://keepassxc.org/) to add your private key.\n\n### Registering for Startup\n\nOmniSSHAgent does not have an installer to register itself for startup automatically. To add it manually:\n\n- Press the Windows logo key + R, type `shell:startup`, and click OK. This opens the Startup folder.\n- Copy and paste a shortcut to `OmniSSHAgent.exe` into the Startup folder.\n\n### Using with WSL2\n#### Setting up wsl2-ssh-agent-proxy in Ubuntu or Rocky (WSL2)\nChoose the instructions for your preferred shell below. If your shell is not listed, you can convert the Bash script syntax and submit a pull request to add it to the repository.\n\n##### Bash (and all POSIX-compliant shells)\n1. Download [ubuntu.wsl2-ssh-agent-proxy.sh](hack/ubuntu.wsl2-ssh-agent-proxy.sh) using the following command:\n```bash\nmkdir -p $HOME/wsl2-ssh-agent-proxy\ncurl -sL https://raw.githubusercontent.com/masahide/OmniSSHAgent/refs/heads/main/hack/ubuntu.wsl2-ssh-agent-proxy.sh -o $HOME/wsl2-ssh-agent-proxy/ubuntu.wsl2-ssh-agent-proxy.sh\n```\n2. Add the following line to `~/.bashrc`, `~/.zshrc`, or the appropriate file for your shell:\n```bash\nsource $HOME/wsl2-ssh-agent-proxy/ubuntu.wsl2-ssh-agent-proxy.sh\n```\n\n##### Fish\n1. Download [ubuntu.wsl2-ssh-agent-proxy.fish](hack/ubuntu.wsl2-ssh-agent-proxy.fish) using the following command:\n```fish\nmkdir -p $HOME/wsl2-ssh-agent-proxy\ncurl -sL https://raw.githubusercontent.com/masahide/OmniSSHAgent/refs/heads/main/hack/ubuntu.wsl2-ssh-agent-proxy.fish -o $HOME/wsl2-ssh-agent-proxy/ubuntu.wsl2-ssh-agent-proxy.fish\n```\n2. Add the following line to `~/.config/fish/config.fish`:\n```fish\n. $HOME/wsl2-ssh-agent-proxy/ubuntu.wsl2-ssh-agent-proxy.fish\n```\n\n### Using with WSL1\nSetting up a Unix domain socket in the Ubuntu environment:\n\n1. Check the setting for `Unix domain socket file path (WSL1)` in OmniSSHAgent.\nFor example, if the path is set as follows (`UserName` will vary based on your environment):\n`C:\\Users\\\u003cUserName\u003e\\OmniSSHAgent.sock`\nThe WSL1 path would be `/mnt/c/Users/\u003cUserName\u003e/OmniSSHAgent.sock`.\n\n2. Add the following line to `~/.bashrc`:\n```bash\nexport SSH_AUTH_SOCK=/mnt/c/Users/\u003cUserName\u003e/OmniSSHAgent.sock\n```\n\n### Using with Cygwin/MSYS2/Git for Windows (Git Bash)\n1. Check the setting for `Cygwin Unix domain socket file path (MSYS2)` in OmniSSHAgent.\n   * For example, if the path is (`UserName` will vary based on your environment):\n   * `C:\\Users\\\u003cUserName\u003e\\OmniSSHCygwin.sock`\n   * The Cygwin path would be `/mnt/c/Users/\u003cUserName\u003e/OmniSSHCygwin.sock`.\n\n2. To set the `SSH_AUTH_SOCK` variable:\n   * On the Windows taskbar, right-click the Windows icon and select System.\n   * In the Settings window, under Related Settings, click Advanced system settings.\n   * On the Advanced tab, click Environment Variables.\n   * In `User variables`, click `New` to create a new environment variable:\n```\nVariable name:  SSH_AUTH_SOCK\nVariable value: /mnt/c/Users/\u003cUserName\u003e/OmniSSHAgent.sock\n```\n\n## Using with OpenSSH ssh-agent NamedPipe (1Password, etc.) in Proxy Mode\n\nThis mode uses [OpenSSH ssh-agent NamedPipe](https://learn.microsoft.com/windows-server/administration/openssh/openssh_keymanagement) or [1Password's ssh-agent function](https://developer.1password.com/docs/ssh/agent/) as a backend, as shown in the diagram below.\n![NamedPipe-Proxy-mode](https://github.com/masahide/OmniSSHAgent/blob/main/doc/NamedPipeProxyMode.png?raw=true)\n\nBy enabling \"Proxy mode for 1Password key-agent\" in the configuration, OmniSSHAgent functions as a proxy for 1Password or OpenSSH's NamedPipe SSH agent.\n\nNote: When \"Proxy mode for 1Password key-agent\" is enabled, OmniSSHAgent operates solely as a proxy, meaning private keys cannot be added.\n\n## Supported Key File Formats\n- PuTTY private key file (.ppk)\n- OpenSSH format\n\n## Supported Key Types\n- RSA\n- ECDSA \n- ED25519 \n\n(DSA, ECDSA-SK, ED25519-SK are not supported)\n\n## FAQ\n\n### Where is the passphrase for the private key stored?\n\nPassphrases are stored in the [Windows Credential Manager](https://support.microsoft.com/en-us/windows/accessing-credential-manager-1b5c916a-6a16-889f-8581-fc16e8165ac0).\n\n## Screenshots\n\n\u003cimg src=\"https://github.com/masahide/OmniSSHAgent/blob/main/doc/screen.png?raw=true\" width=\"500\"\u003e\n\u003cimg src=\"https://github.com/masahide/OmniSSHAgent/blob/main/doc/screen-setup.png?raw=true\" width=\"500\"\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmasahide%2FOmniSSHAgent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmasahide%2FOmniSSHAgent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmasahide%2FOmniSSHAgent/lists"}