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