blob: 1bd3a624fdae497b024eecb46f36d03022c821e0 [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 Miller306d1182006-03-15 12:05:59 +110037.\" $OpenBSD: sshd_config.5,v 1.56 2006/03/13 10:14:29 dtucker 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 Miller1594ad52005-05-26 12:12:19 +1000226.It Cm ClientAliveInterval
227Sets a timeout interval in seconds after which if no data has been received
228from the client,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100229.Xr sshd 8
Damien Miller1594ad52005-05-26 12:12:19 +1000230will send a message through the encrypted
231channel to request a response from the client.
232The default
233is 0, indicating that these messages will not be sent to the client.
234This option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000235.It Cm Compression
Damien Miller9786e6e2005-07-26 21:54:56 +1000236Specifies whether compression is allowed, or delayed until
237the user has authenticated successfully.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000238The argument must be
Damien Miller9786e6e2005-07-26 21:54:56 +1000239.Dq yes ,
240.Dq delayed ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000241or
242.Dq no .
243The default is
Damien Miller9786e6e2005-07-26 21:54:56 +1000244.Dq delayed .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000245.It Cm DenyGroups
246This keyword can be followed by a list of group name patterns, separated
247by spaces.
248Login is disallowed for users whose primary group or supplementary
249group list matches one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000250Only group names are valid; a numerical group ID is not recognized.
251By default, login is allowed for all groups.
Damien Millerac73e512006-03-15 11:58:49 +1100252The allow/deny directives are processed in the following order:
253.Cm DenyUsers ,
254.Cm AllowUsers ,
255.Cm DenyGroups ,
256and finally
257.Cm AllowGroups .
Damien Miller0c2079d2006-03-15 11:54:21 +1100258.Pp
259See
260.Sx PATTERNS
261in
262.Xr ssh_config 5
263for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000264.It Cm DenyUsers
265This keyword can be followed by a list of user name patterns, separated
266by spaces.
267Login is disallowed for user names that match one of the patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000268Only user names are valid; a numerical user ID is not recognized.
269By default, login is allowed for all users.
270If the pattern takes the form USER@HOST then USER and HOST
271are separately checked, restricting logins to particular
272users from particular hosts.
Damien Millerac73e512006-03-15 11:58:49 +1100273The allow/deny directives are processed in the following order:
274.Cm DenyUsers ,
275.Cm AllowUsers ,
276.Cm DenyGroups ,
277and finally
278.Cm AllowGroups .
Damien Miller0c2079d2006-03-15 11:54:21 +1100279.Pp
280See
281.Sx PATTERNS
282in
283.Xr ssh_config 5
284for more information on patterns.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000285.It Cm GatewayPorts
286Specifies whether remote hosts are allowed to connect to ports
287forwarded for the client.
288By default,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100289.Xr sshd 8
Damien Miller495dca32003-04-01 21:42:14 +1000290binds remote port forwardings to the loopback address.
291This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000292.Cm GatewayPorts
Damien Miller5b0d63f2006-03-15 11:56:56 +1100293can be used to specify that sshd
Damien Millerf91ee4c2005-03-01 21:24:33 +1100294should allow remote port forwardings to bind to non-loopback addresses, thus
295allowing other hosts to connect.
296The argument may be
297.Dq no
298to force remote port forwardings to be available to the local host only,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000299.Dq yes
Damien Millerf91ee4c2005-03-01 21:24:33 +1100300to force remote port forwardings to bind to the wildcard address, or
301.Dq clientspecified
302to allow the client to select the address to which the forwarding is bound.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000303The default is
304.Dq no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000305.It Cm GSSAPIAuthentication
Damien Miller9b7b03b2003-09-02 22:57:05 +1000306Specifies whether user authentication based on GSSAPI is allowed.
Damien Millera8e06ce2003-11-21 23:48:55 +1100307The default is
Darren Tucker0efd1552003-08-26 11:49:55 +1000308.Dq no .
309Note that this option applies to protocol version 2 only.
310.It Cm GSSAPICleanupCredentials
311Specifies whether to automatically destroy the user's credentials cache
312on logout.
313The default is
314.Dq yes .
315Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000316.It Cm HostbasedAuthentication
317Specifies whether rhosts or /etc/hosts.equiv authentication together
318with successful public key client host authentication is allowed
Damien Miller1faa7132006-03-15 11:55:31 +1100319(host-based authentication).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000320This option is similar to
321.Cm RhostsRSAAuthentication
322and applies to protocol version 2 only.
323The default is
324.Dq no .
325.It Cm HostKey
326Specifies a file containing a private host key
327used by SSH.
328The default is
329.Pa /etc/ssh/ssh_host_key
330for protocol version 1, and
331.Pa /etc/ssh/ssh_host_rsa_key
332and
333.Pa /etc/ssh/ssh_host_dsa_key
334for protocol version 2.
335Note that
Damien Miller5b0d63f2006-03-15 11:56:56 +1100336.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000337will refuse to use a file if it is group/world-accessible.
338It is possible to have multiple host key files.
339.Dq rsa1
340keys are used for version 1 and
341.Dq dsa
342or
343.Dq rsa
344are used for version 2 of the SSH protocol.
345.It Cm IgnoreRhosts
346Specifies that
347.Pa .rhosts
348and
349.Pa .shosts
350files will not be used in
Ben Lindstrom9f049032002-06-21 00:59:05 +0000351.Cm RhostsRSAAuthentication
352or
353.Cm HostbasedAuthentication .
354.Pp
355.Pa /etc/hosts.equiv
356and
357.Pa /etc/shosts.equiv
358are still used.
359The default is
360.Dq yes .
361.It Cm IgnoreUserKnownHosts
362Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100363.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000364should ignore the user's
Damien Miller167ea5d2005-05-26 12:04:02 +1000365.Pa ~/.ssh/known_hosts
Ben Lindstrom9f049032002-06-21 00:59:05 +0000366during
367.Cm RhostsRSAAuthentication
368or
369.Cm HostbasedAuthentication .
370The default is
371.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000372.It Cm KerberosAuthentication
Damien Miller1a0c0b92003-09-02 22:51:17 +1000373Specifies whether the password provided by the user for
Ben Lindstrom9f049032002-06-21 00:59:05 +0000374.Cm PasswordAuthentication
Damien Miller1a0c0b92003-09-02 22:51:17 +1000375will be validated through the Kerberos KDC.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000376To use this option, the server needs a
377Kerberos servtab which allows the verification of the KDC's identity.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100378The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000379.Dq no .
Damien Miller8448e662004-03-08 23:13:15 +1100380.It Cm KerberosGetAFSToken
Darren Tuckere2dd2d52005-10-03 18:19:06 +1000381If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
Damien Miller8448e662004-03-08 23:13:15 +1100382an AFS token before accessing the user's home directory.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100383The default is
Damien Miller8448e662004-03-08 23:13:15 +1100384.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000385.It Cm KerberosOrLocalPasswd
Damien Miller5b0d63f2006-03-15 11:56:56 +1100386If password authentication through Kerberos fails then
Ben Lindstrom9f049032002-06-21 00:59:05 +0000387the password will be validated via any additional local mechanism
388such as
389.Pa /etc/passwd .
Damien Miller5b0d63f2006-03-15 11:56:56 +1100390The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000391.Dq yes .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000392.It Cm KerberosTicketCleanup
393Specifies whether to automatically destroy the user's ticket cache
394file on logout.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100395The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000396.Dq yes .
397.It Cm KeyRegenerationInterval
398In protocol version 1, the ephemeral server key is automatically regenerated
399after this many seconds (if it has been used).
400The purpose of regeneration is to prevent
401decrypting captured sessions by later breaking into the machine and
402stealing the keys.
403The key is never stored anywhere.
404If the value is 0, the key is never regenerated.
405The default is 3600 (seconds).
406.It Cm ListenAddress
407Specifies the local addresses
Damien Miller5b0d63f2006-03-15 11:56:56 +1100408.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000409should listen on.
410The following forms may be used:
411.Pp
412.Bl -item -offset indent -compact
413.It
414.Cm ListenAddress
415.Sm off
416.Ar host No | Ar IPv4_addr No | Ar IPv6_addr
417.Sm on
418.It
419.Cm ListenAddress
420.Sm off
421.Ar host No | Ar IPv4_addr No : Ar port
422.Sm on
423.It
424.Cm ListenAddress
425.Sm off
426.Oo
427.Ar host No | Ar IPv6_addr Oc : Ar port
428.Sm on
429.El
430.Pp
431If
432.Ar port
433is not specified,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100434sshd will listen on the address and all prior
Ben Lindstrom9f049032002-06-21 00:59:05 +0000435.Cm Port
Damien Millerfbf486b2003-05-23 18:44:23 +1000436options specified.
437The default is to listen on all local addresses.
Damien Miller495dca32003-04-01 21:42:14 +1000438Multiple
Ben Lindstrom9f049032002-06-21 00:59:05 +0000439.Cm ListenAddress
Damien Millerfbf486b2003-05-23 18:44:23 +1000440options are permitted.
441Additionally, any
Ben Lindstrom9f049032002-06-21 00:59:05 +0000442.Cm Port
Damien Miller5b0d63f2006-03-15 11:56:56 +1100443options must precede this option for non-port qualified addresses.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000444.It Cm LoginGraceTime
445The server disconnects after this time if the user has not
446successfully logged in.
447If the value is 0, there is no time limit.
Damien Millerc1348632002-09-05 14:35:14 +1000448The default is 120 seconds.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000449.It Cm LogLevel
450Gives the verbosity level that is used when logging messages from
Damien Millerf4f22b52006-03-15 11:57:25 +1100451.Xr sshd 8 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000452The possible values are:
Damien Miller5b0d63f2006-03-15 11:56:56 +1100453QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +1000454The default is INFO.
455DEBUG and DEBUG1 are equivalent.
456DEBUG2 and DEBUG3 each specify higher levels of debugging output.
457Logging with a DEBUG level violates the privacy of users and is not recommended.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000458.It Cm MACs
459Specifies the available MAC (message authentication code) algorithms.
460The MAC algorithm is used in protocol version 2
461for data integrity protection.
462Multiple algorithms must be comma-separated.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100463The default is:
Ben Lindstrom9f049032002-06-21 00:59:05 +0000464.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
Darren Tucker89413db2004-05-24 10:36:23 +1000465.It Cm MaxAuthTries
466Specifies the maximum number of authentication attempts permitted per
Damien Miller26213e52004-06-30 22:39:34 +1000467connection.
468Once the number of failures reaches half this value,
469additional failures are logged.
470The default is 6.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000471.It Cm MaxStartups
472Specifies the maximum number of concurrent unauthenticated connections to the
Damien Miller5b0d63f2006-03-15 11:56:56 +1100473SSH daemon.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000474Additional connections will be dropped until authentication succeeds or the
475.Cm LoginGraceTime
476expires for a connection.
477The default is 10.
478.Pp
479Alternatively, random early drop can be enabled by specifying
480the three colon separated values
481.Dq start:rate:full
Damien Miller208f1ed2006-03-15 11:56:03 +1100482(e.g. "10:30:60").
Damien Millerf4f22b52006-03-15 11:57:25 +1100483.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000484will refuse connection attempts with a probability of
485.Dq rate/100
486(30%)
487if there are currently
488.Dq start
489(10)
490unauthenticated connections.
491The probability increases linearly and all connection attempts
492are refused if the number of unauthenticated connections reaches
493.Dq full
494(60).
495.It Cm PasswordAuthentication
496Specifies whether password authentication is allowed.
497The default is
498.Dq yes .
499.It Cm PermitEmptyPasswords
500When password authentication is allowed, it specifies whether the
501server allows login to accounts with empty password strings.
502The default is
503.Dq no .
504.It Cm PermitRootLogin
Darren Tuckerb3509012005-01-20 11:01:46 +1100505Specifies whether root can log in using
Ben Lindstrom9f049032002-06-21 00:59:05 +0000506.Xr ssh 1 .
507The argument must be
508.Dq yes ,
509.Dq without-password ,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100510.Dq forced-commands-only ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000511or
512.Dq no .
513The default is
514.Dq yes .
515.Pp
516If this option is set to
Damien Miller5b0d63f2006-03-15 11:56:56 +1100517.Dq without-password ,
Darren Tucker9dca0992005-02-01 19:16:45 +1100518password authentication is disabled for root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000519.Pp
520If this option is set to
Damien Miller5b0d63f2006-03-15 11:56:56 +1100521.Dq forced-commands-only ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000522root login with public key authentication will be allowed,
523but only if the
524.Ar command
525option has been specified
526(which may be useful for taking remote backups even if root login is
Damien Millerfbf486b2003-05-23 18:44:23 +1000527normally not allowed).
528All other authentication methods are disabled for root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000529.Pp
530If this option is set to
Damien Miller5b0d63f2006-03-15 11:56:56 +1100531.Dq no ,
Darren Tuckerb3509012005-01-20 11:01:46 +1100532root is not allowed to log in.
Damien Millerd27b9472005-12-13 19:29:02 +1100533.It Cm PermitTunnel
534Specifies whether
535.Xr tun 4
536device forwarding is allowed.
Damien Miller7b58e802005-12-13 19:33:19 +1100537The argument must be
538.Dq yes ,
539.Dq point-to-point ,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100540.Dq ethernet ,
Damien Miller7b58e802005-12-13 19:33:19 +1100541or
542.Dq no .
Damien Millerd27b9472005-12-13 19:29:02 +1100543The default is
544.Dq no .
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000545.It Cm PermitUserEnvironment
546Specifies whether
547.Pa ~/.ssh/environment
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000548and
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000549.Cm environment=
550options in
551.Pa ~/.ssh/authorized_keys
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000552are processed by
Damien Miller5b0d63f2006-03-15 11:56:56 +1100553.Xr sshd 8 .
Ben Lindstrom5d860f02002-08-01 01:28:38 +0000554The default is
555.Dq no .
Ben Lindstrombd9bf382002-08-20 18:54:20 +0000556Enabling environment processing may enable users to bypass access
557restrictions in some configurations using mechanisms such as
558.Ev LD_PRELOAD .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000559.It Cm PidFile
Ben Lindstrom959de992002-06-23 00:35:25 +0000560Specifies the file that contains the process ID of the
Damien Millerf4f22b52006-03-15 11:57:25 +1100561SSH daemon.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000562The default is
563.Pa /var/run/sshd.pid .
564.It Cm Port
565Specifies the port number that
Damien Miller5b0d63f2006-03-15 11:56:56 +1100566.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000567listens on.
568The default is 22.
569Multiple options of this type are permitted.
570See also
571.Cm ListenAddress .
572.It Cm PrintLastLog
573Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100574.Xr sshd 8
Darren Tucker7cc5c232004-11-05 20:06:59 +1100575should print the date and time of the last user login when a user logs
576in interactively.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000577The default is
578.Dq yes .
579.It Cm PrintMotd
580Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100581.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000582should print
583.Pa /etc/motd
584when a user logs in interactively.
585(On some systems it is also printed by the shell,
586.Pa /etc/profile ,
587or equivalent.)
588The default is
589.Dq yes .
590.It Cm Protocol
591Specifies the protocol versions
Damien Miller5b0d63f2006-03-15 11:56:56 +1100592.Xr sshd 8
Ben Lindstrom9c445542002-07-11 03:59:18 +0000593supports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000594The possible values are
Damien Miller5b0d63f2006-03-15 11:56:56 +1100595.Sq 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000596and
Damien Miller5b0d63f2006-03-15 11:56:56 +1100597.Sq 2 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000598Multiple versions must be comma-separated.
599The default is
600.Dq 2,1 .
Ben Lindstrom9c445542002-07-11 03:59:18 +0000601Note that the order of the protocol list does not indicate preference,
602because the client selects among multiple protocol versions offered
603by the server.
604Specifying
605.Dq 2,1
606is identical to
607.Dq 1,2 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000608.It Cm PubkeyAuthentication
609Specifies whether public key authentication is allowed.
610The default is
611.Dq yes .
612Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000613.It Cm RhostsRSAAuthentication
614Specifies whether rhosts or /etc/hosts.equiv authentication together
615with successful RSA host authentication is allowed.
616The default is
617.Dq no .
618This option applies to protocol version 1 only.
619.It Cm RSAAuthentication
620Specifies whether pure RSA authentication is allowed.
621The default is
622.Dq yes .
623This option applies to protocol version 1 only.
624.It Cm ServerKeyBits
625Defines the number of bits in the ephemeral protocol version 1 server key.
626The minimum value is 512, and the default is 768.
627.It Cm StrictModes
628Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100629.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000630should check file modes and ownership of the
631user's files and home directory before accepting login.
632This is normally desirable because novices sometimes accidentally leave their
633directory or files world-writable.
634The default is
635.Dq yes .
636.It Cm Subsystem
Damien Miller208f1ed2006-03-15 11:56:03 +1100637Configures an external subsystem (e.g. file transfer daemon).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000638Arguments should be a subsystem name and a command to execute upon subsystem
639request.
640The command
641.Xr sftp-server 8
642implements the
643.Dq sftp
644file transfer subsystem.
645By default no subsystems are defined.
646Note that this option applies to protocol version 2 only.
647.It Cm SyslogFacility
648Gives the facility code that is used when logging messages from
Damien Millerf4f22b52006-03-15 11:57:25 +1100649.Xr sshd 8 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000650The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
651LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
652The default is AUTH.
Damien Miller12c150e2003-12-17 16:31:10 +1100653.It Cm TCPKeepAlive
654Specifies whether the system should send TCP keepalive messages to the
655other side.
656If they are sent, death of the connection or crash of one
657of the machines will be properly noticed.
658However, this means that
659connections will die if the route is down temporarily, and some people
660find it annoying.
661On the other hand, if TCP keepalives are not sent,
662sessions may hang indefinitely on the server, leaving
663.Dq ghost
664users and consuming server resources.
665.Pp
666The default is
667.Dq yes
668(to send TCP keepalive messages), and the server will notice
669if the network goes down or the client host crashes.
670This avoids infinitely hanging sessions.
671.Pp
672To disable TCP keepalive messages, the value should be set to
673.Dq no .
Damien Miller3a961dc2003-06-03 10:25:48 +1000674.It Cm UseDNS
675Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100676.Xr sshd 8
Darren Tucker83d5a982005-03-31 21:33:50 +1000677should look up the remote host name and check that
Damien Miller3a961dc2003-06-03 10:25:48 +1000678the resolved host name for the remote IP address maps back to the
679very same IP address.
680The default is
681.Dq yes .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000682.It Cm UseLogin
683Specifies whether
684.Xr login 1
685is used for interactive login sessions.
686The default is
687.Dq no .
688Note that
689.Xr login 1
690is never used for remote command execution.
691Note also, that if this is enabled,
692.Cm X11Forwarding
693will be disabled because
694.Xr login 1
695does not know how to handle
696.Xr xauth 1
Damien Miller495dca32003-04-01 21:42:14 +1000697cookies.
698If
Ben Lindstrom9f049032002-06-21 00:59:05 +0000699.Cm UsePrivilegeSeparation
700is specified, it will be disabled after authentication.
Damien Miller2e193e22003-05-14 15:13:03 +1000701.It Cm UsePAM
Darren Tucker1dcff9a2004-05-13 16:51:40 +1000702Enables the Pluggable Authentication Module interface.
703If set to
704.Dq yes
705this will enable PAM authentication using
706.Cm ChallengeResponseAuthentication
Darren Tuckera4904f72006-02-23 21:35:30 +1100707and
708.Cm PasswordAuthentication
709in addition to PAM account and session module processing for all
710authentication types.
Darren Tucker1dcff9a2004-05-13 16:51:40 +1000711.Pp
712Because PAM challenge-response authentication usually serves an equivalent
713role to password authentication, you should disable either
714.Cm PasswordAuthentication
715or
716.Cm ChallengeResponseAuthentication.
717.Pp
718If
719.Cm UsePAM
720is enabled, you will not be able to run
721.Xr sshd 8
722as a non-root user.
723The default is
Darren Tucker6c0c0702003-10-09 14:13:53 +1000724.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000725.It Cm UsePrivilegeSeparation
726Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100727.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000728separates privileges by creating an unprivileged child process
Damien Miller495dca32003-04-01 21:42:14 +1000729to deal with incoming network traffic.
730After successful authentication, another process will be created that has
731the privilege of the authenticated user.
732The goal of privilege separation is to prevent privilege
Ben Lindstrom9f049032002-06-21 00:59:05 +0000733escalation by containing any corruption within the unprivileged processes.
734The default is
735.Dq yes .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000736.It Cm X11DisplayOffset
737Specifies the first display number available for
Damien Miller5b0d63f2006-03-15 11:56:56 +1100738.Xr sshd 8 Ns 's
Ben Lindstrom9f049032002-06-21 00:59:05 +0000739X11 forwarding.
Damien Miller5b0d63f2006-03-15 11:56:56 +1100740This prevents sshd from interfering with real X11 servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000741The default is 10.
742.It Cm X11Forwarding
743Specifies whether X11 forwarding is permitted.
Damien Miller101c4a72002-09-19 11:51:21 +1000744The argument must be
745.Dq yes
746or
747.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000748The default is
749.Dq no .
Damien Miller101c4a72002-09-19 11:51:21 +1000750.Pp
751When X11 forwarding is enabled, there may be additional exposure to
752the server and to client displays if the
Damien Miller5b0d63f2006-03-15 11:56:56 +1100753.Xr sshd 8
Damien Miller101c4a72002-09-19 11:51:21 +1000754proxy display is configured to listen on the wildcard address (see
755.Cm X11UseLocalhost
Damien Miller5b0d63f2006-03-15 11:56:56 +1100756below), though this is not the default.
Damien Miller101c4a72002-09-19 11:51:21 +1000757Additionally, the authentication spoofing and authentication data
758verification and substitution occur on the client side.
759The security risk of using X11 forwarding is that the client's X11
Damien Miller5b0d63f2006-03-15 11:56:56 +1100760display server may be exposed to attack when the SSH client requests
Damien Miller101c4a72002-09-19 11:51:21 +1000761forwarding (see the warnings for
762.Cm ForwardX11
763in
Damien Millerf1ce5052003-06-11 22:04:39 +1000764.Xr ssh_config 5 ) .
Damien Miller101c4a72002-09-19 11:51:21 +1000765A system administrator may have a stance in which they want to
766protect clients that may expose themselves to attack by unwittingly
767requesting X11 forwarding, which can warrant a
768.Dq no
769setting.
770.Pp
771Note that disabling X11 forwarding does not prevent users from
772forwarding X11 traffic, as users can always install their own forwarders.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000773X11 forwarding is automatically disabled if
774.Cm UseLogin
775is enabled.
776.It Cm X11UseLocalhost
777Specifies whether
Damien Miller5b0d63f2006-03-15 11:56:56 +1100778.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000779should bind the X11 forwarding server to the loopback address or to
Damien Miller495dca32003-04-01 21:42:14 +1000780the wildcard address.
781By default,
Damien Miller5b0d63f2006-03-15 11:56:56 +1100782sshd binds the forwarding server to the loopback address and sets the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000783hostname part of the
784.Ev DISPLAY
785environment variable to
786.Dq localhost .
Ben Lindstrom15b61202002-08-20 18:44:24 +0000787This prevents remote hosts from connecting to the proxy display.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000788However, some older X11 clients may not function with this
789configuration.
790.Cm X11UseLocalhost
791may be set to
792.Dq no
793to specify that the forwarding server should be bound to the wildcard
794address.
795The argument must be
796.Dq yes
797or
798.Dq no .
799The default is
800.Dq yes .
801.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +1000802Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000803.Xr xauth 1
804program.
805The default is
806.Pa /usr/X11R6/bin/xauth .
807.El
Damien Millere3beba22006-03-15 11:59:25 +1100808.Sh TIME FORMATS
Damien Millerf4f22b52006-03-15 11:57:25 +1100809.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000810command-line arguments and configuration file options that specify time
811may be expressed using a sequence of the form:
812.Sm off
Ben Lindstrom1f8cf4f2002-08-20 18:43:27 +0000813.Ar time Op Ar qualifier ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000814.Sm on
815where
816.Ar time
817is a positive integer value and
818.Ar qualifier
819is one of the following:
820.Pp
821.Bl -tag -width Ds -compact -offset indent
822.It Cm <none>
823seconds
824.It Cm s | Cm S
825seconds
826.It Cm m | Cm M
827minutes
828.It Cm h | Cm H
829hours
830.It Cm d | Cm D
831days
832.It Cm w | Cm W
833weeks
834.El
835.Pp
836Each member of the sequence is added together to calculate
837the total time value.
838.Pp
839Time format examples:
840.Pp
841.Bl -tag -width Ds -compact -offset indent
842.It 600
843600 seconds (10 minutes)
844.It 10m
84510 minutes
846.It 1h30m
8471 hour 30 minutes (90 minutes)
848.El
849.Sh FILES
850.Bl -tag -width Ds
851.It Pa /etc/ssh/sshd_config
852Contains configuration data for
Damien Millerf4f22b52006-03-15 11:57:25 +1100853.Xr sshd 8 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000854This file should be writable by root only, but it is recommended
855(though not necessary) that it be world-readable.
856.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000857.Sh SEE ALSO
858.Xr sshd 8
Ben Lindstrom9f049032002-06-21 00:59:05 +0000859.Sh AUTHORS
860OpenSSH is a derivative of the original and free
861ssh 1.2.12 release by Tatu Ylonen.
862Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
863Theo de Raadt and Dug Song
864removed many bugs, re-added newer features and
865created OpenSSH.
866Markus Friedl contributed the support for SSH
867protocol versions 1.5 and 2.0.
868Niels Provos and Markus Friedl contributed support
869for privilege separation.