]>
Commit | Line | Data |
---|---|---|
588df31a | 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 | .\" | |
39ceddb7 | 37 | .\" $OpenBSD: sshd_config.5,v 1.96 2008/07/02 02:24:18 djm Exp $ |
e473dcd1 | 38 | .Dd $Mdocdate$ |
588df31a | 39 | .Dt SSHD_CONFIG 5 |
40 | .Os | |
41 | .Sh NAME | |
42 | .Nm sshd_config | |
43 | .Nd OpenSSH SSH daemon configuration file | |
44 | .Sh SYNOPSIS | |
5d9a4204 | 45 | .Nm /etc/ssh/sshd_config |
588df31a | 46 | .Sh DESCRIPTION |
32cfd177 | 47 | .Xr sshd 8 |
588df31a | 48 | reads configuration data from |
49 | .Pa /etc/ssh/sshd_config | |
50 | (or the file specified with | |
51 | .Fl f | |
52 | on the command line). | |
53 | The file contains keyword-argument pairs, one per line. | |
54 | Lines starting with | |
55 | .Ql # | |
56 | and empty lines are interpreted as comments. | |
533b9133 | 57 | Arguments may optionally be enclosed in double quotes |
58 | .Pq \&" | |
59 | in order to represent arguments containing spaces. | |
588df31a | 60 | .Pp |
61 | The possible | |
62 | keywords and their meanings are as follows (note that | |
63 | keywords are case-insensitive and arguments are case-sensitive): | |
64 | .Bl -tag -width Ds | |
61a2c1da | 65 | .It Cm AcceptEnv |
66 | Specifies what environment variables sent by the client will be copied into | |
67 | the session's | |
68 | .Xr environ 7 . | |
69 | See | |
70 | .Cm SendEnv | |
71 | in | |
72 | .Xr ssh_config 5 | |
73 | for how to configure the client. | |
b8b9f2e6 | 74 | Note that environment passing is only supported for protocol 2. |
61a2c1da | 75 | Variables are specified by name, which may contain the wildcard characters |
f09ffbdb | 76 | .Ql * |
61a2c1da | 77 | and |
78 | .Ql \&? . | |
b8b9f2e6 | 79 | Multiple environment variables may be separated by whitespace or spread |
61a2c1da | 80 | across multiple |
81 | .Cm AcceptEnv | |
82 | directives. | |
b8b9f2e6 | 83 | Be warned that some environment variables could be used to bypass restricted |
61a2c1da | 84 | user environments. |
85 | For this reason, care should be taken in the use of this directive. | |
86 | The default is not to accept any environment variables. | |
31b41ceb | 87 | .It Cm AddressFamily |
88 | Specifies which address family should be used by | |
32cfd177 | 89 | .Xr sshd 8 . |
31b41ceb | 90 | Valid arguments are |
91 | .Dq any , | |
92 | .Dq inet | |
b74c3b8c | 93 | (use IPv4 only), or |
31b41ceb | 94 | .Dq inet6 |
95 | (use IPv6 only). | |
96 | The default is | |
97 | .Dq any . | |
94569631 | 98 | .It Cm AllowAgentForwarding |
99 | Specifies whether | |
100 | .Xr ssh-agent 1 | |
101 | forwarding is permitted. | |
102 | The default is | |
103 | .Dq yes . | |
104 | Note that disabling agent forwarding does not improve security | |
105 | unless users are also denied shell access, as they can always install | |
106 | their own forwarders. | |
588df31a | 107 | .It Cm AllowGroups |
108 | This keyword can be followed by a list of group name patterns, separated | |
109 | by spaces. | |
110 | If specified, login is allowed only for users whose primary | |
111 | group or supplementary group list matches one of the patterns. | |
588df31a | 112 | Only group names are valid; a numerical group ID is not recognized. |
113 | By default, login is allowed for all groups. | |
84c1b530 | 114 | The allow/deny directives are processed in the following order: |
115 | .Cm DenyUsers , | |
116 | .Cm AllowUsers , | |
117 | .Cm DenyGroups , | |
118 | and finally | |
119 | .Cm AllowGroups . | |
ac1ec4d8 | 120 | .Pp |
121 | See | |
122 | .Sx PATTERNS | |
123 | in | |
124 | .Xr ssh_config 5 | |
125 | for more information on patterns. | |
588df31a | 126 | .It Cm AllowTcpForwarding |
127 | Specifies whether TCP forwarding is permitted. | |
128 | The default is | |
129 | .Dq yes . | |
130 | Note that disabling TCP forwarding does not improve security unless | |
131 | users are also denied shell access, as they can always install their | |
132 | own forwarders. | |
588df31a | 133 | .It Cm AllowUsers |
134 | This keyword can be followed by a list of user name patterns, separated | |
135 | by spaces. | |
1be697b6 | 136 | If specified, login is allowed only for user names that |
588df31a | 137 | match one of the patterns. |
588df31a | 138 | Only user names are valid; a numerical user ID is not recognized. |
139 | By default, login is allowed for all users. | |
140 | If the pattern takes the form USER@HOST then USER and HOST | |
141 | are separately checked, restricting logins to particular | |
142 | users from particular hosts. | |
84c1b530 | 143 | The allow/deny directives are processed in the following order: |
144 | .Cm DenyUsers , | |
145 | .Cm AllowUsers , | |
146 | .Cm DenyGroups , | |
147 | and finally | |
148 | .Cm AllowGroups . | |
ac1ec4d8 | 149 | .Pp |
150 | See | |
151 | .Sx PATTERNS | |
152 | in | |
153 | .Xr ssh_config 5 | |
154 | for more information on patterns. | |
588df31a | 155 | .It Cm AuthorizedKeysFile |
156 | Specifies the file that contains the public keys that can be used | |
157 | for user authentication. | |
158 | .Cm AuthorizedKeysFile | |
159 | may contain tokens of the form %T which are substituted during connection | |
b74c3b8c | 160 | setup. |
3cbc677d | 161 | The following tokens are defined: %% is replaced by a literal '%', |
b74c3b8c | 162 | %h is replaced by the home directory of the user being authenticated, and |
588df31a | 163 | %u is replaced by the username of that user. |
164 | After expansion, | |
165 | .Cm AuthorizedKeysFile | |
166 | is taken to be an absolute path or one relative to the user's home | |
167 | directory. | |
168 | The default is | |
169 | .Dq .ssh/authorized_keys . | |
170 | .It Cm Banner | |
588df31a | 171 | The contents of the specified file are sent to the remote user before |
172 | authentication is allowed. | |
ba8cfba6 | 173 | If the argument is |
174 | .Dq none | |
175 | then no banner is displayed. | |
588df31a | 176 | This option is only available for protocol version 2. |
177 | By default, no banner is displayed. | |
588df31a | 178 | .It Cm ChallengeResponseAuthentication |
340a4caf | 179 | Specifies whether challenge-response authentication is allowed. |
588df31a | 180 | All authentication styles from |
181 | .Xr login.conf 5 | |
182 | are supported. | |
183 | The default is | |
184 | .Dq yes . | |
db49deeb | 185 | .It Cm ChrootDirectory |
186 | Specifies a path to | |
187 | .Xr chroot 2 | |
188 | to after authentication. | |
189 | This path, and all its components, must be root-owned directories that are | |
190 | not writable by any other user or group. | |
191 | .Pp | |
192 | The path may contain the following tokens that are expanded at runtime once | |
193 | the connecting user has been authenticated: %% is replaced by a literal '%', | |
194 | %h is replaced by the home directory of the user being authenticated, and | |
195 | %u is replaced by the username of that user. | |
196 | .Pp | |
197 | The | |
198 | .Cm ChrootDirectory | |
199 | must contain the necessary files and directories to support the | |
200 | users' session. | |
201 | For an interactive session this requires at least a shell, typically | |
202 | .Xr sh 1 , | |
203 | and basic | |
204 | .Pa /dev | |
205 | nodes such as | |
206 | .Xr null 4 , | |
207 | .Xr zero 4 , | |
208 | .Xr stdin 4 , | |
209 | .Xr stdout 4 , | |
210 | .Xr stderr 4 , | |
211 | .Xr arandom 4 | |
212 | and | |
213 | .Xr tty 4 | |
214 | devices. | |
215 | For file transfer sessions using | |
216 | .Dq sftp , | |
217 | no additional configuration of the environment is necessary if the | |
218 | in-process sftp server is used (see | |
219 | .Cm Subsystem | |
d42a7d38 | 220 | for details). |
db49deeb | 221 | .Pp |
222 | The default is not to | |
223 | .Xr chroot 2 . | |
588df31a | 224 | .It Cm Ciphers |
225 | Specifies the ciphers allowed for protocol version 2. | |
226 | Multiple ciphers must be comma-separated. | |
3b9baa7b | 227 | The supported ciphers are |
228 | .Dq 3des-cbc , | |
229 | .Dq aes128-cbc , | |
230 | .Dq aes192-cbc , | |
231 | .Dq aes256-cbc , | |
232 | .Dq aes128-ctr , | |
233 | .Dq aes192-ctr , | |
234 | .Dq aes256-ctr , | |
74a66cc8 | 235 | .Dq arcfour128 , |
236 | .Dq arcfour256 , | |
3b9baa7b | 237 | .Dq arcfour , |
238 | .Dq blowfish-cbc , | |
239 | and | |
240 | .Dq cast128-cbc . | |
b74c3b8c | 241 | The default is: |
242 | .Bd -literal -offset 3n | |
243 | aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128, | |
244 | arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr, | |
245 | aes192-ctr,aes256-ctr | |
588df31a | 246 | .Ed |
588df31a | 247 | .It Cm ClientAliveCountMax |
79e46360 | 248 | Sets the number of client alive messages (see below) which may be |
588df31a | 249 | sent without |
b74c3b8c | 250 | .Xr sshd 8 |
3cbc677d | 251 | receiving any messages back from the client. |
252 | If this threshold is reached while client alive messages are being sent, | |
b74c3b8c | 253 | sshd will disconnect the client, terminating the session. |
3cbc677d | 254 | It is important to note that the use of client alive messages is very |
255 | different from | |
fd573618 | 256 | .Cm TCPKeepAlive |
3cbc677d | 257 | (below). |
258 | The client alive messages are sent through the encrypted channel | |
259 | and therefore will not be spoofable. | |
260 | The TCP keepalive option enabled by | |
fd573618 | 261 | .Cm TCPKeepAlive |
3cbc677d | 262 | is spoofable. |
263 | The client alive mechanism is valuable when the client or | |
588df31a | 264 | server depend on knowing when a connection has become inactive. |
265 | .Pp | |
3cbc677d | 266 | The default value is 3. |
267 | If | |
588df31a | 268 | .Cm ClientAliveInterval |
79e46360 | 269 | (see below) is set to 15, and |
588df31a | 270 | .Cm ClientAliveCountMax |
b74c3b8c | 271 | is left at the default, unresponsive SSH clients |
588df31a | 272 | will be disconnected after approximately 45 seconds. |
2d762582 | 273 | This option applies to protocol version 2 only. |
2264526c | 274 | .It Cm ClientAliveInterval |
275 | Sets a timeout interval in seconds after which if no data has been received | |
276 | from the client, | |
b74c3b8c | 277 | .Xr sshd 8 |
2264526c | 278 | will send a message through the encrypted |
279 | channel to request a response from the client. | |
280 | The default | |
281 | is 0, indicating that these messages will not be sent to the client. | |
282 | This option applies to protocol version 2 only. | |
588df31a | 283 | .It Cm Compression |
07200973 | 284 | Specifies whether compression is allowed, or delayed until |
285 | the user has authenticated successfully. | |
588df31a | 286 | The argument must be |
07200973 | 287 | .Dq yes , |
288 | .Dq delayed , | |
588df31a | 289 | or |
290 | .Dq no . | |
291 | The default is | |
07200973 | 292 | .Dq delayed . |
588df31a | 293 | .It Cm DenyGroups |
294 | This keyword can be followed by a list of group name patterns, separated | |
295 | by spaces. | |
296 | Login is disallowed for users whose primary group or supplementary | |
297 | group list matches one of the patterns. | |
588df31a | 298 | Only group names are valid; a numerical group ID is not recognized. |
299 | By default, login is allowed for all groups. | |
84c1b530 | 300 | The allow/deny directives are processed in the following order: |
301 | .Cm DenyUsers , | |
302 | .Cm AllowUsers , | |
303 | .Cm DenyGroups , | |
304 | and finally | |
305 | .Cm AllowGroups . | |
ac1ec4d8 | 306 | .Pp |
307 | See | |
308 | .Sx PATTERNS | |
309 | in | |
310 | .Xr ssh_config 5 | |
311 | for more information on patterns. | |
588df31a | 312 | .It Cm DenyUsers |
313 | This keyword can be followed by a list of user name patterns, separated | |
314 | by spaces. | |
315 | Login is disallowed for user names that match one of the patterns. | |
588df31a | 316 | Only user names are valid; a numerical user ID is not recognized. |
317 | By default, login is allowed for all users. | |
318 | If the pattern takes the form USER@HOST then USER and HOST | |
319 | are separately checked, restricting logins to particular | |
320 | users from particular hosts. | |
84c1b530 | 321 | The allow/deny directives are processed in the following order: |
322 | .Cm DenyUsers , | |
323 | .Cm AllowUsers , | |
324 | .Cm DenyGroups , | |
325 | and finally | |
326 | .Cm AllowGroups . | |
ac1ec4d8 | 327 | .Pp |
328 | See | |
329 | .Sx PATTERNS | |
330 | in | |
331 | .Xr ssh_config 5 | |
332 | for more information on patterns. | |
e7259e8d | 333 | .It Cm ForceCommand |
334 | Forces the execution of the command specified by | |
335 | .Cm ForceCommand , | |
6e2a8e29 | 336 | ignoring any command supplied by the client and |
337 | .Pa ~/.ssh/rc | |
338 | if present. | |
e7259e8d | 339 | The command is invoked by using the user's login shell with the -c option. |
340 | This applies to shell, command, or subsystem execution. | |
341 | It is most useful inside a | |
342 | .Cm Match | |
343 | block. | |
344 | The command originally supplied by the client is available in the | |
345 | .Ev SSH_ORIGINAL_COMMAND | |
346 | environment variable. | |
2bd88d9f | 347 | Specifying a command of |
348 | .Dq internal-sftp | |
349 | will force the use of an in-process sftp server that requires no support | |
350 | files when used with | |
351 | .Cm ChrootDirectory . | |
588df31a | 352 | .It Cm GatewayPorts |
353 | Specifies whether remote hosts are allowed to connect to ports | |
354 | forwarded for the client. | |
355 | By default, | |
b74c3b8c | 356 | .Xr sshd 8 |
a4e5acef | 357 | binds remote port forwardings to the loopback address. |
358 | This prevents other remote hosts from connecting to forwarded ports. | |
588df31a | 359 | .Cm GatewayPorts |
b74c3b8c | 360 | can be used to specify that sshd |
3867aa0a | 361 | should allow remote port forwardings to bind to non-loopback addresses, thus |
362 | allowing other hosts to connect. | |
363 | The argument may be | |
364 | .Dq no | |
365 | to force remote port forwardings to be available to the local host only, | |
588df31a | 366 | .Dq yes |
3867aa0a | 367 | to force remote port forwardings to bind to the wildcard address, or |
368 | .Dq clientspecified | |
369 | to allow the client to select the address to which the forwarding is bound. | |
588df31a | 370 | The default is |
371 | .Dq no . | |
7364bd04 | 372 | .It Cm GSSAPIAuthentication |
105b07db | 373 | Specifies whether user authentication based on GSSAPI is allowed. |
aff51935 | 374 | The default is |
7364bd04 | 375 | .Dq no . |
376 | Note that this option applies to protocol version 2 only. | |
377 | .It Cm GSSAPICleanupCredentials | |
378 | Specifies whether to automatically destroy the user's credentials cache | |
379 | on logout. | |
380 | The default is | |
381 | .Dq yes . | |
382 | Note that this option applies to protocol version 2 only. | |
588df31a | 383 | .It Cm HostbasedAuthentication |
384 | Specifies whether rhosts or /etc/hosts.equiv authentication together | |
385 | with successful public key client host authentication is allowed | |
340a4caf | 386 | (host-based authentication). |
588df31a | 387 | This option is similar to |
388 | .Cm RhostsRSAAuthentication | |
389 | and applies to protocol version 2 only. | |
390 | The default is | |
391 | .Dq no . | |
e9f2e744 | 392 | .It Cm HostbasedUsesNameFromPacketOnly |
393 | Specifies whether or not the server will attempt to perform a reverse | |
394 | name lookup when matching the name in the | |
395 | .Pa ~/.shosts , | |
396 | .Pa ~/.rhosts , | |
397 | and | |
398 | .Pa /etc/hosts.equiv | |
399 | files during | |
400 | .Cm HostbasedAuthentication . | |
401 | A setting of | |
402 | .Dq yes | |
403 | means that | |
404 | .Xr sshd 8 | |
405 | uses the name supplied by the client rather than | |
406 | attempting to resolve the name from the TCP connection itself. | |
407 | The default is | |
408 | .Dq no . | |
588df31a | 409 | .It Cm HostKey |
410 | Specifies a file containing a private host key | |
411 | used by SSH. | |
412 | The default is | |
413 | .Pa /etc/ssh/ssh_host_key | |
414 | for protocol version 1, and | |
415 | .Pa /etc/ssh/ssh_host_rsa_key | |
416 | and | |
417 | .Pa /etc/ssh/ssh_host_dsa_key | |
418 | for protocol version 2. | |
419 | Note that | |
b74c3b8c | 420 | .Xr sshd 8 |
588df31a | 421 | will refuse to use a file if it is group/world-accessible. |
422 | It is possible to have multiple host key files. | |
423 | .Dq rsa1 | |
424 | keys are used for version 1 and | |
425 | .Dq dsa | |
426 | or | |
427 | .Dq rsa | |
428 | are used for version 2 of the SSH protocol. | |
429 | .It Cm IgnoreRhosts | |
430 | Specifies that | |
431 | .Pa .rhosts | |
432 | and | |
433 | .Pa .shosts | |
434 | files will not be used in | |
588df31a | 435 | .Cm RhostsRSAAuthentication |
436 | or | |
437 | .Cm HostbasedAuthentication . | |
438 | .Pp | |
439 | .Pa /etc/hosts.equiv | |
440 | and | |
441 | .Pa /etc/shosts.equiv | |
442 | are still used. | |
443 | The default is | |
444 | .Dq yes . | |
445 | .It Cm IgnoreUserKnownHosts | |
446 | Specifies whether | |
b74c3b8c | 447 | .Xr sshd 8 |
588df31a | 448 | should ignore the user's |
140e3e97 | 449 | .Pa ~/.ssh/known_hosts |
588df31a | 450 | during |
451 | .Cm RhostsRSAAuthentication | |
452 | or | |
453 | .Cm HostbasedAuthentication . | |
454 | The default is | |
455 | .Dq no . | |
588df31a | 456 | .It Cm KerberosAuthentication |
8f73f7bb | 457 | Specifies whether the password provided by the user for |
588df31a | 458 | .Cm PasswordAuthentication |
8f73f7bb | 459 | will be validated through the Kerberos KDC. |
588df31a | 460 | To use this option, the server needs a |
461 | Kerberos servtab which allows the verification of the KDC's identity. | |
b74c3b8c | 462 | The default is |
588df31a | 463 | .Dq no . |
24f37810 | 464 | .It Cm KerberosGetAFSToken |
0d3d1077 | 465 | If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire |
24f37810 | 466 | an AFS token before accessing the user's home directory. |
b74c3b8c | 467 | The default is |
24f37810 | 468 | .Dq no . |
588df31a | 469 | .It Cm KerberosOrLocalPasswd |
b74c3b8c | 470 | If password authentication through Kerberos fails then |
588df31a | 471 | the password will be validated via any additional local mechanism |
472 | such as | |
473 | .Pa /etc/passwd . | |
b74c3b8c | 474 | The default is |
588df31a | 475 | .Dq yes . |
588df31a | 476 | .It Cm KerberosTicketCleanup |
477 | Specifies whether to automatically destroy the user's ticket cache | |
478 | file on logout. | |
b74c3b8c | 479 | The default is |
588df31a | 480 | .Dq yes . |
481 | .It Cm KeyRegenerationInterval | |
482 | In protocol version 1, the ephemeral server key is automatically regenerated | |
483 | after this many seconds (if it has been used). | |
484 | The purpose of regeneration is to prevent | |
485 | decrypting captured sessions by later breaking into the machine and | |
486 | stealing the keys. | |
487 | The key is never stored anywhere. | |
488 | If the value is 0, the key is never regenerated. | |
489 | The default is 3600 (seconds). | |
490 | .It Cm ListenAddress | |
491 | Specifies the local addresses | |
b74c3b8c | 492 | .Xr sshd 8 |
588df31a | 493 | should listen on. |
494 | The following forms may be used: | |
495 | .Pp | |
496 | .Bl -item -offset indent -compact | |
497 | .It | |
498 | .Cm ListenAddress | |
499 | .Sm off | |
500 | .Ar host No | Ar IPv4_addr No | Ar IPv6_addr | |
501 | .Sm on | |
502 | .It | |
503 | .Cm ListenAddress | |
504 | .Sm off | |
505 | .Ar host No | Ar IPv4_addr No : Ar port | |
506 | .Sm on | |
507 | .It | |
508 | .Cm ListenAddress | |
509 | .Sm off | |
510 | .Oo | |
511 | .Ar host No | Ar IPv6_addr Oc : Ar port | |
512 | .Sm on | |
513 | .El | |
514 | .Pp | |
515 | If | |
516 | .Ar port | |
517 | is not specified, | |
b74c3b8c | 518 | sshd will listen on the address and all prior |
588df31a | 519 | .Cm Port |
3cbc677d | 520 | options specified. |
521 | The default is to listen on all local addresses. | |
a4e5acef | 522 | Multiple |
588df31a | 523 | .Cm ListenAddress |
3cbc677d | 524 | options are permitted. |
525 | Additionally, any | |
588df31a | 526 | .Cm Port |
b74c3b8c | 527 | options must precede this option for non-port qualified addresses. |
588df31a | 528 | .It Cm LoginGraceTime |
529 | The server disconnects after this time if the user has not | |
530 | successfully logged in. | |
531 | If the value is 0, there is no time limit. | |
3445ca02 | 532 | The default is 120 seconds. |
588df31a | 533 | .It Cm LogLevel |
534 | Gives the verbosity level that is used when logging messages from | |
32cfd177 | 535 | .Xr sshd 8 . |
588df31a | 536 | The possible values are: |
b74c3b8c | 537 | QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. |
a4e5acef | 538 | The default is INFO. |
539 | DEBUG and DEBUG1 are equivalent. | |
540 | DEBUG2 and DEBUG3 each specify higher levels of debugging output. | |
541 | Logging with a DEBUG level violates the privacy of users and is not recommended. | |
588df31a | 542 | .It Cm MACs |
543 | Specifies the available MAC (message authentication code) algorithms. | |
544 | The MAC algorithm is used in protocol version 2 | |
545 | for data integrity protection. | |
546 | Multiple algorithms must be comma-separated. | |
b74c3b8c | 547 | The default is: |
33d2ae0f | 548 | .Bd -literal -offset indent |
549 | hmac-md5,hmac-sha1,umac-64@openssh.com, | |
550 | hmac-ripemd160,hmac-sha1-96,hmac-md5-96 | |
551 | .Ed | |
d231781a | 552 | .It Cm Match |
14e980ef | 553 | Introduces a conditional block. |
4895f836 | 554 | If all of the criteria on the |
d231781a | 555 | .Cm Match |
4895f836 | 556 | line are satisfied, the keywords on the following lines override those |
557 | set in the global section of the config file, until either another | |
d231781a | 558 | .Cm Match |
4895f836 | 559 | line or the end of the file. |
15b5fa9b | 560 | .Pp |
14e980ef | 561 | The arguments to |
d231781a | 562 | .Cm Match |
4895f836 | 563 | are one or more criteria-pattern pairs. |
d231781a | 564 | The available criteria are |
565 | .Cm User , | |
fa47fe3c | 566 | .Cm Group , |
d231781a | 567 | .Cm Host , |
568 | and | |
569 | .Cm Address . | |
15b5fa9b | 570 | The match patterns may consist of single entries or comma-separated |
571 | lists and may use the wildcard and negation operators described in the | |
8b671558 | 572 | .Sx PATTERNS |
15b5fa9b | 573 | section of |
8b671558 | 574 | .Xr ssh_config 5 . |
15b5fa9b | 575 | .Pp |
576 | The patterns in an | |
577 | .Cm Address | |
578 | criteria may additionally contain addresses to match in CIDR | |
01e9e424 | 579 | address/masklen format, e.g.\& |
15b5fa9b | 580 | .Dq 192.0.2.0/24 |
581 | or | |
582 | .Dq 3ffe:ffff::/32 . | |
583 | Note that the mask length provided must be consistent with the address - | |
584 | it is an error to specify a mask length that is too long for the address | |
01e9e424 | 585 | or one with bits set in this host portion of the address. |
586 | For example, | |
15b5fa9b | 587 | .Dq 192.0.2.0/33 |
588 | and | |
01e9e424 | 589 | .Dq 192.0.2.0/8 |
15b5fa9b | 590 | respectively. |
591 | .Pp | |
d231781a | 592 | Only a subset of keywords may be used on the lines following a |
593 | .Cm Match | |
594 | keyword. | |
595 | Available keywords are | |
2fefbadf | 596 | .Cm AllowTcpForwarding , |
03bcbf84 | 597 | .Cm Banner , |
9b04dbaa | 598 | .Cm ChrootDirectory , |
e7259e8d | 599 | .Cm ForceCommand , |
2fefbadf | 600 | .Cm GatewayPorts , |
ade21243 | 601 | .Cm GSSAPIAuthentication , |
602 | .Cm HostbasedAuthentication , | |
121c4a34 | 603 | .Cm KbdInteractiveAuthentication , |
a863b75f | 604 | .Cm KerberosAuthentication , |
8086aeb2 | 605 | .Cm MaxAuthTries , |
d97287d3 | 606 | .Cm MaxSessions , |
03bcbf84 | 607 | .Cm PasswordAuthentication , |
691712e0 | 608 | .Cm PermitOpen , |
2ef741a3 | 609 | .Cm PermitRootLogin , |
03bcbf84 | 610 | .Cm RhostsRSAAuthentication , |
611 | .Cm RSAAuthentication , | |
691712e0 | 612 | .Cm X11DisplayOffset , |
613 | .Cm X11Forwarding , | |
d231781a | 614 | and |
691712e0 | 615 | .Cm X11UseLocalHost . |
af4bd935 | 616 | .It Cm MaxAuthTries |
617 | Specifies the maximum number of authentication attempts permitted per | |
8fca654b | 618 | connection. |
619 | Once the number of failures reaches half this value, | |
620 | additional failures are logged. | |
621 | The default is 6. | |
c6dca55e | 622 | .It Cm MaxSessions |
623 | Specifies the maximum number of open sessions permitted per network connection. | |
624 | The default is 10. | |
588df31a | 625 | .It Cm MaxStartups |
626 | Specifies the maximum number of concurrent unauthenticated connections to the | |
b74c3b8c | 627 | SSH daemon. |
588df31a | 628 | Additional connections will be dropped until authentication succeeds or the |
629 | .Cm LoginGraceTime | |
630 | expires for a connection. | |
631 | The default is 10. | |
632 | .Pp | |
633 | Alternatively, random early drop can be enabled by specifying | |
634 | the three colon separated values | |
635 | .Dq start:rate:full | |
f09ffbdb | 636 | (e.g. "10:30:60"). |
32cfd177 | 637 | .Xr sshd 8 |
588df31a | 638 | will refuse connection attempts with a probability of |
639 | .Dq rate/100 | |
640 | (30%) | |
641 | if there are currently | |
642 | .Dq start | |
643 | (10) | |
644 | unauthenticated connections. | |
645 | The probability increases linearly and all connection attempts | |
646 | are refused if the number of unauthenticated connections reaches | |
647 | .Dq full | |
648 | (60). | |
649 | .It Cm PasswordAuthentication | |
650 | Specifies whether password authentication is allowed. | |
651 | The default is | |
652 | .Dq yes . | |
653 | .It Cm PermitEmptyPasswords | |
654 | When password authentication is allowed, it specifies whether the | |
655 | server allows login to accounts with empty password strings. | |
656 | The default is | |
657 | .Dq no . | |
2fefbadf | 658 | .It Cm PermitOpen |
659 | Specifies the destinations to which TCP port forwarding is permitted. | |
660 | The forwarding specification must be one of the following forms: | |
661 | .Pp | |
662 | .Bl -item -offset indent -compact | |
663 | .It | |
664 | .Cm PermitOpen | |
665 | .Sm off | |
666 | .Ar host : port | |
667 | .Sm on | |
668 | .It | |
669 | .Cm PermitOpen | |
670 | .Sm off | |
671 | .Ar IPv4_addr : port | |
672 | .Sm on | |
673 | .It | |
674 | .Cm PermitOpen | |
675 | .Sm off | |
676 | .Ar \&[ IPv6_addr \&] : port | |
677 | .Sm on | |
678 | .El | |
679 | .Pp | |
ea46e550 | 680 | Multiple forwards may be specified by separating them with whitespace. |
2fefbadf | 681 | An argument of |
682 | .Dq any | |
683 | can be used to remove all restrictions and permit any forwarding requests. | |
f22506ff | 684 | By default all port forwarding requests are permitted. |
588df31a | 685 | .It Cm PermitRootLogin |
667e4135 | 686 | Specifies whether root can log in using |
588df31a | 687 | .Xr ssh 1 . |
688 | The argument must be | |
689 | .Dq yes , | |
690 | .Dq without-password , | |
b74c3b8c | 691 | .Dq forced-commands-only , |
588df31a | 692 | or |
693 | .Dq no . | |
694 | The default is | |
695 | .Dq yes . | |
696 | .Pp | |
697 | If this option is set to | |
b74c3b8c | 698 | .Dq without-password , |
8a4c4ee4 | 699 | password authentication is disabled for root. |
588df31a | 700 | .Pp |
701 | If this option is set to | |
b74c3b8c | 702 | .Dq forced-commands-only , |
588df31a | 703 | root login with public key authentication will be allowed, |
704 | but only if the | |
705 | .Ar command | |
706 | option has been specified | |
707 | (which may be useful for taking remote backups even if root login is | |
3cbc677d | 708 | normally not allowed). |
709 | All other authentication methods are disabled for root. | |
588df31a | 710 | .Pp |
711 | If this option is set to | |
b74c3b8c | 712 | .Dq no , |
667e4135 | 713 | root is not allowed to log in. |
d20f3c9e | 714 | .It Cm PermitTunnel |
715 | Specifies whether | |
716 | .Xr tun 4 | |
717 | device forwarding is allowed. | |
a4f24bf8 | 718 | The argument must be |
719 | .Dq yes , | |
06fa4ac1 | 720 | .Dq point-to-point |
721 | (layer 3), | |
722 | .Dq ethernet | |
723 | (layer 2), or | |
a4f24bf8 | 724 | .Dq no . |
06fa4ac1 | 725 | Specifying |
726 | .Dq yes | |
727 | permits both | |
728 | .Dq point-to-point | |
729 | and | |
730 | .Dq ethernet . | |
d20f3c9e | 731 | The default is |
732 | .Dq no . | |
f00bab84 | 733 | .It Cm PermitUserEnvironment |
734 | Specifies whether | |
735 | .Pa ~/.ssh/environment | |
35453849 | 736 | and |
f00bab84 | 737 | .Cm environment= |
738 | options in | |
739 | .Pa ~/.ssh/authorized_keys | |
35453849 | 740 | are processed by |
b74c3b8c | 741 | .Xr sshd 8 . |
f00bab84 | 742 | The default is |
743 | .Dq no . | |
35453849 | 744 | Enabling environment processing may enable users to bypass access |
745 | restrictions in some configurations using mechanisms such as | |
746 | .Ev LD_PRELOAD . | |
588df31a | 747 | .It Cm PidFile |
baa08b92 | 748 | Specifies the file that contains the process ID of the |
32cfd177 | 749 | SSH daemon. |
588df31a | 750 | The default is |
751 | .Pa /var/run/sshd.pid . | |
752 | .It Cm Port | |
753 | Specifies the port number that | |
b74c3b8c | 754 | .Xr sshd 8 |
588df31a | 755 | listens on. |
756 | The default is 22. | |
757 | Multiple options of this type are permitted. | |
758 | See also | |
759 | .Cm ListenAddress . | |
760 | .It Cm PrintLastLog | |
761 | Specifies whether | |
b74c3b8c | 762 | .Xr sshd 8 |
329a8666 | 763 | should print the date and time of the last user login when a user logs |
764 | in interactively. | |
588df31a | 765 | The default is |
766 | .Dq yes . | |
767 | .It Cm PrintMotd | |
768 | Specifies whether | |
b74c3b8c | 769 | .Xr sshd 8 |
588df31a | 770 | should print |
771 | .Pa /etc/motd | |
772 | when a user logs in interactively. | |
773 | (On some systems it is also printed by the shell, | |
774 | .Pa /etc/profile , | |
775 | or equivalent.) | |
776 | The default is | |
777 | .Dq yes . | |
778 | .It Cm Protocol | |
779 | Specifies the protocol versions | |
b74c3b8c | 780 | .Xr sshd 8 |
94ad46d1 | 781 | supports. |
588df31a | 782 | The possible values are |
b74c3b8c | 783 | .Sq 1 |
588df31a | 784 | and |
b74c3b8c | 785 | .Sq 2 . |
588df31a | 786 | Multiple versions must be comma-separated. |
787 | The default is | |
788 | .Dq 2,1 . | |
94ad46d1 | 789 | Note that the order of the protocol list does not indicate preference, |
790 | because the client selects among multiple protocol versions offered | |
791 | by the server. | |
792 | Specifying | |
793 | .Dq 2,1 | |
794 | is identical to | |
795 | .Dq 1,2 . | |
588df31a | 796 | .It Cm PubkeyAuthentication |
797 | Specifies whether public key authentication is allowed. | |
798 | The default is | |
799 | .Dq yes . | |
800 | Note that this option applies to protocol version 2 only. | |
588df31a | 801 | .It Cm RhostsRSAAuthentication |
802 | Specifies whether rhosts or /etc/hosts.equiv authentication together | |
803 | with successful RSA host authentication is allowed. | |
804 | The default is | |
805 | .Dq no . | |
806 | This option applies to protocol version 1 only. | |
807 | .It Cm RSAAuthentication | |
808 | Specifies whether pure RSA authentication is allowed. | |
809 | The default is | |
810 | .Dq yes . | |
811 | This option applies to protocol version 1 only. | |
812 | .It Cm ServerKeyBits | |
813 | Defines the number of bits in the ephemeral protocol version 1 server key. | |
39ceddb7 | 814 | The minimum value is 512, and the default is 1024. |
588df31a | 815 | .It Cm StrictModes |
816 | Specifies whether | |
b74c3b8c | 817 | .Xr sshd 8 |
588df31a | 818 | should check file modes and ownership of the |
819 | user's files and home directory before accepting login. | |
820 | This is normally desirable because novices sometimes accidentally leave their | |
821 | directory or files world-writable. | |
822 | The default is | |
823 | .Dq yes . | |
824 | .It Cm Subsystem | |
f09ffbdb | 825 | Configures an external subsystem (e.g. file transfer daemon). |
d66ce1a1 | 826 | Arguments should be a subsystem name and a command (with optional arguments) |
827 | to execute upon subsystem request. | |
db49deeb | 828 | .Pp |
588df31a | 829 | The command |
830 | .Xr sftp-server 8 | |
831 | implements the | |
832 | .Dq sftp | |
833 | file transfer subsystem. | |
db49deeb | 834 | .Pp |
835 | Alternately the name | |
836 | .Dq internal-sftp | |
837 | implements an in-process | |
838 | .Dq sftp | |
839 | server. | |
840 | This may simplify configurations using | |
841 | .Cm ChrootDirectory | |
842 | to force a different filesystem root on clients. | |
843 | .Pp | |
588df31a | 844 | By default no subsystems are defined. |
845 | Note that this option applies to protocol version 2 only. | |
846 | .It Cm SyslogFacility | |
847 | Gives the facility code that is used when logging messages from | |
32cfd177 | 848 | .Xr sshd 8 . |
588df31a | 849 | The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, |
850 | LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. | |
851 | The default is AUTH. | |
fd573618 | 852 | .It Cm TCPKeepAlive |
853 | Specifies whether the system should send TCP keepalive messages to the | |
854 | other side. | |
855 | If they are sent, death of the connection or crash of one | |
856 | of the machines will be properly noticed. | |
857 | However, this means that | |
858 | connections will die if the route is down temporarily, and some people | |
859 | find it annoying. | |
860 | On the other hand, if TCP keepalives are not sent, | |
861 | sessions may hang indefinitely on the server, leaving | |
862 | .Dq ghost | |
863 | users and consuming server resources. | |
864 | .Pp | |
865 | The default is | |
866 | .Dq yes | |
867 | (to send TCP keepalive messages), and the server will notice | |
868 | if the network goes down or the client host crashes. | |
869 | This avoids infinitely hanging sessions. | |
870 | .Pp | |
871 | To disable TCP keepalive messages, the value should be set to | |
872 | .Dq no . | |
c5a7d788 | 873 | .It Cm UseDNS |
874 | Specifies whether | |
b74c3b8c | 875 | .Xr sshd 8 |
102c77c2 | 876 | should look up the remote host name and check that |
c5a7d788 | 877 | the resolved host name for the remote IP address maps back to the |
878 | very same IP address. | |
879 | The default is | |
880 | .Dq yes . | |
588df31a | 881 | .It Cm UseLogin |
882 | Specifies whether | |
883 | .Xr login 1 | |
884 | is used for interactive login sessions. | |
885 | The default is | |
886 | .Dq no . | |
887 | Note that | |
888 | .Xr login 1 | |
889 | is never used for remote command execution. | |
890 | Note also, that if this is enabled, | |
891 | .Cm X11Forwarding | |
892 | will be disabled because | |
893 | .Xr login 1 | |
894 | does not know how to handle | |
895 | .Xr xauth 1 | |
a4e5acef | 896 | cookies. |
897 | If | |
588df31a | 898 | .Cm UsePrivilegeSeparation |
899 | is specified, it will be disabled after authentication. | |
72c35df7 | 900 | .It Cm UsePAM |
d5c67850 | 901 | Enables the Pluggable Authentication Module interface. |
902 | If set to | |
903 | .Dq yes | |
904 | this will enable PAM authentication using | |
905 | .Cm ChallengeResponseAuthentication | |
05059810 | 906 | and |
907 | .Cm PasswordAuthentication | |
908 | in addition to PAM account and session module processing for all | |
909 | authentication types. | |
d5c67850 | 910 | .Pp |
911 | Because PAM challenge-response authentication usually serves an equivalent | |
912 | role to password authentication, you should disable either | |
913 | .Cm PasswordAuthentication | |
914 | or | |
915 | .Cm ChallengeResponseAuthentication. | |
916 | .Pp | |
917 | If | |
918 | .Cm UsePAM | |
919 | is enabled, you will not be able to run | |
920 | .Xr sshd 8 | |
921 | as a non-root user. | |
922 | The default is | |
a83a3125 | 923 | .Dq no . |
588df31a | 924 | .It Cm UsePrivilegeSeparation |
925 | Specifies whether | |
b74c3b8c | 926 | .Xr sshd 8 |
588df31a | 927 | separates privileges by creating an unprivileged child process |
a4e5acef | 928 | to deal with incoming network traffic. |
929 | After successful authentication, another process will be created that has | |
930 | the privilege of the authenticated user. | |
931 | The goal of privilege separation is to prevent privilege | |
588df31a | 932 | escalation by containing any corruption within the unprivileged processes. |
933 | The default is | |
934 | .Dq yes . | |
588df31a | 935 | .It Cm X11DisplayOffset |
936 | Specifies the first display number available for | |
b74c3b8c | 937 | .Xr sshd 8 Ns 's |
588df31a | 938 | X11 forwarding. |
b74c3b8c | 939 | This prevents sshd from interfering with real X11 servers. |
588df31a | 940 | The default is 10. |
941 | .It Cm X11Forwarding | |
942 | Specifies whether X11 forwarding is permitted. | |
e6fe1bab | 943 | The argument must be |
944 | .Dq yes | |
945 | or | |
946 | .Dq no . | |
588df31a | 947 | The default is |
948 | .Dq no . | |
e6fe1bab | 949 | .Pp |
950 | When X11 forwarding is enabled, there may be additional exposure to | |
951 | the server and to client displays if the | |
b74c3b8c | 952 | .Xr sshd 8 |
e6fe1bab | 953 | proxy display is configured to listen on the wildcard address (see |
954 | .Cm X11UseLocalhost | |
b74c3b8c | 955 | below), though this is not the default. |
e6fe1bab | 956 | Additionally, the authentication spoofing and authentication data |
957 | verification and substitution occur on the client side. | |
958 | The security risk of using X11 forwarding is that the client's X11 | |
b74c3b8c | 959 | display server may be exposed to attack when the SSH client requests |
e6fe1bab | 960 | forwarding (see the warnings for |
961 | .Cm ForwardX11 | |
962 | in | |
be193d89 | 963 | .Xr ssh_config 5 ) . |
e6fe1bab | 964 | A system administrator may have a stance in which they want to |
965 | protect clients that may expose themselves to attack by unwittingly | |
966 | requesting X11 forwarding, which can warrant a | |
967 | .Dq no | |
968 | setting. | |
969 | .Pp | |
970 | Note that disabling X11 forwarding does not prevent users from | |
971 | forwarding X11 traffic, as users can always install their own forwarders. | |
588df31a | 972 | X11 forwarding is automatically disabled if |
973 | .Cm UseLogin | |
974 | is enabled. | |
975 | .It Cm X11UseLocalhost | |
976 | Specifies whether | |
b74c3b8c | 977 | .Xr sshd 8 |
588df31a | 978 | should bind the X11 forwarding server to the loopback address or to |
a4e5acef | 979 | the wildcard address. |
980 | By default, | |
b74c3b8c | 981 | sshd binds the forwarding server to the loopback address and sets the |
588df31a | 982 | hostname part of the |
983 | .Ev DISPLAY | |
984 | environment variable to | |
985 | .Dq localhost . | |
b3641662 | 986 | This prevents remote hosts from connecting to the proxy display. |
588df31a | 987 | However, some older X11 clients may not function with this |
988 | configuration. | |
989 | .Cm X11UseLocalhost | |
990 | may be set to | |
991 | .Dq no | |
992 | to specify that the forwarding server should be bound to the wildcard | |
993 | address. | |
994 | The argument must be | |
995 | .Dq yes | |
996 | or | |
997 | .Dq no . | |
998 | The default is | |
999 | .Dq yes . | |
1000 | .It Cm XAuthLocation | |
57ff5eeb | 1001 | Specifies the full pathname of the |
588df31a | 1002 | .Xr xauth 1 |
1003 | program. | |
1004 | The default is | |
1005 | .Pa /usr/X11R6/bin/xauth . | |
1006 | .El | |
ef1c6497 | 1007 | .Sh TIME FORMATS |
32cfd177 | 1008 | .Xr sshd 8 |
588df31a | 1009 | command-line arguments and configuration file options that specify time |
1010 | may be expressed using a sequence of the form: | |
1011 | .Sm off | |
36535ee6 | 1012 | .Ar time Op Ar qualifier , |
588df31a | 1013 | .Sm on |
1014 | where | |
1015 | .Ar time | |
1016 | is a positive integer value and | |
1017 | .Ar qualifier | |
1018 | is one of the following: | |
1019 | .Pp | |
1020 | .Bl -tag -width Ds -compact -offset indent | |
874d319b | 1021 | .It Aq Cm none |
588df31a | 1022 | seconds |
1023 | .It Cm s | Cm S | |
1024 | seconds | |
1025 | .It Cm m | Cm M | |
1026 | minutes | |
1027 | .It Cm h | Cm H | |
1028 | hours | |
1029 | .It Cm d | Cm D | |
1030 | days | |
1031 | .It Cm w | Cm W | |
1032 | weeks | |
1033 | .El | |
1034 | .Pp | |
1035 | Each member of the sequence is added together to calculate | |
1036 | the total time value. | |
1037 | .Pp | |
1038 | Time format examples: | |
1039 | .Pp | |
1040 | .Bl -tag -width Ds -compact -offset indent | |
1041 | .It 600 | |
1042 | 600 seconds (10 minutes) | |
1043 | .It 10m | |
1044 | 10 minutes | |
1045 | .It 1h30m | |
1046 | 1 hour 30 minutes (90 minutes) | |
1047 | .El | |
1048 | .Sh FILES | |
1049 | .Bl -tag -width Ds | |
1050 | .It Pa /etc/ssh/sshd_config | |
1051 | Contains configuration data for | |
32cfd177 | 1052 | .Xr sshd 8 . |
588df31a | 1053 | This file should be writable by root only, but it is recommended |
1054 | (though not necessary) that it be world-readable. | |
1055 | .El | |
be193d89 | 1056 | .Sh SEE ALSO |
1057 | .Xr sshd 8 | |
588df31a | 1058 | .Sh AUTHORS |
1059 | OpenSSH is a derivative of the original and free | |
1060 | ssh 1.2.12 release by Tatu Ylonen. | |
1061 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, | |
1062 | Theo de Raadt and Dug Song | |
1063 | removed many bugs, re-added newer features and | |
1064 | created OpenSSH. | |
1065 | Markus Friedl contributed the support for SSH | |
1066 | protocol versions 1.5 and 2.0. | |
1067 | Niels Provos and Markus Friedl contributed support | |
1068 | for privilege separation. |