Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 1 | .\" $OpenBSD: ssh-agent.1,v 1.64 2016/11/30 06:54:26 jmc Exp $ |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 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 | .\" |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 37 | .Dd $Mdocdate: November 30 2016 $ |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 38 | .Dt SSH-AGENT 1 |
| 39 | .Os |
| 40 | .Sh NAME |
| 41 | .Nm ssh-agent |
| 42 | .Nd authentication agent |
| 43 | .Sh SYNOPSIS |
| 44 | .Nm ssh-agent |
| 45 | .Op Fl c | s |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 46 | .Op Fl \&Dd |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 47 | .Op Fl a Ar bind_address |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 48 | .Op Fl E Ar fingerprint_hash |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 49 | .Op Fl P Ar pkcs11_whitelist |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 50 | .Op Fl t Ar life |
| 51 | .Op Ar command Op Ar arg ... |
| 52 | .Nm ssh-agent |
| 53 | .Op Fl c | s |
| 54 | .Fl k |
| 55 | .Sh DESCRIPTION |
| 56 | .Nm |
| 57 | is a program to hold private keys used for public key authentication |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 58 | (RSA, DSA, ECDSA, Ed25519). |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 59 | .Nm |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 60 | is usually started in the beginning of an X-session or a login session, and |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 61 | all other windows or programs are started as clients to the ssh-agent |
| 62 | program. |
| 63 | Through use of environment variables the agent can be located |
| 64 | and automatically used for authentication when logging in to other |
| 65 | machines using |
| 66 | .Xr ssh 1 . |
| 67 | .Pp |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 68 | The agent initially does not have any private keys. |
| 69 | Keys are added using |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 70 | .Xr ssh 1 |
| 71 | (see |
| 72 | .Cm AddKeysToAgent |
| 73 | in |
| 74 | .Xr ssh_config 5 |
| 75 | for details) |
| 76 | or |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 77 | .Xr ssh-add 1 . |
| 78 | Multiple identities may be stored in |
| 79 | .Nm |
| 80 | concurrently and |
| 81 | .Xr ssh 1 |
| 82 | will automatically use them if present. |
| 83 | .Xr ssh-add 1 |
| 84 | is also used to remove keys from |
| 85 | .Nm |
| 86 | and to query the keys that are held in one. |
| 87 | .Pp |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 88 | The options are as follows: |
| 89 | .Bl -tag -width Ds |
| 90 | .It Fl a Ar bind_address |
| 91 | Bind the agent to the |
| 92 | .Ux Ns -domain |
| 93 | socket |
| 94 | .Ar bind_address . |
| 95 | The default is |
| 96 | .Pa $TMPDIR/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt . |
| 97 | .It Fl c |
| 98 | Generate C-shell commands on |
| 99 | .Dv stdout . |
| 100 | This is the default if |
| 101 | .Ev SHELL |
| 102 | looks like it's a csh style of shell. |
Greg Hartman | ccacbc9 | 2016-02-03 09:59:44 -0800 | [diff] [blame] | 103 | .It Fl D |
| 104 | Foreground mode. |
| 105 | When this option is specified |
| 106 | .Nm |
| 107 | will not fork. |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 108 | .It Fl d |
| 109 | Debug mode. |
| 110 | When this option is specified |
| 111 | .Nm |
Greg Hartman | ccacbc9 | 2016-02-03 09:59:44 -0800 | [diff] [blame] | 112 | will not fork and will write debug information to standard error. |
Adam Langley | d059297 | 2015-03-30 14:49:51 -0700 | [diff] [blame] | 113 | .It Fl E Ar fingerprint_hash |
| 114 | Specifies the hash algorithm used when displaying key fingerprints. |
| 115 | Valid options are: |
| 116 | .Dq md5 |
| 117 | and |
| 118 | .Dq sha256 . |
| 119 | The default is |
| 120 | .Dq sha256 . |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 121 | .It Fl k |
| 122 | Kill the current agent (given by the |
| 123 | .Ev SSH_AGENT_PID |
| 124 | environment variable). |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 125 | .It Fl P Ar pkcs11_whitelist |
| 126 | Specify a pattern-list of acceptable paths for PKCS#11 shared libraries |
| 127 | that may be added using the |
| 128 | .Fl s |
| 129 | option to |
| 130 | .Xr ssh-add 1 . |
| 131 | The default is to allow loading PKCS#11 libraries from |
| 132 | .Dq /usr/lib/*,/usr/local/lib/* . |
| 133 | PKCS#11 libraries that do not match the whitelist will be refused. |
| 134 | See PATTERNS in |
| 135 | .Xr ssh_config 5 |
| 136 | for a description of pattern-list syntax. |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 137 | .It Fl s |
| 138 | Generate Bourne shell commands on |
| 139 | .Dv stdout . |
| 140 | This is the default if |
| 141 | .Ev SHELL |
| 142 | does not look like it's a csh style of shell. |
| 143 | .It Fl t Ar life |
| 144 | Set a default value for the maximum lifetime of identities added to the agent. |
| 145 | The lifetime may be specified in seconds or in a time format specified in |
| 146 | .Xr sshd_config 5 . |
| 147 | A lifetime specified for an identity with |
| 148 | .Xr ssh-add 1 |
| 149 | overrides this value. |
| 150 | Without this option the default maximum lifetime is forever. |
| 151 | .El |
| 152 | .Pp |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 153 | If a command line is given, this is executed as a subprocess of the agent. |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 154 | When the command dies, so does the agent. |
| 155 | .Pp |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 156 | The idea is that the agent is run in the user's local PC, laptop, or |
| 157 | terminal. |
| 158 | Authentication data need not be stored on any other |
| 159 | machine, and authentication passphrases never go over the network. |
| 160 | However, the connection to the agent is forwarded over SSH |
| 161 | remote logins, and the user can thus use the privileges given by the |
| 162 | identities anywhere in the network in a secure way. |
| 163 | .Pp |
| 164 | There are two main ways to get an agent set up: |
| 165 | The first is that the agent starts a new subcommand into which some environment |
| 166 | variables are exported, eg |
| 167 | .Cm ssh-agent xterm & . |
| 168 | The second is that the agent prints the needed shell commands (either |
| 169 | .Xr sh 1 |
| 170 | or |
| 171 | .Xr csh 1 |
| 172 | syntax can be generated) which can be evaluated in the calling shell, eg |
| 173 | .Cm eval `ssh-agent -s` |
| 174 | for Bourne-type shells such as |
| 175 | .Xr sh 1 |
| 176 | or |
| 177 | .Xr ksh 1 |
| 178 | and |
| 179 | .Cm eval `ssh-agent -c` |
| 180 | for |
| 181 | .Xr csh 1 |
| 182 | and derivatives. |
| 183 | .Pp |
| 184 | Later |
| 185 | .Xr ssh 1 |
| 186 | looks at these variables and uses them to establish a connection to the agent. |
| 187 | .Pp |
| 188 | The agent will never send a private key over its request channel. |
| 189 | Instead, operations that require a private key will be performed |
| 190 | by the agent, and the result will be returned to the requester. |
| 191 | This way, private keys are not exposed to clients using the agent. |
| 192 | .Pp |
| 193 | A |
| 194 | .Ux Ns -domain |
| 195 | socket is created and the name of this socket is stored in the |
| 196 | .Ev SSH_AUTH_SOCK |
| 197 | environment |
| 198 | variable. |
| 199 | The socket is made accessible only to the current user. |
| 200 | This method is easily abused by root or another instance of the same |
| 201 | user. |
| 202 | .Pp |
| 203 | The |
| 204 | .Ev SSH_AGENT_PID |
| 205 | environment variable holds the agent's process ID. |
| 206 | .Pp |
| 207 | The agent exits automatically when the command given on the command |
| 208 | line terminates. |
| 209 | .Sh FILES |
| 210 | .Bl -tag -width Ds |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 211 | .It Pa $TMPDIR/ssh-XXXXXXXXXX/agent.<ppid> |
Greg Hartman | bd77cf7 | 2015-02-25 13:21:06 -0800 | [diff] [blame] | 212 | .Ux Ns -domain |
| 213 | sockets used to contain the connection to the authentication agent. |
| 214 | These sockets should only be readable by the owner. |
| 215 | The sockets should get automatically removed when the agent exits. |
| 216 | .El |
| 217 | .Sh SEE ALSO |
| 218 | .Xr ssh 1 , |
| 219 | .Xr ssh-add 1 , |
| 220 | .Xr ssh-keygen 1 , |
| 221 | .Xr sshd 8 |
| 222 | .Sh AUTHORS |
Greg Hartman | 9768ca4 | 2017-06-22 20:49:52 -0700 | [diff] [blame] | 223 | .An -nosplit |
| 224 | OpenSSH is a derivative of the original and free ssh 1.2.12 release by |
| 225 | .An Tatu Ylonen . |
| 226 | .An Aaron Campbell , Bob Beck , Markus Friedl , Niels Provos , Theo de Raadt |
| 227 | and |
| 228 | .An Dug Song |
| 229 | removed many bugs, re-added newer features and created OpenSSH. |
| 230 | .An Markus Friedl |
| 231 | contributed the support for SSH protocol versions 1.5 and 2.0. |