]>
Commit | Line | Data |
---|---|---|
bf740959 | 1 | .\" -*- nroff -*- |
2 | .\" | |
3 | .\" ssh.1.in | |
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 21:55:14 1995 ylo | |
11 | .\" | |
12 | .\" $Id$ | |
13 | .\" | |
14 | .Dd September 25, 1999 | |
15 | .Dt SSH 1 | |
16 | .Os | |
17 | .Sh NAME | |
18 | .Nm ssh | |
19 | .Nd OpenSSH secure shell client (remote login program) | |
20 | .Sh SYNOPSIS | |
21 | .Nm ssh | |
22 | .Op Fl l Ar login_name | |
23 | .Op Ar hostname | user@hostname | |
24 | .Op Ar command | |
25 | .Pp | |
26 | .Nm ssh | |
6ae2364d | 27 | .Op Fl afgknqtvxCPX246 |
bf740959 | 28 | .Op Fl c Ar blowfish | 3des |
29 | .Op Fl e Ar escape_char | |
30 | .Op Fl i Ar identity_file | |
31 | .Op Fl l Ar login_name | |
32 | .Op Fl o Ar option | |
33 | .Op Fl p Ar port | |
34 | .Oo Fl L Xo | |
35 | .Sm off | |
bf740959 | 36 | .Ar port : |
7b2ea3a1 | 37 | .Ar host : |
bf740959 | 38 | .Ar hostport |
39 | .Sm on | |
40 | .Xc | |
41 | .Oc | |
42 | .Oo Fl R Xo | |
43 | .Sm off | |
bf740959 | 44 | .Ar port : |
7b2ea3a1 | 45 | .Ar host : |
bf740959 | 46 | .Ar hostport |
47 | .Sm on | |
48 | .Xc | |
49 | .Oc | |
50 | .Op Ar hostname | user@hostname | |
51 | .Op Ar command | |
f54651ce | 52 | .Sh DESCRIPTION |
bf740959 | 53 | .Nm |
54 | (Secure Shell) is a program for logging into a remote machine and for | |
610cd5c6 | 55 | executing commands on a remote machine. |
56 | It is intended to replace | |
bf740959 | 57 | rlogin and rsh, and provide secure encrypted communications between |
610cd5c6 | 58 | two untrusted hosts over an insecure network. |
59 | X11 connections and | |
bf740959 | 60 | arbitrary TCP/IP ports can also be forwarded over the secure channel. |
61 | .Pp | |
62 | .Nm | |
f54651ce | 63 | connects and logs into the specified |
bf740959 | 64 | .Ar hostname . |
65 | The user must prove | |
1d1ffb87 | 66 | his/her identity to the remote machine using one of several methods |
67 | depending on the protocol version used: | |
68 | .Pp | |
69 | .Ss SSH protocol version 1 | |
bf740959 | 70 | .Pp |
71 | First, if the machine the user logs in from is listed in | |
72 | .Pa /etc/hosts.equiv | |
73 | or | |
5f4fdfae | 74 | .Pa /etc/shosts.equiv |
bf740959 | 75 | on the remote machine, and the user names are |
76 | the same on both sides, the user is immediately permitted to log in. | |
f54651ce | 77 | Second, if |
bf740959 | 78 | .Pa \&.rhosts |
79 | or | |
80 | .Pa \&.shosts | |
81 | exists in the user's home directory on the | |
82 | remote machine and contains a line containing the name of the client | |
83 | machine and the name of the user on that machine, the user is | |
610cd5c6 | 84 | permitted to log in. |
85 | This form of authentication alone is normally not | |
bf740959 | 86 | allowed by the server because it is not secure. |
87 | .Pp | |
88 | The second (and primary) authentication method is the | |
89 | .Pa rhosts | |
90 | or | |
91 | .Pa hosts.equiv | |
610cd5c6 | 92 | method combined with RSA-based host authentication. |
93 | It means that if the login would be permitted by | |
1d1ffb87 | 94 | .Pa $HOME/.rhosts , |
95 | .Pa $HOME/.shosts , | |
bf740959 | 96 | .Pa /etc/hosts.equiv , |
97 | or | |
5f4fdfae | 98 | .Pa /etc/shosts.equiv , |
bf740959 | 99 | and if additionally the server can verify the client's |
f54651ce | 100 | host key (see |
5f4fdfae | 101 | .Pa /etc/ssh_known_hosts |
5bbb5681 | 102 | and |
103 | .Pa $HOME/.ssh/known_hosts | |
bf740959 | 104 | in the |
105 | .Sx FILES | |
610cd5c6 | 106 | section), only then login is permitted. |
107 | This authentication method closes security holes due to IP | |
108 | spoofing, DNS spoofing and routing spoofing. | |
109 | [Note to the administrator: | |
bf740959 | 110 | .Pa /etc/hosts.equiv , |
1d1ffb87 | 111 | .Pa $HOME/.rhosts , |
bf740959 | 112 | and the rlogin/rsh protocol in general, are inherently insecure and should be |
113 | disabled if security is desired.] | |
114 | .Pp | |
f54651ce | 115 | As a third authentication method, |
bf740959 | 116 | .Nm |
117 | supports RSA based authentication. | |
118 | The scheme is based on public-key cryptography: there are cryptosystems | |
119 | where encryption and decryption are done using separate keys, and it | |
120 | is not possible to derive the decryption key from the encryption key. | |
610cd5c6 | 121 | RSA is one such system. |
f54651ce | 122 | The idea is that each user creates a public/private |
610cd5c6 | 123 | key pair for authentication purposes. |
124 | The server knows the public key, and only the user knows the private key. | |
f54651ce | 125 | The file |
bf740959 | 126 | .Pa $HOME/.ssh/authorized_keys |
127 | lists the public keys that are permitted for logging | |
610cd5c6 | 128 | in. |
129 | When the user logs in, the | |
bf740959 | 130 | .Nm |
131 | program tells the server which key pair it would like to use for | |
610cd5c6 | 132 | authentication. |
133 | The server checks if this key is permitted, and if | |
bf740959 | 134 | so, sends the user (actually the |
135 | .Nm | |
136 | program running on behalf of the user) a challenge, a random number, | |
610cd5c6 | 137 | encrypted by the user's public key. |
138 | The challenge can only be | |
139 | decrypted using the proper private key. | |
140 | The user's client then decrypts the | |
bf740959 | 141 | challenge using the private key, proving that he/she knows the private |
142 | key but without disclosing it to the server. | |
143 | .Pp | |
144 | .Nm | |
610cd5c6 | 145 | implements the RSA authentication protocol automatically. |
146 | The user creates his/her RSA key pair by running | |
bf740959 | 147 | .Xr ssh-keygen 1 . |
f54651ce | 148 | This stores the private key in |
1d1ffb87 | 149 | .Pa $HOME/.ssh/identity |
bf740959 | 150 | and the public key in |
1d1ffb87 | 151 | .Pa $HOME/.ssh/identity.pub |
610cd5c6 | 152 | in the user's home directory. |
153 | The user should then copy the | |
bf740959 | 154 | .Pa identity.pub |
f54651ce | 155 | to |
1d1ffb87 | 156 | .Pa $HOME/.ssh/authorized_keys |
f54651ce | 157 | in his/her home directory on the remote machine (the |
bf740959 | 158 | .Pa authorized_keys |
f54651ce | 159 | file corresponds to the conventional |
1d1ffb87 | 160 | .Pa $HOME/.rhosts |
bf740959 | 161 | file, and has one key |
610cd5c6 | 162 | per line, though the lines can be very long). |
163 | After this, the user can log in without giving the password. | |
164 | RSA authentication is much | |
bf740959 | 165 | more secure than rhosts authentication. |
166 | .Pp | |
167 | The most convenient way to use RSA authentication may be with an | |
610cd5c6 | 168 | authentication agent. |
169 | See | |
bf740959 | 170 | .Xr ssh-agent 1 |
171 | for more information. | |
172 | .Pp | |
f54651ce | 173 | If other authentication methods fail, |
bf740959 | 174 | .Nm |
610cd5c6 | 175 | prompts the user for a password. |
176 | The password is sent to the remote | |
bf740959 | 177 | host for checking; however, since all communications are encrypted, |
178 | the password cannot be seen by someone listening on the network. | |
179 | .Pp | |
1d1ffb87 | 180 | .Ss SSH protocol version 2 |
181 | .Pp | |
182 | When a user connects using the protocol version 2 | |
183 | different authentication methods are available: | |
184 | At first, the client attempts to authenticate using the public key method. | |
185 | If this method fails password authentication is tried. | |
186 | .Pp | |
187 | The public key method is similar to RSA authentication described | |
188 | in the previous section except that the DSA algorithm is used | |
189 | instead of the patented RSA algorithm. | |
190 | The client uses his private DSA key | |
191 | .Pa $HOME/.ssh/id_dsa | |
192 | to sign the session identifier and sends the result to the server. | |
193 | The server checks whether the matching public key is listed in | |
194 | .Pa $HOME/.ssh/authorized_keys2 | |
195 | and grants access if both the key is found and the signature is correct. | |
196 | The session identifier is derived from a shared Diffie-Hellman value | |
197 | and is only known to the client and the server. | |
198 | .Pp | |
199 | If public key authentication fails or is not available a password | |
200 | can be sent encrypted to the remote host for proving the user's identity. | |
201 | This protocol 2 implementation does not yet support Kerberos or | |
202 | S/Key authentication. | |
203 | .Pp | |
204 | Protocol 2 provides additional mechanisms for confidentiality | |
205 | (the traffic is encrypted using 3DES, blowfish, cast128 or arcfour) | |
206 | and integrity (hmac-sha1, hmac-md5). | |
207 | Note that protocol 1 lacks a strong mechanism for ensuring the | |
208 | integrity of the connection. | |
209 | .Pp | |
210 | .Ss Login session and remote execution | |
211 | .Pp | |
bf740959 | 212 | When the user's identity has been accepted by the server, the server |
213 | either executes the given command, or logs into the machine and gives | |
610cd5c6 | 214 | the user a normal shell on the remote machine. |
215 | All communication with | |
bf740959 | 216 | the remote command or shell will be automatically encrypted. |
217 | .Pp | |
218 | If a pseudo-terminal has been allocated (normal login session), the | |
219 | user can disconnect with | |
220 | .Ic ~. , | |
221 | and suspend | |
222 | .Nm | |
223 | with | |
224 | .Ic ~^Z . | |
225 | All forwarded connections can be listed with | |
f54651ce | 226 | .Ic ~# |
bf740959 | 227 | and if |
228 | the session blocks waiting for forwarded X11 or TCP/IP | |
229 | connections to terminate, it can be backgrounded with | |
230 | .Ic ~& | |
231 | (this should not be used while the user shell is active, as it can cause the | |
610cd5c6 | 232 | shell to hang). |
233 | All available escapes can be listed with | |
bf740959 | 234 | .Ic ~? . |
235 | .Pp | |
236 | A single tilde character can be sent as | |
237 | .Ic ~~ | |
238 | (or by following the tilde by a character other than those described above). | |
239 | The escape character must always follow a newline to be interpreted as | |
610cd5c6 | 240 | special. |
241 | The escape character can be changed in configuration files | |
242 | or on the command line. | |
bf740959 | 243 | .Pp |
244 | If no pseudo tty has been allocated, the | |
245 | session is transparent and can be used to reliably transfer binary | |
610cd5c6 | 246 | data. |
247 | On most systems, setting the escape character to | |
bf740959 | 248 | .Dq none |
249 | will also make the session transparent even if a tty is used. | |
250 | .Pp | |
251 | The session terminates when the command or shell in on the remote | |
252 | machine exists and all X11 and TCP/IP connections have been closed. | |
253 | The exit status of the remote program is returned as the exit status | |
254 | of | |
255 | .Nm ssh . | |
256 | .Pp | |
1d1ffb87 | 257 | .Ss X11 and TCP forwarding |
258 | .Pp | |
bf740959 | 259 | If the user is using X11 (the |
260 | .Ev DISPLAY | |
261 | environment variable is set), the connection to the X11 display is | |
262 | automatically forwarded to the remote side in such a way that any X11 | |
263 | programs started from the shell (or command) will go through the | |
264 | encrypted channel, and the connection to the real X server will be made | |
610cd5c6 | 265 | from the local machine. |
266 | The user should not manually set | |
bf740959 | 267 | .Ev DISPLAY . |
268 | Forwarding of X11 connections can be | |
269 | configured on the command line or in configuration files. | |
270 | .Pp | |
271 | The | |
f54651ce | 272 | .Ev DISPLAY |
bf740959 | 273 | value set by |
274 | .Nm | |
275 | will point to the server machine, but with a display number greater | |
610cd5c6 | 276 | than zero. |
277 | This is normal, and happens because | |
bf740959 | 278 | .Nm |
279 | creates a | |
280 | .Dq proxy | |
281 | X server on the server machine for forwarding the | |
282 | connections over the encrypted channel. | |
283 | .Pp | |
284 | .Nm | |
285 | will also automatically set up Xauthority data on the server machine. | |
286 | For this purpose, it will generate a random authorization cookie, | |
287 | store it in Xauthority on the server, and verify that any forwarded | |
288 | connections carry this cookie and replace it by the real cookie when | |
610cd5c6 | 289 | the connection is opened. |
290 | The real authentication cookie is never | |
bf740959 | 291 | sent to the server machine (and no cookies are sent in the plain). |
292 | .Pp | |
293 | If the user is using an authentication agent, the connection to the agent | |
294 | is automatically forwarded to the remote side unless disabled on | |
295 | command line or in a configuration file. | |
296 | .Pp | |
297 | Forwarding of arbitrary TCP/IP connections over the secure channel can | |
610cd5c6 | 298 | be specified either on command line or in a configuration file. |
299 | One possible application of TCP/IP forwarding is a secure connection to an | |
bf740959 | 300 | electronic purse; another is going trough firewalls. |
301 | .Pp | |
1d1ffb87 | 302 | .Ss Server authentication |
303 | .Pp | |
bf740959 | 304 | .Nm |
1d1ffb87 | 305 | automatically maintains and checks a database containing |
610cd5c6 | 306 | identifications for all hosts it has ever been used with. |
1d1ffb87 | 307 | RSA host keys are stored in |
308 | .Pa $HOME/.ssh/known_hosts | |
309 | and | |
310 | DSA host keys are stored in | |
311 | .Pa $HOME/.ssh/known_hosts2 | |
610cd5c6 | 312 | in the user's home directory. |
1d1ffb87 | 313 | Additionally, the files |
5f4fdfae | 314 | .Pa /etc/ssh_known_hosts |
1d1ffb87 | 315 | and |
316 | .Pa /etc/ssh_known_hosts2 | |
317 | are automatically checked for known hosts. | |
610cd5c6 | 318 | Any new hosts are automatically added to the user's file. |
319 | If a host's identification | |
bf740959 | 320 | ever changes, |
321 | .Nm | |
322 | warns about this and disables password authentication to prevent a | |
610cd5c6 | 323 | trojan horse from getting the user's password. |
324 | Another purpose of | |
bf740959 | 325 | this mechanism is to prevent man-in-the-middle attacks which could |
610cd5c6 | 326 | otherwise be used to circumvent the encryption. |
327 | The | |
bf740959 | 328 | .Cm StrictHostKeyChecking |
329 | option (see below) can be used to prevent logins to machines whose | |
330 | host key is not known or has changed. | |
331 | .Sh OPTIONS | |
332 | .Bl -tag -width Ds | |
333 | .It Fl a | |
4fe2af09 | 334 | Disables forwarding of the authentication agent connection. |
335 | This may also be specified on a per-host basis in the configuration file. | |
bf740959 | 336 | .It Fl c Ar blowfish|3des |
f54651ce | 337 | Selects the cipher to use for encrypting the session. |
bf740959 | 338 | .Ar 3des |
610cd5c6 | 339 | is used by default. |
f54651ce | 340 | It is believed to be secure. |
bf740959 | 341 | .Ar 3des |
342 | (triple-des) is an encrypt-decrypt-encrypt triple with three different keys. | |
343 | It is presumably more secure than the | |
344 | .Ar des | |
345 | cipher which is no longer supported in ssh. | |
346 | .Ar blowfish | |
347 | is a fast block cipher, it appears very secure and is much faster than | |
610cd5c6 | 348 | .Ar 3des . |
bf740959 | 349 | .It Fl e Ar ch|^ch|none |
350 | Sets the escape character for sessions with a pty (default: | |
351 | .Ql ~ ) . | |
610cd5c6 | 352 | The escape character is only recognized at the beginning of a line. |
353 | The escape character followed by a dot | |
bf740959 | 354 | .Pq Ql \&. |
355 | closes the connection, followed | |
356 | by control-Z suspends the connection, and followed by itself sends the | |
610cd5c6 | 357 | escape character once. |
358 | Setting the character to | |
bf740959 | 359 | .Dq none |
360 | disables any escapes and makes the session fully transparent. | |
361 | .It Fl f | |
362 | Requests | |
363 | .Nm | |
610cd5c6 | 364 | to go to background just before command execution. |
365 | This is useful if | |
bf740959 | 366 | .Nm |
367 | is going to ask for passwords or passphrases, but the user | |
610cd5c6 | 368 | wants it in the background. |
f54651ce | 369 | This implies |
bf740959 | 370 | .Fl n . |
371 | The recommended way to start X11 programs at a remote site is with | |
372 | something like | |
373 | .Ic ssh -f host xterm . | |
7b2ea3a1 | 374 | .It Fl g |
375 | Allows remote hosts to connect to local forwarded ports. | |
bf740959 | 376 | .It Fl i Ar identity_file |
f54651ce | 377 | Selects the file from which the identity (private key) for |
610cd5c6 | 378 | RSA authentication is read. |
f54651ce | 379 | Default is |
1d1ffb87 | 380 | .Pa $HOME/.ssh/identity |
610cd5c6 | 381 | in the user's home directory. |
382 | Identity files may also be specified on | |
383 | a per-host basis in the configuration file. | |
384 | It is possible to have multiple | |
bf740959 | 385 | .Fl i |
386 | options (and multiple identities specified in | |
387 | configuration files). | |
bf740959 | 388 | .It Fl k |
4fe2af09 | 389 | Disables forwarding of Kerberos tickets and AFS tokens. |
390 | This may also be specified on a per-host basis in the configuration file. | |
bf740959 | 391 | .It Fl l Ar login_name |
610cd5c6 | 392 | Specifies the user to log in as on the remote machine. |
393 | This also may be specified on a per-host basis in the configuration file. | |
bf740959 | 394 | .It Fl n |
395 | Redirects stdin from | |
396 | .Pa /dev/null | |
397 | (actually, prevents reading from stdin). | |
398 | This must be used when | |
399 | .Nm | |
610cd5c6 | 400 | is run in the background. |
401 | A common trick is to use this to run X11 programs on a remote machine. | |
402 | For example, | |
bf740959 | 403 | .Ic ssh -n shadows.cs.hut.fi emacs & |
404 | will start an emacs on shadows.cs.hut.fi, and the X11 | |
405 | connection will be automatically forwarded over an encrypted channel. | |
406 | The | |
407 | .Nm | |
408 | program will be put in the background. | |
409 | (This does not work if | |
410 | .Nm | |
411 | needs to ask for a password or passphrase; see also the | |
412 | .Fl f | |
413 | option.) | |
414 | .It Fl o Ar option | |
415 | Can be used to give options in the format used in the config file. | |
416 | This is useful for specifying options for which there is no separate | |
610cd5c6 | 417 | command-line flag. |
418 | The option has the same format as a line in the configuration file. | |
bf740959 | 419 | .It Fl p Ar port |
610cd5c6 | 420 | Port to connect to on the remote host. |
421 | This can be specified on a | |
bf740959 | 422 | per-host basis in the configuration file. |
423 | .It Fl P | |
424 | Use a non-privileged port for outgoing connections. | |
425 | This can be used if your firewall does | |
426 | not permit connections from privileged ports. | |
95f1eccc | 427 | Note that this option turns off |
bf740959 | 428 | .Cm RhostsAuthentication |
429 | and | |
430 | .Cm RhostsRSAAuthentication . | |
431 | .It Fl q | |
610cd5c6 | 432 | Quiet mode. |
433 | Causes all warning and diagnostic messages to be suppressed. | |
434 | Only fatal errors are displayed. | |
bf740959 | 435 | .It Fl t |
610cd5c6 | 436 | Force pseudo-tty allocation. |
4fe2af09 | 437 | This can be used to execute arbitrary |
610cd5c6 | 438 | screen-based programs on a remote machine, which can be very useful, |
439 | e.g., when implementing menu services. | |
bf740959 | 440 | .It Fl v |
610cd5c6 | 441 | Verbose mode. |
442 | Causes | |
bf740959 | 443 | .Nm |
610cd5c6 | 444 | to print debugging messages about its progress. |
445 | This is helpful in | |
bf740959 | 446 | debugging connection, authentication, and configuration problems. |
447 | The verbose mode is also used to display | |
448 | .Xr skey 1 | |
449 | challenges, if the user entered "s/key" as password. | |
450 | .It Fl x | |
610cd5c6 | 451 | Disables X11 forwarding. |
452 | This can also be specified on a per-host basis in a configuration file. | |
bf740959 | 453 | .It Fl X |
454 | Enables X11 forwarding. | |
455 | .It Fl C | |
456 | Requests compression of all data (including stdin, stdout, stderr, and | |
610cd5c6 | 457 | data for forwarded X11 and TCP/IP connections). |
458 | The compression algorithm is the same used by | |
7b2ea3a1 | 459 | .Xr gzip 1 , |
460 | and the | |
bf740959 | 461 | .Dq level |
462 | can be controlled by the | |
463 | .Cm CompressionLevel | |
610cd5c6 | 464 | option (see below). |
465 | Compression is desirable on modem lines and other | |
bf740959 | 466 | slow connections, but will only slow down things on fast networks. |
467 | The default value can be set on a host-by-host basis in the | |
468 | configuration files; see the | |
469 | .Cm Compress | |
470 | option below. | |
471 | .It Fl L Ar port:host:hostport | |
472 | Specifies that the given port on the local (client) host is to be | |
610cd5c6 | 473 | forwarded to the given host and port on the remote side. |
474 | This works by allocating a socket to listen to | |
bf740959 | 475 | .Ar port |
476 | on the local side, and whenever a connection is made to this port, the | |
477 | connection is forwarded over the secure channel, and a connection is | |
478 | made to | |
48e671d5 | 479 | .Ar host |
480 | port | |
481 | .Ar hostport | |
610cd5c6 | 482 | from the remote machine. |
483 | Port forwardings can also be specified in the configuration file. | |
484 | Only root can forward privileged ports. | |
48e671d5 | 485 | IPv6 addresses can be specified with an alternative syntax: |
486 | .Ar port/host/hostport | |
bf740959 | 487 | .It Fl R Ar port:host:hostport |
488 | Specifies that the given port on the remote (server) host is to be | |
610cd5c6 | 489 | forwarded to the given host and port on the local side. |
490 | This works by allocating a socket to listen to | |
bf740959 | 491 | .Ar port |
492 | on the remote side, and whenever a connection is made to this port, the | |
493 | connection is forwarded over the secure channel, and a connection is | |
494 | made to | |
48e671d5 | 495 | .Ar host |
496 | port | |
497 | .Ar hostport | |
610cd5c6 | 498 | from the local machine. |
499 | Port forwardings can also be specified in the configuration file. | |
500 | Privileged ports can be forwarded only when | |
bf740959 | 501 | logging in as root on the remote machine. |
6ae2364d | 502 | .It Fl 2 |
503 | Forces | |
504 | .Nm | |
1d1ffb87 | 505 | to try protocol version 2 only. |
48e671d5 | 506 | .It Fl 4 |
507 | Forces | |
508 | .Nm | |
509 | to use IPv4 addresses only. | |
510 | .It Fl 6 | |
511 | Forces | |
512 | .Nm | |
513 | to use IPv6 addresses only. | |
bf740959 | 514 | .El |
515 | .Sh CONFIGURATION FILES | |
516 | .Nm | |
517 | obtains configuration data from the following sources (in this order): | |
518 | command line options, user's configuration file | |
519 | .Pq Pa $HOME/.ssh/config , | |
520 | and system-wide configuration file | |
5f4fdfae | 521 | .Pq Pa /etc/ssh_config . |
bf740959 | 522 | For each parameter, the first obtained value |
610cd5c6 | 523 | will be used. |
524 | The configuration files contain sections bracketed by | |
525 | .Dq Host | |
526 | specifications, and that section is only applied for hosts that | |
527 | match one of the patterns given in the specification. | |
528 | The matched host name is the one given on the command line. | |
bf740959 | 529 | .Pp |
530 | Since the first obtained value for each parameter is used, more | |
531 | host-specific declarations should be given near the beginning of the | |
532 | file, and general defaults at the end. | |
533 | .Pp | |
534 | The configuration file has the following format: | |
535 | .Pp | |
536 | Empty lines and lines starting with | |
537 | .Ql # | |
538 | are comments. | |
539 | .Pp | |
540 | Otherwise a line is of the format | |
541 | .Dq keyword arguments . | |
542 | The possible | |
543 | keywords and their meanings are as follows (note that the | |
544 | configuration files are case-sensitive): | |
545 | .Bl -tag -width Ds | |
546 | .It Cm Host | |
547 | Restricts the following declarations (up to the next | |
548 | .Cm Host | |
549 | keyword) to be only for those hosts that match one of the patterns | |
550 | given after the keyword. | |
551 | .Ql \&* | |
552 | and | |
553 | .Ql ? | |
554 | can be used as wildcards in the | |
610cd5c6 | 555 | patterns. |
556 | A single | |
bf740959 | 557 | .Ql \&* |
558 | as a pattern can be used to provide global | |
610cd5c6 | 559 | defaults for all hosts. |
560 | The host is the | |
bf740959 | 561 | .Ar hostname |
562 | argument given on the command line (i.e., the name is not converted to | |
563 | a canonicalized host name before matching). | |
564 | .It Cm AFSTokenPassing | |
4fe2af09 | 565 | Specifies whether to pass AFS tokens to remote host. |
566 | The argument to this keyword must be | |
bf740959 | 567 | .Dq yes |
568 | or | |
569 | .Dq no . | |
570 | .It Cm BatchMode | |
571 | If set to | |
572 | .Dq yes , | |
610cd5c6 | 573 | passphrase/password querying will be disabled. |
574 | This option is useful in scripts and other batch jobs where you have no | |
575 | user to supply the password. | |
576 | The argument must be | |
bf740959 | 577 | .Dq yes |
578 | or | |
579 | .Dq no . | |
7b2ea3a1 | 580 | .It Cm CheckHostIP |
581 | If this flag is set to | |
582 | .Dq yes , | |
583 | ssh will additionally check the host ip address in the | |
584 | .Pa known_hosts | |
4fe2af09 | 585 | file. |
586 | This allows ssh to detect if a host key changed due to DNS spoofing. | |
7b2ea3a1 | 587 | If the option is set to |
588 | .Dq no , | |
589 | the check will not be executed. | |
bf740959 | 590 | .It Cm Cipher |
610cd5c6 | 591 | Specifies the cipher to use for encrypting the session. |
592 | Currently, | |
bf740959 | 593 | .Dq blowfish , |
594 | and | |
595 | .Dq 3des | |
610cd5c6 | 596 | are supported. |
597 | The default is | |
bf740959 | 598 | .Dq 3des . |
f54651ce | 599 | .It Cm Ciphers |
600 | Specifies the ciphers allowed for protocol version 2 | |
601 | in order of preference. | |
602 | Multiple ciphers must be comma-separated. | |
603 | The default is | |
604 | .Dq blowfish-cbc,3des-cbc,arcfour,cast128-cbc . | |
bf740959 | 605 | .It Cm Compression |
610cd5c6 | 606 | Specifies whether to use compression. |
607 | The argument must be | |
bf740959 | 608 | .Dq yes |
609 | or | |
610 | .Dq no . | |
611 | .It Cm CompressionLevel | |
610cd5c6 | 612 | Specifies the compression level to use if compression is enable. |
613 | The argument must be an integer from 1 (fast) to 9 (slow, best). | |
614 | The default level is 6, which is good for most applications. | |
615 | The meaning of the values is the same as in | |
7b2ea3a1 | 616 | .Xr gzip 1 . |
bf740959 | 617 | .It Cm ConnectionAttempts |
618 | Specifies the number of tries (one per second) to make before falling | |
610cd5c6 | 619 | back to rsh or exiting. |
620 | The argument must be an integer. | |
621 | This may be useful in scripts if the connection sometimes fails. | |
1d1ffb87 | 622 | .It Cm DSAAuthentication |
623 | Specifies whether to try DSA authentication. | |
624 | The argument to this keyword must be | |
625 | .Dq yes | |
626 | or | |
627 | .Dq no . | |
628 | DSA authentication will only be | |
629 | attempted if a DSA identity file exists. | |
630 | Note that this option applies to protocol version 2 only. | |
bf740959 | 631 | .It Cm EscapeChar |
632 | Sets the escape character (default: | |
633 | .Ql ~ ) . | |
634 | The escape character can also | |
610cd5c6 | 635 | be set on the command line. |
636 | The argument should be a single character, | |
bf740959 | 637 | .Ql ^ |
638 | followed by a letter, or | |
639 | .Dq none | |
640 | to disable the escape | |
641 | character entirely (making the connection transparent for binary | |
642 | data). | |
f54651ce | 643 | .It Cm FallBackToRsh |
bf740959 | 644 | Specifies that if connecting via |
645 | .Nm | |
646 | fails due to a connection refused error (there is no | |
647 | .Xr sshd 8 | |
f54651ce | 648 | listening on the remote host), |
bf740959 | 649 | .Xr rsh 1 |
650 | should automatically be used instead (after a suitable warning about | |
610cd5c6 | 651 | the session being unencrypted). |
652 | The argument must be | |
bf740959 | 653 | .Dq yes |
654 | or | |
655 | .Dq no . | |
656 | .It Cm ForwardAgent | |
657 | Specifies whether the connection to the authentication agent (if any) | |
610cd5c6 | 658 | will be forwarded to the remote machine. |
659 | The argument must be | |
bf740959 | 660 | .Dq yes |
661 | or | |
662 | .Dq no . | |
663 | .It Cm ForwardX11 | |
664 | Specifies whether X11 connections will be automatically redirected | |
f54651ce | 665 | over the secure channel and |
bf740959 | 666 | .Ev DISPLAY |
610cd5c6 | 667 | set. |
f54651ce | 668 | The argument must be |
bf740959 | 669 | .Dq yes |
670 | or | |
671 | .Dq no . | |
c8d54615 | 672 | The default is |
673 | .Dq no . | |
bf740959 | 674 | .It Cm GatewayPorts |
675 | Specifies whether remote hosts are allowed to connect to local | |
676 | forwarded ports. | |
677 | The argument must be | |
678 | .Dq yes | |
679 | or | |
680 | .Dq no . | |
681 | The default is | |
682 | .Dq no . | |
683 | .It Cm GlobalKnownHostsFile | |
f54651ce | 684 | Specifies a file to use instead of |
5f4fdfae | 685 | .Pa /etc/ssh_known_hosts . |
bf740959 | 686 | .It Cm HostName |
610cd5c6 | 687 | Specifies the real host name to log into. |
688 | This can be used to specify nicknames or abbreviations for hosts. | |
689 | Default is the name given on the command line. | |
690 | Numeric IP addresses are also permitted (both on the command line and in | |
bf740959 | 691 | .Cm HostName |
692 | specifications). | |
693 | .It Cm IdentityFile | |
694 | Specifies the file from which the user's RSA authentication identity | |
695 | is read (default | |
1d1ffb87 | 696 | .Pa $HOME/.ssh/identity |
bf740959 | 697 | in the user's home directory). |
698 | Additionally, any identities represented by the authentication agent | |
610cd5c6 | 699 | will be used for authentication. |
700 | The file name may use the tilde | |
701 | syntax to refer to a user's home directory. | |
702 | It is possible to have | |
bf740959 | 703 | multiple identity files specified in configuration files; all these |
704 | identities will be tried in sequence. | |
1d1ffb87 | 705 | .It Cm IdentityFile2 |
706 | Specifies the file from which the user's DSA authentication identity | |
707 | is read (default | |
708 | .Pa $HOME/.ssh/id_dsa | |
709 | in the user's home directory). | |
710 | The file name may use the tilde | |
711 | syntax to refer to a user's home directory. | |
712 | It is possible to have | |
713 | multiple identity files specified in configuration files; all these | |
714 | identities will be tried in sequence. | |
bf740959 | 715 | .It Cm KeepAlive |
716 | Specifies whether the system should send keepalive messages to the | |
610cd5c6 | 717 | other side. |
718 | If they are sent, death of the connection or crash of one | |
719 | of the machines will be properly noticed. | |
720 | However, this means that | |
bf740959 | 721 | connections will die if the route is down temporarily, and some people |
4fe2af09 | 722 | find it annoying. |
bf740959 | 723 | .Pp |
724 | The default is | |
725 | .Dq yes | |
726 | (to send keepalives), and the client will notice | |
610cd5c6 | 727 | if the network goes down or the remote host dies. |
728 | This is important in scripts, and many users want it too. | |
bf740959 | 729 | .Pp |
730 | To disable keepalives, the value should be set to | |
731 | .Dq no | |
732 | in both the server and the client configuration files. | |
733 | .It Cm KerberosAuthentication | |
4fe2af09 | 734 | Specifies whether Kerberos authentication will be used. |
735 | The argument to this keyword must be | |
bf740959 | 736 | .Dq yes |
737 | or | |
738 | .Dq no . | |
739 | .It Cm KerberosTgtPassing | |
4fe2af09 | 740 | Specifies whether a Kerberos TGT will be forwarded to the server. |
741 | This will only work if the Kerberos server is actually an AFS kaserver. | |
742 | The argument to this keyword must be | |
bf740959 | 743 | .Dq yes |
744 | or | |
745 | .Dq no . | |
746 | .It Cm LocalForward | |
747 | Specifies that a TCP/IP port on the local machine be forwarded over | |
610cd5c6 | 748 | the secure channel to given host:port from the remote machine. |
749 | The first argument must be a port number, and the second must be | |
750 | host:port. | |
751 | Multiple forwardings may be specified, and additional | |
752 | forwardings can be given on the command line. | |
753 | Only the superuser can forward privileged ports. | |
6a17f9c2 | 754 | .It Cm LogLevel |
755 | Gives the verbosity level that is used when logging messages from | |
756 | .Nm ssh . | |
757 | The possible values are: | |
22fa590f | 758 | QUIET, FATAL, ERROR, INFO, VERBOSE and DEBUG. |
6a17f9c2 | 759 | The default is INFO. |
bf740959 | 760 | .It Cm NumberOfPasswordPrompts |
4fe2af09 | 761 | Specifies the number of password prompts before giving up. |
762 | The argument to this keyword must be an integer. | |
763 | Default is 3. | |
7b2ea3a1 | 764 | .It Cm PasswordAuthentication |
610cd5c6 | 765 | Specifies whether to use password authentication. |
766 | The argument to this keyword must be | |
7b2ea3a1 | 767 | .Dq yes |
768 | or | |
769 | .Dq no . | |
1d1ffb87 | 770 | Note that this option applies to both protocol version 1 and 2. |
bf740959 | 771 | .It Cm Port |
610cd5c6 | 772 | Specifies the port number to connect on the remote host. |
773 | Default is 22. | |
f54651ce | 774 | .It Cm Protocol |
775 | Specifies the protocol versions | |
776 | .Nm | |
777 | should support in order of preference. | |
778 | The possible values are | |
779 | .Dq 1 | |
780 | and | |
781 | .Dq 2 . | |
782 | Multiple versions must be comma-separated. | |
783 | The default is | |
1d1ffb87 | 784 | .Dq 1,2 . |
785 | This means that | |
786 | .Nm | |
787 | tries version 1 and falls back to version 2 | |
788 | if version 1 is no available. | |
bf740959 | 789 | .It Cm ProxyCommand |
610cd5c6 | 790 | Specifies the command to use to connect to the server. |
791 | The command | |
792 | string extends to the end of the line, and is executed with | |
793 | .Pa /bin/sh . | |
794 | In the command string, | |
795 | .Ql %h | |
796 | will be substituted by the host name to | |
797 | connect and | |
798 | .Ql %p | |
799 | by the port. | |
800 | The command can be basically anything, | |
801 | and should read from its standard input and write to its standard output. | |
802 | It should eventually connect an | |
bf740959 | 803 | .Xr sshd 8 |
804 | server running on some machine, or execute | |
805 | .Ic sshd -i | |
610cd5c6 | 806 | somewhere. |
807 | Host key management will be done using the | |
bf740959 | 808 | HostName of the host being connected (defaulting to the name typed by |
809 | the user). | |
57112b5a | 810 | Note that |
811 | .Cm CheckHostIP | |
812 | is not available for connects with a proxy command. | |
bf740959 | 813 | .Pp |
814 | .It Cm RemoteForward | |
815 | Specifies that a TCP/IP port on the remote machine be forwarded over | |
610cd5c6 | 816 | the secure channel to given host:port from the local machine. |
817 | The first argument must be a port number, and the second must be | |
818 | host:port. | |
819 | Multiple forwardings may be specified, and additional | |
820 | forwardings can be given on the command line. | |
821 | Only the superuser can forward privileged ports. | |
bf740959 | 822 | .It Cm RhostsAuthentication |
610cd5c6 | 823 | Specifies whether to try rhosts based authentication. |
824 | Note that this | |
bf740959 | 825 | declaration only affects the client side and has no effect whatsoever |
610cd5c6 | 826 | on security. |
827 | Disabling rhosts authentication may reduce | |
bf740959 | 828 | authentication time on slow connections when rhosts authentication is |
610cd5c6 | 829 | not used. |
830 | Most servers do not permit RhostsAuthentication because it | |
831 | is not secure (see RhostsRSAAuthentication). | |
832 | The argument to this keyword must be | |
bf740959 | 833 | .Dq yes |
834 | or | |
835 | .Dq no . | |
836 | .It Cm RhostsRSAAuthentication | |
837 | Specifies whether to try rhosts based authentication with RSA host | |
610cd5c6 | 838 | authentication. |
839 | This is the primary authentication method for most sites. | |
840 | The argument must be | |
bf740959 | 841 | .Dq yes |
842 | or | |
843 | .Dq no . | |
844 | .It Cm RSAAuthentication | |
610cd5c6 | 845 | Specifies whether to try RSA authentication. |
846 | The argument to this keyword must be | |
bf740959 | 847 | .Dq yes |
848 | or | |
849 | .Dq no . | |
850 | RSA authentication will only be | |
851 | attempted if the identity file exists, or an authentication agent is | |
852 | running. | |
1d1ffb87 | 853 | Note that this option applies to protocol version 1 only. |
5260325f | 854 | .It Cm SkeyAuthentication |
855 | Specifies whether to use | |
856 | .Xr skey 1 | |
610cd5c6 | 857 | authentication. |
858 | The argument to this keyword must be | |
5260325f | 859 | .Dq yes |
860 | or | |
861 | .Dq no . | |
862 | The default is | |
863 | .Dq no . | |
bf740959 | 864 | .It Cm StrictHostKeyChecking |
865 | If this flag is set to | |
f54651ce | 866 | .Dq yes , |
bf740959 | 867 | .Nm |
868 | ssh will never automatically add host keys to the | |
869 | .Pa $HOME/.ssh/known_hosts | |
1d1ffb87 | 870 | and |
871 | .Pa $HOME/.ssh/known_hosts2 | |
872 | files, and refuses to connect hosts whose host key has changed. | |
610cd5c6 | 873 | This provides maximum protection against trojan horse attacks. |
874 | However, it can be somewhat annoying if you don't have good | |
5f4fdfae | 875 | .Pa /etc/ssh_known_hosts |
1d1ffb87 | 876 | and |
877 | .Pa /etc/ssh_known_hosts2 | |
bf740959 | 878 | files installed and frequently |
610cd5c6 | 879 | connect new hosts. |
880 | Basically this option forces the user to manually | |
881 | add any new hosts. | |
882 | Normally this option is disabled, and new hosts | |
883 | will automatically be added to the known host files. | |
884 | The host keys of | |
885 | known hosts will be verified automatically in either case. | |
886 | The argument must be | |
bf740959 | 887 | .Dq yes |
888 | or | |
889 | .Dq no . | |
bf740959 | 890 | .It Cm UsePrivilegedPort |
891 | Specifies whether to use a privileged port for outgoing connections. | |
892 | The argument must be | |
893 | .Dq yes | |
894 | or | |
895 | .Dq no . | |
896 | The default is | |
897 | .Dq yes . | |
898 | Note that setting this option to | |
899 | .Dq no | |
95f1eccc | 900 | turns off |
bf740959 | 901 | .Cm RhostsAuthentication |
902 | and | |
903 | .Cm RhostsRSAAuthentication . | |
7b2ea3a1 | 904 | .It Cm User |
610cd5c6 | 905 | Specifies the user to log in as. |
906 | This can be useful if you have a different user name on different machines. | |
907 | This saves the trouble of | |
7b2ea3a1 | 908 | having to remember to give the user name on the command line. |
909 | .It Cm UserKnownHostsFile | |
910 | Specifies a file to use instead of | |
911 | .Pa $HOME/.ssh/known_hosts . | |
bf740959 | 912 | .It Cm UseRsh |
610cd5c6 | 913 | Specifies that rlogin/rsh should be used for this host. |
914 | It is possible that the host does not at all support the | |
bf740959 | 915 | .Nm |
610cd5c6 | 916 | protocol. |
917 | This causes | |
bf740959 | 918 | .Nm |
610cd5c6 | 919 | to immediately execute |
bf740959 | 920 | .Xr rsh 1 . |
921 | All other options (except | |
922 | .Cm HostName ) | |
610cd5c6 | 923 | are ignored if this has been specified. |
924 | The argument must be | |
bf740959 | 925 | .Dq yes |
926 | or | |
927 | .Dq no . | |
928 | .Sh ENVIRONMENT | |
929 | .Nm | |
930 | will normally set the following environment variables: | |
931 | .Bl -tag -width Ds | |
932 | .It Ev DISPLAY | |
933 | The | |
934 | .Ev DISPLAY | |
610cd5c6 | 935 | variable indicates the location of the X11 server. |
f54651ce | 936 | It is automatically set by |
bf740959 | 937 | .Nm |
938 | to point to a value of the form | |
939 | .Dq hostname:n | |
940 | where hostname indicates | |
610cd5c6 | 941 | the host where the shell runs, and n is an integer >= 1. |
942 | .Nm | |
943 | uses this special value to forward X11 connections over the secure | |
944 | channel. | |
945 | The user should normally not set DISPLAY explicitly, as that | |
bf740959 | 946 | will render the X11 connection insecure (and will require the user to |
947 | manually copy any required authorization cookies). | |
948 | .It Ev HOME | |
949 | Set to the path of the user's home directory. | |
950 | .It Ev LOGNAME | |
951 | Synonym for | |
952 | .Ev USER ; | |
953 | set for compatibility with systems that use this variable. | |
954 | .It Ev MAIL | |
955 | Set to point the user's mailbox. | |
610cd5c6 | 956 | .It Ev PATH |
bf740959 | 957 | Set to the default |
958 | .Ev PATH , | |
959 | as specified when compiling | |
960 | .Nm ssh . | |
961 | .It Ev SSH_AUTH_SOCK | |
962 | indicates the path of a unix-domain socket used to communicate with the | |
963 | agent. | |
964 | .It Ev SSH_CLIENT | |
610cd5c6 | 965 | Identifies the client end of the connection. |
966 | The variable contains | |
bf740959 | 967 | three space-separated values: client ip-address, client port number, |
968 | and server port number. | |
969 | .It Ev SSH_TTY | |
970 | This is set to the name of the tty (path to the device) associated | |
610cd5c6 | 971 | with the current shell or command. |
972 | If the current session has no tty, | |
bf740959 | 973 | this variable is not set. |
974 | .It Ev TZ | |
975 | The timezone variable is set to indicate the present timezone if it | |
976 | was set when the daemon was started (e.i., the daemon passes the value | |
977 | on to new connections). | |
978 | .It Ev USER | |
979 | Set to the name of the user logging in. | |
980 | .El | |
981 | .Pp | |
f54651ce | 982 | Additionally, |
bf740959 | 983 | .Nm |
f54651ce | 984 | reads |
985 | .Pa $HOME/.ssh/environment , | |
bf740959 | 986 | and adds lines of the format |
987 | .Dq VARNAME=value | |
988 | to the environment. | |
989 | .Sh FILES | |
c8d54615 | 990 | .Bl -tag -width Ds |
bf740959 | 991 | .It Pa $HOME/.ssh/known_hosts |
992 | Records host keys for all hosts the user has logged into (that are not | |
993 | in | |
5f4fdfae | 994 | .Pa /etc/ssh_known_hosts ) . |
bf740959 | 995 | See |
996 | .Xr sshd 8 . | |
1d1ffb87 | 997 | .It Pa $HOME/.ssh/identity, $HOME/.ssh/id_dsa |
998 | Contains the RSA and the DSA authentication identity of the user. | |
999 | These files | |
1000 | contain sensitive data and should be readable by the user but not | |
bf740959 | 1001 | accessible by others (read/write/execute). |
1002 | Note that | |
1003 | .Nm | |
1d1ffb87 | 1004 | ignores a private key file if it is accessible by others. |
bf740959 | 1005 | It is possible to specify a passphrase when |
1006 | generating the key; the passphrase will be used to encrypt the | |
1007 | sensitive part of this file using 3DES. | |
1d1ffb87 | 1008 | .It Pa $HOME/.ssh/identity.pub, $HOME/.ssh/id_dsa.pub |
bf740959 | 1009 | Contains the public key for authentication (public part of the |
610cd5c6 | 1010 | identity file in human-readable form). |
1d1ffb87 | 1011 | The contents of the |
1012 | .Pa $HOME/.ssh/identity.pub | |
1013 | file should be added to | |
bf740959 | 1014 | .Pa $HOME/.ssh/authorized_keys |
1015 | on all machines | |
610cd5c6 | 1016 | where you wish to log in using RSA authentication. |
1d1ffb87 | 1017 | The contents of the |
1018 | .Pa $HOME/.ssh/id_dsa.pub | |
1019 | file should be added to | |
1020 | .Pa $HOME/.ssh/authorized_keys2 | |
1021 | on all machines | |
1022 | where you wish to log in using DSA authentication. | |
1023 | These files are not | |
610cd5c6 | 1024 | sensitive and can (but need not) be readable by anyone. |
1d1ffb87 | 1025 | These files are |
1026 | never used automatically and are not necessary; they is only provided for | |
bf740959 | 1027 | the convenience of the user. |
1028 | .It Pa $HOME/.ssh/config | |
610cd5c6 | 1029 | This is the per-user configuration file. |
1030 | The format of this file is described above. | |
1031 | This file is used by the | |
bf740959 | 1032 | .Nm |
610cd5c6 | 1033 | client. |
1034 | This file does not usually contain any sensitive information, | |
bf740959 | 1035 | but the recommended permissions are read/write for the user, and not |
1036 | accessible by others. | |
1037 | .It Pa $HOME/.ssh/authorized_keys | |
610cd5c6 | 1038 | Lists the RSA keys that can be used for logging in as this user. |
1039 | The format of this file is described in the | |
bf740959 | 1040 | .Xr sshd 8 |
610cd5c6 | 1041 | manual page. |
1042 | In the simplest form the format is the same as the .pub | |
bf740959 | 1043 | identity files (that is, each line contains the number of bits in |
1044 | modulus, public exponent, modulus, and comment fields, separated by | |
610cd5c6 | 1045 | spaces). |
1046 | This file is not highly sensitive, but the recommended | |
bf740959 | 1047 | permissions are read/write for the user, and not accessible by others. |
1d1ffb87 | 1048 | .It Pa $HOME/.ssh/authorized_keys2 |
1049 | Lists the DSA keys that can be used for logging in as this user. | |
1050 | This file is not highly sensitive, but the recommended | |
1051 | permissions are read/write for the user, and not accessible by others. | |
1052 | .It Pa /etc/ssh_known_hosts, /etc/ssh_known_hosts2 | |
610cd5c6 | 1053 | Systemwide list of known host keys. |
1d1ffb87 | 1054 | .Pa /etc/ssh_known_hosts |
1055 | contains RSA and | |
1056 | .Pa /etc/ssh_known_hosts2 | |
1057 | contains DSA keys. | |
1058 | These files should be prepared by the | |
bf740959 | 1059 | system administrator to contain the public host keys of all machines in the |
610cd5c6 | 1060 | organization. |
1061 | This file should be world-readable. | |
1062 | This file contains | |
bf740959 | 1063 | public keys, one per line, in the following format (fields separated |
1064 | by spaces): system name, number of bits in modulus, public exponent, | |
610cd5c6 | 1065 | modulus, and optional comment field. |
1066 | When different names are used | |
bf740959 | 1067 | for the same machine, all such names should be listed, separated by |
610cd5c6 | 1068 | commas. |
1069 | The format is described on the | |
bf740959 | 1070 | .Xr sshd 8 |
1071 | manual page. | |
1072 | .Pp | |
1073 | The canonical system name (as returned by name servers) is used by | |
1074 | .Xr sshd 8 | |
1075 | to verify the client host when logging in; other names are needed because | |
1076 | .Nm | |
1077 | does not convert the user-supplied name to a canonical name before | |
1078 | checking the key, because someone with access to the name servers | |
1079 | would then be able to fool host authentication. | |
5f4fdfae | 1080 | .It Pa /etc/ssh_config |
610cd5c6 | 1081 | Systemwide configuration file. |
1082 | This file provides defaults for those | |
bf740959 | 1083 | values that are not specified in the user's configuration file, and |
610cd5c6 | 1084 | for those users who do not have a configuration file. |
1085 | This file must be world-readable. | |
bf740959 | 1086 | .It Pa $HOME/.rhosts |
1087 | This file is used in | |
1088 | .Pa \&.rhosts | |
1089 | authentication to list the | |
610cd5c6 | 1090 | host/user pairs that are permitted to log in. |
1091 | (Note that this file is | |
bf740959 | 1092 | also used by rlogin and rsh, which makes using this file insecure.) |
1093 | Each line of the file contains a host name (in the canonical form | |
1094 | returned by name servers), and then a user name on that host, | |
610cd5c6 | 1095 | separated by a space. |
1096 | One some machines this file may need to be | |
bf740959 | 1097 | world-readable if the user's home directory is on a NFS partition, |
1098 | because | |
1099 | .Xr sshd 8 | |
610cd5c6 | 1100 | reads it as root. |
1101 | Additionally, this file must be owned by the user, | |
1102 | and must not have write permissions for anyone else. | |
1103 | The recommended | |
bf740959 | 1104 | permission for most machines is read/write for the user, and not |
1105 | accessible by others. | |
1106 | .Pp | |
1107 | Note that by default | |
1108 | .Xr sshd 8 | |
1109 | will be installed so that it requires successful RSA host | |
610cd5c6 | 1110 | authentication before permitting \s+2.\s0rhosts authentication. |
1111 | If your server machine does not have the client's host key in | |
5f4fdfae | 1112 | .Pa /etc/ssh_known_hosts , |
bf740959 | 1113 | you can store it in |
1114 | .Pa $HOME/.ssh/known_hosts . | |
1115 | The easiest way to do this is to | |
1116 | connect back to the client from the server machine using ssh; this | |
1d1ffb87 | 1117 | will automatically add the host key to |
bf740959 | 1118 | .Pa $HOME/.ssh/known_hosts . |
1119 | .It Pa $HOME/.shosts | |
1120 | This file is used exactly the same way as | |
1121 | .Pa \&.rhosts . | |
1122 | The purpose for | |
1123 | having this file is to be able to use rhosts authentication with | |
1124 | .Nm | |
1125 | without permitting login with | |
1126 | .Xr rlogin 1 | |
1127 | or | |
1128 | .Xr rsh 1 . | |
1129 | .It Pa /etc/hosts.equiv | |
1130 | This file is used during | |
610cd5c6 | 1131 | .Pa \&.rhosts authentication. |
1132 | It contains | |
bf740959 | 1133 | canonical hosts names, one per line (the full format is described on |
1134 | the | |
1135 | .Xr sshd 8 | |
610cd5c6 | 1136 | manual page). |
1137 | If the client host is found in this file, login is | |
bf740959 | 1138 | automatically permitted provided client and server user names are the |
610cd5c6 | 1139 | same. |
1140 | Additionally, successful RSA host authentication is normally | |
1141 | required. | |
1142 | This file should only be writable by root. | |
5f4fdfae | 1143 | .It Pa /etc/shosts.equiv |
f54651ce | 1144 | This file is processed exactly as |
bf740959 | 1145 | .Pa /etc/hosts.equiv . |
1146 | This file may be useful to permit logins using | |
1147 | .Nm | |
1148 | but not using rsh/rlogin. | |
5f4fdfae | 1149 | .It Pa /etc/sshrc |
bf740959 | 1150 | Commands in this file are executed by |
1151 | .Nm | |
1152 | when the user logs in just before the user's shell (or command) is started. | |
1153 | See the | |
1154 | .Xr sshd 8 | |
1155 | manual page for more information. | |
1156 | .It Pa $HOME/.ssh/rc | |
1157 | Commands in this file are executed by | |
1158 | .Nm | |
1159 | when the user logs in just before the user's shell (or command) is | |
1160 | started. | |
f54651ce | 1161 | See the |
bf740959 | 1162 | .Xr sshd 8 |
1163 | manual page for more information. | |
83b7f649 | 1164 | .It Pa $HOME/.ssh/environment |
1165 | Contains additional definitions for environment variables, see section | |
1166 | .Sx ENVIRONMENT | |
1167 | above. | |
bf740959 | 1168 | .It Pa libcrypto.so.X.1 |
1169 | A version of this library which includes support for the RSA algorithm | |
1170 | is required for proper operation. | |
1171 | .Sh AUTHOR | |
bf740959 | 1172 | OpenSSH |
c8d54615 | 1173 | is a derivative of the original (free) ssh 1.2.12 release by Tatu Ylonen, |
610cd5c6 | 1174 | but with bugs removed and newer features re-added. |
1175 | Rapidly after the | |
c8d54615 | 1176 | 1.2.12 release, newer versions of the original ssh bore successively |
1177 | more restrictive licenses, and thus demand for a free version was born. | |
1d1ffb87 | 1178 | .Pp |
c8d54615 | 1179 | This version of OpenSSH |
bf740959 | 1180 | .Bl -bullet |
1181 | .It | |
371ecff9 | 1182 | has all components of a restrictive nature (i.e., patents) |
bf740959 | 1183 | directly removed from the source code; any licensed or patented components |
1184 | are chosen from | |
1185 | external libraries. | |
1186 | .It | |
1d1ffb87 | 1187 | has been updated to support SSH protocol 1.5 and 2, making it compatible with |
1188 | all other SSH clients and servers. | |
bf740959 | 1189 | .It |
f54651ce | 1190 | contains added support for |
bf740959 | 1191 | .Xr kerberos 8 |
1192 | authentication and ticket passing. | |
1193 | .It | |
1194 | supports one-time password authentication with | |
1195 | .Xr skey 1 . | |
1196 | .El | |
1197 | .Pp | |
0c16a097 | 1198 | OpenSSH has been created by Aaron Campbell, Bob Beck, Markus Friedl, |
f095fcc7 | 1199 | Niels Provos, Theo de Raadt, and Dug Song. |
1d1ffb87 | 1200 | .Pp |
1201 | The support for SSH protocol 2 was written by Markus Friedl. | |
bf740959 | 1202 | .Sh SEE ALSO |
1203 | .Xr rlogin 1 , | |
1204 | .Xr rsh 1 , | |
1205 | .Xr scp 1 , | |
1206 | .Xr ssh-add 1 , | |
1207 | .Xr ssh-agent 1 , | |
1208 | .Xr ssh-keygen 1 , | |
1209 | .Xr telnet 1 , | |
1210 | .Xr sshd 8 , |