blob: aed8b60d12ddec1948a953d3f41ea438a13c169e [file] [log] [blame]
Damien Miller32aa1441999-10-29 09:15:49 +10001.\" -*- nroff -*-
2.\"
Damien Miller32aa1441999-10-29 09:15:49 +10003.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller32aa1441999-10-29 09:15:49 +10004.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
Damien Millere4340be2000-09-16 13:29:08 +11007.\" As far as I am concerned, the code I have written for this software
8.\" can be used freely for any purpose. Any derived versions of this
9.\" software must be clearly marked as such, and if the derived work is
10.\" incompatible with the protocol description in the RFC file, it must be
11.\" called by a name other than "ssh" or "Secure Shell".
Damien Miller32aa1441999-10-29 09:15:49 +100012.\"
Ben Lindstrom92a2e382001-03-05 06:59:27 +000013.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
14.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
15.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
Damien Millere4340be2000-09-16 13:29:08 +110016.\"
17.\" Redistribution and use in source and binary forms, with or without
18.\" modification, are permitted provided that the following conditions
19.\" are met:
20.\" 1. Redistributions of source code must retain the above copyright
21.\" notice, this list of conditions and the following disclaimer.
22.\" 2. Redistributions in binary form must reproduce the above copyright
23.\" notice, this list of conditions and the following disclaimer in the
24.\" documentation and/or other materials provided with the distribution.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Damien Miller32aa1441999-10-29 09:15:49 +100036.\"
Damien Millerbc1936a2006-03-15 11:35:05 +110037.\" $OpenBSD: sshd.8,v 1.224 2006/02/15 16:55:33 jmc Exp $
Damien Miller32aa1441999-10-29 09:15:49 +100038.Dd September 25, 1999
39.Dt SSHD 8
40.Os
41.Sh NAME
42.Nm sshd
Ben Lindstromc65e6a02001-04-23 13:02:16 +000043.Nd OpenSSH SSH daemon
Damien Miller32aa1441999-10-29 09:15:49 +100044.Sh SYNOPSIS
45.Nm sshd
Damien Millerffadc582003-02-24 11:52:26 +110046.Bk -words
Darren Tucker1f203942003-10-15 15:50:42 +100047.Op Fl 46Ddeiqt
Damien Miller32aa1441999-10-29 09:15:49 +100048.Op Fl b Ar bits
49.Op Fl f Ar config_file
50.Op Fl g Ar login_grace_time
51.Op Fl h Ar host_key_file
52.Op Fl k Ar key_gen_time
Ben Lindstromade03f62001-12-06 18:22:17 +000053.Op Fl o Ar option
Damien Miller32aa1441999-10-29 09:15:49 +100054.Op Fl p Ar port
Damien Miller942da032000-08-18 13:59:06 +100055.Op Fl u Ar len
Damien Millerffadc582003-02-24 11:52:26 +110056.Ek
Damien Miller22c77262000-04-13 12:26:34 +100057.Sh DESCRIPTION
Damien Miller32aa1441999-10-29 09:15:49 +100058.Nm
Damien Miller99cc4a82006-01-31 21:45:53 +110059(OpenSSH Daemon) is the daemon program for
Damien Miller32aa1441999-10-29 09:15:49 +100060.Xr ssh 1 .
Damien Miller35dabd02000-05-01 21:10:33 +100061Together these programs replace rlogin and rsh, and
Damien Miller32aa1441999-10-29 09:15:49 +100062provide secure encrypted communications between two untrusted hosts
Damien Miller450a7a12000-03-26 13:04:51 +100063over an insecure network.
Damien Miller32aa1441999-10-29 09:15:49 +100064.Pp
65.Nm
Damien Miller99cc4a82006-01-31 21:45:53 +110066listens for connections from clients.
Damien Miller22c77262000-04-13 12:26:34 +100067It is normally started at boot from
Damien Miller32aa1441999-10-29 09:15:49 +100068.Pa /etc/rc .
69It forks a new
Damien Miller450a7a12000-03-26 13:04:51 +100070daemon for each incoming connection.
71The forked daemons handle
Damien Miller32aa1441999-10-29 09:15:49 +100072key exchange, encryption, authentication, command execution,
73and data exchange.
Damien Miller32aa1441999-10-29 09:15:49 +100074.Pp
75.Nm
Darren Tucker1f203942003-10-15 15:50:42 +100076can be configured using command-line options or a configuration file
77(by default
Damien Miller99cc4a82006-01-31 21:45:53 +110078.Xr sshd_config 5 ) ;
79command-line options override values specified in the
Damien Miller32aa1441999-10-29 09:15:49 +100080configuration file.
Damien Miller6162d121999-11-21 13:23:52 +110081.Nm
82rereads its configuration file when it receives a hangup signal,
Ben Lindstrom49a098d2001-03-05 06:55:18 +000083.Dv SIGHUP ,
Darren Tucker097e1e92004-05-02 22:15:08 +100084by executing itself with the name and options it was started with, e.g.,
Ben Lindstrom49a098d2001-03-05 06:55:18 +000085.Pa /usr/sbin/sshd .
Damien Miller6162d121999-11-21 13:23:52 +110086.Pp
Damien Miller32aa1441999-10-29 09:15:49 +100087The options are as follows:
88.Bl -tag -width Ds
Darren Tucker1f203942003-10-15 15:50:42 +100089.It Fl 4
90Forces
91.Nm
92to use IPv4 addresses only.
93.It Fl 6
94Forces
95.Nm
96to use IPv6 addresses only.
Damien Miller32aa1441999-10-29 09:15:49 +100097.It Fl b Ar bits
Ben Lindstromc65e6a02001-04-23 13:02:16 +000098Specifies the number of bits in the ephemeral protocol version 1
99server key (default 768).
Darren Tucker1f203942003-10-15 15:50:42 +1000100.It Fl D
101When this option is specified,
102.Nm
103will not detach and does not become a daemon.
104This allows easy monitoring of
105.Nm sshd .
Damien Miller32aa1441999-10-29 09:15:49 +1000106.It Fl d
Damien Miller450a7a12000-03-26 13:04:51 +1000107Debug mode.
108The server sends verbose debug output to the system
109log, and does not put itself in the background.
110The server also will not fork and will only process one connection.
111This option is only intended for debugging for the server.
Damien Millerffadc582003-02-24 11:52:26 +1100112Multiple
113.Fl d
114options increase the debugging level.
Damien Miller874d77b2000-10-14 16:23:11 +1100115Maximum is 3.
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000116.It Fl e
117When this option is specified,
118.Nm
119will send the output to the standard error instead of the system log.
Damien Miller32aa1441999-10-29 09:15:49 +1000120.It Fl f Ar configuration_file
Damien Miller450a7a12000-03-26 13:04:51 +1000121Specifies the name of the configuration file.
122The default is
Damien Miller05eda432002-02-10 18:32:28 +1100123.Pa /etc/ssh/sshd_config .
Damien Miller32aa1441999-10-29 09:15:49 +1000124.Nm
125refuses to start if there is no configuration file.
126.It Fl g Ar login_grace_time
127Gives the grace time for clients to authenticate themselves (default
Damien Millerc1348632002-09-05 14:35:14 +1000128120 seconds).
Damien Miller450a7a12000-03-26 13:04:51 +1000129If the client fails to authenticate the user within
130this many seconds, the server disconnects and exits.
131A value of zero indicates no limit.
Damien Miller32aa1441999-10-29 09:15:49 +1000132.It Fl h Ar host_key_file
Damien Miller7fc23732002-01-22 23:19:11 +1100133Specifies a file from which a host key is read.
Damien Miller32aa1441999-10-29 09:15:49 +1000134This option must be given if
135.Nm
136is not run as root (as the normal
Damien Miller7fc23732002-01-22 23:19:11 +1100137host key files are normally not readable by anyone but root).
138The default is
Damien Miller05eda432002-02-10 18:32:28 +1100139.Pa /etc/ssh/ssh_host_key
Damien Miller7fc23732002-01-22 23:19:11 +1100140for protocol version 1, and
Damien Miller05eda432002-02-10 18:32:28 +1100141.Pa /etc/ssh/ssh_host_rsa_key
Damien Miller7fc23732002-01-22 23:19:11 +1100142and
Damien Miller05eda432002-02-10 18:32:28 +1100143.Pa /etc/ssh/ssh_host_dsa_key
Damien Miller7fc23732002-01-22 23:19:11 +1100144for protocol version 2.
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000145It is possible to have multiple host key files for
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000146the different protocol versions and host key algorithms.
Damien Miller32aa1441999-10-29 09:15:49 +1000147.It Fl i
148Specifies that
149.Nm
Damien Millerffadc582003-02-24 11:52:26 +1100150is being run from
151.Xr inetd 8 .
Damien Miller32aa1441999-10-29 09:15:49 +1000152.Nm
153is normally not run
154from inetd because it needs to generate the server key before it can
Damien Miller450a7a12000-03-26 13:04:51 +1000155respond to the client, and this may take tens of seconds.
156Clients would have to wait too long if the key was regenerated every time.
Damien Miller7684ee12000-03-17 23:40:15 +1100157However, with small key sizes (e.g., 512) using
Damien Miller32aa1441999-10-29 09:15:49 +1000158.Nm
159from inetd may
160be feasible.
161.It Fl k Ar key_gen_time
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000162Specifies how often the ephemeral protocol version 1 server key is
163regenerated (default 3600 seconds, or one hour).
Damien Miller450a7a12000-03-26 13:04:51 +1000164The motivation for regenerating the key fairly
Darren Tucker1f203942003-10-15 15:50:42 +1000165often is that the key is not stored anywhere, and after about an hour
Damien Miller32aa1441999-10-29 09:15:49 +1000166it becomes impossible to recover the key for decrypting intercepted
167communications even if the machine is cracked into or physically
Damien Miller450a7a12000-03-26 13:04:51 +1000168seized.
169A value of zero indicates that the key will never be regenerated.
Ben Lindstromade03f62001-12-06 18:22:17 +0000170.It Fl o Ar option
171Can be used to give options in the format used in the configuration file.
172This is useful for specifying options for which there is no separate
173command-line flag.
Darren Tucker1f203942003-10-15 15:50:42 +1000174For full details of the options, and their values, see
175.Xr sshd_config 5 .
Damien Miller32aa1441999-10-29 09:15:49 +1000176.It Fl p Ar port
177Specifies the port on which the server listens for connections
178(default 22).
Damien Miller7d1ded42002-01-22 23:09:41 +1100179Multiple port options are permitted.
Damien Millerd7f308f2005-12-24 14:55:16 +1100180Ports specified in the configuration file with the
181.Cm Port
182option are ignored when a command-line port is specified.
183Ports specified using the
184.Cm ListenAddress
185option override command-line ports.
Damien Miller32aa1441999-10-29 09:15:49 +1000186.It Fl q
Damien Miller450a7a12000-03-26 13:04:51 +1000187Quiet mode.
188Nothing is sent to the system log.
189Normally the beginning,
Damien Miller32aa1441999-10-29 09:15:49 +1000190authentication, and termination of each connection is logged.
Ben Lindstrom794325a2001-08-06 21:09:07 +0000191.It Fl t
192Test mode.
193Only check the validity of the configuration file and sanity of the keys.
Damien Miller9f0f5c62001-12-21 14:45:46 +1100194This is useful for updating
Ben Lindstrom794325a2001-08-06 21:09:07 +0000195.Nm
196reliably as configuration options may change.
Damien Miller942da032000-08-18 13:59:06 +1000197.It Fl u Ar len
198This option is used to specify the size of the field
199in the
200.Li utmp
201structure that holds the remote host name.
202If the resolved host name is longer than
203.Ar len ,
204the dotted decimal value will be used instead.
205This allows hosts with very long host names that
206overflow this field to still be uniquely identified.
207Specifying
208.Fl u0
209indicates that only dotted decimal addresses
210should be put into the
211.Pa utmp
212file.
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000213.Fl u0
Damien Millerffadc582003-02-24 11:52:26 +1100214may also be used to prevent
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000215.Nm
216from making DNS requests unless the authentication
217mechanism or configuration requires it.
218Authentication mechanisms that may require DNS include
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000219.Cm RhostsRSAAuthentication ,
Damien Miller2ac05772006-02-01 22:05:42 +1100220.Cm HostbasedAuthentication ,
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000221and using a
222.Cm from="pattern-list"
223option in a key file.
Ben Lindstromea03db92002-03-05 01:38:57 +0000224Configuration options that require DNS include using a
225USER@HOST pattern in
226.Cm AllowUsers
227or
228.Cm DenyUsers .
Damien Miller32aa1441999-10-29 09:15:49 +1000229.El
Damien Miller8bbdf902006-02-01 22:05:25 +1100230.Sh AUTHENTICATION
231The OpenSSH SSH daemon supports SSH protocols 1 and 2.
232Both protocols are supported by default,
233though this can be changed via the
234.Cm Protocol
235option in
236.Xr sshd_config 5 .
237Protocol 2 supports both RSA and DSA keys;
238protocol 1 only supports RSA keys.
239For both protocols,
240each host has a host-specific key,
241normally 2048 bits,
242used to identify the host.
Damien Miller99cc4a82006-01-31 21:45:53 +1100243.Pp
Damien Miller8bbdf902006-02-01 22:05:25 +1100244Forward security for protocol 1 is provided through
245an additional server key,
246normally 768 bits,
247generated when the server starts.
Damien Miller99cc4a82006-01-31 21:45:53 +1100248This key is normally regenerated every hour if it has been used, and
249is never stored on disk.
Damien Miller99cc4a82006-01-31 21:45:53 +1100250Whenever a client connects, the daemon responds with its public
251host and server keys.
252The client compares the
253RSA host key against its own database to verify that it has not changed.
254The client then generates a 256-bit random number.
255It encrypts this
256random number using both the host key and the server key, and sends
257the encrypted number to the server.
258Both sides then use this
259random number as a session key which is used to encrypt all further
260communications in the session.
261The rest of the session is encrypted
262using a conventional cipher, currently Blowfish or 3DES, with 3DES
263being used by default.
264The client selects the encryption algorithm
265to use from those offered by the server.
266.Pp
Damien Miller8bbdf902006-02-01 22:05:25 +1100267For protocol 2,
268forward security is provided through a Diffie-Hellman key agreement.
269This key agreement results in a shared session key.
270The rest of the session is encrypted using a symmetric cipher, currently
271128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES.
272The client selects the encryption algorithm
273to use from those offered by the server.
274Additionally, session integrity is provided
275through a cryptographic message authentication code
276(hmac-sha1 or hmac-md5).
277.Pp
278Finally, the server and the client enter an authentication dialog.
Damien Miller99cc4a82006-01-31 21:45:53 +1100279The client tries to authenticate itself using
Damien Miller8bbdf902006-02-01 22:05:25 +1100280host-based authentication,
281public key authentication,
282challenge-response authentication,
283or password authentication.
Damien Miller99cc4a82006-01-31 21:45:53 +1100284.Pp
285Regardless of the authentication type, the account is checked to
286ensure that it is accessible. An account is not accessible if it is
287locked, listed in
288.Cm DenyUsers
289or its group is listed in
290.Cm DenyGroups
291\&. The definition of a locked account is system dependant. Some platforms
292have their own account database (eg AIX) and some modify the passwd field (
293.Ql \&*LK\&*
294on Solaris and UnixWare,
295.Ql \&*
296on HP-UX, containing
297.Ql Nologin
298on Tru64,
299a leading
300.Ql \&*LOCKED\&*
301on FreeBSD and a leading
302.Ql \&!!
303on Linux). If there is a requirement to disable password authentication
304for the account while allowing still public-key, then the passwd field
305should be set to something other than these values (eg
306.Ql NP
307or
308.Ql \&*NP\&*
309).
310.Pp
Damien Miller99cc4a82006-01-31 21:45:53 +1100311If the client successfully authenticates itself, a dialog for
312preparing the session is entered.
313At this time the client may request
314things like allocating a pseudo-tty, forwarding X11 connections,
315forwarding TCP connections, or forwarding the authentication agent
316connection over the secure channel.
317.Pp
Damien Millerc47d7e92006-03-15 11:27:20 +1100318After this, the client either requests a shell or execution of a command.
Damien Miller99cc4a82006-01-31 21:45:53 +1100319The sides then enter session mode.
320In this mode, either side may send
321data at any time, and such data is forwarded to/from the shell or
322command on the server side, and the user terminal in the client side.
323.Pp
324When the user program terminates and all forwarded X11 and other
325connections have been closed, the server sends command exit status to
326the client, and both sides exit.
Damien Miller32aa1441999-10-29 09:15:49 +1000327.Sh LOGIN PROCESS
328When a user successfully logs in,
329.Nm
330does the following:
331.Bl -enum -offset indent
332.It
333If the login is on a tty, and no command has been specified,
Damien Miller22c77262000-04-13 12:26:34 +1000334prints last login time and
Damien Miller32aa1441999-10-29 09:15:49 +1000335.Pa /etc/motd
336(unless prevented in the configuration file or by
Damien Miller167ea5d2005-05-26 12:04:02 +1000337.Pa ~/.hushlogin ;
Damien Miller32aa1441999-10-29 09:15:49 +1000338see the
Damien Miller22c77262000-04-13 12:26:34 +1000339.Sx FILES
Damien Miller32aa1441999-10-29 09:15:49 +1000340section).
341.It
342If the login is on a tty, records login time.
343.It
344Checks
345.Pa /etc/nologin ;
346if it exists, prints contents and quits
347(unless root).
348.It
349Changes to run with normal user privileges.
350.It
351Sets up basic environment.
352.It
Darren Tucker1f203942003-10-15 15:50:42 +1000353Reads the file
Damien Miller167ea5d2005-05-26 12:04:02 +1000354.Pa ~/.ssh/environment ,
Darren Tucker1f203942003-10-15 15:50:42 +1000355if it exists, and users are allowed to change their environment.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000356See the
Ben Lindstromdc7adf22002-08-20 18:38:02 +0000357.Cm PermitUserEnvironment
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000358option in
Ben Lindstromdc7adf22002-08-20 18:38:02 +0000359.Xr sshd_config 5 .
Damien Miller32aa1441999-10-29 09:15:49 +1000360.It
361Changes to user's home directory.
362.It
363If
Damien Miller167ea5d2005-05-26 12:04:02 +1000364.Pa ~/.ssh/rc
Damien Miller32aa1441999-10-29 09:15:49 +1000365exists, runs it; else if
Damien Millerafcc2252002-02-10 18:32:55 +1100366.Pa /etc/ssh/sshrc
Damien Miller32aa1441999-10-29 09:15:49 +1000367exists, runs
Damien Miller450a7a12000-03-26 13:04:51 +1000368it; otherwise runs xauth.
369The
Damien Miller32aa1441999-10-29 09:15:49 +1000370.Dq rc
371files are given the X11
372authentication protocol and cookie in standard input.
373.It
374Runs user's shell or command.
375.El
376.Sh AUTHORIZED_KEYS FILE FORMAT
Ben Lindstromf96704d2001-06-25 04:17:12 +0000377.Cm AuthorizedKeysFile
Damien Millerdcfea272006-03-15 11:31:22 +1100378specifies the file containing public keys for
379public key authentication;
380if none is specified, the default is
381.Pa ~/.ssh/authorized_keys .
Damien Miller450a7a12000-03-26 13:04:51 +1000382Each line of the file contains one
Damien Miller32aa1441999-10-29 09:15:49 +1000383key (empty lines and lines starting with a
384.Ql #
385are ignored as
Damien Miller450a7a12000-03-26 13:04:51 +1000386comments).
Damien Millerdcfea272006-03-15 11:31:22 +1100387Protocol 1 public keys consist of the following space-separated fields:
388options, bits, exponent, modulus, comment.
389Protocol 2 public key consist of:
390options, keytype, base64-encoded key, comment.
391The options field is optional;
392its presence is determined by whether the line starts
Damien Millerb83df8d2002-09-04 16:24:55 +1000393with a number or not (the options field never starts with a number).
Damien Millerdcfea272006-03-15 11:31:22 +1100394The bits, exponent, modulus, and comment fields give the RSA key for
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000395protocol version 1; the
Damien Miller32aa1441999-10-29 09:15:49 +1000396comment field is not used for anything (but may be convenient for the
397user to identify the key).
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000398For protocol version 2 the keytype is
399.Dq ssh-dss
400or
401.Dq ssh-rsa .
Damien Miller32aa1441999-10-29 09:15:49 +1000402.Pp
403Note that lines in this file are usually several hundred bytes long
Darren Tucker22cc7412004-12-06 22:47:41 +1100404(because of the size of the public key encoding) up to a limit of
4058 kilobytes, which permits DSA keys up to 8 kilobits and RSA
406keys up to 16 kilobits.
Damien Miller450a7a12000-03-26 13:04:51 +1000407You don't want to type them in; instead, copy the
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000408.Pa identity.pub ,
Damien Millerdcfea272006-03-15 11:31:22 +1100409.Pa id_dsa.pub ,
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000410or the
411.Pa id_rsa.pub
Damien Miller32aa1441999-10-29 09:15:49 +1000412file and edit it.
413.Pp
Ben Lindstrom0d0be022002-04-02 20:39:29 +0000414.Nm
415enforces a minimum RSA key modulus size for protocol 1
416and protocol 2 keys of 768 bits.
417.Pp
Damien Miller942da032000-08-18 13:59:06 +1000418The options (if present) consist of comma-separated option
Damien Miller450a7a12000-03-26 13:04:51 +1000419specifications.
420No spaces are permitted, except within double quotes.
Ben Lindstrom1c0fd092001-09-12 16:36:17 +0000421The following option specifications are supported (note
422that option keywords are case-insensitive):
Damien Miller32aa1441999-10-29 09:15:49 +1000423.Bl -tag -width Ds
Damien Miller32aa1441999-10-29 09:15:49 +1000424.It Cm command="command"
425Specifies that the command is executed whenever this key is used for
Damien Miller450a7a12000-03-26 13:04:51 +1000426authentication.
427The command supplied by the user (if any) is ignored.
Ben Lindstrom23124ea2001-09-14 23:14:25 +0000428The command is run on a pty if the client requests a pty;
Damien Miller450a7a12000-03-26 13:04:51 +1000429otherwise it is run without a tty.
Damien Millerffadc582003-02-24 11:52:26 +1100430If an 8-bit clean channel is required,
Ben Lindstrom594e2032001-09-12 18:35:30 +0000431one must not request a pty or should specify
Damien Miller33804262001-02-04 23:20:18 +1100432.Cm no-pty .
Damien Miller450a7a12000-03-26 13:04:51 +1000433A quote may be included in the command by quoting it with a backslash.
434This option might be useful
Damien Millerb83df8d2002-09-04 16:24:55 +1000435to restrict certain public keys to perform just a specific operation.
Damien Miller450a7a12000-03-26 13:04:51 +1000436An example might be a key that permits remote backups but nothing else.
Damien Miller7c24b812006-01-14 10:09:56 +1100437Note that the client may specify TCP and/or X11
Damien Miller30c3d422000-05-09 11:02:59 +1000438forwarding unless they are explicitly prohibited.
Ben Lindstrom20daef72001-09-20 00:54:01 +0000439Note that this option applies to shell, command or subsystem execution.
Damien Miller32aa1441999-10-29 09:15:49 +1000440.It Cm environment="NAME=value"
441Specifies that the string is to be added to the environment when
Damien Miller450a7a12000-03-26 13:04:51 +1000442logging in using this key.
443Environment variables set this way
444override other default environment values.
445Multiple options of this type are permitted.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000446Environment processing is disabled by default and is
447controlled via the
448.Cm PermitUserEnvironment
449option.
Ben Lindstrom38b951c2001-12-06 17:47:47 +0000450This option is automatically disabled if
451.Cm UseLogin
452is enabled.
Damien Miller31bdc522006-03-15 11:31:44 +1100453.It Cm from="pattern-list"
454Specifies that in addition to public key authentication, the canonical name
455of the remote host must be present in the comma-separated list of
456patterns
Damien Millerc8f61cf2006-03-15 11:33:25 +1100457.Pf ( Ql *
Damien Miller31bdc522006-03-15 11:31:44 +1100458and
459.Ql \&?
460serve as wildcards).
461The list may also contain
462patterns negated by prefixing them with
463.Ql \&! ;
464if the canonical host name matches a negated pattern, the key is not accepted.
465The purpose
466of this option is to optionally increase security: public key authentication
467by itself does not trust the network or name servers or anything (but
468the key); however, if somebody somehow steals the key, the key
469permits an intruder to log in from anywhere in the world.
470This additional option makes using a stolen key more difficult (name
471servers and/or routers would have to be compromised in addition to
472just the key).
473.It Cm no-agent-forwarding
474Forbids authentication agent forwarding when this key is used for
475authentication.
Damien Miller32aa1441999-10-29 09:15:49 +1000476.It Cm no-port-forwarding
Damien Miller7c24b812006-01-14 10:09:56 +1100477Forbids TCP forwarding when this key is used for authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000478Any port forward requests by the client will return an error.
479This might be used, e.g., in connection with the
Damien Miller32aa1441999-10-29 09:15:49 +1000480.Cm command
481option.
Damien Miller31bdc522006-03-15 11:31:44 +1100482.It Cm no-pty
483Prevents tty allocation (a request to allocate a pty will fail).
Damien Miller32aa1441999-10-29 09:15:49 +1000484.It Cm no-X11-forwarding
485Forbids X11 forwarding when this key is used for authentication.
486Any X11 forward requests by the client will return an error.
Damien Millera243fde2001-03-19 23:16:08 +1100487.It Cm permitopen="host:port"
Ben Lindstrom24643222001-06-25 05:08:11 +0000488Limit local
Damien Millera243fde2001-03-19 23:16:08 +1100489.Li ``ssh -L''
Ben Lindstrom4b3564e2001-04-10 02:41:56 +0000490port forwarding such that it may only connect to the specified host and
Ben Lindstromd71ba572001-09-12 18:03:31 +0000491port.
492IPv6 addresses can be specified with an alternative syntax:
Darren Tucker1f203942003-10-15 15:50:42 +1000493.Ar host Ns / Ns Ar port .
Ben Lindstromd71ba572001-09-12 18:03:31 +0000494Multiple
Damien Millera243fde2001-03-19 23:16:08 +1100495.Cm permitopen
Damien Millerfbf486b2003-05-23 18:44:23 +1000496options may be applied separated by commas.
497No pattern matching is performed on the specified hostnames,
498they must be literal domains or addresses.
Damien Millerd27b9472005-12-13 19:29:02 +1100499.It Cm tunnel="n"
500Force a
501.Xr tun 4
502device on the server.
503Without this option, the next available device will be used if
504the client requests a tunnel.
Damien Miller32aa1441999-10-29 09:15:49 +1000505.El
Damien Miller32aa1441999-10-29 09:15:49 +1000506.Pp
Damien Miller7d2ef022006-03-15 11:32:06 +1100507An example authorized_keys file:
Damien Millerc8f61cf2006-03-15 11:33:25 +1100508.Bd -literal -offset 3n
Damien Miller7d2ef022006-03-15 11:32:06 +1100509# Comments allowed at start of line
510ssh-rsa AAAAB3Nza...LiPk== user@example.net
Damien Millerc8f61cf2006-03-15 11:33:25 +1100511from="*.sales.example.net,!pc.sales.example.net" ssh-rsa
512AAAAB2...19Q== john@example.net
513command="dump /home",no-pty,no-port-forwarding ssh-dss
514AAAAC3...51R== example.net
515permitopen="192.0.2.1:80",permitopen="192.0.2.2:25" ssh-dss
516AAAAB5...21S==
517tunnel="0",command="sh /etc/netstart tun0" ssh-rsa AAAA...==
518jane@example.net
Damien Miller7d2ef022006-03-15 11:32:06 +1100519.Ed
Damien Miller32aa1441999-10-29 09:15:49 +1000520.Sh SSH_KNOWN_HOSTS FILE FORMAT
Damien Miller22c77262000-04-13 12:26:34 +1000521The
Damien Millerffadc582003-02-24 11:52:26 +1100522.Pa /etc/ssh/ssh_known_hosts
Damien Miller22c77262000-04-13 12:26:34 +1000523and
Damien Miller167ea5d2005-05-26 12:04:02 +1000524.Pa ~/.ssh/known_hosts
Damien Miller450a7a12000-03-26 13:04:51 +1000525files contain host public keys for all known hosts.
526The global file should
527be prepared by the administrator (optional), and the per-user file is
Damien Miller9a7f2012006-03-15 11:32:42 +1100528maintained automatically: whenever the user connects from an unknown host,
Damien Miller450a7a12000-03-26 13:04:51 +1000529its key is added to the per-user file.
Damien Miller32aa1441999-10-29 09:15:49 +1000530.Pp
531Each line in these files contains the following fields: hostnames,
Damien Miller450a7a12000-03-26 13:04:51 +1000532bits, exponent, modulus, comment.
533The fields are separated by spaces.
Damien Miller32aa1441999-10-29 09:15:49 +1000534.Pp
Damien Miller31554322003-05-14 13:44:58 +1000535Hostnames is a comma-separated list of patterns
Damien Miller9a7f2012006-03-15 11:32:42 +1100536.Pf ( Ql *
Damien Millerfbf486b2003-05-23 18:44:23 +1000537and
538.Ql \&?
Damien Miller049245d2003-05-14 13:44:42 +1000539act as
Damien Miller32aa1441999-10-29 09:15:49 +1000540wildcards); each pattern in turn is matched against the canonical host
541name (when authenticating a client) or against the user-supplied
Damien Miller450a7a12000-03-26 13:04:51 +1000542name (when authenticating a server).
543A pattern may also be preceded by
Damien Miller049245d2003-05-14 13:44:42 +1000544.Ql \&!
Damien Miller32aa1441999-10-29 09:15:49 +1000545to indicate negation: if the host name matches a negated
546pattern, it is not accepted (by that line) even if it matched another
547pattern on the line.
548.Pp
Damien Millere1776152005-03-01 21:47:37 +1100549Alternately, hostnames may be stored in a hashed form which hides host names
Damien Miller718fd4b2005-03-02 12:03:23 +1100550and addresses should the file's contents be disclosed.
551Hashed hostnames start with a
552.Ql |
Damien Millere1776152005-03-01 21:47:37 +1100553character.
554Only one hashed hostname may appear on a single line and none of the above
555negation or wildcard operators may be applied.
556.Pp
Damien Millere247cc42000-05-07 12:03:14 +1000557Bits, exponent, and modulus are taken directly from the RSA host key; they
Damien Miller9a7f2012006-03-15 11:32:42 +1100558can be obtained, for example, from
Damien Miller05eda432002-02-10 18:32:28 +1100559.Pa /etc/ssh/ssh_host_key.pub .
Damien Miller32aa1441999-10-29 09:15:49 +1000560The optional comment field continues to the end of the line, and is not used.
561.Pp
562Lines starting with
563.Ql #
564and empty lines are ignored as comments.
565.Pp
566When performing host authentication, authentication is accepted if any
Damien Miller450a7a12000-03-26 13:04:51 +1000567matching line has the proper key.
568It is thus permissible (but not
Damien Miller32aa1441999-10-29 09:15:49 +1000569recommended) to have several lines or different host keys for the same
Damien Miller450a7a12000-03-26 13:04:51 +1000570names.
571This will inevitably happen when short forms of host names
572from different domains are put in the file.
573It is possible
Damien Miller32aa1441999-10-29 09:15:49 +1000574that the files contain conflicting information; authentication is
575accepted if valid information can be found from either file.
576.Pp
577Note that the lines in these files are typically hundreds of characters
578long, and you definitely don't want to type in the host keys by hand.
579Rather, generate them by a script
Damien Miller22c77262000-04-13 12:26:34 +1000580or by taking
Damien Miller05eda432002-02-10 18:32:28 +1100581.Pa /etc/ssh/ssh_host_key.pub
Damien Miller32aa1441999-10-29 09:15:49 +1000582and adding the host names at the front.
Damien Millercc00f5e2006-03-15 11:33:00 +1100583.Pp
584An example ssh_known_hosts file:
585.Bd -literal -offset 3n
586# Comments allowed at start of line
587closenet,...,192.0.2.53 1024 37 159...93 closenet.example.net
588cvs.example.net,192.0.2.10 ssh-rsa AAAA1234.....=
Damien Millere1776152005-03-01 21:47:37 +1100589# A hashed hostname
590|1|JfKTdBh7rNbXkVAQCRp4OQoPfmI=|USECr3SWf1JUPsms5AqfD5QfxkM= ssh-rsa
591AAAA1234.....=
592.Ed
Damien Miller32aa1441999-10-29 09:15:49 +1000593.Sh FILES
Damien Millerd8702e82006-03-15 11:33:56 +1100594.Bl -tag -width Ds -compact
595.It ~/.hushlogin
Damien Miller70a908e2005-03-01 21:17:09 +1100596This file is used to suppress printing the last login time and
597.Pa /etc/motd ,
598if
599.Cm PrintLastLog
600and
601.Cm PrintMotd ,
602respectively,
603are enabled.
604It does not suppress printing of the banner specified by
605.Cm Banner .
Damien Millerd8702e82006-03-15 11:33:56 +1100606.Pp
607.It ~/.rhosts
Darren Tuckerdb693902004-08-29 16:37:24 +1000608This file is used during
609.Cm RhostsRSAAuthentication
610and
611.Cm HostbasedAuthentication
612and contains host-username pairs, separated by a space, one per
Damien Miller450a7a12000-03-26 13:04:51 +1000613line.
614The given user on the corresponding host is permitted to log in
Damien Millerffadc582003-02-24 11:52:26 +1100615without a password.
Damien Miller450a7a12000-03-26 13:04:51 +1000616The same file is used by rlogind and rshd.
Damien Miller32aa1441999-10-29 09:15:49 +1000617The file must
618be writable only by the user; it is recommended that it not be
619accessible by others.
620.Pp
Darren Tucker1f203942003-10-15 15:50:42 +1000621It is also possible to use netgroups in the file.
Damien Miller450a7a12000-03-26 13:04:51 +1000622Either host or user
Damien Miller32aa1441999-10-29 09:15:49 +1000623name may be of the form +@groupname to specify all hosts or all users
624in the group.
Damien Millerd8702e82006-03-15 11:33:56 +1100625.Pp
626.It ~/.shosts
Damien Miller32aa1441999-10-29 09:15:49 +1000627For ssh,
628this file is exactly the same as for
629.Pa .rhosts .
630However, this file is
631not used by rlogin and rshd, so using this permits access using SSH only.
Damien Miller32aa1441999-10-29 09:15:49 +1000632.Pp
Damien Millerd8702e82006-03-15 11:33:56 +1100633.It ~/.ssh/authorized_keys
634Lists the public keys (RSA or DSA) that can be used to log into the user's account.
635This file must be readable by root (which may on some machines imply
636it being world-readable if the user's home directory resides on an NFS
637volume).
638It is recommended that it not be accessible by others.
639The format of this file is described above.
640Users will place the contents of their
641.Pa identity.pub ,
642.Pa id_dsa.pub
643and/or
644.Pa id_rsa.pub
645files into this file, as described in
646.Xr ssh-keygen 1 .
Damien Miller32aa1441999-10-29 09:15:49 +1000647.Pp
Damien Millerd8702e82006-03-15 11:33:56 +1100648.It ~/.ssh/environment
Damien Miller450a7a12000-03-26 13:04:51 +1000649This file is read into the environment at login (if it exists).
650It can only contain empty lines, comment lines (that start with
Damien Miller32aa1441999-10-29 09:15:49 +1000651.Ql # ) ,
Damien Miller450a7a12000-03-26 13:04:51 +1000652and assignment lines of the form name=value.
653The file should be writable
Damien Miller32aa1441999-10-29 09:15:49 +1000654only by the user; it need not be readable by anyone else.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000655Environment processing is disabled by default and is
656controlled via the
657.Cm PermitUserEnvironment
658option.
Damien Millerd8702e82006-03-15 11:33:56 +1100659.Pp
660.It ~/.ssh/known_hosts
661.It /etc/ssh/ssh_known_hosts
662These files are consulted when using rhosts with RSA host
663authentication or protocol version 2 hostbased authentication
664to check the public key of the host.
665The key must be listed in one of these files to be accepted.
666The client uses the same files
667to verify that it is connecting to the correct remote host.
668These files should be writable only by root/the owner.
669.Pa /etc/ssh/ssh_known_hosts
670should be world-readable, and
671.Pa ~/.ssh/known_hosts
672can, but need not be, world-readable.
673.Pp
674.It ~/.ssh/rc
Damien Millerffadc582003-02-24 11:52:26 +1100675If this file exists, it is run with
676.Pa /bin/sh
677after reading the
Damien Miller450a7a12000-03-26 13:04:51 +1000678environment files but before starting the user's shell or command.
Ben Lindstroma11e2702002-04-05 22:18:48 +0000679It must not produce any output on stdout; stderr must be used
680instead.
681If X11 forwarding is in use, it will receive the "proto cookie" pair in
682its standard input (and
Damien Miller32aa1441999-10-29 09:15:49 +1000683.Ev DISPLAY
Ben Lindstroma11e2702002-04-05 22:18:48 +0000684in its environment).
685The script must call
Damien Miller32aa1441999-10-29 09:15:49 +1000686.Xr xauth 1
Ben Lindstroma11e2702002-04-05 22:18:48 +0000687because
688.Nm
689will not run xauth automatically to add X11 cookies.
Damien Miller32aa1441999-10-29 09:15:49 +1000690.Pp
691The primary purpose of this file is to run any initialization routines
692which may be needed before the user's home directory becomes
693accessible; AFS is a particular example of such an environment.
694.Pp
695This file will probably contain some initialization code followed by
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000696something similar to:
697.Bd -literal
Ben Lindstroma11e2702002-04-05 22:18:48 +0000698if read proto cookie && [ -n "$DISPLAY" ]; then
699 if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
700 # X11UseLocalhost=yes
Damien Millerdcbb6c22002-09-25 12:20:52 +1000701 echo add unix:`echo $DISPLAY |
Ben Lindstroma11e2702002-04-05 22:18:48 +0000702 cut -c11-` $proto $cookie
703 else
704 # X11UseLocalhost=no
Damien Millerdcbb6c22002-09-25 12:20:52 +1000705 echo add $DISPLAY $proto $cookie
706 fi | xauth -q -
Ben Lindstroma11e2702002-04-05 22:18:48 +0000707fi
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000708.Ed
Damien Miller32aa1441999-10-29 09:15:49 +1000709.Pp
710If this file does not exist,
Damien Miller05eda432002-02-10 18:32:28 +1100711.Pa /etc/ssh/sshrc
Damien Miller32aa1441999-10-29 09:15:49 +1000712is run, and if that
Ben Lindstroma11e2702002-04-05 22:18:48 +0000713does not exist either, xauth is used to add the cookie.
Damien Miller32aa1441999-10-29 09:15:49 +1000714.Pp
715This file should be writable only by the user, and need not be
716readable by anyone else.
Damien Millerd8702e82006-03-15 11:33:56 +1100717.Pp
718.It /etc/hosts.allow
719.It /etc/hosts.deny
720Access controls that should be enforced by tcp-wrappers are defined here.
721Further details are described in
722.Xr hosts_access 5 .
723.Pp
724.It /etc/hosts.equiv
725This file is used during
726.Cm RhostsRSAAuthentication
727and
728.Cm HostbasedAuthentication
729authentication.
730In the simplest form, this file contains host names, one per line.
731Users on
732those hosts are permitted to log in without a password, provided they
733have the same user name on both machines.
734The host name may also be
735followed by a user name; such users are permitted to log in as
736.Em any
737user on this machine (except root).
738Additionally, the syntax
739.Dq +@group
740can be used to specify netgroups.
741Negated entries start with
742.Ql \&- .
743.Pp
744If the client host/user is successfully matched in this file, login is
745automatically permitted provided the client and server user names are the
746same.
747Additionally, successful client host key authentication is required.
748This file must be writable only by root; it is recommended
749that it be world-readable.
750.Pp
751.Sy "Warning: It is almost never a good idea to use user names in"
752.Pa hosts.equiv .
753Beware that it really means that the named user(s) can log in as
754.Em anybody ,
755which includes bin, daemon, adm, and other accounts that own critical
756binaries and directories.
757Using a user name practically grants the user root access.
758The only valid use for user names that I can think
759of is in negative entries.
760.Pp
761Note that this warning also applies to rsh/rlogin.
762.Pp
763.It /etc/moduli
764Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
765The file format is described in
766.Xr moduli 5 .
767.Pp
768.It /etc/motd
769See
770.Xr motd 5 .
771.Pp
772.It /etc/nologin
773If this file exists,
774.Nm
775refuses to let anyone except root log in.
776The contents of the file
777are displayed to anyone trying to log in, and non-root connections are
778refused.
779The file should be world-readable.
780.Pp
781.It /etc/shosts.equiv
782This is processed exactly as
783.Pa /etc/hosts.equiv .
784However, this file may be useful in environments that want to run both
785rsh/rlogin and ssh.
786.Pp
787.It /etc/ssh/ssh_host_key
788.It /etc/ssh/ssh_host_dsa_key
789.It /etc/ssh/ssh_host_rsa_key
790These three files contain the private parts of the host keys.
791These files should only be owned by root, readable only by root, and not
792accessible to others.
793Note that
794.Nm
795does not start if this file is group/world-accessible.
796.Pp
797.It /etc/ssh/ssh_host_key.pub
798.It /etc/ssh/ssh_host_dsa_key.pub
799.It /etc/ssh/ssh_host_rsa_key.pub
800These three files contain the public parts of the host keys.
801These files should be world-readable but writable only by
802root.
803Their contents should match the respective private parts.
804These files are not
805really used for anything; they are provided for the convenience of
806the user so their contents can be copied to known hosts files.
807These files are created using
808.Xr ssh-keygen 1 .
809.Pp
810.It /etc/ssh/sshd_config
811Contains configuration data for
812.Nm sshd .
813The file format and configuration options are described in
814.Xr sshd_config 5 .
815.Pp
816.It /etc/ssh/sshrc
Damien Miller32aa1441999-10-29 09:15:49 +1000817Like
Damien Miller167ea5d2005-05-26 12:04:02 +1000818.Pa ~/.ssh/rc .
Damien Miller32aa1441999-10-29 09:15:49 +1000819This can be used to specify
Damien Miller450a7a12000-03-26 13:04:51 +1000820machine-specific login-time initializations globally.
821This file should be writable only by root, and should be world-readable.
Damien Millerd8702e82006-03-15 11:33:56 +1100822.Pp
823.It /var/empty
824.Xr chroot 2
825directory used by
826.Nm
827during privilege separation in the pre-authentication phase.
828The directory should not contain any files and must be owned by root
829and not group or world-writable.
830.Pp
831.It /var/run/sshd.pid
832Contains the process ID of the
833.Nm
834listening for connections (if there are several daemons running
835concurrently for different ports, this contains the process ID of the one
836started last).
837The content of this file is not sensitive; it can be world-readable.
Damien Miller37023962000-07-11 17:31:38 +1000838.El
Damien Miller32aa1441999-10-29 09:15:49 +1000839.Sh SEE ALSO
Damien Miller32aa1441999-10-29 09:15:49 +1000840.Xr scp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100841.Xr sftp 1 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000842.Xr ssh 1 ,
843.Xr ssh-add 1 ,
844.Xr ssh-agent 1 ,
845.Xr ssh-keygen 1 ,
Darren Tucker1f203942003-10-15 15:50:42 +1000846.Xr chroot 2 ,
847.Xr hosts_access 5 ,
Ben Lindstromc8e29ce2001-08-06 20:55:28 +0000848.Xr login.conf 5 ,
849.Xr moduli 5 ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000850.Xr sshd_config 5 ,
Darren Tucker1f203942003-10-15 15:50:42 +1000851.Xr inetd 8 ,
Ben Lindstromd2bf0d62001-06-25 04:10:54 +0000852.Xr sftp-server 8
Damien Millerf1ce5052003-06-11 22:04:39 +1000853.Sh AUTHORS
854OpenSSH is a derivative of the original and free
855ssh 1.2.12 release by Tatu Ylonen.
856Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
857Theo de Raadt and Dug Song
858removed many bugs, re-added newer features and
859created OpenSSH.
860Markus Friedl contributed the support for SSH
861protocol versions 1.5 and 2.0.
862Niels Provos and Markus Friedl contributed support
863for privilege separation.
Damien Millerc47d7e92006-03-15 11:27:20 +1100864.Sh CAVEATS
865System security is not improved unless
866.Nm rshd ,
867.Nm rlogind ,
868and
869.Nm rexecd
870are disabled (thus completely disabling
871.Xr rlogin
872and
873.Xr rsh
874into the machine).