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