]> andersk Git - openssh.git/blob - sshd.8
- jmc@cvs.openbsd.org 2006/02/19 19:52:10
[openssh.git] / sshd.8
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.226 2006/02/19 19:52:10 jmc 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 .Bk -words
47 .Op Fl 46Ddeiqt
48 .Op Fl b Ar bits
49 .Op Fl f Ar config_file
50 .Op Fl g Ar login_grace_time
51 .Op Fl h Ar host_key_file
52 .Op Fl k Ar key_gen_time
53 .Op Fl o Ar option
54 .Op Fl p Ar port
55 .Op Fl u Ar len
56 .Ek
57 .Sh DESCRIPTION
58 .Nm
59 (OpenSSH Daemon) is the daemon program for
60 .Xr ssh 1 .
61 Together these programs replace rlogin and rsh, and
62 provide secure encrypted communications between two untrusted hosts
63 over an insecure network.
64 .Pp
65 .Nm
66 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 .Pp
75 .Nm
76 can be configured using command-line options or a configuration file
77 (by default
78 .Xr sshd_config 5 ) ;
79 command-line options override values specified in the
80 configuration file.
81 .Nm
82 rereads its configuration file when it receives a hangup signal,
83 .Dv SIGHUP ,
84 by executing itself with the name and options it was started with, e.g.,
85 .Pa /usr/sbin/sshd .
86 .Pp
87 The options are as follows:
88 .Bl -tag -width Ds
89 .It Fl 4
90 Forces
91 .Nm
92 to use IPv4 addresses only.
93 .It Fl 6
94 Forces
95 .Nm
96 to use IPv6 addresses only.
97 .It Fl b Ar bits
98 Specifies the number of bits in the ephemeral protocol version 1
99 server key (default 768).
100 .It Fl D
101 When this option is specified,
102 .Nm
103 will not detach and does not become a daemon.
104 This allows easy monitoring of
105 .Nm sshd .
106 .It Fl d
107 Debug mode.
108 The server sends verbose debug output to the system
109 log, and does not put itself in the background.
110 The server also will not fork and will only process one connection.
111 This option is only intended for debugging for the server.
112 Multiple
113 .Fl d
114 options increase the debugging level.
115 Maximum is 3.
116 .It Fl e
117 When this option is specified,
118 .Nm
119 will send the output to the standard error instead of the system log.
120 .It Fl f Ar configuration_file
121 Specifies the name of the configuration file.
122 The default is
123 .Pa /etc/ssh/sshd_config .
124 .Nm
125 refuses to start if there is no configuration file.
126 .It Fl g Ar login_grace_time
127 Gives the grace time for clients to authenticate themselves (default
128 120 seconds).
129 If the client fails to authenticate the user within
130 this many seconds, the server disconnects and exits.
131 A value of zero indicates no limit.
132 .It Fl h Ar host_key_file
133 Specifies a file from which a host key is read.
134 This option must be given if
135 .Nm
136 is not run as root (as the normal
137 host key files are normally not readable by anyone but root).
138 The default is
139 .Pa /etc/ssh/ssh_host_key
140 for protocol version 1, and
141 .Pa /etc/ssh/ssh_host_rsa_key
142 and
143 .Pa /etc/ssh/ssh_host_dsa_key
144 for protocol version 2.
145 It is possible to have multiple host key files for
146 the different protocol versions and host key algorithms.
147 .It Fl i
148 Specifies that
149 .Nm
150 is being run from
151 .Xr inetd 8 .
152 .Nm
153 is normally not run
154 from inetd because it needs to generate the server key before it can
155 respond to the client, and this may take tens of seconds.
156 Clients would have to wait too long if the key was regenerated every time.
157 However, with small key sizes (e.g., 512) using
158 .Nm
159 from inetd may
160 be feasible.
161 .It Fl k Ar key_gen_time
162 Specifies how often the ephemeral protocol version 1 server key is
163 regenerated (default 3600 seconds, or one hour).
164 The motivation for regenerating the key fairly
165 often is that the key is not stored anywhere, and after about an hour
166 it becomes impossible to recover the key for decrypting intercepted
167 communications even if the machine is cracked into or physically
168 seized.
169 A value of zero indicates that the key will never be regenerated.
170 .It Fl o Ar option
171 Can be used to give options in the format used in the configuration file.
172 This is useful for specifying options for which there is no separate
173 command-line flag.
174 For full details of the options, and their values, see
175 .Xr sshd_config 5 .
176 .It Fl p Ar port
177 Specifies the port on which the server listens for connections
178 (default 22).
179 Multiple port options are permitted.
180 Ports specified in the configuration file with the
181 .Cm Port
182 option are ignored when a command-line port is specified.
183 Ports specified using the
184 .Cm ListenAddress
185 option override command-line ports.
186 .It Fl q
187 Quiet mode.
188 Nothing is sent to the system log.
189 Normally the beginning,
190 authentication, and termination of each connection is logged.
191 .It Fl t
192 Test mode.
193 Only check the validity of the configuration file and sanity of the keys.
194 This is useful for updating
195 .Nm
196 reliably as configuration options may change.
197 .It Fl u Ar len
198 This option is used to specify the size of the field
199 in the
200 .Li utmp
201 structure that holds the remote host name.
202 If the resolved host name is longer than
203 .Ar len ,
204 the dotted decimal value will be used instead.
205 This allows hosts with very long host names that
206 overflow this field to still be uniquely identified.
207 Specifying
208 .Fl u0
209 indicates that only dotted decimal addresses
210 should be put into the
211 .Pa utmp
212 file.
213 .Fl u0
214 may also be used to prevent
215 .Nm
216 from making DNS requests unless the authentication
217 mechanism or configuration requires it.
218 Authentication mechanisms that may require DNS include
219 .Cm RhostsRSAAuthentication ,
220 .Cm HostbasedAuthentication ,
221 and using a
222 .Cm from="pattern-list"
223 option in a key file.
224 Configuration options that require DNS include using a
225 USER@HOST pattern in
226 .Cm AllowUsers
227 or
228 .Cm DenyUsers .
229 .El
230 .Sh AUTHENTICATION
231 The OpenSSH SSH daemon supports SSH protocols 1 and 2.
232 Both protocols are supported by default,
233 though this can be changed via the
234 .Cm Protocol
235 option in
236 .Xr sshd_config 5 .
237 Protocol 2 supports both RSA and DSA keys;
238 protocol 1 only supports RSA keys.
239 For both protocols,
240 each host has a host-specific key,
241 normally 2048 bits,
242 used to identify the host.
243 .Pp
244 Forward security for protocol 1 is provided through
245 an additional server key,
246 normally 768 bits,
247 generated when the server starts.
248 This key is normally regenerated every hour if it has been used, and
249 is never stored on disk.
250 Whenever a client connects, the daemon responds with its public
251 host and server keys.
252 The client compares the
253 RSA host key against its own database to verify that it has not changed.
254 The client then generates a 256-bit random number.
255 It encrypts this
256 random number using both the host key and the server key, and sends
257 the encrypted number to the server.
258 Both sides then use this
259 random number as a session key which is used to encrypt all further
260 communications in the session.
261 The rest of the session is encrypted
262 using a conventional cipher, currently Blowfish or 3DES, with 3DES
263 being used by default.
264 The client selects the encryption algorithm
265 to use from those offered by the server.
266 .Pp
267 For protocol 2,
268 forward security is provided through a Diffie-Hellman key agreement.
269 This key agreement results in a shared session key.
270 The rest of the session is encrypted using a symmetric cipher, currently
271 128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES.
272 The client selects the encryption algorithm
273 to use from those offered by the server.
274 Additionally, session integrity is provided
275 through a cryptographic message authentication code
276 (hmac-sha1 or hmac-md5).
277 .Pp
278 Finally, the server and the client enter an authentication dialog.
279 The client tries to authenticate itself using
280 host-based authentication,
281 public key authentication,
282 challenge-response authentication,
283 or password authentication.
284 .Pp
285 Regardless of the authentication type, the account is checked to
286 ensure that it is accessible.  An account is not accessible if it is
287 locked, listed in
288 .Cm DenyUsers
289 or its group is listed in
290 .Cm DenyGroups
291 \&.  The definition of a locked account is system dependant. Some platforms
292 have their own account database (eg AIX) and some modify the passwd field (
293 .Ql \&*LK\&*
294 on Solaris and UnixWare,
295 .Ql \&*
296 on HP-UX, containing
297 .Ql Nologin
298 on Tru64,
299 a leading
300 .Ql \&*LOCKED\&*
301 on FreeBSD and a leading
302 .Ql \&!!
303 on Linux).  If there is a requirement to disable password authentication
304 for the account while allowing still public-key, then the passwd field
305 should be set to something other than these values (eg
306 .Ql NP
307 or
308 .Ql \&*NP\&*
309 ).
310 .Pp
311 If the client successfully authenticates itself, a dialog for
312 preparing the session is entered.
313 At this time the client may request
314 things like allocating a pseudo-tty, forwarding X11 connections,
315 forwarding TCP connections, or forwarding the authentication agent
316 connection over the secure channel.
317 .Pp
318 After this, the client either requests a shell or execution of a command.
319 The sides then enter session mode.
320 In this mode, either side may send
321 data at any time, and such data is forwarded to/from the shell or
322 command on the server side, and the user terminal in the client side.
323 .Pp
324 When the user program terminates and all forwarded X11 and other
325 connections have been closed, the server sends command exit status to
326 the client, and both sides exit.
327 .Sh LOGIN PROCESS
328 When a user successfully logs in,
329 .Nm
330 does the following:
331 .Bl -enum -offset indent
332 .It
333 If the login is on a tty, and no command has been specified,
334 prints last login time and
335 .Pa /etc/motd
336 (unless prevented in the configuration file or by
337 .Pa ~/.hushlogin ;
338 see the
339 .Sx FILES
340 section).
341 .It
342 If the login is on a tty, records login time.
343 .It
344 Checks
345 .Pa /etc/nologin ;
346 if it exists, prints contents and quits
347 (unless root).
348 .It
349 Changes to run with normal user privileges.
350 .It
351 Sets up basic environment.
352 .It
353 Reads the file
354 .Pa ~/.ssh/environment ,
355 if it exists, and users are allowed to change their environment.
356 See the
357 .Cm PermitUserEnvironment
358 option in
359 .Xr sshd_config 5 .
360 .It
361 Changes to user's home directory.
362 .It
363 If
364 .Pa ~/.ssh/rc
365 exists, runs it; else if
366 .Pa /etc/ssh/sshrc
367 exists, runs
368 it; otherwise runs xauth.
369 The
370 .Dq rc
371 files are given the X11
372 authentication protocol and cookie in standard input.
373 See
374 .Sx SSHRC ,
375 below.
376 .It
377 Runs user's shell or command.
378 .El
379 .Sh SSHRC
380 If the file
381 .Pa ~/.ssh/rc
382 exists,
383 .Xr sh 1
384 runs it after reading the
385 environment files but before starting the user's shell or command.
386 It must not produce any output on stdout; stderr must be used
387 instead.
388 If X11 forwarding is in use, it will receive the "proto cookie" pair in
389 its standard input (and
390 .Ev DISPLAY
391 in its environment).
392 The script must call
393 .Xr xauth 1
394 because
395 .Nm
396 will not run xauth automatically to add X11 cookies.
397 .Pp
398 The primary purpose of this file is to run any initialization routines
399 which may be needed before the user's home directory becomes
400 accessible; AFS is a particular example of such an environment.
401 .Pp
402 This file will probably contain some initialization code followed by
403 something similar to:
404 .Bd -literal -offset 3n
405 if read proto cookie && [ -n "$DISPLAY" ]; then
406         if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
407                 # X11UseLocalhost=yes
408                 echo add unix:`echo $DISPLAY |
409                     cut -c11-` $proto $cookie
410         else
411                 # X11UseLocalhost=no
412                 echo add $DISPLAY $proto $cookie
413         fi | xauth -q -
414 fi
415 .Ed
416 .Pp
417 If this file does not exist,
418 .Pa /etc/ssh/sshrc
419 is run, and if that
420 does not exist either, xauth is used to add the cookie.
421 .Sh AUTHORIZED_KEYS FILE FORMAT
422 .Cm AuthorizedKeysFile
423 specifies the file containing public keys for
424 public key authentication;
425 if none is specified, the default is
426 .Pa ~/.ssh/authorized_keys .
427 Each line of the file contains one
428 key (empty lines and lines starting with a
429 .Ql #
430 are ignored as
431 comments).
432 Protocol 1 public keys consist of the following space-separated fields:
433 options, bits, exponent, modulus, comment.
434 Protocol 2 public key consist of:
435 options, keytype, base64-encoded key, comment.
436 The options field is optional;
437 its presence is determined by whether the line starts
438 with a number or not (the options field never starts with a number).
439 The bits, exponent, modulus, and comment fields give the RSA key for
440 protocol version 1; the
441 comment field is not used for anything (but may be convenient for the
442 user to identify the key).
443 For protocol version 2 the keytype is
444 .Dq ssh-dss
445 or
446 .Dq ssh-rsa .
447 .Pp
448 Note that lines in this file are usually several hundred bytes long
449 (because of the size of the public key encoding) up to a limit of
450 8 kilobytes, which permits DSA keys up to 8 kilobits and RSA
451 keys up to 16 kilobits.
452 You don't want to type them in; instead, copy the
453 .Pa identity.pub ,
454 .Pa id_dsa.pub ,
455 or the
456 .Pa id_rsa.pub
457 file and edit it.
458 .Pp
459 .Nm
460 enforces a minimum RSA key modulus size for protocol 1
461 and protocol 2 keys of 768 bits.
462 .Pp
463 The options (if present) consist of comma-separated option
464 specifications.
465 No spaces are permitted, except within double quotes.
466 The following option specifications are supported (note
467 that option keywords are case-insensitive):
468 .Bl -tag -width Ds
469 .It Cm command="command"
470 Specifies that the command is executed whenever this key is used for
471 authentication.
472 The command supplied by the user (if any) is ignored.
473 The command is run on a pty if the client requests a pty;
474 otherwise it is run without a tty.
475 If an 8-bit clean channel is required,
476 one must not request a pty or should specify
477 .Cm no-pty .
478 A quote may be included in the command by quoting it with a backslash.
479 This option might be useful
480 to restrict certain public keys to perform just a specific operation.
481 An example might be a key that permits remote backups but nothing else.
482 Note that the client may specify TCP and/or X11
483 forwarding unless they are explicitly prohibited.
484 Note that this option applies to shell, command or subsystem execution.
485 .It Cm environment="NAME=value"
486 Specifies that the string is to be added to the environment when
487 logging in using this key.
488 Environment variables set this way
489 override other default environment values.
490 Multiple options of this type are permitted.
491 Environment processing is disabled by default and is
492 controlled via the
493 .Cm PermitUserEnvironment
494 option.
495 This option is automatically disabled if
496 .Cm UseLogin
497 is enabled.
498 .It Cm from="pattern-list"
499 Specifies that in addition to public key authentication, the canonical name
500 of the remote host must be present in the comma-separated list of
501 patterns
502 .Pf ( Ql *
503 and
504 .Ql \&?
505 serve as wildcards).
506 The list may also contain
507 patterns negated by prefixing them with
508 .Ql \&! ;
509 if the canonical host name matches a negated pattern, the key is not accepted.
510 The purpose
511 of this option is to optionally increase security: public key authentication
512 by itself does not trust the network or name servers or anything (but
513 the key); however, if somebody somehow steals the key, the key
514 permits an intruder to log in from anywhere in the world.
515 This additional option makes using a stolen key more difficult (name
516 servers and/or routers would have to be compromised in addition to
517 just the key).
518 .It Cm no-agent-forwarding
519 Forbids authentication agent forwarding when this key is used for
520 authentication.
521 .It Cm no-port-forwarding
522 Forbids TCP forwarding when this key is used for authentication.
523 Any port forward requests by the client will return an error.
524 This might be used, e.g., in connection with the
525 .Cm command
526 option.
527 .It Cm no-pty
528 Prevents tty allocation (a request to allocate a pty will fail).
529 .It Cm no-X11-forwarding
530 Forbids X11 forwarding when this key is used for authentication.
531 Any X11 forward requests by the client will return an error.
532 .It Cm permitopen="host:port"
533 Limit local
534 .Li ``ssh -L''
535 port forwarding such that it may only connect to the specified host and
536 port.
537 IPv6 addresses can be specified with an alternative syntax:
538 .Ar host Ns / Ns Ar port .
539 Multiple
540 .Cm permitopen
541 options may be applied separated by commas.
542 No pattern matching is performed on the specified hostnames,
543 they must be literal domains or addresses.
544 .It Cm tunnel="n"
545 Force a
546 .Xr tun 4
547 device on the server.
548 Without this option, the next available device will be used if
549 the client requests a tunnel.
550 .El
551 .Pp
552 An example authorized_keys file:
553 .Bd -literal -offset 3n
554 # Comments allowed at start of line
555 ssh-rsa AAAAB3Nza...LiPk== user@example.net
556 from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
557 AAAAB2...19Q== john@example.net
558 command="dump /home",no-pty,no-port-forwarding ssh-dss
559 AAAAC3...51R== example.net
560 permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
561 AAAAB5...21S==
562 tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
563 jane@example.net
564 .Ed
565 .Sh SSH_KNOWN_HOSTS FILE FORMAT
566 The
567 .Pa /etc/ssh/ssh_known_hosts
568 and
569 .Pa ~/.ssh/known_hosts
570 files contain host public keys for all known hosts.
571 The global file should
572 be prepared by the administrator (optional), and the per-user file is
573 maintained automatically: whenever the user connects from an unknown host,
574 its key is added to the per-user file.
575 .Pp
576 Each line in these files contains the following fields: hostnames,
577 bits, exponent, modulus, comment.
578 The fields are separated by spaces.
579 .Pp
580 Hostnames is a comma-separated list of patterns
581 .Pf ( Ql *
582 and
583 .Ql \&?
584 act as
585 wildcards); each pattern in turn is matched against the canonical host
586 name (when authenticating a client) or against the user-supplied
587 name (when authenticating a server).
588 A pattern may also be preceded by
589 .Ql \&!
590 to indicate negation: if the host name matches a negated
591 pattern, it is not accepted (by that line) even if it matched another
592 pattern on the line.
593 .Pp
594 Alternately, hostnames may be stored in a hashed form which hides host names
595 and addresses should the file's contents be disclosed.
596 Hashed hostnames start with a
597 .Ql |
598 character.
599 Only one hashed hostname may appear on a single line and none of the above
600 negation or wildcard operators may be applied.
601 .Pp
602 Bits, exponent, and modulus are taken directly from the RSA host key; they
603 can be obtained, for example, from
604 .Pa /etc/ssh/ssh_host_key.pub .
605 The optional comment field continues to the end of the line, and is not used.
606 .Pp
607 Lines starting with
608 .Ql #
609 and empty lines are ignored as comments.
610 .Pp
611 When performing host authentication, authentication is accepted if any
612 matching line has the proper key.
613 It is thus permissible (but not
614 recommended) to have several lines or different host keys for the same
615 names.
616 This will inevitably happen when short forms of host names
617 from different domains are put in the file.
618 It is possible
619 that the files contain conflicting information; authentication is
620 accepted if valid information can be found from either file.
621 .Pp
622 Note that the lines in these files are typically hundreds of characters
623 long, and you definitely don't want to type in the host keys by hand.
624 Rather, generate them by a script
625 or by taking
626 .Pa /etc/ssh/ssh_host_key.pub
627 and adding the host names at the front.
628 .Pp
629 An example ssh_known_hosts file:
630 .Bd -literal -offset 3n
631 # Comments allowed at start of line
632 closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
633 cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
634 # A hashed hostname
635 |1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
636 AAAA1234.....=
637 .Ed
638 .Sh FILES
639 .Bl -tag -width Ds -compact
640 .It ~/.hushlogin
641 This file is used to suppress printing the last login time and
642 .Pa /etc/motd ,
643 if
644 .Cm PrintLastLog
645 and
646 .Cm PrintMotd ,
647 respectively,
648 are enabled.
649 It does not suppress printing of the banner specified by
650 .Cm Banner .
651 .Pp
652 .It ~/.rhosts
653 This file is used for host-based authentication (see
654 .Xr ssh 1
655 for more information).
656 On some machines this file may need to be
657 world-readable if the user's home directory is on an NFS partition,
658 because
659 .Nm
660 reads it as root.
661 Additionally, this file must be owned by the user,
662 and must not have write permissions for anyone else.
663 The recommended
664 permission for most machines is read/write for the user, and not
665 accessible by others.
666 .Pp
667 .It ~/.shosts
668 This file is used in exactly the same way as
669 .Pa .rhosts ,
670 but allows host-based authentication without permitting login with
671 rlogin/rsh.
672 .Pp
673 .It ~/.ssh/authorized_keys
674 Lists the public keys (RSA/DSA) that can be used for logging in as this user.
675 The format of this file is described above.
676 This file is not highly sensitive, but the recommended
677 permissions are read/write for the user, and not accessible by others.
678 .Pp
679 .It ~/.ssh/environment
680 This file is read into the environment at login (if it exists).
681 It can only contain empty lines, comment lines (that start with
682 .Ql # ) ,
683 and assignment lines of the form name=value.
684 The file should be writable
685 only by the user; it need not be readable by anyone else.
686 Environment processing is disabled by default and is
687 controlled via the
688 .Cm PermitUserEnvironment
689 option.
690 .Pp
691 .It ~/.ssh/known_hosts
692 Contains a list of host keys for all hosts the user has logged into
693 that are not already in the systemwide list of known host keys.
694 The format of this file is described above.
695 This file should be writable only by root/the owner and
696 can, but need not be, world-readable.
697 .Pp
698 .It ~/.ssh/rc
699 Contains initialization routines to be run before
700 the user's home directory becomes accessible.
701 This file should be writable only by the user, and need not be
702 readable by anyone else.
703 .Pp
704 .It /etc/hosts.allow
705 .It /etc/hosts.deny
706 Access controls that should be enforced by tcp-wrappers are defined here.
707 Further details are described in
708 .Xr hosts_access 5 .
709 .Pp
710 .It /etc/hosts.equiv
711 This file is used during
712 .Cm RhostsRSAAuthentication
713 and
714 .Cm HostbasedAuthentication
715 authentication.
716 In the simplest form, this file contains host names, one per line.
717 Users on
718 those hosts are permitted to log in without a password, provided they
719 have the same user name on both machines.
720 The host name may also be
721 followed by a user name; such users are permitted to log in as
722 .Em any
723 user on this machine (except root).
724 Additionally, the syntax
725 .Dq +@group
726 can be used to specify netgroups.
727 Negated entries start with
728 .Ql \&- .
729 .Pp
730 If the client host/user is successfully matched in this file, login is
731 automatically permitted provided the client and server user names are the
732 same.
733 Additionally, successful client host key authentication is required.
734 This file must be writable only by root; it is recommended
735 that it be world-readable.
736 .Pp
737 .Sy "Warning: It is almost never a good idea to use user names in"
738 .Pa hosts.equiv .
739 Beware that it really means that the named user(s) can log in as
740 .Em anybody ,
741 which includes bin, daemon, adm, and other accounts that own critical
742 binaries and directories.
743 Using a user name practically grants the user root access.
744 The only valid use for user names that I can think
745 of is in negative entries.
746 .Pp
747 Note that this warning also applies to rsh/rlogin.
748 .Pp
749 .It /etc/moduli
750 Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
751 The file format is described in
752 .Xr moduli 5 .
753 .Pp
754 .It /etc/motd
755 See
756 .Xr motd 5 .
757 .Pp
758 .It /etc/nologin
759 If this file exists,
760 .Nm
761 refuses to let anyone except root log in.
762 The contents of the file
763 are displayed to anyone trying to log in, and non-root connections are
764 refused.
765 The file should be world-readable.
766 .Pp
767 .It /etc/shosts.equiv
768 This is processed exactly as
769 .Pa /etc/hosts.equiv .
770 However, this file may be useful in environments that want to run both
771 rsh/rlogin and ssh.
772 .Pp
773 .It /etc/ssh/ssh_known_hosts
774 Systemwide list of known host keys.
775 This file should be prepared by the
776 system administrator to contain the public host keys of all machines in the
777 organization.
778 The format of this file is described above.
779 This file should be writable only by root/the owner and
780 should be world-readable.
781 .Pp
782 .It /etc/ssh/ssh_host_key
783 .It /etc/ssh/ssh_host_dsa_key
784 .It /etc/ssh/ssh_host_rsa_key
785 These three files contain the private parts of the host keys.
786 These files should only be owned by root, readable only by root, and not
787 accessible to others.
788 Note that
789 .Nm
790 does not start if this file is group/world-accessible.
791 .Pp
792 .It /etc/ssh/ssh_host_key.pub
793 .It /etc/ssh/ssh_host_dsa_key.pub
794 .It /etc/ssh/ssh_host_rsa_key.pub
795 These three files contain the public parts of the host keys.
796 These files should be world-readable but writable only by
797 root.
798 Their contents should match the respective private parts.
799 These files are not
800 really used for anything; they are provided for the convenience of
801 the user so their contents can be copied to known hosts files.
802 These files are created using
803 .Xr ssh-keygen 1 .
804 .Pp
805 .It /etc/ssh/sshd_config
806 Contains configuration data for
807 .Nm sshd .
808 The file format and configuration options are described in
809 .Xr sshd_config 5 .
810 .Pp
811 .It /etc/ssh/sshrc
812 Similar to
813 .Pa ~/.ssh/rc ,
814 it can be used to specify
815 machine-specific login-time initializations globally.
816 This file should be writable only by root, and should be world-readable.
817 .Pp
818 .It /var/empty
819 .Xr chroot 2
820 directory used by
821 .Nm
822 during privilege separation in the pre-authentication phase.
823 The directory should not contain any files and must be owned by root
824 and not group or world-writable.
825 .Pp
826 .It /var/run/sshd.pid
827 Contains the process ID of the
828 .Nm
829 listening for connections (if there are several daemons running
830 concurrently for different ports, this contains the process ID of the one
831 started last).
832 The content of this file is not sensitive; it can be world-readable.
833 .El
834 .Sh SEE ALSO
835 .Xr scp 1 ,
836 .Xr sftp 1 ,
837 .Xr ssh 1 ,
838 .Xr ssh-add 1 ,
839 .Xr ssh-agent 1 ,
840 .Xr ssh-keygen 1 ,
841 .Xr chroot 2 ,
842 .Xr hosts_access 5 ,
843 .Xr login.conf 5 ,
844 .Xr moduli 5 ,
845 .Xr sshd_config 5 ,
846 .Xr inetd 8 ,
847 .Xr sftp-server 8
848 .Sh AUTHORS
849 OpenSSH is a derivative of the original and free
850 ssh 1.2.12 release by Tatu Ylonen.
851 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
852 Theo de Raadt and Dug Song
853 removed many bugs, re-added newer features and
854 created OpenSSH.
855 Markus Friedl contributed the support for SSH
856 protocol versions 1.5 and 2.0.
857 Niels Provos and Markus Friedl contributed support
858 for privilege separation.
859 .Sh CAVEATS
860 System security is not improved unless
861 .Nm rshd ,
862 .Nm rlogind ,
863 and
864 .Nm rexecd
865 are disabled (thus completely disabling
866 .Xr rlogin
867 and
868 .Xr rsh
869 into the machine).
This page took 0.120321 seconds and 5 git commands to generate.