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.84 2008/03/25 11:58:02 djm Exp $
  38 .Dd $Mdocdate: March 27 2008 $
  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 .Nm /etc/ssh/sshd_config
  46 .Sh DESCRIPTION
  47 .Xr sshd 8
  48 reads configuration data from
  49 .Pa /etc/ssh/sshd_config
  50 (or the file specified with
  51 .Fl f
  52 on the command line).
  53 The file contains keyword-argument pairs, one per line.
  54 Lines starting with
  55 .Ql #
  56 and empty lines are interpreted as comments.
  57 Arguments may optionally be enclosed in double quotes
  58 .Pq \&"
  59 in order to represent arguments containing spaces.
  60 .Pp
  61 The possible
  62 keywords and their meanings are as follows (note that
  63 keywords are case-insensitive and arguments are case-sensitive):
  64 .Bl -tag -width Ds
  65 .It Cm AcceptEnv
  66 Specifies what environment variables sent by the client will be copied into
  67 the session's
  68 .Xr environ 7 .
  69 See
  70 .Cm SendEnv
  71 in
  72 .Xr ssh_config 5
  73 for how to configure the client.
  74 Note that environment passing is only supported for protocol 2.
  75 Variables are specified by name, which may contain the wildcard characters
  76 .Ql *
  77 and
  78 .Ql \&? .
  79 Multiple environment variables may be separated by whitespace or spread
  80 across multiple
  81 .Cm AcceptEnv
  82 directives.
  83 Be warned that some environment variables could be used to bypass restricted
  84 user environments.
  85 For this reason, care should be taken in the use of this directive.
  86 The default is not to accept any environment variables.
  87 .It Cm AddressFamily
  88 Specifies which address family should be used by
  89 .Xr sshd 8 .
  90 Valid arguments are
  91 .Dq any ,
  92 .Dq inet
  93 (use IPv4 only), or
  94 .Dq inet6
  95 (use IPv6 only).
  96 The default is
  97 .Dq any .
  98 .It Cm AllowGroups
  99 This keyword can be followed by a list of group name patterns, separated
 100 by spaces.
 101 If specified, login is allowed only for users whose primary
 102 group or supplementary group list matches one of the patterns.
 103 Only group names are valid; a numerical group ID is not recognized.
 104 By default, login is allowed for all groups.
 105 The allow/deny directives are processed in the following order:
 106 .Cm DenyUsers ,
 107 .Cm AllowUsers ,
 108 .Cm DenyGroups ,
 109 and finally
 110 .Cm AllowGroups .
 111 .Pp
 112 See
 113 .Sx PATTERNS
 114 in
 115 .Xr ssh_config 5
 116 for more information on patterns.
 117 .It Cm AllowTcpForwarding
 118 Specifies whether TCP forwarding is permitted.
 119 The default is
 120 .Dq yes .
 121 Note that disabling TCP forwarding does not improve security unless
 122 users are also denied shell access, as they can always install their
 123 own forwarders.
 124 .It Cm AllowUsers
 125 This keyword can be followed by a list of user name patterns, separated
 126 by spaces.
 127 If specified, login is allowed only for user names that
 128 match one of the patterns.
 129 Only user names are valid; a numerical user ID is not recognized.
 130 By default, login is allowed for all users.
 131 If the pattern takes the form USER@HOST then USER and HOST
 132 are separately checked, restricting logins to particular
 133 users from particular hosts.
 134 The allow/deny directives are processed in the following order:
 135 .Cm DenyUsers ,
 136 .Cm AllowUsers ,
 137 .Cm DenyGroups ,
 138 and finally
 139 .Cm AllowGroups .
 140 .Pp
 141 See
 142 .Sx PATTERNS
 143 in
 144 .Xr ssh_config 5
 145 for more information on patterns.
 146 .It Cm AuthorizedKeysFile
 147 Specifies the file that contains the public keys that can be used
 148 for user authentication.
 149 .Cm AuthorizedKeysFile
 150 may contain tokens of the form %T which are substituted during connection
 151 setup.
 152 The following tokens are defined: %% is replaced by a literal '%',
 153 %h is replaced by the home directory of the user being authenticated, and
 154 %u is replaced by the username of that user.
 155 After expansion,
 156 .Cm AuthorizedKeysFile
 157 is taken to be an absolute path or one relative to the user's home
 158 directory.
 159 The default is
 160 .Dq .ssh/authorized_keys .
 161 .It Cm Banner
 162 The contents of the specified file are sent to the remote user before
 163 authentication is allowed.
 164 If the argument is
 165 .Dq none
 166 then no banner is displayed.
 167 This option is only available for protocol version 2.
 168 By default, no banner is displayed.
 169 .It Cm ChallengeResponseAuthentication
 170 Specifies whether challenge-response authentication is allowed.
 171 All authentication styles from
 172 .Xr login.conf 5
 173 are supported.
 174 The default is
 175 .Dq yes .
 176 .It Cm ChrootDirectory
 177 Specifies a path to
 178 .Xr chroot 2
 179 to after authentication.
 180 This path, and all its components, must be root-owned directories that are
 181 not writable by any other user or group.
 182 .Pp
 183 The path may contain the following tokens that are expanded at runtime once
 184 the connecting user has been authenticated: %% is replaced by a literal '%',
 185 %h is replaced by the home directory of the user being authenticated, and
 186 %u is replaced by the username of that user.
 187 .Pp
 188 The
 189 .Cm ChrootDirectory
 190 must contain the necessary files and directories to support the
 191 users' session.
 192 For an interactive session this requires at least a shell, typically
 193 .Xr sh 1 ,
 194 and basic
 195 .Pa /dev
 196 nodes such as
 197 .Xr null 4 ,
 198 .Xr zero 4 ,
 199 .Xr stdin 4 ,
 200 .Xr stdout 4 ,
 201 .Xr stderr 4 ,
 202 .Xr arandom 4
 203 and
 204 .Xr tty 4
 205 devices.
 206 For file transfer sessions using
 207 .Dq sftp ,
 208 no additional configuration of the environment is necessary if the
 209 in-process sftp server is used (see
 210 .Cm Subsystem
 211 for details).
 212 .Pp
 213 The default is not to
 214 .Xr chroot 2 .
 215 .It Cm Ciphers
 216 Specifies the ciphers allowed for protocol version 2.
 217 Multiple ciphers must be comma-separated.
 218 The supported ciphers are
 219 .Dq 3des-cbc ,
 220 .Dq aes128-cbc ,
 221 .Dq aes192-cbc ,
 222 .Dq aes256-cbc ,
 223 .Dq aes128-ctr ,
 224 .Dq aes192-ctr ,
 225 .Dq aes256-ctr ,
 226 .Dq arcfour128 ,
 227 .Dq arcfour256 ,
 228 .Dq arcfour ,
 229 .Dq blowfish-cbc ,
 230 and
 231 .Dq cast128-cbc .
 232 The default is:
 233 .Bd -literal -offset 3n
 234 aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
 235 arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
 236 aes192-ctr,aes256-ctr
 237 .Ed
 238 .It Cm ClientAliveCountMax
 239 Sets the number of client alive messages (see below) which may be
 240 sent without
 241 .Xr sshd 8
 242 receiving any messages back from the client.
 243 If this threshold is reached while client alive messages are being sent,
 244 sshd will disconnect the client, terminating the session.
 245 It is important to note that the use of client alive messages is very
 246 different from
 247 .Cm TCPKeepAlive
 248 (below).
 249 The client alive messages are sent through the encrypted channel
 250 and therefore will not be spoofable.
 251 The TCP keepalive option enabled by
 252 .Cm TCPKeepAlive
 253 is spoofable.
 254 The client alive mechanism is valuable when the client or
 255 server depend on knowing when a connection has become inactive.
 256 .Pp
 257 The default value is 3.
 258 If
 259 .Cm ClientAliveInterval
 260 (see below) is set to 15, and
 261 .Cm ClientAliveCountMax
 262 is left at the default, unresponsive SSH clients
 263 will be disconnected after approximately 45 seconds.
 264 This option applies to protocol version 2 only.
 265 .It Cm ClientAliveInterval
 266 Sets a timeout interval in seconds after which if no data has been received
 267 from the client,
 268 .Xr sshd 8
 269 will send a message through the encrypted
 270 channel to request a response from the client.
 271 The default
 272 is 0, indicating that these messages will not be sent to the client.
 273 This option applies to protocol version 2 only.
 274 .It Cm Compression
 275 Specifies whether compression is allowed, or delayed until
 276 the user has authenticated successfully.
 277 The argument must be
 278 .Dq yes ,
 279 .Dq delayed ,
 280 or
 281 .Dq no .
 282 The default is
 283 .Dq delayed .
 284 .It Cm DenyGroups
 285 This keyword can be followed by a list of group name patterns, separated
 286 by spaces.
 287 Login is disallowed for users whose primary group or supplementary
 288 group list matches one of the patterns.
 289 Only group names are valid; a numerical group ID is not recognized.
 290 By default, login is allowed for all groups.
 291 The allow/deny directives are processed in the following order:
 292 .Cm DenyUsers ,
 293 .Cm AllowUsers ,
 294 .Cm DenyGroups ,
 295 and finally
 296 .Cm AllowGroups .
 297 .Pp
 298 See
 299 .Sx PATTERNS
 300 in
 301 .Xr ssh_config 5
 302 for more information on patterns.
 303 .It Cm DenyUsers
 304 This keyword can be followed by a list of user name patterns, separated
 305 by spaces.
 306 Login is disallowed for user names that match one of the patterns.
 307 Only user names are valid; a numerical user ID is not recognized.
 308 By default, login is allowed for all users.
 309 If the pattern takes the form USER@HOST then USER and HOST
 310 are separately checked, restricting logins to particular
 311 users from particular hosts.
 312 The allow/deny directives are processed in the following order:
 313 .Cm DenyUsers ,
 314 .Cm AllowUsers ,
 315 .Cm DenyGroups ,
 316 and finally
 317 .Cm AllowGroups .
 318 .Pp
 319 See
 320 .Sx PATTERNS
 321 in
 322 .Xr ssh_config 5
 323 for more information on patterns.
 324 .It Cm ForceCommand
 325 Forces the execution of the command specified by
 326 .Cm ForceCommand ,
 327 ignoring any command supplied by the client and
 328 .Pa ~/.ssh/rc
 329 if present.
 330 The command is invoked by using the user's login shell with the -c option.
 331 This applies to shell, command, or subsystem execution.
 332 It is most useful inside a
 333 .Cm Match
 334 block.
 335 The command originally supplied by the client is available in the
 336 .Ev SSH_ORIGINAL_COMMAND
 337 environment variable.
 338 Specifying a command of
 339 .Dq internal-sftp
 340 will force the use of an in-process sftp server that requires no support
 341 files when used with
 342 .Cm ChrootDirectory .
 343 .It Cm GatewayPorts
 344 Specifies whether remote hosts are allowed to connect to ports
 345 forwarded for the client.
 346 By default,
 347 .Xr sshd 8
 348 binds remote port forwardings to the loopback address.
 349 This prevents other remote hosts from connecting to forwarded ports.
 350 .Cm GatewayPorts
 351 can be used to specify that sshd
 352 should allow remote port forwardings to bind to non-loopback addresses, thus
 353 allowing other hosts to connect.
 354 The argument may be
 355 .Dq no
 356 to force remote port forwardings to be available to the local host only,
 357 .Dq yes
 358 to force remote port forwardings to bind to the wildcard address, or
 359 .Dq clientspecified
 360 to allow the client to select the address to which the forwarding is bound.
 361 The default is
 362 .Dq no .
 363 .It Cm GSSAPIAuthentication
 364 Specifies whether user authentication based on GSSAPI is allowed.
 365 The default is
 366 .Dq yes .
 367 Note that this option applies to protocol version 2 only.
 368 .It Cm GSSAPIKeyExchange
 369 Specifies whether key exchange based on GSSAPI is allowed. GSSAPI key exchange
 370 doesn't rely on ssh keys to verify host identity.
 371 The default is
 372 .Dq yes .
 373 Note that this option applies to protocol version 2 only.
 374 .It Cm GSSAPICleanupCredentials
 375 Specifies whether to automatically destroy the user's credentials cache
 376 on logout.
 377 The default is
 378 .Dq yes .
 379 Note that this option applies to protocol version 2 only.
 380 .It Cm GSSAPIStrictAcceptorCheck
 381 Determines whether to be strict about the identity of the GSSAPI acceptor
 382 a client authenticates against. If
 383 .Dq yes
 384 then the client must authenticate against the
 385 .Pa host
 386 service on the current hostname. If
 387 .Dq no
 388 then the client may authenticate against any service key stored in the
 389 machine's default store. This facility is provided to assist with operation
 390 on multi homed machines.
 391 The default is
 392 .Dq yes .
 393 Note that this option applies only to protocol version 2 GSSAPI connections,
 394 and setting it to
 395 .Dq no
 396 may only work with recent Kerberos GSSAPI libraries.
 397 .It Cm GSSAPICredentialsPath
 398 If specified, the delegated GSSAPI credential is stored in the
 399 given path, overwriting any existing credentials.
 400 Paths can be specified with syntax similar to the AuthorizedKeysFile
 401 option (i.e., accepting %h and %u tokens).
 402 When using this option,
 403 setting 'GssapiCleanupCredentials no' is recommended,
 404 so logging out of one session
 405 doesn't remove the credentials in use by another session of
 406 the same user.
 407 Currently only implemented for the GSI mechanism.
 408 .It Cm GSIAllowLimitedProxy
 409 Specifies whether to accept limited proxy credentials for
 410 authentication.
 411 The default is
 412 .Dq no .
 413 .It Cm HostbasedAuthentication
 414 Specifies whether rhosts or /etc/hosts.equiv authentication together
 415 with successful public key client host authentication is allowed
 416 (host-based authentication).
 417 This option is similar to
 418 .Cm RhostsRSAAuthentication
 419 and applies to protocol version 2 only.
 420 The default is
 421 .Dq no .
 422 .It Cm HostbasedUsesNameFromPacketOnly
 423 Specifies whether or not the server will attempt to perform a reverse
 424 name lookup when matching the name in the
 425 .Pa ~/.shosts ,
 426 .Pa ~/.rhosts ,
 427 and
 428 .Pa /etc/hosts.equiv
 429 files during
 430 .Cm HostbasedAuthentication .
 431 A setting of
 432 .Dq yes
 433 means that
 434 .Xr sshd 8
 435 uses the name supplied by the client rather than
 436 attempting to resolve the name from the TCP connection itself.
 437 The default is
 438 .Dq no .
 439 .It Cm HostKey
 440 Specifies a file containing a private host key
 441 used by SSH.
 442 The default is
 443 .Pa /etc/ssh/ssh_host_key
 444 for protocol version 1, and
 445 .Pa /etc/ssh/ssh_host_rsa_key
 446 and
 447 .Pa /etc/ssh/ssh_host_dsa_key
 448 for protocol version 2.
 449 Note that
 450 .Xr sshd 8
 451 will refuse to use a file if it is group/world-accessible.
 452 It is possible to have multiple host key files.
 453 .Dq rsa1
 454 keys are used for version 1 and
 455 .Dq dsa
 456 or
 457 .Dq rsa
 458 are used for version 2 of the SSH protocol.
 459 .It Cm IgnoreRhosts
 460 Specifies that
 461 .Pa .rhosts
 462 and
 463 .Pa .shosts
 464 files will not be used in
 465 .Cm RhostsRSAAuthentication
 466 or
 467 .Cm HostbasedAuthentication .
 468 .Pp
 469 .Pa /etc/hosts.equiv
 470 and
 471 .Pa /etc/shosts.equiv
 472 are still used.
 473 The default is
 474 .Dq yes .
 475 .It Cm IgnoreUserKnownHosts
 476 Specifies whether
 477 .Xr sshd 8
 478 should ignore the user's
 479 .Pa ~/.ssh/known_hosts
 480 during
 481 .Cm RhostsRSAAuthentication
 482 or
 483 .Cm HostbasedAuthentication .
 484 The default is
 485 .Dq no .
 486 .It Cm KerberosAuthentication
 487 Specifies whether the password provided by the user for
 488 .Cm PasswordAuthentication
 489 will be validated through the Kerberos KDC.
 490 To use this option, the server needs a
 491 Kerberos servtab which allows the verification of the KDC's identity.
 492 The default is
 493 .Dq no .
 494 .It Cm KerberosGetAFSToken
 495 If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
 496 an AFS token before accessing the user's home directory.
 497 The default is
 498 .Dq no .
 499 .It Cm KerberosOrLocalPasswd
 500 If password authentication through Kerberos fails then
 501 the password will be validated via any additional local mechanism
 502 such as
 503 .Pa /etc/passwd .
 504 The default is
 505 .Dq yes .
 506 .It Cm KerberosTicketCleanup
 507 Specifies whether to automatically destroy the user's ticket cache
 508 file on logout.
 509 The default is
 510 .Dq yes .
 511 .It Cm KeyRegenerationInterval
 512 In protocol version 1, the ephemeral server key is automatically regenerated
 513 after this many seconds (if it has been used).
 514 The purpose of regeneration is to prevent
 515 decrypting captured sessions by later breaking into the machine and
 516 stealing the keys.
 517 The key is never stored anywhere.
 518 If the value is 0, the key is never regenerated.
 519 The default is 3600 (seconds).
 520 .It Cm ListenAddress
 521 Specifies the local addresses
 522 .Xr sshd 8
 523 should listen on.
 524 The following forms may be used:
 525 .Pp
 526 .Bl -item -offset indent -compact
 527 .It
 528 .Cm ListenAddress
 529 .Sm off
 530 .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
 531 .Sm on
 532 .It
 533 .Cm ListenAddress
 534 .Sm off
 535 .Ar host No | Ar IPv4_addr No : Ar port
 536 .Sm on
 537 .It
 538 .Cm ListenAddress
 539 .Sm off
 540 .Oo
 541 .Ar host No | Ar IPv6_addr Oc : Ar port
 542 .Sm on
 543 .El
 544 .Pp
 545 If
 546 .Ar port
 547 is not specified,
 548 sshd will listen on the address and all prior
 549 .Cm Port
 550 options specified.
 551 The default is to listen on all local addresses.
 552 Multiple
 553 .Cm ListenAddress
 554 options are permitted.
 555 Additionally, any
 556 .Cm Port
 557 options must precede this option for non-port qualified addresses.
 558 .It Cm LoginGraceTime
 559 The server disconnects after this time if the user has not
 560 successfully logged in.
 561 If the value is 0, there is no time limit.
 562 The default is 120 seconds.
 563 .It Cm LogLevel
 564 Gives the verbosity level that is used when logging messages from
 565 .Xr sshd 8 .
 566 The possible values are:
 567 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
 568 The default is INFO.
 569 DEBUG and DEBUG1 are equivalent.
 570 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
 571 Logging with a DEBUG level violates the privacy of users and is not recommended.
 572 .It Cm MACs
 573 Specifies the available MAC (message authentication code) algorithms.
 574 The MAC algorithm is used in protocol version 2
 575 for data integrity protection.
 576 Multiple algorithms must be comma-separated.
 577 The default is:
 578 .Bd -literal -offset indent
 579 hmac-md5,hmac-sha1,umac-64@openssh.com,
 580 hmac-ripemd160,hmac-sha1-96,hmac-md5-96
 581 .Ed
 582 .It Cm Match
 583 Introduces a conditional block.
 584 If all of the criteria on the
 585 .Cm Match
 586 line are satisfied, the keywords on the following lines override those
 587 set in the global section of the config file, until either another
 588 .Cm Match
 589 line or the end of the file.
 590 The arguments to
 591 .Cm Match
 592 are one or more criteria-pattern pairs.
 593 The available criteria are
 594 .Cm User ,
 595 .Cm Group ,
 596 .Cm Host ,
 597 and
 598 .Cm Address .
 599 Only a subset of keywords may be used on the lines following a
 600 .Cm Match
 601 keyword.
 602 Available keywords are
 603 .Cm AllowTcpForwarding ,
 604 .Cm Banner ,
 605 .Cm ForceCommand ,
 606 .Cm GatewayPorts ,
 607 .Cm GSSApiAuthentication ,
 608 .Cm KbdInteractiveAuthentication ,
 609 .Cm KerberosAuthentication ,
 610 .Cm PasswordAuthentication ,
 611 .Cm PermitOpen ,
 612 .Cm PermitRootLogin ,
 613 .Cm RhostsRSAAuthentication ,
 614 .Cm RSAAuthentication ,
 615 .Cm X11DisplayOffset ,
 616 .Cm X11Forwarding ,
 617 and
 618 .Cm X11UseLocalHost .
 619 .It Cm MaxAuthTries
 620 Specifies the maximum number of authentication attempts permitted per
 621 connection.
 622 Once the number of failures reaches half this value,
 623 additional failures are logged.
 624 The default is 6.
 625 .It Cm MaxStartups
 626 Specifies the maximum number of concurrent unauthenticated connections to the
 627 SSH daemon.
 628 Additional connections will be dropped until authentication succeeds or the
 629 .Cm LoginGraceTime
 630 expires for a connection.
 631 The default is 10.
 632 .Pp
 633 Alternatively, random early drop can be enabled by specifying
 634 the three colon separated values
 635 .Dq start:rate:full
 636 (e.g. "10:30:60").
 637 .Xr sshd 8
 638 will refuse connection attempts with a probability of
 639 .Dq rate/100
 640 (30%)
 641 if there are currently
 642 .Dq start
 643 (10)
 644 unauthenticated connections.
 645 The probability increases linearly and all connection attempts
 646 are refused if the number of unauthenticated connections reaches
 647 .Dq full
 648 (60).
 649 .It Cm PasswordAuthentication
 650 Specifies whether password authentication is allowed.
 651 The default is
 652 .Dq yes .
 653 .It Cm PermitEmptyPasswords
 654 When password authentication is allowed, it specifies whether the
 655 server allows login to accounts with empty password strings.
 656 The default is
 657 .Dq no .
 658 .It Cm PermitOpen
 659 Specifies the destinations to which TCP port forwarding is permitted.
 660 The forwarding specification must be one of the following forms:
 661 .Pp
 662 .Bl -item -offset indent -compact
 663 .It
 664 .Cm PermitOpen
 665 .Sm off
 666 .Ar host : port
 667 .Sm on
 668 .It
 669 .Cm PermitOpen
 670 .Sm off
 671 .Ar IPv4_addr : port
 672 .Sm on
 673 .It
 674 .Cm PermitOpen
 675 .Sm off
 676 .Ar \&[ IPv6_addr \&] : port
 677 .Sm on
 678 .El
 679 .Pp
 680 Multiple forwards may be specified by separating them with whitespace.
 681 An argument of
 682 .Dq any
 683 can be used to remove all restrictions and permit any forwarding requests.
 684 By default all port forwarding requests are permitted.
 685 .It Cm PermitRootLogin
 686 Specifies whether root can log in using
 687 .Xr ssh 1 .
 688 The argument must be
 689 .Dq yes ,
 690 .Dq without-password ,
 691 .Dq forced-commands-only ,
 692 or
 693 .Dq no .
 694 The default is
 695 .Dq yes .
 696 .Pp
 697 If this option is set to
 698 .Dq without-password ,
 699 password authentication is disabled for root.
 700 .Pp
 701 If this option is set to
 702 .Dq forced-commands-only ,
 703 root login with public key authentication will be allowed,
 704 but only if the
 705 .Ar command
 706 option has been specified
 707 (which may be useful for taking remote backups even if root login is
 708 normally not allowed).
 709 All other authentication methods are disabled for root.
 710 .Pp
 711 If this option is set to
 712 .Dq no ,
 713 root is not allowed to log in.
 714 .It Cm PermitTunnel
 715 Specifies whether
 716 .Xr tun 4
 717 device forwarding is allowed.
 718 The argument must be
 719 .Dq yes ,
 720 .Dq point-to-point
 721 (layer 3),
 722 .Dq ethernet
 723 (layer 2), or
 724 .Dq no .
 725 Specifying
 726 .Dq yes
 727 permits both
 728 .Dq point-to-point
 729 and
 730 .Dq ethernet .
 731 The default is
 732 .Dq no .
 733 .It Cm PermitUserEnvironment
 734 Specifies whether
 735 .Pa ~/.ssh/environment
 736 and
 737 .Cm environment=
 738 options in
 739 .Pa ~/.ssh/authorized_keys
 740 are processed by
 741 .Xr sshd 8 .
 742 The default is
 743 .Dq no .
 744 Enabling environment processing may enable users to bypass access
 745 restrictions in some configurations using mechanisms such as
 746 .Ev LD_PRELOAD .
 747 .It Cm PidFile
 748 Specifies the file that contains the process ID of the
 749 SSH daemon.
 750 The default is
 751 .Pa /var/run/sshd.pid .
 752 .It Cm Port
 753 Specifies the port number that
 754 .Xr sshd 8
 755 listens on.
 756 The default is 22.
 757 Multiple options of this type are permitted.
 758 See also
 759 .Cm ListenAddress .
 760 .It Cm PrintLastLog
 761 Specifies whether
 762 .Xr sshd 8
 763 should print the date and time of the last user login when a user logs
 764 in interactively.
 765 The default is
 766 .Dq yes .
 767 .It Cm PrintMotd
 768 Specifies whether
 769 .Xr sshd 8
 770 should print
 771 .Pa /etc/motd
 772 when a user logs in interactively.
 773 (On some systems it is also printed by the shell,
 774 .Pa /etc/profile ,
 775 or equivalent.)
 776 The default is
 777 .Dq yes .
 778 .It Cm Protocol
 779 Specifies the protocol versions
 780 .Xr sshd 8
 781 supports.
 782 The possible values are
 783 .Sq 1
 784 and
 785 .Sq 2 .
 786 Multiple versions must be comma-separated.
 787 The default is
 788 .Dq 2,1 .
 789 Note that the order of the protocol list does not indicate preference,
 790 because the client selects among multiple protocol versions offered
 791 by the server.
 792 Specifying
 793 .Dq 2,1
 794 is identical to
 795 .Dq 1,2 .
 796 .It Cm PubkeyAuthentication
 797 Specifies whether public key authentication is allowed.
 798 The default is
 799 .Dq yes .
 800 Note that this option applies to protocol version 2 only.
 801 .It Cm RhostsRSAAuthentication
 802 Specifies whether rhosts or /etc/hosts.equiv authentication together
 803 with successful RSA host authentication is allowed.
 804 The default is
 805 .Dq no .
 806 This option applies to protocol version 1 only.
 807 .It Cm RSAAuthentication
 808 Specifies whether pure RSA authentication is allowed.
 809 The default is
 810 .Dq yes .
 811 This option applies to protocol version 1 only.
 812 .It Cm ServerKeyBits
 813 Defines the number of bits in the ephemeral protocol version 1 server key.
 814 The minimum value is 512, and the default is 768.
 815 .It Cm StrictModes
 816 Specifies whether
 817 .Xr sshd 8
 818 should check file modes and ownership of the
 819 user's files and home directory before accepting login.
 820 This is normally desirable because novices sometimes accidentally leave their
 821 directory or files world-writable.
 822 The default is
 823 .Dq yes .
 824 .It Cm Subsystem
 825 Configures an external subsystem (e.g. file transfer daemon).
 826 Arguments should be a subsystem name and a command (with optional arguments)
 827 to execute upon subsystem request.
 828 .Pp
 829 The command
 830 .Xr sftp-server 8
 831 implements the
 832 .Dq sftp
 833 file transfer subsystem.
 834 .Pp
 835 Alternately the name
 836 .Dq internal-sftp
 837 implements an in-process
 838 .Dq sftp
 839 server.
 840 This may simplify configurations using
 841 .Cm ChrootDirectory
 842 to force a different filesystem root on clients.
 843 .Pp
 844 By default no subsystems are defined.
 845 Note that this option applies to protocol version 2 only.
 846 .It Cm SyslogFacility
 847 Gives the facility code that is used when logging messages from
 848 .Xr sshd 8 .
 849 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
 850 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
 851 The default is AUTH.
 852 .It Cm TCPKeepAlive
 853 Specifies whether the system should send TCP keepalive messages to the
 854 other side.
 855 If they are sent, death of the connection or crash of one
 856 of the machines will be properly noticed.
 857 However, this means that
 858 connections will die if the route is down temporarily, and some people
 859 find it annoying.
 860 On the other hand, if TCP keepalives are not sent,
 861 sessions may hang indefinitely on the server, leaving
 862 .Dq ghost
 863 users and consuming server resources.
 864 .Pp
 865 The default is
 866 .Dq yes
 867 (to send TCP keepalive messages), and the server will notice
 868 if the network goes down or the client host crashes.
 869 This avoids infinitely hanging sessions.
 870 .Pp
 871 To disable TCP keepalive messages, the value should be set to
 872 .Dq no .
 873 .It Cm UseDNS
 874 Specifies whether
 875 .Xr sshd 8
 876 should look up the remote host name and check that
 877 the resolved host name for the remote IP address maps back to the
 878 very same IP address.
 879 The default is
 880 .Dq yes .
 881 .It Cm UseLogin
 882 Specifies whether
 883 .Xr login 1
 884 is used for interactive login sessions.
 885 The default is
 886 .Dq no .
 887 Note that
 888 .Xr login 1
 889 is never used for remote command execution.
 890 Note also, that if this is enabled,
 891 .Cm X11Forwarding
 892 will be disabled because
 893 .Xr login 1
 894 does not know how to handle
 895 .Xr xauth 1
 896 cookies.
 897 If
 898 .Cm UsePrivilegeSeparation
 899 is specified, it will be disabled after authentication.
 900 .It Cm UsePAM
 901 Enables the Pluggable Authentication Module interface.
 902 If set to
 903 .Dq yes
 904 this will enable PAM authentication using
 905 .Cm ChallengeResponseAuthentication
 906 and
 907 .Cm PasswordAuthentication
 908 in addition to PAM account and session module processing for all
 909 authentication types.
 910 .Pp
 911 Because PAM challenge-response authentication usually serves an equivalent
 912 role to password authentication, you should disable either
 913 .Cm PasswordAuthentication
 914 or
 915 .Cm ChallengeResponseAuthentication.
 916 .Pp
 917 If
 918 .Cm UsePAM
 919 is enabled, you will not be able to run
 920 .Xr sshd 8
 921 as a non-root user.
 922 The default is
 923 .Dq no .
 924 .It Cm UsePrivilegeSeparation
 925 Specifies whether
 926 .Xr sshd 8
 927 separates privileges by creating an unprivileged child process
 928 to deal with incoming network traffic.
 929 After successful authentication, another process will be created that has
 930 the privilege of the authenticated user.
 931 The goal of privilege separation is to prevent privilege
 932 escalation by containing any corruption within the unprivileged processes.
 933 The default is
 934 .Dq yes .
 935 .It Cm X11DisplayOffset
 936 Specifies the first display number available for
 937 .Xr sshd 8 Ns 's
 938 X11 forwarding.
 939 This prevents sshd from interfering with real X11 servers.
 940 The default is 10.
 941 .It Cm X11Forwarding
 942 Specifies whether X11 forwarding is permitted.
 943 The argument must be
 944 .Dq yes
 945 or
 946 .Dq no .
 947 The default is
 948 .Dq no .
 949 .Pp
 950 When X11 forwarding is enabled, there may be additional exposure to
 951 the server and to client displays if the
 952 .Xr sshd 8
 953 proxy display is configured to listen on the wildcard address (see
 954 .Cm X11UseLocalhost
 955 below), though this is not the default.
 956 Additionally, the authentication spoofing and authentication data
 957 verification and substitution occur on the client side.
 958 The security risk of using X11 forwarding is that the client's X11
 959 display server may be exposed to attack when the SSH client requests
 960 forwarding (see the warnings for
 961 .Cm ForwardX11
 962 in
 963 .Xr ssh_config 5 ) .
 964 A system administrator may have a stance in which they want to
 965 protect clients that may expose themselves to attack by unwittingly
 966 requesting X11 forwarding, which can warrant a
 967 .Dq no
 968 setting.
 969 .Pp
 970 Note that disabling X11 forwarding does not prevent users from
 971 forwarding X11 traffic, as users can always install their own forwarders.
 972 X11 forwarding is automatically disabled if
 973 .Cm UseLogin
 974 is enabled.
 975 .It Cm X11UseLocalhost
 976 Specifies whether
 977 .Xr sshd 8
 978 should bind the X11 forwarding server to the loopback address or to
 979 the wildcard address.
 980 By default,
 981 sshd binds the forwarding server to the loopback address and sets the
 982 hostname part of the
 983 .Ev DISPLAY
 984 environment variable to
 985 .Dq localhost .
 986 This prevents remote hosts from connecting to the proxy display.
 987 However, some older X11 clients may not function with this
 988 configuration.
 989 .Cm X11UseLocalhost
 990 may be set to
 991 .Dq no
 992 to specify that the forwarding server should be bound to the wildcard
 993 address.
 994 The argument must be
 995 .Dq yes
 996 or
 997 .Dq no .
 998 The default is
 999 .Dq yes .
1000 .It Cm XAuthLocation
1001 Specifies the full pathname of the
1002 .Xr xauth 1
1003 program.
1004 The default is
1005 .Pa /usr/X11R6/bin/xauth .
1006 .El
1007 .Sh TIME FORMATS
1008 .Xr sshd 8
1009 command-line arguments and configuration file options that specify time
1010 may be expressed using a sequence of the form:
1011 .Sm off
1012 .Ar time Op Ar qualifier ,
1013 .Sm on
1014 where
1015 .Ar time
1016 is a positive integer value and
1017 .Ar qualifier
1018 is one of the following:
1019 .Pp
1020 .Bl -tag -width Ds -compact -offset indent
1021 .It Aq Cm none
1022 seconds
1023 .It Cm s | Cm S
1024 seconds
1025 .It Cm m | Cm M
1026 minutes
1027 .It Cm h | Cm H
1028 hours
1029 .It Cm d | Cm D
1030 days
1031 .It Cm w | Cm W
1032 weeks
1033 .El
1034 .Pp
1035 Each member of the sequence is added together to calculate
1036 the total time value.
1037 .Pp
1038 Time format examples:
1039 .Pp
1040 .Bl -tag -width Ds -compact -offset indent
1041 .It 600
1042 600 seconds (10 minutes)
1043 .It 10m
1044 10 minutes
1045 .It 1h30m
1046 1 hour 30 minutes (90 minutes)
1047 .El
1048 .Sh FILES
1049 .Bl -tag -width Ds
1050 .It Pa /etc/ssh/sshd_config
1051 Contains configuration data for
1052 .Xr sshd 8 .
1053 This file should be writable by root only, but it is recommended
1054 (though not necessary) that it be world-readable.
1055 .El
1056 .Sh SEE ALSO
1057 .Xr sshd 8
1058 .Sh AUTHORS
1059 OpenSSH is a derivative of the original and free
1060 ssh 1.2.12 release by Tatu Ylonen.
1061 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1062 Theo de Raadt and Dug Song
1063 removed many bugs, re-added newer features and
1064 created OpenSSH.
1065 Markus Friedl contributed the support for SSH
1066 protocol versions 1.5 and 2.0.
1067 Niels Provos and Markus Friedl contributed support
1068 for privilege separation.