]> andersk Git - openssh.git/blame - sshd.8
- dtucker@cvs.openbsd.org 2008/06/10 04:50:25
[openssh.git] / sshd.8
CommitLineData
bf740959 1.\" -*- nroff -*-
2.\"
bf740959 3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
bf740959 4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
bcbf86ec 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.\"
f3c7c613 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.
bcbf86ec 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.
bf740959 25.\"
bcbf86ec 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.
bf740959 36.\"
1760c982 37.\" $OpenBSD: sshd.8,v 1.242 2008/06/10 04:50:25 dtucker Exp $
e473dcd1 38.Dd $Mdocdate$
bf740959 39.Dt SSHD 8
40.Os
41.Sh NAME
42.Nm sshd
da89cf4d 43.Nd OpenSSH SSH daemon
bf740959 44.Sh SYNOPSIS
45.Nm sshd
6691e41b 46.Bk -words
1760c982 47.Op Fl 46DTdeiqt
bf740959 48.Op Fl b Ar bits
1760c982 49.Op Fl C Ar connection_spec
bf740959 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
2717fa0f 54.Op Fl o Ar option
bf740959 55.Op Fl p Ar port
c345cf9d 56.Op Fl u Ar len
6691e41b 57.Ek
f54651ce 58.Sh DESCRIPTION
bf740959 59.Nm
ec63d7ce 60(OpenSSH Daemon) is the daemon program for
bf740959 61.Xr ssh 1 .
82029813 62Together these programs replace
63.Xr rlogin 1
64and
65.Xr rsh 1 ,
66and provide secure encrypted communications between two untrusted hosts
4fe2af09 67over an insecure network.
bf740959 68.Pp
69.Nm
ec63d7ce 70listens for connections from clients.
f54651ce 71It is normally started at boot from
bf740959 72.Pa /etc/rc .
73It forks a new
4fe2af09 74daemon for each incoming connection.
75The forked daemons handle
bf740959 76key exchange, encryption, authentication, command execution,
77and data exchange.
bf740959 78.Pp
79.Nm
433e60ac 80can be configured using command-line options or a configuration file
81(by default
ec63d7ce 82.Xr sshd_config 5 ) ;
83command-line options override values specified in the
bf740959 84configuration file.
9d6b7add 85.Nm
86rereads its configuration file when it receives a hangup signal,
409edaba 87.Dv SIGHUP ,
f09ffbdb 88by executing itself with the name and options it was started with, e.g.\&
409edaba 89.Pa /usr/sbin/sshd .
9d6b7add 90.Pp
bf740959 91The options are as follows:
92.Bl -tag -width Ds
433e60ac 93.It Fl 4
94Forces
95.Nm
96to use IPv4 addresses only.
97.It Fl 6
98Forces
99.Nm
100to use IPv6 addresses only.
bf740959 101.It Fl b Ar bits
da89cf4d 102Specifies the number of bits in the ephemeral protocol version 1
103server key (default 768).
433e60ac 104.It Fl D
105When this option is specified,
106.Nm
107will not detach and does not become a daemon.
108This allows easy monitoring of
109.Nm sshd .
bf740959 110.It Fl d
4fe2af09 111Debug mode.
112The server sends verbose debug output to the system
113log, and does not put itself in the background.
114The server also will not fork and will only process one connection.
115This option is only intended for debugging for the server.
6691e41b 116Multiple
117.Fl d
118options increase the debugging level.
94ec8c6b 119Maximum is 3.
da89cf4d 120.It Fl e
121When this option is specified,
122.Nm
123will send the output to the standard error instead of the system log.
82029813 124.It Fl f Ar config_file
4fe2af09 125Specifies the name of the configuration file.
126The default is
2a8a6488 127.Pa /etc/ssh/sshd_config .
bf740959 128.Nm
129refuses to start if there is no configuration file.
130.It Fl g Ar login_grace_time
131Gives the grace time for clients to authenticate themselves (default
3445ca02 132120 seconds).
4fe2af09 133If the client fails to authenticate the user within
134this many seconds, the server disconnects and exits.
135A value of zero indicates no limit.
bf740959 136.It Fl h Ar host_key_file
0f84fe37 137Specifies a file from which a host key is read.
bf740959 138This option must be given if
139.Nm
140is not run as root (as the normal
0f84fe37 141host key files are normally not readable by anyone but root).
142The default is
2a8a6488 143.Pa /etc/ssh/ssh_host_key
0f84fe37 144for protocol version 1, and
2a8a6488 145.Pa /etc/ssh/ssh_host_rsa_key
0f84fe37 146and
2a8a6488 147.Pa /etc/ssh/ssh_host_dsa_key
0f84fe37 148for protocol version 2.
8abcdba4 149It is possible to have multiple host key files for
da89cf4d 150the different protocol versions and host key algorithms.
bf740959 151.It Fl i
152Specifies that
153.Nm
6691e41b 154is being run from
155.Xr inetd 8 .
bf740959 156.Nm
157is normally not run
158from inetd because it needs to generate the server key before it can
4fe2af09 159respond to the client, and this may take tens of seconds.
160Clients would have to wait too long if the key was regenerated every time.
f09ffbdb 161However, with small key sizes (e.g. 512) using
bf740959 162.Nm
163from inetd may
164be feasible.
165.It Fl k Ar key_gen_time
da89cf4d 166Specifies how often the ephemeral protocol version 1 server key is
167regenerated (default 3600 seconds, or one hour).
4fe2af09 168The motivation for regenerating the key fairly
433e60ac 169often is that the key is not stored anywhere, and after about an hour
bf740959 170it becomes impossible to recover the key for decrypting intercepted
171communications even if the machine is cracked into or physically
4fe2af09 172seized.
173A value of zero indicates that the key will never be regenerated.
2717fa0f 174.It Fl o Ar option
175Can be used to give options in the format used in the configuration file.
176This is useful for specifying options for which there is no separate
177command-line flag.
433e60ac 178For full details of the options, and their values, see
179.Xr sshd_config 5 .
bf740959 180.It Fl p Ar port
181Specifies the port on which the server listens for connections
182(default 22).
135113a3 183Multiple port options are permitted.
6cd6c442 184Ports specified in the configuration file with the
185.Cm Port
186option are ignored when a command-line port is specified.
187Ports specified using the
188.Cm ListenAddress
189option override command-line ports.
bf740959 190.It Fl q
4fe2af09 191Quiet mode.
192Nothing is sent to the system log.
193Normally the beginning,
bf740959 194authentication, and termination of each connection is logged.
f87f09aa 195.It Fl t
196Test mode.
197Only check the validity of the configuration file and sanity of the keys.
184eed6a 198This is useful for updating
f87f09aa 199.Nm
200reliably as configuration options may change.
1760c982 201.It Fl T
202Extended test mode.
203Check the validity of the configuration file, output the effective configuration
204to stdout and then exit.
205Optionally,
206.Cm Match
207rules may be applied by specifying the connection parameters using one or more
208.Fl C
209options.
210.It Fl C
211Specify the connection parameters to use for the the
212.Fl T
213extended test mode.
214If provided, any
215.Cm Match
216directives in the configuration file
217that would apply to the specified user, host and address will be set before
218the configuration is written to standard output.
219The connection parameters are supplied as keyword=value pairs.
220The keywords are
221.Dq user ,
222.Dq host
223and
224.Dq addr
225All are required and may be supplied in any order, either with multiple
226.Fl C
227options or as a comma-separated list.
c345cf9d 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.
e675b851 244.Fl u0
6691e41b 245may also be used to prevent
e675b851 246.Nm
247from making DNS requests unless the authentication
248mechanism or configuration requires it.
249Authentication mechanisms that may require DNS include
e675b851 250.Cm RhostsRSAAuthentication ,
170c69ba 251.Cm HostbasedAuthentication ,
e675b851 252and using a
253.Cm from="pattern-list"
254option in a key file.
f464aad8 255Configuration options that require DNS include using a
256USER@HOST pattern in
257.Cm AllowUsers
258or
259.Cm DenyUsers .
bf740959 260.El
f3906047 261.Sh AUTHENTICATION
262The OpenSSH SSH daemon supports SSH protocols 1 and 2.
263Both protocols are supported by default,
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.
ec63d7ce 274.Pp
f3906047 275Forward security for protocol 1 is provided through
276an additional server key,
277normally 768 bits,
278generated when the server starts.
ec63d7ce 279This key is normally regenerated every hour if it has been used, and
280is never stored on disk.
ec63d7ce 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
f3906047 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
f444d0f8 307(hmac-md5, hmac-sha1, umac-64 or hmac-ripemd160).
f3906047 308.Pp
309Finally, the server and the client enter an authentication dialog.
ec63d7ce 310The client tries to authenticate itself using
f3906047 311host-based authentication,
312public key authentication,
313challenge-response authentication,
314or password authentication.
ec63d7ce 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
145707ab 333.Ql \&!
334on most Linuxes).
335If there is a requirement to disable password authentication
ec63d7ce 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
ec63d7ce 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
4eb67845 350After this, the client either requests a shell or execution of a command.
ec63d7ce 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.
bf740959 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,
f54651ce 366prints last login time and
bf740959 367.Pa /etc/motd
368(unless prevented in the configuration file or by
140e3e97 369.Pa ~/.hushlogin ;
bf740959 370see the
f54651ce 371.Sx FILES
bf740959 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
433e60ac 385Reads the file
140e3e97 386.Pa ~/.ssh/environment ,
433e60ac 387if it exists, and users are allowed to change their environment.
35453849 388See the
6a342527 389.Cm PermitUserEnvironment
35453849 390option in
6a342527 391.Xr sshd_config 5 .
bf740959 392.It
393Changes to user's home directory.
394.It
395If
140e3e97 396.Pa ~/.ssh/rc
bf740959 397exists, runs it; else if
af98ced9 398.Pa /etc/ssh/sshrc
bf740959 399exists, runs
4fe2af09 400it; otherwise runs xauth.
401The
bf740959 402.Dq rc
403files are given the X11
404authentication protocol and cookie in standard input.
f3d2d92e 405See
406.Sx SSHRC ,
407below.
bf740959 408.It
409Runs user's shell or command.
410.El
f3d2d92e 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.
bf740959 453.Sh AUTHORIZED_KEYS FILE FORMAT
96a7b0cc 454.Cm AuthorizedKeysFile
010c04e5 455specifies the file containing public keys for
456public key authentication;
457if none is specified, the default is
458.Pa ~/.ssh/authorized_keys .
4fe2af09 459Each line of the file contains one
bf740959 460key (empty lines and lines starting with a
461.Ql #
462are ignored as
4fe2af09 463comments).
010c04e5 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
755c4339 470with a number or not (the options field never starts with a number).
010c04e5 471The bits, exponent, modulus, and comment fields give the RSA key for
8abcdba4 472protocol version 1; the
bf740959 473comment field is not used for anything (but may be convenient for the
474user to identify the key).
8abcdba4 475For protocol version 2 the keytype is
476.Dq ssh-dss
477or
478.Dq ssh-rsa .
bf740959 479.Pp
480Note that lines in this file are usually several hundred bytes long
ea067773 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.
4fe2af09 484You don't want to type them in; instead, copy the
c0ecc314 485.Pa identity.pub ,
010c04e5 486.Pa id_dsa.pub ,
c0ecc314 487or the
488.Pa id_rsa.pub
bf740959 489file and edit it.
490.Pp
3bc822df 491.Nm
492enforces a minimum RSA key modulus size for protocol 1
493and protocol 2 keys of 768 bits.
494.Pp
c345cf9d 495The options (if present) consist of comma-separated option
4fe2af09 496specifications.
497No spaces are permitted, except within double quotes.
54bf768d 498The following option specifications are supported (note
499that option keywords are case-insensitive):
bf740959 500.Bl -tag -width Ds
bf740959 501.It Cm command="command"
502Specifies that the command is executed whenever this key is used for
4fe2af09 503authentication.
504The command supplied by the user (if any) is ignored.
9658ecbc 505The command is run on a pty if the client requests a pty;
4fe2af09 506otherwise it is run without a tty.
6691e41b 507If an 8-bit clean channel is required,
91789042 508one must not request a pty or should specify
61e96248 509.Cm no-pty .
4fe2af09 510A quote may be included in the command by quoting it with a backslash.
511This option might be useful
755c4339 512to restrict certain public keys to perform just a specific operation.
4fe2af09 513An example might be a key that permits remote backups but nothing else.
e5d4cfad 514Note that the client may specify TCP and/or X11
d0c832f3 515forwarding unless they are explicitly prohibited.
e7259e8d 516The command originally supplied by the client is available in the
517.Ev SSH_ORIGINAL_COMMAND
518environment variable.
4cdbc654 519Note that this option applies to shell, command or subsystem execution.
bf740959 520.It Cm environment="NAME=value"
521Specifies that the string is to be added to the environment when
4fe2af09 522logging in using this key.
523Environment variables set this way
524override other default environment values.
525Multiple options of this type are permitted.
35453849 526Environment processing is disabled by default and is
527controlled via the
528.Cm PermitUserEnvironment
529option.
2548961d 530This option is automatically disabled if
531.Cm UseLogin
532is enabled.
9ed4bd80 533.It Cm from="pattern-list"
534Specifies that in addition to public key authentication, the canonical name
535of the remote host must be present in the comma-separated list of
4cb23985 536patterns.
9ed4bd80 537The purpose
538of this option is to optionally increase security: public key authentication
539by itself does not trust the network or name servers or anything (but
540the key); however, if somebody somehow steals the key, the key
541permits an intruder to log in from anywhere in the world.
542This additional option makes using a stolen key more difficult (name
543servers and/or routers would have to be compromised in addition to
544just the key).
4cb23985 545.Pp
546See
547.Sx PATTERNS
548in
549.Xr ssh_config 5
550for more information on patterns.
9ed4bd80 551.It Cm no-agent-forwarding
552Forbids authentication agent forwarding when this key is used for
553authentication.
bf740959 554.It Cm no-port-forwarding
e5d4cfad 555Forbids TCP forwarding when this key is used for authentication.
4fe2af09 556Any port forward requests by the client will return an error.
f09ffbdb 557This might be used, e.g. in connection with the
bf740959 558.Cm command
559option.
9ed4bd80 560.It Cm no-pty
561Prevents tty allocation (a request to allocate a pty will fail).
8c03e768 562.It Cm no-user-rc
adb7acbc 563Disables execution of
8c03e768 564.Pa ~/.ssh/rc .
bf740959 565.It Cm no-X11-forwarding
566Forbids X11 forwarding when this key is used for authentication.
567Any X11 forward requests by the client will return an error.
dc504afd 568.It Cm permitopen="host:port"
3730bb22 569Limit local
dc504afd 570.Li ``ssh -L''
b2ae83b8 571port forwarding such that it may only connect to the specified host and
ed787d14 572port.
573IPv6 addresses can be specified with an alternative syntax:
433e60ac 574.Ar host Ns / Ns Ar port .
ed787d14 575Multiple
dc504afd 576.Cm permitopen
3cbc677d 577options may be applied separated by commas.
578No pattern matching is performed on the specified hostnames,
579they must be literal domains or addresses.
d20f3c9e 580.It Cm tunnel="n"
581Force a
582.Xr tun 4
583device on the server.
584Without this option, the next available device will be used if
585the client requests a tunnel.
bf740959 586.El
bf740959 587.Pp
1e0fcfc6 588An example authorized_keys file:
481e991f 589.Bd -literal -offset 3n
1e0fcfc6 590# Comments allowed at start of line
591ssh-rsa AAAAB3Nza...LiPk== user@example.net
481e991f 592from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
593AAAAB2...19Q== john@example.net
594command="dump /home",no-pty,no-port-forwarding ssh-dss
595AAAAC3...51R== example.net
596permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
597AAAAB5...21S==
598tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
599jane@example.net
1e0fcfc6 600.Ed
bf740959 601.Sh SSH_KNOWN_HOSTS FILE FORMAT
f54651ce 602The
6691e41b 603.Pa /etc/ssh/ssh_known_hosts
f54651ce 604and
140e3e97 605.Pa ~/.ssh/known_hosts
4fe2af09 606files contain host public keys for all known hosts.
607The global file should
608be prepared by the administrator (optional), and the per-user file is
2881e0e9 609maintained automatically: whenever the user connects from an unknown host,
4fe2af09 610its key is added to the per-user file.
bf740959 611.Pp
612Each line in these files contains the following fields: hostnames,
4fe2af09 613bits, exponent, modulus, comment.
614The fields are separated by spaces.
bf740959 615.Pp
09dc8896 616Hostnames is a comma-separated list of patterns
2881e0e9 617.Pf ( Ql *
3cbc677d 618and
619.Ql \&?
9a26a6e2 620act as
bf740959 621wildcards); each pattern in turn is matched against the canonical host
622name (when authenticating a client) or against the user-supplied
4fe2af09 623name (when authenticating a server).
624A pattern may also be preceded by
9a26a6e2 625.Ql \&!
bf740959 626to indicate negation: if the host name matches a negated
627pattern, it is not accepted (by that line) even if it matched another
628pattern on the line.
d4530052 629A hostname or address may optionally be enclosed within
630.Ql \&[
631and
632.Ql \&]
633brackets then followed by
634.Ql \&:
a0bca6ed 635and a non-standard port number.
bf740959 636.Pp
5c63c2ab 637Alternately, hostnames may be stored in a hashed form which hides host names
c79ae9fd 638and addresses should the file's contents be disclosed.
639Hashed hostnames start with a
640.Ql |
5c63c2ab 641character.
642Only one hashed hostname may appear on a single line and none of the above
643negation or wildcard operators may be applied.
644.Pp
1d1ffb87 645Bits, exponent, and modulus are taken directly from the RSA host key; they
2881e0e9 646can be obtained, for example, from
2a8a6488 647.Pa /etc/ssh/ssh_host_key.pub .
bf740959 648The optional comment field continues to the end of the line, and is not used.
649.Pp
650Lines starting with
651.Ql #
652and empty lines are ignored as comments.
653.Pp
654When performing host authentication, authentication is accepted if any
4fe2af09 655matching line has the proper key.
656It is thus permissible (but not
bf740959 657recommended) to have several lines or different host keys for the same
4fe2af09 658names.
659This will inevitably happen when short forms of host names
660from different domains are put in the file.
661It is possible
bf740959 662that the files contain conflicting information; authentication is
663accepted if valid information can be found from either file.
664.Pp
665Note that the lines in these files are typically hundreds of characters
666long, and you definitely don't want to type in the host keys by hand.
667Rather, generate them by a script
f54651ce 668or by taking
2a8a6488 669.Pa /etc/ssh/ssh_host_key.pub
bf740959 670and adding the host names at the front.
9d4b0313 671.Pp
672An example ssh_known_hosts file:
673.Bd -literal -offset 3n
674# Comments allowed at start of line
675closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
676cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
5c63c2ab 677# A hashed hostname
678|1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
679AAAA1234.....=
680.Ed
bf740959 681.Sh FILES
10fa86ae 682.Bl -tag -width Ds -compact
683.It ~/.hushlogin
a333272d 684This file is used to suppress printing the last login time and
685.Pa /etc/motd ,
686if
687.Cm PrintLastLog
688and
689.Cm PrintMotd ,
690respectively,
691are enabled.
692It does not suppress printing of the banner specified by
693.Cm Banner .
10fa86ae 694.Pp
695.It ~/.rhosts
00e7c607 696This file is used for host-based authentication (see
697.Xr ssh 1
698for more information).
699On some machines this file may need to be
700world-readable if the user's home directory is on an NFS partition,
701because
702.Nm
703reads it as root.
704Additionally, this file must be owned by the user,
705and must not have write permissions for anyone else.
706The recommended
707permission for most machines is read/write for the user, and not
bf740959 708accessible by others.
709.Pp
10fa86ae 710.It ~/.shosts
00e7c607 711This file is used in exactly the same way as
712.Pa .rhosts ,
713but allows host-based authentication without permitting login with
714rlogin/rsh.
bf740959 715.Pp
7c36e880 716.It ~/.ssh/
717This directory is the default location for all user-specific configuration
718and authentication information.
719There is no general requirement to keep the entire contents of this directory
720secret, but the recommended permissions are read/write/execute for the user,
721and not accessible by others.
722.Pp
10fa86ae 723.It ~/.ssh/authorized_keys
00e7c607 724Lists the public keys (RSA/DSA) that can be used for logging in as this user.
10fa86ae 725The format of this file is described above.
5f047fbc 726The content of the file is not highly sensitive, but the recommended
00e7c607 727permissions are read/write for the user, and not accessible by others.
bf740959 728.Pp
5f047fbc 729If this file, the
730.Pa ~/.ssh
731directory, or the user's home directory are writable
732by other users, then the file could be modified or replaced by unauthorized
733users.
734In this case,
735.Nm
736will not allow it to be used unless the
737.Cm StrictModes
738option has been set to
739.Dq no .
740The recommended permissions can be set by executing
741.Dq chmod go-w ~/ ~/.ssh ~/.ssh/authorized_keys .
742.Pp
10fa86ae 743.It ~/.ssh/environment
4fe2af09 744This file is read into the environment at login (if it exists).
745It can only contain empty lines, comment lines (that start with
bf740959 746.Ql # ) ,
4fe2af09 747and assignment lines of the form name=value.
748The file should be writable
bf740959 749only by the user; it need not be readable by anyone else.
35453849 750Environment processing is disabled by default and is
751controlled via the
752.Cm PermitUserEnvironment
753option.
10fa86ae 754.Pp
755.It ~/.ssh/known_hosts
00e7c607 756Contains a list of host keys for all hosts the user has logged into
757that are not already in the systemwide list of known host keys.
758The format of this file is described above.
759This file should be writable only by root/the owner and
10fa86ae 760can, but need not be, world-readable.
761.Pp
762.It ~/.ssh/rc
f3d2d92e 763Contains initialization routines to be run before
764the user's home directory becomes accessible.
bf740959 765This file should be writable only by the user, and need not be
766readable by anyone else.
10fa86ae 767.Pp
768.It /etc/hosts.allow
769.It /etc/hosts.deny
770Access controls that should be enforced by tcp-wrappers are defined here.
771Further details are described in
772.Xr hosts_access 5 .
773.Pp
774.It /etc/hosts.equiv
e56bbe08 775This file is for host-based authentication (see
776.Xr ssh 1 ) .
777It should only be writable by root.
10fa86ae 778.Pp
779.It /etc/moduli
780Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
781The file format is described in
782.Xr moduli 5 .
783.Pp
784.It /etc/motd
785See
786.Xr motd 5 .
787.Pp
788.It /etc/nologin
789If this file exists,
790.Nm
791refuses to let anyone except root log in.
792The contents of the file
793are displayed to anyone trying to log in, and non-root connections are
794refused.
795The file should be world-readable.
796.Pp
797.It /etc/shosts.equiv
e56bbe08 798This file is used in exactly the same way as
799.Pa hosts.equiv ,
800but allows host-based authentication without permitting login with
801rlogin/rsh.
10fa86ae 802.Pp
803.It /etc/ssh/ssh_host_key
804.It /etc/ssh/ssh_host_dsa_key
805.It /etc/ssh/ssh_host_rsa_key
806These three files contain the private parts of the host keys.
807These files should only be owned by root, readable only by root, and not
808accessible to others.
809Note that
810.Nm
3783659a 811does not start if these files are group/world-accessible.
10fa86ae 812.Pp
813.It /etc/ssh/ssh_host_key.pub
814.It /etc/ssh/ssh_host_dsa_key.pub
815.It /etc/ssh/ssh_host_rsa_key.pub
816These three files contain the public parts of the host keys.
817These files should be world-readable but writable only by
818root.
819Their contents should match the respective private parts.
820These files are not
821really used for anything; they are provided for the convenience of
822the user so their contents can be copied to known hosts files.
823These files are created using
824.Xr ssh-keygen 1 .
825.Pp
82029813 826.It /etc/ssh/ssh_known_hosts
827Systemwide list of known host keys.
828This file should be prepared by the
829system administrator to contain the public host keys of all machines in the
830organization.
831The format of this file is described above.
832This file should be writable only by root/the owner and
833should be world-readable.
834.Pp
10fa86ae 835.It /etc/ssh/sshd_config
836Contains configuration data for
837.Nm sshd .
838The file format and configuration options are described in
839.Xr sshd_config 5 .
840.Pp
841.It /etc/ssh/sshrc
f3d2d92e 842Similar to
843.Pa ~/.ssh/rc ,
844it can be used to specify
4fe2af09 845machine-specific login-time initializations globally.
846This file should be writable only by root, and should be world-readable.
10fa86ae 847.Pp
848.It /var/empty
849.Xr chroot 2
850directory used by
851.Nm
852during privilege separation in the pre-authentication phase.
853The directory should not contain any files and must be owned by root
854and not group or world-writable.
855.Pp
856.It /var/run/sshd.pid
857Contains the process ID of the
858.Nm
859listening for connections (if there are several daemons running
860concurrently for different ports, this contains the process ID of the one
861started last).
862The content of this file is not sensitive; it can be world-readable.
089fbbd2 863.El
bf740959 864.Sh SEE ALSO
bf740959 865.Xr scp 1 ,
61e96248 866.Xr sftp 1 ,
bf740959 867.Xr ssh 1 ,
868.Xr ssh-add 1 ,
869.Xr ssh-agent 1 ,
870.Xr ssh-keygen 1 ,
82029813 871.Xr ssh-keyscan 1 ,
433e60ac 872.Xr chroot 2 ,
873.Xr hosts_access 5 ,
248bad82 874.Xr login.conf 5 ,
875.Xr moduli 5 ,
588df31a 876.Xr sshd_config 5 ,
433e60ac 877.Xr inetd 8 ,
a5a2da3b 878.Xr sftp-server 8
be193d89 879.Sh AUTHORS
880OpenSSH is a derivative of the original and free
881ssh 1.2.12 release by Tatu Ylonen.
882Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
883Theo de Raadt and Dug Song
884removed many bugs, re-added newer features and
885created OpenSSH.
886Markus Friedl contributed the support for SSH
887protocol versions 1.5 and 2.0.
888Niels Provos and Markus Friedl contributed support
889for privilege separation.
4eb67845 890.Sh CAVEATS
891System security is not improved unless
892.Nm rshd ,
893.Nm rlogind ,
894and
895.Nm rexecd
896are disabled (thus completely disabling
897.Xr rlogin
898and
899.Xr rsh
900into the machine).
This page took 0.454491 seconds and 5 git commands to generate.