]>
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 | |
19 | .Nd adds identities for the authentication agent | |
20 | .Sh SYNOPSIS | |
21 | .Nm ssh-add | |
22 | .Op Fl ldD | |
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 | |
44 | Lists all identities currently represented by the agent. | |
45 | .It Fl d | |
46 | Instead of adding the identity, removes the identity from the agent. | |
47 | .It Fl D | |
48 | Deletes all identities from the agent. | |
49 | .El | |
50 | .Sh FILES | |
51 | .Bl -tag -width Ds | |
52 | .Pa $HOME/.ssh/identity | |
53 | Contains the RSA authentication identity of the user. This file | |
54 | should not be readable by anyone but the user. | |
55 | Note that | |
56 | .Nm | |
57 | ignores this file if it is accessible by others. | |
58 | It is possible to | |
59 | specify a passphrase when generating the key; that passphrase will be | |
60 | used to encrypt the private part of this file. This is the | |
61 | default file added by | |
62 | .Nm | |
63 | when no other files have been specified. | |
64 | .Pp | |
65 | If | |
66 | .Nm | |
67 | needs a passphrase, it will read the passphrase from the current | |
68 | terminal if it was run from a terminal. If | |
69 | .Nm | |
70 | does not have a terminal associated with it but | |
71 | .Ev DISPLAY | |
72 | is set, it | |
73 | will open an X11 window to read the passphrase. This is particularly | |
74 | useful when calling | |
75 | .Nm | |
76 | from a | |
77 | .Pa .Xsession | |
78 | or related script. (Note that on some machines it | |
79 | may be necessary to redirect the input from | |
80 | .Pa /dev/null | |
81 | to make this work.) | |
82 | .Sh AUTHOR | |
83 | Tatu Ylonen <ylo@cs.hut.fi> | |
84 | .Pp | |
85 | OpenSSH | |
86 | is a derivative of the original (free) ssh 1.2.12 release, but with bugs | |
87 | removed and newer features re-added. Rapidly after the 1.2.12 release, | |
88 | newer versions bore successively more restrictive licenses. This version | |
89 | of OpenSSH | |
90 | .Bl -bullet | |
91 | .It | |
92 | has all components of a restrictive nature (ie. patents, see | |
93 | .Xr ssl 8 ) | |
94 | directly removed from the source code; any licensed or patented components | |
95 | are chosen from | |
96 | external libraries. | |
97 | .It | |
98 | has been updated to support ssh protocol 1.5. | |
99 | .It | |
100 | contains added support for | |
101 | .Xr kerberos 8 | |
102 | authentication and ticket passing. | |
103 | .It | |
104 | supports one-time password authentication with | |
105 | .Xr skey 1 . | |
106 | .El | |
107 | .Pp | |
108 | The libraries described in | |
109 | .Xr ssl 8 | |
110 | are required for proper operation. | |
111 | .Sh SEE ALSO | |
112 | .Xr ssh 1 , | |
113 | .Xr ssh-agent 1 , | |
114 | .Xr ssh-keygen 1 , | |
115 | .Xr sshd 8 , | |
116 | .Xr ssl 8 |