]>
Commit | Line | Data |
---|---|---|
bf740959 | 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 | .\" | |
12 | .\" $Id$ | |
13 | .\" | |
14 | .Dd September 25, 1999 | |
15 | .Dt SSH-ADD 1 | |
16 | .Os | |
17 | .Sh NAME | |
18 | .Nm ssh-add | |
2e73a022 | 19 | .Nd adds RSA or DSA identities for the authentication agent |
bf740959 | 20 | .Sh SYNOPSIS |
21 | .Nm ssh-add | |
f095fcc7 | 22 | .Op Fl lLdD |
bf740959 | 23 | .Op Ar |
f54651ce | 24 | .Sh DESCRIPTION |
bf740959 | 25 | .Nm |
2e73a022 | 26 | adds RSA or DSA identities to the authentication agent, |
bf740959 | 27 | .Xr ssh-agent 1 . |
28 | When run without arguments, it adds the file | |
29 | .Pa $HOME/.ssh/identity . | |
4fe2af09 | 30 | Alternative file names can be given on the command line. |
31 | If any file requires a passphrase, | |
bf740959 | 32 | .Nm |
f54651ce | 33 | asks for the passphrase from the user. |
4fe2af09 | 34 | The Passphrase it is read from the user's tty. |
bf740959 | 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 | |
f095fcc7 | 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. | |
bf740959 | 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 | |
57112b5a | 54 | .It Pa $HOME/.ssh/identity |
4fe2af09 | 55 | Contains the RSA authentication identity of the user. |
56 | This file should not be readable by anyone but the user. | |
bf740959 | 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 | |
4fe2af09 | 62 | used to encrypt the private part of this file. |
63 | This is the default file added by | |
bf740959 | 64 | .Nm |
65 | when no other files have been specified. | |
2e73a022 | 66 | .It Pa $HOME/.ssh/id_dsa |
67 | Contains the DSA authentication identity of the user. | |
b5e300c2 | 68 | .El |
57112b5a | 69 | .Sh ENVIRONMENT |
70 | .Bl -tag -width Ds | |
71 | .It Ev "DISPLAY" and "SSH_ASKPASS" | |
bf740959 | 72 | If |
73 | .Nm | |
74 | needs a passphrase, it will read the passphrase from the current | |
4fe2af09 | 75 | terminal if it was run from a terminal. |
76 | If | |
bf740959 | 77 | .Nm |
78 | does not have a terminal associated with it but | |
79 | .Ev DISPLAY | |
aa3378df | 80 | and |
81 | .Ev SSH_ASKPASS | |
82 | are set, it will execute the program specified by | |
83 | .Ev SSH_ASKPASS | |
4fe2af09 | 84 | and open an X11 window to read the passphrase. |
85 | This is particularly useful when calling | |
bf740959 | 86 | .Nm |
87 | from a | |
88 | .Pa .Xsession | |
4fe2af09 | 89 | or related script. |
90 | (Note that on some machines it | |
bf740959 | 91 | may be necessary to redirect the input from |
92 | .Pa /dev/null | |
93 | to make this work.) | |
b5e300c2 | 94 | .El |
bf740959 | 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 | |
4fe2af09 | 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 | |
bf740959 | 104 | .Bl -bullet |
105 | .It | |
371ecff9 | 106 | has all components of a restrictive nature (i.e., patents) |
bf740959 | 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 | |
f54651ce | 113 | contains added support for |
bf740959 | 114 | .Xr kerberos 8 |
115 | authentication and ticket passing. | |
116 | .It | |
117 | supports one-time password authentication with | |
118 | .Xr skey 1 . | |
119 | .El | |
bf740959 | 120 | .Sh SEE ALSO |
121 | .Xr ssh 1 , | |
122 | .Xr ssh-agent 1 , | |
123 | .Xr ssh-keygen 1 , | |
124 | .Xr sshd 8 , |