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.35 2004/06/26 09:14:40 jmc Exp $
  38 .Dd September 25, 1999
  39 .Dt SSHD_CONFIG 5
  40 .Os
  41 .Sh NAME
  42 .Nm sshd_config
  43 .Nd OpenSSH SSH daemon configuration file
  44 .Sh SYNOPSIS
  45 .Bl -tag -width Ds -compact
  46 .It Pa /etc/ssh/sshd_config
  47 .El
  48 .Sh DESCRIPTION
  49 .Nm sshd
  50 reads configuration data from
  51 .Pa /etc/ssh/sshd_config
  52 (or the file specified with
  53 .Fl f
  54 on the command line).
  55 The file contains keyword-argument pairs, one per line.
  56 Lines starting with
  57 .Ql #
  58 and empty lines are interpreted as comments.
  59 .Pp
  60 The possible
  61 keywords and their meanings are as follows (note that
  62 keywords are case-insensitive and arguments are case-sensitive):
  63 .Bl -tag -width Ds
  64 .It Cm AcceptEnv
  65 Specifies what environment variables sent by the client will be copied into
  66 the session's
  67 .Xr environ 7 .
  68 See
  69 .Cm SendEnv
  70 in
  71 .Xr ssh_config 5
  72 for how to configure the client.
  73 Note that environment passing is only supported for protocol 2.
  74 Variables are specified by name, which may contain the wildcard characters
  75 .Ql \&*
  76 and
  77 .Ql \&? .
  78 Multiple environment variables may be separated by whitespace or spread
  79 across multiple
  80 .Cm AcceptEnv
  81 directives.
  82 Be warned that some environment variables could be used to bypass restricted
  83 user environments.
  84 For this reason, care should be taken in the use of this directive.
  85 The default is not to accept any environment variables.
  86 .It Cm AllowGroups
  87 This keyword can be followed by a list of group name patterns, separated
  88 by spaces.
  89 If specified, login is allowed only for users whose primary
  90 group or supplementary group list matches one of the patterns.
  91 .Ql \&*
  92 and
  93 .Ql \&?
  94 can be used as
  95 wildcards in the patterns.
  96 Only group names are valid; a numerical group ID is not recognized.
  97 By default, login is allowed for all groups.
  98 .It Cm AllowTcpForwarding
  99 Specifies whether TCP forwarding is permitted.
 100 The default is
 101 .Dq yes .
 102 Note that disabling TCP forwarding does not improve security unless
 103 users are also denied shell access, as they can always install their
 104 own forwarders.
 105 .It Cm AllowUsers
 106 This keyword can be followed by a list of user name patterns, separated
 107 by spaces.
 108 If specified, login is allowed only for user names that
 109 match one of the patterns.
 110 .Ql \&*
 111 and
 112 .Ql \&?
 113 can be used as
 114 wildcards in the patterns.
 115 Only user names are valid; a numerical user ID is not recognized.
 116 By default, login is allowed for all users.
 117 If the pattern takes the form USER@HOST then USER and HOST
 118 are separately checked, restricting logins to particular
 119 users from particular hosts.
 120 .It Cm AuthorizedKeysFile
 121 Specifies the file that contains the public keys that can be used
 122 for user authentication.
 123 .Cm AuthorizedKeysFile
 124 may contain tokens of the form %T which are substituted during connection
 125 set-up.
 126 The following tokens are defined: %% is replaced by a literal '%',
 127 %h is replaced by the home directory of the user being authenticated and
 128 %u is replaced by the username of that user.
 129 After expansion,
 130 .Cm AuthorizedKeysFile
 131 is taken to be an absolute path or one relative to the user's home
 132 directory.
 133 The default is
 134 .Dq .ssh/authorized_keys .
 135 .It Cm Banner
 136 In some jurisdictions, sending a warning message before authentication
 137 may be relevant for getting legal protection.
 138 The contents of the specified file are sent to the remote user before
 139 authentication is allowed.
 140 This option is only available for protocol version 2.
 141 By default, no banner is displayed.
 142 .It Cm ChallengeResponseAuthentication
 143 Specifies whether challenge response authentication is allowed.
 144 All authentication styles from
 145 .Xr login.conf 5
 146 are supported.
 147 The default is
 148 .Dq yes .
 149 .It Cm Ciphers
 150 Specifies the ciphers allowed for protocol version 2.
 151 Multiple ciphers must be comma-separated.
 152 The supported ciphers are
 153 .Dq 3des-cbc ,
 154 .Dq aes128-cbc ,
 155 .Dq aes192-cbc ,
 156 .Dq aes256-cbc ,
 157 .Dq aes128-ctr ,
 158 .Dq aes192-ctr ,
 159 .Dq aes256-ctr ,
 160 .Dq arcfour ,
 161 .Dq blowfish-cbc ,
 162 and
 163 .Dq cast128-cbc .
 164 The default is
 165 .Bd -literal
 166   ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
 167     aes192-cbc,aes256-cbc,aes128-ctr,aes192-ctr,aes256-ctr''
 168 .Ed
 169 .It Cm ClientAliveInterval
 170 Sets a timeout interval in seconds after which if no data has been received
 171 from the client,
 172 .Nm sshd
 173 will send a message through the encrypted
 174 channel to request a response from the client.
 175 The default
 176 is 0, indicating that these messages will not be sent to the client.
 177 This option applies to protocol version 2 only.
 178 .It Cm ClientAliveCountMax
 179 Sets the number of client alive messages (see above) which may be
 180 sent without
 181 .Nm sshd
 182 receiving any messages back from the client.
 183 If this threshold is reached while client alive messages are being sent,
 184 .Nm sshd
 185 will disconnect the client, terminating the session.
 186 It is important to note that the use of client alive messages is very
 187 different from
 188 .Cm TCPKeepAlive
 189 (below).
 190 The client alive messages are sent through the encrypted channel
 191 and therefore will not be spoofable.
 192 The TCP keepalive option enabled by
 193 .Cm TCPKeepAlive
 194 is spoofable.
 195 The client alive mechanism is valuable when the client or
 196 server depend on knowing when a connection has become inactive.
 197 .Pp
 198 The default value is 3.
 199 If
 200 .Cm ClientAliveInterval
 201 (above) is set to 15, and
 202 .Cm ClientAliveCountMax
 203 is left at the default, unresponsive ssh clients
 204 will be disconnected after approximately 45 seconds.
 205 .It Cm Compression
 206 Specifies whether compression is allowed.
 207 The argument must be
 208 .Dq yes
 209 or
 210 .Dq no .
 211 The default is
 212 .Dq yes .
 213 .It Cm DenyGroups
 214 This keyword can be followed by a list of group name patterns, separated
 215 by spaces.
 216 Login is disallowed for users whose primary group or supplementary
 217 group list matches one of the patterns.
 218 .Ql \&*
 219 and
 220 .Ql \&?
 221 can be used as
 222 wildcards in the patterns.
 223 Only group names are valid; a numerical group ID is not recognized.
 224 By default, login is allowed for all groups.
 225 .It Cm DenyUsers
 226 This keyword can be followed by a list of user name patterns, separated
 227 by spaces.
 228 Login is disallowed for user names that match one of the patterns.
 229 .Ql \&*
 230 and
 231 .Ql \&?
 232 can be used as wildcards in the patterns.
 233 Only user names are valid; a numerical user ID is not recognized.
 234 By default, login is allowed for all users.
 235 If the pattern takes the form USER@HOST then USER and HOST
 236 are separately checked, restricting logins to particular
 237 users from particular hosts.
 238 .It Cm GatewayPorts
 239 Specifies whether remote hosts are allowed to connect to ports
 240 forwarded for the client.
 241 By default,
 242 .Nm sshd
 243 binds remote port forwardings to the loopback address.
 244 This prevents other remote hosts from connecting to forwarded ports.
 245 .Cm GatewayPorts
 246 can be used to specify that
 247 .Nm sshd
 248 should bind remote port forwardings to the wildcard address,
 249 thus allowing remote hosts to connect to forwarded ports.
 250 The argument must be
 251 .Dq yes
 252 or
 253 .Dq no .
 254 The default is
 255 .Dq no .
 256 .It Cm GSSAPIAuthentication
 257 Specifies whether user authentication based on GSSAPI is allowed.
 258 The default is
 259 .Dq yes .
 260 Note that this option applies to protocol version 2 only.
 261 .It Cm GSSAPICleanupCredentials
 262 Specifies whether to automatically destroy the user's credentials cache
 263 on logout.
 264 The default is
 265 .Dq yes .
 266 Note that this option applies to protocol version 2 only.
 267 .It Cm GSSAPIKeyExchange
 268 Specifies whether key exchange based on GSSAPI may be used. When using
 269 GSSAPI key exchange the server need not have a host key.
 270 The default is
 271 .Dq yes .
 272 Note that this option applies to protocol version 2 only.
 273 .It Cm GSSAPIUseSessionCredCache
 274 Specifies whether a unique credentials cache name should be generated per
 275 session for storing delegated credentials.
 276 The default is
 277 .Dq yes .
 278 Note that this option applies to protocol version 2 only.
 279 .It Cm HostbasedAuthentication
 280 Specifies whether rhosts or /etc/hosts.equiv authentication together
 281 with successful public key client host authentication is allowed
 282 (hostbased authentication).
 283 This option is similar to
 284 .Cm RhostsRSAAuthentication
 285 and applies to protocol version 2 only.
 286 The default is
 287 .Dq no .
 288 .It Cm HostKey
 289 Specifies a file containing a private host key
 290 used by SSH.
 291 The default is
 292 .Pa /etc/ssh/ssh_host_key
 293 for protocol version 1, and
 294 .Pa /etc/ssh/ssh_host_rsa_key
 295 and
 296 .Pa /etc/ssh/ssh_host_dsa_key
 297 for protocol version 2.
 298 Note that
 299 .Nm sshd
 300 will refuse to use a file if it is group/world-accessible.
 301 It is possible to have multiple host key files.
 302 .Dq rsa1
 303 keys are used for version 1 and
 304 .Dq dsa
 305 or
 306 .Dq rsa
 307 are used for version 2 of the SSH protocol.
 308 .It Cm IgnoreRhosts
 309 Specifies that
 310 .Pa .rhosts
 311 and
 312 .Pa .shosts
 313 files will not be used in
 314 .Cm RhostsRSAAuthentication
 315 or
 316 .Cm HostbasedAuthentication .
 317 .Pp
 318 .Pa /etc/hosts.equiv
 319 and
 320 .Pa /etc/shosts.equiv
 321 are still used.
 322 The default is
 323 .Dq yes .
 324 .It Cm IgnoreUserKnownHosts
 325 Specifies whether
 326 .Nm sshd
 327 should ignore the user's
 328 .Pa $HOME/.ssh/known_hosts
 329 during
 330 .Cm RhostsRSAAuthentication
 331 or
 332 .Cm HostbasedAuthentication .
 333 The default is
 334 .Dq no .
 335 .It Cm KerberosAuthentication
 336 Specifies whether the password provided by the user for
 337 .Cm PasswordAuthentication
 338 will be validated through the Kerberos KDC.
 339 To use this option, the server needs a
 340 Kerberos servtab which allows the verification of the KDC's identity.
 341 Default is
 342 .Dq no .
 343 .It Cm KerberosGetAFSToken
 344 If AFS is active and the user has a Kerberos 5 TGT, attempt to aquire
 345 an AFS token before accessing the user's home directory.
 346 Default is
 347 .Dq no .
 348 .It Cm KerberosOrLocalPasswd
 349 If set then if password authentication through Kerberos fails then
 350 the password will be validated via any additional local mechanism
 351 such as
 352 .Pa /etc/passwd .
 353 Default is
 354 .Dq yes .
 355 .It Cm KerberosTicketCleanup
 356 Specifies whether to automatically destroy the user's ticket cache
 357 file on logout.
 358 Default is
 359 .Dq yes .
 360 .It Cm KeyRegenerationInterval
 361 In protocol version 1, the ephemeral server key is automatically regenerated
 362 after this many seconds (if it has been used).
 363 The purpose of regeneration is to prevent
 364 decrypting captured sessions by later breaking into the machine and
 365 stealing the keys.
 366 The key is never stored anywhere.
 367 If the value is 0, the key is never regenerated.
 368 The default is 3600 (seconds).
 369 .It Cm ListenAddress
 370 Specifies the local addresses
 371 .Nm sshd
 372 should listen on.
 373 The following forms may be used:
 374 .Pp
 375 .Bl -item -offset indent -compact
 376 .It
 377 .Cm ListenAddress
 378 .Sm off
 379 .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
 380 .Sm on
 381 .It
 382 .Cm ListenAddress
 383 .Sm off
 384 .Ar host No | Ar IPv4_addr No : Ar port
 385 .Sm on
 386 .It
 387 .Cm ListenAddress
 388 .Sm off
 389 .Oo
 390 .Ar host No | Ar IPv6_addr Oc : Ar port
 391 .Sm on
 392 .El
 393 .Pp
 394 If
 395 .Ar port
 396 is not specified,
 397 .Nm sshd
 398 will listen on the address and all prior
 399 .Cm Port
 400 options specified.
 401 The default is to listen on all local addresses.
 402 Multiple
 403 .Cm ListenAddress
 404 options are permitted.
 405 Additionally, any
 406 .Cm Port
 407 options must precede this option for non port qualified addresses.
 408 .It Cm LoginGraceTime
 409 The server disconnects after this time if the user has not
 410 successfully logged in.
 411 If the value is 0, there is no time limit.
 412 The default is 120 seconds.
 413 .It Cm LogLevel
 414 Gives the verbosity level that is used when logging messages from
 415 .Nm sshd .
 416 The possible values are:
 417 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
 418 The default is INFO.
 419 DEBUG and DEBUG1 are equivalent.
 420 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
 421 Logging with a DEBUG level violates the privacy of users and is not recommended.
 422 .It Cm MACs
 423 Specifies the available MAC (message authentication code) algorithms.
 424 The MAC algorithm is used in protocol version 2
 425 for data integrity protection.
 426 Multiple algorithms must be comma-separated.
 427 The default is
 428 .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
 429 .It Cm MaxAuthTries
 430 Specifies the maximum number of authentication attempts permitted per
 431 connection.
 432 Once the number of failures reaches half this value,
 433 additional failures are logged.
 434 The default is 6.
 435 .It Cm MaxStartups
 436 Specifies the maximum number of concurrent unauthenticated connections to the
 437 .Nm sshd
 438 daemon.
 439 Additional connections will be dropped until authentication succeeds or the
 440 .Cm LoginGraceTime
 441 expires for a connection.
 442 The default is 10.
 443 .Pp
 444 Alternatively, random early drop can be enabled by specifying
 445 the three colon separated values
 446 .Dq start:rate:full
 447 (e.g., "10:30:60").
 448 .Nm sshd
 449 will refuse connection attempts with a probability of
 450 .Dq rate/100
 451 (30%)
 452 if there are currently
 453 .Dq start
 454 (10)
 455 unauthenticated connections.
 456 The probability increases linearly and all connection attempts
 457 are refused if the number of unauthenticated connections reaches
 458 .Dq full
 459 (60).
 460 .It Cm PasswordAuthentication
 461 Specifies whether password authentication is allowed.
 462 The default is
 463 .Dq yes .
 464 .It Cm PermitEmptyPasswords
 465 When password authentication is allowed, it specifies whether the
 466 server allows login to accounts with empty password strings.
 467 The default is
 468 .Dq no .
 469 .It Cm PermitRootLogin
 470 Specifies whether root can login using
 471 .Xr ssh 1 .
 472 The argument must be
 473 .Dq yes ,
 474 .Dq without-password ,
 475 .Dq forced-commands-only
 476 or
 477 .Dq no .
 478 The default is
 479 .Dq yes .
 480 .Pp
 481 If this option is set to
 482 .Dq without-password
 483 password authentication is disabled for root.  Note that other authentication
 484 methods (e.g., keyboard-interactive/PAM) may still allow root to login using
 485 a password.
 486 .Pp
 487 If this option is set to
 488 .Dq forced-commands-only
 489 root login with public key authentication will be allowed,
 490 but only if the
 491 .Ar command
 492 option has been specified
 493 (which may be useful for taking remote backups even if root login is
 494 normally not allowed).
 495 All other authentication methods are disabled for root.
 496 .Pp
 497 If this option is set to
 498 .Dq no
 499 root is not allowed to login.
 500 .It Cm PermitUserEnvironment
 501 Specifies whether
 502 .Pa ~/.ssh/environment
 503 and
 504 .Cm environment=
 505 options in
 506 .Pa ~/.ssh/authorized_keys
 507 are processed by
 508 .Nm sshd .
 509 The default is
 510 .Dq no .
 511 Enabling environment processing may enable users to bypass access
 512 restrictions in some configurations using mechanisms such as
 513 .Ev LD_PRELOAD .
 514 .It Cm PidFile
 515 Specifies the file that contains the process ID of the
 516 .Nm sshd
 517 daemon.
 518 The default is
 519 .Pa /var/run/sshd.pid .
 520 .It Cm Port
 521 Specifies the port number that
 522 .Nm sshd
 523 listens on.
 524 The default is 22.
 525 Multiple options of this type are permitted.
 526 See also
 527 .Cm ListenAddress .
 528 .It Cm PrintLastLog
 529 Specifies whether
 530 .Nm sshd
 531 should print the date and time when the user last logged in.
 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.