blob: 836add94fb00b62f91a22513e0e61f2dd5cab0e8 [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 Miller991dba42006-07-10 20:16:27 +100037.\" $OpenBSD: sshd_config.5,v 1.58 2006/07/02 17:12:58 stevesk 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.
Damien Miller306d1182006-03-15 12:05:59 +110059Arguments may optionally be enclosed in double quotes
60.Pq \&"
61in order to represent arguments containing spaces.
Ben Lindstrom9f049032002-06-21 00:59:05 +000062.Pp
63The possible
64keywords and their meanings are as follows (note that
65keywords are case-insensitive and arguments are case-sensitive):
66.Bl -tag -width Ds
Darren Tucker46bc0752004-05-02 22:11:30 +100067.It Cm AcceptEnv
68Specifies what environment variables sent by the client will be copied into
69the session's
70.Xr environ 7 .
71See
72.Cm SendEnv
73in
74.Xr ssh_config 5
75for how to configure the client.
Darren Tucker1e0c9bf2004-05-02 22:12:48 +100076Note that environment passing is only supported for protocol 2.
Darren Tucker46bc0752004-05-02 22:11:30 +100077Variables are specified by name, which may contain the wildcard characters
Damien Miller208f1ed2006-03-15 11:56:03 +110078.Ql *
Darren Tucker46bc0752004-05-02 22:11:30 +100079and
80.Ql \&? .
Darren Tucker1e0c9bf2004-05-02 22:12:48 +100081Multiple environment variables may be separated by whitespace or spread
Darren Tucker46bc0752004-05-02 22:11:30 +100082across multiple
83.Cm AcceptEnv
84directives.
Darren Tucker1e0c9bf2004-05-02 22:12:48 +100085Be warned that some environment variables could be used to bypass restricted
Darren Tucker46bc0752004-05-02 22:11:30 +100086user environments.
87For this reason, care should be taken in the use of this directive.
88The default is not to accept any environment variables.
Darren Tucker0f383232005-01-20 10:57:56 +110089.It Cm AddressFamily
90Specifies which address family should be used by
Damien Millerf4f22b52006-03-15 11:57:25 +110091.Xr sshd 8 .
Darren Tucker0f383232005-01-20 10:57:56 +110092Valid arguments are
93.Dq any ,
94.Dq inet
Damien Miller5b0d63f2006-03-15 11:56:56 +110095(use IPv4 only), or
Darren Tucker0f383232005-01-20 10:57:56 +110096.Dq inet6
97(use IPv6 only).
98The default is
99.Dq any .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000100.It Cm AllowGroups
101This keyword can be followed by a list of group name patterns, separated
102by spaces.
103If specified, login is allowed only for users whose primary
104group or supplementary group list matches one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000105Only group names are valid; a numerical group ID is not recognized.
106By default, login is allowed for all groups.
Damien Millerac73e512006-03-15 11:58:49 +1100107The allow/deny directives are processed in the following order:
108.Cm DenyUsers ,
109.Cm AllowUsers ,
110.Cm DenyGroups ,
111and finally
112.Cm AllowGroups .
Damien Miller0c2079d2006-03-15 11:54:21 +1100113.Pp
114See
115.Sx PATTERNS
116in
117.Xr ssh_config 5
118for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000119.It Cm AllowTcpForwarding
120Specifies whether TCP forwarding is permitted.
121The default is
122.Dq yes .
123Note that disabling TCP forwarding does not improve security unless
124users are also denied shell access, as they can always install their
125own forwarders.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000126.It Cm AllowUsers
127This keyword can be followed by a list of user name patterns, separated
128by spaces.
Damien Miller5a93add2003-01-24 11:34:52 +1100129If specified, login is allowed only for user names that
Ben Lindstrom9f049032002-06-21 00:59:05 +0000130match one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000131Only user names are valid; a numerical user ID is not recognized.
132By default, login is allowed for all users.
133If the pattern takes the form USER@HOST then USER and HOST
134are separately checked, restricting logins to particular
135users from particular hosts.
Damien Millerac73e512006-03-15 11:58:49 +1100136The allow/deny directives are processed in the following order:
137.Cm DenyUsers ,
138.Cm AllowUsers ,
139.Cm DenyGroups ,
140and finally
141.Cm AllowGroups .
Damien Miller0c2079d2006-03-15 11:54:21 +1100142.Pp
143See
144.Sx PATTERNS
145in
146.Xr ssh_config 5
147for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000148.It Cm AuthorizedKeysFile
149Specifies the file that contains the public keys that can be used
150for user authentication.
151.Cm AuthorizedKeysFile
152may contain tokens of the form %T which are substituted during connection
Damien Miller5b0d63f2006-03-15 11:56:56 +1100153setup.
Damien Millerfbf486b2003-05-23 18:44:23 +1000154The following tokens are defined: %% is replaced by a literal '%',
Damien Miller5b0d63f2006-03-15 11:56:56 +1100155%h is replaced by the home directory of the user being authenticated, and
Ben Lindstrom9f049032002-06-21 00:59:05 +0000156%u is replaced by the username of that user.
157After expansion,
158.Cm AuthorizedKeysFile
159is taken to be an absolute path or one relative to the user's home
160directory.
161The default is
162.Dq .ssh/authorized_keys .
163.It Cm Banner
164In some jurisdictions, sending a warning message before authentication
165may be relevant for getting legal protection.
166The contents of the specified file are sent to the remote user before
167authentication is allowed.
168This option is only available for protocol version 2.
169By default, no banner is displayed.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000170.It Cm ChallengeResponseAuthentication
Damien Miller1faa7132006-03-15 11:55:31 +1100171Specifies whether challenge-response authentication is allowed.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000172All authentication styles from
173.Xr login.conf 5
174are supported.
175The default is
176.Dq yes .
177.It Cm Ciphers
178Specifies the ciphers allowed for protocol version 2.
179Multiple ciphers must be comma-separated.
Damien Miller05202ff2004-06-15 10:30:39 +1000180The supported ciphers are
181.Dq 3des-cbc ,
182.Dq aes128-cbc ,
183.Dq aes192-cbc ,
184.Dq aes256-cbc ,
185.Dq aes128-ctr ,
186.Dq aes192-ctr ,
187.Dq aes256-ctr ,
Damien Miller3710f272005-05-26 12:19:17 +1000188.Dq arcfour128 ,
189.Dq arcfour256 ,
Damien Miller05202ff2004-06-15 10:30:39 +1000190.Dq arcfour ,
191.Dq blowfish-cbc ,
192and
193.Dq cast128-cbc .
Damien Miller5b0d63f2006-03-15 11:56:56 +1100194The default is:
195.Bd -literal -offset 3n
196aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
197arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
198aes192-ctr,aes256-ctr
Ben Lindstrom9f049032002-06-21 00:59:05 +0000199.Ed
Ben Lindstrom9f049032002-06-21 00:59:05 +0000200.It Cm ClientAliveCountMax
Damien Millerb7977702006-01-03 18:47:31 +1100201Sets the number of client alive messages (see below) which may be
Ben Lindstrom9f049032002-06-21 00:59:05 +0000202sent without
Damien Miller5b0d63f2006-03-15 11:56:56 +1100203.Xr sshd 8
Damien Millerfbf486b2003-05-23 18:44:23 +1000204receiving any messages back from the client.
205If this threshold is reached while client alive messages are being sent,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100206sshd will disconnect the client, terminating the session.
Damien Millerfbf486b2003-05-23 18:44:23 +1000207It is important to note that the use of client alive messages is very
208different from
Damien Miller12c150e2003-12-17 16:31:10 +1100209.Cm TCPKeepAlive
Damien Millerfbf486b2003-05-23 18:44:23 +1000210(below).
211The client alive messages are sent through the encrypted channel
212and therefore will not be spoofable.
213The TCP keepalive option enabled by
Damien Miller12c150e2003-12-17 16:31:10 +1100214.Cm TCPKeepAlive
Damien Millerfbf486b2003-05-23 18:44:23 +1000215is spoofable.
216The client alive mechanism is valuable when the client or
Ben Lindstrom9f049032002-06-21 00:59:05 +0000217server depend on knowing when a connection has become inactive.
218.Pp
Damien Millerfbf486b2003-05-23 18:44:23 +1000219The default value is 3.
220If
Ben Lindstrom9f049032002-06-21 00:59:05 +0000221.Cm ClientAliveInterval
Damien Millerb7977702006-01-03 18:47:31 +1100222(see below) is set to 15, and
Ben Lindstrom9f049032002-06-21 00:59:05 +0000223.Cm ClientAliveCountMax
Damien Miller5b0d63f2006-03-15 11:56:56 +1100224is left at the default, unresponsive SSH clients
Ben Lindstrom9f049032002-06-21 00:59:05 +0000225will be disconnected after approximately 45 seconds.
Damien Millercc3e8ba2006-03-15 12:06:55 +1100226This option applies to protocol version 2 only.
Damien Miller1594ad52005-05-26 12:12:19 +1000227.It Cm ClientAliveInterval
228Sets a timeout interval in seconds after which if no data has been received
229from the client,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100230.Xr sshd 8
Damien Miller1594ad52005-05-26 12:12:19 +1000231will send a message through the encrypted
232channel to request a response from the client.
233The default
234is 0, indicating that these messages will not be sent to the client.
235This option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000236.It Cm Compression
Damien Miller9786e6e2005-07-26 21:54:56 +1000237Specifies whether compression is allowed, or delayed until
238the user has authenticated successfully.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000239The argument must be
Damien Miller9786e6e2005-07-26 21:54:56 +1000240.Dq yes ,
241.Dq delayed ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000242or
243.Dq no .
244The default is
Damien Miller9786e6e2005-07-26 21:54:56 +1000245.Dq delayed .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000246.It Cm DenyGroups
247This keyword can be followed by a list of group name patterns, separated
248by spaces.
249Login is disallowed for users whose primary group or supplementary
250group list matches one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000251Only group names are valid; a numerical group ID is not recognized.
252By default, login is allowed for all groups.
Damien Millerac73e512006-03-15 11:58:49 +1100253The allow/deny directives are processed in the following order:
254.Cm DenyUsers ,
255.Cm AllowUsers ,
256.Cm DenyGroups ,
257and finally
258.Cm AllowGroups .
Damien Miller0c2079d2006-03-15 11:54:21 +1100259.Pp
260See
261.Sx PATTERNS
262in
263.Xr ssh_config 5
264for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000265.It Cm DenyUsers
266This keyword can be followed by a list of user name patterns, separated
267by spaces.
268Login is disallowed for user names that match one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000269Only user names are valid; a numerical user ID is not recognized.
270By default, login is allowed for all users.
271If the pattern takes the form USER@HOST then USER and HOST
272are separately checked, restricting logins to particular
273users from particular hosts.
Damien Millerac73e512006-03-15 11:58:49 +1100274The allow/deny directives are processed in the following order:
275.Cm DenyUsers ,
276.Cm AllowUsers ,
277.Cm DenyGroups ,
278and finally
279.Cm AllowGroups .
Damien Miller0c2079d2006-03-15 11:54:21 +1100280.Pp
281See
282.Sx PATTERNS
283in
284.Xr ssh_config 5
285for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000286.It Cm GatewayPorts
287Specifies whether remote hosts are allowed to connect to ports
288forwarded for the client.
289By default,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100290.Xr sshd 8
Damien Miller495dca32003-04-01 21:42:14 +1000291binds remote port forwardings to the loopback address.
292This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000293.Cm GatewayPorts
Damien Miller5b0d63f2006-03-15 11:56:56 +1100294can be used to specify that sshd
Damien Millerf91ee4c2005-03-01 21:24:33 +1100295should allow remote port forwardings to bind to non-loopback addresses, thus
296allowing other hosts to connect.
297The argument may be
298.Dq no
299to force remote port forwardings to be available to the local host only,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000300.Dq yes
Damien Millerf91ee4c2005-03-01 21:24:33 +1100301to force remote port forwardings to bind to the wildcard address, or
302.Dq clientspecified
303to allow the client to select the address to which the forwarding is bound.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000304The default is
305.Dq no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000306.It Cm GSSAPIAuthentication
Damien Miller9b7b03b2003-09-02 22:57:05 +1000307Specifies whether user authentication based on GSSAPI is allowed.
Damien Millera8e06ce2003-11-21 23:48:55 +1100308The default is
Darren Tucker0efd1552003-08-26 11:49:55 +1000309.Dq no .
310Note that this option applies to protocol version 2 only.
311.It Cm GSSAPICleanupCredentials
312Specifies whether to automatically destroy the user's credentials cache
313on logout.
314The default is
315.Dq yes .
316Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000317.It Cm HostbasedAuthentication
318Specifies whether rhosts or /etc/hosts.equiv authentication together
319with successful public key client host authentication is allowed
Damien Miller1faa7132006-03-15 11:55:31 +1100320(host-based authentication).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000321This option is similar to
322.Cm RhostsRSAAuthentication
323and applies to protocol version 2 only.
324The default is
325.Dq no .
326.It Cm HostKey
327Specifies a file containing a private host key
328used by SSH.
329The default is
330.Pa /etc/ssh/ssh_host_key
331for protocol version 1, and
332.Pa /etc/ssh/ssh_host_rsa_key
333and
334.Pa /etc/ssh/ssh_host_dsa_key
335for protocol version 2.
336Note that
Damien Miller5b0d63f2006-03-15 11:56:56 +1100337.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000338will refuse to use a file if it is group/world-accessible.
339It is possible to have multiple host key files.
340.Dq rsa1
341keys are used for version 1 and
342.Dq dsa
343or
344.Dq rsa
345are used for version 2 of the SSH protocol.
346.It Cm IgnoreRhosts
347Specifies that
348.Pa .rhosts
349and
350.Pa .shosts
351files will not be used in
Ben Lindstrom9f049032002-06-21 00:59:05 +0000352.Cm RhostsRSAAuthentication
353or
354.Cm HostbasedAuthentication .
355.Pp
356.Pa /etc/hosts.equiv
357and
358.Pa /etc/shosts.equiv
359are still used.
360The default is
361.Dq yes .
362.It Cm IgnoreUserKnownHosts
363Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100364.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000365should ignore the user's
Damien Miller167ea5d2005-05-26 12:04:02 +1000366.Pa ~/.ssh/known_hosts
Ben Lindstrom9f049032002-06-21 00:59:05 +0000367during
368.Cm RhostsRSAAuthentication
369or
370.Cm HostbasedAuthentication .
371The default is
372.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000373.It Cm KerberosAuthentication
Damien Miller1a0c0b92003-09-02 22:51:17 +1000374Specifies whether the password provided by the user for
Ben Lindstrom9f049032002-06-21 00:59:05 +0000375.Cm PasswordAuthentication
Damien Miller1a0c0b92003-09-02 22:51:17 +1000376will be validated through the Kerberos KDC.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000377To use this option, the server needs a
378Kerberos servtab which allows the verification of the KDC's identity.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100379The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000380.Dq no .
Damien Miller8448e662004-03-08 23:13:15 +1100381.It Cm KerberosGetAFSToken
Darren Tuckere2dd2d52005-10-03 18:19:06 +1000382If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
Damien Miller8448e662004-03-08 23:13:15 +1100383an AFS token before accessing the user's home directory.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100384The default is
Damien Miller8448e662004-03-08 23:13:15 +1100385.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000386.It Cm KerberosOrLocalPasswd
Damien Miller5b0d63f2006-03-15 11:56:56 +1100387If password authentication through Kerberos fails then
Ben Lindstrom9f049032002-06-21 00:59:05 +0000388the password will be validated via any additional local mechanism
389such as
390.Pa /etc/passwd .
Damien Miller5b0d63f2006-03-15 11:56:56 +1100391The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000392.Dq yes .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000393.It Cm KerberosTicketCleanup
394Specifies whether to automatically destroy the user's ticket cache
395file on logout.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100396The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000397.Dq yes .
398.It Cm KeyRegenerationInterval
399In protocol version 1, the ephemeral server key is automatically regenerated
400after this many seconds (if it has been used).
401The purpose of regeneration is to prevent
402decrypting captured sessions by later breaking into the machine and
403stealing the keys.
404The key is never stored anywhere.
405If the value is 0, the key is never regenerated.
406The default is 3600 (seconds).
407.It Cm ListenAddress
408Specifies the local addresses
Damien Miller5b0d63f2006-03-15 11:56:56 +1100409.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000410should listen on.
411The following forms may be used:
412.Pp
413.Bl -item -offset indent -compact
414.It
415.Cm ListenAddress
416.Sm off
417.Ar host No | Ar IPv4_addr No | Ar IPv6_addr
418.Sm on
419.It
420.Cm ListenAddress
421.Sm off
422.Ar host No | Ar IPv4_addr No : Ar port
423.Sm on
424.It
425.Cm ListenAddress
426.Sm off
427.Oo
428.Ar host No | Ar IPv6_addr Oc : Ar port
429.Sm on
430.El
431.Pp
432If
433.Ar port
434is not specified,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100435sshd will listen on the address and all prior
Ben Lindstrom9f049032002-06-21 00:59:05 +0000436.Cm Port
Damien Millerfbf486b2003-05-23 18:44:23 +1000437options specified.
438The default is to listen on all local addresses.
Damien Miller495dca32003-04-01 21:42:14 +1000439Multiple
Ben Lindstrom9f049032002-06-21 00:59:05 +0000440.Cm ListenAddress
Damien Millerfbf486b2003-05-23 18:44:23 +1000441options are permitted.
442Additionally, any
Ben Lindstrom9f049032002-06-21 00:59:05 +0000443.Cm Port
Damien Miller5b0d63f2006-03-15 11:56:56 +1100444options must precede this option for non-port qualified addresses.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000445.It Cm LoginGraceTime
446The server disconnects after this time if the user has not
447successfully logged in.
448If the value is 0, there is no time limit.
Damien Millerc1348632002-09-05 14:35:14 +1000449The default is 120 seconds.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000450.It Cm LogLevel
451Gives the verbosity level that is used when logging messages from
Damien Millerf4f22b52006-03-15 11:57:25 +1100452.Xr sshd 8 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000453The possible values are:
Damien Miller5b0d63f2006-03-15 11:56:56 +1100454QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +1000455The default is INFO.
456DEBUG and DEBUG1 are equivalent.
457DEBUG2 and DEBUG3 each specify higher levels of debugging output.
458Logging with a DEBUG level violates the privacy of users and is not recommended.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000459.It Cm MACs
460Specifies the available MAC (message authentication code) algorithms.
461The MAC algorithm is used in protocol version 2
462for data integrity protection.
463Multiple algorithms must be comma-separated.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100464The default is:
Ben Lindstrom9f049032002-06-21 00:59:05 +0000465.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
Darren Tucker89413db2004-05-24 10:36:23 +1000466.It Cm MaxAuthTries
467Specifies the maximum number of authentication attempts permitted per
Damien Miller26213e52004-06-30 22:39:34 +1000468connection.
469Once the number of failures reaches half this value,
470additional failures are logged.
471The default is 6.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000472.It Cm MaxStartups
473Specifies the maximum number of concurrent unauthenticated connections to the
Damien Miller5b0d63f2006-03-15 11:56:56 +1100474SSH daemon.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000475Additional connections will be dropped until authentication succeeds or the
476.Cm LoginGraceTime
477expires for a connection.
478The default is 10.
479.Pp
480Alternatively, random early drop can be enabled by specifying
481the three colon separated values
482.Dq start:rate:full
Damien Miller208f1ed2006-03-15 11:56:03 +1100483(e.g. "10:30:60").
Damien Millerf4f22b52006-03-15 11:57:25 +1100484.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000485will refuse connection attempts with a probability of
486.Dq rate/100
487(30%)
488if there are currently
489.Dq start
490(10)
491unauthenticated connections.
492The probability increases linearly and all connection attempts
493are refused if the number of unauthenticated connections reaches
494.Dq full
495(60).
496.It Cm PasswordAuthentication
497Specifies whether password authentication is allowed.
498The default is
499.Dq yes .
500.It Cm PermitEmptyPasswords
501When password authentication is allowed, it specifies whether the
502server allows login to accounts with empty password strings.
503The default is
504.Dq no .
505.It Cm PermitRootLogin
Darren Tuckerb3509012005-01-20 11:01:46 +1100506Specifies whether root can log in using
Ben Lindstrom9f049032002-06-21 00:59:05 +0000507.Xr ssh 1 .
508The argument must be
509.Dq yes ,
510.Dq without-password ,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100511.Dq forced-commands-only ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000512or
513.Dq no .
514The default is
515.Dq yes .
516.Pp
517If this option is set to
Damien Miller5b0d63f2006-03-15 11:56:56 +1100518.Dq without-password ,
Darren Tucker9dca0992005-02-01 19:16:45 +1100519password authentication is disabled for root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000520.Pp
521If this option is set to
Damien Miller5b0d63f2006-03-15 11:56:56 +1100522.Dq forced-commands-only ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000523root login with public key authentication will be allowed,
524but only if the
525.Ar command
526option has been specified
527(which may be useful for taking remote backups even if root login is
Damien Millerfbf486b2003-05-23 18:44:23 +1000528normally not allowed).
529All other authentication methods are disabled for root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000530.Pp
531If this option is set to
Damien Miller5b0d63f2006-03-15 11:56:56 +1100532.Dq no ,
Darren Tuckerb3509012005-01-20 11:01:46 +1100533root is not allowed to log in.
Damien Millerd27b9472005-12-13 19:29:02 +1100534.It Cm PermitTunnel
535Specifies whether
536.Xr tun 4
537device forwarding is allowed.
Damien Miller7b58e802005-12-13 19:33:19 +1100538The argument must be
539.Dq yes ,
Damien Miller991dba42006-07-10 20:16:27 +1000540.Dq point-to-point
541(layer 3),
542.Dq ethernet
543(layer 2), or
Damien Miller7b58e802005-12-13 19:33:19 +1100544.Dq no .
Damien Miller991dba42006-07-10 20:16:27 +1000545Specifying
546.Dq yes
547permits both
548.Dq point-to-point
549and
550.Dq ethernet .
Damien Millerd27b9472005-12-13 19:29:02 +1100551The default is
552.Dq no .
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000553.It Cm PermitUserEnvironment
554Specifies whether
555.Pa ~/.ssh/environment
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000556and
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000557.Cm environment=
558options in
559.Pa ~/.ssh/authorized_keys
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000560are processed by
Damien Miller5b0d63f2006-03-15 11:56:56 +1100561.Xr sshd 8 .
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000562The default is
563.Dq no .
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000564Enabling environment processing may enable users to bypass access
565restrictions in some configurations using mechanisms such as
566.Ev LD_PRELOAD .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000567.It Cm PidFile
Ben Lindstrom959de992002-06-23 00:35:25 +0000568Specifies the file that contains the process ID of the
Damien Millerf4f22b52006-03-15 11:57:25 +1100569SSH daemon.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000570The default is
571.Pa /var/run/sshd.pid .
572.It Cm Port
573Specifies the port number that
Damien Miller5b0d63f2006-03-15 11:56:56 +1100574.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000575listens on.
576The default is 22.
577Multiple options of this type are permitted.
578See also
579.Cm ListenAddress .
580.It Cm PrintLastLog
581Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100582.Xr sshd 8
Darren Tucker7cc5c232004-11-05 20:06:59 +1100583should print the date and time of the last user login when a user logs
584in interactively.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000585The default is
586.Dq yes .
587.It Cm PrintMotd
588Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100589.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000590should print
591.Pa /etc/motd
592when a user logs in interactively.
593(On some systems it is also printed by the shell,
594.Pa /etc/profile ,
595or equivalent.)
596The default is
597.Dq yes .
598.It Cm Protocol
599Specifies the protocol versions
Damien Miller5b0d63f2006-03-15 11:56:56 +1100600.Xr sshd 8
Ben Lindstrom9c445542002-07-11 03:59:18 +0000601supports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000602The possible values are
Damien Miller5b0d63f2006-03-15 11:56:56 +1100603.Sq 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000604and
Damien Miller5b0d63f2006-03-15 11:56:56 +1100605.Sq 2 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000606Multiple versions must be comma-separated.
607The default is
608.Dq 2,1 .
Ben Lindstrom9c445542002-07-11 03:59:18 +0000609Note that the order of the protocol list does not indicate preference,
610because the client selects among multiple protocol versions offered
611by the server.
612Specifying
613.Dq 2,1
614is identical to
615.Dq 1,2 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000616.It Cm PubkeyAuthentication
617Specifies whether public key authentication is allowed.
618The default is
619.Dq yes .
620Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000621.It Cm RhostsRSAAuthentication
622Specifies whether rhosts or /etc/hosts.equiv authentication together
623with successful RSA host authentication is allowed.
624The default is
625.Dq no .
626This option applies to protocol version 1 only.
627.It Cm RSAAuthentication
628Specifies whether pure RSA authentication is allowed.
629The default is
630.Dq yes .
631This option applies to protocol version 1 only.
632.It Cm ServerKeyBits
633Defines the number of bits in the ephemeral protocol version 1 server key.
634The minimum value is 512, and the default is 768.
635.It Cm StrictModes
636Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100637.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000638should check file modes and ownership of the
639user's files and home directory before accepting login.
640This is normally desirable because novices sometimes accidentally leave their
641directory or files world-writable.
642The default is
643.Dq yes .
644.It Cm Subsystem
Damien Miller208f1ed2006-03-15 11:56:03 +1100645Configures an external subsystem (e.g. file transfer daemon).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000646Arguments should be a subsystem name and a command to execute upon subsystem
647request.
648The command
649.Xr sftp-server 8
650implements the
651.Dq sftp
652file transfer subsystem.
653By default no subsystems are defined.
654Note that this option applies to protocol version 2 only.
655.It Cm SyslogFacility
656Gives the facility code that is used when logging messages from
Damien Millerf4f22b52006-03-15 11:57:25 +1100657.Xr sshd 8 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000658The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
659LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
660The default is AUTH.
Damien Miller12c150e2003-12-17 16:31:10 +1100661.It Cm TCPKeepAlive
662Specifies whether the system should send TCP keepalive messages to the
663other side.
664If they are sent, death of the connection or crash of one
665of the machines will be properly noticed.
666However, this means that
667connections will die if the route is down temporarily, and some people
668find it annoying.
669On the other hand, if TCP keepalives are not sent,
670sessions may hang indefinitely on the server, leaving
671.Dq ghost
672users and consuming server resources.
673.Pp
674The default is
675.Dq yes
676(to send TCP keepalive messages), and the server will notice
677if the network goes down or the client host crashes.
678This avoids infinitely hanging sessions.
679.Pp
680To disable TCP keepalive messages, the value should be set to
681.Dq no .
Damien Miller3a961dc2003-06-03 10:25:48 +1000682.It Cm UseDNS
683Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100684.Xr sshd 8
Darren Tucker83d5a982005-03-31 21:33:50 +1000685should look up the remote host name and check that
Damien Miller3a961dc2003-06-03 10:25:48 +1000686the resolved host name for the remote IP address maps back to the
687very same IP address.
688The default is
689.Dq yes .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000690.It Cm UseLogin
691Specifies whether
692.Xr login 1
693is used for interactive login sessions.
694The default is
695.Dq no .
696Note that
697.Xr login 1
698is never used for remote command execution.
699Note also, that if this is enabled,
700.Cm X11Forwarding
701will be disabled because
702.Xr login 1
703does not know how to handle
704.Xr xauth 1
Damien Miller495dca32003-04-01 21:42:14 +1000705cookies.
706If
Ben Lindstrom9f049032002-06-21 00:59:05 +0000707.Cm UsePrivilegeSeparation
708is specified, it will be disabled after authentication.
Damien Miller2e193e22003-05-14 15:13:03 +1000709.It Cm UsePAM
Darren Tucker1dcff9a2004-05-13 16:51:40 +1000710Enables the Pluggable Authentication Module interface.
711If set to
712.Dq yes
713this will enable PAM authentication using
714.Cm ChallengeResponseAuthentication
Darren Tuckera4904f72006-02-23 21:35:30 +1100715and
716.Cm PasswordAuthentication
717in addition to PAM account and session module processing for all
718authentication types.
Darren Tucker1dcff9a2004-05-13 16:51:40 +1000719.Pp
720Because PAM challenge-response authentication usually serves an equivalent
721role to password authentication, you should disable either
722.Cm PasswordAuthentication
723or
724.Cm ChallengeResponseAuthentication.
725.Pp
726If
727.Cm UsePAM
728is enabled, you will not be able to run
729.Xr sshd 8
730as a non-root user.
731The default is
Darren Tucker6c0c0702003-10-09 14:13:53 +1000732.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000733.It Cm UsePrivilegeSeparation
734Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100735.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000736separates privileges by creating an unprivileged child process
Damien Miller495dca32003-04-01 21:42:14 +1000737to deal with incoming network traffic.
738After successful authentication, another process will be created that has
739the privilege of the authenticated user.
740The goal of privilege separation is to prevent privilege
Ben Lindstrom9f049032002-06-21 00:59:05 +0000741escalation by containing any corruption within the unprivileged processes.
742The default is
743.Dq yes .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000744.It Cm X11DisplayOffset
745Specifies the first display number available for
Damien Miller5b0d63f2006-03-15 11:56:56 +1100746.Xr sshd 8 Ns 's
Ben Lindstrom9f049032002-06-21 00:59:05 +0000747X11 forwarding.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100748This prevents sshd from interfering with real X11 servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000749The default is 10.
750.It Cm X11Forwarding
751Specifies whether X11 forwarding is permitted.
Damien Miller101c4a72002-09-19 11:51:21 +1000752The argument must be
753.Dq yes
754or
755.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000756The default is
757.Dq no .
Damien Miller101c4a72002-09-19 11:51:21 +1000758.Pp
759When X11 forwarding is enabled, there may be additional exposure to
760the server and to client displays if the
Damien Miller5b0d63f2006-03-15 11:56:56 +1100761.Xr sshd 8
Damien Miller101c4a72002-09-19 11:51:21 +1000762proxy display is configured to listen on the wildcard address (see
763.Cm X11UseLocalhost
Damien Miller5b0d63f2006-03-15 11:56:56 +1100764below), though this is not the default.
Damien Miller101c4a72002-09-19 11:51:21 +1000765Additionally, the authentication spoofing and authentication data
766verification and substitution occur on the client side.
767The security risk of using X11 forwarding is that the client's X11
Damien Miller5b0d63f2006-03-15 11:56:56 +1100768display server may be exposed to attack when the SSH client requests
Damien Miller101c4a72002-09-19 11:51:21 +1000769forwarding (see the warnings for
770.Cm ForwardX11
771in
Damien Millerf1ce5052003-06-11 22:04:39 +1000772.Xr ssh_config 5 ) .
Damien Miller101c4a72002-09-19 11:51:21 +1000773A system administrator may have a stance in which they want to
774protect clients that may expose themselves to attack by unwittingly
775requesting X11 forwarding, which can warrant a
776.Dq no
777setting.
778.Pp
779Note that disabling X11 forwarding does not prevent users from
780forwarding X11 traffic, as users can always install their own forwarders.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000781X11 forwarding is automatically disabled if
782.Cm UseLogin
783is enabled.
784.It Cm X11UseLocalhost
785Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100786.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000787should bind the X11 forwarding server to the loopback address or to
Damien Miller495dca32003-04-01 21:42:14 +1000788the wildcard address.
789By default,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100790sshd binds the forwarding server to the loopback address and sets the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000791hostname part of the
792.Ev DISPLAY
793environment variable to
794.Dq localhost .
Ben Lindstrom15b61202002-08-20 18:44:24 +0000795This prevents remote hosts from connecting to the proxy display.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000796However, some older X11 clients may not function with this
797configuration.
798.Cm X11UseLocalhost
799may be set to
800.Dq no
801to specify that the forwarding server should be bound to the wildcard
802address.
803The argument must be
804.Dq yes
805or
806.Dq no .
807The default is
808.Dq yes .
809.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +1000810Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000811.Xr xauth 1
812program.
813The default is
814.Pa /usr/X11R6/bin/xauth .
815.El
Damien Millere3beba22006-03-15 11:59:25 +1100816.Sh TIME FORMATS
Damien Millerf4f22b52006-03-15 11:57:25 +1100817.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000818command-line arguments and configuration file options that specify time
819may be expressed using a sequence of the form:
820.Sm off
Ben Lindstrom1f8cf4f2002-08-20 18:43:27 +0000821.Ar time Op Ar qualifier ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000822.Sm on
823where
824.Ar time
825is a positive integer value and
826.Ar qualifier
827is one of the following:
828.Pp
829.Bl -tag -width Ds -compact -offset indent
830.It Cm <none>
831seconds
832.It Cm s | Cm S
833seconds
834.It Cm m | Cm M
835minutes
836.It Cm h | Cm H
837hours
838.It Cm d | Cm D
839days
840.It Cm w | Cm W
841weeks
842.El
843.Pp
844Each member of the sequence is added together to calculate
845the total time value.
846.Pp
847Time format examples:
848.Pp
849.Bl -tag -width Ds -compact -offset indent
850.It 600
851600 seconds (10 minutes)
852.It 10m
85310 minutes
854.It 1h30m
8551 hour 30 minutes (90 minutes)
856.El
857.Sh FILES
858.Bl -tag -width Ds
859.It Pa /etc/ssh/sshd_config
860Contains configuration data for
Damien Millerf4f22b52006-03-15 11:57:25 +1100861.Xr sshd 8 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000862This file should be writable by root only, but it is recommended
863(though not necessary) that it be world-readable.
864.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000865.Sh SEE ALSO
866.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000867.Sh AUTHORS
868OpenSSH is a derivative of the original and free
869ssh 1.2.12 release by Tatu Ylonen.
870Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
871Theo de Raadt and Dug Song
872removed many bugs, re-added newer features and
873created OpenSSH.
874Markus Friedl contributed the support for SSH
875protocol versions 1.5 and 2.0.
876Niels Provos and Markus Friedl contributed support
877for privilege separation.