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