Skip to content

Update README for proxy mode compatibility with OpenSSH and 1Password #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
masahide merged 1 commit into from
Apr 5, 2025
Merged

Update README for proxy mode compatibility with OpenSSH and 1Password #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,14 +104,16 @@ Variable name: SSH_AUTH_SOCK
Variable value: /mnt/c/Users/<UserName>/OmniSSHAgent.sock
```

## Using with OpenSSH ssh-agent NamedPipe (1Password, etc.) in Proxy Mode
## Using with OpenSSH ssh-agent NamedPipe (also compatible with 1Password) in Proxy Mode

This 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.
This mode uses the [OpenSSH ssh-agent NamedPipe](https://learn.microsoft.com/windows-server/administration/openssh/openssh_keymanagement) as a backend. It can also be used with [1Password’s ssh-agent function](https://developer.1password.com/docs/ssh/agent/), as shown in the diagram below.
![NamedPipe-Proxy-mode](https://github.com/masahide/OmniSSHAgent/blob/main/doc/NamedPipeProxyMode.png?raw=true)

By enabling "Proxy mode for 1Password key-agent" in the configuration, OmniSSHAgent functions as a proxy for 1Password or OpenSSH's NamedPipe SSH agent.
By enabling **"Proxy mode for OpenSSH agent (also compatible with 1Password)"** in the configuration, OmniSSHAgent functions as a proxy for Windows OpenSSH's NamedPipe SSH agent.
This mode also works with the 1Password key-agent.

**Note:** When "Proxy mode for OpenSSH agent (also compatible with 1Password)" is enabled, OmniSSHAgent operates solely as a proxy, and private keys cannot be added directly to it.

Note: When "Proxy mode for 1Password key-agent" is enabled, OmniSSHAgent operates solely as a proxy, meaning private keys cannot be added.

## Supported Key File Formats
- PuTTY private key file (.ppk)
Expand Down
6 changes: 3 additions & 3 deletions frontend/src/Settings.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,12 +202,12 @@
<Switch
bind:checked={data.ProxyModeOfNamedPipe}
on:SMUISwitch:change={proxyToggle}
value="Enable proxy mode for 1Password key-agent"
value="Enable proxy mode for OpenSSH agent (also compatible with 1Password)"
/>
<span
>{data.ProxyModeOfNamedPipe
? "Enable proxy mode for 1Password key-agent"
: "Disable proxy mode for 1Password key-agent"}</span
? "Enable proxy mode for OpenSSH agent (also compatible with 1Password)"
: "Disable proxy mode for OpenSSH agent (also compatible with 1Password)"}</span
>
</FormField>
</div>
Expand Down