]> CyberLeo.Net >> Repos - FreeBSD/releng/7.2.git/blob - crypto/openssh/sshd.8
Create releng/7.2 from stable/7 in preparation for 7.2-RELEASE.
[FreeBSD/releng/7.2.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.246 2008/07/02 02:24:18 djm Exp $
38 .\" $FreeBSD$
39 .Dd July 2 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_dsa_key
165 for protocol version 2.
166 It is possible to have multiple host key files for
167 the different protocol versions and host key algorithms.
168 .It Fl i
169 Specifies that
170 .Nm
171 is being run from
172 .Xr inetd 8 .
173 .Nm
174 is normally not run
175 from inetd because it needs to generate the server key before it can
176 respond to the client, and this may take tens of seconds.
177 Clients would have to wait too long if the key was regenerated every time.
178 However, with small key sizes (e.g. 512) using
179 .Nm
180 from inetd may
181 be feasible.
182 .It Fl k Ar key_gen_time
183 Specifies how often the ephemeral protocol version 1 server key is
184 regenerated (default 3600 seconds, or one hour).
185 The motivation for regenerating the key fairly
186 often is that the key is not stored anywhere, and after about an hour
187 it becomes impossible to recover the key for decrypting intercepted
188 communications even if the machine is cracked into or physically
189 seized.
190 A value of zero indicates that the key will never be regenerated.
191 .It Fl o Ar option
192 Can be used to give options in the format used in the configuration file.
193 This is useful for specifying options for which there is no separate
194 command-line flag.
195 For full details of the options, and their values, see
196 .Xr sshd_config 5 .
197 .It Fl p Ar port
198 Specifies the port on which the server listens for connections
199 (default 22).
200 Multiple port options are permitted.
201 Ports specified in the configuration file with the
202 .Cm Port
203 option are ignored when a command-line port is specified.
204 Ports specified using the
205 .Cm ListenAddress
206 option override command-line ports.
207 .It Fl q
208 Quiet mode.
209 Nothing is sent to the system log.
210 Normally the beginning,
211 authentication, and termination of each connection is logged.
212 .It Fl T
213 Extended test mode.
214 Check the validity of the configuration file, output the effective configuration
215 to stdout and then exit.
216 Optionally,
217 .Cm Match
218 rules may be applied by specifying the connection parameters using one or more
219 .Fl C
220 options.
221 .It Fl t
222 Test mode.
223 Only check the validity of the configuration file and sanity of the keys.
224 This is useful for updating
225 .Nm
226 reliably as configuration options may change.
227 .It Fl u Ar len
228 This option is used to specify the size of the field
229 in the
230 .Li utmp
231 structure that holds the remote host name.
232 If the resolved host name is longer than
233 .Ar len ,
234 the dotted decimal value will be used instead.
235 This allows hosts with very long host names that
236 overflow this field to still be uniquely identified.
237 Specifying
238 .Fl u0
239 indicates that only dotted decimal addresses
240 should be put into the
241 .Pa utmp
242 file.
243 .Fl u0
244 may also be used to prevent
245 .Nm
246 from making DNS requests unless the authentication
247 mechanism or configuration requires it.
248 Authentication mechanisms that may require DNS include
249 .Cm RhostsRSAAuthentication ,
250 .Cm HostbasedAuthentication ,
251 and using a
252 .Cm from="pattern-list"
253 option in a key file.
254 Configuration options that require DNS include using a
255 USER@HOST pattern in
256 .Cm AllowUsers
257 or
258 .Cm DenyUsers .
259 .El
260 .Sh AUTHENTICATION
261 The OpenSSH SSH daemon supports SSH protocols 1 and 2.
262 Both protocols are supported by default,
263 though this can be changed via the
264 .Cm Protocol
265 option in
266 .Xr sshd_config 5 .
267 Protocol 2 supports both RSA and DSA keys;
268 protocol 1 only supports RSA keys.
269 For both protocols,
270 each host has a host-specific key,
271 normally 2048 bits,
272 used to identify the host.
273 .Pp
274 Forward security for protocol 1 is provided through
275 an additional server key,
276 normally 768 bits,
277 generated when the server starts.
278 This key is normally regenerated every hour if it has been used, and
279 is never stored on disk.
280 Whenever a client connects, the daemon responds with its public
281 host and server keys.
282 The client compares the
283 RSA host key against its own database to verify that it has not changed.
284 The client then generates a 256-bit random number.
285 It encrypts this
286 random number using both the host key and the server key, and sends
287 the encrypted number to the server.
288 Both sides then use this
289 random number as a session key which is used to encrypt all further
290 communications in the session.
291 The rest of the session is encrypted
292 using a conventional cipher, currently Blowfish or 3DES, with 3DES
293 being used by default.
294 The client selects the encryption algorithm
295 to use from those offered by the server.
296 .Pp
297 For protocol 2,
298 forward security is provided through a Diffie-Hellman key agreement.
299 This key agreement results in a shared session key.
300 The rest of the session is encrypted using a symmetric cipher, currently
301 128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES.
302 The client selects the encryption algorithm
303 to use from those offered by the server.
304 Additionally, session integrity is provided
305 through a cryptographic message authentication code
306 (hmac-md5, hmac-sha1, umac-64 or hmac-ripemd160).
307 .Pp
308 Finally, the server and the client enter an authentication dialog.
309 The client tries to authenticate itself using
310 host-based authentication,
311 public key authentication,
312 challenge-response authentication,
313 or password authentication.
314 .Pp
315 Regardless of the authentication type, the account is checked to
316 ensure that it is accessible.  An account is not accessible if it is
317 locked, listed in
318 .Cm DenyUsers
319 or its group is listed in
320 .Cm DenyGroups
321 \&.  The definition of a locked account is system dependant. Some platforms
322 have their own account database (eg AIX) and some modify the passwd field (
323 .Ql \&*LK\&*
324 on Solaris and UnixWare,
325 .Ql \&*
326 on HP-UX, containing
327 .Ql Nologin
328 on Tru64,
329 a leading
330 .Ql \&*LOCKED\&*
331 on FreeBSD and a leading
332 .Ql \&!
333 on most Linuxes).
334 If there is a requirement to disable password authentication
335 for the account while allowing still public-key, then the passwd field
336 should be set to something other than these values (eg
337 .Ql NP
338 or
339 .Ql \&*NP\&*
340 ).
341 .Pp
342 If the client successfully authenticates itself, a dialog for
343 preparing the session is entered.
344 At this time the client may request
345 things like allocating a pseudo-tty, forwarding X11 connections,
346 forwarding TCP connections, or forwarding the authentication agent
347 connection over the secure channel.
348 .Pp
349 After this, the client either requests a shell or execution of a command.
350 The sides then enter session mode.
351 In this mode, either side may send
352 data at any time, and such data is forwarded to/from the shell or
353 command on the server side, and the user terminal in the client side.
354 .Pp
355 When the user program terminates and all forwarded X11 and other
356 connections have been closed, the server sends command exit status to
357 the client, and both sides exit.
358 .Sh LOGIN PROCESS
359 When a user successfully logs in,
360 .Nm
361 does the following:
362 .Bl -enum -offset indent
363 .It
364 If the login is on a tty, and no command has been specified,
365 prints last login time and
366 .Pa /etc/motd
367 (unless prevented in the configuration file or by
368 .Pa ~/.hushlogin ;
369 see the
370 .Sx FILES
371 section).
372 .It
373 If the login is on a tty, records login time.
374 .It
375 Checks
376 .Pa /etc/nologin and
377 .Pa /var/run/nologin ;
378 if one exists, it prints the 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
401 .Xr xauth 1 .
402 The
403 .Dq rc
404 files are given the X11
405 authentication protocol and cookie in standard input.
406 See
407 .Sx SSHRC ,
408 below.
409 .It
410 Runs user's shell or command.
411 .El
412 .Sh SSHRC
413 If the file
414 .Pa ~/.ssh/rc
415 exists,
416 .Xr sh 1
417 runs it after reading the
418 environment files but before starting the user's shell or command.
419 It must not produce any output on stdout; stderr must be used
420 instead.
421 If X11 forwarding is in use, it will receive the "proto cookie" pair in
422 its standard input (and
423 .Ev DISPLAY
424 in its environment).
425 The script must call
426 .Xr xauth 1
427 because
428 .Nm
429 will not run xauth automatically to add X11 cookies.
430 .Pp
431 The primary purpose of this file is to run any initialization routines
432 which may be needed before the user's home directory becomes
433 accessible; AFS is a particular example of such an environment.
434 .Pp
435 This file will probably contain some initialization code followed by
436 something similar to:
437 .Bd -literal -offset 3n
438 if read proto cookie && [ -n "$DISPLAY" ]; then
439         if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
440                 # X11UseLocalhost=yes
441                 echo add unix:`echo $DISPLAY |
442                     cut -c11-` $proto $cookie
443         else
444                 # X11UseLocalhost=no
445                 echo add $DISPLAY $proto $cookie
446         fi | xauth -q -
447 fi
448 .Ed
449 .Pp
450 If this file does not exist,
451 .Pa /etc/ssh/sshrc
452 is run, and if that
453 does not exist either, xauth is used to add the cookie.
454 .Sh AUTHORIZED_KEYS FILE FORMAT
455 .Cm AuthorizedKeysFile
456 specifies the file containing public keys for
457 public key authentication;
458 if none is specified, the default is
459 .Pa ~/.ssh/authorized_keys .
460 Each line of the file contains one
461 key (empty lines and lines starting with a
462 .Ql #
463 are ignored as
464 comments).
465 Protocol 1 public keys consist of the following space-separated fields:
466 options, bits, exponent, modulus, comment.
467 Protocol 2 public key consist of:
468 options, keytype, base64-encoded key, comment.
469 The options field is optional;
470 its presence is determined by whether the line starts
471 with a number or not (the options field never starts with a number).
472 The bits, exponent, modulus, and comment fields give the RSA key for
473 protocol version 1; the
474 comment field is not used for anything (but may be convenient for the
475 user to identify the key).
476 For protocol version 2 the keytype is
477 .Dq ssh-dss
478 or
479 .Dq ssh-rsa .
480 .Pp
481 Note that lines in this file are usually several hundred bytes long
482 (because of the size of the public key encoding) up to a limit of
483 8 kilobytes, which permits DSA keys up to 8 kilobits and RSA
484 keys up to 16 kilobits.
485 You don't want to type them in; instead, copy the
486 .Pa identity.pub ,
487 .Pa id_dsa.pub ,
488 or the
489 .Pa id_rsa.pub
490 file and edit it.
491 .Pp
492 .Nm
493 enforces a minimum RSA key modulus size for protocol 1
494 and protocol 2 keys of 768 bits.
495 .Pp
496 The options (if present) consist of comma-separated option
497 specifications.
498 No spaces are permitted, except within double quotes.
499 The following option specifications are supported (note
500 that option keywords are case-insensitive):
501 .Bl -tag -width Ds
502 .It Cm command="command"
503 Specifies that the command is executed whenever this key is used for
504 authentication.
505 The command supplied by the user (if any) is ignored.
506 The command is run on a pty if the client requests a pty;
507 otherwise it is run without a tty.
508 If an 8-bit clean channel is required,
509 one must not request a pty or should specify
510 .Cm no-pty .
511 A quote may be included in the command by quoting it with a backslash.
512 This option might be useful
513 to restrict certain public keys to perform just a specific operation.
514 An example might be a key that permits remote backups but nothing else.
515 Note that the client may specify TCP and/or X11
516 forwarding unless they are explicitly prohibited.
517 The command originally supplied by the client is available in the
518 .Ev SSH_ORIGINAL_COMMAND
519 environment variable.
520 Note that this option applies to shell, command or subsystem execution.
521 .It Cm environment="NAME=value"
522 Specifies that the string is to be added to the environment when
523 logging in using this key.
524 Environment variables set this way
525 override other default environment values.
526 Multiple options of this type are permitted.
527 Environment processing is disabled by default and is
528 controlled via the
529 .Cm PermitUserEnvironment
530 option.
531 This option is automatically disabled if
532 .Cm UseLogin
533 is enabled.
534 .It Cm from="pattern-list"
535 Specifies that in addition to public key authentication, either the canonical
536 name of the remote host or its IP address must be present in the
537 comma-separated list of patterns.
538 See
539 .Sx PATTERNS
540 in
541 .Xr ssh_config 5
542 for more information on patterns.
543 .Pp
544 In addition to the wildcard matching that may be applied to hostnames or
545 addresses, a
546 .Cm from
547 stanza may match IP addressess using CIDR address/masklen notation.
548 .Pp
549 The purpose of this option is to optionally increase security: public key
550 authentication by itself does not trust the network or name servers or
551 anything (but the key); however, if somebody somehow steals the key, the key
552 permits an intruder to log in from anywhere in the world.
553 This additional option makes using a stolen key more difficult (name
554 servers and/or routers would have to be compromised in addition to
555 just the key).
556 .It Cm no-agent-forwarding
557 Forbids authentication agent forwarding when this key is used for
558 authentication.
559 .It Cm no-port-forwarding
560 Forbids TCP forwarding when this key is used for authentication.
561 Any port forward requests by the client will return an error.
562 This might be used, e.g. in connection with the
563 .Cm command
564 option.
565 .It Cm no-pty
566 Prevents tty allocation (a request to allocate a pty will fail).
567 .It Cm no-user-rc
568 Disables execution of
569 .Pa ~/.ssh/rc .
570 .It Cm no-X11-forwarding
571 Forbids X11 forwarding when this key is used for authentication.
572 Any X11 forward requests by the client will return an error.
573 .It Cm permitopen="host:port"
574 Limit local
575 .Li ``ssh -L''
576 port forwarding such that it may only connect to the specified host and
577 port.
578 IPv6 addresses can be specified with an alternative syntax:
579 .Ar host Ns / Ns Ar port .
580 Multiple
581 .Cm permitopen
582 options may be applied separated by commas.
583 No pattern matching is performed on the specified hostnames,
584 they must be literal domains or addresses.
585 .It Cm tunnel="n"
586 Force a
587 .Xr tun 4
588 device on the server.
589 Without this option, the next available device will be used if
590 the client requests a tunnel.
591 .El
592 .Pp
593 An example authorized_keys file:
594 .Bd -literal -offset 3n
595 # Comments allowed at start of line
596 ssh-rsa AAAAB3Nza...LiPk== user@example.net
597 from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
598 AAAAB2...19Q== john@example.net
599 command="dump /home",no-pty,no-port-forwarding ssh-dss
600 AAAAC3...51R== example.net
601 permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
602 AAAAB5...21S==
603 tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
604 jane@example.net
605 .Ed
606 .Sh SSH_KNOWN_HOSTS FILE FORMAT
607 The
608 .Pa /etc/ssh/ssh_known_hosts
609 and
610 .Pa ~/.ssh/known_hosts
611 files contain host public keys for all known hosts.
612 The global file should
613 be prepared by the administrator (optional), and the per-user file is
614 maintained automatically: whenever the user connects from an unknown host,
615 its key is added to the per-user file.
616 .Pp
617 Each line in these files contains the following fields: hostnames,
618 bits, exponent, modulus, comment.
619 The fields are separated by spaces.
620 .Pp
621 Hostnames is a comma-separated list of patterns
622 .Pf ( Ql *
623 and
624 .Ql \&?
625 act as
626 wildcards); each pattern in turn is matched against the canonical host
627 name (when authenticating a client) or against the user-supplied
628 name (when authenticating a server).
629 A pattern may also be preceded by
630 .Ql \&!
631 to indicate negation: if the host name matches a negated
632 pattern, it is not accepted (by that line) even if it matched another
633 pattern on the line.
634 A hostname or address may optionally be enclosed within
635 .Ql \&[
636 and
637 .Ql \&]
638 brackets then followed by
639 .Ql \&:
640 and a non-standard port number.
641 .Pp
642 Alternately, hostnames may be stored in a hashed form which hides host names
643 and addresses should the file's contents be disclosed.
644 Hashed hostnames start with a
645 .Ql |
646 character.
647 Only one hashed hostname may appear on a single line and none of the above
648 negation or wildcard operators may be applied.
649 .Pp
650 Bits, exponent, and modulus are taken directly from the RSA host key; they
651 can be obtained, for example, from
652 .Pa /etc/ssh/ssh_host_key.pub .
653 The optional comment field continues to the end of the line, and is not used.
654 .Pp
655 Lines starting with
656 .Ql #
657 and empty lines are ignored as comments.
658 .Pp
659 When performing host authentication, authentication is accepted if any
660 matching line has the proper key.
661 It is thus permissible (but not
662 recommended) to have several lines or different host keys for the same
663 names.
664 This will inevitably happen when short forms of host names
665 from different domains are put in the file.
666 It is possible
667 that the files contain conflicting information; authentication is
668 accepted if valid information can be found from either file.
669 .Pp
670 Note that the lines in these files are typically hundreds of characters
671 long, and you definitely don't want to type in the host keys by hand.
672 Rather, generate them by a script
673 or by taking
674 .Pa /etc/ssh/ssh_host_key.pub
675 and adding the host names at the front.
676 .Pp
677 An example ssh_known_hosts file:
678 .Bd -literal -offset 3n
679 # Comments allowed at start of line
680 closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
681 cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
682 # A hashed hostname
683 |1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
684 AAAA1234.....=
685 .Ed
686 .Sh FILES
687 .Bl -tag -width Ds -compact
688 .It ~/.hushlogin
689 This file is used to suppress printing the last login time and
690 .Pa /etc/motd ,
691 if
692 .Cm PrintLastLog
693 and
694 .Cm PrintMotd ,
695 respectively,
696 are enabled.
697 It does not suppress printing of the banner specified by
698 .Cm Banner .
699 .Pp
700 .It ~/.rhosts
701 This file is used for host-based authentication (see
702 .Xr ssh 1
703 for more information).
704 On some machines this file may need to be
705 world-readable if the user's home directory is on an NFS partition,
706 because
707 .Nm
708 reads it as root.
709 Additionally, this file must be owned by the user,
710 and must not have write permissions for anyone else.
711 The recommended
712 permission for most machines is read/write for the user, and not
713 accessible by others.
714 .Pp
715 .It ~/.shosts
716 This file is used in exactly the same way as
717 .Pa .rhosts ,
718 but allows host-based authentication without permitting login with
719 rlogin/rsh.
720 .Pp
721 .It ~/.ssh/
722 This directory is the default location for all user-specific configuration
723 and authentication information.
724 There is no general requirement to keep the entire contents of this directory
725 secret, but the recommended permissions are read/write/execute for the user,
726 and not accessible by others.
727 .Pp
728 .It ~/.ssh/authorized_keys
729 Lists the public keys (RSA/DSA) that can be used for logging in as this user.
730 The format of this file is described above.
731 The content of the file is not highly sensitive, but the recommended
732 permissions are read/write for the user, and not accessible by others.
733 .Pp
734 If this file, the
735 .Pa ~/.ssh
736 directory, or the user's home directory are writable
737 by other users, then the file could be modified or replaced by unauthorized
738 users.
739 In this case,
740 .Nm
741 will not allow it to be used unless the
742 .Cm StrictModes
743 option has been set to
744 .Dq no .
745 The recommended permissions can be set by executing
746 .Dq chmod go-w ~/ ~/.ssh ~/.ssh/authorized_keys .
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).