blob: 213b5fc4315ae678d8998f5193d5182f1bb20ffe [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.\"
djm@openbsd.org933935c2015-07-03 03:49:45 +000036.\" $OpenBSD: sshd.8,v 1.280 2015/07/03 03:49:45 djm Exp $
37.Dd $Mdocdate: July 3 2015 $
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 Miller03d4d7e2013-04-23 15:21:06 +100050.Op Fl E Ar log_file
Damien Miller32aa1441999-10-29 09:15:49 +100051.Op Fl f Ar config_file
52.Op Fl g Ar login_grace_time
53.Op Fl h Ar host_key_file
54.Op Fl k Ar key_gen_time
Ben Lindstromade03f62001-12-06 18:22:17 +000055.Op Fl o Ar option
Damien Miller32aa1441999-10-29 09:15:49 +100056.Op Fl p Ar port
Damien Miller942da032000-08-18 13:59:06 +100057.Op Fl u Ar len
Damien Millerffadc582003-02-24 11:52:26 +110058.Ek
Damien Miller22c77262000-04-13 12:26:34 +100059.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +100060.Nm
Damien Miller99cc4a82006-01-31 21:45:53 +110061(OpenSSH Daemon) is the daemon program for
Damien Miller32aa1441999-10-29 09:15:49 +100062.Xr ssh 1 .
Damien Miller69cb24b2014-04-20 13:29:06 +100063Together these programs replace rlogin and rsh,
Darren Tucker04354b92007-03-21 20:46:54 +110064and provide secure encrypted communications between two untrusted hosts
Damien Miller450a7a12000-03-26 13:04:51 +100065over an insecure network.
Damien Miller32aa1441999-10-29 09:15:49 +100066.Pp
67.Nm
Damien Miller99cc4a82006-01-31 21:45:53 +110068listens for connections from clients.
Damien Miller22c77262000-04-13 12:26:34 +100069It is normally started at boot from
Damien Miller32aa1441999-10-29 09:15:49 +100070.Pa /etc/rc .
71It forks a new
Damien Miller450a7a12000-03-26 13:04:51 +100072daemon for each incoming connection.
73The forked daemons handle
Damien Miller32aa1441999-10-29 09:15:49 +100074key exchange, encryption, authentication, command execution,
75and data exchange.
Damien Miller32aa1441999-10-29 09:15:49 +100076.Pp
77.Nm
Darren Tucker1f203942003-10-15 15:50:42 +100078can be configured using command-line options or a configuration file
79(by default
Damien Miller99cc4a82006-01-31 21:45:53 +110080.Xr sshd_config 5 ) ;
81command-line options override values specified in the
Damien Miller32aa1441999-10-29 09:15:49 +100082configuration file.
Damien Miller6162d121999-11-21 13:23:52 +110083.Nm
84rereads its configuration file when it receives a hangup signal,
Ben Lindstrom49a098d2001-03-05 06:55:18 +000085.Dv SIGHUP ,
Damien Miller208f1ed2006-03-15 11:56:03 +110086by executing itself with the name and options it was started with, e.g.\&
Ben Lindstrom49a098d2001-03-05 06:55:18 +000087.Pa /usr/sbin/sshd .
Damien Miller6162d121999-11-21 13:23:52 +110088.Pp
Damien Miller32aa1441999-10-29 09:15:49 +100089The options are as follows:
90.Bl -tag -width Ds
Darren Tucker1f203942003-10-15 15:50:42 +100091.It Fl 4
92Forces
93.Nm
94to use IPv4 addresses only.
95.It Fl 6
96Forces
97.Nm
98to use IPv6 addresses only.
Damien Miller32aa1441999-10-29 09:15:49 +100099.It Fl b Ar bits
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000100Specifies the number of bits in the ephemeral protocol version 1
Darren Tucker7499b0c2008-07-02 22:35:43 +1000101server key (default 1024).
Darren Tuckere7f3f752008-06-10 23:06:01 +1000102.It Fl C Ar connection_spec
103Specify the connection parameters to use for the
104.Fl T
105extended test mode.
106If provided, any
107.Cm Match
108directives in the configuration file
109that would apply to the specified user, host, and address will be set before
110the configuration is written to standard output.
111The connection parameters are supplied as keyword=value pairs.
112The keywords are
113.Dq user ,
114.Dq host ,
Darren Tuckerfbcf8272012-05-19 19:37:01 +1000115.Dq laddr ,
116.Dq lport ,
Darren Tuckere7f3f752008-06-10 23:06:01 +1000117and
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.
Damien Miller03d4d7e2013-04-23 15:21:06 +1000147.It Fl E Ar log_file
148Append debug logs to
149.Ar log_file
150instead of the system log.
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000151.It Fl e
Damien Miller69010322013-04-23 15:21:24 +1000152Write debug logs to standard error instead of the system log.
Darren Tucker04354b92007-03-21 20:46:54 +1100153.It Fl f Ar config_file
Damien Miller450a7a12000-03-26 13:04:51 +1000154Specifies the name of the configuration file.
155The default is
Damien Miller05eda432002-02-10 18:32:28 +1100156.Pa /etc/ssh/sshd_config .
Damien Miller32aa1441999-10-29 09:15:49 +1000157.Nm
158refuses to start if there is no configuration file.
159.It Fl g Ar login_grace_time
160Gives the grace time for clients to authenticate themselves (default
Damien Millerc1348632002-09-05 14:35:14 +1000161120 seconds).
Damien Miller450a7a12000-03-26 13:04:51 +1000162If the client fails to authenticate the user within
163this many seconds, the server disconnects and exits.
164A value of zero indicates no limit.
Damien Miller32aa1441999-10-29 09:15:49 +1000165.It Fl h Ar host_key_file
Damien Miller7fc23732002-01-22 23:19:11 +1100166Specifies a file from which a host key is read.
Damien Miller32aa1441999-10-29 09:15:49 +1000167This option must be given if
168.Nm
169is not run as root (as the normal
Damien Miller7fc23732002-01-22 23:19:11 +1100170host key files are normally not readable by anyone but root).
171The default is
Damien Miller05eda432002-02-10 18:32:28 +1100172.Pa /etc/ssh/ssh_host_key
Damien Miller7fc23732002-01-22 23:19:11 +1100173for protocol version 1, and
Damien Millereb8b60e2010-08-31 22:41:14 +1000174.Pa /etc/ssh/ssh_host_dsa_key ,
Damien Miller8ba0ead2013-12-18 17:46:27 +1100175.Pa /etc/ssh/ssh_host_ecdsa_key .
176.Pa /etc/ssh/ssh_host_ed25519_key
Damien Miller7fc23732002-01-22 23:19:11 +1100177and
Damien Millereb8b60e2010-08-31 22:41:14 +1000178.Pa /etc/ssh/ssh_host_rsa_key
Damien Miller7fc23732002-01-22 23:19:11 +1100179for protocol version 2.
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000180It is possible to have multiple host key files for
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000181the different protocol versions and host key algorithms.
Damien Miller32aa1441999-10-29 09:15:49 +1000182.It Fl i
183Specifies that
184.Nm
Damien Millerffadc582003-02-24 11:52:26 +1100185is being run from
186.Xr inetd 8 .
djm@openbsd.org933935c2015-07-03 03:49:45 +0000187If SSH protocol 1 is enabled,
Damien Miller32aa1441999-10-29 09:15:49 +1000188.Nm
djm@openbsd.org933935c2015-07-03 03:49:45 +0000189should not normally be run
Damien Miller32aa1441999-10-29 09:15:49 +1000190from inetd because it needs to generate the server key before it can
djm@openbsd.org933935c2015-07-03 03:49:45 +0000191respond to the client, and this may take some time.
192Clients may have to wait too long if the key was regenerated every time.
Damien Miller32aa1441999-10-29 09:15:49 +1000193.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 .
sobrado@openbsd.orgf70b22b2014-08-30 15:33:50 +0000278Protocol 2 supports DSA, ECDSA, Ed25519 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,
djm@openbsd.org933935c2015-07-03 03:49:45 +0000287normally 1024 bits,
Damien Miller8bbdf902006-02-01 22:05:25 +1100288generated 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
Darren Tucker427e4092012-10-05 11:02:39 +1000317(hmac-md5, hmac-sha1, umac-64, umac-128, hmac-ripemd160,
Damien Miller20bd4532011-08-06 06:17:30 +1000318hmac-sha2-256 or hmac-sha2-512).
Damien Miller8bbdf902006-02-01 22:05:25 +1100319.Pp
320Finally, the server and the client enter an authentication dialog.
Damien Miller99cc4a82006-01-31 21:45:53 +1100321The client tries to authenticate itself using
Damien Miller8bbdf902006-02-01 22:05:25 +1100322host-based authentication,
323public key authentication,
324challenge-response authentication,
325or password authentication.
Damien Miller99cc4a82006-01-31 21:45:53 +1100326.Pp
327Regardless of the authentication type, the account is checked to
328ensure that it is accessible. An account is not accessible if it is
329locked, listed in
330.Cm DenyUsers
331or its group is listed in
332.Cm DenyGroups
333\&. The definition of a locked account is system dependant. Some platforms
334have their own account database (eg AIX) and some modify the passwd field (
335.Ql \&*LK\&*
336on Solaris and UnixWare,
337.Ql \&*
338on HP-UX, containing
339.Ql Nologin
340on Tru64,
341a leading
342.Ql \&*LOCKED\&*
343on FreeBSD and a leading
Darren Tucker1a9176b2007-08-17 09:42:32 +1000344.Ql \&!
345on most Linuxes).
346If there is a requirement to disable password authentication
Damien Miller99cc4a82006-01-31 21:45:53 +1100347for the account while allowing still public-key, then the passwd field
348should be set to something other than these values (eg
349.Ql NP
350or
351.Ql \&*NP\&*
352).
353.Pp
Damien Miller99cc4a82006-01-31 21:45:53 +1100354If the client successfully authenticates itself, a dialog for
355preparing the session is entered.
356At this time the client may request
357things like allocating a pseudo-tty, forwarding X11 connections,
358forwarding TCP connections, or forwarding the authentication agent
359connection over the secure channel.
360.Pp
Damien Millerc47d7e92006-03-15 11:27:20 +1100361After this, the client either requests a shell or execution of a command.
Damien Miller99cc4a82006-01-31 21:45:53 +1100362The sides then enter session mode.
363In this mode, either side may send
364data at any time, and such data is forwarded to/from the shell or
365command on the server side, and the user terminal in the client side.
366.Pp
367When the user program terminates and all forwarded X11 and other
368connections have been closed, the server sends command exit status to
369the client, and both sides exit.
Damien Miller32aa1441999-10-29 09:15:49 +1000370.Sh LOGIN PROCESS
371When a user successfully logs in,
372.Nm
373does the following:
374.Bl -enum -offset indent
375.It
376If the login is on a tty, and no command has been specified,
Damien Miller22c77262000-04-13 12:26:34 +1000377prints last login time and
Damien Miller32aa1441999-10-29 09:15:49 +1000378.Pa /etc/motd
379(unless prevented in the configuration file or by
Damien Miller167ea5d2005-05-26 12:04:02 +1000380.Pa ~/.hushlogin ;
Damien Miller32aa1441999-10-29 09:15:49 +1000381see the
Damien Miller22c77262000-04-13 12:26:34 +1000382.Sx FILES
Damien Miller32aa1441999-10-29 09:15:49 +1000383section).
384.It
385If the login is on a tty, records login time.
386.It
387Checks
388.Pa /etc/nologin ;
389if it exists, prints contents and quits
390(unless root).
391.It
392Changes to run with normal user privileges.
393.It
394Sets up basic environment.
395.It
Darren Tucker1f203942003-10-15 15:50:42 +1000396Reads the file
Damien Miller167ea5d2005-05-26 12:04:02 +1000397.Pa ~/.ssh/environment ,
Darren Tucker1f203942003-10-15 15:50:42 +1000398if it exists, and users are allowed to change their environment.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000399See the
Ben Lindstromdc7adf22002-08-20 18:38:02 +0000400.Cm PermitUserEnvironment
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000401option in
Ben Lindstromdc7adf22002-08-20 18:38:02 +0000402.Xr sshd_config 5 .
Damien Miller32aa1441999-10-29 09:15:49 +1000403.It
404Changes to user's home directory.
405.It
406If
Damien Miller167ea5d2005-05-26 12:04:02 +1000407.Pa ~/.ssh/rc
Damien Miller72e6b5c2014-07-04 09:00:04 +1000408exists and the
409.Xr sshd_config 5
410.Cm PermitUserRC
411option is set, runs it; else if
Damien Millerafcc2252002-02-10 18:32:55 +1100412.Pa /etc/ssh/sshrc
Damien Miller32aa1441999-10-29 09:15:49 +1000413exists, runs
Damien Miller450a7a12000-03-26 13:04:51 +1000414it; otherwise runs xauth.
415The
Damien Miller32aa1441999-10-29 09:15:49 +1000416.Dq rc
417files are given the X11
418authentication protocol and cookie in standard input.
Damien Millerfd725cf2006-03-15 11:35:54 +1100419See
420.Sx SSHRC ,
421below.
Damien Miller32aa1441999-10-29 09:15:49 +1000422.It
423Runs user's shell or command.
djm@openbsd.org8d4d1bf2015-05-01 07:11:47 +0000424All commands are run under the user's login shell as specified in the
425system password database.
Damien Miller32aa1441999-10-29 09:15:49 +1000426.El
Damien Millerfd725cf2006-03-15 11:35:54 +1100427.Sh SSHRC
428If the file
429.Pa ~/.ssh/rc
430exists,
431.Xr sh 1
432runs it after reading the
433environment files but before starting the user's shell or command.
434It must not produce any output on stdout; stderr must be used
435instead.
436If X11 forwarding is in use, it will receive the "proto cookie" pair in
437its standard input (and
438.Ev DISPLAY
439in its environment).
440The script must call
441.Xr xauth 1
442because
443.Nm
444will not run xauth automatically to add X11 cookies.
445.Pp
446The primary purpose of this file is to run any initialization routines
447which may be needed before the user's home directory becomes
448accessible; AFS is a particular example of such an environment.
449.Pp
450This file will probably contain some initialization code followed by
451something similar to:
452.Bd -literal -offset 3n
453if read proto cookie && [ -n "$DISPLAY" ]; then
454 if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
455 # X11UseLocalhost=yes
456 echo add unix:`echo $DISPLAY |
457 cut -c11-` $proto $cookie
458 else
459 # X11UseLocalhost=no
460 echo add $DISPLAY $proto $cookie
461 fi | xauth -q -
462fi
463.Ed
464.Pp
465If this file does not exist,
466.Pa /etc/ssh/sshrc
467is run, and if that
468does not exist either, xauth is used to add the cookie.
Damien Miller32aa1441999-10-29 09:15:49 +1000469.Sh AUTHORIZED_KEYS FILE FORMAT
Ben Lindstromf96704d2001-06-25 04:17:12 +0000470.Cm AuthorizedKeysFile
Damien Millerb9132fc2011-05-29 21:41:40 +1000471specifies the files containing public keys for
Damien Millerdcfea272006-03-15 11:31:22 +1100472public key authentication;
Damien Millerb9132fc2011-05-29 21:41:40 +1000473if none is specified, the default is
Damien Millerd8478b62011-05-29 21:39:36 +1000474.Pa ~/.ssh/authorized_keys
475and
476.Pa ~/.ssh/authorized_keys2 .
Damien Miller450a7a12000-03-26 13:04:51 +1000477Each line of the file contains one
Damien Miller32aa1441999-10-29 09:15:49 +1000478key (empty lines and lines starting with a
479.Ql #
480are ignored as
Damien Miller450a7a12000-03-26 13:04:51 +1000481comments).
Damien Millerdcfea272006-03-15 11:31:22 +1100482Protocol 1 public keys consist of the following space-separated fields:
483options, bits, exponent, modulus, comment.
484Protocol 2 public key consist of:
485options, keytype, base64-encoded key, comment.
486The options field is optional;
487its presence is determined by whether the line starts
Damien Millerb83df8d2002-09-04 16:24:55 +1000488with a number or not (the options field never starts with a number).
Damien Millerdcfea272006-03-15 11:31:22 +1100489The bits, exponent, modulus, and comment fields give the RSA key for
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000490protocol version 1; the
Damien Miller32aa1441999-10-29 09:15:49 +1000491comment field is not used for anything (but may be convenient for the
492user to identify the key).
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000493For protocol version 2 the keytype is
Damien Millereb8b60e2010-08-31 22:41:14 +1000494.Dq ecdsa-sha2-nistp256 ,
495.Dq ecdsa-sha2-nistp384 ,
496.Dq ecdsa-sha2-nistp521 ,
Damien Millera7827c12013-12-07 11:24:30 +1100497.Dq ssh-ed25519 ,
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000498.Dq ssh-dss
499or
500.Dq ssh-rsa .
Damien Miller32aa1441999-10-29 09:15:49 +1000501.Pp
502Note that lines in this file are usually several hundred bytes long
Darren Tucker22cc7412004-12-06 22:47:41 +1100503(because of the size of the public key encoding) up to a limit of
5048 kilobytes, which permits DSA keys up to 8 kilobits and RSA
505keys up to 16 kilobits.
Damien Miller450a7a12000-03-26 13:04:51 +1000506You don't want to type them in; instead, copy the
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000507.Pa identity.pub ,
Damien Millerdcfea272006-03-15 11:31:22 +1100508.Pa id_dsa.pub ,
Damien Millereb8b60e2010-08-31 22:41:14 +1000509.Pa id_ecdsa.pub ,
Damien Miller8ba0ead2013-12-18 17:46:27 +1100510.Pa id_ed25519.pub ,
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000511or the
512.Pa id_rsa.pub
Damien Miller32aa1441999-10-29 09:15:49 +1000513file and edit it.
514.Pp
Ben Lindstrom0d0be022002-04-02 20:39:29 +0000515.Nm
516enforces a minimum RSA key modulus size for protocol 1
517and protocol 2 keys of 768 bits.
518.Pp
Damien Miller942da032000-08-18 13:59:06 +1000519The options (if present) consist of comma-separated option
Damien Miller450a7a12000-03-26 13:04:51 +1000520specifications.
521No spaces are permitted, except within double quotes.
Ben Lindstrom1c0fd092001-09-12 16:36:17 +0000522The following option specifications are supported (note
523that option keywords are case-insensitive):
Damien Miller32aa1441999-10-29 09:15:49 +1000524.Bl -tag -width Ds
Damien Millercd38c9c2010-03-04 21:51:37 +1100525.It Cm cert-authority
Damien Miller0a80ca12010-02-27 07:55:05 +1100526Specifies that the listed key is a certification authority (CA) that is
527trusted to validate signed certificates for user authentication.
528.Pp
529Certificates may encode access restrictions similar to these key options.
530If both certificate restrictions and key options are present, the most
531restrictive union of the two is applied.
Damien Miller32aa1441999-10-29 09:15:49 +1000532.It Cm command="command"
533Specifies that the command is executed whenever this key is used for
Damien Miller450a7a12000-03-26 13:04:51 +1000534authentication.
535The command supplied by the user (if any) is ignored.
Ben Lindstrom23124ea2001-09-14 23:14:25 +0000536The command is run on a pty if the client requests a pty;
Damien Miller450a7a12000-03-26 13:04:51 +1000537otherwise it is run without a tty.
Damien Millerffadc582003-02-24 11:52:26 +1100538If an 8-bit clean channel is required,
Ben Lindstrom594e2032001-09-12 18:35:30 +0000539one must not request a pty or should specify
Damien Miller33804262001-02-04 23:20:18 +1100540.Cm no-pty .
Damien Miller450a7a12000-03-26 13:04:51 +1000541A quote may be included in the command by quoting it with a backslash.
542This option might be useful
Damien Millerb83df8d2002-09-04 16:24:55 +1000543to restrict certain public keys to perform just a specific operation.
Damien Miller450a7a12000-03-26 13:04:51 +1000544An example might be a key that permits remote backups but nothing else.
Damien Miller7c24b812006-01-14 10:09:56 +1100545Note that the client may specify TCP and/or X11
Damien Miller30c3d422000-05-09 11:02:59 +1000546forwarding unless they are explicitly prohibited.
Damien Millere2754432006-07-24 14:06:47 +1000547The command originally supplied by the client is available in the
548.Ev SSH_ORIGINAL_COMMAND
549environment variable.
Ben Lindstrom20daef72001-09-20 00:54:01 +0000550Note that this option applies to shell, command or subsystem execution.
Damien Miller0a80ca12010-02-27 07:55:05 +1100551Also note that this command may be superseded by either a
552.Xr sshd_config 5
553.Cm ForceCommand
554directive or a command embedded in a certificate.
Damien Miller32aa1441999-10-29 09:15:49 +1000555.It Cm environment="NAME=value"
556Specifies that the string is to be added to the environment when
Damien Miller450a7a12000-03-26 13:04:51 +1000557logging in using this key.
558Environment variables set this way
559override other default environment values.
560Multiple options of this type are permitted.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000561Environment processing is disabled by default and is
562controlled via the
563.Cm PermitUserEnvironment
564option.
Ben Lindstrom38b951c2001-12-06 17:47:47 +0000565This option is automatically disabled if
566.Cm UseLogin
567is enabled.
Damien Miller31bdc522006-03-15 11:31:44 +1100568.It Cm from="pattern-list"
Darren Tucker896ad5a2008-06-11 09:34:46 +1000569Specifies that in addition to public key authentication, either the canonical
Darren Tucker11996732008-06-13 04:32:00 +1000570name of the remote host or its IP address must be present in the
Darren Tucker896ad5a2008-06-11 09:34:46 +1000571comma-separated list of patterns.
Damien Millerfecfd112013-07-18 16:11:50 +1000572See PATTERNS in
Damien Millerc7d5b5e2006-03-15 11:55:08 +1100573.Xr ssh_config 5
574for more information on patterns.
Darren Tucker896ad5a2008-06-11 09:34:46 +1000575.Pp
576In addition to the wildcard matching that may be applied to hostnames or
577addresses, a
578.Cm from
Darren Tucker5837b512009-06-21 17:52:27 +1000579stanza may match IP addresses using CIDR address/masklen notation.
Darren Tucker896ad5a2008-06-11 09:34:46 +1000580.Pp
581The purpose of this option is to optionally increase security: public key
582authentication by itself does not trust the network or name servers or
583anything (but the key); however, if somebody somehow steals the key, the key
584permits an intruder to log in from anywhere in the world.
585This additional option makes using a stolen key more difficult (name
586servers and/or routers would have to be compromised in addition to
587just the key).
Damien Miller31bdc522006-03-15 11:31:44 +1100588.It Cm no-agent-forwarding
589Forbids authentication agent forwarding when this key is used for
590authentication.
Damien Miller32aa1441999-10-29 09:15:49 +1000591.It Cm no-port-forwarding
Damien Miller7c24b812006-01-14 10:09:56 +1100592Forbids TCP forwarding when this key is used for authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000593Any port forward requests by the client will return an error.
Damien Miller208f1ed2006-03-15 11:56:03 +1100594This might be used, e.g. in connection with the
Damien Miller32aa1441999-10-29 09:15:49 +1000595.Cm command
596option.
Damien Miller31bdc522006-03-15 11:31:44 +1100597.It Cm no-pty
598Prevents tty allocation (a request to allocate a pty will fail).
Damien Miller95e80952008-03-27 11:03:05 +1100599.It Cm no-user-rc
Damien Miller13ba9c22008-04-03 20:52:51 +1100600Disables execution of
Damien Miller95e80952008-03-27 11:03:05 +1100601.Pa ~/.ssh/rc .
Damien Miller32aa1441999-10-29 09:15:49 +1000602.It Cm no-X11-forwarding
603Forbids X11 forwarding when this key is used for authentication.
604Any X11 forward requests by the client will return an error.
Damien Millera243fde2001-03-19 23:16:08 +1100605.It Cm permitopen="host:port"
bentley@openbsd.orgda8af832014-11-15 14:41:03 +0000606Limit local port forwarding with
607.Xr ssh 1
608.Fl L
609such that it may only connect to the specified host and port.
Damien Miller7fa96602010-08-05 13:03:13 +1000610IPv6 addresses can be specified by enclosing the address in square brackets.
Ben Lindstromd71ba572001-09-12 18:03:31 +0000611Multiple
Damien Millera243fde2001-03-19 23:16:08 +1100612.Cm permitopen
Damien Millerfbf486b2003-05-23 18:44:23 +1000613options may be applied separated by commas.
614No pattern matching is performed on the specified hostnames,
615they must be literal domains or addresses.
Darren Tucker1338b9e2011-10-02 18:57:35 +1100616A port specification of
617.Cm *
618matches any port.
Damien Miller30da3442010-05-10 11:58:03 +1000619.It Cm principals="principals"
620On a
621.Cm cert-authority
622line, specifies allowed principals for certificate authentication as a
623comma-separated list.
624At least one name from the list must appear in the certificate's
625list of principals for the certificate to be accepted.
626This option is ignored for keys that are not marked as trusted certificate
627signers using the
628.Cm cert-authority
629option.
Damien Millerd27b9472005-12-13 19:29:02 +1100630.It Cm tunnel="n"
631Force a
632.Xr tun 4
633device on the server.
634Without this option, the next available device will be used if
635the client requests a tunnel.
Damien Miller32aa1441999-10-29 09:15:49 +1000636.El
Damien Miller32aa1441999-10-29 09:15:49 +1000637.Pp
Damien Miller7d2ef022006-03-15 11:32:06 +1100638An example authorized_keys file:
Damien Millerc8f61cf2006-03-15 11:33:25 +1100639.Bd -literal -offset 3n
Damien Miller7d2ef022006-03-15 11:32:06 +1100640# Comments allowed at start of line
641ssh-rsa AAAAB3Nza...LiPk== user@example.net
Damien Millerc8f61cf2006-03-15 11:33:25 +1100642from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
643AAAAB2...19Q== john@example.net
644command="dump /home",no-pty,no-port-forwarding ssh-dss
645AAAAC3...51R== example.net
646permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
647AAAAB5...21S==
648tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
649jane@example.net
Damien Miller7d2ef022006-03-15 11:32:06 +1100650.Ed
Damien Miller32aa1441999-10-29 09:15:49 +1000651.Sh SSH_KNOWN_HOSTS FILE FORMAT
Damien Miller22c77262000-04-13 12:26:34 +1000652The
Damien Millerffadc582003-02-24 11:52:26 +1100653.Pa /etc/ssh/ssh_known_hosts
Damien Miller22c77262000-04-13 12:26:34 +1000654and
Damien Miller167ea5d2005-05-26 12:04:02 +1000655.Pa ~/.ssh/known_hosts
Damien Miller450a7a12000-03-26 13:04:51 +1000656files contain host public keys for all known hosts.
657The global file should
658be prepared by the administrator (optional), and the per-user file is
Damien Miller9a7f2012006-03-15 11:32:42 +1100659maintained automatically: whenever the user connects from an unknown host,
Damien Miller450a7a12000-03-26 13:04:51 +1000660its key is added to the per-user file.
Damien Miller32aa1441999-10-29 09:15:49 +1000661.Pp
Damien Millera7dab8b2010-03-05 10:42:05 +1100662Each line in these files contains the following fields: markers (optional),
663hostnames, bits, exponent, modulus, comment.
Damien Miller450a7a12000-03-26 13:04:51 +1000664The fields are separated by spaces.
Damien Miller32aa1441999-10-29 09:15:49 +1000665.Pp
Damien Millera7dab8b2010-03-05 10:42:05 +1100666The marker is optional, but if it is present then it must be one of
667.Dq @cert-authority ,
668to indicate that the line contains a certification authority (CA) key,
669or
670.Dq @revoked ,
671to indicate that the key contained on the line is revoked and must not ever
672be accepted.
673Only one marker should be used on a key line.
674.Pp
Damien Miller31554322003-05-14 13:44:58 +1000675Hostnames is a comma-separated list of patterns
Damien Miller9a7f2012006-03-15 11:32:42 +1100676.Pf ( Ql *
Damien Millerfbf486b2003-05-23 18:44:23 +1000677and
678.Ql \&?
Damien Miller049245d2003-05-14 13:44:42 +1000679act as
Damien Miller32aa1441999-10-29 09:15:49 +1000680wildcards); each pattern in turn is matched against the canonical host
681name (when authenticating a client) or against the user-supplied
Damien Miller450a7a12000-03-26 13:04:51 +1000682name (when authenticating a server).
683A pattern may also be preceded by
Damien Miller049245d2003-05-14 13:44:42 +1000684.Ql \&!
Damien Miller32aa1441999-10-29 09:15:49 +1000685to indicate negation: if the host name matches a negated
686pattern, it is not accepted (by that line) even if it matched another
687pattern on the line.
Darren Tuckerda345532006-07-10 23:04:19 +1000688A hostname or address may optionally be enclosed within
689.Ql \&[
690and
691.Ql \&]
692brackets then followed by
693.Ql \&:
Darren Tucker11318472006-07-12 22:07:59 +1000694and a non-standard port number.
Damien Miller32aa1441999-10-29 09:15:49 +1000695.Pp
Damien Millere1776152005-03-01 21:47:37 +1100696Alternately, hostnames may be stored in a hashed form which hides host names
Damien Miller718fd4b2005-03-02 12:03:23 +1100697and addresses should the file's contents be disclosed.
698Hashed hostnames start with a
699.Ql |
Damien Millere1776152005-03-01 21:47:37 +1100700character.
701Only one hashed hostname may appear on a single line and none of the above
702negation or wildcard operators may be applied.
703.Pp
Damien Millere247cc42000-05-07 12:03:14 +1000704Bits, exponent, and modulus are taken directly from the RSA host key; they
Damien Miller9a7f2012006-03-15 11:32:42 +1100705can be obtained, for example, from
Damien Miller05eda432002-02-10 18:32:28 +1100706.Pa /etc/ssh/ssh_host_key.pub .
Damien Miller32aa1441999-10-29 09:15:49 +1000707The optional comment field continues to the end of the line, and is not used.
708.Pp
709Lines starting with
710.Ql #
711and empty lines are ignored as comments.
712.Pp
713When performing host authentication, authentication is accepted if any
Damien Millera7dab8b2010-03-05 10:42:05 +1100714matching line has the proper key; either one that matches exactly or,
715if the server has presented a certificate for authentication, the key
716of the certification authority that signed the certificate.
717For a key to be trusted as a certification authority, it must use the
718.Dq @cert-authority
719marker described above.
720.Pp
721The known hosts file also provides a facility to mark keys as revoked,
722for example when it is known that the associated private key has been
723stolen.
724Revoked keys are specified by including the
725.Dq @revoked
726marker at the beginning of the key line, and are never accepted for
727authentication or as certification authorities, but instead will
728produce a warning from
729.Xr ssh 1
730when they are encountered.
731.Pp
732It is permissible (but not
Damien Miller32aa1441999-10-29 09:15:49 +1000733recommended) to have several lines or different host keys for the same
Damien Miller450a7a12000-03-26 13:04:51 +1000734names.
735This will inevitably happen when short forms of host names
736from different domains are put in the file.
737It is possible
Damien Miller32aa1441999-10-29 09:15:49 +1000738that the files contain conflicting information; authentication is
739accepted if valid information can be found from either file.
740.Pp
741Note that the lines in these files are typically hundreds of characters
742long, and you definitely don't want to type in the host keys by hand.
Damien Millera7dab8b2010-03-05 10:42:05 +1100743Rather, generate them by a script,
744.Xr ssh-keyscan 1
Damien Miller22c77262000-04-13 12:26:34 +1000745or by taking
Damien Miller05eda432002-02-10 18:32:28 +1100746.Pa /etc/ssh/ssh_host_key.pub
Damien Miller32aa1441999-10-29 09:15:49 +1000747and adding the host names at the front.
Damien Millera7dab8b2010-03-05 10:42:05 +1100748.Xr ssh-keygen 1
Damien Miller98339052010-03-05 21:30:35 +1100749also offers some basic automated editing for
Damien Millera7dab8b2010-03-05 10:42:05 +1100750.Pa ~/.ssh/known_hosts
751including removing hosts matching a host name and converting all host
752names to their hashed representations.
Damien Millercc00f5e2006-03-15 11:33:00 +1100753.Pp
754An example ssh_known_hosts file:
755.Bd -literal -offset 3n
756# Comments allowed at start of line
757closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
758cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
Damien Millere1776152005-03-01 21:47:37 +1100759# A hashed hostname
760|1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
761AAAA1234.....=
Damien Millera7dab8b2010-03-05 10:42:05 +1100762# A revoked key
763@revoked * ssh-rsa AAAAB5W...
764# A CA key, accepted for any host in *.mydomain.com or *.mydomain.org
765@cert-authority *.mydomain.org,*.mydomain.com ssh-rsa AAAAB5W...
Damien Millere1776152005-03-01 21:47:37 +1100766.Ed
Damien Miller32aa1441999-10-29 09:15:49 +1000767.Sh FILES
Damien Millerd8702e82006-03-15 11:33:56 +1100768.Bl -tag -width Ds -compact
Damien Millerafdae612010-08-31 22:31:14 +1000769.It Pa ~/.hushlogin
Damien Miller70a908e2005-03-01 21:17:09 +1100770This file is used to suppress printing the last login time and
771.Pa /etc/motd ,
772if
773.Cm PrintLastLog
774and
775.Cm PrintMotd ,
776respectively,
777are enabled.
778It does not suppress printing of the banner specified by
779.Cm Banner .
Damien Millerd8702e82006-03-15 11:33:56 +1100780.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000781.It Pa ~/.rhosts
Damien Milleradc35b92006-03-15 11:35:27 +1100782This file is used for host-based authentication (see
783.Xr ssh 1
784for more information).
785On some machines this file may need to be
786world-readable if the user's home directory is on an NFS partition,
787because
788.Nm
789reads it as root.
790Additionally, this file must be owned by the user,
791and must not have write permissions for anyone else.
792The recommended
793permission for most machines is read/write for the user, and not
Damien Miller32aa1441999-10-29 09:15:49 +1000794accessible by others.
795.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000796.It Pa ~/.shosts
Damien Milleradc35b92006-03-15 11:35:27 +1100797This file is used in exactly the same way as
798.Pa .rhosts ,
799but allows host-based authentication without permitting login with
800rlogin/rsh.
Damien Miller32aa1441999-10-29 09:15:49 +1000801.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000802.It Pa ~/.ssh/
Damien Miller520e6152008-02-10 22:46:22 +1100803This directory is the default location for all user-specific configuration
804and authentication information.
805There is no general requirement to keep the entire contents of this directory
806secret, but the recommended permissions are read/write/execute for the user,
807and not accessible by others.
808.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000809.It Pa ~/.ssh/authorized_keys
sobrado@openbsd.orgf70b22b2014-08-30 15:33:50 +0000810Lists the public keys (DSA, ECDSA, Ed25519, RSA)
Damien Miller8ba0ead2013-12-18 17:46:27 +1100811that can be used for logging in as this user.
Damien Millerd8702e82006-03-15 11:33:56 +1100812The format of this file is described above.
Damien Miller5d43d492006-08-30 11:07:00 +1000813The content of the file is not highly sensitive, but the recommended
Damien Milleradc35b92006-03-15 11:35:27 +1100814permissions are read/write for the user, and not accessible by others.
Damien Miller32aa1441999-10-29 09:15:49 +1000815.Pp
Damien Miller5d43d492006-08-30 11:07:00 +1000816If this file, the
817.Pa ~/.ssh
818directory, or the user's home directory are writable
819by other users, then the file could be modified or replaced by unauthorized
820users.
821In this case,
822.Nm
823will not allow it to be used unless the
824.Cm StrictModes
825option has been set to
826.Dq no .
Damien Miller5d43d492006-08-30 11:07:00 +1000827.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000828.It Pa ~/.ssh/environment
Damien Miller450a7a12000-03-26 13:04:51 +1000829This file is read into the environment at login (if it exists).
830It can only contain empty lines, comment lines (that start with
Damien Miller32aa1441999-10-29 09:15:49 +1000831.Ql # ) ,
Damien Miller450a7a12000-03-26 13:04:51 +1000832and assignment lines of the form name=value.
833The file should be writable
Damien Miller32aa1441999-10-29 09:15:49 +1000834only by the user; it need not be readable by anyone else.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000835Environment processing is disabled by default and is
836controlled via the
837.Cm PermitUserEnvironment
838option.
Damien Millerd8702e82006-03-15 11:33:56 +1100839.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000840.It Pa ~/.ssh/known_hosts
Damien Milleradc35b92006-03-15 11:35:27 +1100841Contains a list of host keys for all hosts the user has logged into
842that are not already in the systemwide list of known host keys.
843The format of this file is described above.
844This file should be writable only by root/the owner and
Damien Millerd8702e82006-03-15 11:33:56 +1100845can, but need not be, world-readable.
846.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000847.It Pa ~/.ssh/rc
Damien Millerfd725cf2006-03-15 11:35:54 +1100848Contains initialization routines to be run before
849the user's home directory becomes accessible.
Damien Miller32aa1441999-10-29 09:15:49 +1000850This file should be writable only by the user, and need not be
851readable by anyone else.
Damien Millerd8702e82006-03-15 11:33:56 +1100852.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000853.It Pa /etc/hosts.equiv
Damien Miller445121f2006-03-15 11:36:18 +1100854This file is for host-based authentication (see
855.Xr ssh 1 ) .
856It should only be writable by root.
Damien Millerd8702e82006-03-15 11:33:56 +1100857.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000858.It Pa /etc/moduli
Damien Millerd8702e82006-03-15 11:33:56 +1100859Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
860The file format is described in
861.Xr moduli 5 .
862.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000863.It Pa /etc/motd
Damien Millerd8702e82006-03-15 11:33:56 +1100864See
865.Xr motd 5 .
866.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000867.It Pa /etc/nologin
Damien Millerd8702e82006-03-15 11:33:56 +1100868If this file exists,
869.Nm
870refuses to let anyone except root log in.
871The contents of the file
872are displayed to anyone trying to log in, and non-root connections are
873refused.
874The file should be world-readable.
875.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000876.It Pa /etc/shosts.equiv
Damien Miller445121f2006-03-15 11:36:18 +1100877This file is used in exactly the same way as
878.Pa hosts.equiv ,
879but allows host-based authentication without permitting login with
880rlogin/rsh.
Damien Millerd8702e82006-03-15 11:33:56 +1100881.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000882.It Pa /etc/ssh/ssh_host_key
883.It Pa /etc/ssh/ssh_host_dsa_key
Damien Millereb8b60e2010-08-31 22:41:14 +1000884.It Pa /etc/ssh/ssh_host_ecdsa_key
Damien Miller8ba0ead2013-12-18 17:46:27 +1100885.It Pa /etc/ssh/ssh_host_ed25519_key
Damien Millerafdae612010-08-31 22:31:14 +1000886.It Pa /etc/ssh/ssh_host_rsa_key
Damien Millerb9902cf2012-06-20 21:52:58 +1000887These files contain the private parts of the host keys.
Damien Millerd8702e82006-03-15 11:33:56 +1100888These files should only be owned by root, readable only by root, and not
889accessible to others.
890Note that
891.Nm
Damien Milleredd03752006-03-15 11:36:45 +1100892does not start if these files are group/world-accessible.
Damien Millerd8702e82006-03-15 11:33:56 +1100893.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000894.It Pa /etc/ssh/ssh_host_key.pub
895.It Pa /etc/ssh/ssh_host_dsa_key.pub
Damien Millereb8b60e2010-08-31 22:41:14 +1000896.It Pa /etc/ssh/ssh_host_ecdsa_key.pub
Damien Miller8ba0ead2013-12-18 17:46:27 +1100897.It Pa /etc/ssh/ssh_host_ed25519_key.pub
Damien Millerafdae612010-08-31 22:31:14 +1000898.It Pa /etc/ssh/ssh_host_rsa_key.pub
Damien Millerb9902cf2012-06-20 21:52:58 +1000899These files contain the public parts of the host keys.
Damien Millerd8702e82006-03-15 11:33:56 +1100900These files should be world-readable but writable only by
901root.
902Their contents should match the respective private parts.
903These files are not
904really used for anything; they are provided for the convenience of
905the user so their contents can be copied to known hosts files.
906These files are created using
907.Xr ssh-keygen 1 .
908.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000909.It Pa /etc/ssh/ssh_known_hosts
Darren Tucker04354b92007-03-21 20:46:54 +1100910Systemwide list of known host keys.
911This file should be prepared by the
912system administrator to contain the public host keys of all machines in the
913organization.
914The format of this file is described above.
915This file should be writable only by root/the owner and
916should be world-readable.
917.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000918.It Pa /etc/ssh/sshd_config
Damien Millerd8702e82006-03-15 11:33:56 +1100919Contains configuration data for
920.Nm sshd .
921The file format and configuration options are described in
922.Xr sshd_config 5 .
923.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000924.It Pa /etc/ssh/sshrc
Damien Millerfd725cf2006-03-15 11:35:54 +1100925Similar to
926.Pa ~/.ssh/rc ,
927it can be used to specify
Damien Miller450a7a12000-03-26 13:04:51 +1000928machine-specific login-time initializations globally.
929This file should be writable only by root, and should be world-readable.
Damien Millerd8702e82006-03-15 11:33:56 +1100930.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000931.It Pa /var/empty
Damien Millerd8702e82006-03-15 11:33:56 +1100932.Xr chroot 2
933directory used by
934.Nm
935during privilege separation in the pre-authentication phase.
936The directory should not contain any files and must be owned by root
937and not group or world-writable.
938.Pp
Damien Millerafdae612010-08-31 22:31:14 +1000939.It Pa /var/run/sshd.pid
Damien Millerd8702e82006-03-15 11:33:56 +1100940Contains the process ID of the
941.Nm
942listening for connections (if there are several daemons running
943concurrently for different ports, this contains the process ID of the one
944started last).
945The content of this file is not sensitive; it can be world-readable.
Damien Miller37023962000-07-11 17:31:38 +1000946.El
Damien Miller32aa1441999-10-29 09:15:49 +1000947.Sh SEE ALSO
Damien Miller32aa1441999-10-29 09:15:49 +1000948.Xr scp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100949.Xr sftp 1 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000950.Xr ssh 1 ,
951.Xr ssh-add 1 ,
952.Xr ssh-agent 1 ,
953.Xr ssh-keygen 1 ,
Darren Tucker04354b92007-03-21 20:46:54 +1100954.Xr ssh-keyscan 1 ,
Darren Tucker1f203942003-10-15 15:50:42 +1000955.Xr chroot 2 ,
Ben Lindstromc8e29ce2001-08-06 20:55:28 +0000956.Xr login.conf 5 ,
957.Xr moduli 5 ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000958.Xr sshd_config 5 ,
Darren Tucker1f203942003-10-15 15:50:42 +1000959.Xr inetd 8 ,
Ben Lindstromd2bf0d62001-06-25 04:10:54 +0000960.Xr sftp-server 8
Damien Millerf1ce5052003-06-11 22:04:39 +1000961.Sh AUTHORS
962OpenSSH is a derivative of the original and free
963ssh 1.2.12 release by Tatu Ylonen.
964Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
965Theo de Raadt and Dug Song
966removed many bugs, re-added newer features and
967created OpenSSH.
968Markus Friedl contributed the support for SSH
969protocol versions 1.5 and 2.0.
970Niels Provos and Markus Friedl contributed support
971for privilege separation.