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