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