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