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