| 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 | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 12 | .\" $Id: ssh-add.1,v 1.6 1999/12/06 00:47:29 damien 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 |
| 19 | .Nd adds identities for the authentication agent |
| 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 |
| 24 | .Sh DESCRIPTION |
| 25 | .Nm |
| 26 | adds identities to the authentication agent, |
| 27 | .Xr ssh-agent 1 . |
| 28 | When run without arguments, it adds the file |
| 29 | .Pa $HOME/.ssh/identity . |
| 30 | Alternative file names can be given on the |
| 31 | command line. If any file requires a passphrase, |
| 32 | .Nm |
| 33 | asks for the passphrase from the user. |
| 34 | The Passphrase it is read from the user's tty. |
| 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 | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 55 | Contains the RSA authentication identity of the user. This file |
| 56 | should not be readable by anyone but the user. |
| 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 |
| 62 | used to encrypt the private part of this file. This is the |
| 63 | default file added by |
| 64 | .Nm |
| 65 | when no other files have been specified. |
| 66 | .Pp |
| Damien Miller | aae6c61 | 1999-12-06 11:47:28 +1100 | [diff] [blame] | 67 | .Sh ENVIRONMENT |
| 68 | .Bl -tag -width Ds |
| 69 | .It Ev "DISPLAY" and "SSH_ASKPASS" |
| Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 70 | If |
| 71 | .Nm |
| 72 | needs a passphrase, it will read the passphrase from the current |
| 73 | terminal if it was run from a terminal. If |
| 74 | .Nm |
| 75 | does not have a terminal associated with it but |
| 76 | .Ev DISPLAY |
| Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 77 | and |
| 78 | .Ev SSH_ASKPASS |
| 79 | are set, it will execute the program specified by |
| 80 | .Ev SSH_ASKPASS |
| 81 | and open an X11 window to read the passphrase. This is particularly |
| Damien Miller | 32aa144 | 1999-10-29 09:15:49 +1000 | [diff] [blame] | 82 | useful when calling |
| 83 | .Nm |
| 84 | from a |
| 85 | .Pa .Xsession |
| 86 | or related script. (Note that on some machines it |
| 87 | may be necessary to redirect the input from |
| 88 | .Pa /dev/null |
| 89 | to make this work.) |
| 90 | .Sh AUTHOR |
| 91 | Tatu Ylonen <ylo@cs.hut.fi> |
| 92 | .Pp |
| 93 | OpenSSH |
| 94 | is a derivative of the original (free) ssh 1.2.12 release, but with bugs |
| 95 | removed and newer features re-added. Rapidly after the 1.2.12 release, |
| 96 | newer versions bore successively more restrictive licenses. This version |
| 97 | of OpenSSH |
| 98 | .Bl -bullet |
| 99 | .It |
| 100 | has all components of a restrictive nature (ie. patents, see |
| 101 | .Xr ssl 8 ) |
| 102 | directly removed from the source code; any licensed or patented components |
| 103 | are chosen from |
| 104 | external libraries. |
| 105 | .It |
| 106 | has been updated to support ssh protocol 1.5. |
| 107 | .It |
| 108 | contains added support for |
| 109 | .Xr kerberos 8 |
| 110 | authentication and ticket passing. |
| 111 | .It |
| 112 | supports one-time password authentication with |
| 113 | .Xr skey 1 . |
| 114 | .El |
| 115 | .Pp |
| 116 | The libraries described in |
| 117 | .Xr ssl 8 |
| 118 | are required for proper operation. |
| 119 | .Sh SEE ALSO |
| 120 | .Xr ssh 1 , |
| 121 | .Xr ssh-agent 1 , |
| 122 | .Xr ssh-keygen 1 , |
| 123 | .Xr sshd 8 , |
| 124 | .Xr ssl 8 |