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