diff options
Diffstat (limited to 'sshd_config.5')
-rw-r--r-- | sshd_config.5 | 728 |
1 files changed, 327 insertions, 401 deletions
diff --git a/sshd_config.5 b/sshd_config.5 index 1bc26ec4d..32b29d240 100644 --- a/sshd_config.5 +++ b/sshd_config.5 | |||
@@ -33,8 +33,8 @@ | |||
33 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | 33 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
34 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | 34 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
35 | .\" | 35 | .\" |
36 | .\" $OpenBSD: sshd_config.5,v 1.227 2016/07/19 12:59:16 jmc Exp $ | 36 | .\" $OpenBSD: sshd_config.5,v 1.239 2016/11/30 03:00:05 djm Exp $ |
37 | .Dd $Mdocdate: July 19 2016 $ | 37 | .Dd $Mdocdate: November 30 2016 $ |
38 | .Dt SSHD_CONFIG 5 | 38 | .Dt SSHD_CONFIG 5 |
39 | .Os | 39 | .Os |
40 | .Sh NAME | 40 | .Sh NAME |
@@ -90,19 +90,18 @@ The default is not to accept any environment variables. | |||
90 | Specifies which address family should be used by | 90 | Specifies which address family should be used by |
91 | .Xr sshd 8 . | 91 | .Xr sshd 8 . |
92 | Valid arguments are | 92 | Valid arguments are |
93 | .Dq any , | 93 | .Cm any |
94 | .Dq inet | 94 | (the default), |
95 | .Cm inet | ||
95 | (use IPv4 only), or | 96 | (use IPv4 only), or |
96 | .Dq inet6 | 97 | .Cm inet6 |
97 | (use IPv6 only). | 98 | (use IPv6 only). |
98 | The default is | ||
99 | .Dq any . | ||
100 | .It Cm AllowAgentForwarding | 99 | .It Cm AllowAgentForwarding |
101 | Specifies whether | 100 | Specifies whether |
102 | .Xr ssh-agent 1 | 101 | .Xr ssh-agent 1 |
103 | forwarding is permitted. | 102 | forwarding is permitted. |
104 | The default is | 103 | The default is |
105 | .Dq yes . | 104 | .Cm yes . |
106 | Note that disabling agent forwarding does not improve security | 105 | Note that disabling agent forwarding does not improve security |
107 | unless users are also denied shell access, as they can always install | 106 | unless users are also denied shell access, as they can always install |
108 | their own forwarders. | 107 | their own forwarders. |
@@ -123,44 +122,42 @@ and finally | |||
123 | See PATTERNS in | 122 | See PATTERNS in |
124 | .Xr ssh_config 5 | 123 | .Xr ssh_config 5 |
125 | for more information on patterns. | 124 | for more information on patterns. |
126 | .It Cm AllowTcpForwarding | 125 | .It Cm AllowStreamLocalForwarding |
127 | Specifies whether TCP forwarding is permitted. | 126 | Specifies whether StreamLocal (Unix-domain socket) forwarding is permitted. |
128 | The available options are | 127 | The available options are |
129 | .Dq yes | 128 | .Cm yes |
129 | (the default) | ||
130 | or | 130 | or |
131 | .Dq all | 131 | .Cm all |
132 | to allow TCP forwarding, | 132 | to allow StreamLocal forwarding, |
133 | .Dq no | 133 | .Cm no |
134 | to prevent all TCP forwarding, | 134 | to prevent all StreamLocal forwarding, |
135 | .Dq local | 135 | .Cm local |
136 | to allow local (from the perspective of | 136 | to allow local (from the perspective of |
137 | .Xr ssh 1 ) | 137 | .Xr ssh 1 ) |
138 | forwarding only or | 138 | forwarding only or |
139 | .Dq remote | 139 | .Cm remote |
140 | to allow remote forwarding only. | 140 | to allow remote forwarding only. |
141 | The default is | 141 | Note that disabling StreamLocal forwarding does not improve security unless |
142 | .Dq yes . | ||
143 | Note that disabling TCP forwarding does not improve security unless | ||
144 | users are also denied shell access, as they can always install their | 142 | users are also denied shell access, as they can always install their |
145 | own forwarders. | 143 | own forwarders. |
146 | .It Cm AllowStreamLocalForwarding | 144 | .It Cm AllowTcpForwarding |
147 | Specifies whether StreamLocal (Unix-domain socket) forwarding is permitted. | 145 | Specifies whether TCP forwarding is permitted. |
148 | The available options are | 146 | The available options are |
149 | .Dq yes | 147 | .Cm yes |
148 | (the default) | ||
150 | or | 149 | or |
151 | .Dq all | 150 | .Cm all |
152 | to allow StreamLocal forwarding, | 151 | to allow TCP forwarding, |
153 | .Dq no | 152 | .Cm no |
154 | to prevent all StreamLocal forwarding, | 153 | to prevent all TCP forwarding, |
155 | .Dq local | 154 | .Cm local |
156 | to allow local (from the perspective of | 155 | to allow local (from the perspective of |
157 | .Xr ssh 1 ) | 156 | .Xr ssh 1 ) |
158 | forwarding only or | 157 | forwarding only or |
159 | .Dq remote | 158 | .Cm remote |
160 | to allow remote forwarding only. | 159 | to allow remote forwarding only. |
161 | The default is | 160 | Note that disabling TCP forwarding does not improve security unless |
162 | .Dq yes . | ||
163 | Note that disabling StreamLocal forwarding does not improve security unless | ||
164 | users are also denied shell access, as they can always install their | 161 | users are also denied shell access, as they can always install their |
165 | own forwarders. | 162 | own forwarders. |
166 | .It Cm AllowUsers | 163 | .It Cm AllowUsers |
@@ -190,80 +187,73 @@ Specifies the authentication methods that must be successfully completed | |||
190 | for a user to be granted access. | 187 | for a user to be granted access. |
191 | This option must be followed by one or more comma-separated lists of | 188 | This option must be followed by one or more comma-separated lists of |
192 | authentication method names, or by the single string | 189 | authentication method names, or by the single string |
193 | .Dq any | 190 | .Cm any |
194 | to indicate the default behaviour of accepting any single authentication | 191 | to indicate the default behaviour of accepting any single authentication |
195 | method. | 192 | method. |
196 | if the default is overridden, then successful authentication requires | 193 | If the default is overridden, then successful authentication requires |
197 | completion of every method in at least one of these lists. | 194 | completion of every method in at least one of these lists. |
198 | .Pp | 195 | .Pp |
199 | For example, an argument of | 196 | For example, |
200 | .Dq publickey,password publickey,keyboard-interactive | 197 | .Qq publickey,password publickey,keyboard-interactive |
201 | would require the user to complete public key authentication, followed by | 198 | would require the user to complete public key authentication, followed by |
202 | either password or keyboard interactive authentication. | 199 | either password or keyboard interactive authentication. |
203 | Only methods that are next in one or more lists are offered at each stage, | 200 | Only methods that are next in one or more lists are offered at each stage, |
204 | so for this example, it would not be possible to attempt password or | 201 | so for this example it would not be possible to attempt password or |
205 | keyboard-interactive authentication before public key. | 202 | keyboard-interactive authentication before public key. |
206 | .Pp | 203 | .Pp |
207 | For keyboard interactive authentication it is also possible to | 204 | For keyboard interactive authentication it is also possible to |
208 | restrict authentication to a specific device by appending a | 205 | restrict authentication to a specific device by appending a |
209 | colon followed by the device identifier | 206 | colon followed by the device identifier |
210 | .Dq bsdauth , | 207 | .Cm bsdauth , |
211 | .Dq pam , | 208 | .Cm pam , |
212 | or | 209 | or |
213 | .Dq skey , | 210 | .Cm skey , |
214 | depending on the server configuration. | 211 | depending on the server configuration. |
215 | For example, | 212 | For example, |
216 | .Dq keyboard-interactive:bsdauth | 213 | .Qq keyboard-interactive:bsdauth |
217 | would restrict keyboard interactive authentication to the | 214 | would restrict keyboard interactive authentication to the |
218 | .Dq bsdauth | 215 | .Cm bsdauth |
219 | device. | 216 | device. |
220 | .Pp | 217 | .Pp |
221 | If the | 218 | If the publickey method is listed more than once, |
222 | .Dq publickey | ||
223 | method is listed more than once, | ||
224 | .Xr sshd 8 | 219 | .Xr sshd 8 |
225 | verifies that keys that have been used successfully are not reused for | 220 | verifies that keys that have been used successfully are not reused for |
226 | subsequent authentications. | 221 | subsequent authentications. |
227 | For example, an | 222 | For example, |
228 | .Cm AuthenticationMethods | 223 | .Qq publickey,publickey |
229 | of | 224 | requires successful authentication using two different public keys. |
230 | .Dq publickey,publickey | 225 | .Pp |
231 | will require successful authentication using two different public keys. | ||
232 | .Pp | ||
233 | This option will yield a fatal | ||
234 | error if enabled if protocol 1 is also enabled. | ||
235 | Note that each authentication method listed should also be explicitly enabled | 226 | Note that each authentication method listed should also be explicitly enabled |
236 | in the configuration. | 227 | in the configuration. |
237 | The default | ||
238 | .Dq any | ||
239 | is not to require multiple authentication; successful completion | ||
240 | of a single authentication method is sufficient. | ||
241 | .It Cm AuthorizedKeysCommand | 228 | .It Cm AuthorizedKeysCommand |
242 | Specifies a program to be used to look up the user's public keys. | 229 | Specifies a program to be used to look up the user's public keys. |
243 | The program must be owned by root, not writable by group or others and | 230 | The program must be owned by root, not writable by group or others and |
244 | specified by an absolute path. | 231 | specified by an absolute path. |
245 | .Pp | ||
246 | Arguments to | 232 | Arguments to |
247 | .Cm AuthorizedKeysCommand | 233 | .Cm AuthorizedKeysCommand |
248 | may be provided using the following tokens, which will be expanded | 234 | accept the tokens described in the |
249 | at runtime: %% is replaced by a literal '%', %u is replaced by the | 235 | .Sx TOKENS |
250 | username being authenticated, %h is replaced by the home directory | 236 | section. |
251 | of the user being authenticated, %t is replaced with the key type | 237 | If no arguments are specified then the username of the target user is used. |
252 | offered for authentication, %f is replaced with the fingerprint of | ||
253 | the key, and %k is replaced with the key being offered for authentication. | ||
254 | If no arguments are specified then the username of the target user | ||
255 | will be supplied. | ||
256 | .Pp | 238 | .Pp |
257 | The program should produce on standard output zero or | 239 | The program should produce on standard output zero or |
258 | more lines of authorized_keys output (see AUTHORIZED_KEYS in | 240 | more lines of authorized_keys output (see |
241 | .Sx AUTHORIZED_KEYS | ||
242 | in | ||
259 | .Xr sshd 8 ) . | 243 | .Xr sshd 8 ) . |
260 | If a key supplied by AuthorizedKeysCommand does not successfully authenticate | 244 | If a key supplied by |
245 | .Cm AuthorizedKeysCommand | ||
246 | does not successfully authenticate | ||
261 | and authorize the user then public key authentication continues using the usual | 247 | and authorize the user then public key authentication continues using the usual |
262 | .Cm AuthorizedKeysFile | 248 | .Cm AuthorizedKeysFile |
263 | files. | 249 | files. |
264 | By default, no AuthorizedKeysCommand is run. | 250 | By default, no |
251 | .Cm AuthorizedKeysCommand | ||
252 | is run. | ||
265 | .It Cm AuthorizedKeysCommandUser | 253 | .It Cm AuthorizedKeysCommandUser |
266 | Specifies the user under whose account the AuthorizedKeysCommand is run. | 254 | Specifies the user under whose account the |
255 | .Cm AuthorizedKeysCommand | ||
256 | is run. | ||
267 | It is recommended to use a dedicated user that has no other role on the host | 257 | It is recommended to use a dedicated user that has no other role on the host |
268 | than running authorized keys commands. | 258 | than running authorized keys commands. |
269 | If | 259 | If |
@@ -274,41 +264,38 @@ is not, then | |||
274 | .Xr sshd 8 | 264 | .Xr sshd 8 |
275 | will refuse to start. | 265 | will refuse to start. |
276 | .It Cm AuthorizedKeysFile | 266 | .It Cm AuthorizedKeysFile |
277 | Specifies the file that contains the public keys that can be used | 267 | Specifies the file that contains the public keys used for user authentication. |
278 | for user authentication. | ||
279 | The format is described in the | 268 | The format is described in the |
280 | AUTHORIZED_KEYS FILE FORMAT | 269 | .Sx AUTHORIZED_KEYS FILE FORMAT |
281 | section of | 270 | section of |
282 | .Xr sshd 8 . | 271 | .Xr sshd 8 . |
272 | Arguments to | ||
283 | .Cm AuthorizedKeysFile | 273 | .Cm AuthorizedKeysFile |
284 | may contain tokens of the form %T which are substituted during connection | 274 | accept the tokens described in the |
285 | setup. | 275 | .Sx TOKENS |
286 | The following tokens are defined: %% is replaced by a literal '%', | 276 | section. |
287 | %h is replaced by the home directory of the user being authenticated, and | ||
288 | %u is replaced by the username of that user. | ||
289 | After expansion, | 277 | After expansion, |
290 | .Cm AuthorizedKeysFile | 278 | .Cm AuthorizedKeysFile |
291 | is taken to be an absolute path or one relative to the user's home | 279 | is taken to be an absolute path or one relative to the user's home |
292 | directory. | 280 | directory. |
293 | Multiple files may be listed, separated by whitespace. | 281 | Multiple files may be listed, separated by whitespace. |
294 | Alternately this option may be set to | 282 | Alternately this option may be set to |
295 | .Dq none | 283 | .Cm none |
296 | to skip checking for user keys in files. | 284 | to skip checking for user keys in files. |
297 | The default is | 285 | The default is |
298 | .Dq .ssh/authorized_keys .ssh/authorized_keys2 . | 286 | .Qq .ssh/authorized_keys .ssh/authorized_keys2 . |
299 | .It Cm AuthorizedPrincipalsCommand | 287 | .It Cm AuthorizedPrincipalsCommand |
300 | Specifies a program to be used to generate the list of allowed | 288 | Specifies a program to be used to generate the list of allowed |
301 | certificate principals as per | 289 | certificate principals as per |
302 | .Cm AuthorizedPrincipalsFile . | 290 | .Cm AuthorizedPrincipalsFile . |
303 | The program must be owned by root, not writable by group or others and | 291 | The program must be owned by root, not writable by group or others and |
304 | specified by an absolute path. | 292 | specified by an absolute path. |
305 | .Pp | ||
306 | Arguments to | 293 | Arguments to |
307 | .Cm AuthorizedPrincipalsCommand | 294 | .Cm AuthorizedPrincipalsCommand |
308 | may be provided using the following tokens, which will be expanded | 295 | accept the tokens described in the |
309 | at runtime: %% is replaced by a literal '%', %u is replaced by the | 296 | .Sx TOKENS |
310 | username being authenticated and %h is replaced by the home directory | 297 | section. |
311 | of the user being authenticated. | 298 | If no arguments are specified then the username of the target user is used. |
312 | .Pp | 299 | .Pp |
313 | The program should produce on standard output zero or | 300 | The program should produce on standard output zero or |
314 | more lines of | 301 | more lines of |
@@ -320,9 +307,13 @@ or | |||
320 | .Cm AuthorizedPrincipalsFile | 307 | .Cm AuthorizedPrincipalsFile |
321 | is specified, then certificates offered by the client for authentication | 308 | is specified, then certificates offered by the client for authentication |
322 | must contain a principal that is listed. | 309 | must contain a principal that is listed. |
323 | By default, no AuthorizedPrincipalsCommand is run. | 310 | By default, no |
311 | .Cm AuthorizedPrincipalsCommand | ||
312 | is run. | ||
324 | .It Cm AuthorizedPrincipalsCommandUser | 313 | .It Cm AuthorizedPrincipalsCommandUser |
325 | Specifies the user under whose account the AuthorizedPrincipalsCommand is run. | 314 | Specifies the user under whose account the |
315 | .Cm AuthorizedPrincipalsCommand | ||
316 | is run. | ||
326 | It is recommended to use a dedicated user that has no other role on the host | 317 | It is recommended to use a dedicated user that has no other role on the host |
327 | than running authorized principals commands. | 318 | than running authorized principals commands. |
328 | If | 319 | If |
@@ -339,29 +330,28 @@ When using certificates signed by a key listed in | |||
339 | .Cm TrustedUserCAKeys , | 330 | .Cm TrustedUserCAKeys , |
340 | this file lists names, one of which must appear in the certificate for it | 331 | this file lists names, one of which must appear in the certificate for it |
341 | to be accepted for authentication. | 332 | to be accepted for authentication. |
342 | Names are listed one per line preceded by key options (as described | 333 | Names are listed one per line preceded by key options (as described in |
343 | in AUTHORIZED_KEYS FILE FORMAT in | 334 | .Sx AUTHORIZED_KEYS FILE FORMAT |
335 | in | ||
344 | .Xr sshd 8 ) . | 336 | .Xr sshd 8 ) . |
345 | Empty lines and comments starting with | 337 | Empty lines and comments starting with |
346 | .Ql # | 338 | .Ql # |
347 | are ignored. | 339 | are ignored. |
348 | .Pp | 340 | .Pp |
341 | Arguments to | ||
349 | .Cm AuthorizedPrincipalsFile | 342 | .Cm AuthorizedPrincipalsFile |
350 | may contain tokens of the form %T which are substituted during connection | 343 | accept the tokens described in the |
351 | setup. | 344 | .Sx TOKENS |
352 | The following tokens are defined: %% is replaced by a literal '%', | 345 | section. |
353 | %h is replaced by the home directory of the user being authenticated, and | ||
354 | %u is replaced by the username of that user. | ||
355 | After expansion, | 346 | After expansion, |
356 | .Cm AuthorizedPrincipalsFile | 347 | .Cm AuthorizedPrincipalsFile |
357 | is taken to be an absolute path or one relative to the user's home | 348 | is taken to be an absolute path or one relative to the user's home directory. |
358 | directory. | ||
359 | .Pp | ||
360 | The default is | 349 | The default is |
361 | .Dq none , | 350 | .Cm none , |
362 | i.e. not to use a principals file \(en in this case, the username | 351 | i.e. not to use a principals file \(en in this case, the username |
363 | of the user must appear in a certificate's principals list for it to be | 352 | of the user must appear in a certificate's principals list for it to be |
364 | accepted. | 353 | accepted. |
354 | .Pp | ||
365 | Note that | 355 | Note that |
366 | .Cm AuthorizedPrincipalsFile | 356 | .Cm AuthorizedPrincipalsFile |
367 | is only used when authentication proceeds using a CA listed in | 357 | is only used when authentication proceeds using a CA listed in |
@@ -377,7 +367,7 @@ for details). | |||
377 | The contents of the specified file are sent to the remote user before | 367 | The contents of the specified file are sent to the remote user before |
378 | authentication is allowed. | 368 | authentication is allowed. |
379 | If the argument is | 369 | If the argument is |
380 | .Dq none | 370 | .Cm none |
381 | then no banner is displayed. | 371 | then no banner is displayed. |
382 | By default, no banner is displayed. | 372 | By default, no banner is displayed. |
383 | .It Cm ChallengeResponseAuthentication | 373 | .It Cm ChallengeResponseAuthentication |
@@ -385,7 +375,7 @@ Specifies whether challenge-response authentication is allowed (e.g. via | |||
385 | PAM or through authentication styles supported in | 375 | PAM or through authentication styles supported in |
386 | .Xr login.conf 5 ) | 376 | .Xr login.conf 5 ) |
387 | The default is | 377 | The default is |
388 | .Dq yes . | 378 | .Cm yes . |
389 | .It Cm ChrootDirectory | 379 | .It Cm ChrootDirectory |
390 | Specifies the pathname of a directory to | 380 | Specifies the pathname of a directory to |
391 | .Xr chroot 2 | 381 | .Xr chroot 2 |
@@ -397,11 +387,11 @@ which are not writable by any other user or group. | |||
397 | After the chroot, | 387 | After the chroot, |
398 | .Xr sshd 8 | 388 | .Xr sshd 8 |
399 | changes the working directory to the user's home directory. | 389 | changes the working directory to the user's home directory. |
400 | .Pp | 390 | Arguments to |
401 | The pathname may contain the following tokens that are expanded at runtime once | 391 | .Cm ChrootDirectory |
402 | the connecting user has been authenticated: %% is replaced by a literal '%', | 392 | accept the tokens described in the |
403 | %h is replaced by the home directory of the user being authenticated, and | 393 | .Sx TOKENS |
404 | %u is replaced by the username of that user. | 394 | section. |
405 | .Pp | 395 | .Pp |
406 | The | 396 | The |
407 | .Cm ChrootDirectory | 397 | .Cm ChrootDirectory |
@@ -420,10 +410,9 @@ nodes such as | |||
420 | and | 410 | and |
421 | .Xr tty 4 | 411 | .Xr tty 4 |
422 | devices. | 412 | devices. |
423 | For file transfer sessions using | 413 | For file transfer sessions using SFTP |
424 | .Dq sftp , | 414 | no additional configuration of the environment is necessary if the in-process |
425 | no additional configuration of the environment is necessary if the | 415 | sftp-server is used, |
426 | in-process sftp server is used, | ||
427 | though sessions which use logging may require | 416 | though sessions which use logging may require |
428 | .Pa /dev/log | 417 | .Pa /dev/log |
429 | inside the chroot directory on some operating systems (see | 418 | inside the chroot directory on some operating systems (see |
@@ -438,7 +427,7 @@ Misconfiguration can lead to unsafe environments which | |||
438 | cannot detect. | 427 | cannot detect. |
439 | .Pp | 428 | .Pp |
440 | The default is | 429 | The default is |
441 | .Dq none , | 430 | .Cm none , |
442 | indicating not to | 431 | indicating not to |
443 | .Xr chroot 2 . | 432 | .Xr chroot 2 . |
444 | .It Cm Ciphers | 433 | .It Cm Ciphers |
@@ -491,23 +480,17 @@ aes128-ctr,aes192-ctr,aes256-ctr, | |||
491 | aes128-gcm@openssh.com,aes256-gcm@openssh.com | 480 | aes128-gcm@openssh.com,aes256-gcm@openssh.com |
492 | .Ed | 481 | .Ed |
493 | .Pp | 482 | .Pp |
494 | The list of available ciphers may also be obtained using the | 483 | The list of available ciphers may also be obtained using |
495 | .Fl Q | 484 | .Qq ssh -Q cipher . |
496 | option of | ||
497 | .Xr ssh 1 | ||
498 | with an argument of | ||
499 | .Dq cipher . | ||
500 | .It Cm ClientAliveCountMax | 485 | .It Cm ClientAliveCountMax |
501 | Sets the number of client alive messages (see below) which may be | 486 | Sets the number of client alive messages which may be sent without |
502 | sent without | ||
503 | .Xr sshd 8 | 487 | .Xr sshd 8 |
504 | receiving any messages back from the client. | 488 | receiving any messages back from the client. |
505 | If this threshold is reached while client alive messages are being sent, | 489 | If this threshold is reached while client alive messages are being sent, |
506 | sshd will disconnect the client, terminating the session. | 490 | sshd will disconnect the client, terminating the session. |
507 | It is important to note that the use of client alive messages is very | 491 | It is important to note that the use of client alive messages is very |
508 | different from | 492 | different from |
509 | .Cm TCPKeepAlive | 493 | .Cm TCPKeepAlive . |
510 | (below). | ||
511 | The client alive messages are sent through the encrypted channel | 494 | The client alive messages are sent through the encrypted channel |
512 | and therefore will not be spoofable. | 495 | and therefore will not be spoofable. |
513 | The TCP keepalive option enabled by | 496 | The TCP keepalive option enabled by |
@@ -519,7 +502,7 @@ server depend on knowing when a connection has become inactive. | |||
519 | The default value is 3. | 502 | The default value is 3. |
520 | If | 503 | If |
521 | .Cm ClientAliveInterval | 504 | .Cm ClientAliveInterval |
522 | (see below) is set to 15, and | 505 | is set to 15, and |
523 | .Cm ClientAliveCountMax | 506 | .Cm ClientAliveCountMax |
524 | is left at the default, unresponsive SSH clients | 507 | is left at the default, unresponsive SSH clients |
525 | will be disconnected after approximately 45 seconds. | 508 | will be disconnected after approximately 45 seconds. |
@@ -532,15 +515,17 @@ channel to request a response from the client. | |||
532 | The default | 515 | The default |
533 | is 0, indicating that these messages will not be sent to the client. | 516 | is 0, indicating that these messages will not be sent to the client. |
534 | .It Cm Compression | 517 | .It Cm Compression |
535 | Specifies whether compression is allowed, or delayed until | 518 | Specifies whether compression is enabled after |
536 | the user has authenticated successfully. | 519 | the user has authenticated successfully. |
537 | The argument must be | 520 | The argument must be |
538 | .Dq yes , | 521 | .Cm yes , |
539 | .Dq delayed , | 522 | .Cm delayed |
523 | (a legacy synonym for | ||
524 | .Cm yes ) | ||
540 | or | 525 | or |
541 | .Dq no . | 526 | .Cm no . |
542 | The default is | 527 | The default is |
543 | .Dq delayed . | 528 | .Cm yes . |
544 | .It Cm DenyGroups | 529 | .It Cm DenyGroups |
545 | This keyword can be followed by a list of group name patterns, separated | 530 | This keyword can be followed by a list of group name patterns, separated |
546 | by spaces. | 531 | by spaces. |
@@ -579,14 +564,20 @@ and finally | |||
579 | See PATTERNS in | 564 | See PATTERNS in |
580 | .Xr ssh_config 5 | 565 | .Xr ssh_config 5 |
581 | for more information on patterns. | 566 | for more information on patterns. |
567 | .It Cm DisableForwarding | ||
568 | Disables all forwarding features, including X11, | ||
569 | .Xr ssh-agent 1 , | ||
570 | TCP and StreamLocal. | ||
571 | This option overrides all other forwarding-related options and may | ||
572 | simplify restricted configurations. | ||
582 | .It Cm FingerprintHash | 573 | .It Cm FingerprintHash |
583 | Specifies the hash algorithm used when logging key fingerprints. | 574 | Specifies the hash algorithm used when logging key fingerprints. |
584 | Valid options are: | 575 | Valid options are: |
585 | .Dq md5 | 576 | .Cm md5 |
586 | and | 577 | and |
587 | .Dq sha256 . | 578 | .Cm sha256 . |
588 | The default is | 579 | The default is |
589 | .Dq sha256 . | 580 | .Cm sha256 . |
590 | .It Cm ForceCommand | 581 | .It Cm ForceCommand |
591 | Forces the execution of the command specified by | 582 | Forces the execution of the command specified by |
592 | .Cm ForceCommand , | 583 | .Cm ForceCommand , |
@@ -602,12 +593,12 @@ The command originally supplied by the client is available in the | |||
602 | .Ev SSH_ORIGINAL_COMMAND | 593 | .Ev SSH_ORIGINAL_COMMAND |
603 | environment variable. | 594 | environment variable. |
604 | Specifying a command of | 595 | Specifying a command of |
605 | .Dq internal-sftp | 596 | .Cm internal-sftp |
606 | will force the use of an in-process sftp server that requires no support | 597 | will force the use of an in-process SFTP server that requires no support |
607 | files when used with | 598 | files when used with |
608 | .Cm ChrootDirectory . | 599 | .Cm ChrootDirectory . |
609 | The default is | 600 | The default is |
610 | .Dq none . | 601 | .Cm none . |
611 | .It Cm GatewayPorts | 602 | .It Cm GatewayPorts |
612 | Specifies whether remote hosts are allowed to connect to ports | 603 | Specifies whether remote hosts are allowed to connect to ports |
613 | forwarded for the client. | 604 | forwarded for the client. |
@@ -620,38 +611,37 @@ can be used to specify that sshd | |||
620 | should allow remote port forwardings to bind to non-loopback addresses, thus | 611 | should allow remote port forwardings to bind to non-loopback addresses, thus |
621 | allowing other hosts to connect. | 612 | allowing other hosts to connect. |
622 | The argument may be | 613 | The argument may be |
623 | .Dq no | 614 | .Cm no |
624 | to force remote port forwardings to be available to the local host only, | 615 | to force remote port forwardings to be available to the local host only, |
625 | .Dq yes | 616 | .Cm yes |
626 | to force remote port forwardings to bind to the wildcard address, or | 617 | to force remote port forwardings to bind to the wildcard address, or |
627 | .Dq clientspecified | 618 | .Cm clientspecified |
628 | to allow the client to select the address to which the forwarding is bound. | 619 | to allow the client to select the address to which the forwarding is bound. |
629 | The default is | 620 | The default is |
630 | .Dq no . | 621 | .Cm no . |
631 | .It Cm GSSAPIAuthentication | 622 | .It Cm GSSAPIAuthentication |
632 | Specifies whether user authentication based on GSSAPI is allowed. | 623 | Specifies whether user authentication based on GSSAPI is allowed. |
633 | The default is | 624 | The default is |
634 | .Dq no . | 625 | .Cm no . |
635 | .It Cm GSSAPICleanupCredentials | 626 | .It Cm GSSAPICleanupCredentials |
636 | Specifies whether to automatically destroy the user's credentials cache | 627 | Specifies whether to automatically destroy the user's credentials cache |
637 | on logout. | 628 | on logout. |
638 | The default is | 629 | The default is |
639 | .Dq yes . | 630 | .Cm yes . |
640 | .It Cm GSSAPIStrictAcceptorCheck | 631 | .It Cm GSSAPIStrictAcceptorCheck |
641 | Determines whether to be strict about the identity of the GSSAPI acceptor | 632 | Determines whether to be strict about the identity of the GSSAPI acceptor |
642 | a client authenticates against. | 633 | a client authenticates against. |
643 | If set to | 634 | If set to |
644 | .Dq yes | 635 | .Cm yes |
645 | then the client must authenticate against the | 636 | then the client must authenticate against the host |
646 | .Pa host | ||
647 | service on the current hostname. | 637 | service on the current hostname. |
648 | If set to | 638 | If set to |
649 | .Dq no | 639 | .Cm no |
650 | then the client may authenticate against any service key stored in the | 640 | then the client may authenticate against any service key stored in the |
651 | machine's default store. | 641 | machine's default store. |
652 | This facility is provided to assist with operation on multi homed machines. | 642 | This facility is provided to assist with operation on multi homed machines. |
653 | The default is | 643 | The default is |
654 | .Dq yes . | 644 | .Cm yes . |
655 | .It Cm HostbasedAcceptedKeyTypes | 645 | .It Cm HostbasedAcceptedKeyTypes |
656 | Specifies the key types that will be accepted for hostbased authentication | 646 | Specifies the key types that will be accepted for hostbased authentication |
657 | as a comma-separated pattern list. | 647 | as a comma-separated pattern list. |
@@ -670,17 +660,14 @@ ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, | |||
670 | ssh-ed25519,ssh-rsa | 660 | ssh-ed25519,ssh-rsa |
671 | .Ed | 661 | .Ed |
672 | .Pp | 662 | .Pp |
673 | The | 663 | The list of available key types may also be obtained using |
674 | .Fl Q | 664 | .Qq ssh -Q key . |
675 | option of | ||
676 | .Xr ssh 1 | ||
677 | may be used to list supported key types. | ||
678 | .It Cm HostbasedAuthentication | 665 | .It Cm HostbasedAuthentication |
679 | Specifies whether rhosts or /etc/hosts.equiv authentication together | 666 | Specifies whether rhosts or /etc/hosts.equiv authentication together |
680 | with successful public key client host authentication is allowed | 667 | with successful public key client host authentication is allowed |
681 | (host-based authentication). | 668 | (host-based authentication). |
682 | The default is | 669 | The default is |
683 | .Dq no . | 670 | .Cm no . |
684 | .It Cm HostbasedUsesNameFromPacketOnly | 671 | .It Cm HostbasedUsesNameFromPacketOnly |
685 | Specifies whether or not the server will attempt to perform a reverse | 672 | Specifies whether or not the server will attempt to perform a reverse |
686 | name lookup when matching the name in the | 673 | name lookup when matching the name in the |
@@ -691,13 +678,13 @@ and | |||
691 | files during | 678 | files during |
692 | .Cm HostbasedAuthentication . | 679 | .Cm HostbasedAuthentication . |
693 | A setting of | 680 | A setting of |
694 | .Dq yes | 681 | .Cm yes |
695 | means that | 682 | means that |
696 | .Xr sshd 8 | 683 | .Xr sshd 8 |
697 | uses the name supplied by the client rather than | 684 | uses the name supplied by the client rather than |
698 | attempting to resolve the name from the TCP connection itself. | 685 | attempting to resolve the name from the TCP connection itself. |
699 | The default is | 686 | The default is |
700 | .Dq no . | 687 | .Cm no . |
701 | .It Cm HostCertificate | 688 | .It Cm HostCertificate |
702 | Specifies a file containing a public host certificate. | 689 | Specifies a file containing a public host certificate. |
703 | The certificate's public key must match a private host key already specified | 690 | The certificate's public key must match a private host key already specified |
@@ -709,15 +696,12 @@ is not to load any certificates. | |||
709 | .It Cm HostKey | 696 | .It Cm HostKey |
710 | Specifies a file containing a private host key | 697 | Specifies a file containing a private host key |
711 | used by SSH. | 698 | used by SSH. |
712 | The default is | 699 | The defaults are |
713 | .Pa /etc/ssh/ssh_host_key | ||
714 | for protocol version 1, and | ||
715 | .Pa /etc/ssh/ssh_host_dsa_key , | 700 | .Pa /etc/ssh/ssh_host_dsa_key , |
716 | .Pa /etc/ssh/ssh_host_ecdsa_key , | 701 | .Pa /etc/ssh/ssh_host_ecdsa_key , |
717 | .Pa /etc/ssh/ssh_host_ed25519_key | 702 | .Pa /etc/ssh/ssh_host_ed25519_key |
718 | and | 703 | and |
719 | .Pa /etc/ssh/ssh_host_rsa_key | 704 | .Pa /etc/ssh/ssh_host_rsa_key . |
720 | for protocol version 2. | ||
721 | .Pp | 705 | .Pp |
722 | Note that | 706 | Note that |
723 | .Xr sshd 8 | 707 | .Xr sshd 8 |
@@ -728,14 +712,6 @@ option restricts which of the keys are actually used by | |||
728 | .Xr sshd 8 . | 712 | .Xr sshd 8 . |
729 | .Pp | 713 | .Pp |
730 | It is possible to have multiple host key files. | 714 | It is possible to have multiple host key files. |
731 | .Dq rsa1 | ||
732 | keys are used for version 1 and | ||
733 | .Dq dsa , | ||
734 | .Dq ecdsa , | ||
735 | .Dq ed25519 | ||
736 | or | ||
737 | .Dq rsa | ||
738 | are used for version 2 of the SSH protocol. | ||
739 | It is also possible to specify public host key files instead. | 715 | It is also possible to specify public host key files instead. |
740 | In this case operations on the private key will be delegated | 716 | In this case operations on the private key will be delegated |
741 | to an | 717 | to an |
@@ -744,7 +720,7 @@ to an | |||
744 | Identifies the UNIX-domain socket used to communicate | 720 | Identifies the UNIX-domain socket used to communicate |
745 | with an agent that has access to the private host keys. | 721 | with an agent that has access to the private host keys. |
746 | If the string | 722 | If the string |
747 | .Dq SSH_AUTH_SOCK | 723 | .Qq SSH_AUTH_SOCK |
748 | is specified, the location of the socket will be read from the | 724 | is specified, the location of the socket will be read from the |
749 | .Ev SSH_AUTH_SOCK | 725 | .Ev SSH_AUTH_SOCK |
750 | environment variable. | 726 | environment variable. |
@@ -762,20 +738,14 @@ ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, | |||
762 | ssh-ed25519,ssh-rsa | 738 | ssh-ed25519,ssh-rsa |
763 | .Ed | 739 | .Ed |
764 | .Pp | 740 | .Pp |
765 | The list of available key types may also be obtained using the | 741 | The list of available key types may also be obtained using |
766 | .Fl Q | 742 | .Qq ssh -Q key . |
767 | option of | ||
768 | .Xr ssh 1 | ||
769 | with an argument of | ||
770 | .Dq key . | ||
771 | .It Cm IgnoreRhosts | 743 | .It Cm IgnoreRhosts |
772 | Specifies that | 744 | Specifies that |
773 | .Pa .rhosts | 745 | .Pa .rhosts |
774 | and | 746 | and |
775 | .Pa .shosts | 747 | .Pa .shosts |
776 | files will not be used in | 748 | files will not be used in |
777 | .Cm RhostsRSAAuthentication | ||
778 | or | ||
779 | .Cm HostbasedAuthentication . | 749 | .Cm HostbasedAuthentication . |
780 | .Pp | 750 | .Pp |
781 | .Pa /etc/hosts.equiv | 751 | .Pa /etc/hosts.equiv |
@@ -783,66 +753,64 @@ and | |||
783 | .Pa /etc/shosts.equiv | 753 | .Pa /etc/shosts.equiv |
784 | are still used. | 754 | are still used. |
785 | The default is | 755 | The default is |
786 | .Dq yes . | 756 | .Cm yes . |
787 | .It Cm IgnoreUserKnownHosts | 757 | .It Cm IgnoreUserKnownHosts |
788 | Specifies whether | 758 | Specifies whether |
789 | .Xr sshd 8 | 759 | .Xr sshd 8 |
790 | should ignore the user's | 760 | should ignore the user's |
791 | .Pa ~/.ssh/known_hosts | 761 | .Pa ~/.ssh/known_hosts |
792 | during | 762 | during |
793 | .Cm RhostsRSAAuthentication | ||
794 | or | ||
795 | .Cm HostbasedAuthentication . | 763 | .Cm HostbasedAuthentication . |
796 | The default is | 764 | The default is |
797 | .Dq no . | 765 | .Cm no . |
798 | .It Cm IPQoS | 766 | .It Cm IPQoS |
799 | Specifies the IPv4 type-of-service or DSCP class for the connection. | 767 | Specifies the IPv4 type-of-service or DSCP class for the connection. |
800 | Accepted values are | 768 | Accepted values are |
801 | .Dq af11 , | 769 | .Cm af11 , |
802 | .Dq af12 , | 770 | .Cm af12 , |
803 | .Dq af13 , | 771 | .Cm af13 , |
804 | .Dq af21 , | 772 | .Cm af21 , |
805 | .Dq af22 , | 773 | .Cm af22 , |
806 | .Dq af23 , | 774 | .Cm af23 , |
807 | .Dq af31 , | 775 | .Cm af31 , |
808 | .Dq af32 , | 776 | .Cm af32 , |
809 | .Dq af33 , | 777 | .Cm af33 , |
810 | .Dq af41 , | 778 | .Cm af41 , |
811 | .Dq af42 , | 779 | .Cm af42 , |
812 | .Dq af43 , | 780 | .Cm af43 , |
813 | .Dq cs0 , | 781 | .Cm cs0 , |
814 | .Dq cs1 , | 782 | .Cm cs1 , |
815 | .Dq cs2 , | 783 | .Cm cs2 , |
816 | .Dq cs3 , | 784 | .Cm cs3 , |
817 | .Dq cs4 , | 785 | .Cm cs4 , |
818 | .Dq cs5 , | 786 | .Cm cs5 , |
819 | .Dq cs6 , | 787 | .Cm cs6 , |
820 | .Dq cs7 , | 788 | .Cm cs7 , |
821 | .Dq ef , | 789 | .Cm ef , |
822 | .Dq lowdelay , | 790 | .Cm lowdelay , |
823 | .Dq throughput , | 791 | .Cm throughput , |
824 | .Dq reliability , | 792 | .Cm reliability , |
825 | or a numeric value. | 793 | or a numeric value. |
826 | This option may take one or two arguments, separated by whitespace. | 794 | This option may take one or two arguments, separated by whitespace. |
827 | If one argument is specified, it is used as the packet class unconditionally. | 795 | If one argument is specified, it is used as the packet class unconditionally. |
828 | If two values are specified, the first is automatically selected for | 796 | If two values are specified, the first is automatically selected for |
829 | interactive sessions and the second for non-interactive sessions. | 797 | interactive sessions and the second for non-interactive sessions. |
830 | The default is | 798 | The default is |
831 | .Dq lowdelay | 799 | .Cm lowdelay |
832 | for interactive sessions and | 800 | for interactive sessions and |
833 | .Dq throughput | 801 | .Cm throughput |
834 | for non-interactive sessions. | 802 | for non-interactive sessions. |
835 | .It Cm KbdInteractiveAuthentication | 803 | .It Cm KbdInteractiveAuthentication |
836 | Specifies whether to allow keyboard-interactive authentication. | 804 | Specifies whether to allow keyboard-interactive authentication. |
837 | The argument to this keyword must be | 805 | The argument to this keyword must be |
838 | .Dq yes | 806 | .Cm yes |
839 | or | 807 | or |
840 | .Dq no . | 808 | .Cm no . |
841 | The default is to use whatever value | 809 | The default is to use whatever value |
842 | .Cm ChallengeResponseAuthentication | 810 | .Cm ChallengeResponseAuthentication |
843 | is set to | 811 | is set to |
844 | (by default | 812 | (by default |
845 | .Dq yes ) . | 813 | .Cm yes ) . |
846 | .It Cm KerberosAuthentication | 814 | .It Cm KerberosAuthentication |
847 | Specifies whether the password provided by the user for | 815 | Specifies whether the password provided by the user for |
848 | .Cm PasswordAuthentication | 816 | .Cm PasswordAuthentication |
@@ -850,24 +818,24 @@ will be validated through the Kerberos KDC. | |||
850 | To use this option, the server needs a | 818 | To use this option, the server needs a |
851 | Kerberos servtab which allows the verification of the KDC's identity. | 819 | Kerberos servtab which allows the verification of the KDC's identity. |
852 | The default is | 820 | The default is |
853 | .Dq no . | 821 | .Cm no . |
854 | .It Cm KerberosGetAFSToken | 822 | .It Cm KerberosGetAFSToken |
855 | If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire | 823 | If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire |
856 | an AFS token before accessing the user's home directory. | 824 | an AFS token before accessing the user's home directory. |
857 | The default is | 825 | The default is |
858 | .Dq no . | 826 | .Cm no . |
859 | .It Cm KerberosOrLocalPasswd | 827 | .It Cm KerberosOrLocalPasswd |
860 | If password authentication through Kerberos fails then | 828 | If password authentication through Kerberos fails then |
861 | the password will be validated via any additional local mechanism | 829 | the password will be validated via any additional local mechanism |
862 | such as | 830 | such as |
863 | .Pa /etc/passwd . | 831 | .Pa /etc/passwd . |
864 | The default is | 832 | The default is |
865 | .Dq yes . | 833 | .Cm yes . |
866 | .It Cm KerberosTicketCleanup | 834 | .It Cm KerberosTicketCleanup |
867 | Specifies whether to automatically destroy the user's ticket cache | 835 | Specifies whether to automatically destroy the user's ticket cache |
868 | file on logout. | 836 | file on logout. |
869 | The default is | 837 | The default is |
870 | .Dq yes . | 838 | .Cm yes . |
871 | .It Cm KexAlgorithms | 839 | .It Cm KexAlgorithms |
872 | Specifies the available KEX (Key Exchange) algorithms. | 840 | Specifies the available KEX (Key Exchange) algorithms. |
873 | Multiple algorithms must be comma-separated. | 841 | Multiple algorithms must be comma-separated. |
@@ -879,6 +847,8 @@ The supported algorithms are: | |||
879 | .Pp | 847 | .Pp |
880 | .Bl -item -compact -offset indent | 848 | .Bl -item -compact -offset indent |
881 | .It | 849 | .It |
850 | curve25519-sha256 | ||
851 | .It | ||
882 | curve25519-sha256@libssh.org | 852 | curve25519-sha256@libssh.org |
883 | .It | 853 | .It |
884 | diffie-hellman-group1-sha1 | 854 | diffie-hellman-group1-sha1 |
@@ -898,27 +868,14 @@ ecdh-sha2-nistp521 | |||
898 | .Pp | 868 | .Pp |
899 | The default is: | 869 | The default is: |
900 | .Bd -literal -offset indent | 870 | .Bd -literal -offset indent |
901 | curve25519-sha256@libssh.org, | 871 | curve25519-sha256,curve25519-sha256@libssh.org, |
902 | ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521, | 872 | ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521, |
903 | diffie-hellman-group-exchange-sha256, | 873 | diffie-hellman-group-exchange-sha256, |
904 | diffie-hellman-group14-sha1 | 874 | diffie-hellman-group14-sha1 |
905 | .Ed | 875 | .Ed |
906 | .Pp | 876 | .Pp |
907 | The list of available key exchange algorithms may also be obtained using the | 877 | The list of available key exchange algorithms may also be obtained using |
908 | .Fl Q | 878 | .Qq ssh -Q kex . |
909 | option of | ||
910 | .Xr ssh 1 | ||
911 | with an argument of | ||
912 | .Dq kex . | ||
913 | .It Cm KeyRegenerationInterval | ||
914 | In protocol version 1, the ephemeral server key is automatically regenerated | ||
915 | after this many seconds (if it has been used). | ||
916 | The purpose of regeneration is to prevent | ||
917 | decrypting captured sessions by later breaking into the machine and | ||
918 | stealing the keys. | ||
919 | The key is never stored anywhere. | ||
920 | If the value is 0, the key is never regenerated. | ||
921 | The default is 3600 (seconds). | ||
922 | .It Cm ListenAddress | 879 | .It Cm ListenAddress |
923 | Specifies the local addresses | 880 | Specifies the local addresses |
924 | .Xr sshd 8 | 881 | .Xr sshd 8 |
@@ -978,7 +935,7 @@ character, then the specified algorithms will be appended to the default set | |||
978 | instead of replacing them. | 935 | instead of replacing them. |
979 | .Pp | 936 | .Pp |
980 | The algorithms that contain | 937 | The algorithms that contain |
981 | .Dq -etm | 938 | .Qq -etm |
982 | calculate the MAC after encryption (encrypt-then-mac). | 939 | calculate the MAC after encryption (encrypt-then-mac). |
983 | These are considered safer and their use recommended. | 940 | These are considered safer and their use recommended. |
984 | The supported MACs are: | 941 | The supported MACs are: |
@@ -1031,12 +988,8 @@ umac-64@openssh.com,umac-128@openssh.com, | |||
1031 | hmac-sha2-256,hmac-sha2-512,hmac-sha1 | 988 | hmac-sha2-256,hmac-sha2-512,hmac-sha1 |
1032 | .Ed | 989 | .Ed |
1033 | .Pp | 990 | .Pp |
1034 | The list of available MAC algorithms may also be obtained using the | 991 | The list of available MAC algorithms may also be obtained using |
1035 | .Fl Q | 992 | .Qq ssh -Q mac . |
1036 | option of | ||
1037 | .Xr ssh 1 | ||
1038 | with an argument of | ||
1039 | .Dq mac . | ||
1040 | .It Cm Match | 993 | .It Cm Match |
1041 | Introduces a conditional block. | 994 | Introduces a conditional block. |
1042 | If all of the criteria on the | 995 | If all of the criteria on the |
@@ -1065,24 +1018,19 @@ and | |||
1065 | .Cm Address . | 1018 | .Cm Address . |
1066 | The match patterns may consist of single entries or comma-separated | 1019 | The match patterns may consist of single entries or comma-separated |
1067 | lists and may use the wildcard and negation operators described in the | 1020 | lists and may use the wildcard and negation operators described in the |
1068 | PATTERNS section of | 1021 | .Sx PATTERNS |
1022 | section of | ||
1069 | .Xr ssh_config 5 . | 1023 | .Xr ssh_config 5 . |
1070 | .Pp | 1024 | .Pp |
1071 | The patterns in an | 1025 | The patterns in an |
1072 | .Cm Address | 1026 | .Cm Address |
1073 | criteria may additionally contain addresses to match in CIDR | 1027 | criteria may additionally contain addresses to match in CIDR |
1074 | address/masklen format, e.g.\& | 1028 | address/masklen format, |
1075 | .Dq 192.0.2.0/24 | 1029 | such as 192.0.2.0/24 or 2001:db8::/32. |
1076 | or | ||
1077 | .Dq 3ffe:ffff::/32 . | ||
1078 | Note that the mask length provided must be consistent with the address - | 1030 | Note that the mask length provided must be consistent with the address - |
1079 | it is an error to specify a mask length that is too long for the address | 1031 | it is an error to specify a mask length that is too long for the address |
1080 | or one with bits set in this host portion of the address. | 1032 | or one with bits set in this host portion of the address. |
1081 | For example, | 1033 | For example, 192.0.2.0/33 and 192.0.2.0/8, respectively. |
1082 | .Dq 192.0.2.0/33 | ||
1083 | and | ||
1084 | .Dq 192.0.2.0/8 | ||
1085 | respectively. | ||
1086 | .Pp | 1034 | .Pp |
1087 | Only a subset of keywords may be used on the lines following a | 1035 | Only a subset of keywords may be used on the lines following a |
1088 | .Cm Match | 1036 | .Cm Match |
@@ -1103,6 +1051,8 @@ Available keywords are | |||
1103 | .Cm AuthorizedPrincipalsFile , | 1051 | .Cm AuthorizedPrincipalsFile , |
1104 | .Cm Banner , | 1052 | .Cm Banner , |
1105 | .Cm ChrootDirectory , | 1053 | .Cm ChrootDirectory , |
1054 | .Cm ClientAliveCountMax , | ||
1055 | .Cm ClientAliveInterval , | ||
1106 | .Cm DenyGroups , | 1056 | .Cm DenyGroups , |
1107 | .Cm DenyUsers , | 1057 | .Cm DenyUsers , |
1108 | .Cm ForceCommand , | 1058 | .Cm ForceCommand , |
@@ -1127,8 +1077,6 @@ Available keywords are | |||
1127 | .Cm PubkeyAuthentication , | 1077 | .Cm PubkeyAuthentication , |
1128 | .Cm RekeyLimit , | 1078 | .Cm RekeyLimit , |
1129 | .Cm RevokedKeys , | 1079 | .Cm RevokedKeys , |
1130 | .Cm RhostsRSAAuthentication , | ||
1131 | .Cm RSAAuthentication , | ||
1132 | .Cm StreamLocalBindMask , | 1080 | .Cm StreamLocalBindMask , |
1133 | .Cm StreamLocalBindUnlink , | 1081 | .Cm StreamLocalBindUnlink , |
1134 | .Cm TrustedUserCAKeys , | 1082 | .Cm TrustedUserCAKeys , |
@@ -1163,29 +1111,21 @@ The default is 10:30:100. | |||
1163 | .Pp | 1111 | .Pp |
1164 | Alternatively, random early drop can be enabled by specifying | 1112 | Alternatively, random early drop can be enabled by specifying |
1165 | the three colon separated values | 1113 | the three colon separated values |
1166 | .Dq start:rate:full | 1114 | start:rate:full (e.g. "10:30:60"). |
1167 | (e.g. "10:30:60"). | ||
1168 | .Xr sshd 8 | 1115 | .Xr sshd 8 |
1169 | will refuse connection attempts with a probability of | 1116 | will refuse connection attempts with a probability of rate/100 (30%) |
1170 | .Dq rate/100 | 1117 | if there are currently start (10) unauthenticated connections. |
1171 | (30%) | ||
1172 | if there are currently | ||
1173 | .Dq start | ||
1174 | (10) | ||
1175 | unauthenticated connections. | ||
1176 | The probability increases linearly and all connection attempts | 1118 | The probability increases linearly and all connection attempts |
1177 | are refused if the number of unauthenticated connections reaches | 1119 | are refused if the number of unauthenticated connections reaches full (60). |
1178 | .Dq full | ||
1179 | (60). | ||
1180 | .It Cm PasswordAuthentication | 1120 | .It Cm PasswordAuthentication |
1181 | Specifies whether password authentication is allowed. | 1121 | Specifies whether password authentication is allowed. |
1182 | The default is | 1122 | The default is |
1183 | .Dq yes . | 1123 | .Cm yes . |
1184 | .It Cm PermitEmptyPasswords | 1124 | .It Cm PermitEmptyPasswords |
1185 | When password authentication is allowed, it specifies whether the | 1125 | When password authentication is allowed, it specifies whether the |
1186 | server allows login to accounts with empty password strings. | 1126 | server allows login to accounts with empty password strings. |
1187 | The default is | 1127 | The default is |
1188 | .Dq no . | 1128 | .Cm no . |
1189 | .It Cm PermitOpen | 1129 | .It Cm PermitOpen |
1190 | Specifies the destinations to which TCP port forwarding is permitted. | 1130 | Specifies the destinations to which TCP port forwarding is permitted. |
1191 | The forwarding specification must be one of the following forms: | 1131 | The forwarding specification must be one of the following forms: |
@@ -1210,36 +1150,36 @@ The forwarding specification must be one of the following forms: | |||
1210 | .Pp | 1150 | .Pp |
1211 | Multiple forwards may be specified by separating them with whitespace. | 1151 | Multiple forwards may be specified by separating them with whitespace. |
1212 | An argument of | 1152 | An argument of |
1213 | .Dq any | 1153 | .Cm any |
1214 | can be used to remove all restrictions and permit any forwarding requests. | 1154 | can be used to remove all restrictions and permit any forwarding requests. |
1215 | An argument of | 1155 | An argument of |
1216 | .Dq none | 1156 | .Cm none |
1217 | can be used to prohibit all forwarding requests. | 1157 | can be used to prohibit all forwarding requests. |
1218 | The wildcard | 1158 | The wildcard |
1219 | .Dq * | 1159 | .Sq * |
1220 | can be used for host or port to allow all hosts or ports, respectively. | 1160 | can be used for host or port to allow all hosts or ports, respectively. |
1221 | By default all port forwarding requests are permitted. | 1161 | By default all port forwarding requests are permitted. |
1222 | .It Cm PermitRootLogin | 1162 | .It Cm PermitRootLogin |
1223 | Specifies whether root can log in using | 1163 | Specifies whether root can log in using |
1224 | .Xr ssh 1 . | 1164 | .Xr ssh 1 . |
1225 | The argument must be | 1165 | The argument must be |
1226 | .Dq yes , | 1166 | .Cm yes , |
1227 | .Dq prohibit-password , | 1167 | .Cm prohibit-password , |
1228 | .Dq without-password , | 1168 | .Cm without-password , |
1229 | .Dq forced-commands-only , | 1169 | .Cm forced-commands-only , |
1230 | or | 1170 | or |
1231 | .Dq no . | 1171 | .Cm no . |
1232 | The default is | 1172 | The default is |
1233 | .Dq prohibit-password . | 1173 | .Cm prohibit-password . |
1234 | .Pp | 1174 | .Pp |
1235 | If this option is set to | 1175 | If this option is set to |
1236 | .Dq prohibit-password | 1176 | .Cm prohibit-password |
1237 | or | 1177 | or |
1238 | .Dq without-password , | 1178 | .Cm without-password , |
1239 | password and keyboard-interactive authentication are disabled for root. | 1179 | password and keyboard-interactive authentication are disabled for root. |
1240 | .Pp | 1180 | .Pp |
1241 | If this option is set to | 1181 | If this option is set to |
1242 | .Dq forced-commands-only , | 1182 | .Cm forced-commands-only , |
1243 | root login with public key authentication will be allowed, | 1183 | root login with public key authentication will be allowed, |
1244 | but only if the | 1184 | but only if the |
1245 | .Ar command | 1185 | .Ar command |
@@ -1249,37 +1189,37 @@ normally not allowed). | |||
1249 | All other authentication methods are disabled for root. | 1189 | All other authentication methods are disabled for root. |
1250 | .Pp | 1190 | .Pp |
1251 | If this option is set to | 1191 | If this option is set to |
1252 | .Dq no , | 1192 | .Cm no , |
1253 | root is not allowed to log in. | 1193 | root is not allowed to log in. |
1194 | .It Cm PermitTTY | ||
1195 | Specifies whether | ||
1196 | .Xr pty 4 | ||
1197 | allocation is permitted. | ||
1198 | The default is | ||
1199 | .Cm yes . | ||
1254 | .It Cm PermitTunnel | 1200 | .It Cm PermitTunnel |
1255 | Specifies whether | 1201 | Specifies whether |
1256 | .Xr tun 4 | 1202 | .Xr tun 4 |
1257 | device forwarding is allowed. | 1203 | device forwarding is allowed. |
1258 | The argument must be | 1204 | The argument must be |
1259 | .Dq yes , | 1205 | .Cm yes , |
1260 | .Dq point-to-point | 1206 | .Cm point-to-point |
1261 | (layer 3), | 1207 | (layer 3), |
1262 | .Dq ethernet | 1208 | .Cm ethernet |
1263 | (layer 2), or | 1209 | (layer 2), or |
1264 | .Dq no . | 1210 | .Cm no . |
1265 | Specifying | 1211 | Specifying |
1266 | .Dq yes | 1212 | .Cm yes |
1267 | permits both | 1213 | permits both |
1268 | .Dq point-to-point | 1214 | .Cm point-to-point |
1269 | and | 1215 | and |
1270 | .Dq ethernet . | 1216 | .Cm ethernet . |
1271 | The default is | 1217 | The default is |
1272 | .Dq no . | 1218 | .Cm no . |
1273 | .Pp | 1219 | .Pp |
1274 | Independent of this setting, the permissions of the selected | 1220 | Independent of this setting, the permissions of the selected |
1275 | .Xr tun 4 | 1221 | .Xr tun 4 |
1276 | device must allow access to the user. | 1222 | device must allow access to the user. |
1277 | .It Cm PermitTTY | ||
1278 | Specifies whether | ||
1279 | .Xr pty 4 | ||
1280 | allocation is permitted. | ||
1281 | The default is | ||
1282 | .Dq yes . | ||
1283 | .It Cm PermitUserEnvironment | 1223 | .It Cm PermitUserEnvironment |
1284 | Specifies whether | 1224 | Specifies whether |
1285 | .Pa ~/.ssh/environment | 1225 | .Pa ~/.ssh/environment |
@@ -1290,7 +1230,7 @@ options in | |||
1290 | are processed by | 1230 | are processed by |
1291 | .Xr sshd 8 . | 1231 | .Xr sshd 8 . |
1292 | The default is | 1232 | The default is |
1293 | .Dq no . | 1233 | .Cm no . |
1294 | Enabling environment processing may enable users to bypass access | 1234 | Enabling environment processing may enable users to bypass access |
1295 | restrictions in some configurations using mechanisms such as | 1235 | restrictions in some configurations using mechanisms such as |
1296 | .Ev LD_PRELOAD . | 1236 | .Ev LD_PRELOAD . |
@@ -1299,11 +1239,11 @@ Specifies whether any | |||
1299 | .Pa ~/.ssh/rc | 1239 | .Pa ~/.ssh/rc |
1300 | file is executed. | 1240 | file is executed. |
1301 | The default is | 1241 | The default is |
1302 | .Dq yes . | 1242 | .Cm yes . |
1303 | .It Cm PidFile | 1243 | .It Cm PidFile |
1304 | Specifies the file that contains the process ID of the | 1244 | Specifies the file that contains the process ID of the |
1305 | SSH daemon, or | 1245 | SSH daemon, or |
1306 | .Dq none | 1246 | .Cm none |
1307 | to not write one. | 1247 | to not write one. |
1308 | The default is | 1248 | The default is |
1309 | .Pa /var/run/sshd.pid . | 1249 | .Pa /var/run/sshd.pid . |
@@ -1321,7 +1261,7 @@ Specifies whether | |||
1321 | should print the date and time of the last user login when a user logs | 1261 | should print the date and time of the last user login when a user logs |
1322 | in interactively. | 1262 | in interactively. |
1323 | The default is | 1263 | The default is |
1324 | .Dq yes . | 1264 | .Cm yes . |
1325 | .It Cm PrintMotd | 1265 | .It Cm PrintMotd |
1326 | Specifies whether | 1266 | Specifies whether |
1327 | .Xr sshd 8 | 1267 | .Xr sshd 8 |
@@ -1332,29 +1272,7 @@ when a user logs in interactively. | |||
1332 | .Pa /etc/profile , | 1272 | .Pa /etc/profile , |
1333 | or equivalent.) | 1273 | or equivalent.) |
1334 | The default is | 1274 | The default is |
1335 | .Dq yes . | 1275 | .Cm yes . |
1336 | .It Cm Protocol | ||
1337 | Specifies the protocol versions | ||
1338 | .Xr sshd 8 | ||
1339 | supports. | ||
1340 | The possible values are | ||
1341 | .Sq 1 | ||
1342 | and | ||
1343 | .Sq 2 . | ||
1344 | Multiple versions must be comma-separated. | ||
1345 | The default is | ||
1346 | .Sq 2 . | ||
1347 | Protocol 1 suffers from a number of cryptographic weaknesses and should | ||
1348 | not be used. | ||
1349 | It is only offered to support legacy devices. | ||
1350 | .Pp | ||
1351 | Note that the order of the protocol list does not indicate preference, | ||
1352 | because the client selects among multiple protocol versions offered | ||
1353 | by the server. | ||
1354 | Specifying | ||
1355 | .Dq 2,1 | ||
1356 | is identical to | ||
1357 | .Dq 1,2 . | ||
1358 | .It Cm PubkeyAcceptedKeyTypes | 1276 | .It Cm PubkeyAcceptedKeyTypes |
1359 | Specifies the key types that will be accepted for public key authentication | 1277 | Specifies the key types that will be accepted for public key authentication |
1360 | as a comma-separated pattern list. | 1278 | as a comma-separated pattern list. |
@@ -1373,15 +1291,12 @@ ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, | |||
1373 | ssh-ed25519,ssh-rsa | 1291 | ssh-ed25519,ssh-rsa |
1374 | .Ed | 1292 | .Ed |
1375 | .Pp | 1293 | .Pp |
1376 | The | 1294 | The list of available key types may also be obtained using |
1377 | .Fl Q | 1295 | .Qq ssh -Q key . |
1378 | option of | ||
1379 | .Xr ssh 1 | ||
1380 | may be used to list supported key types. | ||
1381 | .It Cm PubkeyAuthentication | 1296 | .It Cm PubkeyAuthentication |
1382 | Specifies whether public key authentication is allowed. | 1297 | Specifies whether public key authentication is allowed. |
1383 | The default is | 1298 | The default is |
1384 | .Dq yes . | 1299 | .Cm yes . |
1385 | .It Cm RekeyLimit | 1300 | .It Cm RekeyLimit |
1386 | Specifies the maximum amount of data that may be transmitted before the | 1301 | Specifies the maximum amount of data that may be transmitted before the |
1387 | session key is renegotiated, optionally followed a maximum amount of | 1302 | session key is renegotiated, optionally followed a maximum amount of |
@@ -1404,12 +1319,12 @@ section. | |||
1404 | The default value for | 1319 | The default value for |
1405 | .Cm RekeyLimit | 1320 | .Cm RekeyLimit |
1406 | is | 1321 | is |
1407 | .Dq default none , | 1322 | .Cm default none , |
1408 | which means that rekeying is performed after the cipher's default amount | 1323 | which means that rekeying is performed after the cipher's default amount |
1409 | of data has been sent or received and no time based rekeying is done. | 1324 | of data has been sent or received and no time based rekeying is done. |
1410 | .It Cm RevokedKeys | 1325 | .It Cm RevokedKeys |
1411 | Specifies revoked public keys file, or | 1326 | Specifies revoked public keys file, or |
1412 | .Dq none | 1327 | .Cm none |
1413 | to not use one. | 1328 | to not use one. |
1414 | Keys listed in this file will be refused for public key authentication. | 1329 | Keys listed in this file will be refused for public key authentication. |
1415 | Note that if this file is not readable, then public key authentication will | 1330 | Note that if this file is not readable, then public key authentication will |
@@ -1419,20 +1334,6 @@ an OpenSSH Key Revocation List (KRL) as generated by | |||
1419 | .Xr ssh-keygen 1 . | 1334 | .Xr ssh-keygen 1 . |
1420 | For more information on KRLs, see the KEY REVOCATION LISTS section in | 1335 | For more information on KRLs, see the KEY REVOCATION LISTS section in |
1421 | .Xr ssh-keygen 1 . | 1336 | .Xr ssh-keygen 1 . |
1422 | .It Cm RhostsRSAAuthentication | ||
1423 | Specifies whether rhosts or /etc/hosts.equiv authentication together | ||
1424 | with successful RSA host authentication is allowed. | ||
1425 | The default is | ||
1426 | .Dq no . | ||
1427 | This option applies to protocol version 1 only. | ||
1428 | .It Cm RSAAuthentication | ||
1429 | Specifies whether pure RSA authentication is allowed. | ||
1430 | The default is | ||
1431 | .Dq yes . | ||
1432 | This option applies to protocol version 1 only. | ||
1433 | .It Cm ServerKeyBits | ||
1434 | Defines the number of bits in the ephemeral protocol version 1 server key. | ||
1435 | The default and minimum value is 1024. | ||
1436 | .It Cm StreamLocalBindMask | 1337 | .It Cm StreamLocalBindMask |
1437 | Sets the octal file creation mode mask | 1338 | Sets the octal file creation mode mask |
1438 | .Pq umask | 1339 | .Pq umask |
@@ -1455,11 +1356,11 @@ will be unable to forward the port to the Unix-domain socket file. | |||
1455 | This option is only used for port forwarding to a Unix-domain socket file. | 1356 | This option is only used for port forwarding to a Unix-domain socket file. |
1456 | .Pp | 1357 | .Pp |
1457 | The argument must be | 1358 | The argument must be |
1458 | .Dq yes | 1359 | .Cm yes |
1459 | or | 1360 | or |
1460 | .Dq no . | 1361 | .Cm no . |
1461 | The default is | 1362 | The default is |
1462 | .Dq no . | 1363 | .Cm no . |
1463 | .It Cm StrictModes | 1364 | .It Cm StrictModes |
1464 | Specifies whether | 1365 | Specifies whether |
1465 | .Xr sshd 8 | 1366 | .Xr sshd 8 |
@@ -1468,7 +1369,7 @@ user's files and home directory before accepting login. | |||
1468 | This is normally desirable because novices sometimes accidentally leave their | 1369 | This is normally desirable because novices sometimes accidentally leave their |
1469 | directory or files world-writable. | 1370 | directory or files world-writable. |
1470 | The default is | 1371 | The default is |
1471 | .Dq yes . | 1372 | .Cm yes . |
1472 | Note that this does not apply to | 1373 | Note that this does not apply to |
1473 | .Cm ChrootDirectory , | 1374 | .Cm ChrootDirectory , |
1474 | whose permissions and ownership are checked unconditionally. | 1375 | whose permissions and ownership are checked unconditionally. |
@@ -1478,16 +1379,12 @@ Arguments should be a subsystem name and a command (with optional arguments) | |||
1478 | to execute upon subsystem request. | 1379 | to execute upon subsystem request. |
1479 | .Pp | 1380 | .Pp |
1480 | The command | 1381 | The command |
1481 | .Xr sftp-server 8 | 1382 | .Cm sftp-server |
1482 | implements the | 1383 | implements the SFTP file transfer subsystem. |
1483 | .Dq sftp | ||
1484 | file transfer subsystem. | ||
1485 | .Pp | 1384 | .Pp |
1486 | Alternately the name | 1385 | Alternately the name |
1487 | .Dq internal-sftp | 1386 | .Cm internal-sftp |
1488 | implements an in-process | 1387 | implements an in-process SFTP server. |
1489 | .Dq sftp | ||
1490 | server. | ||
1491 | This may simplify configurations using | 1388 | This may simplify configurations using |
1492 | .Cm ChrootDirectory | 1389 | .Cm ChrootDirectory |
1493 | to force a different filesystem root on clients. | 1390 | to force a different filesystem root on clients. |
@@ -1509,21 +1406,21 @@ connections will die if the route is down temporarily, and some people | |||
1509 | find it annoying. | 1406 | find it annoying. |
1510 | On the other hand, if TCP keepalives are not sent, | 1407 | On the other hand, if TCP keepalives are not sent, |
1511 | sessions may hang indefinitely on the server, leaving | 1408 | sessions may hang indefinitely on the server, leaving |
1512 | .Dq ghost | 1409 | .Qq ghost |
1513 | users and consuming server resources. | 1410 | users and consuming server resources. |
1514 | .Pp | 1411 | .Pp |
1515 | The default is | 1412 | The default is |
1516 | .Dq yes | 1413 | .Cm yes |
1517 | (to send TCP keepalive messages), and the server will notice | 1414 | (to send TCP keepalive messages), and the server will notice |
1518 | if the network goes down or the client host crashes. | 1415 | if the network goes down or the client host crashes. |
1519 | This avoids infinitely hanging sessions. | 1416 | This avoids infinitely hanging sessions. |
1520 | .Pp | 1417 | .Pp |
1521 | To disable TCP keepalive messages, the value should be set to | 1418 | To disable TCP keepalive messages, the value should be set to |
1522 | .Dq no . | 1419 | .Cm no . |
1523 | .It Cm TrustedUserCAKeys | 1420 | .It Cm TrustedUserCAKeys |
1524 | Specifies a file containing public keys of certificate authorities that are | 1421 | Specifies a file containing public keys of certificate authorities that are |
1525 | trusted to sign user certificates for authentication, or | 1422 | trusted to sign user certificates for authentication, or |
1526 | .Dq none | 1423 | .Cm none |
1527 | to not use one. | 1424 | to not use one. |
1528 | Keys are listed one per line; empty lines and comments starting with | 1425 | Keys are listed one per line; empty lines and comments starting with |
1529 | .Ql # | 1426 | .Ql # |
@@ -1544,7 +1441,7 @@ the resolved host name for the remote IP address maps back to the | |||
1544 | very same IP address. | 1441 | very same IP address. |
1545 | .Pp | 1442 | .Pp |
1546 | If this option is set to | 1443 | If this option is set to |
1547 | .Dq no | 1444 | .Cm no |
1548 | (the default) then only addresses and not host names may be used in | 1445 | (the default) then only addresses and not host names may be used in |
1549 | .Pa ~/.ssh/authorized_keys | 1446 | .Pa ~/.ssh/authorized_keys |
1550 | .Cm from | 1447 | .Cm from |
@@ -1553,29 +1450,10 @@ and | |||
1553 | .Cm Match | 1450 | .Cm Match |
1554 | .Cm Host | 1451 | .Cm Host |
1555 | directives. | 1452 | directives. |
1556 | .It Cm UseLogin | ||
1557 | Specifies whether | ||
1558 | .Xr login 1 | ||
1559 | is used for interactive login sessions. | ||
1560 | The default is | ||
1561 | .Dq no . | ||
1562 | Note that | ||
1563 | .Xr login 1 | ||
1564 | is never used for remote command execution. | ||
1565 | Note also, that if this is enabled, | ||
1566 | .Cm X11Forwarding | ||
1567 | will be disabled because | ||
1568 | .Xr login 1 | ||
1569 | does not know how to handle | ||
1570 | .Xr xauth 1 | ||
1571 | cookies. | ||
1572 | If | ||
1573 | .Cm UsePrivilegeSeparation | ||
1574 | is specified, it will be disabled after authentication. | ||
1575 | .It Cm UsePAM | 1453 | .It Cm UsePAM |
1576 | Enables the Pluggable Authentication Module interface. | 1454 | Enables the Pluggable Authentication Module interface. |
1577 | If set to | 1455 | If set to |
1578 | .Dq yes | 1456 | .Cm yes |
1579 | this will enable PAM authentication using | 1457 | this will enable PAM authentication using |
1580 | .Cm ChallengeResponseAuthentication | 1458 | .Cm ChallengeResponseAuthentication |
1581 | and | 1459 | and |
@@ -1595,7 +1473,7 @@ is enabled, you will not be able to run | |||
1595 | .Xr sshd 8 | 1473 | .Xr sshd 8 |
1596 | as a non-root user. | 1474 | as a non-root user. |
1597 | The default is | 1475 | The default is |
1598 | .Dq no . | 1476 | .Cm no . |
1599 | .It Cm UsePrivilegeSeparation | 1477 | .It Cm UsePrivilegeSeparation |
1600 | Specifies whether | 1478 | Specifies whether |
1601 | .Xr sshd 8 | 1479 | .Xr sshd 8 |
@@ -1606,23 +1484,23 @@ the privilege of the authenticated user. | |||
1606 | The goal of privilege separation is to prevent privilege | 1484 | The goal of privilege separation is to prevent privilege |
1607 | escalation by containing any corruption within the unprivileged processes. | 1485 | escalation by containing any corruption within the unprivileged processes. |
1608 | The argument must be | 1486 | The argument must be |
1609 | .Dq yes , | 1487 | .Cm yes , |
1610 | .Dq no , | 1488 | .Cm no , |
1611 | or | 1489 | or |
1612 | .Dq sandbox . | 1490 | .Cm sandbox . |
1613 | If | 1491 | If |
1614 | .Cm UsePrivilegeSeparation | 1492 | .Cm UsePrivilegeSeparation |
1615 | is set to | 1493 | is set to |
1616 | .Dq sandbox | 1494 | .Cm sandbox |
1617 | then the pre-authentication unprivileged process is subject to additional | 1495 | then the pre-authentication unprivileged process is subject to additional |
1618 | restrictions. | 1496 | restrictions. |
1619 | The default is | 1497 | The default is |
1620 | .Dq sandbox . | 1498 | .Cm sandbox . |
1621 | .It Cm VersionAddendum | 1499 | .It Cm VersionAddendum |
1622 | Optionally specifies additional text to append to the SSH protocol banner | 1500 | Optionally specifies additional text to append to the SSH protocol banner |
1623 | sent by the server upon connection. | 1501 | sent by the server upon connection. |
1624 | The default is | 1502 | The default is |
1625 | .Dq none . | 1503 | .Cm none . |
1626 | .It Cm X11DisplayOffset | 1504 | .It Cm X11DisplayOffset |
1627 | Specifies the first display number available for | 1505 | Specifies the first display number available for |
1628 | .Xr sshd 8 Ns 's | 1506 | .Xr sshd 8 Ns 's |
@@ -1632,18 +1510,18 @@ The default is 10. | |||
1632 | .It Cm X11Forwarding | 1510 | .It Cm X11Forwarding |
1633 | Specifies whether X11 forwarding is permitted. | 1511 | Specifies whether X11 forwarding is permitted. |
1634 | The argument must be | 1512 | The argument must be |
1635 | .Dq yes | 1513 | .Cm yes |
1636 | or | 1514 | or |
1637 | .Dq no . | 1515 | .Cm no . |
1638 | The default is | 1516 | The default is |
1639 | .Dq no . | 1517 | .Cm no . |
1640 | .Pp | 1518 | .Pp |
1641 | When X11 forwarding is enabled, there may be additional exposure to | 1519 | When X11 forwarding is enabled, there may be additional exposure to |
1642 | the server and to client displays if the | 1520 | the server and to client displays if the |
1643 | .Xr sshd 8 | 1521 | .Xr sshd 8 |
1644 | proxy display is configured to listen on the wildcard address (see | 1522 | proxy display is configured to listen on the wildcard address (see |
1645 | .Cm X11UseLocalhost | 1523 | .Cm X11UseLocalhost ) , |
1646 | below), though this is not the default. | 1524 | though this is not the default. |
1647 | Additionally, the authentication spoofing and authentication data | 1525 | Additionally, the authentication spoofing and authentication data |
1648 | verification and substitution occur on the client side. | 1526 | verification and substitution occur on the client side. |
1649 | The security risk of using X11 forwarding is that the client's X11 | 1527 | The security risk of using X11 forwarding is that the client's X11 |
@@ -1655,14 +1533,11 @@ in | |||
1655 | A system administrator may have a stance in which they want to | 1533 | A system administrator may have a stance in which they want to |
1656 | protect clients that may expose themselves to attack by unwittingly | 1534 | protect clients that may expose themselves to attack by unwittingly |
1657 | requesting X11 forwarding, which can warrant a | 1535 | requesting X11 forwarding, which can warrant a |
1658 | .Dq no | 1536 | .Cm no |
1659 | setting. | 1537 | setting. |
1660 | .Pp | 1538 | .Pp |
1661 | Note that disabling X11 forwarding does not prevent users from | 1539 | Note that disabling X11 forwarding does not prevent users from |
1662 | forwarding X11 traffic, as users can always install their own forwarders. | 1540 | forwarding X11 traffic, as users can always install their own forwarders. |
1663 | X11 forwarding is automatically disabled if | ||
1664 | .Cm UseLogin | ||
1665 | is enabled. | ||
1666 | .It Cm X11UseLocalhost | 1541 | .It Cm X11UseLocalhost |
1667 | Specifies whether | 1542 | Specifies whether |
1668 | .Xr sshd 8 | 1543 | .Xr sshd 8 |
@@ -1673,26 +1548,26 @@ sshd binds the forwarding server to the loopback address and sets the | |||
1673 | hostname part of the | 1548 | hostname part of the |
1674 | .Ev DISPLAY | 1549 | .Ev DISPLAY |
1675 | environment variable to | 1550 | environment variable to |
1676 | .Dq localhost . | 1551 | .Cm localhost . |
1677 | This prevents remote hosts from connecting to the proxy display. | 1552 | This prevents remote hosts from connecting to the proxy display. |
1678 | However, some older X11 clients may not function with this | 1553 | However, some older X11 clients may not function with this |
1679 | configuration. | 1554 | configuration. |
1680 | .Cm X11UseLocalhost | 1555 | .Cm X11UseLocalhost |
1681 | may be set to | 1556 | may be set to |
1682 | .Dq no | 1557 | .Cm no |
1683 | to specify that the forwarding server should be bound to the wildcard | 1558 | to specify that the forwarding server should be bound to the wildcard |
1684 | address. | 1559 | address. |
1685 | The argument must be | 1560 | The argument must be |
1686 | .Dq yes | 1561 | .Cm yes |
1687 | or | 1562 | or |
1688 | .Dq no . | 1563 | .Cm no . |
1689 | The default is | 1564 | The default is |
1690 | .Dq yes . | 1565 | .Cm yes . |
1691 | .It Cm XAuthLocation | 1566 | .It Cm XAuthLocation |
1692 | Specifies the full pathname of the | 1567 | Specifies the full pathname of the |
1693 | .Xr xauth 1 | 1568 | .Xr xauth 1 |
1694 | program, or | 1569 | program, or |
1695 | .Dq none | 1570 | .Cm none |
1696 | to not use one. | 1571 | to not use one. |
1697 | The default is | 1572 | The default is |
1698 | .Pa /usr/X11R6/bin/xauth . | 1573 | .Pa /usr/X11R6/bin/xauth . |
@@ -1738,6 +1613,50 @@ Time format examples: | |||
1738 | .It 1h30m | 1613 | .It 1h30m |
1739 | 1 hour 30 minutes (90 minutes) | 1614 | 1 hour 30 minutes (90 minutes) |
1740 | .El | 1615 | .El |
1616 | .Sh TOKENS | ||
1617 | Arguments to some keywords can make use of tokens, | ||
1618 | which are expanded at runtime: | ||
1619 | .Pp | ||
1620 | .Bl -tag -width XXXX -offset indent -compact | ||
1621 | .It %% | ||
1622 | A literal | ||
1623 | .Sq % . | ||
1624 | .It %F | ||
1625 | The fingerprint of the CA key. | ||
1626 | .It %f | ||
1627 | The fingerprint of the key or certificate. | ||
1628 | .It %h | ||
1629 | The home directory of the user. | ||
1630 | .It %i | ||
1631 | The key ID in the certificate. | ||
1632 | .It %K | ||
1633 | The base64-encoded CA key. | ||
1634 | .It %k | ||
1635 | The base64-encoded key or certificate for authentication. | ||
1636 | .It %s | ||
1637 | The serial number of the certificate. | ||
1638 | .It \&%T | ||
1639 | The type of the CA key. | ||
1640 | .It %t | ||
1641 | The key or certificate type. | ||
1642 | .It %u | ||
1643 | The username. | ||
1644 | .El | ||
1645 | .Pp | ||
1646 | .Cm AuthorizedKeysCommand | ||
1647 | accepts the tokens %%, %f, %h, %t, and %u. | ||
1648 | .Pp | ||
1649 | .Cm AuthorizedKeysFile | ||
1650 | accepts the tokens %%, %h, and %u. | ||
1651 | .Pp | ||
1652 | .Cm AuthorizedPrincipalsCommand | ||
1653 | accepts the tokens %%, %F, %f, %K, %k, %h, %i, %s, %T, %t, and %u. | ||
1654 | .Pp | ||
1655 | .Cm AuthorizedPrincipalsFile | ||
1656 | accepts the tokens %%, %h, and %u. | ||
1657 | .Pp | ||
1658 | .Cm ChrootDirectory | ||
1659 | accepts the tokens %%, %h, and %u. | ||
1741 | .Sh FILES | 1660 | .Sh FILES |
1742 | .Bl -tag -width Ds | 1661 | .Bl -tag -width Ds |
1743 | .It Pa /etc/ssh/sshd_config | 1662 | .It Pa /etc/ssh/sshd_config |
@@ -1747,15 +1666,22 @@ This file should be writable by root only, but it is recommended | |||
1747 | (though not necessary) that it be world-readable. | 1666 | (though not necessary) that it be world-readable. |
1748 | .El | 1667 | .El |
1749 | .Sh SEE ALSO | 1668 | .Sh SEE ALSO |
1669 | .Xr sftp-server 8 , | ||
1750 | .Xr sshd 8 | 1670 | .Xr sshd 8 |
1751 | .Sh AUTHORS | 1671 | .Sh AUTHORS |
1672 | .An -nosplit | ||
1752 | OpenSSH is a derivative of the original and free | 1673 | OpenSSH is a derivative of the original and free |
1753 | ssh 1.2.12 release by Tatu Ylonen. | 1674 | ssh 1.2.12 release by |
1754 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, | 1675 | .An Tatu Ylonen . |
1755 | Theo de Raadt and Dug Song | 1676 | .An Aaron Campbell , Bob Beck , Markus Friedl , Niels Provos , |
1677 | .An Theo de Raadt | ||
1678 | and | ||
1679 | .An Dug Song | ||
1756 | removed many bugs, re-added newer features and | 1680 | removed many bugs, re-added newer features and |
1757 | created OpenSSH. | 1681 | created OpenSSH. |
1758 | Markus Friedl contributed the support for SSH | 1682 | .An Markus Friedl |
1759 | protocol versions 1.5 and 2.0. | 1683 | contributed the support for SSH protocol versions 1.5 and 2.0. |
1760 | Niels Provos and Markus Friedl contributed support | 1684 | .An Niels Provos |
1761 | for privilege separation. | 1685 | and |
1686 | .An Markus Friedl | ||
1687 | contributed support for privilege separation. | ||