blob: 8c714444b5023898690e4e02236adbd300533372 [file] [log] [blame]
Ben Lindstrom9f049032002-06-21 00:59:05 +00001.\" -*- nroff -*-
2.\"
3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
7.\" As far as I am concerned, the code I have written for this software
8.\" can be used freely for any purpose. Any derived versions of this
9.\" software must be clearly marked as such, and if the derived work is
10.\" incompatible with the protocol description in the RFC file, it must be
11.\" called by a name other than "ssh" or "Secure Shell".
12.\"
13.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
14.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
15.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
16.\"
17.\" Redistribution and use in source and binary forms, with or without
18.\" modification, are permitted provided that the following conditions
19.\" are met:
20.\" 1. Redistributions of source code must retain the above copyright
21.\" notice, this list of conditions and the following disclaimer.
22.\" 2. Redistributions in binary form must reproduce the above copyright
23.\" notice, this list of conditions and the following disclaimer in the
24.\" documentation and/or other materials provided with the distribution.
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.
36.\"
Damien Millerf4f22b52006-03-15 11:57:25 +110037.\" $OpenBSD: sshd_config.5,v 1.53 2006/02/24 23:51:17 jmc Exp $
Ben Lindstrom9f049032002-06-21 00:59:05 +000038.Dd September 25, 1999
39.Dt SSHD_CONFIG 5
40.Os
41.Sh NAME
42.Nm sshd_config
43.Nd OpenSSH SSH daemon configuration file
44.Sh SYNOPSIS
45.Bl -tag -width Ds -compact
46.It Pa /etc/ssh/sshd_config
47.El
48.Sh DESCRIPTION
Damien Millerf4f22b52006-03-15 11:57:25 +110049.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +000050reads configuration data from
51.Pa /etc/ssh/sshd_config
52(or the file specified with
53.Fl f
54on the command line).
55The file contains keyword-argument pairs, one per line.
56Lines starting with
57.Ql #
58and empty lines are interpreted as comments.
59.Pp
60The possible
61keywords and their meanings are as follows (note that
62keywords are case-insensitive and arguments are case-sensitive):
63.Bl -tag -width Ds
Darren Tucker46bc0752004-05-02 22:11:30 +100064.It Cm AcceptEnv
65Specifies what environment variables sent by the client will be copied into
66the session's
67.Xr environ 7 .
68See
69.Cm SendEnv
70in
71.Xr ssh_config 5
72for how to configure the client.
Darren Tucker1e0c9bf2004-05-02 22:12:48 +100073Note that environment passing is only supported for protocol 2.
Darren Tucker46bc0752004-05-02 22:11:30 +100074Variables are specified by name, which may contain the wildcard characters
Damien Miller208f1ed2006-03-15 11:56:03 +110075.Ql *
Darren Tucker46bc0752004-05-02 22:11:30 +100076and
77.Ql \&? .
Darren Tucker1e0c9bf2004-05-02 22:12:48 +100078Multiple environment variables may be separated by whitespace or spread
Darren Tucker46bc0752004-05-02 22:11:30 +100079across multiple
80.Cm AcceptEnv
81directives.
Darren Tucker1e0c9bf2004-05-02 22:12:48 +100082Be warned that some environment variables could be used to bypass restricted
Darren Tucker46bc0752004-05-02 22:11:30 +100083user environments.
84For this reason, care should be taken in the use of this directive.
85The default is not to accept any environment variables.
Darren Tucker0f383232005-01-20 10:57:56 +110086.It Cm AddressFamily
87Specifies which address family should be used by
Damien Millerf4f22b52006-03-15 11:57:25 +110088.Xr sshd 8 .
Darren Tucker0f383232005-01-20 10:57:56 +110089Valid arguments are
90.Dq any ,
91.Dq inet
Damien Miller5b0d63f2006-03-15 11:56:56 +110092(use IPv4 only), or
Darren Tucker0f383232005-01-20 10:57:56 +110093.Dq inet6
94(use IPv6 only).
95The default is
96.Dq any .
Ben Lindstrom9f049032002-06-21 00:59:05 +000097.It Cm AllowGroups
98This keyword can be followed by a list of group name patterns, separated
99by spaces.
100If specified, login is allowed only for users whose primary
101group or supplementary group list matches one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000102Only group names are valid; a numerical group ID is not recognized.
103By default, login is allowed for all groups.
Damien Miller0c2079d2006-03-15 11:54:21 +1100104.Pp
105See
106.Sx PATTERNS
107in
108.Xr ssh_config 5
109for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000110.It Cm AllowTcpForwarding
111Specifies whether TCP forwarding is permitted.
112The default is
113.Dq yes .
114Note that disabling TCP forwarding does not improve security unless
115users are also denied shell access, as they can always install their
116own forwarders.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000117.It Cm AllowUsers
118This keyword can be followed by a list of user name patterns, separated
119by spaces.
Damien Miller5a93add2003-01-24 11:34:52 +1100120If specified, login is allowed only for user names that
Ben Lindstrom9f049032002-06-21 00:59:05 +0000121match one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000122Only user names are valid; a numerical user ID is not recognized.
123By default, login is allowed for all users.
124If the pattern takes the form USER@HOST then USER and HOST
125are separately checked, restricting logins to particular
126users from particular hosts.
Damien Miller0c2079d2006-03-15 11:54:21 +1100127.Pp
128See
129.Sx PATTERNS
130in
131.Xr ssh_config 5
132for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000133.It Cm AuthorizedKeysFile
134Specifies the file that contains the public keys that can be used
135for user authentication.
136.Cm AuthorizedKeysFile
137may contain tokens of the form %T which are substituted during connection
Damien Miller5b0d63f2006-03-15 11:56:56 +1100138setup.
Damien Millerfbf486b2003-05-23 18:44:23 +1000139The following tokens are defined: %% is replaced by a literal '%',
Damien Miller5b0d63f2006-03-15 11:56:56 +1100140%h is replaced by the home directory of the user being authenticated, and
Ben Lindstrom9f049032002-06-21 00:59:05 +0000141%u is replaced by the username of that user.
142After expansion,
143.Cm AuthorizedKeysFile
144is taken to be an absolute path or one relative to the user's home
145directory.
146The default is
147.Dq .ssh/authorized_keys .
148.It Cm Banner
149In some jurisdictions, sending a warning message before authentication
150may be relevant for getting legal protection.
151The contents of the specified file are sent to the remote user before
152authentication is allowed.
153This option is only available for protocol version 2.
154By default, no banner is displayed.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000155.It Cm ChallengeResponseAuthentication
Damien Miller1faa7132006-03-15 11:55:31 +1100156Specifies whether challenge-response authentication is allowed.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000157All authentication styles from
158.Xr login.conf 5
159are supported.
160The default is
161.Dq yes .
162.It Cm Ciphers
163Specifies the ciphers allowed for protocol version 2.
164Multiple ciphers must be comma-separated.
Damien Miller05202ff2004-06-15 10:30:39 +1000165The supported ciphers are
166.Dq 3des-cbc ,
167.Dq aes128-cbc ,
168.Dq aes192-cbc ,
169.Dq aes256-cbc ,
170.Dq aes128-ctr ,
171.Dq aes192-ctr ,
172.Dq aes256-ctr ,
Damien Miller3710f272005-05-26 12:19:17 +1000173.Dq arcfour128 ,
174.Dq arcfour256 ,
Damien Miller05202ff2004-06-15 10:30:39 +1000175.Dq arcfour ,
176.Dq blowfish-cbc ,
177and
178.Dq cast128-cbc .
Damien Miller5b0d63f2006-03-15 11:56:56 +1100179The default is:
180.Bd -literal -offset 3n
181aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
182arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
183aes192-ctr,aes256-ctr
Ben Lindstrom9f049032002-06-21 00:59:05 +0000184.Ed
Ben Lindstrom9f049032002-06-21 00:59:05 +0000185.It Cm ClientAliveCountMax
Damien Millerb7977702006-01-03 18:47:31 +1100186Sets the number of client alive messages (see below) which may be
Ben Lindstrom9f049032002-06-21 00:59:05 +0000187sent without
Damien Miller5b0d63f2006-03-15 11:56:56 +1100188.Xr sshd 8
Damien Millerfbf486b2003-05-23 18:44:23 +1000189receiving any messages back from the client.
190If this threshold is reached while client alive messages are being sent,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100191sshd will disconnect the client, terminating the session.
Damien Millerfbf486b2003-05-23 18:44:23 +1000192It is important to note that the use of client alive messages is very
193different from
Damien Miller12c150e2003-12-17 16:31:10 +1100194.Cm TCPKeepAlive
Damien Millerfbf486b2003-05-23 18:44:23 +1000195(below).
196The client alive messages are sent through the encrypted channel
197and therefore will not be spoofable.
198The TCP keepalive option enabled by
Damien Miller12c150e2003-12-17 16:31:10 +1100199.Cm TCPKeepAlive
Damien Millerfbf486b2003-05-23 18:44:23 +1000200is spoofable.
201The client alive mechanism is valuable when the client or
Ben Lindstrom9f049032002-06-21 00:59:05 +0000202server depend on knowing when a connection has become inactive.
203.Pp
Damien Millerfbf486b2003-05-23 18:44:23 +1000204The default value is 3.
205If
Ben Lindstrom9f049032002-06-21 00:59:05 +0000206.Cm ClientAliveInterval
Damien Millerb7977702006-01-03 18:47:31 +1100207(see below) is set to 15, and
Ben Lindstrom9f049032002-06-21 00:59:05 +0000208.Cm ClientAliveCountMax
Damien Miller5b0d63f2006-03-15 11:56:56 +1100209is left at the default, unresponsive SSH clients
Ben Lindstrom9f049032002-06-21 00:59:05 +0000210will be disconnected after approximately 45 seconds.
Damien Miller1594ad52005-05-26 12:12:19 +1000211.It Cm ClientAliveInterval
212Sets a timeout interval in seconds after which if no data has been received
213from the client,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100214.Xr sshd 8
Damien Miller1594ad52005-05-26 12:12:19 +1000215will send a message through the encrypted
216channel to request a response from the client.
217The default
218is 0, indicating that these messages will not be sent to the client.
219This option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000220.It Cm Compression
Damien Miller9786e6e2005-07-26 21:54:56 +1000221Specifies whether compression is allowed, or delayed until
222the user has authenticated successfully.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000223The argument must be
Damien Miller9786e6e2005-07-26 21:54:56 +1000224.Dq yes ,
225.Dq delayed ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000226or
227.Dq no .
228The default is
Damien Miller9786e6e2005-07-26 21:54:56 +1000229.Dq delayed .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000230.It Cm DenyGroups
231This keyword can be followed by a list of group name patterns, separated
232by spaces.
233Login is disallowed for users whose primary group or supplementary
234group list matches one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000235Only group names are valid; a numerical group ID is not recognized.
236By default, login is allowed for all groups.
Damien Miller0c2079d2006-03-15 11:54:21 +1100237.Pp
238See
239.Sx PATTERNS
240in
241.Xr ssh_config 5
242for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000243.It Cm DenyUsers
244This keyword can be followed by a list of user name patterns, separated
245by spaces.
246Login is disallowed for user names that match one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000247Only user names are valid; a numerical user ID is not recognized.
248By default, login is allowed for all users.
249If the pattern takes the form USER@HOST then USER and HOST
250are separately checked, restricting logins to particular
251users from particular hosts.
Damien Miller0c2079d2006-03-15 11:54:21 +1100252.Pp
253See
254.Sx PATTERNS
255in
256.Xr ssh_config 5
257for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000258.It Cm GatewayPorts
259Specifies whether remote hosts are allowed to connect to ports
260forwarded for the client.
261By default,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100262.Xr sshd 8
Damien Miller495dca32003-04-01 21:42:14 +1000263binds remote port forwardings to the loopback address.
264This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000265.Cm GatewayPorts
Damien Miller5b0d63f2006-03-15 11:56:56 +1100266can be used to specify that sshd
Damien Millerf91ee4c2005-03-01 21:24:33 +1100267should allow remote port forwardings to bind to non-loopback addresses, thus
268allowing other hosts to connect.
269The argument may be
270.Dq no
271to force remote port forwardings to be available to the local host only,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000272.Dq yes
Damien Millerf91ee4c2005-03-01 21:24:33 +1100273to force remote port forwardings to bind to the wildcard address, or
274.Dq clientspecified
275to allow the client to select the address to which the forwarding is bound.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000276The default is
277.Dq no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000278.It Cm GSSAPIAuthentication
Damien Miller9b7b03b2003-09-02 22:57:05 +1000279Specifies whether user authentication based on GSSAPI is allowed.
Damien Millera8e06ce2003-11-21 23:48:55 +1100280The default is
Darren Tucker0efd1552003-08-26 11:49:55 +1000281.Dq no .
282Note that this option applies to protocol version 2 only.
283.It Cm GSSAPICleanupCredentials
284Specifies whether to automatically destroy the user's credentials cache
285on logout.
286The default is
287.Dq yes .
288Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000289.It Cm HostbasedAuthentication
290Specifies whether rhosts or /etc/hosts.equiv authentication together
291with successful public key client host authentication is allowed
Damien Miller1faa7132006-03-15 11:55:31 +1100292(host-based authentication).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000293This option is similar to
294.Cm RhostsRSAAuthentication
295and applies to protocol version 2 only.
296The default is
297.Dq no .
298.It Cm HostKey
299Specifies a file containing a private host key
300used by SSH.
301The default is
302.Pa /etc/ssh/ssh_host_key
303for protocol version 1, and
304.Pa /etc/ssh/ssh_host_rsa_key
305and
306.Pa /etc/ssh/ssh_host_dsa_key
307for protocol version 2.
308Note that
Damien Miller5b0d63f2006-03-15 11:56:56 +1100309.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000310will refuse to use a file if it is group/world-accessible.
311It is possible to have multiple host key files.
312.Dq rsa1
313keys are used for version 1 and
314.Dq dsa
315or
316.Dq rsa
317are used for version 2 of the SSH protocol.
318.It Cm IgnoreRhosts
319Specifies that
320.Pa .rhosts
321and
322.Pa .shosts
323files will not be used in
Ben Lindstrom9f049032002-06-21 00:59:05 +0000324.Cm RhostsRSAAuthentication
325or
326.Cm HostbasedAuthentication .
327.Pp
328.Pa /etc/hosts.equiv
329and
330.Pa /etc/shosts.equiv
331are still used.
332The default is
333.Dq yes .
334.It Cm IgnoreUserKnownHosts
335Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100336.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000337should ignore the user's
Damien Miller167ea5d2005-05-26 12:04:02 +1000338.Pa ~/.ssh/known_hosts
Ben Lindstrom9f049032002-06-21 00:59:05 +0000339during
340.Cm RhostsRSAAuthentication
341or
342.Cm HostbasedAuthentication .
343The default is
344.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000345.It Cm KerberosAuthentication
Damien Miller1a0c0b92003-09-02 22:51:17 +1000346Specifies whether the password provided by the user for
Ben Lindstrom9f049032002-06-21 00:59:05 +0000347.Cm PasswordAuthentication
Damien Miller1a0c0b92003-09-02 22:51:17 +1000348will be validated through the Kerberos KDC.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000349To use this option, the server needs a
350Kerberos servtab which allows the verification of the KDC's identity.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100351The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000352.Dq no .
Damien Miller8448e662004-03-08 23:13:15 +1100353.It Cm KerberosGetAFSToken
Darren Tuckere2dd2d52005-10-03 18:19:06 +1000354If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
Damien Miller8448e662004-03-08 23:13:15 +1100355an AFS token before accessing the user's home directory.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100356The default is
Damien Miller8448e662004-03-08 23:13:15 +1100357.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000358.It Cm KerberosOrLocalPasswd
Damien Miller5b0d63f2006-03-15 11:56:56 +1100359If password authentication through Kerberos fails then
Ben Lindstrom9f049032002-06-21 00:59:05 +0000360the password will be validated via any additional local mechanism
361such as
362.Pa /etc/passwd .
Damien Miller5b0d63f2006-03-15 11:56:56 +1100363The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000364.Dq yes .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000365.It Cm KerberosTicketCleanup
366Specifies whether to automatically destroy the user's ticket cache
367file on logout.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100368The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000369.Dq yes .
370.It Cm KeyRegenerationInterval
371In protocol version 1, the ephemeral server key is automatically regenerated
372after this many seconds (if it has been used).
373The purpose of regeneration is to prevent
374decrypting captured sessions by later breaking into the machine and
375stealing the keys.
376The key is never stored anywhere.
377If the value is 0, the key is never regenerated.
378The default is 3600 (seconds).
379.It Cm ListenAddress
380Specifies the local addresses
Damien Miller5b0d63f2006-03-15 11:56:56 +1100381.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000382should listen on.
383The following forms may be used:
384.Pp
385.Bl -item -offset indent -compact
386.It
387.Cm ListenAddress
388.Sm off
389.Ar host No | Ar IPv4_addr No | Ar IPv6_addr
390.Sm on
391.It
392.Cm ListenAddress
393.Sm off
394.Ar host No | Ar IPv4_addr No : Ar port
395.Sm on
396.It
397.Cm ListenAddress
398.Sm off
399.Oo
400.Ar host No | Ar IPv6_addr Oc : Ar port
401.Sm on
402.El
403.Pp
404If
405.Ar port
406is not specified,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100407sshd will listen on the address and all prior
Ben Lindstrom9f049032002-06-21 00:59:05 +0000408.Cm Port
Damien Millerfbf486b2003-05-23 18:44:23 +1000409options specified.
410The default is to listen on all local addresses.
Damien Miller495dca32003-04-01 21:42:14 +1000411Multiple
Ben Lindstrom9f049032002-06-21 00:59:05 +0000412.Cm ListenAddress
Damien Millerfbf486b2003-05-23 18:44:23 +1000413options are permitted.
414Additionally, any
Ben Lindstrom9f049032002-06-21 00:59:05 +0000415.Cm Port
Damien Miller5b0d63f2006-03-15 11:56:56 +1100416options must precede this option for non-port qualified addresses.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000417.It Cm LoginGraceTime
418The server disconnects after this time if the user has not
419successfully logged in.
420If the value is 0, there is no time limit.
Damien Millerc1348632002-09-05 14:35:14 +1000421The default is 120 seconds.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000422.It Cm LogLevel
423Gives the verbosity level that is used when logging messages from
Damien Millerf4f22b52006-03-15 11:57:25 +1100424.Xr sshd 8 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000425The possible values are:
Damien Miller5b0d63f2006-03-15 11:56:56 +1100426QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +1000427The default is INFO.
428DEBUG and DEBUG1 are equivalent.
429DEBUG2 and DEBUG3 each specify higher levels of debugging output.
430Logging with a DEBUG level violates the privacy of users and is not recommended.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000431.It Cm MACs
432Specifies the available MAC (message authentication code) algorithms.
433The MAC algorithm is used in protocol version 2
434for data integrity protection.
435Multiple algorithms must be comma-separated.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100436The default is:
Ben Lindstrom9f049032002-06-21 00:59:05 +0000437.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
Darren Tucker89413db2004-05-24 10:36:23 +1000438.It Cm MaxAuthTries
439Specifies the maximum number of authentication attempts permitted per
Damien Miller26213e52004-06-30 22:39:34 +1000440connection.
441Once the number of failures reaches half this value,
442additional failures are logged.
443The default is 6.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000444.It Cm MaxStartups
445Specifies the maximum number of concurrent unauthenticated connections to the
Damien Miller5b0d63f2006-03-15 11:56:56 +1100446SSH daemon.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000447Additional connections will be dropped until authentication succeeds or the
448.Cm LoginGraceTime
449expires for a connection.
450The default is 10.
451.Pp
452Alternatively, random early drop can be enabled by specifying
453the three colon separated values
454.Dq start:rate:full
Damien Miller208f1ed2006-03-15 11:56:03 +1100455(e.g. "10:30:60").
Damien Millerf4f22b52006-03-15 11:57:25 +1100456.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000457will refuse connection attempts with a probability of
458.Dq rate/100
459(30%)
460if there are currently
461.Dq start
462(10)
463unauthenticated connections.
464The probability increases linearly and all connection attempts
465are refused if the number of unauthenticated connections reaches
466.Dq full
467(60).
468.It Cm PasswordAuthentication
469Specifies whether password authentication is allowed.
470The default is
471.Dq yes .
472.It Cm PermitEmptyPasswords
473When password authentication is allowed, it specifies whether the
474server allows login to accounts with empty password strings.
475The default is
476.Dq no .
477.It Cm PermitRootLogin
Darren Tuckerb3509012005-01-20 11:01:46 +1100478Specifies whether root can log in using
Ben Lindstrom9f049032002-06-21 00:59:05 +0000479.Xr ssh 1 .
480The argument must be
481.Dq yes ,
482.Dq without-password ,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100483.Dq forced-commands-only ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000484or
485.Dq no .
486The default is
487.Dq yes .
488.Pp
489If this option is set to
Damien Miller5b0d63f2006-03-15 11:56:56 +1100490.Dq without-password ,
Darren Tucker9dca0992005-02-01 19:16:45 +1100491password authentication is disabled for root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000492.Pp
493If this option is set to
Damien Miller5b0d63f2006-03-15 11:56:56 +1100494.Dq forced-commands-only ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000495root login with public key authentication will be allowed,
496but only if the
497.Ar command
498option has been specified
499(which may be useful for taking remote backups even if root login is
Damien Millerfbf486b2003-05-23 18:44:23 +1000500normally not allowed).
501All other authentication methods are disabled for root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000502.Pp
503If this option is set to
Damien Miller5b0d63f2006-03-15 11:56:56 +1100504.Dq no ,
Darren Tuckerb3509012005-01-20 11:01:46 +1100505root is not allowed to log in.
Damien Millerd27b9472005-12-13 19:29:02 +1100506.It Cm PermitTunnel
507Specifies whether
508.Xr tun 4
509device forwarding is allowed.
Damien Miller7b58e802005-12-13 19:33:19 +1100510The argument must be
511.Dq yes ,
512.Dq point-to-point ,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100513.Dq ethernet ,
Damien Miller7b58e802005-12-13 19:33:19 +1100514or
515.Dq no .
Damien Millerd27b9472005-12-13 19:29:02 +1100516The default is
517.Dq no .
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000518.It Cm PermitUserEnvironment
519Specifies whether
520.Pa ~/.ssh/environment
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000521and
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000522.Cm environment=
523options in
524.Pa ~/.ssh/authorized_keys
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000525are processed by
Damien Miller5b0d63f2006-03-15 11:56:56 +1100526.Xr sshd 8 .
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000527The default is
528.Dq no .
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000529Enabling environment processing may enable users to bypass access
530restrictions in some configurations using mechanisms such as
531.Ev LD_PRELOAD .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000532.It Cm PidFile
Ben Lindstrom959de992002-06-23 00:35:25 +0000533Specifies the file that contains the process ID of the
Damien Millerf4f22b52006-03-15 11:57:25 +1100534SSH daemon.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000535The default is
536.Pa /var/run/sshd.pid .
537.It Cm Port
538Specifies the port number that
Damien Miller5b0d63f2006-03-15 11:56:56 +1100539.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000540listens on.
541The default is 22.
542Multiple options of this type are permitted.
543See also
544.Cm ListenAddress .
545.It Cm PrintLastLog
546Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100547.Xr sshd 8
Darren Tucker7cc5c232004-11-05 20:06:59 +1100548should print the date and time of the last user login when a user logs
549in interactively.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000550The default is
551.Dq yes .
552.It Cm PrintMotd
553Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100554.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000555should print
556.Pa /etc/motd
557when a user logs in interactively.
558(On some systems it is also printed by the shell,
559.Pa /etc/profile ,
560or equivalent.)
561The default is
562.Dq yes .
563.It Cm Protocol
564Specifies the protocol versions
Damien Miller5b0d63f2006-03-15 11:56:56 +1100565.Xr sshd 8
Ben Lindstrom9c445542002-07-11 03:59:18 +0000566supports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000567The possible values are
Damien Miller5b0d63f2006-03-15 11:56:56 +1100568.Sq 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000569and
Damien Miller5b0d63f2006-03-15 11:56:56 +1100570.Sq 2 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000571Multiple versions must be comma-separated.
572The default is
573.Dq 2,1 .
Ben Lindstrom9c445542002-07-11 03:59:18 +0000574Note that the order of the protocol list does not indicate preference,
575because the client selects among multiple protocol versions offered
576by the server.
577Specifying
578.Dq 2,1
579is identical to
580.Dq 1,2 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000581.It Cm PubkeyAuthentication
582Specifies whether public key authentication is allowed.
583The default is
584.Dq yes .
585Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000586.It Cm RhostsRSAAuthentication
587Specifies whether rhosts or /etc/hosts.equiv authentication together
588with successful RSA host authentication is allowed.
589The default is
590.Dq no .
591This option applies to protocol version 1 only.
592.It Cm RSAAuthentication
593Specifies whether pure RSA authentication is allowed.
594The default is
595.Dq yes .
596This option applies to protocol version 1 only.
597.It Cm ServerKeyBits
598Defines the number of bits in the ephemeral protocol version 1 server key.
599The minimum value is 512, and the default is 768.
600.It Cm StrictModes
601Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100602.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000603should check file modes and ownership of the
604user's files and home directory before accepting login.
605This is normally desirable because novices sometimes accidentally leave their
606directory or files world-writable.
607The default is
608.Dq yes .
609.It Cm Subsystem
Damien Miller208f1ed2006-03-15 11:56:03 +1100610Configures an external subsystem (e.g. file transfer daemon).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000611Arguments should be a subsystem name and a command to execute upon subsystem
612request.
613The command
614.Xr sftp-server 8
615implements the
616.Dq sftp
617file transfer subsystem.
618By default no subsystems are defined.
619Note that this option applies to protocol version 2 only.
620.It Cm SyslogFacility
621Gives the facility code that is used when logging messages from
Damien Millerf4f22b52006-03-15 11:57:25 +1100622.Xr sshd 8 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000623The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
624LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
625The default is AUTH.
Damien Miller12c150e2003-12-17 16:31:10 +1100626.It Cm TCPKeepAlive
627Specifies whether the system should send TCP keepalive messages to the
628other side.
629If they are sent, death of the connection or crash of one
630of the machines will be properly noticed.
631However, this means that
632connections will die if the route is down temporarily, and some people
633find it annoying.
634On the other hand, if TCP keepalives are not sent,
635sessions may hang indefinitely on the server, leaving
636.Dq ghost
637users and consuming server resources.
638.Pp
639The default is
640.Dq yes
641(to send TCP keepalive messages), and the server will notice
642if the network goes down or the client host crashes.
643This avoids infinitely hanging sessions.
644.Pp
645To disable TCP keepalive messages, the value should be set to
646.Dq no .
Damien Miller3a961dc2003-06-03 10:25:48 +1000647.It Cm UseDNS
648Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100649.Xr sshd 8
Darren Tucker83d5a982005-03-31 21:33:50 +1000650should look up the remote host name and check that
Damien Miller3a961dc2003-06-03 10:25:48 +1000651the resolved host name for the remote IP address maps back to the
652very same IP address.
653The default is
654.Dq yes .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000655.It Cm UseLogin
656Specifies whether
657.Xr login 1
658is used for interactive login sessions.
659The default is
660.Dq no .
661Note that
662.Xr login 1
663is never used for remote command execution.
664Note also, that if this is enabled,
665.Cm X11Forwarding
666will be disabled because
667.Xr login 1
668does not know how to handle
669.Xr xauth 1
Damien Miller495dca32003-04-01 21:42:14 +1000670cookies.
671If
Ben Lindstrom9f049032002-06-21 00:59:05 +0000672.Cm UsePrivilegeSeparation
673is specified, it will be disabled after authentication.
Damien Miller2e193e22003-05-14 15:13:03 +1000674.It Cm UsePAM
Darren Tucker1dcff9a2004-05-13 16:51:40 +1000675Enables the Pluggable Authentication Module interface.
676If set to
677.Dq yes
678this will enable PAM authentication using
679.Cm ChallengeResponseAuthentication
Darren Tuckera4904f72006-02-23 21:35:30 +1100680and
681.Cm PasswordAuthentication
682in addition to PAM account and session module processing for all
683authentication types.
Darren Tucker1dcff9a2004-05-13 16:51:40 +1000684.Pp
685Because PAM challenge-response authentication usually serves an equivalent
686role to password authentication, you should disable either
687.Cm PasswordAuthentication
688or
689.Cm ChallengeResponseAuthentication.
690.Pp
691If
692.Cm UsePAM
693is enabled, you will not be able to run
694.Xr sshd 8
695as a non-root user.
696The default is
Darren Tucker6c0c0702003-10-09 14:13:53 +1000697.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000698.It Cm UsePrivilegeSeparation
699Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100700.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000701separates privileges by creating an unprivileged child process
Damien Miller495dca32003-04-01 21:42:14 +1000702to deal with incoming network traffic.
703After successful authentication, another process will be created that has
704the privilege of the authenticated user.
705The goal of privilege separation is to prevent privilege
Ben Lindstrom9f049032002-06-21 00:59:05 +0000706escalation by containing any corruption within the unprivileged processes.
707The default is
708.Dq yes .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000709.It Cm X11DisplayOffset
710Specifies the first display number available for
Damien Miller5b0d63f2006-03-15 11:56:56 +1100711.Xr sshd 8 Ns 's
Ben Lindstrom9f049032002-06-21 00:59:05 +0000712X11 forwarding.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100713This prevents sshd from interfering with real X11 servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000714The default is 10.
715.It Cm X11Forwarding
716Specifies whether X11 forwarding is permitted.
Damien Miller101c4a72002-09-19 11:51:21 +1000717The argument must be
718.Dq yes
719or
720.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000721The default is
722.Dq no .
Damien Miller101c4a72002-09-19 11:51:21 +1000723.Pp
724When X11 forwarding is enabled, there may be additional exposure to
725the server and to client displays if the
Damien Miller5b0d63f2006-03-15 11:56:56 +1100726.Xr sshd 8
Damien Miller101c4a72002-09-19 11:51:21 +1000727proxy display is configured to listen on the wildcard address (see
728.Cm X11UseLocalhost
Damien Miller5b0d63f2006-03-15 11:56:56 +1100729below), though this is not the default.
Damien Miller101c4a72002-09-19 11:51:21 +1000730Additionally, the authentication spoofing and authentication data
731verification and substitution occur on the client side.
732The security risk of using X11 forwarding is that the client's X11
Damien Miller5b0d63f2006-03-15 11:56:56 +1100733display server may be exposed to attack when the SSH client requests
Damien Miller101c4a72002-09-19 11:51:21 +1000734forwarding (see the warnings for
735.Cm ForwardX11
736in
Damien Millerf1ce5052003-06-11 22:04:39 +1000737.Xr ssh_config 5 ) .
Damien Miller101c4a72002-09-19 11:51:21 +1000738A system administrator may have a stance in which they want to
739protect clients that may expose themselves to attack by unwittingly
740requesting X11 forwarding, which can warrant a
741.Dq no
742setting.
743.Pp
744Note that disabling X11 forwarding does not prevent users from
745forwarding X11 traffic, as users can always install their own forwarders.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000746X11 forwarding is automatically disabled if
747.Cm UseLogin
748is enabled.
749.It Cm X11UseLocalhost
750Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100751.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000752should bind the X11 forwarding server to the loopback address or to
Damien Miller495dca32003-04-01 21:42:14 +1000753the wildcard address.
754By default,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100755sshd binds the forwarding server to the loopback address and sets the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000756hostname part of the
757.Ev DISPLAY
758environment variable to
759.Dq localhost .
Ben Lindstrom15b61202002-08-20 18:44:24 +0000760This prevents remote hosts from connecting to the proxy display.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000761However, some older X11 clients may not function with this
762configuration.
763.Cm X11UseLocalhost
764may be set to
765.Dq no
766to specify that the forwarding server should be bound to the wildcard
767address.
768The argument must be
769.Dq yes
770or
771.Dq no .
772The default is
773.Dq yes .
774.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +1000775Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000776.Xr xauth 1
777program.
778The default is
779.Pa /usr/X11R6/bin/xauth .
780.El
781.Ss Time Formats
Damien Millerf4f22b52006-03-15 11:57:25 +1100782.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000783command-line arguments and configuration file options that specify time
784may be expressed using a sequence of the form:
785.Sm off
Ben Lindstrom1f8cf4f2002-08-20 18:43:27 +0000786.Ar time Op Ar qualifier ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000787.Sm on
788where
789.Ar time
790is a positive integer value and
791.Ar qualifier
792is one of the following:
793.Pp
794.Bl -tag -width Ds -compact -offset indent
795.It Cm <none>
796seconds
797.It Cm s | Cm S
798seconds
799.It Cm m | Cm M
800minutes
801.It Cm h | Cm H
802hours
803.It Cm d | Cm D
804days
805.It Cm w | Cm W
806weeks
807.El
808.Pp
809Each member of the sequence is added together to calculate
810the total time value.
811.Pp
812Time format examples:
813.Pp
814.Bl -tag -width Ds -compact -offset indent
815.It 600
816600 seconds (10 minutes)
817.It 10m
81810 minutes
819.It 1h30m
8201 hour 30 minutes (90 minutes)
821.El
822.Sh FILES
823.Bl -tag -width Ds
824.It Pa /etc/ssh/sshd_config
825Contains configuration data for
Damien Millerf4f22b52006-03-15 11:57:25 +1100826.Xr sshd 8 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000827This file should be writable by root only, but it is recommended
828(though not necessary) that it be world-readable.
829.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000830.Sh SEE ALSO
831.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000832.Sh AUTHORS
833OpenSSH is a derivative of the original and free
834ssh 1.2.12 release by Tatu Ylonen.
835Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
836Theo de Raadt and Dug Song
837removed many bugs, re-added newer features and
838created OpenSSH.
839Markus Friedl contributed the support for SSH
840protocol versions 1.5 and 2.0.
841Niels Provos and Markus Friedl contributed support
842for privilege separation.