Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1 | .\" -*- 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 Miller | cc3e8ba | 2006-03-15 12:06:55 +1100 | [diff] [blame] | 37 | .\" $OpenBSD: sshd_config.5,v 1.57 2006/03/14 16:32:48 markus Exp $ |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 38 | .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 Miller | f4f22b5 | 2006-03-15 11:57:25 +1100 | [diff] [blame] | 49 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 50 | reads configuration data from |
| 51 | .Pa /etc/ssh/sshd_config |
| 52 | (or the file specified with |
| 53 | .Fl f |
| 54 | on the command line). |
| 55 | The file contains keyword-argument pairs, one per line. |
| 56 | Lines starting with |
| 57 | .Ql # |
| 58 | and empty lines are interpreted as comments. |
Damien Miller | 306d118 | 2006-03-15 12:05:59 +1100 | [diff] [blame] | 59 | Arguments may optionally be enclosed in double quotes |
| 60 | .Pq \&" |
| 61 | in order to represent arguments containing spaces. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 62 | .Pp |
| 63 | The possible |
| 64 | keywords and their meanings are as follows (note that |
| 65 | keywords are case-insensitive and arguments are case-sensitive): |
| 66 | .Bl -tag -width Ds |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 67 | .It Cm AcceptEnv |
| 68 | Specifies what environment variables sent by the client will be copied into |
| 69 | the session's |
| 70 | .Xr environ 7 . |
| 71 | See |
| 72 | .Cm SendEnv |
| 73 | in |
| 74 | .Xr ssh_config 5 |
| 75 | for how to configure the client. |
Darren Tucker | 1e0c9bf | 2004-05-02 22:12:48 +1000 | [diff] [blame] | 76 | Note that environment passing is only supported for protocol 2. |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 77 | Variables are specified by name, which may contain the wildcard characters |
Damien Miller | 208f1ed | 2006-03-15 11:56:03 +1100 | [diff] [blame] | 78 | .Ql * |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 79 | and |
| 80 | .Ql \&? . |
Darren Tucker | 1e0c9bf | 2004-05-02 22:12:48 +1000 | [diff] [blame] | 81 | Multiple environment variables may be separated by whitespace or spread |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 82 | across multiple |
| 83 | .Cm AcceptEnv |
| 84 | directives. |
Darren Tucker | 1e0c9bf | 2004-05-02 22:12:48 +1000 | [diff] [blame] | 85 | Be warned that some environment variables could be used to bypass restricted |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 86 | user environments. |
| 87 | For this reason, care should be taken in the use of this directive. |
| 88 | The default is not to accept any environment variables. |
Darren Tucker | 0f38323 | 2005-01-20 10:57:56 +1100 | [diff] [blame] | 89 | .It Cm AddressFamily |
| 90 | Specifies which address family should be used by |
Damien Miller | f4f22b5 | 2006-03-15 11:57:25 +1100 | [diff] [blame] | 91 | .Xr sshd 8 . |
Darren Tucker | 0f38323 | 2005-01-20 10:57:56 +1100 | [diff] [blame] | 92 | Valid arguments are |
| 93 | .Dq any , |
| 94 | .Dq inet |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 95 | (use IPv4 only), or |
Darren Tucker | 0f38323 | 2005-01-20 10:57:56 +1100 | [diff] [blame] | 96 | .Dq inet6 |
| 97 | (use IPv6 only). |
| 98 | The default is |
| 99 | .Dq any . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 100 | .It Cm AllowGroups |
| 101 | This keyword can be followed by a list of group name patterns, separated |
| 102 | by spaces. |
| 103 | If specified, login is allowed only for users whose primary |
| 104 | group or supplementary group list matches one of the patterns. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 105 | Only group names are valid; a numerical group ID is not recognized. |
| 106 | By default, login is allowed for all groups. |
Damien Miller | ac73e51 | 2006-03-15 11:58:49 +1100 | [diff] [blame] | 107 | The allow/deny directives are processed in the following order: |
| 108 | .Cm DenyUsers , |
| 109 | .Cm AllowUsers , |
| 110 | .Cm DenyGroups , |
| 111 | and finally |
| 112 | .Cm AllowGroups . |
Damien Miller | 0c2079d | 2006-03-15 11:54:21 +1100 | [diff] [blame] | 113 | .Pp |
| 114 | See |
| 115 | .Sx PATTERNS |
| 116 | in |
| 117 | .Xr ssh_config 5 |
| 118 | for more information on patterns. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 119 | .It Cm AllowTcpForwarding |
| 120 | Specifies whether TCP forwarding is permitted. |
| 121 | The default is |
| 122 | .Dq yes . |
| 123 | Note that disabling TCP forwarding does not improve security unless |
| 124 | users are also denied shell access, as they can always install their |
| 125 | own forwarders. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 126 | .It Cm AllowUsers |
| 127 | This keyword can be followed by a list of user name patterns, separated |
| 128 | by spaces. |
Damien Miller | 5a93add | 2003-01-24 11:34:52 +1100 | [diff] [blame] | 129 | If specified, login is allowed only for user names that |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 130 | match one of the patterns. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 131 | Only user names are valid; a numerical user ID is not recognized. |
| 132 | By default, login is allowed for all users. |
| 133 | If the pattern takes the form USER@HOST then USER and HOST |
| 134 | are separately checked, restricting logins to particular |
| 135 | users from particular hosts. |
Damien Miller | ac73e51 | 2006-03-15 11:58:49 +1100 | [diff] [blame] | 136 | The allow/deny directives are processed in the following order: |
| 137 | .Cm DenyUsers , |
| 138 | .Cm AllowUsers , |
| 139 | .Cm DenyGroups , |
| 140 | and finally |
| 141 | .Cm AllowGroups . |
Damien Miller | 0c2079d | 2006-03-15 11:54:21 +1100 | [diff] [blame] | 142 | .Pp |
| 143 | See |
| 144 | .Sx PATTERNS |
| 145 | in |
| 146 | .Xr ssh_config 5 |
| 147 | for more information on patterns. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 148 | .It Cm AuthorizedKeysFile |
| 149 | Specifies the file that contains the public keys that can be used |
| 150 | for user authentication. |
| 151 | .Cm AuthorizedKeysFile |
| 152 | may contain tokens of the form %T which are substituted during connection |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 153 | setup. |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 154 | The following tokens are defined: %% is replaced by a literal '%', |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 155 | %h is replaced by the home directory of the user being authenticated, and |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 156 | %u is replaced by the username of that user. |
| 157 | After expansion, |
| 158 | .Cm AuthorizedKeysFile |
| 159 | is taken to be an absolute path or one relative to the user's home |
| 160 | directory. |
| 161 | The default is |
| 162 | .Dq .ssh/authorized_keys . |
| 163 | .It Cm Banner |
| 164 | In some jurisdictions, sending a warning message before authentication |
| 165 | may be relevant for getting legal protection. |
| 166 | The contents of the specified file are sent to the remote user before |
| 167 | authentication is allowed. |
| 168 | This option is only available for protocol version 2. |
| 169 | By default, no banner is displayed. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 170 | .It Cm ChallengeResponseAuthentication |
Damien Miller | 1faa713 | 2006-03-15 11:55:31 +1100 | [diff] [blame] | 171 | Specifies whether challenge-response authentication is allowed. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 172 | All authentication styles from |
| 173 | .Xr login.conf 5 |
| 174 | are supported. |
| 175 | The default is |
| 176 | .Dq yes . |
| 177 | .It Cm Ciphers |
| 178 | Specifies the ciphers allowed for protocol version 2. |
| 179 | Multiple ciphers must be comma-separated. |
Damien Miller | 05202ff | 2004-06-15 10:30:39 +1000 | [diff] [blame] | 180 | The 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 Miller | 3710f27 | 2005-05-26 12:19:17 +1000 | [diff] [blame] | 188 | .Dq arcfour128 , |
| 189 | .Dq arcfour256 , |
Damien Miller | 05202ff | 2004-06-15 10:30:39 +1000 | [diff] [blame] | 190 | .Dq arcfour , |
| 191 | .Dq blowfish-cbc , |
| 192 | and |
| 193 | .Dq cast128-cbc . |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 194 | The default is: |
| 195 | .Bd -literal -offset 3n |
| 196 | aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128, |
| 197 | arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr, |
| 198 | aes192-ctr,aes256-ctr |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 199 | .Ed |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 200 | .It Cm ClientAliveCountMax |
Damien Miller | b797770 | 2006-01-03 18:47:31 +1100 | [diff] [blame] | 201 | Sets the number of client alive messages (see below) which may be |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 202 | sent without |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 203 | .Xr sshd 8 |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 204 | receiving any messages back from the client. |
| 205 | If this threshold is reached while client alive messages are being sent, |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 206 | sshd will disconnect the client, terminating the session. |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 207 | It is important to note that the use of client alive messages is very |
| 208 | different from |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 209 | .Cm TCPKeepAlive |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 210 | (below). |
| 211 | The client alive messages are sent through the encrypted channel |
| 212 | and therefore will not be spoofable. |
| 213 | The TCP keepalive option enabled by |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 214 | .Cm TCPKeepAlive |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 215 | is spoofable. |
| 216 | The client alive mechanism is valuable when the client or |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 217 | server depend on knowing when a connection has become inactive. |
| 218 | .Pp |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 219 | The default value is 3. |
| 220 | If |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 221 | .Cm ClientAliveInterval |
Damien Miller | b797770 | 2006-01-03 18:47:31 +1100 | [diff] [blame] | 222 | (see below) is set to 15, and |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 223 | .Cm ClientAliveCountMax |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 224 | is left at the default, unresponsive SSH clients |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 225 | will be disconnected after approximately 45 seconds. |
Damien Miller | cc3e8ba | 2006-03-15 12:06:55 +1100 | [diff] [blame] | 226 | This option applies to protocol version 2 only. |
Damien Miller | 1594ad5 | 2005-05-26 12:12:19 +1000 | [diff] [blame] | 227 | .It Cm ClientAliveInterval |
| 228 | Sets a timeout interval in seconds after which if no data has been received |
| 229 | from the client, |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 230 | .Xr sshd 8 |
Damien Miller | 1594ad5 | 2005-05-26 12:12:19 +1000 | [diff] [blame] | 231 | will send a message through the encrypted |
| 232 | channel to request a response from the client. |
| 233 | The default |
| 234 | is 0, indicating that these messages will not be sent to the client. |
| 235 | This option applies to protocol version 2 only. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 236 | .It Cm Compression |
Damien Miller | 9786e6e | 2005-07-26 21:54:56 +1000 | [diff] [blame] | 237 | Specifies whether compression is allowed, or delayed until |
| 238 | the user has authenticated successfully. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 239 | The argument must be |
Damien Miller | 9786e6e | 2005-07-26 21:54:56 +1000 | [diff] [blame] | 240 | .Dq yes , |
| 241 | .Dq delayed , |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 242 | or |
| 243 | .Dq no . |
| 244 | The default is |
Damien Miller | 9786e6e | 2005-07-26 21:54:56 +1000 | [diff] [blame] | 245 | .Dq delayed . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 246 | .It Cm DenyGroups |
| 247 | This keyword can be followed by a list of group name patterns, separated |
| 248 | by spaces. |
| 249 | Login is disallowed for users whose primary group or supplementary |
| 250 | group list matches one of the patterns. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 251 | Only group names are valid; a numerical group ID is not recognized. |
| 252 | By default, login is allowed for all groups. |
Damien Miller | ac73e51 | 2006-03-15 11:58:49 +1100 | [diff] [blame] | 253 | The allow/deny directives are processed in the following order: |
| 254 | .Cm DenyUsers , |
| 255 | .Cm AllowUsers , |
| 256 | .Cm DenyGroups , |
| 257 | and finally |
| 258 | .Cm AllowGroups . |
Damien Miller | 0c2079d | 2006-03-15 11:54:21 +1100 | [diff] [blame] | 259 | .Pp |
| 260 | See |
| 261 | .Sx PATTERNS |
| 262 | in |
| 263 | .Xr ssh_config 5 |
| 264 | for more information on patterns. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 265 | .It Cm DenyUsers |
| 266 | This keyword can be followed by a list of user name patterns, separated |
| 267 | by spaces. |
| 268 | Login is disallowed for user names that match one of the patterns. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 269 | Only user names are valid; a numerical user ID is not recognized. |
| 270 | By default, login is allowed for all users. |
| 271 | If the pattern takes the form USER@HOST then USER and HOST |
| 272 | are separately checked, restricting logins to particular |
| 273 | users from particular hosts. |
Damien Miller | ac73e51 | 2006-03-15 11:58:49 +1100 | [diff] [blame] | 274 | The allow/deny directives are processed in the following order: |
| 275 | .Cm DenyUsers , |
| 276 | .Cm AllowUsers , |
| 277 | .Cm DenyGroups , |
| 278 | and finally |
| 279 | .Cm AllowGroups . |
Damien Miller | 0c2079d | 2006-03-15 11:54:21 +1100 | [diff] [blame] | 280 | .Pp |
| 281 | See |
| 282 | .Sx PATTERNS |
| 283 | in |
| 284 | .Xr ssh_config 5 |
| 285 | for more information on patterns. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 286 | .It Cm GatewayPorts |
| 287 | Specifies whether remote hosts are allowed to connect to ports |
| 288 | forwarded for the client. |
| 289 | By default, |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 290 | .Xr sshd 8 |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 291 | binds remote port forwardings to the loopback address. |
| 292 | This prevents other remote hosts from connecting to forwarded ports. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 293 | .Cm GatewayPorts |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 294 | can be used to specify that sshd |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 295 | should allow remote port forwardings to bind to non-loopback addresses, thus |
| 296 | allowing other hosts to connect. |
| 297 | The argument may be |
| 298 | .Dq no |
| 299 | to force remote port forwardings to be available to the local host only, |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 300 | .Dq yes |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 301 | to force remote port forwardings to bind to the wildcard address, or |
| 302 | .Dq clientspecified |
| 303 | to allow the client to select the address to which the forwarding is bound. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 304 | The default is |
| 305 | .Dq no . |
Darren Tucker | 0efd155 | 2003-08-26 11:49:55 +1000 | [diff] [blame] | 306 | .It Cm GSSAPIAuthentication |
Damien Miller | 9b7b03b | 2003-09-02 22:57:05 +1000 | [diff] [blame] | 307 | Specifies whether user authentication based on GSSAPI is allowed. |
Damien Miller | a8e06ce | 2003-11-21 23:48:55 +1100 | [diff] [blame] | 308 | The default is |
Darren Tucker | 0efd155 | 2003-08-26 11:49:55 +1000 | [diff] [blame] | 309 | .Dq no . |
| 310 | Note that this option applies to protocol version 2 only. |
| 311 | .It Cm GSSAPICleanupCredentials |
| 312 | Specifies whether to automatically destroy the user's credentials cache |
| 313 | on logout. |
| 314 | The default is |
| 315 | .Dq yes . |
| 316 | Note that this option applies to protocol version 2 only. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 317 | .It Cm HostbasedAuthentication |
| 318 | Specifies whether rhosts or /etc/hosts.equiv authentication together |
| 319 | with successful public key client host authentication is allowed |
Damien Miller | 1faa713 | 2006-03-15 11:55:31 +1100 | [diff] [blame] | 320 | (host-based authentication). |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 321 | This option is similar to |
| 322 | .Cm RhostsRSAAuthentication |
| 323 | and applies to protocol version 2 only. |
| 324 | The default is |
| 325 | .Dq no . |
| 326 | .It Cm HostKey |
| 327 | Specifies a file containing a private host key |
| 328 | used by SSH. |
| 329 | The default is |
| 330 | .Pa /etc/ssh/ssh_host_key |
| 331 | for protocol version 1, and |
| 332 | .Pa /etc/ssh/ssh_host_rsa_key |
| 333 | and |
| 334 | .Pa /etc/ssh/ssh_host_dsa_key |
| 335 | for protocol version 2. |
| 336 | Note that |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 337 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 338 | will refuse to use a file if it is group/world-accessible. |
| 339 | It is possible to have multiple host key files. |
| 340 | .Dq rsa1 |
| 341 | keys are used for version 1 and |
| 342 | .Dq dsa |
| 343 | or |
| 344 | .Dq rsa |
| 345 | are used for version 2 of the SSH protocol. |
| 346 | .It Cm IgnoreRhosts |
| 347 | Specifies that |
| 348 | .Pa .rhosts |
| 349 | and |
| 350 | .Pa .shosts |
| 351 | files will not be used in |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 352 | .Cm RhostsRSAAuthentication |
| 353 | or |
| 354 | .Cm HostbasedAuthentication . |
| 355 | .Pp |
| 356 | .Pa /etc/hosts.equiv |
| 357 | and |
| 358 | .Pa /etc/shosts.equiv |
| 359 | are still used. |
| 360 | The default is |
| 361 | .Dq yes . |
| 362 | .It Cm IgnoreUserKnownHosts |
| 363 | Specifies whether |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 364 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 365 | should ignore the user's |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 366 | .Pa ~/.ssh/known_hosts |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 367 | during |
| 368 | .Cm RhostsRSAAuthentication |
| 369 | or |
| 370 | .Cm HostbasedAuthentication . |
| 371 | The default is |
| 372 | .Dq no . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 373 | .It Cm KerberosAuthentication |
Damien Miller | 1a0c0b9 | 2003-09-02 22:51:17 +1000 | [diff] [blame] | 374 | Specifies whether the password provided by the user for |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 375 | .Cm PasswordAuthentication |
Damien Miller | 1a0c0b9 | 2003-09-02 22:51:17 +1000 | [diff] [blame] | 376 | will be validated through the Kerberos KDC. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 377 | To use this option, the server needs a |
| 378 | Kerberos servtab which allows the verification of the KDC's identity. |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 379 | The default is |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 380 | .Dq no . |
Damien Miller | 8448e66 | 2004-03-08 23:13:15 +1100 | [diff] [blame] | 381 | .It Cm KerberosGetAFSToken |
Darren Tucker | e2dd2d5 | 2005-10-03 18:19:06 +1000 | [diff] [blame] | 382 | If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire |
Damien Miller | 8448e66 | 2004-03-08 23:13:15 +1100 | [diff] [blame] | 383 | an AFS token before accessing the user's home directory. |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 384 | The default is |
Damien Miller | 8448e66 | 2004-03-08 23:13:15 +1100 | [diff] [blame] | 385 | .Dq no . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 386 | .It Cm KerberosOrLocalPasswd |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 387 | If password authentication through Kerberos fails then |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 388 | the password will be validated via any additional local mechanism |
| 389 | such as |
| 390 | .Pa /etc/passwd . |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 391 | The default is |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 392 | .Dq yes . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 393 | .It Cm KerberosTicketCleanup |
| 394 | Specifies whether to automatically destroy the user's ticket cache |
| 395 | file on logout. |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 396 | The default is |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 397 | .Dq yes . |
| 398 | .It Cm KeyRegenerationInterval |
| 399 | In protocol version 1, the ephemeral server key is automatically regenerated |
| 400 | after this many seconds (if it has been used). |
| 401 | The purpose of regeneration is to prevent |
| 402 | decrypting captured sessions by later breaking into the machine and |
| 403 | stealing the keys. |
| 404 | The key is never stored anywhere. |
| 405 | If the value is 0, the key is never regenerated. |
| 406 | The default is 3600 (seconds). |
| 407 | .It Cm ListenAddress |
| 408 | Specifies the local addresses |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 409 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 410 | should listen on. |
| 411 | The 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 |
| 432 | If |
| 433 | .Ar port |
| 434 | is not specified, |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 435 | sshd will listen on the address and all prior |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 436 | .Cm Port |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 437 | options specified. |
| 438 | The default is to listen on all local addresses. |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 439 | Multiple |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 440 | .Cm ListenAddress |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 441 | options are permitted. |
| 442 | Additionally, any |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 443 | .Cm Port |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 444 | options must precede this option for non-port qualified addresses. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 445 | .It Cm LoginGraceTime |
| 446 | The server disconnects after this time if the user has not |
| 447 | successfully logged in. |
| 448 | If the value is 0, there is no time limit. |
Damien Miller | c134863 | 2002-09-05 14:35:14 +1000 | [diff] [blame] | 449 | The default is 120 seconds. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 450 | .It Cm LogLevel |
| 451 | Gives the verbosity level that is used when logging messages from |
Damien Miller | f4f22b5 | 2006-03-15 11:57:25 +1100 | [diff] [blame] | 452 | .Xr sshd 8 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 453 | The possible values are: |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 454 | QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 455 | The default is INFO. |
| 456 | DEBUG and DEBUG1 are equivalent. |
| 457 | DEBUG2 and DEBUG3 each specify higher levels of debugging output. |
| 458 | Logging with a DEBUG level violates the privacy of users and is not recommended. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 459 | .It Cm MACs |
| 460 | Specifies the available MAC (message authentication code) algorithms. |
| 461 | The MAC algorithm is used in protocol version 2 |
| 462 | for data integrity protection. |
| 463 | Multiple algorithms must be comma-separated. |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 464 | The default is: |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 465 | .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 . |
Darren Tucker | 89413db | 2004-05-24 10:36:23 +1000 | [diff] [blame] | 466 | .It Cm MaxAuthTries |
| 467 | Specifies the maximum number of authentication attempts permitted per |
Damien Miller | 26213e5 | 2004-06-30 22:39:34 +1000 | [diff] [blame] | 468 | connection. |
| 469 | Once the number of failures reaches half this value, |
| 470 | additional failures are logged. |
| 471 | The default is 6. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 472 | .It Cm MaxStartups |
| 473 | Specifies the maximum number of concurrent unauthenticated connections to the |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 474 | SSH daemon. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 475 | Additional connections will be dropped until authentication succeeds or the |
| 476 | .Cm LoginGraceTime |
| 477 | expires for a connection. |
| 478 | The default is 10. |
| 479 | .Pp |
| 480 | Alternatively, random early drop can be enabled by specifying |
| 481 | the three colon separated values |
| 482 | .Dq start:rate:full |
Damien Miller | 208f1ed | 2006-03-15 11:56:03 +1100 | [diff] [blame] | 483 | (e.g. "10:30:60"). |
Damien Miller | f4f22b5 | 2006-03-15 11:57:25 +1100 | [diff] [blame] | 484 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 485 | will refuse connection attempts with a probability of |
| 486 | .Dq rate/100 |
| 487 | (30%) |
| 488 | if there are currently |
| 489 | .Dq start |
| 490 | (10) |
| 491 | unauthenticated connections. |
| 492 | The probability increases linearly and all connection attempts |
| 493 | are refused if the number of unauthenticated connections reaches |
| 494 | .Dq full |
| 495 | (60). |
| 496 | .It Cm PasswordAuthentication |
| 497 | Specifies whether password authentication is allowed. |
| 498 | The default is |
| 499 | .Dq yes . |
| 500 | .It Cm PermitEmptyPasswords |
| 501 | When password authentication is allowed, it specifies whether the |
| 502 | server allows login to accounts with empty password strings. |
| 503 | The default is |
| 504 | .Dq no . |
| 505 | .It Cm PermitRootLogin |
Darren Tucker | b350901 | 2005-01-20 11:01:46 +1100 | [diff] [blame] | 506 | Specifies whether root can log in using |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 507 | .Xr ssh 1 . |
| 508 | The argument must be |
| 509 | .Dq yes , |
| 510 | .Dq without-password , |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 511 | .Dq forced-commands-only , |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 512 | or |
| 513 | .Dq no . |
| 514 | The default is |
| 515 | .Dq yes . |
| 516 | .Pp |
| 517 | If this option is set to |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 518 | .Dq without-password , |
Darren Tucker | 9dca099 | 2005-02-01 19:16:45 +1100 | [diff] [blame] | 519 | password authentication is disabled for root. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 520 | .Pp |
| 521 | If this option is set to |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 522 | .Dq forced-commands-only , |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 523 | root login with public key authentication will be allowed, |
| 524 | but only if the |
| 525 | .Ar command |
| 526 | option has been specified |
| 527 | (which may be useful for taking remote backups even if root login is |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 528 | normally not allowed). |
| 529 | All other authentication methods are disabled for root. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 530 | .Pp |
| 531 | If this option is set to |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 532 | .Dq no , |
Darren Tucker | b350901 | 2005-01-20 11:01:46 +1100 | [diff] [blame] | 533 | root is not allowed to log in. |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 534 | .It Cm PermitTunnel |
| 535 | Specifies whether |
| 536 | .Xr tun 4 |
| 537 | device forwarding is allowed. |
Damien Miller | 7b58e80 | 2005-12-13 19:33:19 +1100 | [diff] [blame] | 538 | The argument must be |
| 539 | .Dq yes , |
| 540 | .Dq point-to-point , |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 541 | .Dq ethernet , |
Damien Miller | 7b58e80 | 2005-12-13 19:33:19 +1100 | [diff] [blame] | 542 | or |
| 543 | .Dq no . |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 544 | The default is |
| 545 | .Dq no . |
Ben Lindstrom | 5d860f0 | 2002-08-01 01:28:38 +0000 | [diff] [blame] | 546 | .It Cm PermitUserEnvironment |
| 547 | Specifies whether |
| 548 | .Pa ~/.ssh/environment |
Ben Lindstrom | bd9bf38 | 2002-08-20 18:54:20 +0000 | [diff] [blame] | 549 | and |
Ben Lindstrom | 5d860f0 | 2002-08-01 01:28:38 +0000 | [diff] [blame] | 550 | .Cm environment= |
| 551 | options in |
| 552 | .Pa ~/.ssh/authorized_keys |
Ben Lindstrom | bd9bf38 | 2002-08-20 18:54:20 +0000 | [diff] [blame] | 553 | are processed by |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 554 | .Xr sshd 8 . |
Ben Lindstrom | 5d860f0 | 2002-08-01 01:28:38 +0000 | [diff] [blame] | 555 | The default is |
| 556 | .Dq no . |
Ben Lindstrom | bd9bf38 | 2002-08-20 18:54:20 +0000 | [diff] [blame] | 557 | Enabling environment processing may enable users to bypass access |
| 558 | restrictions in some configurations using mechanisms such as |
| 559 | .Ev LD_PRELOAD . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 560 | .It Cm PidFile |
Ben Lindstrom | 959de99 | 2002-06-23 00:35:25 +0000 | [diff] [blame] | 561 | Specifies the file that contains the process ID of the |
Damien Miller | f4f22b5 | 2006-03-15 11:57:25 +1100 | [diff] [blame] | 562 | SSH daemon. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 563 | The default is |
| 564 | .Pa /var/run/sshd.pid . |
| 565 | .It Cm Port |
| 566 | Specifies the port number that |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 567 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 568 | listens on. |
| 569 | The default is 22. |
| 570 | Multiple options of this type are permitted. |
| 571 | See also |
| 572 | .Cm ListenAddress . |
| 573 | .It Cm PrintLastLog |
| 574 | Specifies whether |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 575 | .Xr sshd 8 |
Darren Tucker | 7cc5c23 | 2004-11-05 20:06:59 +1100 | [diff] [blame] | 576 | should print the date and time of the last user login when a user logs |
| 577 | in interactively. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 578 | The default is |
| 579 | .Dq yes . |
| 580 | .It Cm PrintMotd |
| 581 | Specifies whether |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 582 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 583 | should print |
| 584 | .Pa /etc/motd |
| 585 | when a user logs in interactively. |
| 586 | (On some systems it is also printed by the shell, |
| 587 | .Pa /etc/profile , |
| 588 | or equivalent.) |
| 589 | The default is |
| 590 | .Dq yes . |
| 591 | .It Cm Protocol |
| 592 | Specifies the protocol versions |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 593 | .Xr sshd 8 |
Ben Lindstrom | 9c44554 | 2002-07-11 03:59:18 +0000 | [diff] [blame] | 594 | supports. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 595 | The possible values are |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 596 | .Sq 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 597 | and |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 598 | .Sq 2 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 599 | Multiple versions must be comma-separated. |
| 600 | The default is |
| 601 | .Dq 2,1 . |
Ben Lindstrom | 9c44554 | 2002-07-11 03:59:18 +0000 | [diff] [blame] | 602 | Note that the order of the protocol list does not indicate preference, |
| 603 | because the client selects among multiple protocol versions offered |
| 604 | by the server. |
| 605 | Specifying |
| 606 | .Dq 2,1 |
| 607 | is identical to |
| 608 | .Dq 1,2 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 609 | .It Cm PubkeyAuthentication |
| 610 | Specifies whether public key authentication is allowed. |
| 611 | The default is |
| 612 | .Dq yes . |
| 613 | Note that this option applies to protocol version 2 only. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 614 | .It Cm RhostsRSAAuthentication |
| 615 | Specifies whether rhosts or /etc/hosts.equiv authentication together |
| 616 | with successful RSA host authentication is allowed. |
| 617 | The default is |
| 618 | .Dq no . |
| 619 | This option applies to protocol version 1 only. |
| 620 | .It Cm RSAAuthentication |
| 621 | Specifies whether pure RSA authentication is allowed. |
| 622 | The default is |
| 623 | .Dq yes . |
| 624 | This option applies to protocol version 1 only. |
| 625 | .It Cm ServerKeyBits |
| 626 | Defines the number of bits in the ephemeral protocol version 1 server key. |
| 627 | The minimum value is 512, and the default is 768. |
| 628 | .It Cm StrictModes |
| 629 | Specifies whether |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 630 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 631 | should check file modes and ownership of the |
| 632 | user's files and home directory before accepting login. |
| 633 | This is normally desirable because novices sometimes accidentally leave their |
| 634 | directory or files world-writable. |
| 635 | The default is |
| 636 | .Dq yes . |
| 637 | .It Cm Subsystem |
Damien Miller | 208f1ed | 2006-03-15 11:56:03 +1100 | [diff] [blame] | 638 | Configures an external subsystem (e.g. file transfer daemon). |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 639 | Arguments should be a subsystem name and a command to execute upon subsystem |
| 640 | request. |
| 641 | The command |
| 642 | .Xr sftp-server 8 |
| 643 | implements the |
| 644 | .Dq sftp |
| 645 | file transfer subsystem. |
| 646 | By default no subsystems are defined. |
| 647 | Note that this option applies to protocol version 2 only. |
| 648 | .It Cm SyslogFacility |
| 649 | Gives the facility code that is used when logging messages from |
Damien Miller | f4f22b5 | 2006-03-15 11:57:25 +1100 | [diff] [blame] | 650 | .Xr sshd 8 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 651 | The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, |
| 652 | LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. |
| 653 | The default is AUTH. |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 654 | .It Cm TCPKeepAlive |
| 655 | Specifies whether the system should send TCP keepalive messages to the |
| 656 | other side. |
| 657 | If they are sent, death of the connection or crash of one |
| 658 | of the machines will be properly noticed. |
| 659 | However, this means that |
| 660 | connections will die if the route is down temporarily, and some people |
| 661 | find it annoying. |
| 662 | On the other hand, if TCP keepalives are not sent, |
| 663 | sessions may hang indefinitely on the server, leaving |
| 664 | .Dq ghost |
| 665 | users and consuming server resources. |
| 666 | .Pp |
| 667 | The default is |
| 668 | .Dq yes |
| 669 | (to send TCP keepalive messages), and the server will notice |
| 670 | if the network goes down or the client host crashes. |
| 671 | This avoids infinitely hanging sessions. |
| 672 | .Pp |
| 673 | To disable TCP keepalive messages, the value should be set to |
| 674 | .Dq no . |
Damien Miller | 3a961dc | 2003-06-03 10:25:48 +1000 | [diff] [blame] | 675 | .It Cm UseDNS |
| 676 | Specifies whether |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 677 | .Xr sshd 8 |
Darren Tucker | 83d5a98 | 2005-03-31 21:33:50 +1000 | [diff] [blame] | 678 | should look up the remote host name and check that |
Damien Miller | 3a961dc | 2003-06-03 10:25:48 +1000 | [diff] [blame] | 679 | the resolved host name for the remote IP address maps back to the |
| 680 | very same IP address. |
| 681 | The default is |
| 682 | .Dq yes . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 683 | .It Cm UseLogin |
| 684 | Specifies whether |
| 685 | .Xr login 1 |
| 686 | is used for interactive login sessions. |
| 687 | The default is |
| 688 | .Dq no . |
| 689 | Note that |
| 690 | .Xr login 1 |
| 691 | is never used for remote command execution. |
| 692 | Note also, that if this is enabled, |
| 693 | .Cm X11Forwarding |
| 694 | will be disabled because |
| 695 | .Xr login 1 |
| 696 | does not know how to handle |
| 697 | .Xr xauth 1 |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 698 | cookies. |
| 699 | If |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 700 | .Cm UsePrivilegeSeparation |
| 701 | is specified, it will be disabled after authentication. |
Damien Miller | 2e193e2 | 2003-05-14 15:13:03 +1000 | [diff] [blame] | 702 | .It Cm UsePAM |
Darren Tucker | 1dcff9a | 2004-05-13 16:51:40 +1000 | [diff] [blame] | 703 | Enables the Pluggable Authentication Module interface. |
| 704 | If set to |
| 705 | .Dq yes |
| 706 | this will enable PAM authentication using |
| 707 | .Cm ChallengeResponseAuthentication |
Darren Tucker | a4904f7 | 2006-02-23 21:35:30 +1100 | [diff] [blame] | 708 | and |
| 709 | .Cm PasswordAuthentication |
| 710 | in addition to PAM account and session module processing for all |
| 711 | authentication types. |
Darren Tucker | 1dcff9a | 2004-05-13 16:51:40 +1000 | [diff] [blame] | 712 | .Pp |
| 713 | Because PAM challenge-response authentication usually serves an equivalent |
| 714 | role to password authentication, you should disable either |
| 715 | .Cm PasswordAuthentication |
| 716 | or |
| 717 | .Cm ChallengeResponseAuthentication. |
| 718 | .Pp |
| 719 | If |
| 720 | .Cm UsePAM |
| 721 | is enabled, you will not be able to run |
| 722 | .Xr sshd 8 |
| 723 | as a non-root user. |
| 724 | The default is |
Darren Tucker | 6c0c070 | 2003-10-09 14:13:53 +1000 | [diff] [blame] | 725 | .Dq no . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 726 | .It Cm UsePrivilegeSeparation |
| 727 | Specifies whether |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 728 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 729 | separates privileges by creating an unprivileged child process |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 730 | to deal with incoming network traffic. |
| 731 | After successful authentication, another process will be created that has |
| 732 | the privilege of the authenticated user. |
| 733 | The goal of privilege separation is to prevent privilege |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 734 | escalation by containing any corruption within the unprivileged processes. |
| 735 | The default is |
| 736 | .Dq yes . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 737 | .It Cm X11DisplayOffset |
| 738 | Specifies the first display number available for |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 739 | .Xr sshd 8 Ns 's |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 740 | X11 forwarding. |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 741 | This prevents sshd from interfering with real X11 servers. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 742 | The default is 10. |
| 743 | .It Cm X11Forwarding |
| 744 | Specifies whether X11 forwarding is permitted. |
Damien Miller | 101c4a7 | 2002-09-19 11:51:21 +1000 | [diff] [blame] | 745 | The argument must be |
| 746 | .Dq yes |
| 747 | or |
| 748 | .Dq no . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 749 | The default is |
| 750 | .Dq no . |
Damien Miller | 101c4a7 | 2002-09-19 11:51:21 +1000 | [diff] [blame] | 751 | .Pp |
| 752 | When X11 forwarding is enabled, there may be additional exposure to |
| 753 | the server and to client displays if the |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 754 | .Xr sshd 8 |
Damien Miller | 101c4a7 | 2002-09-19 11:51:21 +1000 | [diff] [blame] | 755 | proxy display is configured to listen on the wildcard address (see |
| 756 | .Cm X11UseLocalhost |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 757 | below), though this is not the default. |
Damien Miller | 101c4a7 | 2002-09-19 11:51:21 +1000 | [diff] [blame] | 758 | Additionally, the authentication spoofing and authentication data |
| 759 | verification and substitution occur on the client side. |
| 760 | The security risk of using X11 forwarding is that the client's X11 |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 761 | display server may be exposed to attack when the SSH client requests |
Damien Miller | 101c4a7 | 2002-09-19 11:51:21 +1000 | [diff] [blame] | 762 | forwarding (see the warnings for |
| 763 | .Cm ForwardX11 |
| 764 | in |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 765 | .Xr ssh_config 5 ) . |
Damien Miller | 101c4a7 | 2002-09-19 11:51:21 +1000 | [diff] [blame] | 766 | A system administrator may have a stance in which they want to |
| 767 | protect clients that may expose themselves to attack by unwittingly |
| 768 | requesting X11 forwarding, which can warrant a |
| 769 | .Dq no |
| 770 | setting. |
| 771 | .Pp |
| 772 | Note that disabling X11 forwarding does not prevent users from |
| 773 | forwarding X11 traffic, as users can always install their own forwarders. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 774 | X11 forwarding is automatically disabled if |
| 775 | .Cm UseLogin |
| 776 | is enabled. |
| 777 | .It Cm X11UseLocalhost |
| 778 | Specifies whether |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 779 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 780 | should bind the X11 forwarding server to the loopback address or to |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 781 | the wildcard address. |
| 782 | By default, |
Damien Miller | 5b0d63f | 2006-03-15 11:56:56 +1100 | [diff] [blame] | 783 | sshd binds the forwarding server to the loopback address and sets the |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 784 | hostname part of the |
| 785 | .Ev DISPLAY |
| 786 | environment variable to |
| 787 | .Dq localhost . |
Ben Lindstrom | 15b6120 | 2002-08-20 18:44:24 +0000 | [diff] [blame] | 788 | This prevents remote hosts from connecting to the proxy display. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 789 | However, some older X11 clients may not function with this |
| 790 | configuration. |
| 791 | .Cm X11UseLocalhost |
| 792 | may be set to |
| 793 | .Dq no |
| 794 | to specify that the forwarding server should be bound to the wildcard |
| 795 | address. |
| 796 | The argument must be |
| 797 | .Dq yes |
| 798 | or |
| 799 | .Dq no . |
| 800 | The default is |
| 801 | .Dq yes . |
| 802 | .It Cm XAuthLocation |
Damien Miller | 05913ba | 2002-09-04 16:51:03 +1000 | [diff] [blame] | 803 | Specifies the full pathname of the |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 804 | .Xr xauth 1 |
| 805 | program. |
| 806 | The default is |
| 807 | .Pa /usr/X11R6/bin/xauth . |
| 808 | .El |
Damien Miller | e3beba2 | 2006-03-15 11:59:25 +1100 | [diff] [blame] | 809 | .Sh TIME FORMATS |
Damien Miller | f4f22b5 | 2006-03-15 11:57:25 +1100 | [diff] [blame] | 810 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 811 | command-line arguments and configuration file options that specify time |
| 812 | may be expressed using a sequence of the form: |
| 813 | .Sm off |
Ben Lindstrom | 1f8cf4f | 2002-08-20 18:43:27 +0000 | [diff] [blame] | 814 | .Ar time Op Ar qualifier , |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 815 | .Sm on |
| 816 | where |
| 817 | .Ar time |
| 818 | is a positive integer value and |
| 819 | .Ar qualifier |
| 820 | is one of the following: |
| 821 | .Pp |
| 822 | .Bl -tag -width Ds -compact -offset indent |
| 823 | .It Cm <none> |
| 824 | seconds |
| 825 | .It Cm s | Cm S |
| 826 | seconds |
| 827 | .It Cm m | Cm M |
| 828 | minutes |
| 829 | .It Cm h | Cm H |
| 830 | hours |
| 831 | .It Cm d | Cm D |
| 832 | days |
| 833 | .It Cm w | Cm W |
| 834 | weeks |
| 835 | .El |
| 836 | .Pp |
| 837 | Each member of the sequence is added together to calculate |
| 838 | the total time value. |
| 839 | .Pp |
| 840 | Time format examples: |
| 841 | .Pp |
| 842 | .Bl -tag -width Ds -compact -offset indent |
| 843 | .It 600 |
| 844 | 600 seconds (10 minutes) |
| 845 | .It 10m |
| 846 | 10 minutes |
| 847 | .It 1h30m |
| 848 | 1 hour 30 minutes (90 minutes) |
| 849 | .El |
| 850 | .Sh FILES |
| 851 | .Bl -tag -width Ds |
| 852 | .It Pa /etc/ssh/sshd_config |
| 853 | Contains configuration data for |
Damien Miller | f4f22b5 | 2006-03-15 11:57:25 +1100 | [diff] [blame] | 854 | .Xr sshd 8 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 855 | This file should be writable by root only, but it is recommended |
| 856 | (though not necessary) that it be world-readable. |
| 857 | .El |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 858 | .Sh SEE ALSO |
| 859 | .Xr sshd 8 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 860 | .Sh AUTHORS |
| 861 | OpenSSH is a derivative of the original and free |
| 862 | ssh 1.2.12 release by Tatu Ylonen. |
| 863 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, |
| 864 | Theo de Raadt and Dug Song |
| 865 | removed many bugs, re-added newer features and |
| 866 | created OpenSSH. |
| 867 | Markus Friedl contributed the support for SSH |
| 868 | protocol versions 1.5 and 2.0. |
| 869 | Niels Provos and Markus Friedl contributed support |
| 870 | for privilege separation. |