sshd_config.5

   1 .\"  -*- nroff -*-
   2 .\"
   3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   5 .\"                    All rights reserved
   6 .\"
   7 .\" As far as I am concerned, the code I have written for this software
   8 .\" can be used freely for any purpose.  Any derived versions of this
   9 .\" software must be clearly marked as such, and if the derived work is
  10 .\" incompatible with the protocol description in the RFC file, it must be
  11 .\" called by a name other than "ssh" or "Secure Shell".
  12 .\"
  13 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
  14 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
  15 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
  16 .\"
  17 .\" Redistribution and use in source and binary forms, with or without
  18 .\" modification, are permitted provided that the following conditions
  19 .\" are met:
  20 .\" 1. Redistributions of source code must retain the above copyright
  21 .\"    notice, this list of conditions and the following disclaimer.
  22 .\" 2. Redistributions in binary form must reproduce the above copyright
  23 .\"    notice, this list of conditions and the following disclaimer in the
  24 .\"    documentation and/or other materials provided with the distribution.
  25 .\"
  26 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  27 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  28 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  30 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  35 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .\" $OpenBSD: sshd_config.5,v 1.32 2004/04/28 07:02:56 jmc Exp $
  38 .Dd September 25, 1999
  39 .Dt SSHD_CONFIG 5
  40 .Os
  41 .Sh NAME
  42 .Nm sshd_config
  43 .Nd OpenSSH SSH daemon configuration file
  44 .Sh SYNOPSIS
  45 .Bl -tag -width Ds -compact
  46 .It Pa /etc/ssh/sshd_config
  47 .El
  48 .Sh DESCRIPTION
  49 .Nm sshd
  50 reads configuration data from
  51 .Pa /etc/ssh/sshd_config
  52 (or the file specified with
  53 .Fl f
  54 on the command line).
  55 The file contains keyword-argument pairs, one per line.
  56 Lines starting with
  57 .Ql #
  58 and empty lines are interpreted as comments.
  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 AllowGroups
  87 This keyword can be followed by a list of group name patterns, separated
  88 by spaces.
  89 If specified, login is allowed only for users whose primary
  90 group or supplementary group list matches one of the patterns.
  91 .Ql \&*
  92 and
  93 .Ql \&?
  94 can be used as
  95 wildcards in the patterns.
  96 Only group names are valid; a numerical group ID is not recognized.
  97 By default, login is allowed for all groups.
  98 .It Cm AllowTcpForwarding
  99 Specifies whether TCP forwarding is permitted.
 100 The default is
 101 .Dq yes .
 102 Note that disabling TCP forwarding does not improve security unless
 103 users are also denied shell access, as they can always install their
 104 own forwarders.
 105 .It Cm AllowUsers
 106 This keyword can be followed by a list of user name patterns, separated
 107 by spaces.
 108 If specified, login is allowed only for user names that
 109 match one of the patterns.
 110 .Ql \&*
 111 and
 112 .Ql \&?
 113 can be used as
 114 wildcards in the patterns.
 115 Only user names are valid; a numerical user ID is not recognized.
 116 By default, login is allowed for all users.
 117 If the pattern takes the form USER@HOST then USER and HOST
 118 are separately checked, restricting logins to particular
 119 users from particular hosts.
 120 .It Cm AuthorizedKeysFile
 121 Specifies the file that contains the public keys that can be used
 122 for user authentication.
 123 .Cm AuthorizedKeysFile
 124 may contain tokens of the form %T which are substituted during connection
 125 set-up.
 126 The following tokens are defined: %% is replaced by a literal '%',
 127 %h is replaced by the home directory of the user being authenticated and
 128 %u is replaced by the username of that user.
 129 After expansion,
 130 .Cm AuthorizedKeysFile
 131 is taken to be an absolute path or one relative to the user's home
 132 directory.
 133 The default is
 134 .Dq .ssh/authorized_keys .
 135 .It Cm Banner
 136 In some jurisdictions, sending a warning message before authentication
 137 may be relevant for getting legal protection.
 138 The contents of the specified file are sent to the remote user before
 139 authentication is allowed.
 140 This option is only available for protocol version 2.
 141 By default, no banner is displayed.
 142 .It Cm ChallengeResponseAuthentication
 143 Specifies whether challenge response authentication is allowed.
 144 All authentication styles from
 145 .Xr login.conf 5
 146 are supported.
 147 The default is
 148 .Dq yes .
 149 .It Cm Ciphers
 150 Specifies the ciphers allowed for protocol version 2.
 151 Multiple ciphers must be comma-separated.
 152 The default is
 153 .Bd -literal
 154   ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
 155     aes192-cbc,aes256-cbc,aes128-ctr,aes192-ctr,aes256-ctr''
 156 .Ed
 157 .It Cm ClientAliveInterval
 158 Sets a timeout interval in seconds after which if no data has been received
 159 from the client,
 160 .Nm sshd
 161 will send a message through the encrypted
 162 channel to request a response from the client.
 163 The default
 164 is 0, indicating that these messages will not be sent to the client.
 165 This option applies to protocol version 2 only.
 166 .It Cm ClientAliveCountMax
 167 Sets the number of client alive messages (see above) which may be
 168 sent without
 169 .Nm sshd
 170 receiving any messages back from the client.
 171 If this threshold is reached while client alive messages are being sent,
 172 .Nm sshd
 173 will disconnect the client, terminating the session.
 174 It is important to note that the use of client alive messages is very
 175 different from
 176 .Cm TCPKeepAlive
 177 (below).
 178 The client alive messages are sent through the encrypted channel
 179 and therefore will not be spoofable.
 180 The TCP keepalive option enabled by
 181 .Cm TCPKeepAlive
 182 is spoofable.
 183 The client alive mechanism is valuable when the client or
 184 server depend on knowing when a connection has become inactive.
 185 .Pp
 186 The default value is 3.
 187 If
 188 .Cm ClientAliveInterval
 189 (above) is set to 15, and
 190 .Cm ClientAliveCountMax
 191 is left at the default, unresponsive ssh clients
 192 will be disconnected after approximately 45 seconds.
 193 .It Cm Compression
 194 Specifies whether compression is allowed.
 195 The argument must be
 196 .Dq yes
 197 or
 198 .Dq no .
 199 The default is
 200 .Dq yes .
 201 .It Cm DenyGroups
 202 This keyword can be followed by a list of group name patterns, separated
 203 by spaces.
 204 Login is disallowed for users whose primary group or supplementary
 205 group list matches one of the patterns.
 206 .Ql \&*
 207 and
 208 .Ql \&?
 209 can be used as
 210 wildcards in the patterns.
 211 Only group names are valid; a numerical group ID is not recognized.
 212 By default, login is allowed for all groups.
 213 .It Cm DenyUsers
 214 This keyword can be followed by a list of user name patterns, separated
 215 by spaces.
 216 Login is disallowed for user names that match one of the patterns.
 217 .Ql \&*
 218 and
 219 .Ql \&?
 220 can be used as wildcards in the patterns.
 221 Only user names are valid; a numerical user ID is not recognized.
 222 By default, login is allowed for all users.
 223 If the pattern takes the form USER@HOST then USER and HOST
 224 are separately checked, restricting logins to particular
 225 users from particular hosts.
 226 .It Cm GatewayPorts
 227 Specifies whether remote hosts are allowed to connect to ports
 228 forwarded for the client.
 229 By default,
 230 .Nm sshd
 231 binds remote port forwardings to the loopback address.
 232 This prevents other remote hosts from connecting to forwarded ports.
 233 .Cm GatewayPorts
 234 can be used to specify that
 235 .Nm sshd
 236 should bind remote port forwardings to the wildcard address,
 237 thus allowing remote hosts to connect to forwarded ports.
 238 The argument must be
 239 .Dq yes
 240 or
 241 .Dq no .
 242 The default is
 243 .Dq no .
 244 .It Cm GSSAPIAuthentication
 245 Specifies whether user authentication based on GSSAPI is allowed.
 246 The default is
 247 .Dq no .
 248 Note that this option applies to protocol version 2 only.
 249 .It Cm GSSAPICleanupCredentials
 250 Specifies whether to automatically destroy the user's credentials cache
 251 on logout.
 252 The default is
 253 .Dq yes .
 254 Note that this option applies to protocol version 2 only.
 255 .It Cm HostbasedAuthentication
 256 Specifies whether rhosts or /etc/hosts.equiv authentication together
 257 with successful public key client host authentication is allowed
 258 (hostbased authentication).
 259 This option is similar to
 260 .Cm RhostsRSAAuthentication
 261 and applies to protocol version 2 only.
 262 The default is
 263 .Dq no .
 264 .It Cm HostKey
 265 Specifies a file containing a private host key
 266 used by SSH.
 267 The default is
 268 .Pa /etc/ssh/ssh_host_key
 269 for protocol version 1, and
 270 .Pa /etc/ssh/ssh_host_rsa_key
 271 and
 272 .Pa /etc/ssh/ssh_host_dsa_key
 273 for protocol version 2.
 274 Note that
 275 .Nm sshd
 276 will refuse to use a file if it is group/world-accessible.
 277 It is possible to have multiple host key files.
 278 .Dq rsa1
 279 keys are used for version 1 and
 280 .Dq dsa
 281 or
 282 .Dq rsa
 283 are used for version 2 of the SSH protocol.
 284 .It Cm IgnoreRhosts
 285 Specifies that
 286 .Pa .rhosts
 287 and
 288 .Pa .shosts
 289 files will not be used in
 290 .Cm RhostsRSAAuthentication
 291 or
 292 .Cm HostbasedAuthentication .
 293 .Pp
 294 .Pa /etc/hosts.equiv
 295 and
 296 .Pa /etc/shosts.equiv
 297 are still used.
 298 The default is
 299 .Dq yes .
 300 .It Cm IgnoreUserKnownHosts
 301 Specifies whether
 302 .Nm sshd
 303 should ignore the user's
 304 .Pa $HOME/.ssh/known_hosts
 305 during
 306 .Cm RhostsRSAAuthentication
 307 or
 308 .Cm HostbasedAuthentication .
 309 The default is
 310 .Dq no .
 311 .It Cm KerberosAuthentication
 312 Specifies whether the password provided by the user for
 313 .Cm PasswordAuthentication
 314 will be validated through the Kerberos KDC.
 315 To use this option, the server needs a
 316 Kerberos servtab which allows the verification of the KDC's identity.
 317 Default is
 318 .Dq no .
 319 .It Cm KerberosGetAFSToken
 320 If AFS is active and the user has a Kerberos 5 TGT, attempt to aquire
 321 an AFS token before accessing the user's home directory.
 322 Default is
 323 .Dq no .
 324 .It Cm KerberosOrLocalPasswd
 325 If set then if password authentication through Kerberos fails then
 326 the password will be validated via any additional local mechanism
 327 such as
 328 .Pa /etc/passwd .
 329 Default is
 330 .Dq yes .
 331 .It Cm KerberosTicketCleanup
 332 Specifies whether to automatically destroy the user's ticket cache
 333 file on logout.
 334 Default is
 335 .Dq yes .
 336 .It Cm KeyRegenerationInterval
 337 In protocol version 1, the ephemeral server key is automatically regenerated
 338 after this many seconds (if it has been used).
 339 The purpose of regeneration is to prevent
 340 decrypting captured sessions by later breaking into the machine and
 341 stealing the keys.
 342 The key is never stored anywhere.
 343 If the value is 0, the key is never regenerated.
 344 The default is 3600 (seconds).
 345 .It Cm ListenAddress
 346 Specifies the local addresses
 347 .Nm sshd
 348 should listen on.
 349 The following forms may be used:
 350 .Pp
 351 .Bl -item -offset indent -compact
 352 .It
 353 .Cm ListenAddress
 354 .Sm off
 355 .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
 356 .Sm on
 357 .It
 358 .Cm ListenAddress
 359 .Sm off
 360 .Ar host No | Ar IPv4_addr No : Ar port
 361 .Sm on
 362 .It
 363 .Cm ListenAddress
 364 .Sm off
 365 .Oo
 366 .Ar host No | Ar IPv6_addr Oc : Ar port
 367 .Sm on
 368 .El
 369 .Pp
 370 If
 371 .Ar port
 372 is not specified,
 373 .Nm sshd
 374 will listen on the address and all prior
 375 .Cm Port
 376 options specified.
 377 The default is to listen on all local addresses.
 378 Multiple
 379 .Cm ListenAddress
 380 options are permitted.
 381 Additionally, any
 382 .Cm Port
 383 options must precede this option for non port qualified addresses.
 384 .It Cm LoginGraceTime
 385 The server disconnects after this time if the user has not
 386 successfully logged in.
 387 If the value is 0, there is no time limit.
 388 The default is 120 seconds.
 389 .It Cm LogLevel
 390 Gives the verbosity level that is used when logging messages from
 391 .Nm sshd .
 392 The possible values are:
 393 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
 394 The default is INFO.
 395 DEBUG and DEBUG1 are equivalent.
 396 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
 397 Logging with a DEBUG level violates the privacy of users and is not recommended.
 398 .It Cm MACs
 399 Specifies the available MAC (message authentication code) algorithms.
 400 The MAC algorithm is used in protocol version 2
 401 for data integrity protection.
 402 Multiple algorithms must be comma-separated.
 403 The default is
 404 .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
 405 .It Cm MaxStartups
 406 Specifies the maximum number of concurrent unauthenticated connections to the
 407 .Nm sshd
 408 daemon.
 409 Additional connections will be dropped until authentication succeeds or the
 410 .Cm LoginGraceTime
 411 expires for a connection.
 412 The default is 10.
 413 .Pp
 414 Alternatively, random early drop can be enabled by specifying
 415 the three colon separated values
 416 .Dq start:rate:full
 417 (e.g., "10:30:60").
 418 .Nm sshd
 419 will refuse connection attempts with a probability of
 420 .Dq rate/100
 421 (30%)
 422 if there are currently
 423 .Dq start
 424 (10)
 425 unauthenticated connections.
 426 The probability increases linearly and all connection attempts
 427 are refused if the number of unauthenticated connections reaches
 428 .Dq full
 429 (60).
 430 .It Cm PasswordAuthentication
 431 Specifies whether password authentication is allowed.
 432 The default is
 433 .Dq yes .
 434 .It Cm PermitEmptyPasswords
 435 When password authentication is allowed, it specifies whether the
 436 server allows login to accounts with empty password strings.
 437 The default is
 438 .Dq no .
 439 .It Cm PermitRootLogin
 440 Specifies whether root can login using
 441 .Xr ssh 1 .
 442 The argument must be
 443 .Dq yes ,
 444 .Dq without-password ,
 445 .Dq forced-commands-only
 446 or
 447 .Dq no .
 448 The default is
 449 .Dq yes .
 450 .Pp
 451 If this option is set to
 452 .Dq without-password
 453 password authentication is disabled for root.  Note that other authentication
 454 methods (e.g., keyboard-interactive/PAM) may still allow root to login using
 455 a password.
 456 .Pp
 457 If this option is set to
 458 .Dq forced-commands-only
 459 root login with public key authentication will be allowed,
 460 but only if the
 461 .Ar command
 462 option has been specified
 463 (which may be useful for taking remote backups even if root login is
 464 normally not allowed).
 465 All other authentication methods are disabled for root.
 466 .Pp
 467 If this option is set to
 468 .Dq no
 469 root is not allowed to login.
 470 .It Cm PermitUserEnvironment
 471 Specifies whether
 472 .Pa ~/.ssh/environment
 473 and
 474 .Cm environment=
 475 options in
 476 .Pa ~/.ssh/authorized_keys
 477 are processed by
 478 .Nm sshd .
 479 The default is
 480 .Dq no .
 481 Enabling environment processing may enable users to bypass access
 482 restrictions in some configurations using mechanisms such as
 483 .Ev LD_PRELOAD .
 484 .It Cm PidFile
 485 Specifies the file that contains the process ID of the
 486 .Nm sshd
 487 daemon.
 488 The default is
 489 .Pa /var/run/sshd.pid .
 490 .It Cm Port
 491 Specifies the port number that
 492 .Nm sshd
 493 listens on.
 494 The default is 22.
 495 Multiple options of this type are permitted.
 496 See also
 497 .Cm ListenAddress .
 498 .It Cm PrintLastLog
 499 Specifies whether
 500 .Nm sshd
 501 should print the date and time when the user last logged in.
 502 The default is
 503 .Dq yes .
 504 .It Cm PrintMotd
 505 Specifies whether
 506 .Nm sshd
 507 should print
 508 .Pa /etc/motd
 509 when a user logs in interactively.
 510 (On some systems it is also printed by the shell,
 511 .Pa /etc/profile ,
 512 or equivalent.)
 513 The default is
 514 .Dq yes .
 515 .It Cm Protocol
 516 Specifies the protocol versions
 517 .Nm sshd
 518 supports.
 519 The possible values are
 520 .Dq 1
 521 and
 522 .Dq 2 .
 523 Multiple versions must be comma-separated.
 524 The default is
 525 .Dq 2,1 .
 526 Note that the order of the protocol list does not indicate preference,
 527 because the client selects among multiple protocol versions offered
 528 by the server.
 529 Specifying
 530 .Dq 2,1
 531 is identical to
 532 .Dq 1,2 .
 533 .It Cm PubkeyAuthentication
 534 Specifies whether public key authentication is allowed.
 535 The default is
 536 .Dq yes .
 537 Note that this option applies to protocol version 2 only.
 538 .It Cm RhostsRSAAuthentication
 539 Specifies whether rhosts or /etc/hosts.equiv authentication together
 540 with successful RSA host authentication is allowed.
 541 The default is
 542 .Dq no .
 543 This option applies to protocol version 1 only.
 544 .It Cm RSAAuthentication
 545 Specifies whether pure RSA authentication is allowed.
 546 The default is
 547 .Dq yes .
 548 This option applies to protocol version 1 only.
 549 .It Cm ServerKeyBits
 550 Defines the number of bits in the ephemeral protocol version 1 server key.
 551 The minimum value is 512, and the default is 768.
 552 .It Cm StrictModes
 553 Specifies whether
 554 .Nm sshd
 555 should check file modes and ownership of the
 556 user's files and home directory before accepting login.
 557 This is normally desirable because novices sometimes accidentally leave their
 558 directory or files world-writable.
 559 The default is
 560 .Dq yes .
 561 .It Cm Subsystem
 562 Configures an external subsystem (e.g., file transfer daemon).
 563 Arguments should be a subsystem name and a command to execute upon subsystem
 564 request.
 565 The command
 566 .Xr sftp-server 8
 567 implements the
 568 .Dq sftp
 569 file transfer subsystem.
 570 By default no subsystems are defined.
 571 Note that this option applies to protocol version 2 only.
 572 .It Cm SyslogFacility
 573 Gives the facility code that is used when logging messages from
 574 .Nm sshd .
 575 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
 576 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
 577 The default is AUTH.
 578 .It Cm TCPKeepAlive
 579 Specifies whether the system should send TCP keepalive messages to the
 580 other side.
 581 If they are sent, death of the connection or crash of one
 582 of the machines will be properly noticed.
 583 However, this means that
 584 connections will die if the route is down temporarily, and some people
 585 find it annoying.
 586 On the other hand, if TCP keepalives are not sent,
 587 sessions may hang indefinitely on the server, leaving
 588 .Dq ghost
 589 users and consuming server resources.
 590 .Pp
 591 The default is
 592 .Dq yes
 593 (to send TCP keepalive messages), and the server will notice
 594 if the network goes down or the client host crashes.
 595 This avoids infinitely hanging sessions.
 596 .Pp
 597 To disable TCP keepalive messages, the value should be set to
 598 .Dq no .
 599 .It Cm UseDNS
 600 Specifies whether
 601 .Nm sshd
 602 should lookup the remote host name and check that
 603 the resolved host name for the remote IP address maps back to the
 604 very same IP address.
 605 The default is
 606 .Dq yes .
 607 .It Cm UseLogin
 608 Specifies whether
 609 .Xr login 1
 610 is used for interactive login sessions.
 611 The default is
 612 .Dq no .
 613 Note that
 614 .Xr login 1
 615 is never used for remote command execution.
 616 Note also, that if this is enabled,
 617 .Cm X11Forwarding
 618 will be disabled because
 619 .Xr login 1
 620 does not know how to handle
 621 .Xr xauth 1
 622 cookies.
 623 If
 624 .Cm UsePrivilegeSeparation
 625 is specified, it will be disabled after authentication.
 626 .It Cm UsePAM
 627 Enables the Pluggable Authentication Module interface.
 628 If set to
 629 .Dq yes
 630 this will enable PAM authentication using
 631 .Cm ChallengeResponseAuthentication
 632 and PAM account and session module processing for all authentication types.
 633 .Pp
 634 Because PAM challenge-response authentication usually serves an equivalent
 635 role to password authentication, you should disable either
 636 .Cm PasswordAuthentication
 637 or
 638 .Cm ChallengeResponseAuthentication.
 639 .Pp
 640 If
 641 .Cm UsePAM
 642 is enabled, you will not be able to run
 643 .Xr sshd 8
 644 as a non-root user.
 645 The default is
 646 .Dq no .
 647 .It Cm UsePrivilegeSeparation
 648 Specifies whether
 649 .Nm sshd
 650 separates privileges by creating an unprivileged child process
 651 to deal with incoming network traffic.
 652 After successful authentication, another process will be created that has
 653 the privilege of the authenticated user.
 654 The goal of privilege separation is to prevent privilege
 655 escalation by containing any corruption within the unprivileged processes.
 656 The default is
 657 .Dq yes .
 658 .It Cm X11DisplayOffset
 659 Specifies the first display number available for
 660 .Nm sshd Ns 's
 661 X11 forwarding.
 662 This prevents
 663 .Nm sshd
 664 from interfering with real X11 servers.
 665 The default is 10.
 666 .It Cm X11Forwarding
 667 Specifies whether X11 forwarding is permitted.
 668 The argument must be
 669 .Dq yes
 670 or
 671 .Dq no .
 672 The default is
 673 .Dq no .
 674 .Pp
 675 When X11 forwarding is enabled, there may be additional exposure to
 676 the server and to client displays if the
 677 .Nm sshd
 678 proxy display is configured to listen on the wildcard address (see
 679 .Cm X11UseLocalhost
 680 below), however this is not the default.
 681 Additionally, the authentication spoofing and authentication data
 682 verification and substitution occur on the client side.
 683 The security risk of using X11 forwarding is that the client's X11
 684 display server may be exposed to attack when the ssh client requests
 685 forwarding (see the warnings for
 686 .Cm ForwardX11
 687 in
 688 .Xr ssh_config 5 ) .
 689 A system administrator may have a stance in which they want to
 690 protect clients that may expose themselves to attack by unwittingly
 691 requesting X11 forwarding, which can warrant a
 692 .Dq no
 693 setting.
 694 .Pp
 695 Note that disabling X11 forwarding does not prevent users from
 696 forwarding X11 traffic, as users can always install their own forwarders.
 697 X11 forwarding is automatically disabled if
 698 .Cm UseLogin
 699 is enabled.
 700 .It Cm X11UseLocalhost
 701 Specifies whether
 702 .Nm sshd
 703 should bind the X11 forwarding server to the loopback address or to
 704 the wildcard address.
 705 By default,
 706 .Nm sshd
 707 binds the forwarding server to the loopback address and sets the
 708 hostname part of the
 709 .Ev DISPLAY
 710 environment variable to
 711 .Dq localhost .
 712 This prevents remote hosts from connecting to the proxy display.
 713 However, some older X11 clients may not function with this
 714 configuration.
 715 .Cm X11UseLocalhost
 716 may be set to
 717 .Dq no
 718 to specify that the forwarding server should be bound to the wildcard
 719 address.
 720 The argument must be
 721 .Dq yes
 722 or
 723 .Dq no .
 724 The default is
 725 .Dq yes .
 726 .It Cm XAuthLocation
 727 Specifies the full pathname of the
 728 .Xr xauth 1
 729 program.
 730 The default is
 731 .Pa /usr/X11R6/bin/xauth .
 732 .El
 733 .Ss Time Formats
 734 .Nm sshd
 735 command-line arguments and configuration file options that specify time
 736 may be expressed using a sequence of the form:
 737 .Sm off
 738 .Ar time Op Ar qualifier ,
 739 .Sm on
 740 where
 741 .Ar time
 742 is a positive integer value and
 743 .Ar qualifier
 744 is one of the following:
 745 .Pp
 746 .Bl -tag -width Ds -compact -offset indent
 747 .It Cm <none>
 748 seconds
 749 .It Cm s | Cm S
 750 seconds
 751 .It Cm m | Cm M
 752 minutes
 753 .It Cm h | Cm H
 754 hours
 755 .It Cm d | Cm D
 756 days
 757 .It Cm w | Cm W
 758 weeks
 759 .El
 760 .Pp
 761 Each member of the sequence is added together to calculate
 762 the total time value.
 763 .Pp
 764 Time format examples:
 765 .Pp
 766 .Bl -tag -width Ds -compact -offset indent
 767 .It 600
 768 600 seconds (10 minutes)
 769 .It 10m
 770 10 minutes
 771 .It 1h30m
 772 1 hour 30 minutes (90 minutes)
 773 .El
 774 .Sh FILES
 775 .Bl -tag -width Ds
 776 .It Pa /etc/ssh/sshd_config
 777 Contains configuration data for
 778 .Nm sshd .
 779 This file should be writable by root only, but it is recommended
 780 (though not necessary) that it be world-readable.
 781 .El
 782 .Sh SEE ALSO
 783 .Xr sshd 8
 784 .Sh AUTHORS
 785 OpenSSH is a derivative of the original and free
 786 ssh 1.2.12 release by Tatu Ylonen.
 787 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
 788 Theo de Raadt and Dug Song
 789 removed many bugs, re-added newer features and
 790 created OpenSSH.
 791 Markus Friedl contributed the support for SSH
 792 protocol versions 1.5 and 2.0.
 793 Niels Provos and Markus Friedl contributed support
 794 for privilege separation.