Darren Tucker | 4e4fe00 | 2004-11-05 20:01:03 +1100 | [diff] [blame] | 1 | .\" $OpenBSD: ssh-add.1,v 1.41 2004/08/30 21:22:49 jmc Exp $ |
Ben Lindstrom | 36579d3 | 2001-01-29 07:39:26 +0000 | [diff] [blame] | 2 | .\" |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 3 | .\" -*- nroff -*- |
| 4 | .\" |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 5 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 6 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 7 | .\" All rights reserved |
| 8 | .\" |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 9 | .\" As far as I am concerned, the code I have written for this software |
| 10 | .\" can be used freely for any purpose. Any derived versions of this |
| 11 | .\" software must be clearly marked as such, and if the derived work is |
| 12 | .\" incompatible with the protocol description in the RFC file, it must be |
| 13 | .\" called by a name other than "ssh" or "Secure Shell". |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 14 | .\" |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 15 | .\" |
Ben Lindstrom | 92a2e38 | 2001-03-05 06:59:27 +0000 | [diff] [blame] | 16 | .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. |
| 17 | .\" Copyright (c) 1999 Aaron Campbell. All rights reserved. |
| 18 | .\" Copyright (c) 1999 Theo de Raadt. All rights reserved. |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 19 | .\" |
| 20 | .\" Redistribution and use in source and binary forms, with or without |
| 21 | .\" modification, are permitted provided that the following conditions |
| 22 | .\" are met: |
| 23 | .\" 1. Redistributions of source code must retain the above copyright |
| 24 | .\" notice, this list of conditions and the following disclaimer. |
| 25 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| 26 | .\" notice, this list of conditions and the following disclaimer in the |
| 27 | .\" documentation and/or other materials provided with the distribution. |
| 28 | .\" |
| 29 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| 30 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| 31 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| 32 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 33 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 34 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 35 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 36 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 37 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| 38 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 39 | .\" |
| 40 | .Dd September 25, 1999 |
| 41 | .Dt SSH-ADD 1 |
| 42 | .Os |
| 43 | .Sh NAME |
| 44 | .Nm ssh-add |
Ben Lindstrom | 8d066fb | 2001-09-12 17:06:13 +0000 | [diff] [blame] | 45 | .Nd adds RSA or DSA identities to the authentication agent |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 46 | .Sh SYNOPSIS |
| 47 | .Nm ssh-add |
Damien Miller | 6c71179 | 2003-01-24 11:36:23 +1100 | [diff] [blame] | 48 | .Op Fl lLdDxXc |
Ben Lindstrom | 61d328a | 2002-06-06 21:54:57 +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 |
| 52 | .Fl s Ar reader |
| 53 | .Nm ssh-add |
| 54 | .Fl e Ar reader |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 55 | .Sh DESCRIPTION |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 56 | .Nm |
Damien Miller | ad833b3 | 2000-08-23 10:46:23 +1000 | [diff] [blame] | 57 | adds RSA or DSA identities to the authentication agent, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 58 | .Xr ssh-agent 1 . |
Damien Miller | 6e1057c | 2002-01-22 23:05:59 +1100 | [diff] [blame] | 59 | When run without arguments, it adds the files |
| 60 | .Pa $HOME/.ssh/id_rsa , |
Ben Lindstrom | cb72e4f | 2002-06-21 00:41:51 +0000 | [diff] [blame] | 61 | .Pa $HOME/.ssh/id_dsa |
Damien Miller | 6e1057c | 2002-01-22 23:05:59 +1100 | [diff] [blame] | 62 | and |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 63 | .Pa $HOME/.ssh/identity . |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 64 | Alternative file names can be given on the command line. |
| 65 | If any file requires a passphrase, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 66 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 67 | asks for the passphrase from the user. |
Ben Lindstrom | aafff9c | 2001-05-06 03:01:02 +0000 | [diff] [blame] | 68 | The passphrase is read from the user's tty. |
Ben Lindstrom | 12de616 | 2001-04-10 02:46:54 +0000 | [diff] [blame] | 69 | .Nm |
| 70 | retries the last passphrase if multiple identity files are given. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 71 | .Pp |
Darren Tucker | 4c56843 | 2003-12-09 19:01:51 +1100 | [diff] [blame] | 72 | The authentication agent must be running and the |
| 73 | .Ev SSH_AUTH_SOCK |
| 74 | environment variable must contain the name of its socket for |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 75 | .Nm |
| 76 | to work. |
| 77 | .Pp |
| 78 | The options are as follows: |
| 79 | .Bl -tag -width Ds |
| 80 | .It Fl l |
Damien Miller | 10f6f6b | 1999-11-17 17:29:08 +1100 | [diff] [blame] | 81 | Lists fingerprints of all identities currently represented by the agent. |
| 82 | .It Fl L |
| 83 | Lists public key parameters of all identities currently represented by the agent. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 84 | .It Fl d |
| 85 | Instead of adding the identity, removes the identity from the agent. |
| 86 | .It Fl D |
| 87 | Deletes all identities from the agent. |
Ben Lindstrom | 2f71704 | 2002-06-06 21:52:03 +0000 | [diff] [blame] | 88 | .It Fl x |
| 89 | Lock the agent with a password. |
| 90 | .It Fl X |
| 91 | Unlock the agent. |
Ben Lindstrom | 61d328a | 2002-06-06 21:54:57 +0000 | [diff] [blame] | 92 | .It Fl t Ar life |
| 93 | Set a maximum lifetime when adding identities to an agent. |
Ben Lindstrom | 1775c9c | 2002-06-11 15:51:54 +0000 | [diff] [blame] | 94 | The lifetime may be specified in seconds or in a time format |
| 95 | specified in |
Damien Miller | 7b40627 | 2003-02-24 12:00:16 +1100 | [diff] [blame] | 96 | .Xr sshd_config 5 . |
Damien Miller | 6c71179 | 2003-01-24 11:36:23 +1100 | [diff] [blame] | 97 | .It Fl c |
| 98 | Indicates that added identities should be subject to confirmation before |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 99 | being used for authentication. |
| 100 | Confirmation is performed by the |
Damien Miller | 6c71179 | 2003-01-24 11:36:23 +1100 | [diff] [blame] | 101 | .Ev SSH_ASKPASS |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 102 | program mentioned below. |
| 103 | Successful confirmation is signaled by a zero exit status from the |
Damien Miller | 6c71179 | 2003-01-24 11:36:23 +1100 | [diff] [blame] | 104 | .Ev SSH_ASKPASS |
| 105 | program, rather than text entered into the requester. |
Ben Lindstrom | e690121 | 2001-08-06 22:03:08 +0000 | [diff] [blame] | 106 | .It Fl s Ar reader |
| 107 | Add key in smartcard |
| 108 | .Ar reader . |
| 109 | .It Fl e Ar reader |
| 110 | Remove key in smartcard |
| 111 | .Ar reader . |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 112 | .El |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 113 | .Sh ENVIRONMENT |
| 114 | .Bl -tag -width Ds |
| 115 | .It Ev "DISPLAY" and "SSH_ASKPASS" |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 116 | If |
| 117 | .Nm |
| 118 | needs a passphrase, it will read the passphrase from the current |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 119 | terminal if it was run from a terminal. |
| 120 | If |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 121 | .Nm |
| 122 | does not have a terminal associated with it but |
| 123 | .Ev DISPLAY |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 124 | and |
| 125 | .Ev SSH_ASKPASS |
| 126 | are set, it will execute the program specified by |
| 127 | .Ev SSH_ASKPASS |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 128 | and open an X11 window to read the passphrase. |
| 129 | This is particularly useful when calling |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 130 | .Nm |
| 131 | from a |
Darren Tucker | 4e4fe00 | 2004-11-05 20:01:03 +1100 | [diff] [blame] | 132 | .Pa .xsession |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 133 | or related script. |
| 134 | (Note that on some machines it |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 135 | may be necessary to redirect the input from |
| 136 | .Pa /dev/null |
| 137 | to make this work.) |
Ben Lindstrom | b7788f3 | 2002-06-06 21:46:08 +0000 | [diff] [blame] | 138 | .It Ev SSH_AUTH_SOCK |
| 139 | Identifies the path of a unix-domain socket used to communicate with the |
| 140 | agent. |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 141 | .El |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 142 | .Sh FILES |
| 143 | .Bl -tag -width Ds |
| 144 | .It Pa $HOME/.ssh/identity |
| 145 | Contains the protocol version 1 RSA authentication identity of the user. |
| 146 | .It Pa $HOME/.ssh/id_dsa |
| 147 | Contains the protocol version 2 DSA authentication identity of the user. |
| 148 | .It Pa $HOME/.ssh/id_rsa |
| 149 | Contains the protocol version 2 RSA authentication identity of the user. |
| 150 | .El |
| 151 | .Pp |
| 152 | Identity files should not be readable by anyone but the user. |
| 153 | Note that |
| 154 | .Nm |
| 155 | ignores identity files if they are accessible by others. |
Damien Miller | c313be2 | 2002-02-05 12:14:41 +1100 | [diff] [blame] | 156 | .Sh DIAGNOSTICS |
| 157 | Exit status is 0 on success, 1 if the specified command fails, |
| 158 | and 2 if |
| 159 | .Nm |
| 160 | is unable to contact the authentication agent. |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 161 | .Sh SEE ALSO |
| 162 | .Xr ssh 1 , |
| 163 | .Xr ssh-agent 1 , |
| 164 | .Xr ssh-keygen 1 , |
| 165 | .Xr sshd 8 |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 166 | .Sh AUTHORS |
Ben Lindstrom | 035782e | 2001-01-29 08:34:16 +0000 | [diff] [blame] | 167 | OpenSSH is a derivative of the original and free |
| 168 | ssh 1.2.12 release by Tatu Ylonen. |
| 169 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, |
| 170 | Theo de Raadt and Dug Song |
| 171 | removed many bugs, re-added newer features and |
| 172 | created OpenSSH. |
| 173 | Markus Friedl contributed the support for SSH |
| 174 | protocol versions 1.5 and 2.0. |