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