Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 1 | .\" -*- nroff -*- |
| 2 | .\" |
| 3 | .\" ssh-add.1 |
| 4 | .\" |
| 5 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
| 6 | .\" |
| 7 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 8 | .\" All rights reserved |
| 9 | .\" |
| 10 | .\" Created: Sat Apr 22 23:55:14 1995 ylo |
| 11 | .\" |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 12 | .\" $Id: ssh-add.1,v 1.16 2000/09/05 02:34:54 djm Exp $ |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 13 | .\" |
| 14 | .Dd September 25, 1999 |
| 15 | .Dt SSH-ADD 1 |
| 16 | .Os |
| 17 | .Sh NAME |
| 18 | .Nm ssh-add |
Damien Miller | ad833b3 | 2000-08-23 10:46:23 +1000 | [diff] [blame] | 19 | .Nd adds RSA or DSA identities for the authentication agent |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 20 | .Sh SYNOPSIS |
| 21 | .Nm ssh-add |
Damien Miller | 10f6f6b | 1999-11-17 17:29:08 +1100 | [diff] [blame] | 22 | .Op Fl lLdD |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 23 | .Op Ar |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 24 | .Sh DESCRIPTION |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 25 | .Nm |
Damien Miller | ad833b3 | 2000-08-23 10:46:23 +1000 | [diff] [blame] | 26 | adds RSA or DSA identities to the authentication agent, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 27 | .Xr ssh-agent 1 . |
| 28 | When run without arguments, it adds the file |
| 29 | .Pa $HOME/.ssh/identity . |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 30 | Alternative file names can be given on the command line. |
| 31 | If any file requires a passphrase, |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 32 | .Nm |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 33 | asks for the passphrase from the user. |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 34 | The Passphrase it is read from the user's tty. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 35 | .Pp |
| 36 | The authentication agent must be running and must be an ancestor of |
| 37 | the current process for |
| 38 | .Nm |
| 39 | to work. |
| 40 | .Pp |
| 41 | The options are as follows: |
| 42 | .Bl -tag -width Ds |
| 43 | .It Fl l |
Damien Miller | 10f6f6b | 1999-11-17 17:29:08 +1100 | [diff] [blame] | 44 | Lists fingerprints of all identities currently represented by the agent. |
| 45 | .It Fl L |
| 46 | Lists public key parameters of all identities currently represented by the agent. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 47 | .It Fl d |
| 48 | Instead of adding the identity, removes the identity from the agent. |
| 49 | .It Fl D |
| 50 | Deletes all identities from the agent. |
| 51 | .El |
| 52 | .Sh FILES |
| 53 | .Bl -tag -width Ds |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 54 | .It Pa $HOME/.ssh/identity |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 55 | Contains the RSA authentication identity of the user. |
| 56 | This file should not be readable by anyone but the user. |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 57 | Note that |
| 58 | .Nm |
| 59 | ignores this file if it is accessible by others. |
| 60 | It is possible to |
| 61 | specify a passphrase when generating the key; that passphrase will be |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 62 | used to encrypt the private part of this file. |
| 63 | This is the default file added by |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 64 | .Nm |
| 65 | when no other files have been specified. |
Damien Miller | ad833b3 | 2000-08-23 10:46:23 +1000 | [diff] [blame] | 66 | .It Pa $HOME/.ssh/id_dsa |
| 67 | Contains the DSA authentication identity of the user. |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 68 | .El |
Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 69 | .Sh ENVIRONMENT |
| 70 | .Bl -tag -width Ds |
| 71 | .It Ev "DISPLAY" and "SSH_ASKPASS" |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 72 | If |
| 73 | .Nm |
| 74 | needs a passphrase, it will read the passphrase from the current |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 75 | terminal if it was run from a terminal. |
| 76 | If |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 77 | .Nm |
| 78 | does not have a terminal associated with it but |
| 79 | .Ev DISPLAY |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 80 | and |
| 81 | .Ev SSH_ASKPASS |
| 82 | are set, it will execute the program specified by |
| 83 | .Ev SSH_ASKPASS |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 84 | and open an X11 window to read the passphrase. |
| 85 | This is particularly useful when calling |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 86 | .Nm |
| 87 | from a |
| 88 | .Pa .Xsession |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 89 | or related script. |
| 90 | (Note that on some machines it |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 91 | may be necessary to redirect the input from |
| 92 | .Pa /dev/null |
| 93 | to make this work.) |
Damien Miller | 7b28dc5 | 2000-09-05 13:34:53 +1100 | [diff] [blame] | 94 | .El |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 95 | .Sh AUTHOR |
| 96 | Tatu Ylonen <ylo@cs.hut.fi> |
| 97 | .Pp |
| 98 | OpenSSH |
| 99 | is a derivative of the original (free) ssh 1.2.12 release, but with bugs |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 100 | removed and newer features re-added. |
| 101 | Rapidly after the 1.2.12 release, |
| 102 | newer versions bore successively more restrictive licenses. |
| 103 | This version of OpenSSH |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 104 | .Bl -bullet |
| 105 | .It |
Damien Miller | cfabe86 | 2000-04-20 23:27:27 +1000 | [diff] [blame] | 106 | has all components of a restrictive nature (i.e., patents) |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 107 | directly removed from the source code; any licensed or patented components |
| 108 | are chosen from |
| 109 | external libraries. |
| 110 | .It |
| 111 | has been updated to support ssh protocol 1.5. |
| 112 | .It |
Damien Miller | 22c7726 | 2000-04-13 12:26:34 +1000 | [diff] [blame] | 113 | contains added support for |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 114 | .Xr kerberos 8 |
| 115 | authentication and ticket passing. |
| 116 | .It |
| 117 | supports one-time password authentication with |
| 118 | .Xr skey 1 . |
| 119 | .El |
Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 120 | .Sh SEE ALSO |
| 121 | .Xr ssh 1 , |
| 122 | .Xr ssh-agent 1 , |
| 123 | .Xr ssh-keygen 1 , |
| 124 | .Xr sshd 8 , |