summaryrefslogtreecommitdiffstats
path: root/doc/gpg-agent.texi
diff options
context:
space:
mode:
authorWerner Koch <wk@gnupg.org>2024-01-15 17:21:24 +0100
committerWerner Koch <wk@gnupg.org>2024-01-15 17:21:24 +0100
commitdaedb3c96549427ed84fba5c9ab3f9475a412243 (patch)
tree32aa1b804322f7561cf334b125542e42e155f162 /doc/gpg-agent.texi
parentpo: Update parts of the Polish translation (diff)
downloadgnupg2-daedb3c96549427ed84fba5c9ab3f9475a412243.tar.xz
gnupg2-daedb3c96549427ed84fba5c9ab3f9475a412243.zip
doc: Describe the ssh-agent protocol options for Windows.
-- Also fix a typo in a macro.
Diffstat (limited to 'doc/gpg-agent.texi')
-rw-r--r--doc/gpg-agent.texi21
1 files changed, 16 insertions, 5 deletions
diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi
index 902de56f4..49cf16e39 100644
--- a/doc/gpg-agent.texi
+++ b/doc/gpg-agent.texi
@@ -623,19 +623,30 @@ are touched.
@anchor{option --enable-ssh-support}
@item --enable-ssh-support
+@itemx --enable-win32-openssh-support
@itemx --enable-putty-support
@opindex enable-ssh-support
+@opindex enable-win32-openssh-support
@opindex enable-putty-support
-The OpenSSH Agent protocol is always enabled, but @command{gpg-agent}
-will only set the @code{SSH_AUTH_SOCK} variable if this flag is given.
+On Unix platforms the OpenSSH Agent protocol is always enabled, but
+@command{gpg-agent} will only set the @code{SSH_AUTH_SOCK} variable if
+the option @option{enable-ssh-support} is given. Some Linux
+distributions use the presence of this option to decide whether the
+old ssh-agent shall be started.
+
+On Windows support for the native ssh implementation must be enabled
+using the the option @option{enable-win32-openssh-support}. For using
+gpg-agent as a replacement for PuTTY's Pageant, the option
+@option{enable-putty-support} must be enabled.
In this mode of operation, the agent does not only implement the
gpg-agent protocol, but also the agent protocol used by OpenSSH
-(through a separate socket). Consequently, it should be possible to use
-the gpg-agent as a drop-in replacement for the well known ssh-agent.
+(through a separate socket or via Named Pipes) or the protocol used by
+PuTTY. Consequently, this allows to use the gpg-agent as a drop-in
+replacement for the ssh-agent.
-SSH Keys, which are to be used through the agent, need to be added to
+SSH keys, which are to be used through the agent, need to be added to
the gpg-agent initially through the ssh-add utility. When a key is
added, ssh-add will ask for the password of the provided key file and
send the unprotected key material to the agent; this causes the