]>
Commit | Line | Data |
---|---|---|
d866473d | 1 | .\" $OpenBSD: ssh-agent.1,v 1.27 2001/08/23 18:02:48 stevesk Exp $ |
bf740959 | 2 | .\" |
3 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> | |
bf740959 | 4 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
5 | .\" All rights reserved | |
6 | .\" | |
bcbf86ec | 7 | .\" As far as I am concerned, the code I have written for this software |
8 | .\" can be used freely for any purpose. Any derived versions of this | |
9 | .\" software must be clearly marked as such, and if the derived work is | |
10 | .\" incompatible with the protocol description in the RFC file, it must be | |
11 | .\" called by a name other than "ssh" or "Secure Shell". | |
12 | .\" | |
f3c7c613 | 13 | .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. |
14 | .\" Copyright (c) 1999 Aaron Campbell. All rights reserved. | |
15 | .\" Copyright (c) 1999 Theo de Raadt. All rights reserved. | |
bcbf86ec | 16 | .\" |
17 | .\" Redistribution and use in source and binary forms, with or without | |
18 | .\" modification, are permitted provided that the following conditions | |
19 | .\" are met: | |
20 | .\" 1. Redistributions of source code must retain the above copyright | |
21 | .\" notice, this list of conditions and the following disclaimer. | |
22 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
23 | .\" notice, this list of conditions and the following disclaimer in the | |
24 | .\" documentation and/or other materials provided with the distribution. | |
25 | .\" | |
26 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
27 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | |
28 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | |
29 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | |
30 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | |
31 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
32 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
33 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
34 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | |
35 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
bf740959 | 36 | .\" |
37 | .Dd September 25, 1999 | |
38 | .Dt SSH-AGENT 1 | |
39 | .Os | |
40 | .Sh NAME | |
41 | .Nm ssh-agent | |
42 | .Nd authentication agent | |
43 | .Sh SYNOPSIS | |
f54651ce | 44 | .Nm ssh-agent |
d343d900 | 45 | .Op Fl c Li | Fl s |
d866473d | 46 | .Op Fl d |
47 | .Op Ar command Op Ar args ... | |
d343d900 | 48 | .Nm ssh-agent |
d866473d | 49 | .Op Fl c Li | Fl s |
d343d900 | 50 | .Fl k |
f54651ce | 51 | .Sh DESCRIPTION |
bf740959 | 52 | .Nm |
2e73a022 | 53 | is a program to hold private keys used for public key authentication |
54 | (RSA, DSA). | |
4fe2af09 | 55 | The idea is that |
bf740959 | 56 | .Nm |
57 | is started in the beginning of an X-session or a login session, and | |
58 | all other windows or programs are started as clients to the ssh-agent | |
4fe2af09 | 59 | program. |
60 | Through use of environment variables the agent can be located | |
2e73a022 | 61 | and automatically used for authentication when logging in to other |
bf740959 | 62 | machines using |
63 | .Xr ssh 1 . | |
64 | .Pp | |
65 | The options are as follows: | |
66 | .Bl -tag -width Ds | |
67 | .It Fl c | |
68 | Generate C-shell commands on | |
69 | .Dv stdout . | |
70 | This is the default if | |
71 | .Ev SHELL | |
72 | looks like it's a csh style of shell. | |
73 | .It Fl s | |
74 | Generate Bourne shell commands on | |
75 | .Dv stdout . | |
76 | This is the default if | |
77 | .Ev SHELL | |
78 | does not look like it's a csh style of shell. | |
79 | .It Fl k | |
80 | Kill the current agent (given by the | |
81 | .Ev SSH_AGENT_PID | |
82 | environment variable). | |
ffdb5d70 | 83 | .It Fl d |
84 | Debug mode. When this option is specified | |
85 | .Nm | |
2c71dfc1 | 86 | will not fork. |
bf740959 | 87 | .El |
88 | .Pp | |
89 | If a commandline is given, this is executed as a subprocess of the agent. | |
90 | When the command dies, so does the agent. | |
91 | .Pp | |
4fe2af09 | 92 | The agent initially does not have any private keys. |
93 | Keys are added using | |
bf740959 | 94 | .Xr ssh-add 1 . |
f54651ce | 95 | When executed without arguments, |
bf740959 | 96 | .Xr ssh-add 1 |
f54651ce | 97 | adds the |
bf740959 | 98 | .Pa $HOME/.ssh/identity |
4fe2af09 | 99 | file. |
f54651ce | 100 | If the identity has a passphrase, |
bf740959 | 101 | .Xr ssh-add 1 |
102 | asks for the passphrase (using a small X11 application if running | |
4fe2af09 | 103 | under X11, or from the terminal if running without X). |
104 | It then sends the identity to the agent. | |
105 | Several identities can be stored in the | |
bf740959 | 106 | agent; the agent can automatically use any of these identities. |
107 | .Ic ssh-add -l | |
108 | displays the identities currently held by the agent. | |
109 | .Pp | |
110 | The idea is that the agent is run in the user's local PC, laptop, or | |
4fe2af09 | 111 | terminal. |
112 | Authentication data need not be stored on any other | |
bf740959 | 113 | machine, and authentication passphrases never go over the network. |
114 | However, the connection to the agent is forwarded over SSH | |
115 | remote logins, and the user can thus use the privileges given by the | |
116 | identities anywhere in the network in a secure way. | |
117 | .Pp | |
4fe2af09 | 118 | There are two main ways to get an agent setup: |
119 | Either you let the agent | |
bf740959 | 120 | start a new subcommand into which some environment variables are exported, or |
121 | you let the agent print the needed shell commands (either | |
122 | .Xr sh 1 | |
123 | or | |
124 | .Xr csh 1 | |
125 | syntax can be generated) which can be evalled in the calling shell. | |
126 | Later | |
127 | .Xr ssh 1 | |
9d451c5a | 128 | looks at these variables and uses them to establish a connection to the agent. |
bf740959 | 129 | .Pp |
130 | A unix-domain socket is created | |
131 | .Pq Pa /tmp/ssh-XXXXXXXX/agent.<pid> , | |
132 | and the name of this socket is stored in the | |
133 | .Ev SSH_AUTH_SOCK | |
134 | environment | |
4fe2af09 | 135 | variable. |
136 | The socket is made accessible only to the current user. | |
bf740959 | 137 | This method is easily abused by root or another instance of the same |
138 | user. | |
139 | .Pp | |
140 | The | |
141 | .Ev SSH_AGENT_PID | |
142 | environment variable holds the agent's PID. | |
143 | .Pp | |
144 | The agent exits automatically when the command given on the command | |
145 | line terminates. | |
146 | .Sh FILES | |
147 | .Bl -tag -width Ds | |
148 | .It Pa $HOME/.ssh/identity | |
c0ecc314 | 149 | Contains the protocol version 1 RSA authentication identity of the user. |
4fe2af09 | 150 | This file should not be readable by anyone but the user. |
151 | It is possible to | |
bf740959 | 152 | specify a passphrase when generating the key; that passphrase will be |
4fe2af09 | 153 | used to encrypt the private part of this file. |
154 | This file is not used by | |
bf740959 | 155 | .Nm |
156 | but is normally added to the agent using | |
157 | .Xr ssh-add 1 | |
158 | at login time. | |
2e73a022 | 159 | .It Pa $HOME/.ssh/id_dsa |
c0ecc314 | 160 | Contains the protocol version 2 DSA authentication identity of the user. |
161 | .It Pa $HOME/.ssh/id_rsa | |
162 | Contains the protocol version 2 RSA authentication identity of the user. | |
d343d900 | 163 | .It Pa /tmp/ssh-XXXXXXXX/agent.<pid> |
bf740959 | 164 | Unix-domain sockets used to contain the connection to the |
4fe2af09 | 165 | authentication agent. |
166 | These sockets should only be readable by the owner. | |
167 | The sockets should get automatically removed when the agent exits. | |
089fbbd2 | 168 | .El |
fa08c86b | 169 | .Sh AUTHORS |
5fb622e4 | 170 | OpenSSH is a derivative of the original and free |
171 | ssh 1.2.12 release by Tatu Ylonen. | |
172 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, | |
173 | Theo de Raadt and Dug Song | |
174 | removed many bugs, re-added newer features and | |
175 | created OpenSSH. | |
176 | Markus Friedl contributed the support for SSH | |
177 | protocol versions 1.5 and 2.0. | |
bf740959 | 178 | .Sh SEE ALSO |
179 | .Xr ssh 1 , | |
180 | .Xr ssh-add 1 , | |
181 | .Xr ssh-keygen 1 , | |
f98d56f0 | 182 | .Xr sshd 8 |