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