jmc@openbsd.org | af90aec | 2019-11-15 11:16:28 +0000 | [diff] [blame] | 1 | .\" $OpenBSD: ssh-add.1,v 1.74 2019/11/15 11:16:28 jmc Exp $ |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 2 | .\" |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 3 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 4 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 5 | .\" All rights reserved |
| 6 | .\" |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 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". |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 12 | .\" |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 13 | .\" |
Ben Lindstrom | 92a2e38 | 2001-03-05 06:59:27 +0000 | [diff] [blame] | 14 | .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. |
| 15 | .\" Copyright (c) 1999 Aaron Campbell. All rights reserved. |
| 16 | .\" Copyright (c) 1999 Theo de Raadt. All rights reserved. |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 17 | .\" |
| 18 | .\" Redistribution and use in source and binary forms, with or without |
| 19 | .\" modification, are permitted provided that the following conditions |
| 20 | .\" are met: |
| 21 | .\" 1. Redistributions of source code must retain the above copyright |
| 22 | .\" notice, this list of conditions and the following disclaimer. |
| 23 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| 24 | .\" notice, this list of conditions and the following disclaimer in the |
| 25 | .\" documentation and/or other materials provided with the distribution. |
| 26 | .\" |
| 27 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| 28 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| 29 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| 30 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 31 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 32 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 33 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 34 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 35 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| 36 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 37 | .\" |
jmc@openbsd.org | af90aec | 2019-11-15 11:16:28 +0000 | [diff] [blame] | 38 | .Dd $Mdocdate: November 15 2019 $ |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 39 | .Dt SSH-ADD 1 |
| 40 | .Os |
| 41 | .Sh NAME |
| 42 | .Nm ssh-add |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 43 | .Nd adds private key identities to the authentication agent |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 44 | .Sh SYNOPSIS |
| 45 | .Nm ssh-add |
djm@openbsd.org | c7670b0 | 2019-01-21 12:53:35 +0000 | [diff] [blame] | 46 | .Op Fl cDdkLlqvXx |
djm@openbsd.org | 56d1c83 | 2014-12-21 22:27:55 +0000 | [diff] [blame] | 47 | .Op Fl E Ar fingerprint_hash |
djm@openbsd.org | 486164d | 2019-10-31 21:19:56 +0000 | [diff] [blame] | 48 | .Op Fl S Ar provider |
jmc@openbsd.org | de871e4 | 2019-11-01 00:52:35 +0000 | [diff] [blame] | 49 | .Op Fl t Ar life |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 50 | .Op Ar |
Ben Lindstrom | e690121 | 2001-08-06 22:03:08 +0000 | [diff] [blame] | 51 | .Nm ssh-add |
Damien Miller | 048dc93 | 2010-02-12 09:22:04 +1100 | [diff] [blame] | 52 | .Fl s Ar pkcs11 |
Ben Lindstrom | e690121 | 2001-08-06 22:03:08 +0000 | [diff] [blame] | 53 | .Nm ssh-add |
Damien Miller | 048dc93 | 2010-02-12 09:22:04 +1100 | [diff] [blame] | 54 | .Fl e Ar pkcs11 |
djm@openbsd.org | aa22c20 | 2019-01-20 22:03:29 +0000 | [diff] [blame] | 55 | .Nm ssh-add |
| 56 | .Fl T |
jmc@openbsd.org | 9d1a977 | 2019-01-21 07:09:10 +0000 | [diff] [blame] | 57 | .Ar pubkey ... |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 58 | .Sh DESCRIPTION |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 59 | .Nm |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 60 | adds private key identities to the authentication agent, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 61 | .Xr ssh-agent 1 . |
Damien Miller | 6e1057c | 2002-01-22 23:05:59 +1100 | [diff] [blame] | 62 | When run without arguments, it adds the files |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 63 | .Pa ~/.ssh/id_rsa , |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 64 | .Pa ~/.ssh/id_dsa , |
Damien Miller | 8ba0ead | 2013-12-18 17:46:27 +1100 | [diff] [blame] | 65 | .Pa ~/.ssh/id_ecdsa , |
naddy@openbsd.org | aa4c640 | 2019-11-07 08:38:38 +0000 | [diff] [blame] | 66 | .Pa ~/.ssh/id_ecdsa_sk , |
Damien Miller | 6e1057c | 2002-01-22 23:05:59 +1100 | [diff] [blame] | 67 | and |
jmc@openbsd.org | 2b6f799 | 2017-05-03 06:32:02 +0000 | [diff] [blame] | 68 | .Pa ~/.ssh/id_ed25519 . |
Damien Miller | 5059d8d | 2010-03-05 21:31:11 +1100 | [diff] [blame] | 69 | After loading a private key, |
| 70 | .Nm |
| 71 | will try to load corresponding certificate information from the |
| 72 | filename obtained by appending |
| 73 | .Pa -cert.pub |
| 74 | to the name of the private key file. |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 75 | Alternative file names can be given on the command line. |
Damien Miller | 5059d8d | 2010-03-05 21:31:11 +1100 | [diff] [blame] | 76 | .Pp |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 77 | If any file requires a passphrase, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 78 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 79 | asks for the passphrase from the user. |
Ben Lindstrom | aafff9c | 2001-05-06 03:01:02 +0000 | [diff] [blame] | 80 | The passphrase is read from the user's tty. |
Ben Lindstrom | 12de616 | 2001-04-10 02:46:54 +0000 | [diff] [blame] | 81 | .Nm |
| 82 | retries the last passphrase if multiple identity files are given. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 83 | .Pp |
Darren Tucker | 4c56843 | 2003-12-09 19:01:51 +1100 | [diff] [blame] | 84 | The authentication agent must be running and the |
| 85 | .Ev SSH_AUTH_SOCK |
| 86 | environment variable must contain the name of its socket for |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 87 | .Nm |
| 88 | to work. |
| 89 | .Pp |
| 90 | The options are as follows: |
| 91 | .Bl -tag -width Ds |
Damien Miller | 6c71179 | 2003-01-24 11:36:23 +1100 | [diff] [blame] | 92 | .It Fl c |
| 93 | Indicates that added identities should be subject to confirmation before |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 94 | being used for authentication. |
jmc@openbsd.org | 78de167 | 2015-03-30 18:28:37 +0000 | [diff] [blame] | 95 | Confirmation is performed by |
| 96 | .Xr ssh-askpass 1 . |
| 97 | Successful confirmation is signaled by a zero exit status from |
| 98 | .Xr ssh-askpass 1 , |
| 99 | rather than text entered into the requester. |
Damien Miller | 792c017 | 2005-03-02 12:04:50 +1100 | [diff] [blame] | 100 | .It Fl D |
| 101 | Deletes all identities from the agent. |
| 102 | .It Fl d |
Darren Tucker | 930cb0b | 2007-06-13 00:00:27 +1000 | [diff] [blame] | 103 | Instead of adding identities, removes identities from the agent. |
Darren Tucker | 29a5707 | 2007-06-12 23:39:52 +1000 | [diff] [blame] | 104 | If |
| 105 | .Nm |
Damien Miller | 33a8136 | 2012-12-03 09:50:24 +1100 | [diff] [blame] | 106 | has been run without arguments, the keys for the default identities and |
Darren Tucker | f9333d5 | 2012-12-07 13:06:13 +1100 | [diff] [blame] | 107 | their corresponding certificates will be removed. |
Darren Tucker | 29a5707 | 2007-06-12 23:39:52 +1000 | [diff] [blame] | 108 | Otherwise, the argument list will be interpreted as a list of paths to |
Damien Miller | 33a8136 | 2012-12-03 09:50:24 +1100 | [diff] [blame] | 109 | public key files to specify keys and certificates to be removed from the agent. |
Darren Tucker | 29a5707 | 2007-06-12 23:39:52 +1000 | [diff] [blame] | 110 | If no public key is found at a given path, |
| 111 | .Nm |
| 112 | will append |
| 113 | .Pa .pub |
| 114 | and retry. |
djm@openbsd.org | 56d1c83 | 2014-12-21 22:27:55 +0000 | [diff] [blame] | 115 | .It Fl E Ar fingerprint_hash |
| 116 | Specifies the hash algorithm used when displaying key fingerprints. |
| 117 | Valid options are: |
| 118 | .Dq md5 |
| 119 | and |
| 120 | .Dq sha256 . |
| 121 | The default is |
| 122 | .Dq sha256 . |
Damien Miller | 7ea845e | 2010-02-12 09:21:02 +1100 | [diff] [blame] | 123 | .It Fl e Ar pkcs11 |
Damien Miller | a761844 | 2010-02-12 09:26:02 +1100 | [diff] [blame] | 124 | Remove keys provided by the PKCS#11 shared library |
Damien Miller | 7ea845e | 2010-02-12 09:21:02 +1100 | [diff] [blame] | 125 | .Ar pkcs11 . |
Damien Miller | 8f4279e | 2011-10-18 16:06:33 +1100 | [diff] [blame] | 126 | .It Fl k |
Damien Miller | 33a8136 | 2012-12-03 09:50:24 +1100 | [diff] [blame] | 127 | When loading keys into or deleting keys from the agent, process plain private |
| 128 | keys only and skip certificates. |
Damien Miller | 792c017 | 2005-03-02 12:04:50 +1100 | [diff] [blame] | 129 | .It Fl L |
| 130 | Lists public key parameters of all identities currently represented |
| 131 | by the agent. |
| 132 | .It Fl l |
| 133 | Lists fingerprints of all identities currently represented by the agent. |
jmc@openbsd.org | 6227fe5 | 2017-08-29 13:05:58 +0000 | [diff] [blame] | 134 | .It Fl q |
| 135 | Be quiet after a successful operation. |
djm@openbsd.org | 486164d | 2019-10-31 21:19:56 +0000 | [diff] [blame] | 136 | .It Fl S Ar provider |
| 137 | Specifies a path to a security key provider library that will be used when |
| 138 | adding any security key-hosted keys, overriding the default of using the |
jmc@openbsd.org | af90aec | 2019-11-15 11:16:28 +0000 | [diff] [blame] | 139 | internal USB HID support. |
jmc@openbsd.org | de871e4 | 2019-11-01 00:52:35 +0000 | [diff] [blame] | 140 | .It Fl s Ar pkcs11 |
| 141 | Add keys provided by the PKCS#11 shared library |
| 142 | .Ar pkcs11 . |
jmc@openbsd.org | 9d1a977 | 2019-01-21 07:09:10 +0000 | [diff] [blame] | 143 | .It Fl T Ar pubkey ... |
djm@openbsd.org | aa22c20 | 2019-01-20 22:03:29 +0000 | [diff] [blame] | 144 | Tests whether the private keys that correspond to the specified |
| 145 | .Ar pubkey |
| 146 | files are usable by performing sign and verify operations on each. |
Damien Miller | 792c017 | 2005-03-02 12:04:50 +1100 | [diff] [blame] | 147 | .It Fl t Ar life |
| 148 | Set a maximum lifetime when adding identities to an agent. |
| 149 | The lifetime may be specified in seconds or in a time format |
| 150 | specified in |
| 151 | .Xr sshd_config 5 . |
djm@openbsd.org | c7670b0 | 2019-01-21 12:53:35 +0000 | [diff] [blame] | 152 | .It Fl v |
| 153 | Verbose mode. |
| 154 | Causes |
| 155 | .Nm |
| 156 | to print debugging messages about its progress. |
| 157 | This is helpful in debugging problems. |
| 158 | Multiple |
| 159 | .Fl v |
| 160 | options increase the verbosity. |
| 161 | The maximum is 3. |
Damien Miller | 792c017 | 2005-03-02 12:04:50 +1100 | [diff] [blame] | 162 | .It Fl X |
| 163 | Unlock the agent. |
| 164 | .It Fl x |
| 165 | Lock the agent with a password. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 166 | .El |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 167 | .Sh ENVIRONMENT |
| 168 | .Bl -tag -width Ds |
| 169 | .It Ev "DISPLAY" and "SSH_ASKPASS" |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 170 | If |
| 171 | .Nm |
| 172 | needs a passphrase, it will read the passphrase from the current |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 173 | terminal if it was run from a terminal. |
| 174 | If |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 175 | .Nm |
| 176 | does not have a terminal associated with it but |
| 177 | .Ev DISPLAY |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 178 | and |
| 179 | .Ev SSH_ASKPASS |
| 180 | are set, it will execute the program specified by |
| 181 | .Ev SSH_ASKPASS |
jmc@openbsd.org | 78de167 | 2015-03-30 18:28:37 +0000 | [diff] [blame] | 182 | (by default |
| 183 | .Dq ssh-askpass ) |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 184 | and open an X11 window to read the passphrase. |
| 185 | This is particularly useful when calling |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 186 | .Nm |
| 187 | from a |
Darren Tucker | 4e4fe00 | 2004-11-05 20:01:03 +1100 | [diff] [blame] | 188 | .Pa .xsession |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 189 | or related script. |
| 190 | (Note that on some machines it |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 191 | may be necessary to redirect the input from |
| 192 | .Pa /dev/null |
| 193 | to make this work.) |
Ben Lindstrom | b7788f3 | 2002-06-06 21:46:08 +0000 | [diff] [blame] | 194 | .It Ev SSH_AUTH_SOCK |
Darren Tucker | ae69e1d | 2009-10-24 11:41:34 +1100 | [diff] [blame] | 195 | Identifies the path of a |
Darren Tucker | 98c9aec | 2009-10-24 11:42:44 +1100 | [diff] [blame] | 196 | .Ux Ns -domain |
| 197 | socket used to communicate with the agent. |
djm@openbsd.org | 486164d | 2019-10-31 21:19:56 +0000 | [diff] [blame] | 198 | .It Ev SSH_SK_PROVIDER |
| 199 | Specifies the path to a security key provider library used to interact with |
| 200 | hardware security keys. |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 201 | .El |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 202 | .Sh FILES |
| 203 | .Bl -tag -width Ds |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 204 | .It Pa ~/.ssh/id_dsa |
naddy@openbsd.org | 2e9c324 | 2017-05-05 10:41:58 +0000 | [diff] [blame] | 205 | Contains the DSA authentication identity of the user. |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 206 | .It Pa ~/.ssh/id_ecdsa |
naddy@openbsd.org | 2e9c324 | 2017-05-05 10:41:58 +0000 | [diff] [blame] | 207 | Contains the ECDSA authentication identity of the user. |
naddy@openbsd.org | aa4c640 | 2019-11-07 08:38:38 +0000 | [diff] [blame] | 208 | .It Pa ~/.ssh/id_ecdsa_sk |
| 209 | Contains the security key-hosted ECDSA authentication identity of the user. |
Damien Miller | 8ba0ead | 2013-12-18 17:46:27 +1100 | [diff] [blame] | 210 | .It Pa ~/.ssh/id_ed25519 |
naddy@openbsd.org | 2e9c324 | 2017-05-05 10:41:58 +0000 | [diff] [blame] | 211 | Contains the Ed25519 authentication identity of the user. |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 212 | .It Pa ~/.ssh/id_rsa |
naddy@openbsd.org | 2e9c324 | 2017-05-05 10:41:58 +0000 | [diff] [blame] | 213 | Contains the RSA authentication identity of the user. |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 214 | .El |
| 215 | .Pp |
| 216 | Identity files should not be readable by anyone but the user. |
| 217 | Note that |
| 218 | .Nm |
| 219 | ignores identity files if they are accessible by others. |
Damien Miller | daa7b22 | 2010-09-10 11:19:33 +1000 | [diff] [blame] | 220 | .Sh EXIT STATUS |
Damien Miller | c313be2 | 2002-02-05 12:14:41 +1100 | [diff] [blame] | 221 | Exit status is 0 on success, 1 if the specified command fails, |
| 222 | and 2 if |
| 223 | .Nm |
| 224 | is unable to contact the authentication agent. |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 225 | .Sh SEE ALSO |
| 226 | .Xr ssh 1 , |
| 227 | .Xr ssh-agent 1 , |
jmc@openbsd.org | 78de167 | 2015-03-30 18:28:37 +0000 | [diff] [blame] | 228 | .Xr ssh-askpass 1 , |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 229 | .Xr ssh-keygen 1 , |
| 230 | .Xr sshd 8 |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 231 | .Sh AUTHORS |
Ben Lindstrom | 035782e | 2001-01-29 08:34:16 +0000 | [diff] [blame] | 232 | OpenSSH is a derivative of the original and free |
| 233 | ssh 1.2.12 release by Tatu Ylonen. |
| 234 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, |
| 235 | Theo de Raadt and Dug Song |
| 236 | removed many bugs, re-added newer features and |
| 237 | created OpenSSH. |
| 238 | Markus Friedl contributed the support for SSH |
| 239 | protocol versions 1.5 and 2.0. |