blob: 34413e2a7f2388cfd05aefcbfab3e12108798657 [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.\"
Darren Tucker1f203942003-10-15 15:50:42 +100037.\" $OpenBSD: sshd.8,v 1.200 2003/10/08 08:27:36 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
Ben Lindstromd58eb5f2001-03-07 06:07:22 +000059(SSH 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.
64The programs are intended to be as easy to
Damien Miller32aa1441999-10-29 09:15:49 +100065install and use as possible.
66.Pp
67.Nm
Damien Miller450a7a12000-03-26 13:04:51 +100068is the daemon that listens 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 Millere247cc42000-05-07 12:03:14 +100076This implementation of
77.Nm
78supports both SSH protocol version 1 and 2 simultaneously.
Damien Miller32aa1441999-10-29 09:15:49 +100079.Nm
Damien Millerffadc582003-02-24 11:52:26 +110080works as follows:
Damien Millere247cc42000-05-07 12:03:14 +100081.Ss SSH protocol version 1
Damien Miller450a7a12000-03-26 13:04:51 +100082Each host has a host-specific RSA key
83(normally 1024 bits) used to identify the host.
84Additionally, when
Damien Miller32aa1441999-10-29 09:15:49 +100085the daemon starts, it generates a server RSA key (normally 768 bits).
86This key is normally regenerated every hour if it has been used, and
87is never stored on disk.
88.Pp
Damien Millerffadc582003-02-24 11:52:26 +110089Whenever a client connects, the daemon responds with its public
Damien Miller35dabd02000-05-01 21:10:33 +100090host and server keys.
Damien Miller450a7a12000-03-26 13:04:51 +100091The client compares the
Damien Millere247cc42000-05-07 12:03:14 +100092RSA host key against its own database to verify that it has not changed.
Darren Tucker1f203942003-10-15 15:50:42 +100093The client then generates a 256-bit random number.
Damien Miller450a7a12000-03-26 13:04:51 +100094It encrypts this
Damien Miller32aa1441999-10-29 09:15:49 +100095random number using both the host key and the server key, and sends
Damien Miller450a7a12000-03-26 13:04:51 +100096the encrypted number to the server.
Damien Miller35dabd02000-05-01 21:10:33 +100097Both sides then use this
Damien Miller32aa1441999-10-29 09:15:49 +100098random number as a session key which is used to encrypt all further
Damien Miller450a7a12000-03-26 13:04:51 +100099communications in the session.
100The rest of the session is encrypted
Damien Miller35dabd02000-05-01 21:10:33 +1000101using a conventional cipher, currently Blowfish or 3DES, with 3DES
Damien Millerb38eff82000-04-01 11:09:21 +1000102being used by default.
Damien Miller450a7a12000-03-26 13:04:51 +1000103The client selects the encryption algorithm
Damien Miller32aa1441999-10-29 09:15:49 +1000104to use from those offered by the server.
105.Pp
Damien Miller450a7a12000-03-26 13:04:51 +1000106Next, the server and the client enter an authentication dialog.
107The client tries to authenticate itself using
Darren Tucker1f203942003-10-15 15:50:42 +1000108.Em .rhosts
Damien Miller32aa1441999-10-29 09:15:49 +1000109authentication,
Darren Tucker1f203942003-10-15 15:50:42 +1000110.Em .rhosts
Damien Miller32aa1441999-10-29 09:15:49 +1000111authentication combined with RSA host
112authentication, RSA challenge-response authentication, or password
113based authentication.
114.Pp
Darren Tuckere41bba52003-08-25 11:51:19 +1000115Regardless of the authentication type, the account is checked to
116ensure that it is accessible. An account is not accessible if it is
117locked, listed in
118.Cm DenyUsers
119or its group is listed in
120.Cm DenyGroups
121\&. The definition of a locked account is system dependant. Some platforms
122have their own account database (eg AIX) and some modify the passwd field (
123.Ql \&*LK\&*
124on Solaris,
125.Ql \&*
126on HP-UX, containing
127.Ql Nologin
128on Tru64 and a leading
129.Ql \&!!
130on Linux). If there is a requirement to disable password authentication
131for the account while allowing still public-key, then the passwd field
132should be set to something other than these values (eg
133.Ql NP
134or
135.Ql \&*NP\&*
136).
137.Pp
Darren Tucker1f203942003-10-15 15:50:42 +1000138.Em rhosts
139authentication is normally disabled
Damien Miller32aa1441999-10-29 09:15:49 +1000140because it is fundamentally insecure, but can be enabled in the server
Damien Miller450a7a12000-03-26 13:04:51 +1000141configuration file if desired.
142System security is not improved unless
Ben Lindstromc57bbf12002-05-15 21:36:45 +0000143.Nm rshd ,
144.Nm rlogind ,
Damien Miller32aa1441999-10-29 09:15:49 +1000145and
Damien Millerffadc582003-02-24 11:52:26 +1100146.Nm rexecd
Damien Miller32aa1441999-10-29 09:15:49 +1000147are disabled (thus completely disabling
Ben Lindstromc57bbf12002-05-15 21:36:45 +0000148.Xr rlogin
Damien Miller32aa1441999-10-29 09:15:49 +1000149and
Ben Lindstromc57bbf12002-05-15 21:36:45 +0000150.Xr rsh
Damien Miller35dabd02000-05-01 21:10:33 +1000151into the machine).
Damien Millere247cc42000-05-07 12:03:14 +1000152.Ss SSH protocol version 2
Damien Miller942da032000-08-18 13:59:06 +1000153Version 2 works similarly:
Ben Lindstrom07d24dc2001-08-06 21:18:57 +0000154Each host has a host-specific key (RSA or DSA) used to identify the host.
Damien Millere247cc42000-05-07 12:03:14 +1000155However, when the daemon starts, it does not generate a server key.
156Forward security is provided through a Diffie-Hellman key agreement.
157This key agreement results in a shared session key.
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000158.Pp
Ben Lindstromfd2e05b2001-03-05 07:48:45 +0000159The rest of the session is encrypted using a symmetric cipher, currently
Darren Tucker1f203942003-10-15 15:50:42 +1000160128-bit AES, Blowfish, 3DES, CAST128, Arcfour, 192-bit AES, or 256-bit AES.
Damien Millere247cc42000-05-07 12:03:14 +1000161The client selects the encryption algorithm
162to use from those offered by the server.
163Additionally, session integrity is provided
Damien Miller30c3d422000-05-09 11:02:59 +1000164through a cryptographic message authentication code
Damien Millere247cc42000-05-07 12:03:14 +1000165(hmac-sha1 or hmac-md5).
166.Pp
167Protocol version 2 provides a public key based
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000168user (PubkeyAuthentication) or
169client host (HostbasedAuthentication) authentication method,
170conventional password authentication and challenge response based methods.
Damien Millere247cc42000-05-07 12:03:14 +1000171.Ss Command execution and data forwarding
Damien Miller32aa1441999-10-29 09:15:49 +1000172If the client successfully authenticates itself, a dialog for
Damien Miller450a7a12000-03-26 13:04:51 +1000173preparing the session is entered.
174At this time the client may request
Damien Miller32aa1441999-10-29 09:15:49 +1000175things like allocating a pseudo-tty, forwarding X11 connections,
176forwarding TCP/IP connections, or forwarding the authentication agent
177connection over the secure channel.
178.Pp
179Finally, the client either requests a shell or execution of a command.
Damien Miller450a7a12000-03-26 13:04:51 +1000180The sides then enter session mode.
181In this mode, either side may send
Damien Miller32aa1441999-10-29 09:15:49 +1000182data at any time, and such data is forwarded to/from the shell or
183command on the server side, and the user terminal in the client side.
184.Pp
185When the user program terminates and all forwarded X11 and other
186connections have been closed, the server sends command exit status to
187the client, and both sides exit.
188.Pp
189.Nm
Darren Tucker1f203942003-10-15 15:50:42 +1000190can be configured using command-line options or a configuration file
191(by default
192.Xr sshd_config 5 ) .
Damien Miller450a7a12000-03-26 13:04:51 +1000193Command-line options override values specified in the
Damien Miller32aa1441999-10-29 09:15:49 +1000194configuration file.
195.Pp
Damien Miller6162d121999-11-21 13:23:52 +1100196.Nm
197rereads its configuration file when it receives a hangup signal,
Ben Lindstrom49a098d2001-03-05 06:55:18 +0000198.Dv SIGHUP ,
Ben Lindstromd2bf0d62001-06-25 04:10:54 +0000199by executing itself with the name it was started as, i.e.,
Ben Lindstrom49a098d2001-03-05 06:55:18 +0000200.Pa /usr/sbin/sshd .
Damien Miller6162d121999-11-21 13:23:52 +1100201.Pp
Damien Miller32aa1441999-10-29 09:15:49 +1000202The options are as follows:
203.Bl -tag -width Ds
Darren Tucker1f203942003-10-15 15:50:42 +1000204.It Fl 4
205Forces
206.Nm
207to use IPv4 addresses only.
208.It Fl 6
209Forces
210.Nm
211to use IPv6 addresses only.
Damien Miller32aa1441999-10-29 09:15:49 +1000212.It Fl b Ar bits
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000213Specifies the number of bits in the ephemeral protocol version 1
214server key (default 768).
Darren Tucker1f203942003-10-15 15:50:42 +1000215.It Fl D
216When this option is specified,
217.Nm
218will not detach and does not become a daemon.
219This allows easy monitoring of
220.Nm sshd .
Damien Miller32aa1441999-10-29 09:15:49 +1000221.It Fl d
Damien Miller450a7a12000-03-26 13:04:51 +1000222Debug mode.
223The server sends verbose debug output to the system
224log, and does not put itself in the background.
225The server also will not fork and will only process one connection.
226This option is only intended for debugging for the server.
Damien Millerffadc582003-02-24 11:52:26 +1100227Multiple
228.Fl d
229options increase the debugging level.
Damien Miller874d77b2000-10-14 16:23:11 +1100230Maximum is 3.
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000231.It Fl e
232When this option is specified,
233.Nm
234will send the output to the standard error instead of the system log.
Damien Miller32aa1441999-10-29 09:15:49 +1000235.It Fl f Ar configuration_file
Damien Miller450a7a12000-03-26 13:04:51 +1000236Specifies the name of the configuration file.
237The default is
Damien Miller05eda432002-02-10 18:32:28 +1100238.Pa /etc/ssh/sshd_config .
Damien Miller32aa1441999-10-29 09:15:49 +1000239.Nm
240refuses to start if there is no configuration file.
241.It Fl g Ar login_grace_time
242Gives the grace time for clients to authenticate themselves (default
Damien Millerc1348632002-09-05 14:35:14 +1000243120 seconds).
Damien Miller450a7a12000-03-26 13:04:51 +1000244If the client fails to authenticate the user within
245this many seconds, the server disconnects and exits.
246A value of zero indicates no limit.
Damien Miller32aa1441999-10-29 09:15:49 +1000247.It Fl h Ar host_key_file
Damien Miller7fc23732002-01-22 23:19:11 +1100248Specifies a file from which a host key is read.
Damien Miller32aa1441999-10-29 09:15:49 +1000249This option must be given if
250.Nm
251is not run as root (as the normal
Damien Miller7fc23732002-01-22 23:19:11 +1100252host key files are normally not readable by anyone but root).
253The default is
Damien Miller05eda432002-02-10 18:32:28 +1100254.Pa /etc/ssh/ssh_host_key
Damien Miller7fc23732002-01-22 23:19:11 +1100255for protocol version 1, and
Damien Miller05eda432002-02-10 18:32:28 +1100256.Pa /etc/ssh/ssh_host_rsa_key
Damien Miller7fc23732002-01-22 23:19:11 +1100257and
Damien Miller05eda432002-02-10 18:32:28 +1100258.Pa /etc/ssh/ssh_host_dsa_key
Damien Miller7fc23732002-01-22 23:19:11 +1100259for protocol version 2.
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000260It is possible to have multiple host key files for
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000261the different protocol versions and host key algorithms.
Damien Miller32aa1441999-10-29 09:15:49 +1000262.It Fl i
263Specifies that
264.Nm
Damien Millerffadc582003-02-24 11:52:26 +1100265is being run from
266.Xr inetd 8 .
Damien Miller32aa1441999-10-29 09:15:49 +1000267.Nm
268is normally not run
269from inetd because it needs to generate the server key before it can
Damien Miller450a7a12000-03-26 13:04:51 +1000270respond to the client, and this may take tens of seconds.
271Clients would have to wait too long if the key was regenerated every time.
Damien Miller7684ee12000-03-17 23:40:15 +1100272However, with small key sizes (e.g., 512) using
Damien Miller32aa1441999-10-29 09:15:49 +1000273.Nm
274from inetd may
275be feasible.
276.It Fl k Ar key_gen_time
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000277Specifies how often the ephemeral protocol version 1 server key is
278regenerated (default 3600 seconds, or one hour).
Damien Miller450a7a12000-03-26 13:04:51 +1000279The motivation for regenerating the key fairly
Darren Tucker1f203942003-10-15 15:50:42 +1000280often is that the key is not stored anywhere, and after about an hour
Damien Miller32aa1441999-10-29 09:15:49 +1000281it becomes impossible to recover the key for decrypting intercepted
282communications even if the machine is cracked into or physically
Damien Miller450a7a12000-03-26 13:04:51 +1000283seized.
284A value of zero indicates that the key will never be regenerated.
Ben Lindstromade03f62001-12-06 18:22:17 +0000285.It Fl o Ar option
286Can be used to give options in the format used in the configuration file.
287This is useful for specifying options for which there is no separate
288command-line flag.
Darren Tucker1f203942003-10-15 15:50:42 +1000289For full details of the options, and their values, see
290.Xr sshd_config 5 .
Damien Miller32aa1441999-10-29 09:15:49 +1000291.It Fl p Ar port
292Specifies the port on which the server listens for connections
293(default 22).
Damien Miller7d1ded42002-01-22 23:09:41 +1100294Multiple port options are permitted.
295Ports specified in the configuration file are ignored when a
296command-line port is specified.
Damien Miller32aa1441999-10-29 09:15:49 +1000297.It Fl q
Damien Miller450a7a12000-03-26 13:04:51 +1000298Quiet mode.
299Nothing is sent to the system log.
300Normally the beginning,
Damien Miller32aa1441999-10-29 09:15:49 +1000301authentication, and termination of each connection is logged.
Ben Lindstrom794325a2001-08-06 21:09:07 +0000302.It Fl t
303Test mode.
304Only check the validity of the configuration file and sanity of the keys.
Damien Miller9f0f5c62001-12-21 14:45:46 +1100305This is useful for updating
Ben Lindstrom794325a2001-08-06 21:09:07 +0000306.Nm
307reliably as configuration options may change.
Damien Miller942da032000-08-18 13:59:06 +1000308.It Fl u Ar len
309This option is used to specify the size of the field
310in the
311.Li utmp
312structure that holds the remote host name.
313If the resolved host name is longer than
314.Ar len ,
315the dotted decimal value will be used instead.
316This allows hosts with very long host names that
317overflow this field to still be uniquely identified.
318Specifying
319.Fl u0
320indicates that only dotted decimal addresses
321should be put into the
322.Pa utmp
323file.
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000324.Fl u0
Damien Millerffadc582003-02-24 11:52:26 +1100325may also be used to prevent
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000326.Nm
327from making DNS requests unless the authentication
328mechanism or configuration requires it.
329Authentication mechanisms that may require DNS include
Ben Lindstrom6f672c02001-09-12 17:51:55 +0000330.Cm RhostsRSAAuthentication ,
331.Cm HostbasedAuthentication
332and using a
333.Cm from="pattern-list"
334option in a key file.
Ben Lindstromea03db92002-03-05 01:38:57 +0000335Configuration options that require DNS include using a
336USER@HOST pattern in
337.Cm AllowUsers
338or
339.Cm DenyUsers .
Damien Miller32aa1441999-10-29 09:15:49 +1000340.El
341.Sh CONFIGURATION FILE
342.Nm
Damien Miller22c77262000-04-13 12:26:34 +1000343reads configuration data from
Damien Miller05eda432002-02-10 18:32:28 +1100344.Pa /etc/ssh/sshd_config
Damien Miller32aa1441999-10-29 09:15:49 +1000345(or the file specified with
346.Fl f
Damien Miller450a7a12000-03-26 13:04:51 +1000347on the command line).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000348The file format and configuration options are described in
349.Xr sshd_config 5 .
Damien Miller32aa1441999-10-29 09:15:49 +1000350.Sh LOGIN PROCESS
351When a user successfully logs in,
352.Nm
353does the following:
354.Bl -enum -offset indent
355.It
356If the login is on a tty, and no command has been specified,
Damien Miller22c77262000-04-13 12:26:34 +1000357prints last login time and
Damien Miller32aa1441999-10-29 09:15:49 +1000358.Pa /etc/motd
359(unless prevented in the configuration file or by
360.Pa $HOME/.hushlogin ;
361see the
Damien Miller22c77262000-04-13 12:26:34 +1000362.Sx FILES
Damien Miller32aa1441999-10-29 09:15:49 +1000363section).
364.It
365If the login is on a tty, records login time.
366.It
367Checks
368.Pa /etc/nologin ;
369if it exists, prints contents and quits
370(unless root).
371.It
372Changes to run with normal user privileges.
373.It
374Sets up basic environment.
375.It
Darren Tucker1f203942003-10-15 15:50:42 +1000376Reads the file
377.Pa $HOME/.ssh/environment ,
378if it exists, and users are allowed to change their environment.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000379See the
Ben Lindstromdc7adf22002-08-20 18:38:02 +0000380.Cm PermitUserEnvironment
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000381option in
Ben Lindstromdc7adf22002-08-20 18:38:02 +0000382.Xr sshd_config 5 .
Damien Miller32aa1441999-10-29 09:15:49 +1000383.It
384Changes to user's home directory.
385.It
386If
387.Pa $HOME/.ssh/rc
388exists, runs it; else if
Damien Millerafcc2252002-02-10 18:32:55 +1100389.Pa /etc/ssh/sshrc
Damien Miller32aa1441999-10-29 09:15:49 +1000390exists, runs
Damien Miller450a7a12000-03-26 13:04:51 +1000391it; otherwise runs xauth.
392The
Damien Miller32aa1441999-10-29 09:15:49 +1000393.Dq rc
394files are given the X11
395authentication protocol and cookie in standard input.
396.It
397Runs user's shell or command.
398.El
399.Sh AUTHORIZED_KEYS FILE FORMAT
Damien Miller32aa1441999-10-29 09:15:49 +1000400.Pa $HOME/.ssh/authorized_keys
Ben Lindstromf96704d2001-06-25 04:17:12 +0000401is the default file that lists the public keys that are
402permitted for RSA authentication in protocol version 1
403and for public key authentication (PubkeyAuthentication)
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000404in protocol version 2.
Ben Lindstromf96704d2001-06-25 04:17:12 +0000405.Cm AuthorizedKeysFile
Ben Lindstrombfb3a0e2001-06-05 20:25:05 +0000406may be used to specify an alternative file.
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000407.Pp
Damien Miller450a7a12000-03-26 13:04:51 +1000408Each line of the file contains one
Damien Miller32aa1441999-10-29 09:15:49 +1000409key (empty lines and lines starting with a
410.Ql #
411are ignored as
Damien Miller450a7a12000-03-26 13:04:51 +1000412comments).
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000413Each RSA public key consists of the following fields, separated by
Damien Miller450a7a12000-03-26 13:04:51 +1000414spaces: options, bits, exponent, modulus, comment.
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000415Each protocol version 2 public key consists of:
416options, keytype, base64 encoded key, comment.
Damien Millerb83df8d2002-09-04 16:24:55 +1000417The options field
418is optional; its presence is determined by whether the line starts
419with a number or not (the options field never starts with a number).
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000420The bits, exponent, modulus and comment fields give the RSA key for
421protocol version 1; the
Damien Miller32aa1441999-10-29 09:15:49 +1000422comment field is not used for anything (but may be convenient for the
423user to identify the key).
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000424For protocol version 2 the keytype is
425.Dq ssh-dss
426or
427.Dq ssh-rsa .
Damien Miller32aa1441999-10-29 09:15:49 +1000428.Pp
429Note that lines in this file are usually several hundred bytes long
Damien Millerb83df8d2002-09-04 16:24:55 +1000430(because of the size of the public key encoding).
Damien Miller450a7a12000-03-26 13:04:51 +1000431You don't want to type them in; instead, copy the
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000432.Pa identity.pub ,
Ben Lindstrom4dccfa52000-12-28 16:40:05 +0000433.Pa id_dsa.pub
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000434or the
435.Pa id_rsa.pub
Damien Miller32aa1441999-10-29 09:15:49 +1000436file and edit it.
437.Pp
Ben Lindstrom0d0be022002-04-02 20:39:29 +0000438.Nm
439enforces a minimum RSA key modulus size for protocol 1
440and protocol 2 keys of 768 bits.
441.Pp
Damien Miller942da032000-08-18 13:59:06 +1000442The options (if present) consist of comma-separated option
Damien Miller450a7a12000-03-26 13:04:51 +1000443specifications.
444No spaces are permitted, except within double quotes.
Ben Lindstrom1c0fd092001-09-12 16:36:17 +0000445The following option specifications are supported (note
446that option keywords are case-insensitive):
Damien Miller32aa1441999-10-29 09:15:49 +1000447.Bl -tag -width Ds
448.It Cm from="pattern-list"
Damien Millerb83df8d2002-09-04 16:24:55 +1000449Specifies that in addition to public key authentication, the canonical name
Damien Miller32aa1441999-10-29 09:15:49 +1000450of the remote host must be present in the comma-separated list of
Damien Miller450a7a12000-03-26 13:04:51 +1000451patterns
Damien Miller31554322003-05-14 13:44:58 +1000452.Pf ( Ql \&*
Damien Miller450a7a12000-03-26 13:04:51 +1000453and
Damien Miller049245d2003-05-14 13:44:42 +1000454.Ql \&?
Damien Miller450a7a12000-03-26 13:04:51 +1000455serve as wildcards).
456The list may also contain
457patterns negated by prefixing them with
Damien Miller049245d2003-05-14 13:44:42 +1000458.Ql \&! ;
Damien Miller450a7a12000-03-26 13:04:51 +1000459if the canonical host name matches a negated pattern, the key is not accepted.
460The purpose
Damien Millerb83df8d2002-09-04 16:24:55 +1000461of this option is to optionally increase security: public key authentication
Damien Miller32aa1441999-10-29 09:15:49 +1000462by itself does not trust the network or name servers or anything (but
463the key); however, if somebody somehow steals the key, the key
Damien Miller450a7a12000-03-26 13:04:51 +1000464permits an intruder to log in from anywhere in the world.
465This additional option makes using a stolen key more difficult (name
Damien Miller32aa1441999-10-29 09:15:49 +1000466servers and/or routers would have to be compromised in addition to
467just the key).
468.It Cm command="command"
469Specifies that the command is executed whenever this key is used for
Damien Miller450a7a12000-03-26 13:04:51 +1000470authentication.
471The command supplied by the user (if any) is ignored.
Ben Lindstrom23124ea2001-09-14 23:14:25 +0000472The command is run on a pty if the client requests a pty;
Damien Miller450a7a12000-03-26 13:04:51 +1000473otherwise it is run without a tty.
Damien Millerffadc582003-02-24 11:52:26 +1100474If an 8-bit clean channel is required,
Ben Lindstrom594e2032001-09-12 18:35:30 +0000475one must not request a pty or should specify
Damien Miller33804262001-02-04 23:20:18 +1100476.Cm no-pty .
Damien Miller450a7a12000-03-26 13:04:51 +1000477A quote may be included in the command by quoting it with a backslash.
478This option might be useful
Damien Millerb83df8d2002-09-04 16:24:55 +1000479to restrict certain public keys to perform just a specific operation.
Damien Miller450a7a12000-03-26 13:04:51 +1000480An example might be a key that permits remote backups but nothing else.
Damien Miller30c3d422000-05-09 11:02:59 +1000481Note that the client may specify TCP/IP and/or X11
482forwarding unless they are explicitly prohibited.
Ben Lindstrom20daef72001-09-20 00:54:01 +0000483Note that this option applies to shell, command or subsystem execution.
Damien Miller32aa1441999-10-29 09:15:49 +1000484.It Cm environment="NAME=value"
485Specifies that the string is to be added to the environment when
Damien Miller450a7a12000-03-26 13:04:51 +1000486logging in using this key.
487Environment variables set this way
488override other default environment values.
489Multiple options of this type are permitted.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000490Environment processing is disabled by default and is
491controlled via the
492.Cm PermitUserEnvironment
493option.
Ben Lindstrom38b951c2001-12-06 17:47:47 +0000494This option is automatically disabled if
495.Cm UseLogin
496is enabled.
Damien Miller32aa1441999-10-29 09:15:49 +1000497.It Cm no-port-forwarding
498Forbids TCP/IP forwarding when this key is used for authentication.
Damien Miller450a7a12000-03-26 13:04:51 +1000499Any port forward requests by the client will return an error.
500This might be used, e.g., in connection with the
Damien Miller32aa1441999-10-29 09:15:49 +1000501.Cm command
502option.
503.It Cm no-X11-forwarding
504Forbids X11 forwarding when this key is used for authentication.
505Any X11 forward requests by the client will return an error.
506.It Cm no-agent-forwarding
507Forbids authentication agent forwarding when this key is used for
508authentication.
509.It Cm no-pty
510Prevents tty allocation (a request to allocate a pty will fail).
Damien Millera243fde2001-03-19 23:16:08 +1100511.It Cm permitopen="host:port"
Ben Lindstrom24643222001-06-25 05:08:11 +0000512Limit local
Damien Millera243fde2001-03-19 23:16:08 +1100513.Li ``ssh -L''
Ben Lindstrom4b3564e2001-04-10 02:41:56 +0000514port forwarding such that it may only connect to the specified host and
Ben Lindstromd71ba572001-09-12 18:03:31 +0000515port.
516IPv6 addresses can be specified with an alternative syntax:
Darren Tucker1f203942003-10-15 15:50:42 +1000517.Ar host Ns / Ns Ar port .
Ben Lindstromd71ba572001-09-12 18:03:31 +0000518Multiple
Damien Millera243fde2001-03-19 23:16:08 +1100519.Cm permitopen
Damien Millerfbf486b2003-05-23 18:44:23 +1000520options may be applied separated by commas.
521No pattern matching is performed on the specified hostnames,
522they must be literal domains or addresses.
Damien Miller32aa1441999-10-29 09:15:49 +1000523.El
524.Ss Examples
Darren Tucker1f203942003-10-15 15:50:42 +10005251024 33 12121...312314325 ylo@foo.bar
Damien Miller32aa1441999-10-29 09:15:49 +1000526.Pp
Darren Tucker1f203942003-10-15 15:50:42 +1000527from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23...2334 ylo@niksula
Damien Miller32aa1441999-10-29 09:15:49 +1000528.Pp
Darren Tucker1f203942003-10-15 15:50:42 +1000529command="dump /home",no-pty,no-port-forwarding 1024 33 23...2323 backup.hut.fi
Damien Millera243fde2001-03-19 23:16:08 +1100530.Pp
Darren Tucker1f203942003-10-15 15:50:42 +1000531permitopen="10.2.1.55:80",permitopen="10.2.1.56:25" 1024 33 23...2323
Damien Miller32aa1441999-10-29 09:15:49 +1000532.Sh SSH_KNOWN_HOSTS FILE FORMAT
Damien Miller22c77262000-04-13 12:26:34 +1000533The
Damien Millerffadc582003-02-24 11:52:26 +1100534.Pa /etc/ssh/ssh_known_hosts
Damien Miller22c77262000-04-13 12:26:34 +1000535and
Ben Lindstromd6481ea2001-06-25 04:37:41 +0000536.Pa $HOME/.ssh/known_hosts
Damien Miller450a7a12000-03-26 13:04:51 +1000537files contain host public keys for all known hosts.
538The global file should
539be prepared by the administrator (optional), and the per-user file is
Damien Miller942da032000-08-18 13:59:06 +1000540maintained automatically: whenever the user connects from an unknown host
Damien Miller450a7a12000-03-26 13:04:51 +1000541its key is added to the per-user file.
Damien Miller32aa1441999-10-29 09:15:49 +1000542.Pp
543Each line in these files contains the following fields: hostnames,
Damien Miller450a7a12000-03-26 13:04:51 +1000544bits, exponent, modulus, comment.
545The fields are separated by spaces.
Damien Miller32aa1441999-10-29 09:15:49 +1000546.Pp
Damien Miller31554322003-05-14 13:44:58 +1000547Hostnames is a comma-separated list of patterns
Damien Millerfbf486b2003-05-23 18:44:23 +1000548.Pf ( Ql \&*
549and
550.Ql \&?
Damien Miller049245d2003-05-14 13:44:42 +1000551act as
Damien Miller32aa1441999-10-29 09:15:49 +1000552wildcards); each pattern in turn is matched against the canonical host
553name (when authenticating a client) or against the user-supplied
Damien Miller450a7a12000-03-26 13:04:51 +1000554name (when authenticating a server).
555A pattern may also be preceded by
Damien Miller049245d2003-05-14 13:44:42 +1000556.Ql \&!
Damien Miller32aa1441999-10-29 09:15:49 +1000557to indicate negation: if the host name matches a negated
558pattern, it is not accepted (by that line) even if it matched another
559pattern on the line.
560.Pp
Damien Millere247cc42000-05-07 12:03:14 +1000561Bits, exponent, and modulus are taken directly from the RSA host key; they
Damien Miller32aa1441999-10-29 09:15:49 +1000562can be obtained, e.g., from
Damien Miller05eda432002-02-10 18:32:28 +1100563.Pa /etc/ssh/ssh_host_key.pub .
Damien Miller32aa1441999-10-29 09:15:49 +1000564The optional comment field continues to the end of the line, and is not used.
565.Pp
566Lines starting with
567.Ql #
568and empty lines are ignored as comments.
569.Pp
570When performing host authentication, authentication is accepted if any
Damien Miller450a7a12000-03-26 13:04:51 +1000571matching line has the proper key.
572It is thus permissible (but not
Damien Miller32aa1441999-10-29 09:15:49 +1000573recommended) to have several lines or different host keys for the same
Damien Miller450a7a12000-03-26 13:04:51 +1000574names.
575This will inevitably happen when short forms of host names
576from different domains are put in the file.
577It is possible
Damien Miller32aa1441999-10-29 09:15:49 +1000578that the files contain conflicting information; authentication is
579accepted if valid information can be found from either file.
580.Pp
581Note that the lines in these files are typically hundreds of characters
582long, and you definitely don't want to type in the host keys by hand.
583Rather, generate them by a script
Damien Miller22c77262000-04-13 12:26:34 +1000584or by taking
Damien Miller05eda432002-02-10 18:32:28 +1100585.Pa /etc/ssh/ssh_host_key.pub
Damien Miller32aa1441999-10-29 09:15:49 +1000586and adding the host names at the front.
587.Ss Examples
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000588.Bd -literal
Darren Tucker1f203942003-10-15 15:50:42 +1000589closenet,...,130.233.208.41 1024 37 159...93 closenet.hut.fi
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000590cvs.openbsd.org,199.185.137.3 ssh-rsa AAAA1234.....=
591.Ed
Damien Miller32aa1441999-10-29 09:15:49 +1000592.Sh FILES
593.Bl -tag -width Ds
Damien Miller05eda432002-02-10 18:32:28 +1100594.It Pa /etc/ssh/sshd_config
Damien Miller32aa1441999-10-29 09:15:49 +1000595Contains configuration data for
596.Nm sshd .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000597The file format and configuration options are described in
598.Xr sshd_config 5 .
Damien Miller05eda432002-02-10 18:32:28 +1100599.It Pa /etc/ssh/ssh_host_key, /etc/ssh/ssh_host_dsa_key, /etc/ssh/ssh_host_rsa_key
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000600These three files contain the private parts of the host keys.
Ben Lindstromd7f5b512001-03-05 06:57:23 +0000601These files should only be owned by root, readable only by root, and not
Damien Miller32aa1441999-10-29 09:15:49 +1000602accessible to others.
603Note that
604.Nm
605does not start if this file is group/world-accessible.
Damien Miller05eda432002-02-10 18:32:28 +1100606.It Pa /etc/ssh/ssh_host_key.pub, /etc/ssh/ssh_host_dsa_key.pub, /etc/ssh/ssh_host_rsa_key.pub
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000607These three files contain the public parts of the host keys.
Ben Lindstromd7f5b512001-03-05 06:57:23 +0000608These files should be world-readable but writable only by
Damien Miller450a7a12000-03-26 13:04:51 +1000609root.
Ben Lindstromd7f5b512001-03-05 06:57:23 +0000610Their contents should match the respective private parts.
611These files are not
612really used for anything; they are provided for the convenience of
613the user so their contents can be copied to known hosts files.
614These files are created using
Damien Miller32aa1441999-10-29 09:15:49 +1000615.Xr ssh-keygen 1 .
Ben Lindstromae1c51c2001-06-25 04:14:59 +0000616.It Pa /etc/moduli
Damien Millere39cacc2000-11-29 12:18:44 +1100617Contains Diffie-Hellman groups used for the "Diffie-Hellman Group Exchange".
Damien Miller86247e22002-09-19 11:51:53 +1000618The file format is described in
619.Xr moduli 5 .
Ben Lindstrom624e3f22002-06-23 00:32:57 +0000620.It Pa /var/empty
621.Xr chroot 2
622directory used by
623.Nm
624during privilege separation in the pre-authentication phase.
625The directory should not contain any files and must be owned by root
626and not group or world-writable.
Damien Miller886c63a2000-01-20 23:13:36 +1100627.It Pa /var/run/sshd.pid
Damien Miller32aa1441999-10-29 09:15:49 +1000628Contains the process ID of the
629.Nm
630listening for connections (if there are several daemons running
Ben Lindstrom959de992002-06-23 00:35:25 +0000631concurrently for different ports, this contains the process ID of the one
Damien Miller450a7a12000-03-26 13:04:51 +1000632started last).
Damien Miller942da032000-08-18 13:59:06 +1000633The content of this file is not sensitive; it can be world-readable.
Damien Miller32aa1441999-10-29 09:15:49 +1000634.It Pa $HOME/.ssh/authorized_keys
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000635Lists the public keys (RSA or DSA) that can be used to log into the user's account.
Damien Millere247cc42000-05-07 12:03:14 +1000636This file must be readable by root (which may on some machines imply
637it being world-readable if the user's home directory resides on an NFS
638volume).
639It is recommended that it not be accessible by others.
640The format of this file is described above.
641Users will place the contents of their
Ben Lindstromf96704d2001-06-25 04:17:12 +0000642.Pa identity.pub ,
Damien Millere247cc42000-05-07 12:03:14 +1000643.Pa id_dsa.pub
Ben Lindstrom18a82ac2001-04-11 15:59:35 +0000644and/or
645.Pa id_rsa.pub
Damien Millere247cc42000-05-07 12:03:14 +1000646files into this file, as described in
647.Xr ssh-keygen 1 .
Darren Tucker1f203942003-10-15 15:50:42 +1000648.It Pa "/etc/ssh/ssh_known_hosts", "$HOME/.ssh/known_hosts"
Damien Miller5ce662a1999-11-11 17:57:39 +1100649These files are consulted when using rhosts with RSA host
Ben Lindstromd6481ea2001-06-25 04:37:41 +0000650authentication or protocol version 2 hostbased authentication
651to check the public key of the host.
Damien Miller450a7a12000-03-26 13:04:51 +1000652The key must be listed in one of these files to be accepted.
Damien Miller33e511e1999-11-11 11:43:13 +1100653The client uses the same files
Ben Lindstromebd888d2001-03-05 05:49:29 +0000654to verify that it is connecting to the correct remote host.
Damien Miller450a7a12000-03-26 13:04:51 +1000655These files should be writable only by root/the owner.
Damien Miller05eda432002-02-10 18:32:28 +1100656.Pa /etc/ssh/ssh_known_hosts
Damien Miller32aa1441999-10-29 09:15:49 +1000657should be world-readable, and
658.Pa $HOME/.ssh/known_hosts
Damien Millerffadc582003-02-24 11:52:26 +1100659can, but need not be, world-readable.
Damien Miller32aa1441999-10-29 09:15:49 +1000660.It Pa /etc/nologin
Damien Miller22c77262000-04-13 12:26:34 +1000661If this file exists,
Damien Miller32aa1441999-10-29 09:15:49 +1000662.Nm
Damien Miller450a7a12000-03-26 13:04:51 +1000663refuses to let anyone except root log in.
664The contents of the file
Damien Miller32aa1441999-10-29 09:15:49 +1000665are displayed to anyone trying to log in, and non-root connections are
Damien Miller450a7a12000-03-26 13:04:51 +1000666refused.
667The file should be world-readable.
Damien Miller32aa1441999-10-29 09:15:49 +1000668.It Pa /etc/hosts.allow, /etc/hosts.deny
Ben Lindstrom6149a6c2001-10-03 17:15:32 +0000669Access controls that should be enforced by tcp-wrappers are defined here.
670Further details are described in
Damien Miller32aa1441999-10-29 09:15:49 +1000671.Xr hosts_access 5 .
672.It Pa $HOME/.rhosts
673This file contains host-username pairs, separated by a space, one per
Damien Miller450a7a12000-03-26 13:04:51 +1000674line.
675The given user on the corresponding host is permitted to log in
Damien Millerffadc582003-02-24 11:52:26 +1100676without a password.
Damien Miller450a7a12000-03-26 13:04:51 +1000677The same file is used by rlogind and rshd.
Damien Miller32aa1441999-10-29 09:15:49 +1000678The file must
679be writable only by the user; it is recommended that it not be
680accessible by others.
681.Pp
Darren Tucker1f203942003-10-15 15:50:42 +1000682It is also possible to use netgroups in the file.
Damien Miller450a7a12000-03-26 13:04:51 +1000683Either host or user
Damien Miller32aa1441999-10-29 09:15:49 +1000684name may be of the form +@groupname to specify all hosts or all users
685in the group.
686.It Pa $HOME/.shosts
687For ssh,
688this file is exactly the same as for
689.Pa .rhosts .
690However, this file is
691not used by rlogin and rshd, so using this permits access using SSH only.
Damien Miller942da032000-08-18 13:59:06 +1000692.It Pa /etc/hosts.equiv
Damien Miller32aa1441999-10-29 09:15:49 +1000693This file is used during
Darren Tucker1f203942003-10-15 15:50:42 +1000694.Em rhosts
Damien Miller450a7a12000-03-26 13:04:51 +1000695authentication.
696In the simplest form, this file contains host names, one per line.
697Users on
Damien Miller32aa1441999-10-29 09:15:49 +1000698those hosts are permitted to log in without a password, provided they
Damien Miller450a7a12000-03-26 13:04:51 +1000699have the same user name on both machines.
700The host name may also be
Damien Miller32aa1441999-10-29 09:15:49 +1000701followed by a user name; such users are permitted to log in as
702.Em any
Damien Miller450a7a12000-03-26 13:04:51 +1000703user on this machine (except root).
704Additionally, the syntax
Damien Miller32aa1441999-10-29 09:15:49 +1000705.Dq +@group
Damien Miller450a7a12000-03-26 13:04:51 +1000706can be used to specify netgroups.
707Negated entries start with
Damien Miller32aa1441999-10-29 09:15:49 +1000708.Ql \&- .
709.Pp
710If the client host/user is successfully matched in this file, login is
711automatically permitted provided the client and server user names are the
Damien Miller450a7a12000-03-26 13:04:51 +1000712same.
713Additionally, successful RSA host authentication is normally required.
714This file must be writable only by root; it is recommended
Damien Miller32aa1441999-10-29 09:15:49 +1000715that it be world-readable.
716.Pp
717.Sy "Warning: It is almost never a good idea to use user names in"
718.Pa hosts.equiv .
719Beware that it really means that the named user(s) can log in as
720.Em anybody ,
721which includes bin, daemon, adm, and other accounts that own critical
Damien Miller450a7a12000-03-26 13:04:51 +1000722binaries and directories.
723Using a user name practically grants the user root access.
724The only valid use for user names that I can think
Damien Miller32aa1441999-10-29 09:15:49 +1000725of is in negative entries.
726.Pp
727Note that this warning also applies to rsh/rlogin.
Damien Miller886c63a2000-01-20 23:13:36 +1100728.It Pa /etc/shosts.equiv
Damien Miller32aa1441999-10-29 09:15:49 +1000729This is processed exactly as
730.Pa /etc/hosts.equiv .
731However, this file may be useful in environments that want to run both
732rsh/rlogin and ssh.
733.It Pa $HOME/.ssh/environment
Damien Miller450a7a12000-03-26 13:04:51 +1000734This file is read into the environment at login (if it exists).
735It can only contain empty lines, comment lines (that start with
Damien Miller32aa1441999-10-29 09:15:49 +1000736.Ql # ) ,
Damien Miller450a7a12000-03-26 13:04:51 +1000737and assignment lines of the form name=value.
738The file should be writable
Damien Miller32aa1441999-10-29 09:15:49 +1000739only by the user; it need not be readable by anyone else.
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000740Environment processing is disabled by default and is
741controlled via the
742.Cm PermitUserEnvironment
743option.
Damien Miller32aa1441999-10-29 09:15:49 +1000744.It Pa $HOME/.ssh/rc
Damien Millerffadc582003-02-24 11:52:26 +1100745If this file exists, it is run with
746.Pa /bin/sh
747after reading the
Damien Miller450a7a12000-03-26 13:04:51 +1000748environment files but before starting the user's shell or command.
Ben Lindstroma11e2702002-04-05 22:18:48 +0000749It must not produce any output on stdout; stderr must be used
750instead.
751If X11 forwarding is in use, it will receive the "proto cookie" pair in
752its standard input (and
Damien Miller32aa1441999-10-29 09:15:49 +1000753.Ev DISPLAY
Ben Lindstroma11e2702002-04-05 22:18:48 +0000754in its environment).
755The script must call
Damien Miller32aa1441999-10-29 09:15:49 +1000756.Xr xauth 1
Ben Lindstroma11e2702002-04-05 22:18:48 +0000757because
758.Nm
759will not run xauth automatically to add X11 cookies.
Damien Miller32aa1441999-10-29 09:15:49 +1000760.Pp
761The primary purpose of this file is to run any initialization routines
762which may be needed before the user's home directory becomes
763accessible; AFS is a particular example of such an environment.
764.Pp
765This file will probably contain some initialization code followed by
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000766something similar to:
767.Bd -literal
Ben Lindstroma11e2702002-04-05 22:18:48 +0000768if read proto cookie && [ -n "$DISPLAY" ]; then
769 if [ `echo $DISPLAY | cut -c1-10` = 'localhost:' ]; then
770 # X11UseLocalhost=yes
Damien Millerdcbb6c22002-09-25 12:20:52 +1000771 echo add unix:`echo $DISPLAY |
Ben Lindstroma11e2702002-04-05 22:18:48 +0000772 cut -c11-` $proto $cookie
773 else
774 # X11UseLocalhost=no
Damien Millerdcbb6c22002-09-25 12:20:52 +1000775 echo add $DISPLAY $proto $cookie
776 fi | xauth -q -
Ben Lindstroma11e2702002-04-05 22:18:48 +0000777fi
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000778.Ed
Damien Miller32aa1441999-10-29 09:15:49 +1000779.Pp
780If this file does not exist,
Damien Miller05eda432002-02-10 18:32:28 +1100781.Pa /etc/ssh/sshrc
Damien Miller32aa1441999-10-29 09:15:49 +1000782is run, and if that
Ben Lindstroma11e2702002-04-05 22:18:48 +0000783does not exist either, xauth is used to add the cookie.
Damien Miller32aa1441999-10-29 09:15:49 +1000784.Pp
785This file should be writable only by the user, and need not be
786readable by anyone else.
Damien Miller05eda432002-02-10 18:32:28 +1100787.It Pa /etc/ssh/sshrc
Damien Miller32aa1441999-10-29 09:15:49 +1000788Like
789.Pa $HOME/.ssh/rc .
790This can be used to specify
Damien Miller450a7a12000-03-26 13:04:51 +1000791machine-specific login-time initializations globally.
792This file should be writable only by root, and should be world-readable.
Damien Miller37023962000-07-11 17:31:38 +1000793.El
Damien Miller32aa1441999-10-29 09:15:49 +1000794.Sh SEE ALSO
Damien Miller32aa1441999-10-29 09:15:49 +1000795.Xr scp 1 ,
Damien Miller33804262001-02-04 23:20:18 +1100796.Xr sftp 1 ,
Damien Miller32aa1441999-10-29 09:15:49 +1000797.Xr ssh 1 ,
798.Xr ssh-add 1 ,
799.Xr ssh-agent 1 ,
800.Xr ssh-keygen 1 ,
Darren Tucker1f203942003-10-15 15:50:42 +1000801.Xr chroot 2 ,
802.Xr hosts_access 5 ,
Ben Lindstromc8e29ce2001-08-06 20:55:28 +0000803.Xr login.conf 5 ,
804.Xr moduli 5 ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000805.Xr sshd_config 5 ,
Darren Tucker1f203942003-10-15 15:50:42 +1000806.Xr inetd 8 ,
Ben Lindstromd2bf0d62001-06-25 04:10:54 +0000807.Xr sftp-server 8
Ben Lindstrom160ec622001-04-22 17:17:46 +0000808.Rs
809.%A T. Ylonen
810.%A T. Kivinen
811.%A M. Saarinen
812.%A T. Rinne
813.%A S. Lehtinen
814.%T "SSH Protocol Architecture"
Ben Lindstromf1813842002-03-27 17:18:31 +0000815.%N draft-ietf-secsh-architecture-12.txt
816.%D January 2002
Ben Lindstrom160ec622001-04-22 17:17:46 +0000817.%O work in progress material
818.Re
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000819.Rs
820.%A M. Friedl
821.%A N. Provos
822.%A W. A. Simpson
823.%T "Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol"
Ben Lindstromf1813842002-03-27 17:18:31 +0000824.%N draft-ietf-secsh-dh-group-exchange-02.txt
825.%D January 2002
Ben Lindstromc65e6a02001-04-23 13:02:16 +0000826.%O work in progress material
827.Re
Damien Millerf1ce5052003-06-11 22:04:39 +1000828.Sh AUTHORS
829OpenSSH is a derivative of the original and free
830ssh 1.2.12 release by Tatu Ylonen.
831Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
832Theo de Raadt and Dug Song
833removed many bugs, re-added newer features and
834created OpenSSH.
835Markus Friedl contributed the support for SSH
836protocol versions 1.5 and 2.0.
837Niels Provos and Markus Friedl contributed support
838for privilege separation.