]>
Commit | Line | Data |
---|---|---|
bf740959 | 1 | .\" -*- nroff -*- |
2 | .\" | |
bf740959 | 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. | |
bf740959 | 25 | .\" |
bcbf86ec | 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 | .\" |
a4e5acef | 37 | .\" $OpenBSD: ssh.1,v 1.168 2003/03/28 10:11:43 jmc Exp $ |
bf740959 | 38 | .Dd September 25, 1999 |
39 | .Dt SSH 1 | |
40 | .Os | |
41 | .Sh NAME | |
42 | .Nm ssh | |
2c86906e | 43 | .Nd OpenSSH SSH client (remote login program) |
bf740959 | 44 | .Sh SYNOPSIS |
45 | .Nm ssh | |
46 | .Op Fl l Ar login_name | |
c78e5800 | 47 | .Ar hostname | user@hostname |
bf740959 | 48 | .Op Ar command |
49 | .Pp | |
50 | .Nm ssh | |
a4e5acef | 51 | .Bk -words |
e59404d1 | 52 | .Op Fl afgknqstvxACNTX1246 |
3435f5a6 | 53 | .Op Fl b Ar bind_address |
d0c832f3 | 54 | .Op Fl c Ar cipher_spec |
bf740959 | 55 | .Op Fl e Ar escape_char |
56 | .Op Fl i Ar identity_file | |
57 | .Op Fl l Ar login_name | |
b2552997 | 58 | .Op Fl m Ar mac_spec |
bf740959 | 59 | .Op Fl o Ar option |
60 | .Op Fl p Ar port | |
e591b98a | 61 | .Op Fl F Ar configfile |
bf740959 | 62 | .Oo Fl L Xo |
63 | .Sm off | |
bf740959 | 64 | .Ar port : |
7b2ea3a1 | 65 | .Ar host : |
bf740959 | 66 | .Ar hostport |
67 | .Sm on | |
68 | .Xc | |
69 | .Oc | |
a4e5acef | 70 | .Ek |
71 | .Bk -words | |
bf740959 | 72 | .Oo Fl R Xo |
73 | .Sm off | |
bf740959 | 74 | .Ar port : |
7b2ea3a1 | 75 | .Ar host : |
bf740959 | 76 | .Ar hostport |
77 | .Sm on | |
78 | .Xc | |
79 | .Oc | |
ad3e169f | 80 | .Op Fl D Ar port |
c78e5800 | 81 | .Ar hostname | user@hostname |
bf740959 | 82 | .Op Ar command |
a4e5acef | 83 | .Ek |
f54651ce | 84 | .Sh DESCRIPTION |
bf740959 | 85 | .Nm |
2c86906e | 86 | (SSH client) is a program for logging into a remote machine and for |
610cd5c6 | 87 | executing commands on a remote machine. |
88 | It is intended to replace | |
bf740959 | 89 | rlogin and rsh, and provide secure encrypted communications between |
610cd5c6 | 90 | two untrusted hosts over an insecure network. |
91 | X11 connections and | |
bf740959 | 92 | arbitrary TCP/IP ports can also be forwarded over the secure channel. |
93 | .Pp | |
94 | .Nm | |
f54651ce | 95 | connects and logs into the specified |
bf740959 | 96 | .Ar hostname . |
97 | The user must prove | |
1d1ffb87 | 98 | his/her identity to the remote machine using one of several methods |
99 | depending on the protocol version used: | |
100 | .Pp | |
101 | .Ss SSH protocol version 1 | |
bf740959 | 102 | .Pp |
103 | First, if the machine the user logs in from is listed in | |
104 | .Pa /etc/hosts.equiv | |
105 | or | |
5f4fdfae | 106 | .Pa /etc/shosts.equiv |
bf740959 | 107 | on the remote machine, and the user names are |
108 | the same on both sides, the user is immediately permitted to log in. | |
f54651ce | 109 | Second, if |
bf740959 | 110 | .Pa \&.rhosts |
111 | or | |
112 | .Pa \&.shosts | |
113 | exists in the user's home directory on the | |
114 | remote machine and contains a line containing the name of the client | |
115 | machine and the name of the user on that machine, the user is | |
610cd5c6 | 116 | permitted to log in. |
117 | This form of authentication alone is normally not | |
bf740959 | 118 | allowed by the server because it is not secure. |
119 | .Pp | |
da89cf4d | 120 | The second authentication method is the |
bf740959 | 121 | .Pa rhosts |
122 | or | |
123 | .Pa hosts.equiv | |
610cd5c6 | 124 | method combined with RSA-based host authentication. |
125 | It means that if the login would be permitted by | |
1d1ffb87 | 126 | .Pa $HOME/.rhosts , |
127 | .Pa $HOME/.shosts , | |
bf740959 | 128 | .Pa /etc/hosts.equiv , |
129 | or | |
5f4fdfae | 130 | .Pa /etc/shosts.equiv , |
bf740959 | 131 | and if additionally the server can verify the client's |
f54651ce | 132 | host key (see |
2a8a6488 | 133 | .Pa /etc/ssh/ssh_known_hosts |
5bbb5681 | 134 | and |
135 | .Pa $HOME/.ssh/known_hosts | |
bf740959 | 136 | in the |
137 | .Sx FILES | |
610cd5c6 | 138 | section), only then login is permitted. |
139 | This authentication method closes security holes due to IP | |
140 | spoofing, DNS spoofing and routing spoofing. | |
141 | [Note to the administrator: | |
bf740959 | 142 | .Pa /etc/hosts.equiv , |
1d1ffb87 | 143 | .Pa $HOME/.rhosts , |
bf740959 | 144 | and the rlogin/rsh protocol in general, are inherently insecure and should be |
145 | disabled if security is desired.] | |
146 | .Pp | |
f54651ce | 147 | As a third authentication method, |
bf740959 | 148 | .Nm |
149 | supports RSA based authentication. | |
150 | The scheme is based on public-key cryptography: there are cryptosystems | |
151 | where encryption and decryption are done using separate keys, and it | |
152 | is not possible to derive the decryption key from the encryption key. | |
610cd5c6 | 153 | RSA is one such system. |
f54651ce | 154 | The idea is that each user creates a public/private |
610cd5c6 | 155 | key pair for authentication purposes. |
156 | The server knows the public key, and only the user knows the private key. | |
f54651ce | 157 | The file |
bf740959 | 158 | .Pa $HOME/.ssh/authorized_keys |
159 | lists the public keys that are permitted for logging | |
610cd5c6 | 160 | in. |
161 | When the user logs in, the | |
bf740959 | 162 | .Nm |
163 | program tells the server which key pair it would like to use for | |
610cd5c6 | 164 | authentication. |
165 | The server checks if this key is permitted, and if | |
bf740959 | 166 | so, sends the user (actually the |
167 | .Nm | |
168 | program running on behalf of the user) a challenge, a random number, | |
610cd5c6 | 169 | encrypted by the user's public key. |
170 | The challenge can only be | |
171 | decrypted using the proper private key. | |
172 | The user's client then decrypts the | |
bf740959 | 173 | challenge using the private key, proving that he/she knows the private |
174 | key but without disclosing it to the server. | |
175 | .Pp | |
176 | .Nm | |
610cd5c6 | 177 | implements the RSA authentication protocol automatically. |
178 | The user creates his/her RSA key pair by running | |
bf740959 | 179 | .Xr ssh-keygen 1 . |
f54651ce | 180 | This stores the private key in |
1d1ffb87 | 181 | .Pa $HOME/.ssh/identity |
bf740959 | 182 | and the public key in |
1d1ffb87 | 183 | .Pa $HOME/.ssh/identity.pub |
610cd5c6 | 184 | in the user's home directory. |
185 | The user should then copy the | |
bf740959 | 186 | .Pa identity.pub |
f54651ce | 187 | to |
1d1ffb87 | 188 | .Pa $HOME/.ssh/authorized_keys |
f54651ce | 189 | in his/her home directory on the remote machine (the |
bf740959 | 190 | .Pa authorized_keys |
f54651ce | 191 | file corresponds to the conventional |
1d1ffb87 | 192 | .Pa $HOME/.rhosts |
bf740959 | 193 | file, and has one key |
610cd5c6 | 194 | per line, though the lines can be very long). |
195 | After this, the user can log in without giving the password. | |
196 | RSA authentication is much | |
bf740959 | 197 | more secure than rhosts authentication. |
198 | .Pp | |
199 | The most convenient way to use RSA authentication may be with an | |
610cd5c6 | 200 | authentication agent. |
201 | See | |
bf740959 | 202 | .Xr ssh-agent 1 |
203 | for more information. | |
204 | .Pp | |
f54651ce | 205 | If other authentication methods fail, |
bf740959 | 206 | .Nm |
610cd5c6 | 207 | prompts the user for a password. |
208 | The password is sent to the remote | |
bf740959 | 209 | host for checking; however, since all communications are encrypted, |
210 | the password cannot be seen by someone listening on the network. | |
211 | .Pp | |
1d1ffb87 | 212 | .Ss SSH protocol version 2 |
213 | .Pp | |
16210ef7 | 214 | When a user connects using protocol version 2 |
215 | similar authentication methods are available. | |
da89cf4d | 216 | Using the default values for |
217 | .Cm PreferredAuthentications , | |
29c440a0 | 218 | the client will try to authenticate first using the hostbased method; |
219 | if this method fails public key authentication is attempted, | |
220 | and finally if this method fails keyboard-interactive and | |
221 | password authentication are tried. | |
1d1ffb87 | 222 | .Pp |
223 | The public key method is similar to RSA authentication described | |
da89cf4d | 224 | in the previous section and allows the RSA or DSA algorithm to be used: |
c0ecc314 | 225 | The client uses his private key, |
1d1ffb87 | 226 | .Pa $HOME/.ssh/id_dsa |
c0ecc314 | 227 | or |
228 | .Pa $HOME/.ssh/id_rsa , | |
1d1ffb87 | 229 | to sign the session identifier and sends the result to the server. |
230 | The server checks whether the matching public key is listed in | |
96a7b0cc | 231 | .Pa $HOME/.ssh/authorized_keys |
1d1ffb87 | 232 | and grants access if both the key is found and the signature is correct. |
233 | The session identifier is derived from a shared Diffie-Hellman value | |
234 | and is only known to the client and the server. | |
235 | .Pp | |
236 | If public key authentication fails or is not available a password | |
237 | can be sent encrypted to the remote host for proving the user's identity. | |
da89cf4d | 238 | .Pp |
239 | Additionally, | |
240 | .Nm | |
241 | supports hostbased or challenge response authentication. | |
1d1ffb87 | 242 | .Pp |
243 | Protocol 2 provides additional mechanisms for confidentiality | |
d0c832f3 | 244 | (the traffic is encrypted using 3DES, Blowfish, CAST128 or Arcfour) |
f2ba0775 | 245 | and integrity (hmac-md5, hmac-sha1). |
1d1ffb87 | 246 | Note that protocol 1 lacks a strong mechanism for ensuring the |
247 | integrity of the connection. | |
248 | .Pp | |
249 | .Ss Login session and remote execution | |
250 | .Pp | |
bf740959 | 251 | When the user's identity has been accepted by the server, the server |
252 | either executes the given command, or logs into the machine and gives | |
610cd5c6 | 253 | the user a normal shell on the remote machine. |
254 | All communication with | |
bf740959 | 255 | the remote command or shell will be automatically encrypted. |
256 | .Pp | |
257 | If a pseudo-terminal has been allocated (normal login session), the | |
df841692 | 258 | user may use the escape characters noted below. |
bf740959 | 259 | .Pp |
260 | If no pseudo tty has been allocated, the | |
261 | session is transparent and can be used to reliably transfer binary | |
610cd5c6 | 262 | data. |
263 | On most systems, setting the escape character to | |
bf740959 | 264 | .Dq none |
265 | will also make the session transparent even if a tty is used. | |
266 | .Pp | |
ce9c0b75 | 267 | The session terminates when the command or shell on the remote |
e91c60f2 | 268 | machine exits and all X11 and TCP/IP connections have been closed. |
bf740959 | 269 | The exit status of the remote program is returned as the exit status |
270 | of | |
271 | .Nm ssh . | |
272 | .Pp | |
df841692 | 273 | .Ss Escape Characters |
274 | .Pp | |
275 | When a pseudo terminal has been requested, ssh supports a number of functions | |
3730bb22 | 276 | through the use of an escape character. |
df841692 | 277 | .Pp |
278 | A single tilde character can be sent as | |
279 | .Ic ~~ | |
5bef3c35 | 280 | or by following the tilde by a character other than those described below. |
df841692 | 281 | The escape character must always follow a newline to be interpreted as |
282 | special. | |
283 | The escape character can be changed in configuration files using the | |
284 | .Cm EscapeChar | |
3730bb22 | 285 | configuration directive or on the command line by the |
df841692 | 286 | .Fl e |
287 | option. | |
288 | .Pp | |
289 | The supported escapes (assuming the default | |
290 | .Ql ~ ) | |
291 | are: | |
292 | .Bl -tag -width Ds | |
293 | .It Cm ~. | |
294 | Disconnect | |
295 | .It Cm ~^Z | |
296 | Background ssh | |
297 | .It Cm ~# | |
298 | List forwarded connections | |
299 | .It Cm ~& | |
300 | Background ssh at logout when waiting for forwarded connection / X11 sessions | |
03cf595c | 301 | to terminate |
df841692 | 302 | .It Cm ~? |
303 | Display a list of escape characters | |
c53c54c2 | 304 | .It Cm ~C |
305 | Open command line (only useful for adding port forwardings using the | |
306 | .Fl L | |
307 | and | |
308 | .Fl R | |
309 | options) | |
df841692 | 310 | .It Cm ~R |
67b964a1 | 311 | Request rekeying of the connection (only useful for SSH protocol version 2 |
312 | and if the peer supports it) | |
df841692 | 313 | .El |
314 | .Pp | |
1d1ffb87 | 315 | .Ss X11 and TCP forwarding |
316 | .Pp | |
6efa3d14 | 317 | If the |
318 | .Cm ForwardX11 | |
319 | variable is set to | |
320 | .Dq yes | |
321 | (or, see the description of the | |
322 | .Fl X | |
323 | and | |
324 | .Fl x | |
325 | options described later) | |
326 | and the user is using X11 (the | |
bf740959 | 327 | .Ev DISPLAY |
328 | environment variable is set), the connection to the X11 display is | |
329 | automatically forwarded to the remote side in such a way that any X11 | |
330 | programs started from the shell (or command) will go through the | |
331 | encrypted channel, and the connection to the real X server will be made | |
610cd5c6 | 332 | from the local machine. |
333 | The user should not manually set | |
bf740959 | 334 | .Ev DISPLAY . |
335 | Forwarding of X11 connections can be | |
336 | configured on the command line or in configuration files. | |
337 | .Pp | |
338 | The | |
f54651ce | 339 | .Ev DISPLAY |
bf740959 | 340 | value set by |
341 | .Nm | |
342 | will point to the server machine, but with a display number greater | |
610cd5c6 | 343 | than zero. |
344 | This is normal, and happens because | |
bf740959 | 345 | .Nm |
346 | creates a | |
347 | .Dq proxy | |
348 | X server on the server machine for forwarding the | |
349 | connections over the encrypted channel. | |
350 | .Pp | |
351 | .Nm | |
352 | will also automatically set up Xauthority data on the server machine. | |
353 | For this purpose, it will generate a random authorization cookie, | |
354 | store it in Xauthority on the server, and verify that any forwarded | |
355 | connections carry this cookie and replace it by the real cookie when | |
610cd5c6 | 356 | the connection is opened. |
357 | The real authentication cookie is never | |
bf740959 | 358 | sent to the server machine (and no cookies are sent in the plain). |
359 | .Pp | |
24794905 | 360 | If the |
361 | .Cm ForwardAgent | |
362 | variable is set to | |
363 | .Dq yes | |
364 | (or, see the description of the | |
365 | .Fl A | |
366 | and | |
367 | .Fl a | |
a4e5acef | 368 | options described later) and |
24794905 | 369 | the user is using an authentication agent, the connection to the agent |
370 | is automatically forwarded to the remote side. | |
bf740959 | 371 | .Pp |
372 | Forwarding of arbitrary TCP/IP connections over the secure channel can | |
491f5f7b | 373 | be specified either on the command line or in a configuration file. |
610cd5c6 | 374 | One possible application of TCP/IP forwarding is a secure connection to an |
e91c60f2 | 375 | electronic purse; another is going through firewalls. |
bf740959 | 376 | .Pp |
1d1ffb87 | 377 | .Ss Server authentication |
378 | .Pp | |
bf740959 | 379 | .Nm |
1d1ffb87 | 380 | automatically maintains and checks a database containing |
610cd5c6 | 381 | identifications for all hosts it has ever been used with. |
f49bc4f7 | 382 | Host keys are stored in |
1d1ffb87 | 383 | .Pa $HOME/.ssh/known_hosts |
610cd5c6 | 384 | in the user's home directory. |
f49bc4f7 | 385 | Additionally, the file |
2a8a6488 | 386 | .Pa /etc/ssh/ssh_known_hosts |
f49bc4f7 | 387 | is automatically checked for known hosts. |
610cd5c6 | 388 | Any new hosts are automatically added to the user's file. |
389 | If a host's identification | |
bf740959 | 390 | ever changes, |
391 | .Nm | |
392 | warns about this and disables password authentication to prevent a | |
610cd5c6 | 393 | trojan horse from getting the user's password. |
394 | Another purpose of | |
bf740959 | 395 | this mechanism is to prevent man-in-the-middle attacks which could |
610cd5c6 | 396 | otherwise be used to circumvent the encryption. |
397 | The | |
bf740959 | 398 | .Cm StrictHostKeyChecking |
588df31a | 399 | option can be used to prevent logins to machines whose |
bf740959 | 400 | host key is not known or has changed. |
fa08c86b | 401 | .Pp |
402 | The options are as follows: | |
bf740959 | 403 | .Bl -tag -width Ds |
404 | .It Fl a | |
4fe2af09 | 405 | Disables forwarding of the authentication agent connection. |
71276795 | 406 | .It Fl A |
407 | Enables forwarding of the authentication agent connection. | |
408 | This can also be specified on a per-host basis in a configuration file. | |
07d688d5 | 409 | .Pp |
a4e5acef | 410 | Agent forwarding should be enabled with caution. |
411 | Users with the ability to bypass file permissions on the remote host | |
412 | (for the agent's Unix-domain socket) | |
413 | can access the local agent through the forwarded connection. | |
414 | An attacker cannot obtain key material from the agent, | |
07d688d5 | 415 | however they can perform operations on the keys that enable them to |
416 | authenticate using the identities loaded into the agent. | |
3435f5a6 | 417 | .It Fl b Ar bind_address |
418 | Specify the interface to transmit from on machines with multiple | |
419 | interfaces or aliased addresses. | |
29999e54 | 420 | .It Fl c Ar blowfish|3des|des |
f54651ce | 421 | Selects the cipher to use for encrypting the session. |
bf740959 | 422 | .Ar 3des |
610cd5c6 | 423 | is used by default. |
f54651ce | 424 | It is believed to be secure. |
bf740959 | 425 | .Ar 3des |
426 | (triple-des) is an encrypt-decrypt-encrypt triple with three different keys. | |
bf740959 | 427 | .Ar blowfish |
428 | is a fast block cipher, it appears very secure and is much faster than | |
610cd5c6 | 429 | .Ar 3des . |
29999e54 | 430 | .Ar des |
431 | is only supported in the | |
432 | .Nm | |
433 | client for interoperability with legacy protocol 1 implementations | |
434 | that do not support the | |
435 | .Ar 3des | |
a4e5acef | 436 | cipher. |
437 | Its use is strongly discouraged due to cryptographic weaknesses. | |
9afadca8 | 438 | .It Fl c Ar cipher_spec |
d0c832f3 | 439 | Additionally, for protocol version 2 a comma-separated list of ciphers can |
94ec8c6b | 440 | be specified in order of preference. |
9afadca8 | 441 | See |
442 | .Cm Ciphers | |
443 | for more information. | |
bf740959 | 444 | .It Fl e Ar ch|^ch|none |
445 | Sets the escape character for sessions with a pty (default: | |
446 | .Ql ~ ) . | |
610cd5c6 | 447 | The escape character is only recognized at the beginning of a line. |
448 | The escape character followed by a dot | |
bf740959 | 449 | .Pq Ql \&. |
450 | closes the connection, followed | |
451 | by control-Z suspends the connection, and followed by itself sends the | |
610cd5c6 | 452 | escape character once. |
453 | Setting the character to | |
bf740959 | 454 | .Dq none |
455 | disables any escapes and makes the session fully transparent. | |
456 | .It Fl f | |
457 | Requests | |
458 | .Nm | |
610cd5c6 | 459 | to go to background just before command execution. |
460 | This is useful if | |
bf740959 | 461 | .Nm |
462 | is going to ask for passwords or passphrases, but the user | |
610cd5c6 | 463 | wants it in the background. |
f54651ce | 464 | This implies |
bf740959 | 465 | .Fl n . |
466 | The recommended way to start X11 programs at a remote site is with | |
467 | something like | |
468 | .Ic ssh -f host xterm . | |
7b2ea3a1 | 469 | .It Fl g |
470 | Allows remote hosts to connect to local forwarded ports. | |
bf740959 | 471 | .It Fl i Ar identity_file |
cf5a07a8 | 472 | Selects a file from which the identity (private key) for |
fa08c86b | 473 | RSA or DSA authentication is read. |
cf5a07a8 | 474 | The default is |
1d1ffb87 | 475 | .Pa $HOME/.ssh/identity |
cf5a07a8 | 476 | for protocol version 1, and |
477 | .Pa $HOME/.ssh/id_rsa | |
478 | and | |
479 | .Pa $HOME/.ssh/id_dsa | |
480 | for protocol version 2. | |
610cd5c6 | 481 | Identity files may also be specified on |
482 | a per-host basis in the configuration file. | |
483 | It is possible to have multiple | |
bf740959 | 484 | .Fl i |
485 | options (and multiple identities specified in | |
486 | configuration files). | |
eea098a3 | 487 | .It Fl I Ar smartcard_device |
488 | Specifies which smartcard device to use. The argument is | |
489 | the device | |
490 | .Nm | |
491 | should use to communicate with a smartcard used for storing the user's | |
492 | private RSA key. | |
bf740959 | 493 | .It Fl k |
4fe2af09 | 494 | Disables forwarding of Kerberos tickets and AFS tokens. |
495 | This may also be specified on a per-host basis in the configuration file. | |
bf740959 | 496 | .It Fl l Ar login_name |
610cd5c6 | 497 | Specifies the user to log in as on the remote machine. |
498 | This also may be specified on a per-host basis in the configuration file. | |
b2552997 | 499 | .It Fl m Ar mac_spec |
500 | Additionally, for protocol version 2 a comma-separated list of MAC | |
501 | (message authentication code) algorithms can | |
502 | be specified in order of preference. | |
503 | See the | |
504 | .Cm MACs | |
505 | keyword for more information. | |
bf740959 | 506 | .It Fl n |
507 | Redirects stdin from | |
508 | .Pa /dev/null | |
509 | (actually, prevents reading from stdin). | |
510 | This must be used when | |
511 | .Nm | |
610cd5c6 | 512 | is run in the background. |
513 | A common trick is to use this to run X11 programs on a remote machine. | |
514 | For example, | |
bf740959 | 515 | .Ic ssh -n shadows.cs.hut.fi emacs & |
516 | will start an emacs on shadows.cs.hut.fi, and the X11 | |
517 | connection will be automatically forwarded over an encrypted channel. | |
518 | The | |
519 | .Nm | |
520 | program will be put in the background. | |
521 | (This does not work if | |
522 | .Nm | |
523 | needs to ask for a password or passphrase; see also the | |
524 | .Fl f | |
525 | option.) | |
0e73cc53 | 526 | .It Fl N |
527 | Do not execute a remote command. | |
91789042 | 528 | This is useful for just forwarding ports |
0e73cc53 | 529 | (protocol version 2 only). |
bf740959 | 530 | .It Fl o Ar option |
38539909 | 531 | Can be used to give options in the format used in the configuration file. |
bf740959 | 532 | This is useful for specifying options for which there is no separate |
610cd5c6 | 533 | command-line flag. |
bf740959 | 534 | .It Fl p Ar port |
610cd5c6 | 535 | Port to connect to on the remote host. |
536 | This can be specified on a | |
bf740959 | 537 | per-host basis in the configuration file. |
bf740959 | 538 | .It Fl q |
610cd5c6 | 539 | Quiet mode. |
540 | Causes all warning and diagnostic messages to be suppressed. | |
ae810de7 | 541 | .It Fl s |
3730bb22 | 542 | May be used to request invocation of a subsystem on the remote system. Subsystems are a feature of the SSH2 protocol which facilitate the use |
543 | of SSH as a secure transport for other applications (eg. sftp). The | |
ae810de7 | 544 | subsystem is specified as the remote command. |
bf740959 | 545 | .It Fl t |
610cd5c6 | 546 | Force pseudo-tty allocation. |
4fe2af09 | 547 | This can be used to execute arbitrary |
610cd5c6 | 548 | screen-based programs on a remote machine, which can be very useful, |
549 | e.g., when implementing menu services. | |
8abcdba4 | 550 | Multiple |
551 | .Fl t | |
552 | options force tty allocation, even if | |
553 | .Nm | |
554 | has no local tty. | |
0e73cc53 | 555 | .It Fl T |
0b6fbf03 | 556 | Disable pseudo-tty allocation. |
bf740959 | 557 | .It Fl v |
610cd5c6 | 558 | Verbose mode. |
559 | Causes | |
bf740959 | 560 | .Nm |
610cd5c6 | 561 | to print debugging messages about its progress. |
562 | This is helpful in | |
bf740959 | 563 | debugging connection, authentication, and configuration problems. |
8abcdba4 | 564 | Multiple |
565 | .Fl v | |
566 | options increases the verbosity. | |
94ec8c6b | 567 | Maximum is 3. |
bf740959 | 568 | .It Fl x |
610cd5c6 | 569 | Disables X11 forwarding. |
bf740959 | 570 | .It Fl X |
571 | Enables X11 forwarding. | |
71276795 | 572 | This can also be specified on a per-host basis in a configuration file. |
07d688d5 | 573 | .Pp |
a4e5acef | 574 | X11 forwarding should be enabled with caution. |
575 | Users with the ability to bypass file permissions on the remote host | |
576 | (for the user's X authorization database) | |
577 | can access the local X11 display through the forwarded connection. | |
578 | An attacker may then be able to perform activities such as keystroke monitoring. | |
bf740959 | 579 | .It Fl C |
580 | Requests compression of all data (including stdin, stdout, stderr, and | |
610cd5c6 | 581 | data for forwarded X11 and TCP/IP connections). |
582 | The compression algorithm is the same used by | |
7b2ea3a1 | 583 | .Xr gzip 1 , |
584 | and the | |
bf740959 | 585 | .Dq level |
586 | can be controlled by the | |
587 | .Cm CompressionLevel | |
05960cf0 | 588 | option for protocol version 1. |
610cd5c6 | 589 | Compression is desirable on modem lines and other |
bf740959 | 590 | slow connections, but will only slow down things on fast networks. |
591 | The default value can be set on a host-by-host basis in the | |
592 | configuration files; see the | |
0aea6c59 | 593 | .Cm Compression |
588df31a | 594 | option. |
e591b98a | 595 | .It Fl F Ar configfile |
596 | Specifies an alternative per-user configuration file. | |
597 | If a configuration file is given on the command line, | |
598 | the system-wide configuration file | |
2a8a6488 | 599 | .Pq Pa /etc/ssh/ssh_config |
e591b98a | 600 | will be ignored. |
601 | The default for the per-user configuration file is | |
602 | .Pa $HOME/.ssh/config . | |
bf740959 | 603 | .It Fl L Ar port:host:hostport |
604 | Specifies that the given port on the local (client) host is to be | |
610cd5c6 | 605 | forwarded to the given host and port on the remote side. |
606 | This works by allocating a socket to listen to | |
bf740959 | 607 | .Ar port |
608 | on the local side, and whenever a connection is made to this port, the | |
609 | connection is forwarded over the secure channel, and a connection is | |
610 | made to | |
48e671d5 | 611 | .Ar host |
612 | port | |
613 | .Ar hostport | |
610cd5c6 | 614 | from the remote machine. |
615 | Port forwardings can also be specified in the configuration file. | |
616 | Only root can forward privileged ports. | |
48e671d5 | 617 | IPv6 addresses can be specified with an alternative syntax: |
618 | .Ar port/host/hostport | |
bf740959 | 619 | .It Fl R Ar port:host:hostport |
620 | Specifies that the given port on the remote (server) host is to be | |
610cd5c6 | 621 | forwarded to the given host and port on the local side. |
622 | This works by allocating a socket to listen to | |
bf740959 | 623 | .Ar port |
624 | on the remote side, and whenever a connection is made to this port, the | |
625 | connection is forwarded over the secure channel, and a connection is | |
626 | made to | |
48e671d5 | 627 | .Ar host |
628 | port | |
629 | .Ar hostport | |
610cd5c6 | 630 | from the local machine. |
631 | Port forwardings can also be specified in the configuration file. | |
632 | Privileged ports can be forwarded only when | |
bf740959 | 633 | logging in as root on the remote machine. |
da89cf4d | 634 | IPv6 addresses can be specified with an alternative syntax: |
635 | .Ar port/host/hostport | |
4c780c2a | 636 | .It Fl D Ar port |
637 | Specifies a local | |
638 | .Dq dynamic | |
639 | application-level port forwarding. | |
640 | This works by allocating a socket to listen to | |
641 | .Ar port | |
642 | on the local side, and whenever a connection is made to this port, the | |
643 | connection is forwarded over the secure channel, and the application | |
644 | protocol is then used to determine where to connect to from the | |
a4e5acef | 645 | remote machine. |
646 | Currently the SOCKS4 protocol is supported, and | |
4c780c2a | 647 | .Nm |
648 | will act as a SOCKS4 server. | |
649 | Only root can forward privileged ports. | |
650 | Dynamic port forwardings can also be specified in the configuration file. | |
9afadca8 | 651 | .It Fl 1 |
652 | Forces | |
653 | .Nm | |
654 | to try protocol version 1 only. | |
6ae2364d | 655 | .It Fl 2 |
656 | Forces | |
657 | .Nm | |
1d1ffb87 | 658 | to try protocol version 2 only. |
48e671d5 | 659 | .It Fl 4 |
660 | Forces | |
661 | .Nm | |
662 | to use IPv4 addresses only. | |
663 | .It Fl 6 | |
664 | Forces | |
665 | .Nm | |
666 | to use IPv6 addresses only. | |
bf740959 | 667 | .El |
668 | .Sh CONFIGURATION FILES | |
669 | .Nm | |
588df31a | 670 | may additionally obtain configuration data from |
671 | a per-user configuration file and a system-wide configuration file. | |
672 | The file format and configuration options are described in | |
673 | .Xr ssh_config 5 . | |
bf740959 | 674 | .Sh ENVIRONMENT |
675 | .Nm | |
676 | will normally set the following environment variables: | |
677 | .Bl -tag -width Ds | |
678 | .It Ev DISPLAY | |
679 | The | |
680 | .Ev DISPLAY | |
610cd5c6 | 681 | variable indicates the location of the X11 server. |
f54651ce | 682 | It is automatically set by |
bf740959 | 683 | .Nm |
684 | to point to a value of the form | |
685 | .Dq hostname:n | |
686 | where hostname indicates | |
610cd5c6 | 687 | the host where the shell runs, and n is an integer >= 1. |
688 | .Nm | |
689 | uses this special value to forward X11 connections over the secure | |
690 | channel. | |
da89cf4d | 691 | The user should normally not set |
692 | .Ev DISPLAY | |
693 | explicitly, as that | |
bf740959 | 694 | will render the X11 connection insecure (and will require the user to |
695 | manually copy any required authorization cookies). | |
696 | .It Ev HOME | |
697 | Set to the path of the user's home directory. | |
698 | .It Ev LOGNAME | |
699 | Synonym for | |
700 | .Ev USER ; | |
701 | set for compatibility with systems that use this variable. | |
702 | .It Ev MAIL | |
ae897d7c | 703 | Set to the path of the user's mailbox. |
610cd5c6 | 704 | .It Ev PATH |
bf740959 | 705 | Set to the default |
706 | .Ev PATH , | |
707 | as specified when compiling | |
708 | .Nm ssh . | |
3474b2b4 | 709 | .It Ev SSH_ASKPASS |
710 | If | |
711 | .Nm | |
712 | needs a passphrase, it will read the passphrase from the current | |
713 | terminal if it was run from a terminal. | |
714 | If | |
715 | .Nm | |
716 | does not have a terminal associated with it but | |
717 | .Ev DISPLAY | |
718 | and | |
719 | .Ev SSH_ASKPASS | |
720 | are set, it will execute the program specified by | |
721 | .Ev SSH_ASKPASS | |
722 | and open an X11 window to read the passphrase. | |
723 | This is particularly useful when calling | |
724 | .Nm | |
725 | from a | |
726 | .Pa .Xsession | |
727 | or related script. | |
728 | (Note that on some machines it | |
729 | may be necessary to redirect the input from | |
730 | .Pa /dev/null | |
731 | to make this work.) | |
bf740959 | 732 | .It Ev SSH_AUTH_SOCK |
ae897d7c | 733 | Identifies the path of a unix-domain socket used to communicate with the |
bf740959 | 734 | agent. |
da0561eb | 735 | .It Ev SSH_CONNECTION |
736 | Identifies the client and server ends of the connection. | |
610cd5c6 | 737 | The variable contains |
da0561eb | 738 | four space-separated values: client ip-address, client port number, |
739 | server ip-address and server port number. | |
8abcdba4 | 740 | .It Ev SSH_ORIGINAL_COMMAND |
741 | The variable contains the original command line if a forced command | |
742 | is executed. | |
743 | It can be used to extract the original arguments. | |
bf740959 | 744 | .It Ev SSH_TTY |
745 | This is set to the name of the tty (path to the device) associated | |
610cd5c6 | 746 | with the current shell or command. |
747 | If the current session has no tty, | |
bf740959 | 748 | this variable is not set. |
749 | .It Ev TZ | |
750 | The timezone variable is set to indicate the present timezone if it | |
c345cf9d | 751 | was set when the daemon was started (i.e., the daemon passes the value |
bf740959 | 752 | on to new connections). |
753 | .It Ev USER | |
754 | Set to the name of the user logging in. | |
755 | .El | |
756 | .Pp | |
f54651ce | 757 | Additionally, |
bf740959 | 758 | .Nm |
f54651ce | 759 | reads |
760 | .Pa $HOME/.ssh/environment , | |
bf740959 | 761 | and adds lines of the format |
762 | .Dq VARNAME=value | |
6a342527 | 763 | to the environment if the file exists and if users are allowed to |
764 | change their environment. | |
35453849 | 765 | See the |
6a342527 | 766 | .Cm PermitUserEnvironment |
35453849 | 767 | option in |
6a342527 | 768 | .Xr sshd_config 5 . |
bf740959 | 769 | .Sh FILES |
c8d54615 | 770 | .Bl -tag -width Ds |
f49bc4f7 | 771 | .It Pa $HOME/.ssh/known_hosts |
ae897d7c | 772 | Records host keys for all hosts the user has logged into that are not |
bf740959 | 773 | in |
2a8a6488 | 774 | .Pa /etc/ssh/ssh_known_hosts . |
bf740959 | 775 | See |
776 | .Xr sshd 8 . | |
c0ecc314 | 777 | .It Pa $HOME/.ssh/identity, $HOME/.ssh/id_dsa, $HOME/.ssh/id_rsa |
778 | Contains the authentication identity of the user. | |
779 | They are for protocol 1 RSA, protocol 2 DSA, and protocol 2 RSA, respectively. | |
1d1ffb87 | 780 | These files |
781 | contain sensitive data and should be readable by the user but not | |
bf740959 | 782 | accessible by others (read/write/execute). |
783 | Note that | |
784 | .Nm | |
1d1ffb87 | 785 | ignores a private key file if it is accessible by others. |
bf740959 | 786 | It is possible to specify a passphrase when |
787 | generating the key; the passphrase will be used to encrypt the | |
788 | sensitive part of this file using 3DES. | |
c0ecc314 | 789 | .It Pa $HOME/.ssh/identity.pub, $HOME/.ssh/id_dsa.pub, $HOME/.ssh/id_rsa.pub |
bf740959 | 790 | Contains the public key for authentication (public part of the |
610cd5c6 | 791 | identity file in human-readable form). |
1d1ffb87 | 792 | The contents of the |
793 | .Pa $HOME/.ssh/identity.pub | |
794 | file should be added to | |
bf740959 | 795 | .Pa $HOME/.ssh/authorized_keys |
796 | on all machines | |
91789042 | 797 | where the user wishes to log in using protocol version 1 RSA authentication. |
1d1ffb87 | 798 | The contents of the |
799 | .Pa $HOME/.ssh/id_dsa.pub | |
c0ecc314 | 800 | and |
801 | .Pa $HOME/.ssh/id_rsa.pub | |
1d1ffb87 | 802 | file should be added to |
96a7b0cc | 803 | .Pa $HOME/.ssh/authorized_keys |
1d1ffb87 | 804 | on all machines |
91789042 | 805 | where the user wishes to log in using protocol version 2 DSA/RSA authentication. |
1d1ffb87 | 806 | These files are not |
610cd5c6 | 807 | sensitive and can (but need not) be readable by anyone. |
1d1ffb87 | 808 | These files are |
c44559d2 | 809 | never used automatically and are not necessary; they are only provided for |
bf740959 | 810 | the convenience of the user. |
811 | .It Pa $HOME/.ssh/config | |
610cd5c6 | 812 | This is the per-user configuration file. |
588df31a | 813 | The file format and configuration options are described in |
814 | .Xr ssh_config 5 . | |
bf740959 | 815 | .It Pa $HOME/.ssh/authorized_keys |
96a7b0cc | 816 | Lists the public keys (RSA/DSA) that can be used for logging in as this user. |
610cd5c6 | 817 | The format of this file is described in the |
bf740959 | 818 | .Xr sshd 8 |
610cd5c6 | 819 | manual page. |
f49bc4f7 | 820 | In the simplest form the format is the same as the .pub |
821 | identity files. | |
1d1ffb87 | 822 | This file is not highly sensitive, but the recommended |
823 | permissions are read/write for the user, and not accessible by others. | |
2a8a6488 | 824 | .It Pa /etc/ssh/ssh_known_hosts |
610cd5c6 | 825 | Systemwide list of known host keys. |
f49bc4f7 | 826 | This file should be prepared by the |
bf740959 | 827 | system administrator to contain the public host keys of all machines in the |
610cd5c6 | 828 | organization. |
829 | This file should be world-readable. | |
830 | This file contains | |
bf740959 | 831 | public keys, one per line, in the following format (fields separated |
f49bc4f7 | 832 | by spaces): system name, public key and optional comment field. |
610cd5c6 | 833 | When different names are used |
bf740959 | 834 | for the same machine, all such names should be listed, separated by |
610cd5c6 | 835 | commas. |
836 | The format is described on the | |
bf740959 | 837 | .Xr sshd 8 |
838 | manual page. | |
839 | .Pp | |
840 | The canonical system name (as returned by name servers) is used by | |
841 | .Xr sshd 8 | |
842 | to verify the client host when logging in; other names are needed because | |
843 | .Nm | |
844 | does not convert the user-supplied name to a canonical name before | |
845 | checking the key, because someone with access to the name servers | |
846 | would then be able to fool host authentication. | |
2a8a6488 | 847 | .It Pa /etc/ssh/ssh_config |
610cd5c6 | 848 | Systemwide configuration file. |
588df31a | 849 | The file format and configuration options are described in |
850 | .Xr ssh_config 5 . | |
2a8a6488 | 851 | .It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key |
dd58cb5e | 852 | These three files contain the private parts of the host keys |
853 | and are used for | |
854 | .Cm RhostsRSAAuthentication | |
855 | and | |
856 | .Cm HostbasedAuthentication . | |
d83cbdc3 | 857 | If the protocol version 1 |
858 | .Cm RhostsRSAAuthentication | |
7203d6bb | 859 | method is used, |
d83cbdc3 | 860 | .Nm |
861 | must be setuid root, since the host key is readable only by root. | |
862 | For protocol version 2, | |
863 | .Nm | |
864 | uses | |
865 | .Xr ssh-keysign 8 | |
866 | to access the host keys for | |
867 | .Cm HostbasedAuthentication . | |
868 | This eliminates the requirement that | |
869 | .Nm | |
870 | be setuid root when that authentication method is used. | |
871 | By default | |
dd58cb5e | 872 | .Nm |
d83cbdc3 | 873 | is not setuid root. |
bf740959 | 874 | .It Pa $HOME/.rhosts |
875 | This file is used in | |
876 | .Pa \&.rhosts | |
877 | authentication to list the | |
610cd5c6 | 878 | host/user pairs that are permitted to log in. |
879 | (Note that this file is | |
bf740959 | 880 | also used by rlogin and rsh, which makes using this file insecure.) |
881 | Each line of the file contains a host name (in the canonical form | |
882 | returned by name servers), and then a user name on that host, | |
610cd5c6 | 883 | separated by a space. |
e91c60f2 | 884 | On some machines this file may need to be |
bf740959 | 885 | world-readable if the user's home directory is on a NFS partition, |
886 | because | |
887 | .Xr sshd 8 | |
610cd5c6 | 888 | reads it as root. |
889 | Additionally, this file must be owned by the user, | |
890 | and must not have write permissions for anyone else. | |
891 | The recommended | |
bf740959 | 892 | permission for most machines is read/write for the user, and not |
893 | accessible by others. | |
894 | .Pp | |
895 | Note that by default | |
896 | .Xr sshd 8 | |
897 | will be installed so that it requires successful RSA host | |
610cd5c6 | 898 | authentication before permitting \s+2.\s0rhosts authentication. |
91789042 | 899 | If the server machine does not have the client's host key in |
2a8a6488 | 900 | .Pa /etc/ssh/ssh_known_hosts , |
91789042 | 901 | it can be stored in |
bf740959 | 902 | .Pa $HOME/.ssh/known_hosts . |
903 | The easiest way to do this is to | |
904 | connect back to the client from the server machine using ssh; this | |
1d1ffb87 | 905 | will automatically add the host key to |
bf740959 | 906 | .Pa $HOME/.ssh/known_hosts . |
907 | .It Pa $HOME/.shosts | |
908 | This file is used exactly the same way as | |
909 | .Pa \&.rhosts . | |
910 | The purpose for | |
911 | having this file is to be able to use rhosts authentication with | |
912 | .Nm | |
913 | without permitting login with | |
7e276482 | 914 | .Nm rlogin |
bf740959 | 915 | or |
916 | .Xr rsh 1 . | |
917 | .It Pa /etc/hosts.equiv | |
918 | This file is used during | |
610cd5c6 | 919 | .Pa \&.rhosts authentication. |
920 | It contains | |
bf740959 | 921 | canonical hosts names, one per line (the full format is described on |
922 | the | |
923 | .Xr sshd 8 | |
610cd5c6 | 924 | manual page). |
925 | If the client host is found in this file, login is | |
bf740959 | 926 | automatically permitted provided client and server user names are the |
610cd5c6 | 927 | same. |
928 | Additionally, successful RSA host authentication is normally | |
929 | required. | |
930 | This file should only be writable by root. | |
5f4fdfae | 931 | .It Pa /etc/shosts.equiv |
f54651ce | 932 | This file is processed exactly as |
bf740959 | 933 | .Pa /etc/hosts.equiv . |
934 | This file may be useful to permit logins using | |
935 | .Nm | |
936 | but not using rsh/rlogin. | |
2a8a6488 | 937 | .It Pa /etc/ssh/sshrc |
bf740959 | 938 | Commands in this file are executed by |
939 | .Nm | |
940 | when the user logs in just before the user's shell (or command) is started. | |
941 | See the | |
942 | .Xr sshd 8 | |
943 | manual page for more information. | |
944 | .It Pa $HOME/.ssh/rc | |
945 | Commands in this file are executed by | |
946 | .Nm | |
947 | when the user logs in just before the user's shell (or command) is | |
948 | started. | |
f54651ce | 949 | See the |
bf740959 | 950 | .Xr sshd 8 |
951 | manual page for more information. | |
83b7f649 | 952 | .It Pa $HOME/.ssh/environment |
953 | Contains additional definitions for environment variables, see section | |
954 | .Sx ENVIRONMENT | |
955 | above. | |
b5e300c2 | 956 | .El |
16210ef7 | 957 | .Sh DIAGNOSTICS |
958 | .Nm | |
959 | exits with the exit status of the remote command or with 255 | |
960 | if an error occurred. | |
fa08c86b | 961 | .Sh AUTHORS |
5fb622e4 | 962 | OpenSSH is a derivative of the original and free |
963 | ssh 1.2.12 release by Tatu Ylonen. | |
964 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, | |
965 | Theo de Raadt and Dug Song | |
966 | removed many bugs, re-added newer features and | |
967 | created OpenSSH. | |
968 | Markus Friedl contributed the support for SSH | |
969 | protocol versions 1.5 and 2.0. | |
bf740959 | 970 | .Sh SEE ALSO |
bf740959 | 971 | .Xr rsh 1 , |
972 | .Xr scp 1 , | |
61e96248 | 973 | .Xr sftp 1 , |
bf740959 | 974 | .Xr ssh-add 1 , |
975 | .Xr ssh-agent 1 , | |
976 | .Xr ssh-keygen 1 , | |
977 | .Xr telnet 1 , | |
1ae02182 | 978 | .Xr ssh_config 5 , |
b2843ec6 | 979 | .Xr ssh-keysign 8 , |
9afadca8 | 980 | .Xr sshd 8 |
2cad6cef | 981 | .Rs |
982 | .%A T. Ylonen | |
983 | .%A T. Kivinen | |
984 | .%A M. Saarinen | |
985 | .%A T. Rinne | |
986 | .%A S. Lehtinen | |
987 | .%T "SSH Protocol Architecture" | |
17f5e68a | 988 | .%N draft-ietf-secsh-architecture-12.txt |
989 | .%D January 2002 | |
2cad6cef | 990 | .%O work in progress material |
991 | .Re |