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