]> andersk Git - openssh.git/blame - sshd.8
- jmc@cvs.openbsd.org 2006/02/13 11:27:25
[openssh.git] / sshd.8
CommitLineData
bf740959 1.\" -*- nroff -*-
2.\"
bf740959 3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
bf740959 4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
bcbf86ec 7.\" As far as I am concerned, the code I have written for this software
8.\" can be used freely for any purpose. Any derived versions of this
9.\" software must be clearly marked as such, and if the derived work is
10.\" incompatible with the protocol description in the RFC file, it must be
11.\" called by a name other than "ssh" or "Secure Shell".
12.\"
f3c7c613 13.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
14.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
15.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
bcbf86ec 16.\"
17.\" Redistribution and use in source and binary forms, with or without
18.\" modification, are permitted provided that the following conditions
19.\" are met:
20.\" 1. Redistributions of source code must retain the above copyright
21.\" notice, this list of conditions and the following disclaimer.
22.\" 2. Redistributions in binary form must reproduce the above copyright
23.\" notice, this list of conditions and the following disclaimer in the
24.\" documentation and/or other materials provided with the distribution.
bf740959 25.\"
bcbf86ec 26.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bf740959 36.\"
10fa86ae 37.\" $OpenBSD: sshd.8,v 1.223 2006/02/13 11:27:25 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.
373.It
374Runs user's shell or command.
375.El
376.Sh AUTHORIZED_KEYS FILE FORMAT
96a7b0cc 377.Cm AuthorizedKeysFile
010c04e5 378specifies the file containing public keys for
379public key authentication;
380if none is specified, the default is
381.Pa ~/.ssh/authorized_keys .
4fe2af09 382Each line of the file contains one
bf740959 383key (empty lines and lines starting with a
384.Ql #
385are ignored as
4fe2af09 386comments).
010c04e5 387Protocol 1 public keys consist of the following space-separated fields:
388options, bits, exponent, modulus, comment.
389Protocol 2 public key consist of:
390options, keytype, base64-encoded key, comment.
391The options field is optional;
392its presence is determined by whether the line starts
755c4339 393with a number or not (the options field never starts with a number).
010c04e5 394The bits, exponent, modulus, and comment fields give the RSA key for
8abcdba4 395protocol version 1; the
bf740959 396comment field is not used for anything (but may be convenient for the
397user to identify the key).
8abcdba4 398For protocol version 2 the keytype is
399.Dq ssh-dss
400or
401.Dq ssh-rsa .
bf740959 402.Pp
403Note that lines in this file are usually several hundred bytes long
ea067773 404(because of the size of the public key encoding) up to a limit of
4058 kilobytes, which permits DSA keys up to 8 kilobits and RSA
406keys up to 16 kilobits.
4fe2af09 407You don't want to type them in; instead, copy the
c0ecc314 408.Pa identity.pub ,
010c04e5 409.Pa id_dsa.pub ,
c0ecc314 410or the
411.Pa id_rsa.pub
bf740959 412file and edit it.
413.Pp
3bc822df 414.Nm
415enforces a minimum RSA key modulus size for protocol 1
416and protocol 2 keys of 768 bits.
417.Pp
c345cf9d 418The options (if present) consist of comma-separated option
4fe2af09 419specifications.
420No spaces are permitted, except within double quotes.
54bf768d 421The following option specifications are supported (note
422that option keywords are case-insensitive):
bf740959 423.Bl -tag -width Ds
bf740959 424.It Cm command="command"
425Specifies that the command is executed whenever this key is used for
4fe2af09 426authentication.
427The command supplied by the user (if any) is ignored.
9658ecbc 428The command is run on a pty if the client requests a pty;
4fe2af09 429otherwise it is run without a tty.
6691e41b 430If an 8-bit clean channel is required,
91789042 431one must not request a pty or should specify
61e96248 432.Cm no-pty .
4fe2af09 433A quote may be included in the command by quoting it with a backslash.
434This option might be useful
755c4339 435to restrict certain public keys to perform just a specific operation.
4fe2af09 436An example might be a key that permits remote backups but nothing else.
e5d4cfad 437Note that the client may specify TCP and/or X11
d0c832f3 438forwarding unless they are explicitly prohibited.
4cdbc654 439Note that this option applies to shell, command or subsystem execution.
bf740959 440.It Cm environment="NAME=value"
441Specifies that the string is to be added to the environment when
4fe2af09 442logging in using this key.
443Environment variables set this way
444override other default environment values.
445Multiple options of this type are permitted.
35453849 446Environment processing is disabled by default and is
447controlled via the
448.Cm PermitUserEnvironment
449option.
2548961d 450This option is automatically disabled if
451.Cm UseLogin
452is enabled.
9ed4bd80 453.It Cm from="pattern-list"
454Specifies that in addition to public key authentication, the canonical name
455of the remote host must be present in the comma-separated list of
456patterns
481e991f 457.Pf ( Ql *
9ed4bd80 458and
459.Ql \&?
460serve as wildcards).
461The list may also contain
462patterns negated by prefixing them with
463.Ql \&! ;
464if the canonical host name matches a negated pattern, the key is not accepted.
465The purpose
466of this option is to optionally increase security: public key authentication
467by itself does not trust the network or name servers or anything (but
468the key); however, if somebody somehow steals the key, the key
469permits an intruder to log in from anywhere in the world.
470This additional option makes using a stolen key more difficult (name
471servers and/or routers would have to be compromised in addition to
472just the key).
473.It Cm no-agent-forwarding
474Forbids authentication agent forwarding when this key is used for
475authentication.
bf740959 476.It Cm no-port-forwarding
e5d4cfad 477Forbids TCP forwarding when this key is used for authentication.
4fe2af09 478Any port forward requests by the client will return an error.
479This might be used, e.g., in connection with the
bf740959 480.Cm command
481option.
9ed4bd80 482.It Cm no-pty
483Prevents tty allocation (a request to allocate a pty will fail).
bf740959 484.It Cm no-X11-forwarding
485Forbids X11 forwarding when this key is used for authentication.
486Any X11 forward requests by the client will return an error.
dc504afd 487.It Cm permitopen="host:port"
3730bb22 488Limit local
dc504afd 489.Li ``ssh -L''
b2ae83b8 490port forwarding such that it may only connect to the specified host and
ed787d14 491port.
492IPv6 addresses can be specified with an alternative syntax:
433e60ac 493.Ar host Ns / Ns Ar port .
ed787d14 494Multiple
dc504afd 495.Cm permitopen
3cbc677d 496options may be applied separated by commas.
497No pattern matching is performed on the specified hostnames,
498they must be literal domains or addresses.
d20f3c9e 499.It Cm tunnel="n"
500Force a
501.Xr tun 4
502device on the server.
503Without this option, the next available device will be used if
504the client requests a tunnel.
bf740959 505.El
bf740959 506.Pp
1e0fcfc6 507An example authorized_keys file:
481e991f 508.Bd -literal -offset 3n
1e0fcfc6 509# Comments allowed at start of line
510ssh-rsa AAAAB3Nza...LiPk== user@example.net
481e991f 511from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
512AAAAB2...19Q== john@example.net
513command="dump /home",no-pty,no-port-forwarding ssh-dss
514AAAAC3...51R== example.net
515permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
516AAAAB5...21S==
517tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
518jane@example.net
1e0fcfc6 519.Ed
bf740959 520.Sh SSH_KNOWN_HOSTS FILE FORMAT
f54651ce 521The
6691e41b 522.Pa /etc/ssh/ssh_known_hosts
f54651ce 523and
140e3e97 524.Pa ~/.ssh/known_hosts
4fe2af09 525files contain host public keys for all known hosts.
526The global file should
527be prepared by the administrator (optional), and the per-user file is
2881e0e9 528maintained automatically: whenever the user connects from an unknown host,
4fe2af09 529its key is added to the per-user file.
bf740959 530.Pp
531Each line in these files contains the following fields: hostnames,
4fe2af09 532bits, exponent, modulus, comment.
533The fields are separated by spaces.
bf740959 534.Pp
09dc8896 535Hostnames is a comma-separated list of patterns
2881e0e9 536.Pf ( Ql *
3cbc677d 537and
538.Ql \&?
9a26a6e2 539act as
bf740959 540wildcards); each pattern in turn is matched against the canonical host
541name (when authenticating a client) or against the user-supplied
4fe2af09 542name (when authenticating a server).
543A pattern may also be preceded by
9a26a6e2 544.Ql \&!
bf740959 545to indicate negation: if the host name matches a negated
546pattern, it is not accepted (by that line) even if it matched another
547pattern on the line.
548.Pp
5c63c2ab 549Alternately, hostnames may be stored in a hashed form which hides host names
c79ae9fd 550and addresses should the file's contents be disclosed.
551Hashed hostnames start with a
552.Ql |
5c63c2ab 553character.
554Only one hashed hostname may appear on a single line and none of the above
555negation or wildcard operators may be applied.
556.Pp
1d1ffb87 557Bits, exponent, and modulus are taken directly from the RSA host key; they
2881e0e9 558can be obtained, for example, from
2a8a6488 559.Pa /etc/ssh/ssh_host_key.pub .
bf740959 560The optional comment field continues to the end of the line, and is not used.
561.Pp
562Lines starting with
563.Ql #
564and empty lines are ignored as comments.
565.Pp
566When performing host authentication, authentication is accepted if any
4fe2af09 567matching line has the proper key.
568It is thus permissible (but not
bf740959 569recommended) to have several lines or different host keys for the same
4fe2af09 570names.
571This will inevitably happen when short forms of host names
572from different domains are put in the file.
573It is possible
bf740959 574that the files contain conflicting information; authentication is
575accepted if valid information can be found from either file.
576.Pp
577Note that the lines in these files are typically hundreds of characters
578long, and you definitely don't want to type in the host keys by hand.
579Rather, generate them by a script
f54651ce 580or by taking
2a8a6488 581.Pa /etc/ssh/ssh_host_key.pub
bf740959 582and adding the host names at the front.
9d4b0313 583.Pp
584An example ssh_known_hosts file:
585.Bd -literal -offset 3n
586# Comments allowed at start of line
587closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
588cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
5c63c2ab 589# A hashed hostname
590|1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
591AAAA1234.....=
592.Ed
bf740959 593.Sh FILES
10fa86ae 594.Bl -tag -width Ds -compact
595.It ~/.hushlogin
a333272d 596This file is used to suppress printing the last login time and
597.Pa /etc/motd ,
598if
599.Cm PrintLastLog
600and
601.Cm PrintMotd ,
602respectively,
603are enabled.
604It does not suppress printing of the banner specified by
605.Cm Banner .
10fa86ae 606.Pp
607.It ~/.rhosts
6f5abc1e 608This file is used during
609.Cm RhostsRSAAuthentication
610and
611.Cm HostbasedAuthentication
612and contains host-username pairs, separated by a space, one per
4fe2af09 613line.
614The given user on the corresponding host is permitted to log in
6691e41b 615without a password.
4fe2af09 616The same file is used by rlogind and rshd.
bf740959 617The file must
618be writable only by the user; it is recommended that it not be
619accessible by others.
620.Pp
433e60ac 621It is also possible to use netgroups in the file.
4fe2af09 622Either host or user
bf740959 623name may be of the form +@groupname to specify all hosts or all users
624in the group.
10fa86ae 625.Pp
626.It ~/.shosts
bf740959 627For ssh,
628this file is exactly the same as for
629.Pa .rhosts .
630However, this file is
631not used by rlogin and rshd, so using this permits access using SSH only.
bf740959 632.Pp
10fa86ae 633.It ~/.ssh/authorized_keys
634Lists the public keys (RSA or DSA) that can be used to log into the user's account.
635This file must be readable by root (which may on some machines imply
636it being world-readable if the user's home directory resides on an NFS
637volume).
638It is recommended that it not be accessible by others.
639The format of this file is described above.
640Users will place the contents of their
641.Pa identity.pub ,
642.Pa id_dsa.pub
643and/or
644.Pa id_rsa.pub
645files into this file, as described in
646.Xr ssh-keygen 1 .
bf740959 647.Pp
10fa86ae 648.It ~/.ssh/environment
4fe2af09 649This file is read into the environment at login (if it exists).
650It can only contain empty lines, comment lines (that start with
bf740959 651.Ql # ) ,
4fe2af09 652and assignment lines of the form name=value.
653The file should be writable
bf740959 654only by the user; it need not be readable by anyone else.
35453849 655Environment processing is disabled by default and is
656controlled via the
657.Cm PermitUserEnvironment
658option.
10fa86ae 659.Pp
660.It ~/.ssh/known_hosts
661.It /etc/ssh/ssh_known_hosts
662These files are consulted when using rhosts with RSA host
663authentication or protocol version 2 hostbased authentication
664to check the public key of the host.
665The key must be listed in one of these files to be accepted.
666The client uses the same files
667to verify that it is connecting to the correct remote host.
668These files should be writable only by root/the owner.
669.Pa /etc/ssh/ssh_known_hosts
670should be world-readable, and
671.Pa ~/.ssh/known_hosts
672can, but need not be, world-readable.
673.Pp
674.It ~/.ssh/rc
6691e41b 675If this file exists, it is run with
676.Pa /bin/sh
677after reading the
4fe2af09 678environment files but before starting the user's shell or command.
d4c6ddff 679It must not produce any output on stdout; stderr must be used
680instead.
681If X11 forwarding is in use, it will receive the "proto cookie" pair in
682its standard input (and
bf740959 683.Ev DISPLAY
d4c6ddff 684in its environment).
685The script must call
bf740959 686.Xr xauth 1
d4c6ddff 687because
688.Nm
689will not run xauth automatically to add X11 cookies.
bf740959 690.Pp
691The primary purpose of this file is to run any initialization routines
692which may be needed before the user's home directory becomes
693accessible; AFS is a particular example of such an environment.
694.Pp
695This file will probably contain some initialization code followed by
da89cf4d 696something similar to:
697.Bd -literal
d4c6ddff 698if read proto cookie && [ -n "$DISPLAY" ]; then
699 if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
700 # X11UseLocalhost=yes
cb11b555 701 echo add unix:`echo $DISPLAY |
d4c6ddff 702 cut -c11-` $proto $cookie
703 else
704 # X11UseLocalhost=no
cb11b555 705 echo add $DISPLAY $proto $cookie
706 fi | xauth -q -
d4c6ddff 707fi
da89cf4d 708.Ed
bf740959 709.Pp
710If this file does not exist,
2a8a6488 711.Pa /etc/ssh/sshrc
bf740959 712is run, and if that
d4c6ddff 713does not exist either, xauth is used to add the cookie.
bf740959 714.Pp
715This file should be writable only by the user, and need not be
716readable by anyone else.
10fa86ae 717.Pp
718.It /etc/hosts.allow
719.It /etc/hosts.deny
720Access controls that should be enforced by tcp-wrappers are defined here.
721Further details are described in
722.Xr hosts_access 5 .
723.Pp
724.It /etc/hosts.equiv
725This file is used during
726.Cm RhostsRSAAuthentication
727and
728.Cm HostbasedAuthentication
729authentication.
730In the simplest form, this file contains host names, one per line.
731Users on
732those hosts are permitted to log in without a password, provided they
733have the same user name on both machines.
734The host name may also be
735followed by a user name; such users are permitted to log in as
736.Em any
737user on this machine (except root).
738Additionally, the syntax
739.Dq +@group
740can be used to specify netgroups.
741Negated entries start with
742.Ql \&- .
743.Pp
744If the client host/user is successfully matched in this file, login is
745automatically permitted provided the client and server user names are the
746same.
747Additionally, successful client host key authentication is required.
748This file must be writable only by root; it is recommended
749that it be world-readable.
750.Pp
751.Sy "Warning: It is almost never a good idea to use user names in"
752.Pa hosts.equiv .
753Beware that it really means that the named user(s) can log in as
754.Em anybody ,
755which includes bin, daemon, adm, and other accounts that own critical
756binaries and directories.
757Using a user name practically grants the user root access.
758The only valid use for user names that I can think
759of is in negative entries.
760.Pp
761Note that this warning also applies to rsh/rlogin.
762.Pp
763.It /etc/moduli
764Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
765The file format is described in
766.Xr moduli 5 .
767.Pp
768.It /etc/motd
769See
770.Xr motd 5 .
771.Pp
772.It /etc/nologin
773If this file exists,
774.Nm
775refuses to let anyone except root log in.
776The contents of the file
777are displayed to anyone trying to log in, and non-root connections are
778refused.
779The file should be world-readable.
780.Pp
781.It /etc/shosts.equiv
782This is processed exactly as
783.Pa /etc/hosts.equiv .
784However, this file may be useful in environments that want to run both
785rsh/rlogin and ssh.
786.Pp
787.It /etc/ssh/ssh_host_key
788.It /etc/ssh/ssh_host_dsa_key
789.It /etc/ssh/ssh_host_rsa_key
790These three files contain the private parts of the host keys.
791These files should only be owned by root, readable only by root, and not
792accessible to others.
793Note that
794.Nm
795does not start if this file is group/world-accessible.
796.Pp
797.It /etc/ssh/ssh_host_key.pub
798.It /etc/ssh/ssh_host_dsa_key.pub
799.It /etc/ssh/ssh_host_rsa_key.pub
800These three files contain the public parts of the host keys.
801These files should be world-readable but writable only by
802root.
803Their contents should match the respective private parts.
804These files are not
805really used for anything; they are provided for the convenience of
806the user so their contents can be copied to known hosts files.
807These files are created using
808.Xr ssh-keygen 1 .
809.Pp
810.It /etc/ssh/sshd_config
811Contains configuration data for
812.Nm sshd .
813The file format and configuration options are described in
814.Xr sshd_config 5 .
815.Pp
816.It /etc/ssh/sshrc
bf740959 817Like
140e3e97 818.Pa ~/.ssh/rc .
bf740959 819This can be used to specify
4fe2af09 820machine-specific login-time initializations globally.
821This file should be writable only by root, and should be world-readable.
10fa86ae 822.Pp
823.It /var/empty
824.Xr chroot 2
825directory used by
826.Nm
827during privilege separation in the pre-authentication phase.
828The directory should not contain any files and must be owned by root
829and not group or world-writable.
830.Pp
831.It /var/run/sshd.pid
832Contains the process ID of the
833.Nm
834listening for connections (if there are several daemons running
835concurrently for different ports, this contains the process ID of the one
836started last).
837The content of this file is not sensitive; it can be world-readable.
089fbbd2 838.El
bf740959 839.Sh SEE ALSO
bf740959 840.Xr scp 1 ,
61e96248 841.Xr sftp 1 ,
bf740959 842.Xr ssh 1 ,
843.Xr ssh-add 1 ,
844.Xr ssh-agent 1 ,
845.Xr ssh-keygen 1 ,
433e60ac 846.Xr chroot 2 ,
847.Xr hosts_access 5 ,
248bad82 848.Xr login.conf 5 ,
849.Xr moduli 5 ,
588df31a 850.Xr sshd_config 5 ,
433e60ac 851.Xr inetd 8 ,
a5a2da3b 852.Xr sftp-server 8
2cad6cef 853.Rs
854.%A T. Ylonen
855.%A T. Kivinen
856.%A M. Saarinen
857.%A T. Rinne
858.%A S. Lehtinen
859.%T "SSH Protocol Architecture"
17f5e68a 860.%N draft-ietf-secsh-architecture-12.txt
861.%D January 2002
2cad6cef 862.%O work in progress material
863.Re
da89cf4d 864.Rs
865.%A M. Friedl
866.%A N. Provos
867.%A W. A. Simpson
868.%T "Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol"
17f5e68a 869.%N draft-ietf-secsh-dh-group-exchange-02.txt
870.%D January 2002
da89cf4d 871.%O work in progress material
872.Re
be193d89 873.Sh AUTHORS
874OpenSSH is a derivative of the original and free
875ssh 1.2.12 release by Tatu Ylonen.
876Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
877Theo de Raadt and Dug Song
878removed many bugs, re-added newer features and
879created OpenSSH.
880Markus Friedl contributed the support for SSH
881protocol versions 1.5 and 2.0.
882Niels Provos and Markus Friedl contributed support
883for privilege separation.
4eb67845 884.Sh CAVEATS
885System security is not improved unless
886.Nm rshd ,
887.Nm rlogind ,
888and
889.Nm rexecd
890are disabled (thus completely disabling
891.Xr rlogin
892and
893.Xr rsh
894into the machine).
This page took 2.548776 seconds and 5 git commands to generate.