blob: 5503b13311e51f8135d5b31ac7c745ba52d7d049 [file] [log] [blame]
Damien Miller32aa1441999-10-29 09:15:49 +10001.\"
Damien Miller32aa1441999-10-29 09:15:49 +10002.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller32aa1441999-10-29 09:15:49 +10003.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4.\" All rights reserved
5.\"
Damien Millere4340be2000-09-16 13:29:08 +11006.\" As far as I am concerned, the code I have written for this software
7.\" can be used freely for any purpose. Any derived versions of this
8.\" software must be clearly marked as such, and if the derived work is
9.\" incompatible with the protocol description in the RFC file, it must be
10.\" called by a name other than "ssh" or "Secure Shell".
Damien Miller32aa1441999-10-29 09:15:49 +100011.\"
Ben Lindstrom92a2e382001-03-05 06:59:27 +000012.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
13.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
14.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
Damien Millere4340be2000-09-16 13:29:08 +110015.\"
16.\" Redistribution and use in source and binary forms, with or without
17.\" modification, are permitted provided that the following conditions
18.\" are met:
19.\" 1. Redistributions of source code must retain the above copyright
20.\" notice, this list of conditions and the following disclaimer.
21.\" 2. Redistributions in binary form must reproduce the above copyright
22.\" notice, this list of conditions and the following disclaimer in the
23.\" documentation and/or other materials provided with the distribution.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Damien Miller32aa1441999-10-29 09:15:49 +100035.\"
Damien Miller55fa5652010-11-05 10:20:14 +110036.\" $OpenBSD: sshd.8,v 1.260 2010/10/28 18:33:28 jmc Exp $
37.Dd $Mdocdate: October 28 2010 $
Damien Miller32aa1441999-10-29 09:15:49 +100038.Dt SSHD 8
39.Os
40.Sh NAME
41.Nm sshd
Ben Lindstromc65e6a02001-04-23 13:02:16 +000042.Nd OpenSSH SSH daemon
Damien Miller32aa1441999-10-29 09:15:49 +100043.Sh SYNOPSIS
44.Nm sshd
Damien Millerffadc582003-02-24 11:52:26 +110045.Bk -words
Darren Tuckere7f3f752008-06-10 23:06:01 +100046.Op Fl 46DdeiqTt
Damien Miller32aa1441999-10-29 09:15:49 +100047.Op Fl b Ar bits
Darren Tuckere7140f22008-06-10 23:01:51 +100048.Op Fl C Ar connection_spec
Damien Miller0a80ca12010-02-27 07:55:05 +110049.Op Fl c Ar host_certificate_file
Damien Miller32aa1441999-10-29 09:15:49 +100050.Op Fl f Ar config_file
51.Op Fl g Ar login_grace_time
52.Op Fl h Ar host_key_file
53.Op Fl k Ar key_gen_time
Ben Lindstromade03f62001-12-06 18:22:17 +000054.Op Fl o Ar option
Damien Miller32aa1441999-10-29 09:15:49 +100055.Op Fl p Ar port
Damien Miller942da032000-08-18 13:59:06 +100056.Op Fl u Ar len
Damien Millerffadc582003-02-24 11:52:26 +110057.Ek
Damien Miller22c77262000-04-13 12:26:34 +100058.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +100059.Nm
Damien Miller99cc4a82006-01-31 21:45:53 +110060(OpenSSH Daemon) is the daemon program for
Damien Miller32aa1441999-10-29 09:15:49 +100061.Xr ssh 1 .
Darren Tucker04354b92007-03-21 20:46:54 +110062Together these programs replace
63.Xr rlogin 1
64and
65.Xr rsh 1 ,
66and provide secure encrypted communications between two untrusted hosts
Damien Miller450a7a12000-03-26 13:04:51 +100067over an insecure network.
Damien Miller32aa1441999-10-29 09:15:49 +100068.Pp
69.Nm
Damien Miller99cc4a82006-01-31 21:45:53 +110070listens for connections from clients.
Damien Miller22c77262000-04-13 12:26:34 +100071It is normally started at boot from
Damien Miller32aa1441999-10-29 09:15:49 +100072.Pa /etc/rc .
73It forks a new
Damien Miller450a7a12000-03-26 13:04:51 +100074daemon for each incoming connection.
75The forked daemons handle
Damien Miller32aa1441999-10-29 09:15:49 +100076key exchange, encryption, authentication, command execution,
77and data exchange.
Damien Miller32aa1441999-10-29 09:15:49 +100078.Pp
79.Nm
Darren Tucker1f203942003-10-15 15:50:42 +100080can be configured using command-line options or a configuration file
81(by default
Damien Miller99cc4a82006-01-31 21:45:53 +110082.Xr sshd_config 5 ) ;
83command-line options override values specified in the
Damien Miller32aa1441999-10-29 09:15:49 +100084configuration file.
Damien Miller6162d121999-11-21 13:23:52 +110085.Nm
86rereads its configuration file when it receives a hangup signal,
Ben Lindstrom49a098d2001-03-05 06:55:18 +000087.Dv SIGHUP ,
Damien Miller208f1ed2006-03-15 11:56:03 +110088by executing itself with the name and options it was started with, e.g.\&
Ben Lindstrom49a098d2001-03-05 06:55:18 +000089.Pa /usr/sbin/sshd .
Damien Miller6162d121999-11-21 13:23:52 +110090.Pp
Damien Miller32aa1441999-10-29 09:15:49 +100091The options are as follows:
92.Bl -tag -width Ds
Darren Tucker1f203942003-10-15 15:50:42 +100093.It Fl 4
94Forces
95.Nm
96to use IPv4 addresses only.
97.It Fl 6
98Forces
99.Nm
100to use IPv6 addresses only.
Damien Miller32aa1441999-10-29 09:15:49 +1000101.It Fl b Ar bits
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000102Specifies the number of bits in the ephemeral protocol version 1
Darren Tucker7499b0c2008-07-02 22:35:43 +1000103server key (default 1024).
Darren Tuckere7f3f752008-06-10 23:06:01 +1000104.It Fl C Ar connection_spec
105Specify the connection parameters to use for the
106.Fl T
107extended test mode.
108If provided, any
109.Cm Match
110directives in the configuration file
111that would apply to the specified user, host, and address will be set before
112the configuration is written to standard output.
113The connection parameters are supplied as keyword=value pairs.
114The keywords are
115.Dq user ,
116.Dq host ,
117and
118.Dq addr .
119All are required and may be supplied in any order, either with multiple
120.Fl C
121options or as a comma-separated list.
Damien Miller15f5b562010-03-03 10:25:21 +1100122.It Fl c Ar host_certificate_file
123Specifies a path to a certificate file to identify
124.Nm
125during key exchange.
126The certificate file must match a host key file specified using the
127.Fl h
128option or the
129.Cm HostKey
130configuration directive.
Darren Tucker1f203942003-10-15 15:50:42 +1000131.It Fl D
132When this option is specified,
133.Nm
134will not detach and does not become a daemon.
135This allows easy monitoring of
136.Nm sshd .
Damien Miller32aa1441999-10-29 09:15:49 +1000137.It Fl d
Damien Miller450a7a12000-03-26 13:04:51 +1000138Debug mode.
Damien Miller74d98252010-02-02 17:01:46 +1100139The server sends verbose debug output to standard error,
140and does not put itself in the background.
Damien Miller450a7a12000-03-26 13:04:51 +1000141The server also will not fork and will only process one connection.
142This option is only intended for debugging for the server.
Damien Millerffadc582003-02-24 11:52:26 +1100143Multiple
144.Fl d
145options increase the debugging level.
Damien Miller874d77b2000-10-14 16:23:11 +1100146Maximum is 3.
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000147.It Fl e
148When this option is specified,
149.Nm
150will send the output to the standard error instead of the system log.
Darren Tucker04354b92007-03-21 20:46:54 +1100151.It Fl f Ar config_file
Damien Miller450a7a12000-03-26 13:04:51 +1000152Specifies the name of the configuration file.
153The default is
Damien Miller05eda432002-02-10 18:32:28 +1100154.Pa /etc/ssh/sshd_config .
Damien Miller32aa1441999-10-29 09:15:49 +1000155.Nm
156refuses to start if there is no configuration file.
157.It Fl g Ar login_grace_time
158Gives the grace time for clients to authenticate themselves (default
Damien Millerc1348632002-09-05 14:35:14 +1000159120 seconds).
Damien Miller450a7a12000-03-26 13:04:51 +1000160If the client fails to authenticate the user within
161this many seconds, the server disconnects and exits.
162A value of zero indicates no limit.
Damien Miller32aa1441999-10-29 09:15:49 +1000163.It Fl h Ar host_key_file
Damien Miller7fc23732002-01-22 23:19:11 +1100164Specifies a file from which a host key is read.
Damien Miller32aa1441999-10-29 09:15:49 +1000165This option must be given if
166.Nm
167is not run as root (as the normal
Damien Miller7fc23732002-01-22 23:19:11 +1100168host key files are normally not readable by anyone but root).
169The default is
Damien Miller05eda432002-02-10 18:32:28 +1100170.Pa /etc/ssh/ssh_host_key
Damien Miller7fc23732002-01-22 23:19:11 +1100171for protocol version 1, and
Damien Millereb8b60e2010-08-31 22:41:14 +1000172.Pa /etc/ssh/ssh_host_dsa_key ,
173.Pa /etc/ssh/ssh_host_ecdsa_key
Damien Miller7fc23732002-01-22 23:19:11 +1100174and
Damien Millereb8b60e2010-08-31 22:41:14 +1000175.Pa /etc/ssh/ssh_host_rsa_key
Damien Miller7fc23732002-01-22 23:19:11 +1100176for protocol version 2.
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000177It is possible to have multiple host key files for
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000178the different protocol versions and host key algorithms.
Damien Miller32aa1441999-10-29 09:15:49 +1000179.It Fl i
180Specifies that
181.Nm
Damien Millerffadc582003-02-24 11:52:26 +1100182is being run from
183.Xr inetd 8 .
Damien Miller32aa1441999-10-29 09:15:49 +1000184.Nm
185is normally not run
186from inetd because it needs to generate the server key before it can
Damien Miller450a7a12000-03-26 13:04:51 +1000187respond to the client, and this may take tens of seconds.
188Clients would have to wait too long if the key was regenerated every time.
Damien Miller208f1ed2006-03-15 11:56:03 +1100189However, with small key sizes (e.g. 512) using
Damien Miller32aa1441999-10-29 09:15:49 +1000190.Nm
191from inetd may
192be feasible.
193.It Fl k Ar key_gen_time
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000194Specifies how often the ephemeral protocol version 1 server key is
195regenerated (default 3600 seconds, or one hour).
Damien Miller450a7a12000-03-26 13:04:51 +1000196The motivation for regenerating the key fairly
Darren Tucker1f203942003-10-15 15:50:42 +1000197often is that the key is not stored anywhere, and after about an hour
Damien Miller32aa1441999-10-29 09:15:49 +1000198it becomes impossible to recover the key for decrypting intercepted
199communications even if the machine is cracked into or physically
Damien Miller450a7a12000-03-26 13:04:51 +1000200seized.
201A value of zero indicates that the key will never be regenerated.
Ben Lindstromade03f62001-12-06 18:22:17 +0000202.It Fl o Ar option
203Can be used to give options in the format used in the configuration file.
204This is useful for specifying options for which there is no separate
205command-line flag.
Darren Tucker1f203942003-10-15 15:50:42 +1000206For full details of the options, and their values, see
207.Xr sshd_config 5 .
Damien Miller32aa1441999-10-29 09:15:49 +1000208.It Fl p Ar port
209Specifies the port on which the server listens for connections
210(default 22).
Damien Miller7d1ded42002-01-22 23:09:41 +1100211Multiple port options are permitted.
Damien Millerd7f308f2005-12-24 14:55:16 +1100212Ports specified in the configuration file with the
213.Cm Port
214option are ignored when a command-line port is specified.
215Ports specified using the
216.Cm ListenAddress
217option override command-line ports.
Damien Miller32aa1441999-10-29 09:15:49 +1000218.It Fl q
Damien Miller450a7a12000-03-26 13:04:51 +1000219Quiet mode.
220Nothing is sent to the system log.
221Normally the beginning,
Damien Miller32aa1441999-10-29 09:15:49 +1000222authentication, and termination of each connection is logged.
Darren Tuckere7140f22008-06-10 23:01:51 +1000223.It Fl T
224Extended test mode.
225Check the validity of the configuration file, output the effective configuration
226to stdout and then exit.
227Optionally,
228.Cm Match
229rules may be applied by specifying the connection parameters using one or more
230.Fl C
231options.
Darren Tuckere7f3f752008-06-10 23:06:01 +1000232.It Fl t
233Test mode.
234Only check the validity of the configuration file and sanity of the keys.
235This is useful for updating
236.Nm
237reliably as configuration options may change.
Damien Miller942da032000-08-18 13:59:06 +1000238.It Fl u Ar len
239This option is used to specify the size of the field
240in the
241.Li utmp
242structure that holds the remote host name.
243If the resolved host name is longer than
244.Ar len ,
245the dotted decimal value will be used instead.
246This allows hosts with very long host names that
247overflow this field to still be uniquely identified.
248Specifying
249.Fl u0
250indicates that only dotted decimal addresses
251should be put into the
252.Pa utmp
253file.
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000254.Fl u0
Damien Millerffadc582003-02-24 11:52:26 +1100255may also be used to prevent
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000256.Nm
257from making DNS requests unless the authentication
258mechanism or configuration requires it.
259Authentication mechanisms that may require DNS include
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000260.Cm RhostsRSAAuthentication ,
Damien Miller2ac05772006-02-01 22:05:42 +1100261.Cm HostbasedAuthentication ,
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000262and using a
263.Cm from="pattern-list"
264option in a key file.
Ben Lindstromea03db92002-03-05 01:38:57 +0000265Configuration options that require DNS include using a
266USER@HOST pattern in
267.Cm AllowUsers
268or
269.Cm DenyUsers .
Damien Miller32aa1441999-10-29 09:15:49 +1000270.El
Damien Miller8bbdf902006-02-01 22:05:25 +1100271.Sh AUTHENTICATION
272The OpenSSH SSH daemon supports SSH protocols 1 and 2.
Darren Tucker7a4a7652009-10-11 21:51:40 +1100273The default is to use protocol 2 only,
Damien Miller8bbdf902006-02-01 22:05:25 +1100274though this can be changed via the
275.Cm Protocol
276option in
277.Xr sshd_config 5 .
Damien Millereb8b60e2010-08-31 22:41:14 +1000278Protocol 2 supports DSA, ECDSA and RSA keys;
Damien Miller8bbdf902006-02-01 22:05:25 +1100279protocol 1 only supports RSA keys.
280For both protocols,
281each host has a host-specific key,
282normally 2048 bits,
283used to identify the host.
Damien Miller99cc4a82006-01-31 21:45:53 +1100284.Pp
Damien Miller8bbdf902006-02-01 22:05:25 +1100285Forward security for protocol 1 is provided through
286an additional server key,
287normally 768 bits,
288generated when the server starts.
Damien Miller99cc4a82006-01-31 21:45:53 +1100289This key is normally regenerated every hour if it has been used, and
290is never stored on disk.
Damien Miller99cc4a82006-01-31 21:45:53 +1100291Whenever a client connects, the daemon responds with its public
292host and server keys.
293The client compares the
294RSA host key against its own database to verify that it has not changed.
295The client then generates a 256-bit random number.
296It encrypts this
297random number using both the host key and the server key, and sends
298the encrypted number to the server.
299Both sides then use this
300random number as a session key which is used to encrypt all further
301communications in the session.
302The rest of the session is encrypted
303using a conventional cipher, currently Blowfish or 3DES, with 3DES
304being used by default.
305The client selects the encryption algorithm
306to use from those offered by the server.
307.Pp
Damien Miller8bbdf902006-02-01 22:05:25 +1100308For protocol 2,
309forward security is provided through a Diffie-Hellman key agreement.
310This key agreement results in a shared session key.
311The rest of the session is encrypted using a symmetric cipher, currently
312128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES.
313The client selects the encryption algorithm
314to use from those offered by the server.
315Additionally, session integrity is provided
316through a cryptographic message authentication code
Damien Millere45796f2007-06-11 14:01:42 +1000317(hmac-md5, hmac-sha1, umac-64 or hmac-ripemd160).
Damien Miller8bbdf902006-02-01 22:05:25 +1100318.Pp
319Finally, the server and the client enter an authentication dialog.
Damien Miller99cc4a82006-01-31 21:45:53 +1100320The client tries to authenticate itself using
Damien Miller8bbdf902006-02-01 22:05:25 +1100321host-based authentication,
322public key authentication,
323challenge-response authentication,
324or password authentication.
Damien Miller99cc4a82006-01-31 21:45:53 +1100325.Pp
326Regardless of the authentication type, the account is checked to
327ensure that it is accessible. An account is not accessible if it is
328locked, listed in
329.Cm DenyUsers
330or its group is listed in
331.Cm DenyGroups
332\&. The definition of a locked account is system dependant. Some platforms
333have their own account database (eg AIX) and some modify the passwd field (
334.Ql \&*LK\&*
335on Solaris and UnixWare,
336.Ql \&*
337on HP-UX, containing
338.Ql Nologin
339on Tru64,
340a leading
341.Ql \&*LOCKED\&*
342on FreeBSD and a leading
Darren Tucker1a9176b2007-08-17 09:42:32 +1000343.Ql \&!
344on most Linuxes).
345If there is a requirement to disable password authentication
Damien Miller99cc4a82006-01-31 21:45:53 +1100346for the account while allowing still public-key, then the passwd field
347should be set to something other than these values (eg
348.Ql NP
349or
350.Ql \&*NP\&*
351).
352.Pp
Damien Miller99cc4a82006-01-31 21:45:53 +1100353If the client successfully authenticates itself, a dialog for
354preparing the session is entered.
355At this time the client may request
356things like allocating a pseudo-tty, forwarding X11 connections,
357forwarding TCP connections, or forwarding the authentication agent
358connection over the secure channel.
359.Pp
Damien Millerc47d7e92006-03-15 11:27:20 +1100360After this, the client either requests a shell or execution of a command.
Damien Miller99cc4a82006-01-31 21:45:53 +1100361The sides then enter session mode.
362In this mode, either side may send
363data at any time, and such data is forwarded to/from the shell or
364command on the server side, and the user terminal in the client side.
365.Pp
366When the user program terminates and all forwarded X11 and other
367connections have been closed, the server sends command exit status to
368the client, and both sides exit.
Damien Miller32aa1441999-10-29 09:15:49 +1000369.Sh LOGIN PROCESS
370When a user successfully logs in,
371.Nm
372does the following:
373.Bl -enum -offset indent
374.It
375If the login is on a tty, and no command has been specified,
Damien Miller22c77262000-04-13 12:26:34 +1000376prints last login time and
Damien Miller32aa1441999-10-29 09:15:49 +1000377.Pa /etc/motd
378(unless prevented in the configuration file or by
Damien Miller167ea5d2005-05-26 12:04:02 +1000379.Pa ~/.hushlogin ;
Damien Miller32aa1441999-10-29 09:15:49 +1000380see the
Damien Miller22c77262000-04-13 12:26:34 +1000381.Sx FILES
Damien Miller32aa1441999-10-29 09:15:49 +1000382section).
383.It
384If the login is on a tty, records login time.
385.It
386Checks
387.Pa /etc/nologin ;
388if it exists, prints contents and quits
389(unless root).
390.It
391Changes to run with normal user privileges.
392.It
393Sets up basic environment.
394.It
Darren Tucker1f203942003-10-15 15:50:42 +1000395Reads the file
Damien Miller167ea5d2005-05-26 12:04:02 +1000396.Pa ~/.ssh/environment ,
Darren Tucker1f203942003-10-15 15:50:42 +1000397if it exists, and users are allowed to change their environment.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000398See the
Ben Lindstromdc7adf22002-08-20 18:38:02 +0000399.Cm PermitUserEnvironment
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000400option in
Ben Lindstromdc7adf22002-08-20 18:38:02 +0000401.Xr sshd_config 5 .
Damien Miller32aa1441999-10-29 09:15:49 +1000402.It
403Changes to user's home directory.
404.It
405If
Damien Miller167ea5d2005-05-26 12:04:02 +1000406.Pa ~/.ssh/rc
Damien Miller32aa1441999-10-29 09:15:49 +1000407exists, runs it; else if
Damien Millerafcc2252002-02-10 18:32:55 +1100408.Pa /etc/ssh/sshrc
Damien Miller32aa1441999-10-29 09:15:49 +1000409exists, runs
Damien Miller450a7a12000-03-26 13:04:51 +1000410it; otherwise runs xauth.
411The
Damien Miller32aa1441999-10-29 09:15:49 +1000412.Dq rc
413files are given the X11
414authentication protocol and cookie in standard input.
Damien Millerfd725cf2006-03-15 11:35:54 +1100415See
416.Sx SSHRC ,
417below.
Damien Miller32aa1441999-10-29 09:15:49 +1000418.It
419Runs user's shell or command.
420.El
Damien Millerfd725cf2006-03-15 11:35:54 +1100421.Sh SSHRC
422If the file
423.Pa ~/.ssh/rc
424exists,
425.Xr sh 1
426runs it after reading the
427environment files but before starting the user's shell or command.
428It must not produce any output on stdout; stderr must be used
429instead.
430If X11 forwarding is in use, it will receive the "proto cookie" pair in
431its standard input (and
432.Ev DISPLAY
433in its environment).
434The script must call
435.Xr xauth 1
436because
437.Nm
438will not run xauth automatically to add X11 cookies.
439.Pp
440The primary purpose of this file is to run any initialization routines
441which may be needed before the user's home directory becomes
442accessible; AFS is a particular example of such an environment.
443.Pp
444This file will probably contain some initialization code followed by
445something similar to:
446.Bd -literal -offset 3n
447if read proto cookie && [ -n "$DISPLAY" ]; then
448 if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
449 # X11UseLocalhost=yes
450 echo add unix:`echo $DISPLAY |
451 cut -c11-` $proto $cookie
452 else
453 # X11UseLocalhost=no
454 echo add $DISPLAY $proto $cookie
455 fi | xauth -q -
456fi
457.Ed
458.Pp
459If this file does not exist,
460.Pa /etc/ssh/sshrc
461is run, and if that
462does not exist either, xauth is used to add the cookie.
Damien Miller32aa1441999-10-29 09:15:49 +1000463.Sh AUTHORIZED_KEYS FILE FORMAT
Ben Lindstromf96704d2001-06-25 04:17:12 +0000464.Cm AuthorizedKeysFile
Damien Millerdcfea272006-03-15 11:31:22 +1100465specifies the file containing public keys for
466public key authentication;
467if none is specified, the default is
468.Pa ~/.ssh/authorized_keys .
Damien Miller450a7a12000-03-26 13:04:51 +1000469Each line of the file contains one
Damien Miller32aa1441999-10-29 09:15:49 +1000470key (empty lines and lines starting with a
471.Ql #
472are ignored as
Damien Miller450a7a12000-03-26 13:04:51 +1000473comments).
Damien Millerdcfea272006-03-15 11:31:22 +1100474Protocol 1 public keys consist of the following space-separated fields:
475options, bits, exponent, modulus, comment.
476Protocol 2 public key consist of:
477options, keytype, base64-encoded key, comment.
478The options field is optional;
479its presence is determined by whether the line starts
Damien Millerb83df8d2002-09-04 16:24:55 +1000480with a number or not (the options field never starts with a number).
Damien Millerdcfea272006-03-15 11:31:22 +1100481The bits, exponent, modulus, and comment fields give the RSA key for
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000482protocol version 1; the
Damien Miller32aa1441999-10-29 09:15:49 +1000483comment field is not used for anything (but may be convenient for the
484user to identify the key).
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000485For protocol version 2 the keytype is
Damien Millereb8b60e2010-08-31 22:41:14 +1000486.Dq ecdsa-sha2-nistp256 ,
487.Dq ecdsa-sha2-nistp384 ,
488.Dq ecdsa-sha2-nistp521 ,
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000489.Dq ssh-dss
490or
491.Dq ssh-rsa .
Damien Miller32aa1441999-10-29 09:15:49 +1000492.Pp
493Note that lines in this file are usually several hundred bytes long
Darren Tucker22cc7412004-12-06 22:47:41 +1100494(because of the size of the public key encoding) up to a limit of
4958 kilobytes, which permits DSA keys up to 8 kilobits and RSA
496keys up to 16 kilobits.
Damien Miller450a7a12000-03-26 13:04:51 +1000497You don't want to type them in; instead, copy the
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000498.Pa identity.pub ,
Damien Millerdcfea272006-03-15 11:31:22 +1100499.Pa id_dsa.pub ,
Damien Millereb8b60e2010-08-31 22:41:14 +1000500.Pa id_ecdsa.pub ,
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000501or the
502.Pa id_rsa.pub
Damien Miller32aa1441999-10-29 09:15:49 +1000503file and edit it.
504.Pp
Ben Lindstrom0d0be022002-04-02 20:39:29 +0000505.Nm
506enforces a minimum RSA key modulus size for protocol 1
507and protocol 2 keys of 768 bits.
508.Pp
Damien Miller942da032000-08-18 13:59:06 +1000509The options (if present) consist of comma-separated option
Damien Miller450a7a12000-03-26 13:04:51 +1000510specifications.
511No spaces are permitted, except within double quotes.
Ben Lindstrom1c0fd092001-09-12 16:36:17 +0000512The following option specifications are supported (note
513that option keywords are case-insensitive):
Damien Miller32aa1441999-10-29 09:15:49 +1000514.Bl -tag -width Ds
Damien Millercd38c9c2010-03-04 21:51:37 +1100515.It Cm cert-authority
Damien Miller0a80ca12010-02-27 07:55:05 +1100516Specifies that the listed key is a certification authority (CA) that is
517trusted to validate signed certificates for user authentication.
518.Pp
519Certificates may encode access restrictions similar to these key options.
520If both certificate restrictions and key options are present, the most
521restrictive union of the two is applied.
Damien Miller32aa1441999-10-29 09:15:49 +1000522.It Cm command="command"
523Specifies that the command is executed whenever this key is used for
Damien Miller450a7a12000-03-26 13:04:51 +1000524authentication.
525The command supplied by the user (if any) is ignored.
Ben Lindstrom23124ea2001-09-14 23:14:25 +0000526The command is run on a pty if the client requests a pty;
Damien Miller450a7a12000-03-26 13:04:51 +1000527otherwise it is run without a tty.
Damien Millerffadc582003-02-24 11:52:26 +1100528If an 8-bit clean channel is required,
Ben Lindstrom594e2032001-09-12 18:35:30 +0000529one must not request a pty or should specify
Damien Miller33804262001-02-04 23:20:18 +1100530.Cm no-pty .
Damien Miller450a7a12000-03-26 13:04:51 +1000531A quote may be included in the command by quoting it with a backslash.
532This option might be useful
Damien Millerb83df8d2002-09-04 16:24:55 +1000533to restrict certain public keys to perform just a specific operation.
Damien Miller450a7a12000-03-26 13:04:51 +1000534An example might be a key that permits remote backups but nothing else.
Damien Miller7c24b812006-01-14 10:09:56 +1100535Note that the client may specify TCP and/or X11
Damien Miller30c3d422000-05-09 11:02:59 +1000536forwarding unless they are explicitly prohibited.
Damien Millere2754432006-07-24 14:06:47 +1000537The command originally supplied by the client is available in the
538.Ev SSH_ORIGINAL_COMMAND
539environment variable.
Ben Lindstrom20daef72001-09-20 00:54:01 +0000540Note that this option applies to shell, command or subsystem execution.
Damien Miller0a80ca12010-02-27 07:55:05 +1100541Also note that this command may be superseded by either a
542.Xr sshd_config 5
543.Cm ForceCommand
544directive or a command embedded in a certificate.
Damien Miller32aa1441999-10-29 09:15:49 +1000545.It Cm environment="NAME=value"
546Specifies that the string is to be added to the environment when
Damien Miller450a7a12000-03-26 13:04:51 +1000547logging in using this key.
548Environment variables set this way
549override other default environment values.
550Multiple options of this type are permitted.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000551Environment processing is disabled by default and is
552controlled via the
553.Cm PermitUserEnvironment
554option.
Ben Lindstrom38b951c2001-12-06 17:47:47 +0000555This option is automatically disabled if
556.Cm UseLogin
557is enabled.
Damien Miller31bdc522006-03-15 11:31:44 +1100558.It Cm from="pattern-list"
Darren Tucker896ad5a2008-06-11 09:34:46 +1000559Specifies that in addition to public key authentication, either the canonical
Darren Tucker11996732008-06-13 04:32:00 +1000560name of the remote host or its IP address must be present in the
Darren Tucker896ad5a2008-06-11 09:34:46 +1000561comma-separated list of patterns.
Damien Millerc7d5b5e2006-03-15 11:55:08 +1100562See
563.Sx PATTERNS
564in
565.Xr ssh_config 5
566for more information on patterns.
Darren Tucker896ad5a2008-06-11 09:34:46 +1000567.Pp
568In addition to the wildcard matching that may be applied to hostnames or
569addresses, a
570.Cm from
Darren Tucker5837b512009-06-21 17:52:27 +1000571stanza may match IP addresses using CIDR address/masklen notation.
Darren Tucker896ad5a2008-06-11 09:34:46 +1000572.Pp
573The purpose of this option is to optionally increase security: public key
574authentication by itself does not trust the network or name servers or
575anything (but the key); however, if somebody somehow steals the key, the key
576permits an intruder to log in from anywhere in the world.
577This additional option makes using a stolen key more difficult (name
578servers and/or routers would have to be compromised in addition to
579just the key).
Damien Miller31bdc522006-03-15 11:31:44 +1100580.It Cm no-agent-forwarding
581Forbids authentication agent forwarding when this key is used for
582authentication.
Damien Miller32aa1441999-10-29 09:15:49 +1000583.It Cm no-port-forwarding
Damien Miller7c24b812006-01-14 10:09:56 +1100584Forbids TCP forwarding when this key is used for authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000585Any port forward requests by the client will return an error.
Damien Miller208f1ed2006-03-15 11:56:03 +1100586This might be used, e.g. in connection with the
Damien Miller32aa1441999-10-29 09:15:49 +1000587.Cm command
588option.
Damien Miller31bdc522006-03-15 11:31:44 +1100589.It Cm no-pty
590Prevents tty allocation (a request to allocate a pty will fail).
Damien Miller95e80952008-03-27 11:03:05 +1100591.It Cm no-user-rc
Damien Miller13ba9c22008-04-03 20:52:51 +1100592Disables execution of
Damien Miller95e80952008-03-27 11:03:05 +1100593.Pa ~/.ssh/rc .
Damien Miller32aa1441999-10-29 09:15:49 +1000594.It Cm no-X11-forwarding
595Forbids X11 forwarding when this key is used for authentication.
596Any X11 forward requests by the client will return an error.
Damien Millera243fde2001-03-19 23:16:08 +1100597.It Cm permitopen="host:port"
Ben Lindstrom24643222001-06-25 05:08:11 +0000598Limit local
Damien Millera243fde2001-03-19 23:16:08 +1100599.Li ``ssh -L''
Ben Lindstrom4b3564e2001-04-10 02:41:56 +0000600port forwarding such that it may only connect to the specified host and
Ben Lindstromd71ba572001-09-12 18:03:31 +0000601port.
Damien Miller7fa96602010-08-05 13:03:13 +1000602IPv6 addresses can be specified by enclosing the address in square brackets.
Ben Lindstromd71ba572001-09-12 18:03:31 +0000603Multiple
Damien Millera243fde2001-03-19 23:16:08 +1100604.Cm permitopen
Damien Millerfbf486b2003-05-23 18:44:23 +1000605options may be applied separated by commas.
606No pattern matching is performed on the specified hostnames,
607they must be literal domains or addresses.
Damien Miller30da3442010-05-10 11:58:03 +1000608.It Cm principals="principals"
609On a
610.Cm cert-authority
611line, specifies allowed principals for certificate authentication as a
612comma-separated list.
613At least one name from the list must appear in the certificate's
614list of principals for the certificate to be accepted.
615This option is ignored for keys that are not marked as trusted certificate
616signers using the
617.Cm cert-authority
618option.
Damien Millerd27b9472005-12-13 19:29:02 +1100619.It Cm tunnel="n"
620Force a
621.Xr tun 4
622device on the server.
623Without this option, the next available device will be used if
624the client requests a tunnel.
Damien Miller32aa1441999-10-29 09:15:49 +1000625.El
Damien Miller32aa1441999-10-29 09:15:49 +1000626.Pp
Damien Miller7d2ef022006-03-15 11:32:06 +1100627An example authorized_keys file:
Damien Millerc8f61cf2006-03-15 11:33:25 +1100628.Bd -literal -offset 3n
Damien Miller7d2ef022006-03-15 11:32:06 +1100629# Comments allowed at start of line
630ssh-rsa AAAAB3Nza...LiPk== user@example.net
Damien Millerc8f61cf2006-03-15 11:33:25 +1100631from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
632AAAAB2...19Q== john@example.net
633command="dump /home",no-pty,no-port-forwarding ssh-dss
634AAAAC3...51R== example.net
635permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
636AAAAB5...21S==
637tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
638jane@example.net
Damien Miller7d2ef022006-03-15 11:32:06 +1100639.Ed
Damien Miller32aa1441999-10-29 09:15:49 +1000640.Sh SSH_KNOWN_HOSTS FILE FORMAT
Damien Miller22c77262000-04-13 12:26:34 +1000641The
Damien Millerffadc582003-02-24 11:52:26 +1100642.Pa /etc/ssh/ssh_known_hosts
Damien Miller22c77262000-04-13 12:26:34 +1000643and
Damien Miller167ea5d2005-05-26 12:04:02 +1000644.Pa ~/.ssh/known_hosts
Damien Miller450a7a12000-03-26 13:04:51 +1000645files contain host public keys for all known hosts.
646The global file should
647be prepared by the administrator (optional), and the per-user file is
Damien Miller9a7f2012006-03-15 11:32:42 +1100648maintained automatically: whenever the user connects from an unknown host,
Damien Miller450a7a12000-03-26 13:04:51 +1000649its key is added to the per-user file.
Damien Miller32aa1441999-10-29 09:15:49 +1000650.Pp
Damien Millera7dab8b2010-03-05 10:42:05 +1100651Each line in these files contains the following fields: markers (optional),
652hostnames, bits, exponent, modulus, comment.
Damien Miller450a7a12000-03-26 13:04:51 +1000653The fields are separated by spaces.
Damien Miller32aa1441999-10-29 09:15:49 +1000654.Pp
Damien Millera7dab8b2010-03-05 10:42:05 +1100655The marker is optional, but if it is present then it must be one of
656.Dq @cert-authority ,
657to indicate that the line contains a certification authority (CA) key,
658or
659.Dq @revoked ,
660to indicate that the key contained on the line is revoked and must not ever
661be accepted.
662Only one marker should be used on a key line.
663.Pp
Damien Miller31554322003-05-14 13:44:58 +1000664Hostnames is a comma-separated list of patterns
Damien Miller9a7f2012006-03-15 11:32:42 +1100665.Pf ( Ql *
Damien Millerfbf486b2003-05-23 18:44:23 +1000666and
667.Ql \&?
Damien Miller049245d2003-05-14 13:44:42 +1000668act as
Damien Miller32aa1441999-10-29 09:15:49 +1000669wildcards); each pattern in turn is matched against the canonical host
670name (when authenticating a client) or against the user-supplied
Damien Miller450a7a12000-03-26 13:04:51 +1000671name (when authenticating a server).
672A pattern may also be preceded by
Damien Miller049245d2003-05-14 13:44:42 +1000673.Ql \&!
Damien Miller32aa1441999-10-29 09:15:49 +1000674to indicate negation: if the host name matches a negated
675pattern, it is not accepted (by that line) even if it matched another
676pattern on the line.
Darren Tuckerda345532006-07-10 23:04:19 +1000677A hostname or address may optionally be enclosed within
678.Ql \&[
679and
680.Ql \&]
681brackets then followed by
682.Ql \&:
Darren Tucker11318472006-07-12 22:07:59 +1000683and a non-standard port number.
Damien Miller32aa1441999-10-29 09:15:49 +1000684.Pp
Damien Millere1776152005-03-01 21:47:37 +1100685Alternately, hostnames may be stored in a hashed form which hides host names
Damien Miller718fd4b2005-03-02 12:03:23 +1100686and addresses should the file's contents be disclosed.
687Hashed hostnames start with a
688.Ql |
Damien Millere1776152005-03-01 21:47:37 +1100689character.
690Only one hashed hostname may appear on a single line and none of the above
691negation or wildcard operators may be applied.
692.Pp
Damien Millere247cc42000-05-07 12:03:14 +1000693Bits, exponent, and modulus are taken directly from the RSA host key; they
Damien Miller9a7f2012006-03-15 11:32:42 +1100694can be obtained, for example, from
Damien Miller05eda432002-02-10 18:32:28 +1100695.Pa /etc/ssh/ssh_host_key.pub .
Damien Miller32aa1441999-10-29 09:15:49 +1000696The optional comment field continues to the end of the line, and is not used.
697.Pp
698Lines starting with
699.Ql #
700and empty lines are ignored as comments.
701.Pp
702When performing host authentication, authentication is accepted if any
Damien Millera7dab8b2010-03-05 10:42:05 +1100703matching line has the proper key; either one that matches exactly or,
704if the server has presented a certificate for authentication, the key
705of the certification authority that signed the certificate.
706For a key to be trusted as a certification authority, it must use the
707.Dq @cert-authority
708marker described above.
709.Pp
710The known hosts file also provides a facility to mark keys as revoked,
711for example when it is known that the associated private key has been
712stolen.
713Revoked keys are specified by including the
714.Dq @revoked
715marker at the beginning of the key line, and are never accepted for
716authentication or as certification authorities, but instead will
717produce a warning from
718.Xr ssh 1
719when they are encountered.
720.Pp
721It is permissible (but not
Damien Miller32aa1441999-10-29 09:15:49 +1000722recommended) to have several lines or different host keys for the same
Damien Miller450a7a12000-03-26 13:04:51 +1000723names.
724This will inevitably happen when short forms of host names
725from different domains are put in the file.
726It is possible
Damien Miller32aa1441999-10-29 09:15:49 +1000727that the files contain conflicting information; authentication is
728accepted if valid information can be found from either file.
729.Pp
730Note that the lines in these files are typically hundreds of characters
731long, and you definitely don't want to type in the host keys by hand.
Damien Millera7dab8b2010-03-05 10:42:05 +1100732Rather, generate them by a script,
733.Xr ssh-keyscan 1
Damien Miller22c77262000-04-13 12:26:34 +1000734or by taking
Damien Miller05eda432002-02-10 18:32:28 +1100735.Pa /etc/ssh/ssh_host_key.pub
Damien Miller32aa1441999-10-29 09:15:49 +1000736and adding the host names at the front.
Damien Millera7dab8b2010-03-05 10:42:05 +1100737.Xr ssh-keygen 1
Damien Miller98339052010-03-05 21:30:35 +1100738also offers some basic automated editing for
Damien Millera7dab8b2010-03-05 10:42:05 +1100739.Pa ~/.ssh/known_hosts
740including removing hosts matching a host name and converting all host
741names to their hashed representations.
Damien Millercc00f5e2006-03-15 11:33:00 +1100742.Pp
743An example ssh_known_hosts file:
744.Bd -literal -offset 3n
745# Comments allowed at start of line
746closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
747cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
Damien Millere1776152005-03-01 21:47:37 +1100748# A hashed hostname
749|1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
750AAAA1234.....=
Damien Millera7dab8b2010-03-05 10:42:05 +1100751# A revoked key
752@revoked * ssh-rsa AAAAB5W...
753# A CA key, accepted for any host in *.mydomain.com or *.mydomain.org
754@cert-authority *.mydomain.org,*.mydomain.com ssh-rsa AAAAB5W...
Damien Millere1776152005-03-01 21:47:37 +1100755.Ed
Damien Miller32aa1441999-10-29 09:15:49 +1000756.Sh FILES
Damien Millerd8702e82006-03-15 11:33:56 +1100757.Bl -tag -width Ds -compact
Damien Millerafdae612010-08-31 22:31:14 +1000758.It Pa ~/.hushlogin
Damien Miller70a908e2005-03-01 21:17:09 +1100759This file is used to suppress printing the last login time and
760.Pa /etc/motd ,
761if
762.Cm PrintLastLog
763and
764.Cm PrintMotd ,
765respectively,
766are enabled.
767It does not suppress printing of the banner specified by
768.Cm Banner .
Damien Millerd8702e82006-03-15 11:33:56 +1100769.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000770.It Pa ~/.rhosts
Damien Milleradc35b92006-03-15 11:35:27 +1100771This file is used for host-based authentication (see
772.Xr ssh 1
773for more information).
774On some machines this file may need to be
775world-readable if the user's home directory is on an NFS partition,
776because
777.Nm
778reads it as root.
779Additionally, this file must be owned by the user,
780and must not have write permissions for anyone else.
781The recommended
782permission for most machines is read/write for the user, and not
Damien Miller32aa1441999-10-29 09:15:49 +1000783accessible by others.
784.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000785.It Pa ~/.shosts
Damien Milleradc35b92006-03-15 11:35:27 +1100786This file is used in exactly the same way as
787.Pa .rhosts ,
788but allows host-based authentication without permitting login with
789rlogin/rsh.
Damien Miller32aa1441999-10-29 09:15:49 +1000790.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000791.It Pa ~/.ssh/
Damien Miller520e6152008-02-10 22:46:22 +1100792This directory is the default location for all user-specific configuration
793and authentication information.
794There is no general requirement to keep the entire contents of this directory
795secret, but the recommended permissions are read/write/execute for the user,
796and not accessible by others.
797.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000798.It Pa ~/.ssh/authorized_keys
Damien Millereb8b60e2010-08-31 22:41:14 +1000799Lists the public keys (DSA/ECDSA/RSA) that can be used for logging in
800as this user.
Damien Millerd8702e82006-03-15 11:33:56 +1100801The format of this file is described above.
Damien Miller5d43d492006-08-30 11:07:00 +1000802The content of the file is not highly sensitive, but the recommended
Damien Milleradc35b92006-03-15 11:35:27 +1100803permissions are read/write for the user, and not accessible by others.
Damien Miller32aa1441999-10-29 09:15:49 +1000804.Pp
Damien Miller5d43d492006-08-30 11:07:00 +1000805If this file, the
806.Pa ~/.ssh
807directory, or the user's home directory are writable
808by other users, then the file could be modified or replaced by unauthorized
809users.
810In this case,
811.Nm
812will not allow it to be used unless the
813.Cm StrictModes
814option has been set to
815.Dq no .
Damien Miller5d43d492006-08-30 11:07:00 +1000816.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000817.It Pa ~/.ssh/environment
Damien Miller450a7a12000-03-26 13:04:51 +1000818This file is read into the environment at login (if it exists).
819It can only contain empty lines, comment lines (that start with
Damien Miller32aa1441999-10-29 09:15:49 +1000820.Ql # ) ,
Damien Miller450a7a12000-03-26 13:04:51 +1000821and assignment lines of the form name=value.
822The file should be writable
Damien Miller32aa1441999-10-29 09:15:49 +1000823only by the user; it need not be readable by anyone else.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000824Environment processing is disabled by default and is
825controlled via the
826.Cm PermitUserEnvironment
827option.
Damien Millerd8702e82006-03-15 11:33:56 +1100828.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000829.It Pa ~/.ssh/known_hosts
Damien Milleradc35b92006-03-15 11:35:27 +1100830Contains a list of host keys for all hosts the user has logged into
831that are not already in the systemwide list of known host keys.
832The format of this file is described above.
833This file should be writable only by root/the owner and
Damien Millerd8702e82006-03-15 11:33:56 +1100834can, but need not be, world-readable.
835.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000836.It Pa ~/.ssh/rc
Damien Millerfd725cf2006-03-15 11:35:54 +1100837Contains initialization routines to be run before
838the user's home directory becomes accessible.
Damien Miller32aa1441999-10-29 09:15:49 +1000839This file should be writable only by the user, and need not be
840readable by anyone else.
Damien Millerd8702e82006-03-15 11:33:56 +1100841.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000842.It Pa /etc/hosts.allow
843.It Pa /etc/hosts.deny
Damien Millerd8702e82006-03-15 11:33:56 +1100844Access controls that should be enforced by tcp-wrappers are defined here.
845Further details are described in
846.Xr hosts_access 5 .
847.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000848.It Pa /etc/hosts.equiv
Damien Miller445121f2006-03-15 11:36:18 +1100849This file is for host-based authentication (see
850.Xr ssh 1 ) .
851It should only be writable by root.
Damien Millerd8702e82006-03-15 11:33:56 +1100852.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000853.It Pa /etc/moduli
Damien Millerd8702e82006-03-15 11:33:56 +1100854Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
855The file format is described in
856.Xr moduli 5 .
857.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000858.It Pa /etc/motd
Damien Millerd8702e82006-03-15 11:33:56 +1100859See
860.Xr motd 5 .
861.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000862.It Pa /etc/nologin
Damien Millerd8702e82006-03-15 11:33:56 +1100863If this file exists,
864.Nm
865refuses to let anyone except root log in.
866The contents of the file
867are displayed to anyone trying to log in, and non-root connections are
868refused.
869The file should be world-readable.
870.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000871.It Pa /etc/shosts.equiv
Damien Miller445121f2006-03-15 11:36:18 +1100872This file is used in exactly the same way as
873.Pa hosts.equiv ,
874but allows host-based authentication without permitting login with
875rlogin/rsh.
Damien Millerd8702e82006-03-15 11:33:56 +1100876.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000877.It Pa /etc/ssh/ssh_host_key
878.It Pa /etc/ssh/ssh_host_dsa_key
Damien Millereb8b60e2010-08-31 22:41:14 +1000879.It Pa /etc/ssh/ssh_host_ecdsa_key
Damien Millerafdae612010-08-31 22:31:14 +1000880.It Pa /etc/ssh/ssh_host_rsa_key
Damien Millerd8702e82006-03-15 11:33:56 +1100881These three files contain the private parts of the host keys.
882These files should only be owned by root, readable only by root, and not
883accessible to others.
884Note that
885.Nm
Damien Milleredd03752006-03-15 11:36:45 +1100886does not start if these files are group/world-accessible.
Damien Millerd8702e82006-03-15 11:33:56 +1100887.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000888.It Pa /etc/ssh/ssh_host_key.pub
889.It Pa /etc/ssh/ssh_host_dsa_key.pub
Damien Millereb8b60e2010-08-31 22:41:14 +1000890.It Pa /etc/ssh/ssh_host_ecdsa_key.pub
Damien Millerafdae612010-08-31 22:31:14 +1000891.It Pa /etc/ssh/ssh_host_rsa_key.pub
Damien Millerd8702e82006-03-15 11:33:56 +1100892These three files contain the public parts of the host keys.
893These files should be world-readable but writable only by
894root.
895Their contents should match the respective private parts.
896These files are not
897really used for anything; they are provided for the convenience of
898the user so their contents can be copied to known hosts files.
899These files are created using
900.Xr ssh-keygen 1 .
901.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000902.It Pa /etc/ssh/ssh_known_hosts
Darren Tucker04354b92007-03-21 20:46:54 +1100903Systemwide list of known host keys.
904This file should be prepared by the
905system administrator to contain the public host keys of all machines in the
906organization.
907The format of this file is described above.
908This file should be writable only by root/the owner and
909should be world-readable.
910.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000911.It Pa /etc/ssh/sshd_config
Damien Millerd8702e82006-03-15 11:33:56 +1100912Contains configuration data for
913.Nm sshd .
914The file format and configuration options are described in
915.Xr sshd_config 5 .
916.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000917.It Pa /etc/ssh/sshrc
Damien Millerfd725cf2006-03-15 11:35:54 +1100918Similar to
919.Pa ~/.ssh/rc ,
920it can be used to specify
Damien Miller450a7a12000-03-26 13:04:51 +1000921machine-specific login-time initializations globally.
922This file should be writable only by root, and should be world-readable.
Damien Millerd8702e82006-03-15 11:33:56 +1100923.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000924.It Pa /var/empty
Damien Millerd8702e82006-03-15 11:33:56 +1100925.Xr chroot 2
926directory used by
927.Nm
928during privilege separation in the pre-authentication phase.
929The directory should not contain any files and must be owned by root
930and not group or world-writable.
931.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000932.It Pa /var/run/sshd.pid
Damien Millerd8702e82006-03-15 11:33:56 +1100933Contains the process ID of the
934.Nm
935listening for connections (if there are several daemons running
936concurrently for different ports, this contains the process ID of the one
937started last).
938The content of this file is not sensitive; it can be world-readable.
Damien Miller37023962000-07-11 17:31:38 +1000939.El
Damien Miller32aa1441999-10-29 09:15:49 +1000940.Sh SEE ALSO
Damien Miller32aa1441999-10-29 09:15:49 +1000941.Xr scp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100942.Xr sftp 1 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000943.Xr ssh 1 ,
944.Xr ssh-add 1 ,
945.Xr ssh-agent 1 ,
946.Xr ssh-keygen 1 ,
Darren Tucker04354b92007-03-21 20:46:54 +1100947.Xr ssh-keyscan 1 ,
Darren Tucker1f203942003-10-15 15:50:42 +1000948.Xr chroot 2 ,
949.Xr hosts_access 5 ,
Ben Lindstromc8e29ce2001-08-06 20:55:28 +0000950.Xr login.conf 5 ,
951.Xr moduli 5 ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000952.Xr sshd_config 5 ,
Darren Tucker1f203942003-10-15 15:50:42 +1000953.Xr inetd 8 ,
Ben Lindstromd2bf0d62001-06-25 04:10:54 +0000954.Xr sftp-server 8
Damien Millerf1ce5052003-06-11 22:04:39 +1000955.Sh AUTHORS
956OpenSSH is a derivative of the original and free
957ssh 1.2.12 release by Tatu Ylonen.
958Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
959Theo de Raadt and Dug Song
960removed many bugs, re-added newer features and
961created OpenSSH.
962Markus Friedl contributed the support for SSH
963protocol versions 1.5 and 2.0.
964Niels Provos and Markus Friedl contributed support
965for privilege separation.
Damien Millerc47d7e92006-03-15 11:27:20 +1100966.Sh CAVEATS
967System security is not improved unless
968.Nm rshd ,
969.Nm rlogind ,
970and
971.Nm rexecd
972are disabled (thus completely disabling
973.Xr rlogin
974and
975.Xr rsh
976into the machine).