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