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