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