]> andersk Git - openssh.git/blame - sshd.8
- jmc@cvs.openbsd.org 2006/02/19 19:52:10
[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.\"
f3d2d92e 37.\" $OpenBSD: sshd.8,v 1.226 2006/02/19 19:52:10 jmc 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 ,
7b7385da 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.
610cd5c6 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.
4cdbc654 484Note that this option applies to shell, command or subsystem execution.
bf740959 485.It Cm environment="NAME=value"
486Specifies that the string is to be added to the environment when
4fe2af09 487logging in using this key.
488Environment variables set this way
489override other default environment values.
490Multiple options of this type are permitted.
35453849 491Environment processing is disabled by default and is
492controlled via the
493.Cm PermitUserEnvironment
494option.
2548961d 495This option is automatically disabled if
496.Cm UseLogin
497is enabled.
9ed4bd80 498.It Cm from="pattern-list"
499Specifies that in addition to public key authentication, the canonical name
500of the remote host must be present in the comma-separated list of
501patterns
481e991f 502.Pf ( Ql *
9ed4bd80 503and
504.Ql \&?
505serve as wildcards).
506The list may also contain
507patterns negated by prefixing them with
508.Ql \&! ;
509if the canonical host name matches a negated pattern, the key is not accepted.
510The purpose
511of this option is to optionally increase security: public key authentication
512by itself does not trust the network or name servers or anything (but
513the key); however, if somebody somehow steals the key, the key
514permits an intruder to log in from anywhere in the world.
515This additional option makes using a stolen key more difficult (name
516servers and/or routers would have to be compromised in addition to
517just the key).
518.It Cm no-agent-forwarding
519Forbids authentication agent forwarding when this key is used for
520authentication.
bf740959 521.It Cm no-port-forwarding
e5d4cfad 522Forbids TCP forwarding when this key is used for authentication.
4fe2af09 523Any port forward requests by the client will return an error.
524This might be used, e.g., in connection with the
bf740959 525.Cm command
526option.
9ed4bd80 527.It Cm no-pty
528Prevents tty allocation (a request to allocate a pty will fail).
bf740959 529.It Cm no-X11-forwarding
530Forbids X11 forwarding when this key is used for authentication.
531Any X11 forward requests by the client will return an error.
dc504afd 532.It Cm permitopen="host:port"
3730bb22 533Limit local
dc504afd 534.Li ``ssh -L''
b2ae83b8 535port forwarding such that it may only connect to the specified host and
ed787d14 536port.
537IPv6 addresses can be specified with an alternative syntax:
433e60ac 538.Ar host Ns / Ns Ar port .
ed787d14 539Multiple
dc504afd 540.Cm permitopen
3cbc677d 541options may be applied separated by commas.
542No pattern matching is performed on the specified hostnames,
543they must be literal domains or addresses.
d20f3c9e 544.It Cm tunnel="n"
545Force a
546.Xr tun 4
547device on the server.
548Without this option, the next available device will be used if
549the client requests a tunnel.
bf740959 550.El
bf740959 551.Pp
1e0fcfc6 552An example authorized_keys file:
481e991f 553.Bd -literal -offset 3n
1e0fcfc6 554# Comments allowed at start of line
555ssh-rsa AAAAB3Nza...LiPk== user@example.net
481e991f 556from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
557AAAAB2...19Q== john@example.net
558command="dump /home",no-pty,no-port-forwarding ssh-dss
559AAAAC3...51R== example.net
560permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
561AAAAB5...21S==
562tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
563jane@example.net
1e0fcfc6 564.Ed
bf740959 565.Sh SSH_KNOWN_HOSTS FILE FORMAT
f54651ce 566The
6691e41b 567.Pa /etc/ssh/ssh_known_hosts
f54651ce 568and
140e3e97 569.Pa ~/.ssh/known_hosts
4fe2af09 570files contain host public keys for all known hosts.
571The global file should
572be prepared by the administrator (optional), and the per-user file is
2881e0e9 573maintained automatically: whenever the user connects from an unknown host,
4fe2af09 574its key is added to the per-user file.
bf740959 575.Pp
576Each line in these files contains the following fields: hostnames,
4fe2af09 577bits, exponent, modulus, comment.
578The fields are separated by spaces.
bf740959 579.Pp
09dc8896 580Hostnames is a comma-separated list of patterns
2881e0e9 581.Pf ( Ql *
3cbc677d 582and
583.Ql \&?
9a26a6e2 584act as
bf740959 585wildcards); each pattern in turn is matched against the canonical host
586name (when authenticating a client) or against the user-supplied
4fe2af09 587name (when authenticating a server).
588A pattern may also be preceded by
9a26a6e2 589.Ql \&!
bf740959 590to indicate negation: if the host name matches a negated
591pattern, it is not accepted (by that line) even if it matched another
592pattern on the line.
593.Pp
5c63c2ab 594Alternately, hostnames may be stored in a hashed form which hides host names
c79ae9fd 595and addresses should the file's contents be disclosed.
596Hashed hostnames start with a
597.Ql |
5c63c2ab 598character.
599Only one hashed hostname may appear on a single line and none of the above
600negation or wildcard operators may be applied.
601.Pp
1d1ffb87 602Bits, exponent, and modulus are taken directly from the RSA host key; they
2881e0e9 603can be obtained, for example, from
2a8a6488 604.Pa /etc/ssh/ssh_host_key.pub .
bf740959 605The optional comment field continues to the end of the line, and is not used.
606.Pp
607Lines starting with
608.Ql #
609and empty lines are ignored as comments.
610.Pp
611When performing host authentication, authentication is accepted if any
4fe2af09 612matching line has the proper key.
613It is thus permissible (but not
bf740959 614recommended) to have several lines or different host keys for the same
4fe2af09 615names.
616This will inevitably happen when short forms of host names
617from different domains are put in the file.
618It is possible
bf740959 619that the files contain conflicting information; authentication is
620accepted if valid information can be found from either file.
621.Pp
622Note that the lines in these files are typically hundreds of characters
623long, and you definitely don't want to type in the host keys by hand.
624Rather, generate them by a script
f54651ce 625or by taking
2a8a6488 626.Pa /etc/ssh/ssh_host_key.pub
bf740959 627and adding the host names at the front.
9d4b0313 628.Pp
629An example ssh_known_hosts file:
630.Bd -literal -offset 3n
631# Comments allowed at start of line
632closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
633cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
5c63c2ab 634# A hashed hostname
635|1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
636AAAA1234.....=
637.Ed
bf740959 638.Sh FILES
10fa86ae 639.Bl -tag -width Ds -compact
640.It ~/.hushlogin
a333272d 641This file is used to suppress printing the last login time and
642.Pa /etc/motd ,
643if
644.Cm PrintLastLog
645and
646.Cm PrintMotd ,
647respectively,
648are enabled.
649It does not suppress printing of the banner specified by
650.Cm Banner .
10fa86ae 651.Pp
652.It ~/.rhosts
00e7c607 653This file is used for host-based authentication (see
654.Xr ssh 1
655for more information).
656On some machines this file may need to be
657world-readable if the user's home directory is on an NFS partition,
658because
659.Nm
660reads it as root.
661Additionally, this file must be owned by the user,
662and must not have write permissions for anyone else.
663The recommended
664permission for most machines is read/write for the user, and not
bf740959 665accessible by others.
666.Pp
10fa86ae 667.It ~/.shosts
00e7c607 668This file is used in exactly the same way as
669.Pa .rhosts ,
670but allows host-based authentication without permitting login with
671rlogin/rsh.
bf740959 672.Pp
10fa86ae 673.It ~/.ssh/authorized_keys
00e7c607 674Lists the public keys (RSA/DSA) that can be used for logging in as this user.
10fa86ae 675The format of this file is described above.
00e7c607 676This file is not highly sensitive, but the recommended
677permissions are read/write for the user, and not accessible by others.
bf740959 678.Pp
10fa86ae 679.It ~/.ssh/environment
4fe2af09 680This file is read into the environment at login (if it exists).
681It can only contain empty lines, comment lines (that start with
bf740959 682.Ql # ) ,
4fe2af09 683and assignment lines of the form name=value.
684The file should be writable
bf740959 685only by the user; it need not be readable by anyone else.
35453849 686Environment processing is disabled by default and is
687controlled via the
688.Cm PermitUserEnvironment
689option.
10fa86ae 690.Pp
691.It ~/.ssh/known_hosts
00e7c607 692Contains a list of host keys for all hosts the user has logged into
693that are not already in the systemwide list of known host keys.
694The format of this file is described above.
695This file should be writable only by root/the owner and
10fa86ae 696can, but need not be, world-readable.
697.Pp
698.It ~/.ssh/rc
f3d2d92e 699Contains initialization routines to be run before
700the user's home directory becomes accessible.
bf740959 701This file should be writable only by the user, and need not be
702readable by anyone else.
10fa86ae 703.Pp
704.It /etc/hosts.allow
705.It /etc/hosts.deny
706Access controls that should be enforced by tcp-wrappers are defined here.
707Further details are described in
708.Xr hosts_access 5 .
709.Pp
710.It /etc/hosts.equiv
711This file is used during
712.Cm RhostsRSAAuthentication
713and
714.Cm HostbasedAuthentication
715authentication.
716In the simplest form, this file contains host names, one per line.
717Users on
718those hosts are permitted to log in without a password, provided they
719have the same user name on both machines.
720The host name may also be
721followed by a user name; such users are permitted to log in as
722.Em any
723user on this machine (except root).
724Additionally, the syntax
725.Dq +@group
726can be used to specify netgroups.
727Negated entries start with
728.Ql \&- .
729.Pp
730If the client host/user is successfully matched in this file, login is
731automatically permitted provided the client and server user names are the
732same.
733Additionally, successful client host key authentication is required.
734This file must be writable only by root; it is recommended
735that it be world-readable.
736.Pp
737.Sy "Warning: It is almost never a good idea to use user names in"
738.Pa hosts.equiv .
739Beware that it really means that the named user(s) can log in as
740.Em anybody ,
741which includes bin, daemon, adm, and other accounts that own critical
742binaries and directories.
743Using a user name practically grants the user root access.
744The only valid use for user names that I can think
745of is in negative entries.
746.Pp
747Note that this warning also applies to rsh/rlogin.
748.Pp
749.It /etc/moduli
750Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
751The file format is described in
752.Xr moduli 5 .
753.Pp
754.It /etc/motd
755See
756.Xr motd 5 .
757.Pp
758.It /etc/nologin
759If this file exists,
760.Nm
761refuses to let anyone except root log in.
762The contents of the file
763are displayed to anyone trying to log in, and non-root connections are
764refused.
765The file should be world-readable.
766.Pp
767.It /etc/shosts.equiv
768This is processed exactly as
769.Pa /etc/hosts.equiv .
770However, this file may be useful in environments that want to run both
771rsh/rlogin and ssh.
772.Pp
00e7c607 773.It /etc/ssh/ssh_known_hosts
774Systemwide list of known host keys.
775This file should be prepared by the
776system administrator to contain the public host keys of all machines in the
777organization.
778The format of this file is described above.
779This file should be writable only by root/the owner and
780should be world-readable.
781.Pp
10fa86ae 782.It /etc/ssh/ssh_host_key
783.It /etc/ssh/ssh_host_dsa_key
784.It /etc/ssh/ssh_host_rsa_key
785These three files contain the private parts of the host keys.
786These files should only be owned by root, readable only by root, and not
787accessible to others.
788Note that
789.Nm
790does not start if this file is group/world-accessible.
791.Pp
792.It /etc/ssh/ssh_host_key.pub
793.It /etc/ssh/ssh_host_dsa_key.pub
794.It /etc/ssh/ssh_host_rsa_key.pub
795These three files contain the public parts of the host keys.
796These files should be world-readable but writable only by
797root.
798Their contents should match the respective private parts.
799These files are not
800really used for anything; they are provided for the convenience of
801the user so their contents can be copied to known hosts files.
802These files are created using
803.Xr ssh-keygen 1 .
804.Pp
805.It /etc/ssh/sshd_config
806Contains configuration data for
807.Nm sshd .
808The file format and configuration options are described in
809.Xr sshd_config 5 .
810.Pp
811.It /etc/ssh/sshrc
f3d2d92e 812Similar to
813.Pa ~/.ssh/rc ,
814it can be used to specify
4fe2af09 815machine-specific login-time initializations globally.
816This file should be writable only by root, and should be world-readable.
10fa86ae 817.Pp
818.It /var/empty
819.Xr chroot 2
820directory used by
821.Nm
822during privilege separation in the pre-authentication phase.
823The directory should not contain any files and must be owned by root
824and not group or world-writable.
825.Pp
826.It /var/run/sshd.pid
827Contains the process ID of the
828.Nm
829listening for connections (if there are several daemons running
830concurrently for different ports, this contains the process ID of the one
831started last).
832The content of this file is not sensitive; it can be world-readable.
089fbbd2 833.El
bf740959 834.Sh SEE ALSO
bf740959 835.Xr scp 1 ,
61e96248 836.Xr sftp 1 ,
bf740959 837.Xr ssh 1 ,
838.Xr ssh-add 1 ,
839.Xr ssh-agent 1 ,
840.Xr ssh-keygen 1 ,
433e60ac 841.Xr chroot 2 ,
842.Xr hosts_access 5 ,
248bad82 843.Xr login.conf 5 ,
844.Xr moduli 5 ,
588df31a 845.Xr sshd_config 5 ,
433e60ac 846.Xr inetd 8 ,
a5a2da3b 847.Xr sftp-server 8
be193d89 848.Sh AUTHORS
849OpenSSH is a derivative of the original and free
850ssh 1.2.12 release by Tatu Ylonen.
851Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
852Theo de Raadt and Dug Song
853removed many bugs, re-added newer features and
854created OpenSSH.
855Markus Friedl contributed the support for SSH
856protocol versions 1.5 and 2.0.
857Niels Provos and Markus Friedl contributed support
858for privilege separation.
4eb67845 859.Sh CAVEATS
860System security is not improved unless
861.Nm rshd ,
862.Nm rlogind ,
863and
864.Nm rexecd
865are disabled (thus completely disabling
866.Xr rlogin
867and
868.Xr rsh
869into the machine).
This page took 0.479245 seconds and 5 git commands to generate.