crypto/openssh/ssh-agent.1

   1 .\" $OpenBSD: ssh-agent.1,v 1.79 2023/08/10 14:37:32 naddy Exp $
   2 .\"
   3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   5 .\"                    All rights reserved
   6 .\"
   7 .\" As far as I am concerned, the code I have written for this software
   8 .\" can be used freely for any purpose.  Any derived versions of this
   9 .\" software must be clearly marked as such, and if the derived work is
  10 .\" incompatible with the protocol description in the RFC file, it must be
  11 .\" called by a name other than "ssh" or "Secure Shell".
  12 .\"
  13 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
  14 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
  15 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
  16 .\"
  17 .\" Redistribution and use in source and binary forms, with or without
  18 .\" modification, are permitted provided that the following conditions
  19 .\" are met:
  20 .\" 1. Redistributions of source code must retain the above copyright
  21 .\"    notice, this list of conditions and the following disclaimer.
  22 .\" 2. Redistributions in binary form must reproduce the above copyright
  23 .\"    notice, this list of conditions and the following disclaimer in the
  24 .\"    documentation and/or other materials provided with the distribution.
  25 .\"
  26 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  27 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  28 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  30 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  35 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .Dd $Mdocdate: August 10 2023 $
  38 .Dt SSH-AGENT 1
  39 .Os
  40 .Sh NAME
  41 .Nm ssh-agent
  42 .Nd OpenSSH authentication agent
  43 .Sh SYNOPSIS
  44 .Nm ssh-agent
  45 .Op Fl c | s
  46 .Op Fl \&Ddx
  47 .Op Fl a Ar bind_address
  48 .Op Fl E Ar fingerprint_hash
  49 .Op Fl O Ar option
  50 .Op Fl P Ar allowed_providers
  51 .Op Fl t Ar life
  52 .Nm ssh-agent
  53 .Op Fl a Ar bind_address
  54 .Op Fl E Ar fingerprint_hash
  55 .Op Fl O Ar option
  56 .Op Fl P Ar allowed_providers
  57 .Op Fl t Ar life
  58 .Ar command Op Ar arg ...
  59 .Nm ssh-agent
  60 .Op Fl c | s
  61 .Fl k
  62 .Sh DESCRIPTION
  63 .Nm
  64 is a program to hold private keys used for public key authentication.
  65 Through use of environment variables the agent can be located
  66 and automatically used for authentication when logging in to other
  67 machines using
  68 .Xr ssh 1 .
  69 .Pp
  70 The options are as follows:
  71 .Bl -tag -width Ds
  72 .It Fl a Ar bind_address
  73 Bind the agent to the
  74 .Ux Ns -domain
  75 socket
  76 .Ar bind_address .
  77 The default is
  78 .Pa $TMPDIR/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt .
  79 .It Fl c
  80 Generate C-shell commands on
  81 .Dv stdout .
  82 This is the default if
  83 .Ev SHELL
  84 looks like it's a csh style of shell.
  85 .It Fl D
  86 Foreground mode.
  87 When this option is specified,
  88 .Nm
  89 will not fork.
  90 .It Fl d
  91 Debug mode.
  92 When this option is specified,
  93 .Nm
  94 will not fork and will write debug information to standard error.
  95 .It Fl E Ar fingerprint_hash
  96 Specifies the hash algorithm used when displaying key fingerprints.
  97 Valid options are:
  98 .Dq md5
  99 and
 100 .Dq sha256 .
 101 The default is
 102 .Dq sha256 .
 103 .It Fl k
 104 Kill the current agent (given by the
 105 .Ev SSH_AGENT_PID
 106 environment variable).
 107 .It Fl O Ar option
 108 Specify an option when starting
 109 .Nm .
 110 Currently two options are supported:
 111 .Cm allow-remote-pkcs11
 112 and
 113 .Cm no-restrict-websafe .
 114 .Pp
 115 The
 116 .Cm allow-remote-pkcs11
 117 option allows clients of a forwarded
 118 .Nm
 119 to load PKCS#11 or FIDO provider libraries.
 120 By default only local clients may perform this operation.
 121 Note that signalling that an
 122 .Nm
 123 client is remote is performed by
 124 .Xr ssh 1 ,
 125 and use of other tools to forward access to the agent socket may circumvent
 126 this restriction.
 127 .Pp
 128 The
 129 .Cm no-restrict-websafe
 130 option instructs
 131 .Nm
 132 to permit signatures using FIDO keys that might be web authentication
 133 requests.
 134 By default,
 135 .Nm
 136 refuses signature requests for FIDO keys where the key application string
 137 does not start with
 138 .Dq ssh:
 139 and when the data to be signed does not appear to be a
 140 .Xr ssh 1
 141 user authentication request or a
 142 .Xr ssh-keygen 1
 143 signature.
 144 The default behaviour prevents forwarded access to a FIDO key from also
 145 implicitly forwarding the ability to authenticate to websites.
 146 .It Fl P Ar allowed_providers
 147 Specify a pattern-list of acceptable paths for PKCS#11 provider and FIDO
 148 authenticator middleware shared libraries that may be used with the
 149 .Fl S
 150 or
 151 .Fl s
 152 options to
 153 .Xr ssh-add 1 .
 154 Libraries that do not match the pattern list will be refused.
 155 See PATTERNS in
 156 .Xr ssh_config 5
 157 for a description of pattern-list syntax.
 158 The default list is
 159 .Dq usr/lib*/*,/usr/local/lib*/* .
 160 .It Fl s
 161 Generate Bourne shell commands on
 162 .Dv stdout .
 163 This is the default if
 164 .Ev SHELL
 165 does not look like it's a csh style of shell.
 166 .It Fl t Ar life
 167 Set a default value for the maximum lifetime of identities added to the agent.
 168 The lifetime may be specified in seconds or in a time format specified in
 169 .Xr sshd_config 5 .
 170 A lifetime specified for an identity with
 171 .Xr ssh-add 1
 172 overrides this value.
 173 Without this option the default maximum lifetime is forever.
 174 .It Fl x
 175 Exit after the last client has disconnected.
 176 .It Ar command Op Ar arg ...
 177 If a command (and optional arguments) is given,
 178 this is executed as a subprocess of the agent.
 179 The agent exits automatically when the command given on the command
 180 line terminates.
 181 .El
 182 .Pp
 183 There are two main ways to get an agent set up.
 184 The first is at the start of an X session,
 185 where all other windows or programs are started as children of the
 186 .Nm
 187 program.
 188 The agent starts a command under which its environment
 189 variables are exported, for example
 190 .Cm ssh-agent xterm & .
 191 When the command terminates, so does the agent.
 192 .Pp
 193 The second method is used for a login session.
 194 When
 195 .Nm
 196 is started,
 197 it prints the shell commands required to set its environment variables,
 198 which in turn can be evaluated in the calling shell, for example
 199 .Cm eval `ssh-agent -s` .
 200 .Pp
 201 In both cases,
 202 .Xr ssh 1
 203 looks at these environment variables
 204 and uses them to establish a connection to the agent.
 205 .Pp
 206 The agent initially does not have any private keys.
 207 Keys are added using
 208 .Xr ssh-add 1
 209 or by
 210 .Xr ssh 1
 211 when
 212 .Cm AddKeysToAgent
 213 is set in
 214 .Xr ssh_config 5 .
 215 Multiple identities may be stored in
 216 .Nm
 217 concurrently and
 218 .Xr ssh 1
 219 will automatically use them if present.
 220 .Xr ssh-add 1
 221 is also used to remove keys from
 222 .Nm
 223 and to query the keys that are held in one.
 224 .Pp
 225 Connections to
 226 .Nm
 227 may be forwarded from further remote hosts using the
 228 .Fl A
 229 option to
 230 .Xr ssh 1
 231 (but see the caveats documented therein),
 232 avoiding the need for authentication data to be stored on other machines.
 233 Authentication passphrases and private keys never go over the network:
 234 the connection to the agent is forwarded over SSH remote connections
 235 and the result is returned to the requester,
 236 allowing the user access to their identities anywhere in the network
 237 in a secure fashion.
 238 .Sh ENVIRONMENT
 239 .Bl -tag -width "SSH_AGENT_PID"
 240 .It Ev SSH_AGENT_PID
 241 When
 242 .Nm
 243 starts, it stores the name of the agent's process ID (PID) in this variable.
 244 .It Ev SSH_AUTH_SOCK
 245 When
 246 .Nm
 247 starts, it creates a
 248 .Ux Ns -domain
 249 socket and stores its pathname in this variable.
 250 It is accessible only to the current user,
 251 but is easily abused by root or another instance of the same user.
 252 .El
 253 .Sh FILES
 254 .Bl -tag -width Ds
 255 .It Pa $TMPDIR/ssh-XXXXXXXXXX/agent.<ppid>
 256 .Ux Ns -domain
 257 sockets used to contain the connection to the authentication agent.
 258 These sockets should only be readable by the owner.
 259 The sockets should get automatically removed when the agent exits.
 260 .El
 261 .Sh SEE ALSO
 262 .Xr ssh 1 ,
 263 .Xr ssh-add 1 ,
 264 .Xr ssh-keygen 1 ,
 265 .Xr ssh_config 5 ,
 266 .Xr sshd 8
 267 .Sh AUTHORS
 268 .An -nosplit
 269 OpenSSH is a derivative of the original and free ssh 1.2.12 release by
 270 .An Tatu Ylonen .
 271 .An Aaron Campbell , Bob Beck , Markus Friedl , Niels Provos , Theo de Raadt
 272 and
 273 .An Dug Song
 274 removed many bugs, re-added newer features and created OpenSSH.
 275 .An Markus Friedl
 276 contributed the support for SSH protocol versions 1.5 and 2.0.