crypto/openssh/sshd_config.5

   1 .\"
   2 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   3 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4 .\"                    All rights reserved
   5 .\"
   6 .\" As far as I am concerned, the code I have written for this software
   7 .\" can be used freely for any purpose.  Any derived versions of this
   8 .\" software must be clearly marked as such, and if the derived work is
   9 .\" incompatible with the protocol description in the RFC file, it must be
  10 .\" called by a name other than "ssh" or "Secure Shell".
  11 .\"
  12 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
  13 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
  14 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
  15 .\"
  16 .\" Redistribution and use in source and binary forms, with or without
  17 .\" modification, are permitted provided that the following conditions
  18 .\" are met:
  19 .\" 1. Redistributions of source code must retain the above copyright
  20 .\"    notice, this list of conditions and the following disclaimer.
  21 .\" 2. Redistributions in binary form must reproduce the above copyright
  22 .\"    notice, this list of conditions and the following disclaimer in the
  23 .\"    documentation and/or other materials provided with the distribution.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  26 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  28 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  29 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  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.
  35 .\"
  36 .\" $OpenBSD: sshd_config.5,v 1.176 2014/07/28 15:40:08 schwarze Exp $
  37 .Dd $Mdocdate: July 28 2014 $
  38 .Dt SSHD_CONFIG 5
  39 .Os
  40 .Sh NAME
  41 .Nm sshd_config
  42 .Nd OpenSSH SSH daemon configuration file
  43 .Sh SYNOPSIS
  44 .Nm /etc/ssh/sshd_config
  45 .Sh DESCRIPTION
  46 .Xr sshd 8
  47 reads configuration data from
  48 .Pa /etc/ssh/sshd_config
  49 (or the file specified with
  50 .Fl f
  51 on the command line).
  52 The file contains keyword-argument pairs, one per line.
  53 Lines starting with
  54 .Ql #
  55 and empty lines are interpreted as comments.
  56 Arguments may optionally be enclosed in double quotes
  57 .Pq \&"
  58 in order to represent arguments containing spaces.
  59 .Pp
  60 The possible
  61 keywords and their meanings are as follows (note that
  62 keywords are case-insensitive and arguments are case-sensitive):
  63 .Bl -tag -width Ds
  64 .It Cm AcceptEnv
  65 Specifies what environment variables sent by the client will be copied into
  66 the session's
  67 .Xr environ 7 .
  68 See
  69 .Cm SendEnv
  70 in
  71 .Xr ssh_config 5
  72 for how to configure the client.
  73 Note that environment passing is only supported for protocol 2.
  74 Variables are specified by name, which may contain the wildcard characters
  75 .Ql *
  76 and
  77 .Ql \&? .
  78 Multiple environment variables may be separated by whitespace or spread
  79 across multiple
  80 .Cm AcceptEnv
  81 directives.
  82 Be warned that some environment variables could be used to bypass restricted
  83 user environments.
  84 For this reason, care should be taken in the use of this directive.
  85 The default is not to accept any environment variables.
  86 .It Cm AddressFamily
  87 Specifies which address family should be used by
  88 .Xr sshd 8 .
  89 Valid arguments are
  90 .Dq any ,
  91 .Dq inet
  92 (use IPv4 only), or
  93 .Dq inet6
  94 (use IPv6 only).
  95 The default is
  96 .Dq any .
  97 .It Cm AllowAgentForwarding
  98 Specifies whether
  99 .Xr ssh-agent 1
 100 forwarding is permitted.
 101 The default is
 102 .Dq yes .
 103 Note that disabling agent forwarding does not improve security
 104 unless users are also denied shell access, as they can always install
 105 their own forwarders.
 106 .It Cm AllowGroups
 107 This keyword can be followed by a list of group name patterns, separated
 108 by spaces.
 109 If specified, login is allowed only for users whose primary
 110 group or supplementary group list matches one of the patterns.
 111 Only group names are valid; a numerical group ID is not recognized.
 112 By default, login is allowed for all groups.
 113 The allow/deny directives are processed in the following order:
 114 .Cm DenyUsers ,
 115 .Cm AllowUsers ,
 116 .Cm DenyGroups ,
 117 and finally
 118 .Cm AllowGroups .
 119 .Pp
 120 See PATTERNS in
 121 .Xr ssh_config 5
 122 for more information on patterns.
 123 .It Cm AllowTcpForwarding
 124 Specifies whether TCP forwarding is permitted.
 125 The available options are
 126 .Dq yes
 127 or
 128 .Dq all
 129 to allow TCP forwarding,
 130 .Dq no
 131 to prevent all TCP forwarding,
 132 .Dq local
 133 to allow local (from the perspective of
 134 .Xr ssh 1 )
 135 forwarding only or
 136 .Dq remote
 137 to allow remote forwarding only.
 138 The default is
 139 .Dq yes .
 140 Note that disabling TCP forwarding does not improve security unless
 141 users are also denied shell access, as they can always install their
 142 own forwarders.
 143 .It Cm AllowStreamLocalForwarding
 144 Specifies whether StreamLocal (Unix-domain socket) forwarding is permitted.
 145 The available options are
 146 .Dq yes
 147 or
 148 .Dq all
 149 to allow StreamLocal forwarding,
 150 .Dq no
 151 to prevent all StreamLocal forwarding,
 152 .Dq local
 153 to allow local (from the perspective of
 154 .Xr ssh 1 )
 155 forwarding only or
 156 .Dq remote
 157 to allow remote forwarding only.
 158 The default is
 159 .Dq yes .
 160 Note that disabling StreamLocal forwarding does not improve security unless
 161 users are also denied shell access, as they can always install their
 162 own forwarders.
 163 .It Cm AllowUsers
 164 This keyword can be followed by a list of user name patterns, separated
 165 by spaces.
 166 If specified, login is allowed only for user names that
 167 match one of the patterns.
 168 Only user names are valid; a numerical user ID is not recognized.
 169 By default, login is allowed for all users.
 170 If the pattern takes the form USER@HOST then USER and HOST
 171 are separately checked, restricting logins to particular
 172 users from particular hosts.
 173 The allow/deny directives are processed in the following order:
 174 .Cm DenyUsers ,
 175 .Cm AllowUsers ,
 176 .Cm DenyGroups ,
 177 and finally
 178 .Cm AllowGroups .
 179 .Pp
 180 See PATTERNS in
 181 .Xr ssh_config 5
 182 for more information on patterns.
 183 .It Cm AuthenticationMethods
 184 Specifies the authentication methods that must be successfully completed
 185 for a user to be granted access.
 186 This option must be followed by one or more comma-separated lists of
 187 authentication method names.
 188 Successful authentication requires completion of every method in at least
 189 one of these lists.
 190 .Pp
 191 For example, an argument of
 192 .Dq publickey,password publickey,keyboard-interactive
 193 would require the user to complete public key authentication, followed by
 194 either password or keyboard interactive authentication.
 195 Only methods that are next in one or more lists are offered at each stage,
 196 so for this example, it would not be possible to attempt password or
 197 keyboard-interactive authentication before public key.
 198 .Pp
 199 For keyboard interactive authentication it is also possible to
 200 restrict authentication to a specific device by appending a
 201 colon followed by the device identifier
 202 .Dq bsdauth ,
 203 .Dq pam ,
 204 or
 205 .Dq skey ,
 206 depending on the server configuration.
 207 For example,
 208 .Dq keyboard-interactive:bsdauth
 209 would restrict keyboard interactive authentication to the
 210 .Dq bsdauth
 211 device.
 212 .Pp
 213 This option is only available for SSH protocol 2 and will yield a fatal
 214 error if enabled if protocol 1 is also enabled.
 215 Note that each authentication method listed should also be explicitly enabled
 216 in the configuration.
 217 The default is not to require multiple authentication; successful completion
 218 of a single authentication method is sufficient.
 219 .It Cm AuthorizedKeysCommand
 220 Specifies a program to be used to look up the user's public keys.
 221 The program must be owned by root and not writable by group or others.
 222 It will be invoked with a single argument of the username
 223 being authenticated, and should produce on standard output zero or
 224 more lines of authorized_keys output (see AUTHORIZED_KEYS in
 225 .Xr sshd 8 ) .
 226 If a key supplied by AuthorizedKeysCommand does not successfully authenticate
 227 and authorize the user then public key authentication continues using the usual
 228 .Cm AuthorizedKeysFile
 229 files.
 230 By default, no AuthorizedKeysCommand is run.
 231 .It Cm AuthorizedKeysCommandUser
 232 Specifies the user under whose account the AuthorizedKeysCommand is run.
 233 It is recommended to use a dedicated user that has no other role on the host
 234 than running authorized keys commands.
 235 .It Cm AuthorizedKeysFile
 236 Specifies the file that contains the public keys that can be used
 237 for user authentication.
 238 The format is described in the
 239 AUTHORIZED_KEYS FILE FORMAT
 240 section of
 241 .Xr sshd 8 .
 242 .Cm AuthorizedKeysFile
 243 may contain tokens of the form %T which are substituted during connection
 244 setup.
 245 The following tokens are defined: %% is replaced by a literal '%',
 246 %h is replaced by the home directory of the user being authenticated, and
 247 %u is replaced by the username of that user.
 248 After expansion,
 249 .Cm AuthorizedKeysFile
 250 is taken to be an absolute path or one relative to the user's home
 251 directory.
 252 Multiple files may be listed, separated by whitespace.
 253 The default is
 254 .Dq .ssh/authorized_keys .ssh/authorized_keys2 .
 255 .It Cm AuthorizedPrincipalsFile
 256 Specifies a file that lists principal names that are accepted for
 257 certificate authentication.
 258 When using certificates signed by a key listed in
 259 .Cm TrustedUserCAKeys ,
 260 this file lists names, one of which must appear in the certificate for it
 261 to be accepted for authentication.
 262 Names are listed one per line preceded by key options (as described
 263 in AUTHORIZED_KEYS FILE FORMAT in
 264 .Xr sshd 8 ) .
 265 Empty lines and comments starting with
 266 .Ql #
 267 are ignored.
 268 .Pp
 269 .Cm AuthorizedPrincipalsFile
 270 may contain tokens of the form %T which are substituted during connection
 271 setup.
 272 The following tokens are defined: %% is replaced by a literal '%',
 273 %h is replaced by the home directory of the user being authenticated, and
 274 %u is replaced by the username of that user.
 275 After expansion,
 276 .Cm AuthorizedPrincipalsFile
 277 is taken to be an absolute path or one relative to the user's home
 278 directory.
 279 .Pp
 280 The default is
 281 .Dq none ,
 282 i.e. not to use a principals file \(en in this case, the username
 283 of the user must appear in a certificate's principals list for it to be
 284 accepted.
 285 Note that
 286 .Cm AuthorizedPrincipalsFile
 287 is only used when authentication proceeds using a CA listed in
 288 .Cm TrustedUserCAKeys
 289 and is not consulted for certification authorities trusted via
 290 .Pa ~/.ssh/authorized_keys ,
 291 though the
 292 .Cm principals=
 293 key option offers a similar facility (see
 294 .Xr sshd 8
 295 for details).
 296 .It Cm Banner
 297 The contents of the specified file are sent to the remote user before
 298 authentication is allowed.
 299 If the argument is
 300 .Dq none
 301 then no banner is displayed.
 302 This option is only available for protocol version 2.
 303 By default, no banner is displayed.
 304 .It Cm ChallengeResponseAuthentication
 305 Specifies whether challenge-response authentication is allowed (e.g. via
 306 PAM or through authentication styles supported in
 307 .Xr login.conf 5 )
 308 The default is
 309 .Dq yes .
 310 .It Cm ChrootDirectory
 311 Specifies the pathname of a directory to
 312 .Xr chroot 2
 313 to after authentication.
 314 All components of the pathname must be root-owned directories that are
 315 not writable by any other user or group.
 316 After the chroot,
 317 .Xr sshd 8
 318 changes the working directory to the user's home directory.
 319 .Pp
 320 The pathname may contain the following tokens that are expanded at runtime once
 321 the connecting user has been authenticated: %% is replaced by a literal '%',
 322 %h is replaced by the home directory of the user being authenticated, and
 323 %u is replaced by the username of that user.
 324 .Pp
 325 The
 326 .Cm ChrootDirectory
 327 must contain the necessary files and directories to support the
 328 user's session.
 329 For an interactive session this requires at least a shell, typically
 330 .Xr sh 1 ,
 331 and basic
 332 .Pa /dev
 333 nodes such as
 334 .Xr null 4 ,
 335 .Xr zero 4 ,
 336 .Xr stdin 4 ,
 337 .Xr stdout 4 ,
 338 .Xr stderr 4 ,
 339 .Xr arandom 4
 340 and
 341 .Xr tty 4
 342 devices.
 343 For file transfer sessions using
 344 .Dq sftp ,
 345 no additional configuration of the environment is necessary if the
 346 in-process sftp server is used,
 347 though sessions which use logging may require
 348 .Pa /dev/log
 349 inside the chroot directory on some operating systems (see
 350 .Xr sftp-server 8
 351 for details).
 352 .Pp
 353 The default is not to
 354 .Xr chroot 2 .
 355 .It Cm Ciphers
 356 Specifies the ciphers allowed for protocol version 2.
 357 Multiple ciphers must be comma-separated.
 358 The supported ciphers are:
 359 .Pp
 360 .Bl -item -compact -offset indent
 361 .It
 362 3des-cbc
 363 .It
 364 aes128-cbc
 365 .It
 366 aes192-cbc
 367 .It
 368 aes256-cbc
 369 .It
 370 aes128-ctr
 371 .It
 372 aes192-ctr
 373 .It
 374 aes256-ctr
 375 .It
 376 aes128-gcm@openssh.com
 377 .It
 378 aes256-gcm@openssh.com
 379 .It
 380 arcfour
 381 .It
 382 arcfour128
 383 .It
 384 arcfour256
 385 .It
 386 blowfish-cbc
 387 .It
 388 cast128-cbc
 389 .It
 390 chacha20-poly1305@openssh.com
 391 .El
 392 .Pp
 393 The default is:
 394 .Bd -literal -offset indent
 395 aes128-ctr,aes192-ctr,aes256-ctr,
 396 aes128-gcm@openssh.com,aes256-gcm@openssh.com,
 397 chacha20-poly1305@openssh.com
 398 .Ed
 399 .Pp
 400 The list of available ciphers may also be obtained using the
 401 .Fl Q
 402 option of
 403 .Xr ssh 1 .
 404 .It Cm ClientAliveCountMax
 405 Sets the number of client alive messages (see below) which may be
 406 sent without
 407 .Xr sshd 8
 408 receiving any messages back from the client.
 409 If this threshold is reached while client alive messages are being sent,
 410 sshd will disconnect the client, terminating the session.
 411 It is important to note that the use of client alive messages is very
 412 different from
 413 .Cm TCPKeepAlive
 414 (below).
 415 The client alive messages are sent through the encrypted channel
 416 and therefore will not be spoofable.
 417 The TCP keepalive option enabled by
 418 .Cm TCPKeepAlive
 419 is spoofable.
 420 The client alive mechanism is valuable when the client or
 421 server depend on knowing when a connection has become inactive.
 422 .Pp
 423 The default value is 3.
 424 If
 425 .Cm ClientAliveInterval
 426 (see below) is set to 15, and
 427 .Cm ClientAliveCountMax
 428 is left at the default, unresponsive SSH clients
 429 will be disconnected after approximately 45 seconds.
 430 This option applies to protocol version 2 only.
 431 .It Cm ClientAliveInterval
 432 Sets a timeout interval in seconds after which if no data has been received
 433 from the client,
 434 .Xr sshd 8
 435 will send a message through the encrypted
 436 channel to request a response from the client.
 437 The default
 438 is 0, indicating that these messages will not be sent to the client.
 439 This option applies to protocol version 2 only.
 440 .It Cm Compression
 441 Specifies whether compression is allowed, or delayed until
 442 the user has authenticated successfully.
 443 The argument must be
 444 .Dq yes ,
 445 .Dq delayed ,
 446 or
 447 .Dq no .
 448 The default is
 449 .Dq delayed .
 450 .It Cm DenyGroups
 451 This keyword can be followed by a list of group name patterns, separated
 452 by spaces.
 453 Login is disallowed for users whose primary group or supplementary
 454 group list matches one of the patterns.
 455 Only group names are valid; a numerical group ID is not recognized.
 456 By default, login is allowed for all groups.
 457 The allow/deny directives are processed in the following order:
 458 .Cm DenyUsers ,
 459 .Cm AllowUsers ,
 460 .Cm DenyGroups ,
 461 and finally
 462 .Cm AllowGroups .
 463 .Pp
 464 See PATTERNS in
 465 .Xr ssh_config 5
 466 for more information on patterns.
 467 .It Cm DenyUsers
 468 This keyword can be followed by a list of user name patterns, separated
 469 by spaces.
 470 Login is disallowed for user names that match one of the patterns.
 471 Only user names are valid; a numerical user ID is not recognized.
 472 By default, login is allowed for all users.
 473 If the pattern takes the form USER@HOST then USER and HOST
 474 are separately checked, restricting logins to particular
 475 users from particular hosts.
 476 The allow/deny directives are processed in the following order:
 477 .Cm DenyUsers ,
 478 .Cm AllowUsers ,
 479 .Cm DenyGroups ,
 480 and finally
 481 .Cm AllowGroups .
 482 .Pp
 483 See PATTERNS in
 484 .Xr ssh_config 5
 485 for more information on patterns.
 486 .It Cm ForceCommand
 487 Forces the execution of the command specified by
 488 .Cm ForceCommand ,
 489 ignoring any command supplied by the client and
 490 .Pa ~/.ssh/rc
 491 if present.
 492 The command is invoked by using the user's login shell with the -c option.
 493 This applies to shell, command, or subsystem execution.
 494 It is most useful inside a
 495 .Cm Match
 496 block.
 497 The command originally supplied by the client is available in the
 498 .Ev SSH_ORIGINAL_COMMAND
 499 environment variable.
 500 Specifying a command of
 501 .Dq internal-sftp
 502 will force the use of an in-process sftp server that requires no support
 503 files when used with
 504 .Cm ChrootDirectory .
 505 .It Cm GatewayPorts
 506 Specifies whether remote hosts are allowed to connect to ports
 507 forwarded for the client.
 508 By default,
 509 .Xr sshd 8
 510 binds remote port forwardings to the loopback address.
 511 This prevents other remote hosts from connecting to forwarded ports.
 512 .Cm GatewayPorts
 513 can be used to specify that sshd
 514 should allow remote port forwardings to bind to non-loopback addresses, thus
 515 allowing other hosts to connect.
 516 The argument may be
 517 .Dq no
 518 to force remote port forwardings to be available to the local host only,
 519 .Dq yes
 520 to force remote port forwardings to bind to the wildcard address, or
 521 .Dq clientspecified
 522 to allow the client to select the address to which the forwarding is bound.
 523 The default is
 524 .Dq no .
 525 .It Cm GSSAPIAuthentication
 526 Specifies whether user authentication based on GSSAPI is allowed.
 527 The default is
 528 .Dq no .
 529 Note that this option applies to protocol version 2 only.
 530 .It Cm GSSAPICleanupCredentials
 531 Specifies whether to automatically destroy the user's credentials cache
 532 on logout.
 533 The default is
 534 .Dq yes .
 535 Note that this option applies to protocol version 2 only.
 536 .It Cm HostbasedAuthentication
 537 Specifies whether rhosts or /etc/hosts.equiv authentication together
 538 with successful public key client host authentication is allowed
 539 (host-based authentication).
 540 This option is similar to
 541 .Cm RhostsRSAAuthentication
 542 and applies to protocol version 2 only.
 543 The default is
 544 .Dq no .
 545 .It Cm HostbasedUsesNameFromPacketOnly
 546 Specifies whether or not the server will attempt to perform a reverse
 547 name lookup when matching the name in the
 548 .Pa ~/.shosts ,
 549 .Pa ~/.rhosts ,
 550 and
 551 .Pa /etc/hosts.equiv
 552 files during
 553 .Cm HostbasedAuthentication .
 554 A setting of
 555 .Dq yes
 556 means that
 557 .Xr sshd 8
 558 uses the name supplied by the client rather than
 559 attempting to resolve the name from the TCP connection itself.
 560 The default is
 561 .Dq no .
 562 .It Cm HostCertificate
 563 Specifies a file containing a public host certificate.
 564 The certificate's public key must match a private host key already specified
 565 by
 566 .Cm HostKey .
 567 The default behaviour of
 568 .Xr sshd 8
 569 is not to load any certificates.
 570 .It Cm HostKey
 571 Specifies a file containing a private host key
 572 used by SSH.
 573 The default is
 574 .Pa /etc/ssh/ssh_host_key
 575 for protocol version 1, and
 576 .Pa /etc/ssh/ssh_host_dsa_key ,
 577 .Pa /etc/ssh/ssh_host_ecdsa_key ,
 578 .Pa /etc/ssh/ssh_host_ed25519_key
 579 and
 580 .Pa /etc/ssh/ssh_host_rsa_key
 581 for protocol version 2.
 582 Note that
 583 .Xr sshd 8
 584 will refuse to use a file if it is group/world-accessible.
 585 It is possible to have multiple host key files.
 586 .Dq rsa1
 587 keys are used for version 1 and
 588 .Dq dsa ,
 589 .Dq ecdsa ,
 590 .Dq ed25519
 591 or
 592 .Dq rsa
 593 are used for version 2 of the SSH protocol.
 594 It is also possible to specify public host key files instead.
 595 In this case operations on the private key will be delegated
 596 to an
 597 .Xr ssh-agent 1 .
 598 .It Cm HostKeyAgent
 599 Identifies the UNIX-domain socket used to communicate
 600 with an agent that has access to the private host keys.
 601 If
 602 .Dq SSH_AUTH_SOCK
 603 is specified, the location of the socket will be read from the
 604 .Ev SSH_AUTH_SOCK
 605 environment variable.
 606 .It Cm IgnoreRhosts
 607 Specifies that
 608 .Pa .rhosts
 609 and
 610 .Pa .shosts
 611 files will not be used in
 612 .Cm RhostsRSAAuthentication
 613 or
 614 .Cm HostbasedAuthentication .
 615 .Pp
 616 .Pa /etc/hosts.equiv
 617 and
 618 .Pa /etc/shosts.equiv
 619 are still used.
 620 The default is
 621 .Dq yes .
 622 .It Cm IgnoreUserKnownHosts
 623 Specifies whether
 624 .Xr sshd 8
 625 should ignore the user's
 626 .Pa ~/.ssh/known_hosts
 627 during
 628 .Cm RhostsRSAAuthentication
 629 or
 630 .Cm HostbasedAuthentication .
 631 The default is
 632 .Dq no .
 633 .It Cm IPQoS
 634 Specifies the IPv4 type-of-service or DSCP class for the connection.
 635 Accepted values are
 636 .Dq af11 ,
 637 .Dq af12 ,
 638 .Dq af13 ,
 639 .Dq af21 ,
 640 .Dq af22 ,
 641 .Dq af23 ,
 642 .Dq af31 ,
 643 .Dq af32 ,
 644 .Dq af33 ,
 645 .Dq af41 ,
 646 .Dq af42 ,
 647 .Dq af43 ,
 648 .Dq cs0 ,
 649 .Dq cs1 ,
 650 .Dq cs2 ,
 651 .Dq cs3 ,
 652 .Dq cs4 ,
 653 .Dq cs5 ,
 654 .Dq cs6 ,
 655 .Dq cs7 ,
 656 .Dq ef ,
 657 .Dq lowdelay ,
 658 .Dq throughput ,
 659 .Dq reliability ,
 660 or a numeric value.
 661 This option may take one or two arguments, separated by whitespace.
 662 If one argument is specified, it is used as the packet class unconditionally.
 663 If two values are specified, the first is automatically selected for
 664 interactive sessions and the second for non-interactive sessions.
 665 The default is
 666 .Dq lowdelay
 667 for interactive sessions and
 668 .Dq throughput
 669 for non-interactive sessions.
 670 .It Cm KbdInteractiveAuthentication
 671 Specifies whether to allow keyboard-interactive authentication.
 672 The argument to this keyword must be
 673 .Dq yes
 674 or
 675 .Dq no .
 676 The default is to use whatever value
 677 .Cm ChallengeResponseAuthentication
 678 is set to
 679 (by default
 680 .Dq yes ) .
 681 .It Cm KerberosAuthentication
 682 Specifies whether the password provided by the user for
 683 .Cm PasswordAuthentication
 684 will be validated through the Kerberos KDC.
 685 To use this option, the server needs a
 686 Kerberos servtab which allows the verification of the KDC's identity.
 687 The default is
 688 .Dq no .
 689 .It Cm KerberosGetAFSToken
 690 If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
 691 an AFS token before accessing the user's home directory.
 692 The default is
 693 .Dq no .
 694 .It Cm KerberosOrLocalPasswd
 695 If password authentication through Kerberos fails then
 696 the password will be validated via any additional local mechanism
 697 such as
 698 .Pa /etc/passwd .
 699 The default is
 700 .Dq yes .
 701 .It Cm KerberosTicketCleanup
 702 Specifies whether to automatically destroy the user's ticket cache
 703 file on logout.
 704 The default is
 705 .Dq yes .
 706 .It Cm KexAlgorithms
 707 Specifies the available KEX (Key Exchange) algorithms.
 708 Multiple algorithms must be comma-separated.
 709 The supported algorithms are:
 710 .Pp
 711 .Bl -item -compact -offset indent
 712 .It
 713 curve25519-sha256@libssh.org
 714 .It
 715 diffie-hellman-group1-sha1
 716 .It
 717 diffie-hellman-group14-sha1
 718 .It
 719 diffie-hellman-group-exchange-sha1
 720 .It
 721 diffie-hellman-group-exchange-sha256
 722 .It
 723 ecdh-sha2-nistp256
 724 .It
 725 ecdh-sha2-nistp384
 726 .It
 727 ecdh-sha2-nistp521
 728 .El
 729 .Pp
 730 The default is:
 731 .Bd -literal -offset indent
 732 curve25519-sha256@libssh.org,
 733 ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
 734 diffie-hellman-group-exchange-sha256,
 735 diffie-hellman-group14-sha1
 736 .Ed
 737 .It Cm KeyRegenerationInterval
 738 In protocol version 1, the ephemeral server key is automatically regenerated
 739 after this many seconds (if it has been used).
 740 The purpose of regeneration is to prevent
 741 decrypting captured sessions by later breaking into the machine and
 742 stealing the keys.
 743 The key is never stored anywhere.
 744 If the value is 0, the key is never regenerated.
 745 The default is 3600 (seconds).
 746 .It Cm ListenAddress
 747 Specifies the local addresses
 748 .Xr sshd 8
 749 should listen on.
 750 The following forms may be used:
 751 .Pp
 752 .Bl -item -offset indent -compact
 753 .It
 754 .Cm ListenAddress
 755 .Sm off
 756 .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
 757 .Sm on
 758 .It
 759 .Cm ListenAddress
 760 .Sm off
 761 .Ar host No | Ar IPv4_addr No : Ar port
 762 .Sm on
 763 .It
 764 .Cm ListenAddress
 765 .Sm off
 766 .Oo
 767 .Ar host No | Ar IPv6_addr Oc : Ar port
 768 .Sm on
 769 .El
 770 .Pp
 771 If
 772 .Ar port
 773 is not specified,
 774 sshd will listen on the address and all prior
 775 .Cm Port
 776 options specified.
 777 The default is to listen on all local addresses.
 778 Multiple
 779 .Cm ListenAddress
 780 options are permitted.
 781 Additionally, any
 782 .Cm Port
 783 options must precede this option for non-port qualified addresses.
 784 .It Cm LoginGraceTime
 785 The server disconnects after this time if the user has not
 786 successfully logged in.
 787 If the value is 0, there is no time limit.
 788 The default is 120 seconds.
 789 .It Cm LogLevel
 790 Gives the verbosity level that is used when logging messages from
 791 .Xr sshd 8 .
 792 The possible values are:
 793 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
 794 The default is INFO.
 795 DEBUG and DEBUG1 are equivalent.
 796 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
 797 Logging with a DEBUG level violates the privacy of users and is not recommended.
 798 .It Cm MACs
 799 Specifies the available MAC (message authentication code) algorithms.
 800 The MAC algorithm is used in protocol version 2
 801 for data integrity protection.
 802 Multiple algorithms must be comma-separated.
 803 The algorithms that contain
 804 .Dq -etm
 805 calculate the MAC after encryption (encrypt-then-mac).
 806 These are considered safer and their use recommended.
 807 The supported MACs are:
 808 .Pp
 809 .Bl -item -compact -offset indent
 810 .It
 811 hmac-md5
 812 .It
 813 hmac-md5-96
 814 .It
 815 hmac-ripemd160
 816 .It
 817 hmac-sha1
 818 .It
 819 hmac-sha1-96
 820 .It
 821 hmac-sha2-256
 822 .It
 823 hmac-sha2-512
 824 .It
 825 umac-64@openssh.com
 826 .It
 827 umac-128@openssh.com
 828 .It
 829 hmac-md5-etm@openssh.com
 830 .It
 831 hmac-md5-96-etm@openssh.com
 832 .It
 833 hmac-ripemd160-etm@openssh.com
 834 .It
 835 hmac-sha1-etm@openssh.com
 836 .It
 837 hmac-sha1-96-etm@openssh.com
 838 .It
 839 hmac-sha2-256-etm@openssh.com
 840 .It
 841 hmac-sha2-512-etm@openssh.com
 842 .It
 843 umac-64-etm@openssh.com
 844 .It
 845 umac-128-etm@openssh.com
 846 .El
 847 .Pp
 848 The default is:
 849 .Bd -literal -offset indent
 850 umac-64-etm@openssh.com,umac-128-etm@openssh.com,
 851 hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
 852 umac-64@openssh.com,umac-128@openssh.com,
 853 hmac-sha2-256,hmac-sha2-512
 854 .Ed
 855 .It Cm Match
 856 Introduces a conditional block.
 857 If all of the criteria on the
 858 .Cm Match
 859 line are satisfied, the keywords on the following lines override those
 860 set in the global section of the config file, until either another
 861 .Cm Match
 862 line or the end of the file.
 863 If a keyword appears in multiple
 864 .Cm Match
 865 blocks that are satisified, only the first instance of the keyword is
 866 applied.
 867 .Pp
 868 The arguments to
 869 .Cm Match
 870 are one or more criteria-pattern pairs or the single token
 871 .Cm All
 872 which matches all criteria.
 873 The available criteria are
 874 .Cm User ,
 875 .Cm Group ,
 876 .Cm Host ,
 877 .Cm LocalAddress ,
 878 .Cm LocalPort ,
 879 and
 880 .Cm Address .
 881 The match patterns may consist of single entries or comma-separated
 882 lists and may use the wildcard and negation operators described in the
 883 PATTERNS section of
 884 .Xr ssh_config 5 .
 885 .Pp
 886 The patterns in an
 887 .Cm Address
 888 criteria may additionally contain addresses to match in CIDR
 889 address/masklen format, e.g.\&
 890 .Dq 192.0.2.0/24
 891 or
 892 .Dq 3ffe:ffff::/32 .
 893 Note that the mask length provided must be consistent with the address -
 894 it is an error to specify a mask length that is too long for the address
 895 or one with bits set in this host portion of the address.
 896 For example,
 897 .Dq 192.0.2.0/33
 898 and
 899 .Dq 192.0.2.0/8
 900 respectively.
 901 .Pp
 902 Only a subset of keywords may be used on the lines following a
 903 .Cm Match
 904 keyword.
 905 Available keywords are
 906 .Cm AcceptEnv ,
 907 .Cm AllowAgentForwarding ,
 908 .Cm AllowGroups ,
 909 .Cm AllowTcpForwarding ,
 910 .Cm AllowUsers ,
 911 .Cm AuthenticationMethods ,
 912 .Cm AuthorizedKeysCommand ,
 913 .Cm AuthorizedKeysCommandUser ,
 914 .Cm AuthorizedKeysFile ,
 915 .Cm AuthorizedPrincipalsFile ,
 916 .Cm Banner ,
 917 .Cm ChrootDirectory ,
 918 .Cm DenyGroups ,
 919 .Cm DenyUsers ,
 920 .Cm ForceCommand ,
 921 .Cm GatewayPorts ,
 922 .Cm GSSAPIAuthentication ,
 923 .Cm HostbasedAuthentication ,
 924 .Cm HostbasedUsesNameFromPacketOnly ,
 925 .Cm KbdInteractiveAuthentication ,
 926 .Cm KerberosAuthentication ,
 927 .Cm MaxAuthTries ,
 928 .Cm MaxSessions ,
 929 .Cm PasswordAuthentication ,
 930 .Cm PermitEmptyPasswords ,
 931 .Cm PermitOpen ,
 932 .Cm PermitRootLogin ,
 933 .Cm PermitTTY ,
 934 .Cm PermitTunnel ,
 935 .Cm PermitUserRC ,
 936 .Cm PubkeyAuthentication ,
 937 .Cm RekeyLimit ,
 938 .Cm RhostsRSAAuthentication ,
 939 .Cm RSAAuthentication ,
 940 .Cm X11DisplayOffset ,
 941 .Cm X11Forwarding
 942 and
 943 .Cm X11UseLocalHost .
 944 .It Cm MaxAuthTries
 945 Specifies the maximum number of authentication attempts permitted per
 946 connection.
 947 Once the number of failures reaches half this value,
 948 additional failures are logged.
 949 The default is 6.
 950 .It Cm MaxSessions
 951 Specifies the maximum number of open sessions permitted per network connection.
 952 The default is 10.
 953 .It Cm MaxStartups
 954 Specifies the maximum number of concurrent unauthenticated connections to the
 955 SSH daemon.
 956 Additional connections will be dropped until authentication succeeds or the
 957 .Cm LoginGraceTime
 958 expires for a connection.
 959 The default is 10:30:100.
 960 .Pp
 961 Alternatively, random early drop can be enabled by specifying
 962 the three colon separated values
 963 .Dq start:rate:full
 964 (e.g. "10:30:60").
 965 .Xr sshd 8
 966 will refuse connection attempts with a probability of
 967 .Dq rate/100
 968 (30%)
 969 if there are currently
 970 .Dq start
 971 (10)
 972 unauthenticated connections.
 973 The probability increases linearly and all connection attempts
 974 are refused if the number of unauthenticated connections reaches
 975 .Dq full
 976 (60).
 977 .It Cm PasswordAuthentication
 978 Specifies whether password authentication is allowed.
 979 The default is
 980 .Dq yes .
 981 .It Cm PermitEmptyPasswords
 982 When password authentication is allowed, it specifies whether the
 983 server allows login to accounts with empty password strings.
 984 The default is
 985 .Dq no .
 986 .It Cm PermitOpen
 987 Specifies the destinations to which TCP port forwarding is permitted.
 988 The forwarding specification must be one of the following forms:
 989 .Pp
 990 .Bl -item -offset indent -compact
 991 .It
 992 .Cm PermitOpen
 993 .Sm off
 994 .Ar host : port
 995 .Sm on
 996 .It
 997 .Cm PermitOpen
 998 .Sm off
 999 .Ar IPv4_addr : port
1000 .Sm on
1001 .It
1002 .Cm PermitOpen
1003 .Sm off
1004 .Ar \&[ IPv6_addr \&] : port
1005 .Sm on
1006 .El
1007 .Pp
1008 Multiple forwards may be specified by separating them with whitespace.
1009 An argument of
1010 .Dq any
1011 can be used to remove all restrictions and permit any forwarding requests.
1012 An argument of
1013 .Dq none
1014 can be used to prohibit all forwarding requests.
1015 By default all port forwarding requests are permitted.
1016 .It Cm PermitRootLogin
1017 Specifies whether root can log in using
1018 .Xr ssh 1 .
1019 The argument must be
1020 .Dq yes ,
1021 .Dq without-password ,
1022 .Dq forced-commands-only ,
1023 or
1024 .Dq no .
1025 The default is
1026 .Dq yes .
1027 .Pp
1028 If this option is set to
1029 .Dq without-password ,
1030 password authentication is disabled for root.
1031 .Pp
1032 If this option is set to
1033 .Dq forced-commands-only ,
1034 root login with public key authentication will be allowed,
1035 but only if the
1036 .Ar command
1037 option has been specified
1038 (which may be useful for taking remote backups even if root login is
1039 normally not allowed).
1040 All other authentication methods are disabled for root.
1041 .Pp
1042 If this option is set to
1043 .Dq no ,
1044 root is not allowed to log in.
1045 .It Cm PermitTunnel
1046 Specifies whether
1047 .Xr tun 4
1048 device forwarding is allowed.
1049 The argument must be
1050 .Dq yes ,
1051 .Dq point-to-point
1052 (layer 3),
1053 .Dq ethernet
1054 (layer 2), or
1055 .Dq no .
1056 Specifying
1057 .Dq yes
1058 permits both
1059 .Dq point-to-point
1060 and
1061 .Dq ethernet .
1062 The default is
1063 .Dq no .
1064 .It Cm PermitTTY
1065 Specifies whether
1066 .Xr pty 4
1067 allocation is permitted.
1068 The default is
1069 .Dq yes .
1070 .It Cm PermitUserEnvironment
1071 Specifies whether
1072 .Pa ~/.ssh/environment
1073 and
1074 .Cm environment=
1075 options in
1076 .Pa ~/.ssh/authorized_keys
1077 are processed by
1078 .Xr sshd 8 .
1079 The default is
1080 .Dq no .
1081 Enabling environment processing may enable users to bypass access
1082 restrictions in some configurations using mechanisms such as
1083 .Ev LD_PRELOAD .
1084 .It Cm PermitUserRC
1085 Specifies whether any
1086 .Pa ~/.ssh/rc
1087 file is executed.
1088 The default is
1089 .Dq yes .
1090 .It Cm PidFile
1091 Specifies the file that contains the process ID of the
1092 SSH daemon.
1093 The default is
1094 .Pa /var/run/sshd.pid .
1095 .It Cm Port
1096 Specifies the port number that
1097 .Xr sshd 8
1098 listens on.
1099 The default is 22.
1100 Multiple options of this type are permitted.
1101 See also
1102 .Cm ListenAddress .
1103 .It Cm PrintLastLog
1104 Specifies whether
1105 .Xr sshd 8
1106 should print the date and time of the last user login when a user logs
1107 in interactively.
1108 The default is
1109 .Dq yes .
1110 .It Cm PrintMotd
1111 Specifies whether
1112 .Xr sshd 8
1113 should print
1114 .Pa /etc/motd
1115 when a user logs in interactively.
1116 (On some systems it is also printed by the shell,
1117 .Pa /etc/profile ,
1118 or equivalent.)
1119 The default is
1120 .Dq yes .
1121 .It Cm Protocol
1122 Specifies the protocol versions
1123 .Xr sshd 8
1124 supports.
1125 The possible values are
1126 .Sq 1
1127 and
1128 .Sq 2 .
1129 Multiple versions must be comma-separated.
1130 The default is
1131 .Sq 2 .
1132 Note that the order of the protocol list does not indicate preference,
1133 because the client selects among multiple protocol versions offered
1134 by the server.
1135 Specifying
1136 .Dq 2,1
1137 is identical to
1138 .Dq 1,2 .
1139 .It Cm PubkeyAuthentication
1140 Specifies whether public key authentication is allowed.
1141 The default is
1142 .Dq yes .
1143 Note that this option applies to protocol version 2 only.
1144 .It Cm RekeyLimit
1145 Specifies the maximum amount of data that may be transmitted before the
1146 session key is renegotiated, optionally followed a maximum amount of
1147 time that may pass before the session key is renegotiated.
1148 The first argument is specified in bytes and may have a suffix of
1149 .Sq K ,
1150 .Sq M ,
1151 or
1152 .Sq G
1153 to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1154 The default is between
1155 .Sq 1G
1156 and
1157 .Sq 4G ,
1158 depending on the cipher.
1159 The optional second value is specified in seconds and may use any of the
1160 units documented in the
1161 .Sx TIME FORMATS
1162 section.
1163 The default value for
1164 .Cm RekeyLimit
1165 is
1166 .Dq default none ,
1167 which means that rekeying is performed after the cipher's default amount
1168 of data has been sent or received and no time based rekeying is done.
1169 This option applies to protocol version 2 only.
1170 .It Cm RevokedKeys
1171 Specifies revoked public keys.
1172 Keys listed in this file will be refused for public key authentication.
1173 Note that if this file is not readable, then public key authentication will
1174 be refused for all users.
1175 Keys may be specified as a text file, listing one public key per line, or as
1176 an OpenSSH Key Revocation List (KRL) as generated by
1177 .Xr ssh-keygen 1 .
1178 For more information on KRLs, see the KEY REVOCATION LISTS section in
1179 .Xr ssh-keygen 1 .
1180 .It Cm RhostsRSAAuthentication
1181 Specifies whether rhosts or /etc/hosts.equiv authentication together
1182 with successful RSA host authentication is allowed.
1183 The default is
1184 .Dq no .
1185 This option applies to protocol version 1 only.
1186 .It Cm RSAAuthentication
1187 Specifies whether pure RSA authentication is allowed.
1188 The default is
1189 .Dq yes .
1190 This option applies to protocol version 1 only.
1191 .It Cm ServerKeyBits
1192 Defines the number of bits in the ephemeral protocol version 1 server key.
1193 The minimum value is 512, and the default is 1024.
1194 .It Cm StreamLocalBindMask
1195 Sets the octal file creation mode mask
1196 .Pq umask
1197 used when creating a Unix-domain socket file for local or remote
1198 port forwarding.
1199 This option is only used for port forwarding to a Unix-domain socket file.
1200 .Pp
1201 The default value is 0177, which creates a Unix-domain socket file that is
1202 readable and writable only by the owner.
1203 Note that not all operating systems honor the file mode on Unix-domain
1204 socket files.
1205 .It Cm StreamLocalBindUnlink
1206 Specifies whether to remove an existing Unix-domain socket file for local
1207 or remote port forwarding before creating a new one.
1208 If the socket file already exists and
1209 .Cm StreamLocalBindUnlink
1210 is not enabled,
1211 .Nm sshd
1212 will be unable to forward the port to the Unix-domain socket file.
1213 This option is only used for port forwarding to a Unix-domain socket file.
1214 .Pp
1215 The argument must be
1216 .Dq yes
1217 or
1218 .Dq no .
1219 The default is
1220 .Dq no .
1221 .It Cm StrictModes
1222 Specifies whether
1223 .Xr sshd 8
1224 should check file modes and ownership of the
1225 user's files and home directory before accepting login.
1226 This is normally desirable because novices sometimes accidentally leave their
1227 directory or files world-writable.
1228 The default is
1229 .Dq yes .
1230 Note that this does not apply to
1231 .Cm ChrootDirectory ,
1232 whose permissions and ownership are checked unconditionally.
1233 .It Cm Subsystem
1234 Configures an external subsystem (e.g. file transfer daemon).
1235 Arguments should be a subsystem name and a command (with optional arguments)
1236 to execute upon subsystem request.
1237 .Pp
1238 The command
1239 .Xr sftp-server 8
1240 implements the
1241 .Dq sftp
1242 file transfer subsystem.
1243 .Pp
1244 Alternately the name
1245 .Dq internal-sftp
1246 implements an in-process
1247 .Dq sftp
1248 server.
1249 This may simplify configurations using
1250 .Cm ChrootDirectory
1251 to force a different filesystem root on clients.
1252 .Pp
1253 By default no subsystems are defined.
1254 Note that this option applies to protocol version 2 only.
1255 .It Cm SyslogFacility
1256 Gives the facility code that is used when logging messages from
1257 .Xr sshd 8 .
1258 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
1259 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
1260 The default is AUTH.
1261 .It Cm TCPKeepAlive
1262 Specifies whether the system should send TCP keepalive messages to the
1263 other side.
1264 If they are sent, death of the connection or crash of one
1265 of the machines will be properly noticed.
1266 However, this means that
1267 connections will die if the route is down temporarily, and some people
1268 find it annoying.
1269 On the other hand, if TCP keepalives are not sent,
1270 sessions may hang indefinitely on the server, leaving
1271 .Dq ghost
1272 users and consuming server resources.
1273 .Pp
1274 The default is
1275 .Dq yes
1276 (to send TCP keepalive messages), and the server will notice
1277 if the network goes down or the client host crashes.
1278 This avoids infinitely hanging sessions.
1279 .Pp
1280 To disable TCP keepalive messages, the value should be set to
1281 .Dq no .
1282 .It Cm TrustedUserCAKeys
1283 Specifies a file containing public keys of certificate authorities that are
1284 trusted to sign user certificates for authentication.
1285 Keys are listed one per line; empty lines and comments starting with
1286 .Ql #
1287 are allowed.
1288 If a certificate is presented for authentication and has its signing CA key
1289 listed in this file, then it may be used for authentication for any user
1290 listed in the certificate's principals list.
1291 Note that certificates that lack a list of principals will not be permitted
1292 for authentication using
1293 .Cm TrustedUserCAKeys .
1294 For more details on certificates, see the CERTIFICATES section in
1295 .Xr ssh-keygen 1 .
1296 .It Cm UseDNS
1297 Specifies whether
1298 .Xr sshd 8
1299 should look up the remote host name and check that
1300 the resolved host name for the remote IP address maps back to the
1301 very same IP address.
1302 The default is
1303 .Dq yes .
1304 .It Cm UseLogin
1305 Specifies whether
1306 .Xr login 1
1307 is used for interactive login sessions.
1308 The default is
1309 .Dq no .
1310 Note that
1311 .Xr login 1
1312 is never used for remote command execution.
1313 Note also, that if this is enabled,
1314 .Cm X11Forwarding
1315 will be disabled because
1316 .Xr login 1
1317 does not know how to handle
1318 .Xr xauth 1
1319 cookies.
1320 If
1321 .Cm UsePrivilegeSeparation
1322 is specified, it will be disabled after authentication.
1323 .It Cm UsePAM
1324 Enables the Pluggable Authentication Module interface.
1325 If set to
1326 .Dq yes
1327 this will enable PAM authentication using
1328 .Cm ChallengeResponseAuthentication
1329 and
1330 .Cm PasswordAuthentication
1331 in addition to PAM account and session module processing for all
1332 authentication types.
1333 .Pp
1334 Because PAM challenge-response authentication usually serves an equivalent
1335 role to password authentication, you should disable either
1336 .Cm PasswordAuthentication
1337 or
1338 .Cm ChallengeResponseAuthentication.
1339 .Pp
1340 If
1341 .Cm UsePAM
1342 is enabled, you will not be able to run
1343 .Xr sshd 8
1344 as a non-root user.
1345 The default is
1346 .Dq no .
1347 .It Cm UsePrivilegeSeparation
1348 Specifies whether
1349 .Xr sshd 8
1350 separates privileges by creating an unprivileged child process
1351 to deal with incoming network traffic.
1352 After successful authentication, another process will be created that has
1353 the privilege of the authenticated user.
1354 The goal of privilege separation is to prevent privilege
1355 escalation by containing any corruption within the unprivileged processes.
1356 The default is
1357 .Dq yes .
1358 If
1359 .Cm UsePrivilegeSeparation
1360 is set to
1361 .Dq sandbox
1362 then the pre-authentication unprivileged process is subject to additional
1363 restrictions.
1364 .It Cm VersionAddendum
1365 Optionally specifies additional text to append to the SSH protocol banner
1366 sent by the server upon connection.
1367 The default is
1368 .Dq none .
1369 .It Cm X11DisplayOffset
1370 Specifies the first display number available for
1371 .Xr sshd 8 Ns 's
1372 X11 forwarding.
1373 This prevents sshd from interfering with real X11 servers.
1374 The default is 10.
1375 .It Cm X11Forwarding
1376 Specifies whether X11 forwarding is permitted.
1377 The argument must be
1378 .Dq yes
1379 or
1380 .Dq no .
1381 The default is
1382 .Dq no .
1383 .Pp
1384 When X11 forwarding is enabled, there may be additional exposure to
1385 the server and to client displays if the
1386 .Xr sshd 8
1387 proxy display is configured to listen on the wildcard address (see
1388 .Cm X11UseLocalhost
1389 below), though this is not the default.
1390 Additionally, the authentication spoofing and authentication data
1391 verification and substitution occur on the client side.
1392 The security risk of using X11 forwarding is that the client's X11
1393 display server may be exposed to attack when the SSH client requests
1394 forwarding (see the warnings for
1395 .Cm ForwardX11
1396 in
1397 .Xr ssh_config 5 ) .
1398 A system administrator may have a stance in which they want to
1399 protect clients that may expose themselves to attack by unwittingly
1400 requesting X11 forwarding, which can warrant a
1401 .Dq no
1402 setting.
1403 .Pp
1404 Note that disabling X11 forwarding does not prevent users from
1405 forwarding X11 traffic, as users can always install their own forwarders.
1406 X11 forwarding is automatically disabled if
1407 .Cm UseLogin
1408 is enabled.
1409 .It Cm X11UseLocalhost
1410 Specifies whether
1411 .Xr sshd 8
1412 should bind the X11 forwarding server to the loopback address or to
1413 the wildcard address.
1414 By default,
1415 sshd binds the forwarding server to the loopback address and sets the
1416 hostname part of the
1417 .Ev DISPLAY
1418 environment variable to
1419 .Dq localhost .
1420 This prevents remote hosts from connecting to the proxy display.
1421 However, some older X11 clients may not function with this
1422 configuration.
1423 .Cm X11UseLocalhost
1424 may be set to
1425 .Dq no
1426 to specify that the forwarding server should be bound to the wildcard
1427 address.
1428 The argument must be
1429 .Dq yes
1430 or
1431 .Dq no .
1432 The default is
1433 .Dq yes .
1434 .It Cm XAuthLocation
1435 Specifies the full pathname of the
1436 .Xr xauth 1
1437 program.
1438 The default is
1439 .Pa /usr/X11R6/bin/xauth .
1440 .El
1441 .Sh TIME FORMATS
1442 .Xr sshd 8
1443 command-line arguments and configuration file options that specify time
1444 may be expressed using a sequence of the form:
1445 .Sm off
1446 .Ar time Op Ar qualifier ,
1447 .Sm on
1448 where
1449 .Ar time
1450 is a positive integer value and
1451 .Ar qualifier
1452 is one of the following:
1453 .Pp
1454 .Bl -tag -width Ds -compact -offset indent
1455 .It Aq Cm none
1456 seconds
1457 .It Cm s | Cm S
1458 seconds
1459 .It Cm m | Cm M
1460 minutes
1461 .It Cm h | Cm H
1462 hours
1463 .It Cm d | Cm D
1464 days
1465 .It Cm w | Cm W
1466 weeks
1467 .El
1468 .Pp
1469 Each member of the sequence is added together to calculate
1470 the total time value.
1471 .Pp
1472 Time format examples:
1473 .Pp
1474 .Bl -tag -width Ds -compact -offset indent
1475 .It 600
1476 600 seconds (10 minutes)
1477 .It 10m
1478 10 minutes
1479 .It 1h30m
1480 1 hour 30 minutes (90 minutes)
1481 .El
1482 .Sh FILES
1483 .Bl -tag -width Ds
1484 .It Pa /etc/ssh/sshd_config
1485 Contains configuration data for
1486 .Xr sshd 8 .
1487 This file should be writable by root only, but it is recommended
1488 (though not necessary) that it be world-readable.
1489 .El
1490 .Sh SEE ALSO
1491 .Xr sshd 8
1492 .Sh AUTHORS
1493 OpenSSH is a derivative of the original and free
1494 ssh 1.2.12 release by Tatu Ylonen.
1495 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1496 Theo de Raadt and Dug Song
1497 removed many bugs, re-added newer features and
1498 created OpenSSH.
1499 Markus Friedl contributed the support for SSH
1500 protocol versions 1.5 and 2.0.
1501 Niels Provos and Markus Friedl contributed support
1502 for privilege separation.