]>
Commit | Line | Data |
---|---|---|
1 | .\" -*- nroff -*- | |
2 | .\" | |
3 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> | |
4 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland | |
5 | .\" All rights reserved | |
6 | .\" | |
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 | .\" | |
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. | |
16 | .\" | |
17 | .\" Redistribution and use in source and binary forms, with or without | |
18 | .\" modification, are permitted provided that the following conditions | |
19 | .\" are met: | |
20 | .\" 1. Redistributions of source code must retain the above copyright | |
21 | .\" notice, this list of conditions and the following disclaimer. | |
22 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
23 | .\" notice, this list of conditions and the following disclaimer in the | |
24 | .\" documentation and/or other materials provided with the distribution. | |
25 | .\" | |
26 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |
27 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | |
28 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | |
29 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | |
30 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | |
31 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
32 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
33 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
34 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | |
35 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
36 | .\" | |
37 | .\" $OpenBSD: sshd.8,v 1.106 2001/03/07 01:19:06 deraadt Exp $ | |
38 | .Dd September 25, 1999 | |
39 | .Dt SSHD 8 | |
40 | .Os | |
41 | .Sh NAME | |
42 | .Nm sshd | |
43 | .Nd OpenSSH ssh daemon | |
44 | .Sh SYNOPSIS | |
45 | .Nm sshd | |
46 | .Op Fl diqD46 | |
47 | .Op Fl b Ar bits | |
48 | .Op Fl f Ar config_file | |
49 | .Op Fl g Ar login_grace_time | |
50 | .Op Fl h Ar host_key_file | |
51 | .Op Fl k Ar key_gen_time | |
52 | .Op Fl p Ar port | |
53 | .Op Fl u Ar len | |
54 | .Op Fl V Ar client_protocol_id | |
55 | .Sh DESCRIPTION | |
56 | .Nm | |
57 | (SSH Daemon) is the daemon program for | |
58 | .Xr ssh 1 . | |
59 | Together these programs replace rlogin and rsh, and | |
60 | provide secure encrypted communications between two untrusted hosts | |
61 | over an insecure network. | |
62 | The programs are intended to be as easy to | |
63 | install and use as possible. | |
64 | .Pp | |
65 | .Nm | |
66 | is the daemon that listens for connections from clients. | |
67 | It is normally started at boot from | |
68 | .Pa /etc/rc . | |
69 | It forks a new | |
70 | daemon for each incoming connection. | |
71 | The forked daemons handle | |
72 | key exchange, encryption, authentication, command execution, | |
73 | and data exchange. | |
74 | This implementation of | |
75 | .Nm | |
76 | supports both SSH protocol version 1 and 2 simultaneously. | |
77 | .Nm | |
78 | works as follows. | |
79 | .Pp | |
80 | .Ss SSH protocol version 1 | |
81 | .Pp | |
82 | Each host has a host-specific RSA key | |
83 | (normally 1024 bits) used to identify the host. | |
84 | Additionally, when | |
85 | the daemon starts, it generates a server RSA key (normally 768 bits). | |
86 | This key is normally regenerated every hour if it has been used, and | |
87 | is never stored on disk. | |
88 | .Pp | |
89 | Whenever a client connects the daemon responds with its public | |
90 | host and server keys. | |
91 | The client compares the | |
92 | RSA host key against its own database to verify that it has not changed. | |
93 | The client then generates a 256 bit random number. | |
94 | It encrypts this | |
95 | random number using both the host key and the server key, and sends | |
96 | the encrypted number to the server. | |
97 | Both sides then use this | |
98 | random number as a session key which is used to encrypt all further | |
99 | communications in the session. | |
100 | The rest of the session is encrypted | |
101 | using a conventional cipher, currently Blowfish or 3DES, with 3DES | |
102 | being used by default. | |
103 | The client selects the encryption algorithm | |
104 | to use from those offered by the server. | |
105 | .Pp | |
106 | Next, the server and the client enter an authentication dialog. | |
107 | The client tries to authenticate itself using | |
108 | .Pa .rhosts | |
109 | authentication, | |
110 | .Pa .rhosts | |
111 | authentication combined with RSA host | |
112 | authentication, RSA challenge-response authentication, or password | |
113 | based authentication. | |
114 | .Pp | |
115 | Rhosts authentication is normally disabled | |
116 | because it is fundamentally insecure, but can be enabled in the server | |
117 | configuration file if desired. | |
118 | System security is not improved unless | |
119 | .Xr rshd 8 , | |
120 | .Xr rlogind 8 , | |
121 | .Xr rexecd 8 , | |
122 | and | |
123 | .Xr rexd 8 | |
124 | are disabled (thus completely disabling | |
125 | .Xr rlogin 1 | |
126 | and | |
127 | .Xr rsh 1 | |
128 | into the machine). | |
129 | .Pp | |
130 | .Ss SSH protocol version 2 | |
131 | .Pp | |
132 | Version 2 works similarly: | |
133 | Each host has a host-specific DSA key used to identify the host. | |
134 | However, when the daemon starts, it does not generate a server key. | |
135 | Forward security is provided through a Diffie-Hellman key agreement. | |
136 | This key agreement results in a shared session key. | |
137 | The rest of the session is encrypted using a symmetric cipher, currently | |
138 | Blowfish, 3DES, CAST128, Arcfour, 128 bit AES, or 256 bit AES. | |
139 | The client selects the encryption algorithm | |
140 | to use from those offered by the server. | |
141 | Additionally, session integrity is provided | |
142 | through a cryptographic message authentication code | |
143 | (hmac-sha1 or hmac-md5). | |
144 | .Pp | |
145 | Protocol version 2 provides a public key based | |
146 | user authentication method (PubkeyAuthentication) | |
147 | and conventional password authentication. | |
148 | .Pp | |
149 | .Ss Command execution and data forwarding | |
150 | .Pp | |
151 | If the client successfully authenticates itself, a dialog for | |
152 | preparing the session is entered. | |
153 | At this time the client may request | |
154 | things like allocating a pseudo-tty, forwarding X11 connections, | |
155 | forwarding TCP/IP connections, or forwarding the authentication agent | |
156 | connection over the secure channel. | |
157 | .Pp | |
158 | Finally, the client either requests a shell or execution of a command. | |
159 | The sides then enter session mode. | |
160 | In this mode, either side may send | |
161 | data at any time, and such data is forwarded to/from the shell or | |
162 | command on the server side, and the user terminal in the client side. | |
163 | .Pp | |
164 | When the user program terminates and all forwarded X11 and other | |
165 | connections have been closed, the server sends command exit status to | |
166 | the client, and both sides exit. | |
167 | .Pp | |
168 | .Nm | |
169 | can be configured using command-line options or a configuration | |
170 | file. | |
171 | Command-line options override values specified in the | |
172 | configuration file. | |
173 | .Pp | |
174 | .Nm | |
175 | rereads its configuration file when it receives a hangup signal, | |
176 | .Dv SIGHUP , | |
177 | by executing itself with the name it was started as, ie. | |
178 | .Pa /usr/sbin/sshd . | |
179 | .Pp | |
180 | The options are as follows: | |
181 | .Bl -tag -width Ds | |
182 | .It Fl b Ar bits | |
183 | Specifies the number of bits in the server key (default 768). | |
184 | .Pp | |
185 | .It Fl d | |
186 | Debug mode. | |
187 | The server sends verbose debug output to the system | |
188 | log, and does not put itself in the background. | |
189 | The server also will not fork and will only process one connection. | |
190 | This option is only intended for debugging for the server. | |
191 | Multiple -d options increases the debugging level. | |
192 | Maximum is 3. | |
193 | .It Fl f Ar configuration_file | |
194 | Specifies the name of the configuration file. | |
195 | The default is | |
196 | .Pa /etc/sshd_config . | |
197 | .Nm | |
198 | refuses to start if there is no configuration file. | |
199 | .It Fl g Ar login_grace_time | |
200 | Gives the grace time for clients to authenticate themselves (default | |
201 | 600 seconds). | |
202 | If the client fails to authenticate the user within | |
203 | this many seconds, the server disconnects and exits. | |
204 | A value of zero indicates no limit. | |
205 | .It Fl h Ar host_key_file | |
206 | Specifies the file from which the host key is read (default | |
207 | .Pa /etc/ssh_host_key ) . | |
208 | This option must be given if | |
209 | .Nm | |
210 | is not run as root (as the normal | |
211 | host file is normally not readable by anyone but root). | |
212 | It is possible to have multiple host key files for | |
213 | the different protocol versions. | |
214 | .It Fl i | |
215 | Specifies that | |
216 | .Nm | |
217 | is being run from inetd. | |
218 | .Nm | |
219 | is normally not run | |
220 | from inetd because it needs to generate the server key before it can | |
221 | respond to the client, and this may take tens of seconds. | |
222 | Clients would have to wait too long if the key was regenerated every time. | |
223 | However, with small key sizes (e.g., 512) using | |
224 | .Nm | |
225 | from inetd may | |
226 | be feasible. | |
227 | .It Fl k Ar key_gen_time | |
228 | Specifies how often the server key is regenerated (default 3600 | |
229 | seconds, or one hour). | |
230 | The motivation for regenerating the key fairly | |
231 | often is that the key is not stored anywhere, and after about an hour, | |
232 | it becomes impossible to recover the key for decrypting intercepted | |
233 | communications even if the machine is cracked into or physically | |
234 | seized. | |
235 | A value of zero indicates that the key will never be regenerated. | |
236 | .It Fl p Ar port | |
237 | Specifies the port on which the server listens for connections | |
238 | (default 22). | |
239 | .It Fl q | |
240 | Quiet mode. | |
241 | Nothing is sent to the system log. | |
242 | Normally the beginning, | |
243 | authentication, and termination of each connection is logged. | |
244 | .It Fl u Ar len | |
245 | This option is used to specify the size of the field | |
246 | in the | |
247 | .Li utmp | |
248 | structure that holds the remote host name. | |
249 | If the resolved host name is longer than | |
250 | .Ar len , | |
251 | the dotted decimal value will be used instead. | |
252 | This allows hosts with very long host names that | |
253 | overflow this field to still be uniquely identified. | |
254 | Specifying | |
255 | .Fl u0 | |
256 | indicates that only dotted decimal addresses | |
257 | should be put into the | |
258 | .Pa utmp | |
259 | file. | |
260 | .It Fl D | |
261 | When this option is specified | |
262 | .Nm | |
263 | will not detach and does not become a daemon. | |
264 | This allows easy monitoring of | |
265 | .Nm sshd . | |
266 | .It Fl V Ar client_protocol_id | |
267 | SSH-2 compatibility mode. | |
268 | When this option is specified | |
269 | .Nm | |
270 | assumes the client has sent the supplied version string | |
271 | and skips the | |
272 | Protocol Version Identification Exchange. | |
273 | This option is not intended to be called directly. | |
274 | .It Fl 4 | |
275 | Forces | |
276 | .Nm | |
277 | to use IPv4 addresses only. | |
278 | .It Fl 6 | |
279 | Forces | |
280 | .Nm | |
281 | to use IPv6 addresses only. | |
282 | .El | |
283 | .Sh CONFIGURATION FILE | |
284 | .Nm | |
285 | reads configuration data from | |
286 | .Pa /etc/sshd_config | |
287 | (or the file specified with | |
288 | .Fl f | |
289 | on the command line). | |
290 | The file contains keyword-value pairs, one per line. | |
291 | Lines starting with | |
292 | .Ql # | |
293 | and empty lines are interpreted as comments. | |
294 | .Pp | |
295 | The following keywords are possible. | |
296 | .Bl -tag -width Ds | |
297 | .It Cm AFSTokenPassing | |
298 | Specifies whether an AFS token may be forwarded to the server. | |
299 | Default is | |
300 | .Dq yes . | |
301 | .It Cm AllowGroups | |
302 | This keyword can be followed by a list of group names, separated | |
303 | by spaces. | |
304 | If specified, login is allowed only for users whose primary | |
305 | group or supplementary group list matches one of the patterns. | |
306 | .Ql \&* | |
307 | and | |
308 | .Ql ? | |
309 | can be used as | |
310 | wildcards in the patterns. | |
311 | Only group names are valid; a numerical group ID isn't recognized. | |
312 | By default login is allowed regardless of the group list. | |
313 | .Pp | |
314 | .It Cm AllowTcpForwarding | |
315 | Specifies whether TCP forwarding is permitted. | |
316 | The default is | |
317 | .Dq yes . | |
318 | Note that disabling TCP forwarding does not improve security unless | |
319 | users are also denied shell access, as they can always install their | |
320 | own forwarders. | |
321 | .Pp | |
322 | .It Cm AllowUsers | |
323 | This keyword can be followed by a list of user names, separated | |
324 | by spaces. | |
325 | If specified, login is allowed only for users names that | |
326 | match one of the patterns. | |
327 | .Ql \&* | |
328 | and | |
329 | .Ql ? | |
330 | can be used as | |
331 | wildcards in the patterns. | |
332 | Only user names are valid; a numerical user ID isn't recognized. | |
333 | By default login is allowed regardless of the user name. | |
334 | .Pp | |
335 | .It Cm Banner | |
336 | In some jurisdictions, sending a warning message before authentication | |
337 | may be relevant for getting legal protection. | |
338 | The contents of the specified file are sent to the remote user before | |
339 | authentication is allowed. | |
340 | This option is only available for protocol version 2. | |
341 | .Pp | |
342 | .It Cm ChallengeResponseAuthentication | |
343 | Specifies whether | |
344 | challenge response | |
345 | authentication is allowed. | |
346 | Currently there is only support for | |
347 | .Xr skey 1 | |
348 | authentication. | |
349 | The default is | |
350 | .Dq yes . | |
351 | .It Cm Ciphers | |
352 | Specifies the ciphers allowed for protocol version 2. | |
353 | Multiple ciphers must be comma-separated. | |
354 | The default is | |
355 | .Dq aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour. | |
356 | .It Cm CheckMail | |
357 | Specifies whether | |
358 | .Nm | |
359 | should check for new mail for interactive logins. | |
360 | The default is | |
361 | .Dq no . | |
362 | .It Cm DenyGroups | |
363 | This keyword can be followed by a number of group names, separated | |
364 | by spaces. | |
365 | Users whose primary group or supplementary group list matches | |
366 | one of the patterns aren't allowed to log in. | |
367 | .Ql \&* | |
368 | and | |
369 | .Ql ? | |
370 | can be used as | |
371 | wildcards in the patterns. | |
372 | Only group names are valid; a numerical group ID isn't recognized. | |
373 | By default login is allowed regardless of the group list. | |
374 | .Pp | |
375 | .It Cm DenyUsers | |
376 | This keyword can be followed by a number of user names, separated | |
377 | by spaces. | |
378 | Login is disallowed for user names that match one of the patterns. | |
379 | .Ql \&* | |
380 | and | |
381 | .Ql ? | |
382 | can be used as wildcards in the patterns. | |
383 | Only user names are valid; a numerical user ID isn't recognized. | |
384 | By default login is allowed regardless of the user name. | |
385 | .It Cm GatewayPorts | |
386 | Specifies whether remote hosts are allowed to connect to ports | |
387 | forwarded for the client. | |
388 | The argument must be | |
389 | .Dq yes | |
390 | or | |
391 | .Dq no . | |
392 | The default is | |
393 | .Dq no . | |
394 | .It Cm HostKey | |
395 | Specifies the file containing the private host keys (default | |
396 | .Pa /etc/ssh_host_key ) | |
397 | used by SSH protocol versions 1 and 2. | |
398 | Note that | |
399 | .Nm | |
400 | will refuse to use a file if it is group/world-accessible. | |
401 | It is possible to have multiple host key files. | |
402 | .Dq rsa1 | |
403 | keys are used for version 1 and | |
404 | .Dq dsa | |
405 | or | |
406 | .Dq rsa | |
407 | are used for version 2 of the SSH protocol. | |
408 | .It Cm IgnoreRhosts | |
409 | Specifies that | |
410 | .Pa .rhosts | |
411 | and | |
412 | .Pa .shosts | |
413 | files will not be used in authentication. | |
414 | .Pa /etc/hosts.equiv | |
415 | and | |
416 | .Pa /etc/shosts.equiv | |
417 | are still used. | |
418 | The default is | |
419 | .Dq yes . | |
420 | .It Cm IgnoreUserKnownHosts | |
421 | Specifies whether | |
422 | .Nm | |
423 | should ignore the user's | |
424 | .Pa $HOME/.ssh/known_hosts | |
425 | during | |
426 | .Cm RhostsRSAAuthentication . | |
427 | The default is | |
428 | .Dq no . | |
429 | .It Cm KeepAlive | |
430 | Specifies whether the system should send keepalive messages to the | |
431 | other side. | |
432 | If they are sent, death of the connection or crash of one | |
433 | of the machines will be properly noticed. | |
434 | However, this means that | |
435 | connections will die if the route is down temporarily, and some people | |
436 | find it annoying. | |
437 | On the other hand, if keepalives are not sent, | |
438 | sessions may hang indefinitely on the server, leaving | |
439 | .Dq ghost | |
440 | users and consuming server resources. | |
441 | .Pp | |
442 | The default is | |
443 | .Dq yes | |
444 | (to send keepalives), and the server will notice | |
445 | if the network goes down or the client host reboots. | |
446 | This avoids infinitely hanging sessions. | |
447 | .Pp | |
448 | To disable keepalives, the value should be set to | |
449 | .Dq no | |
450 | in both the server and the client configuration files. | |
451 | .It Cm KerberosAuthentication | |
452 | Specifies whether Kerberos authentication is allowed. | |
453 | This can be in the form of a Kerberos ticket, or if | |
454 | .Cm PasswordAuthentication | |
455 | is yes, the password provided by the user will be validated through | |
456 | the Kerberos KDC. | |
457 | To use this option, the server needs a | |
458 | Kerberos servtab which allows the verification of the KDC's identity. | |
459 | Default is | |
460 | .Dq yes . | |
461 | .It Cm KerberosOrLocalPasswd | |
462 | If set then if password authentication through Kerberos fails then | |
463 | the password will be validated via any additional local mechanism | |
464 | such as | |
465 | .Pa /etc/passwd . | |
466 | Default is | |
467 | .Dq yes . | |
468 | .It Cm KerberosTgtPassing | |
469 | Specifies whether a Kerberos TGT may be forwarded to the server. | |
470 | Default is | |
471 | .Dq no , | |
472 | as this only works when the Kerberos KDC is actually an AFS kaserver. | |
473 | .It Cm KerberosTicketCleanup | |
474 | Specifies whether to automatically destroy the user's ticket cache | |
475 | file on logout. | |
476 | Default is | |
477 | .Dq yes . | |
478 | .It Cm KeyRegenerationInterval | |
479 | The server key is automatically regenerated after this many seconds | |
480 | (if it has been used). | |
481 | The purpose of regeneration is to prevent | |
482 | decrypting captured sessions by later breaking into the machine and | |
483 | stealing the keys. | |
484 | The key is never stored anywhere. | |
485 | If the value is 0, the key is never regenerated. | |
486 | The default is 3600 (seconds). | |
487 | .It Cm ListenAddress | |
488 | Specifies what local address | |
489 | .Nm | |
490 | should listen on. | |
491 | The default is to listen to all local addresses. | |
492 | Multiple options of this type are permitted. | |
493 | Additionally, the | |
494 | .Cm Ports | |
495 | options must precede this option. | |
496 | .It Cm LoginGraceTime | |
497 | The server disconnects after this time if the user has not | |
498 | successfully logged in. | |
499 | If the value is 0, there is no time limit. | |
500 | The default is 600 (seconds). | |
501 | .It Cm LogLevel | |
502 | Gives the verbosity level that is used when logging messages from | |
503 | .Nm sshd . | |
504 | The possible values are: | |
505 | QUIET, FATAL, ERROR, INFO, VERBOSE and DEBUG. | |
506 | The default is INFO. | |
507 | Logging with level DEBUG violates the privacy of users | |
508 | and is not recommended. | |
509 | .It Cm MACs | |
510 | Specifies the available MAC (message authentication code) algorithms. | |
511 | The MAC algorithm is used in protocol version 2 | |
512 | for data integrity protection. | |
513 | Multiple algorithms must be comma-separated. | |
514 | The default is | |
515 | .Pp | |
516 | .Bd -literal | |
517 | ``hmac-md5,hmac-sha1,hmac-ripemd160,hmac-ripemd160@openssh.com, | |
518 | hmac-sha1-96,hmac-md5-96'' | |
519 | .Ed | |
520 | .It Cm MaxStartups | |
521 | Specifies the maximum number of concurrent unauthenticated connections to the | |
522 | .Nm | |
523 | daemon. | |
524 | Additional connections will be dropped until authentication succeeds or the | |
525 | .Cm LoginGraceTime | |
526 | expires for a connection. | |
527 | The default is 10. | |
528 | .Pp | |
529 | Alternatively, random early drop can be enabled by specifying | |
530 | the three colon separated values | |
531 | .Dq start:rate:full | |
532 | (e.g., "10:30:60"). | |
533 | .Nm | |
534 | will refuse connection attempts with a probability of | |
535 | .Dq rate/100 | |
536 | (30%) | |
537 | if there are currently | |
538 | .Dq start | |
539 | (10) | |
540 | unauthenticated connections. | |
541 | The probability increases linearly and all connection attempts | |
542 | are refused if the number of unauthenticated connections reaches | |
543 | .Dq full | |
544 | (60). | |
545 | .It Cm PasswordAuthentication | |
546 | Specifies whether password authentication is allowed. | |
547 | The default is | |
548 | .Dq yes . | |
549 | Note that this option applies to both protocol versions 1 and 2. | |
550 | .It Cm PermitEmptyPasswords | |
551 | When password authentication is allowed, it specifies whether the | |
552 | server allows login to accounts with empty password strings. | |
553 | The default is | |
554 | .Dq no . | |
555 | .It Cm PermitRootLogin | |
556 | Specifies whether root can login using | |
557 | .Xr ssh 1 . | |
558 | The argument must be | |
559 | .Dq yes , | |
560 | .Dq without-password , | |
561 | .Dq forced-commands-only | |
562 | or | |
563 | .Dq no . | |
564 | The default is | |
565 | .Dq yes . | |
566 | .Pp | |
567 | If this option is set to | |
568 | .Dq without-password | |
569 | password authentication is disabled for root. | |
570 | .Pp | |
571 | If this option is set to | |
572 | .Dq forced-commands-only | |
573 | root login with public key authentication will be allowed, | |
574 | but only if the | |
575 | .Ar command | |
576 | option has been specified | |
577 | (which may be useful for taking remote backups even if root login is | |
578 | normally not allowed). All other authentication methods are disabled | |
579 | for root. | |
580 | .Pp | |
581 | If this option is set to | |
582 | .Dq no | |
583 | root is not allowed to login. | |
584 | .It Cm PidFile | |
585 | Specifies the file that contains the process identifier of the | |
586 | .Nm | |
587 | daemon. | |
588 | The default is | |
589 | .Pa /var/run/sshd.pid . | |
590 | .It Cm Port | |
591 | Specifies the port number that | |
592 | .Nm | |
593 | listens on. | |
594 | The default is 22. | |
595 | Multiple options of this type are permitted. | |
596 | .It Cm PrintMotd | |
597 | Specifies whether | |
598 | .Nm | |
599 | should print | |
600 | .Pa /etc/motd | |
601 | when a user logs in interactively. | |
602 | (On some systems it is also printed by the shell, | |
603 | .Pa /etc/profile , | |
604 | or equivalent.) | |
605 | The default is | |
606 | .Dq yes . | |
607 | .It Cm Protocol | |
608 | Specifies the protocol versions | |
609 | .Nm | |
610 | should support. | |
611 | The possible values are | |
612 | .Dq 1 | |
613 | and | |
614 | .Dq 2 . | |
615 | Multiple versions must be comma-separated. | |
616 | The default is | |
617 | .Dq 1 . | |
618 | .It Cm PubkeyAuthentication | |
619 | Specifies whether public key authentication is allowed. | |
620 | The default is | |
621 | .Dq yes . | |
622 | Note that this option applies to protocol version 2 only. | |
623 | .It Cm ReverseMappingCheck | |
624 | Specifies whether | |
625 | .Nm | |
626 | should try to verify the remote host name and check that | |
627 | the resolved host name for the remote IP address maps back to the | |
628 | very same IP address. | |
629 | The default is | |
630 | .Dq no . | |
631 | .It Cm RhostsAuthentication | |
632 | Specifies whether authentication using rhosts or /etc/hosts.equiv | |
633 | files is sufficient. | |
634 | Normally, this method should not be permitted because it is insecure. | |
635 | .Cm RhostsRSAAuthentication | |
636 | should be used | |
637 | instead, because it performs RSA-based host authentication in addition | |
638 | to normal rhosts or /etc/hosts.equiv authentication. | |
639 | The default is | |
640 | .Dq no . | |
641 | .It Cm RhostsRSAAuthentication | |
642 | Specifies whether rhosts or /etc/hosts.equiv authentication together | |
643 | with successful RSA host authentication is allowed. | |
644 | The default is | |
645 | .Dq no . | |
646 | .It Cm RSAAuthentication | |
647 | Specifies whether pure RSA authentication is allowed. | |
648 | The default is | |
649 | .Dq yes . | |
650 | Note that this option applies to protocol version 1 only. | |
651 | .It Cm ServerKeyBits | |
652 | Defines the number of bits in the server key. | |
653 | The minimum value is 512, and the default is 768. | |
654 | .It Cm StrictModes | |
655 | Specifies whether | |
656 | .Nm | |
657 | should check file modes and ownership of the | |
658 | user's files and home directory before accepting login. | |
659 | This is normally desirable because novices sometimes accidentally leave their | |
660 | directory or files world-writable. | |
661 | The default is | |
662 | .Dq yes . | |
663 | .It Cm Subsystem | |
664 | Configures an external subsystem (e.g., file transfer daemon). | |
665 | Arguments should be a subsystem name and a command to execute upon subsystem | |
666 | request. | |
667 | The command | |
668 | .Xr sftp-server 8 | |
669 | implements the | |
670 | .Dq sftp | |
671 | file transfer subsystem. | |
672 | By default no subsystems are defined. | |
673 | Note that this option applies to protocol version 2 only. | |
674 | .It Cm SyslogFacility | |
675 | Gives the facility code that is used when logging messages from | |
676 | .Nm sshd . | |
677 | The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, | |
678 | LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. | |
679 | The default is AUTH. | |
680 | .It Cm UseLogin | |
681 | Specifies whether | |
682 | .Xr login 1 | |
683 | is used for interactive login sessions. | |
684 | Note that | |
685 | .Xr login 1 | |
686 | is never used for remote command execution. | |
687 | The default is | |
688 | .Dq no . | |
689 | .It Cm X11DisplayOffset | |
690 | Specifies the first display number available for | |
691 | .Nm sshd Ns 's | |
692 | X11 forwarding. | |
693 | This prevents | |
694 | .Nm | |
695 | from interfering with real X11 servers. | |
696 | The default is 10. | |
697 | .It Cm X11Forwarding | |
698 | Specifies whether X11 forwarding is permitted. | |
699 | The default is | |
700 | .Dq no . | |
701 | Note that disabling X11 forwarding does not improve security in any | |
702 | way, as users can always install their own forwarders. | |
703 | .It Cm XAuthLocation | |
704 | Specifies the location of the | |
705 | .Xr xauth 1 | |
706 | program. | |
707 | The default is | |
708 | .Pa /usr/X11R6/bin/xauth . | |
709 | .El | |
710 | .Sh LOGIN PROCESS | |
711 | When a user successfully logs in, | |
712 | .Nm | |
713 | does the following: | |
714 | .Bl -enum -offset indent | |
715 | .It | |
716 | If the login is on a tty, and no command has been specified, | |
717 | prints last login time and | |
718 | .Pa /etc/motd | |
719 | (unless prevented in the configuration file or by | |
720 | .Pa $HOME/.hushlogin ; | |
721 | see the | |
722 | .Sx FILES | |
723 | section). | |
724 | .It | |
725 | If the login is on a tty, records login time. | |
726 | .It | |
727 | Checks | |
728 | .Pa /etc/nologin ; | |
729 | if it exists, prints contents and quits | |
730 | (unless root). | |
731 | .It | |
732 | Changes to run with normal user privileges. | |
733 | .It | |
734 | Sets up basic environment. | |
735 | .It | |
736 | Reads | |
737 | .Pa $HOME/.ssh/environment | |
738 | if it exists. | |
739 | .It | |
740 | Changes to user's home directory. | |
741 | .It | |
742 | If | |
743 | .Pa $HOME/.ssh/rc | |
744 | exists, runs it; else if | |
745 | .Pa /etc/sshrc | |
746 | exists, runs | |
747 | it; otherwise runs xauth. | |
748 | The | |
749 | .Dq rc | |
750 | files are given the X11 | |
751 | authentication protocol and cookie in standard input. | |
752 | .It | |
753 | Runs user's shell or command. | |
754 | .El | |
755 | .Sh AUTHORIZED_KEYS FILE FORMAT | |
756 | The | |
757 | .Pa $HOME/.ssh/authorized_keys | |
758 | file lists the RSA keys that are | |
759 | permitted for RSA authentication in SSH protocols 1.3 and 1.5 | |
760 | Similarly, the | |
761 | .Pa $HOME/.ssh/authorized_keys2 | |
762 | file lists the DSA and RSA keys that are | |
763 | permitted for public key authentication (PubkeyAuthentication) | |
764 | in SSH protocol 2.0. | |
765 | .Pp | |
766 | Each line of the file contains one | |
767 | key (empty lines and lines starting with a | |
768 | .Ql # | |
769 | are ignored as | |
770 | comments). | |
771 | Each RSA public key consists of the following fields, separated by | |
772 | spaces: options, bits, exponent, modulus, comment. | |
773 | Each protocol version 2 public key consists of: | |
774 | options, keytype, base64 encoded key, comment. | |
775 | The options fields | |
776 | are optional; its presence is determined by whether the line starts | |
777 | with a number or not (the option field never starts with a number). | |
778 | The bits, exponent, modulus and comment fields give the RSA key for | |
779 | protocol version 1; the | |
780 | comment field is not used for anything (but may be convenient for the | |
781 | user to identify the key). | |
782 | For protocol version 2 the keytype is | |
783 | .Dq ssh-dss | |
784 | or | |
785 | .Dq ssh-rsa . | |
786 | .Pp | |
787 | Note that lines in this file are usually several hundred bytes long | |
788 | (because of the size of the RSA key modulus). | |
789 | You don't want to type them in; instead, copy the | |
790 | .Pa identity.pub | |
791 | or the | |
792 | .Pa id_dsa.pub | |
793 | file and edit it. | |
794 | .Pp | |
795 | The options (if present) consist of comma-separated option | |
796 | specifications. | |
797 | No spaces are permitted, except within double quotes. | |
798 | The following option specifications are supported: | |
799 | .Bl -tag -width Ds | |
800 | .It Cm from="pattern-list" | |
801 | Specifies that in addition to RSA authentication, the canonical name | |
802 | of the remote host must be present in the comma-separated list of | |
803 | patterns | |
804 | .Pf ( Ql * | |
805 | and | |
806 | .Ql ? | |
807 | serve as wildcards). | |
808 | The list may also contain | |
809 | patterns negated by prefixing them with | |
810 | .Ql ! ; | |
811 | if the canonical host name matches a negated pattern, the key is not accepted. | |
812 | The purpose | |
813 | of this option is to optionally increase security: RSA authentication | |
814 | by itself does not trust the network or name servers or anything (but | |
815 | the key); however, if somebody somehow steals the key, the key | |
816 | permits an intruder to log in from anywhere in the world. | |
817 | This additional option makes using a stolen key more difficult (name | |
818 | servers and/or routers would have to be compromised in addition to | |
819 | just the key). | |
820 | .It Cm command="command" | |
821 | Specifies that the command is executed whenever this key is used for | |
822 | authentication. | |
823 | The command supplied by the user (if any) is ignored. | |
824 | The command is run on a pty if the connection requests a pty; | |
825 | otherwise it is run without a tty. | |
826 | Note that if you want a 8-bit clean channel, | |
827 | you must not request a pty or should specify | |
828 | .Cm no-pty . | |
829 | A quote may be included in the command by quoting it with a backslash. | |
830 | This option might be useful | |
831 | to restrict certain RSA keys to perform just a specific operation. | |
832 | An example might be a key that permits remote backups but nothing else. | |
833 | Note that the client may specify TCP/IP and/or X11 | |
834 | forwarding unless they are explicitly prohibited. | |
835 | .It Cm environment="NAME=value" | |
836 | Specifies that the string is to be added to the environment when | |
837 | logging in using this key. | |
838 | Environment variables set this way | |
839 | override other default environment values. | |
840 | Multiple options of this type are permitted. | |
841 | .It Cm no-port-forwarding | |
842 | Forbids TCP/IP forwarding when this key is used for authentication. | |
843 | Any port forward requests by the client will return an error. | |
844 | This might be used, e.g., in connection with the | |
845 | .Cm command | |
846 | option. | |
847 | .It Cm no-X11-forwarding | |
848 | Forbids X11 forwarding when this key is used for authentication. | |
849 | Any X11 forward requests by the client will return an error. | |
850 | .It Cm no-agent-forwarding | |
851 | Forbids authentication agent forwarding when this key is used for | |
852 | authentication. | |
853 | .It Cm no-pty | |
854 | Prevents tty allocation (a request to allocate a pty will fail). | |
855 | .El | |
856 | .Ss Examples | |
857 | 1024 33 12121.\|.\|.\|312314325 ylo@foo.bar | |
858 | .Pp | |
859 | from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23.\|.\|.\|2334 ylo@niksula | |
860 | .Pp | |
861 | command="dump /home",no-pty,no-port-forwarding 1024 33 23.\|.\|.\|2323 backup.hut.fi | |
862 | .Sh SSH_KNOWN_HOSTS FILE FORMAT | |
863 | The | |
864 | .Pa /etc/ssh_known_hosts , | |
865 | .Pa /etc/ssh_known_hosts2 , | |
866 | .Pa $HOME/.ssh/known_hosts , | |
867 | and | |
868 | .Pa $HOME/.ssh/known_hosts2 | |
869 | files contain host public keys for all known hosts. | |
870 | The global file should | |
871 | be prepared by the administrator (optional), and the per-user file is | |
872 | maintained automatically: whenever the user connects from an unknown host | |
873 | its key is added to the per-user file. | |
874 | .Pp | |
875 | Each line in these files contains the following fields: hostnames, | |
876 | bits, exponent, modulus, comment. | |
877 | The fields are separated by spaces. | |
878 | .Pp | |
879 | Hostnames is a comma-separated list of patterns ('*' and '?' act as | |
880 | wildcards); each pattern in turn is matched against the canonical host | |
881 | name (when authenticating a client) or against the user-supplied | |
882 | name (when authenticating a server). | |
883 | A pattern may also be preceded by | |
884 | .Ql ! | |
885 | to indicate negation: if the host name matches a negated | |
886 | pattern, it is not accepted (by that line) even if it matched another | |
887 | pattern on the line. | |
888 | .Pp | |
889 | Bits, exponent, and modulus are taken directly from the RSA host key; they | |
890 | can be obtained, e.g., from | |
891 | .Pa /etc/ssh_host_key.pub . | |
892 | The optional comment field continues to the end of the line, and is not used. | |
893 | .Pp | |
894 | Lines starting with | |
895 | .Ql # | |
896 | and empty lines are ignored as comments. | |
897 | .Pp | |
898 | When performing host authentication, authentication is accepted if any | |
899 | matching line has the proper key. | |
900 | It is thus permissible (but not | |
901 | recommended) to have several lines or different host keys for the same | |
902 | names. | |
903 | This will inevitably happen when short forms of host names | |
904 | from different domains are put in the file. | |
905 | It is possible | |
906 | that the files contain conflicting information; authentication is | |
907 | accepted if valid information can be found from either file. | |
908 | .Pp | |
909 | Note that the lines in these files are typically hundreds of characters | |
910 | long, and you definitely don't want to type in the host keys by hand. | |
911 | Rather, generate them by a script | |
912 | or by taking | |
913 | .Pa /etc/ssh_host_key.pub | |
914 | and adding the host names at the front. | |
915 | .Ss Examples | |
916 | closenet,closenet.hut.fi,.\|.\|.\|,130.233.208.41 1024 37 159.\|.\|.93 closenet.hut.fi | |
917 | .Sh FILES | |
918 | .Bl -tag -width Ds | |
919 | .It Pa /etc/sshd_config | |
920 | Contains configuration data for | |
921 | .Nm sshd . | |
922 | This file should be writable by root only, but it is recommended | |
923 | (though not necessary) that it be world-readable. | |
924 | .It Pa /etc/ssh_host_key, /etc/ssh_host_dsa_key, /etc/ssh_host_rsa_key | |
925 | These three files contain the private parts of the | |
926 | (SSH1, SSH2 DSA, and SSH2 RSA) host keys. | |
927 | These files should only be owned by root, readable only by root, and not | |
928 | accessible to others. | |
929 | Note that | |
930 | .Nm | |
931 | does not start if this file is group/world-accessible. | |
932 | .It Pa /etc/ssh_host_key.pub, /etc/ssh_host_dsa_key.pub, /etc/ssh_host_rsa_key.pub | |
933 | There three files contain the public parts of the | |
934 | (SSH1, SSH2 DSA, and SSH2 RSA) host keys. | |
935 | These files should be world-readable but writable only by | |
936 | root. | |
937 | Their contents should match the respective private parts. | |
938 | These files are not | |
939 | really used for anything; they are provided for the convenience of | |
940 | the user so their contents can be copied to known hosts files. | |
941 | These files are created using | |
942 | .Xr ssh-keygen 1 . | |
943 | .It Pa /etc/primes | |
944 | Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange". | |
945 | .It Pa /var/run/sshd.pid | |
946 | Contains the process ID of the | |
947 | .Nm | |
948 | listening for connections (if there are several daemons running | |
949 | concurrently for different ports, this contains the pid of the one | |
950 | started last). | |
951 | The content of this file is not sensitive; it can be world-readable. | |
952 | .It Pa $HOME/.ssh/authorized_keys | |
953 | Lists the RSA keys that can be used to log into the user's account. | |
954 | This file must be readable by root (which may on some machines imply | |
955 | it being world-readable if the user's home directory resides on an NFS | |
956 | volume). | |
957 | It is recommended that it not be accessible by others. | |
958 | The format of this file is described above. | |
959 | Users will place the contents of their | |
960 | .Pa identity.pub | |
961 | files into this file, as described in | |
962 | .Xr ssh-keygen 1 . | |
963 | .It Pa $HOME/.ssh/authorized_keys2 | |
964 | Lists the DSA keys that can be used to log into the user's account. | |
965 | This file must be readable by root (which may on some machines imply | |
966 | it being world-readable if the user's home directory resides on an NFS | |
967 | volume). | |
968 | It is recommended that it not be accessible by others. | |
969 | The format of this file is described above. | |
970 | Users will place the contents of their | |
971 | .Pa id_dsa.pub | |
972 | files into this file, as described in | |
973 | .Xr ssh-keygen 1 . | |
974 | .It Pa "/etc/ssh_known_hosts" and "$HOME/.ssh/known_hosts" | |
975 | These files are consulted when using rhosts with RSA host | |
976 | authentication to check the public key of the host. | |
977 | The key must be listed in one of these files to be accepted. | |
978 | The client uses the same files | |
979 | to verify that it is connecting to the correct remote host. | |
980 | These files should be writable only by root/the owner. | |
981 | .Pa /etc/ssh_known_hosts | |
982 | should be world-readable, and | |
983 | .Pa $HOME/.ssh/known_hosts | |
984 | can but need not be world-readable. | |
985 | .It Pa /etc/nologin | |
986 | If this file exists, | |
987 | .Nm | |
988 | refuses to let anyone except root log in. | |
989 | The contents of the file | |
990 | are displayed to anyone trying to log in, and non-root connections are | |
991 | refused. | |
992 | The file should be world-readable. | |
993 | .It Pa /etc/hosts.allow, /etc/hosts.deny | |
994 | If compiled with | |
995 | .Sy LIBWRAP | |
996 | support, tcp-wrappers access controls may be defined here as described in | |
997 | .Xr hosts_access 5 . | |
998 | .It Pa $HOME/.rhosts | |
999 | This file contains host-username pairs, separated by a space, one per | |
1000 | line. | |
1001 | The given user on the corresponding host is permitted to log in | |
1002 | without password. | |
1003 | The same file is used by rlogind and rshd. | |
1004 | The file must | |
1005 | be writable only by the user; it is recommended that it not be | |
1006 | accessible by others. | |
1007 | .Pp | |
1008 | If is also possible to use netgroups in the file. | |
1009 | Either host or user | |
1010 | name may be of the form +@groupname to specify all hosts or all users | |
1011 | in the group. | |
1012 | .It Pa $HOME/.shosts | |
1013 | For ssh, | |
1014 | this file is exactly the same as for | |
1015 | .Pa .rhosts . | |
1016 | However, this file is | |
1017 | not used by rlogin and rshd, so using this permits access using SSH only. | |
1018 | .It Pa /etc/hosts.equiv | |
1019 | This file is used during | |
1020 | .Pa .rhosts | |
1021 | authentication. | |
1022 | In the simplest form, this file contains host names, one per line. | |
1023 | Users on | |
1024 | those hosts are permitted to log in without a password, provided they | |
1025 | have the same user name on both machines. | |
1026 | The host name may also be | |
1027 | followed by a user name; such users are permitted to log in as | |
1028 | .Em any | |
1029 | user on this machine (except root). | |
1030 | Additionally, the syntax | |
1031 | .Dq +@group | |
1032 | can be used to specify netgroups. | |
1033 | Negated entries start with | |
1034 | .Ql \&- . | |
1035 | .Pp | |
1036 | If the client host/user is successfully matched in this file, login is | |
1037 | automatically permitted provided the client and server user names are the | |
1038 | same. | |
1039 | Additionally, successful RSA host authentication is normally required. | |
1040 | This file must be writable only by root; it is recommended | |
1041 | that it be world-readable. | |
1042 | .Pp | |
1043 | .Sy "Warning: It is almost never a good idea to use user names in" | |
1044 | .Pa hosts.equiv . | |
1045 | Beware that it really means that the named user(s) can log in as | |
1046 | .Em anybody , | |
1047 | which includes bin, daemon, adm, and other accounts that own critical | |
1048 | binaries and directories. | |
1049 | Using a user name practically grants the user root access. | |
1050 | The only valid use for user names that I can think | |
1051 | of is in negative entries. | |
1052 | .Pp | |
1053 | Note that this warning also applies to rsh/rlogin. | |
1054 | .It Pa /etc/shosts.equiv | |
1055 | This is processed exactly as | |
1056 | .Pa /etc/hosts.equiv . | |
1057 | However, this file may be useful in environments that want to run both | |
1058 | rsh/rlogin and ssh. | |
1059 | .It Pa $HOME/.ssh/environment | |
1060 | This file is read into the environment at login (if it exists). | |
1061 | It can only contain empty lines, comment lines (that start with | |
1062 | .Ql # ) , | |
1063 | and assignment lines of the form name=value. | |
1064 | The file should be writable | |
1065 | only by the user; it need not be readable by anyone else. | |
1066 | .It Pa $HOME/.ssh/rc | |
1067 | If this file exists, it is run with /bin/sh after reading the | |
1068 | environment files but before starting the user's shell or command. | |
1069 | If X11 spoofing is in use, this will receive the "proto cookie" pair in | |
1070 | standard input (and | |
1071 | .Ev DISPLAY | |
1072 | in environment). | |
1073 | This must call | |
1074 | .Xr xauth 1 | |
1075 | in that case. | |
1076 | .Pp | |
1077 | The primary purpose of this file is to run any initialization routines | |
1078 | which may be needed before the user's home directory becomes | |
1079 | accessible; AFS is a particular example of such an environment. | |
1080 | .Pp | |
1081 | This file will probably contain some initialization code followed by | |
1082 | something similar to: "if read proto cookie; then echo add $DISPLAY | |
1083 | $proto $cookie | xauth -q -; fi". | |
1084 | .Pp | |
1085 | If this file does not exist, | |
1086 | .Pa /etc/sshrc | |
1087 | is run, and if that | |
1088 | does not exist either, xauth is used to store the cookie. | |
1089 | .Pp | |
1090 | This file should be writable only by the user, and need not be | |
1091 | readable by anyone else. | |
1092 | .It Pa /etc/sshrc | |
1093 | Like | |
1094 | .Pa $HOME/.ssh/rc . | |
1095 | This can be used to specify | |
1096 | machine-specific login-time initializations globally. | |
1097 | This file should be writable only by root, and should be world-readable. | |
1098 | .El | |
1099 | .Sh AUTHORS | |
1100 | OpenSSH is a derivative of the original and free | |
1101 | ssh 1.2.12 release by Tatu Ylonen. | |
1102 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, | |
1103 | Theo de Raadt and Dug Song | |
1104 | removed many bugs, re-added newer features and | |
1105 | created OpenSSH. | |
1106 | Markus Friedl contributed the support for SSH | |
1107 | protocol versions 1.5 and 2.0. | |
1108 | .Sh SEE ALSO | |
1109 | .Xr scp 1 , | |
1110 | .Xr sftp 1 , | |
1111 | .Xr sftp-server 8 , | |
1112 | .Xr ssh 1 , | |
1113 | .Xr ssh-add 1 , | |
1114 | .Xr ssh-agent 1 , | |
1115 | .Xr ssh-keygen 1 , | |
1116 | .Xr rlogin 1 , | |
1117 | .Xr rsh 1 |