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