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