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_dsa_key
 416 for protocol version 2.
 417 Note that
 418 .Xr sshd 8
 419 will refuse to use a file if it is group/world-accessible.
 420 It is possible to have multiple host key files.
 421 .Dq rsa1
 422 keys are used for version 1 and
 423 .Dq dsa
 424 or
 425 .Dq rsa
 426 are used for version 2 of the SSH protocol.
 427 .It Cm IgnoreRhosts
 428 Specifies that
 429 .Pa .rhosts
 430 and
 431 .Pa .shosts
 432 files will not be used in
 433 .Cm RhostsRSAAuthentication
 434 or
 435 .Cm HostbasedAuthentication .
 436 .Pp
 437 .Pa /etc/hosts.equiv
 438 and
 439 .Pa /etc/ssh/shosts.equiv
 440 are still used.
 441 The default is
 442 .Dq yes .
 443 .It Cm IgnoreUserKnownHosts
 444 Specifies whether
 445 .Xr sshd 8
 446 should ignore the user's
 447 .Pa ~/.ssh/known_hosts
 448 during
 449 .Cm RhostsRSAAuthentication
 450 or
 451 .Cm HostbasedAuthentication .
 452 The default is
 453 .Dq no .
 454 .It Cm KerberosAuthentication
 455 Specifies whether the password provided by the user for
 456 .Cm PasswordAuthentication
 457 will be validated through the Kerberos KDC.
 458 To use this option, the server needs a
 459 Kerberos servtab which allows the verification of the KDC's identity.
 460 The default is
 461 .Dq no .
 462 .It Cm KerberosGetAFSToken
 463 If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
 464 an AFS token before accessing the user's home directory.
 465 The default is
 466 .Dq no .
 467 .It Cm KerberosOrLocalPasswd
 468 If password authentication through Kerberos fails then
 469 the password will be validated via any additional local mechanism
 470 such as
 471 .Pa /etc/passwd .
 472 The default is
 473 .Dq yes .
 474 .It Cm KerberosTicketCleanup
 475 Specifies whether to automatically destroy the user's ticket cache
 476 file on logout.
 477 The default is
 478 .Dq yes .
 479 .It Cm KeyRegenerationInterval
 480 In protocol version 1, the ephemeral server key is automatically regenerated
 481 after this many seconds (if it has been used).
 482 The purpose of regeneration is to prevent
 483 decrypting captured sessions by later breaking into the machine and
 484 stealing the keys.
 485 The key is never stored anywhere.
 486 If the value is 0, the key is never regenerated.
 487 The default is 3600 (seconds).
 488 .It Cm ListenAddress
 489 Specifies the local addresses
 490 .Xr sshd 8
 491 should listen on.
 492 The following forms may be used:
 493 .Pp
 494 .Bl -item -offset indent -compact
 495 .It
 496 .Cm ListenAddress
 497 .Sm off
 498 .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
 499 .Sm on
 500 .It
 501 .Cm ListenAddress
 502 .Sm off
 503 .Ar host No | Ar IPv4_addr No : Ar port
 504 .Sm on
 505 .It
 506 .Cm ListenAddress
 507 .Sm off
 508 .Oo
 509 .Ar host No | Ar IPv6_addr Oc : Ar port
 510 .Sm on
 511 .El
 512 .Pp
 513 If
 514 .Ar port
 515 is not specified,
 516 sshd will listen on the address and all prior
 517 .Cm Port
 518 options specified.
 519 The default is to listen on all local addresses.
 520 Multiple
 521 .Cm ListenAddress
 522 options are permitted.
 523 Additionally, any
 524 .Cm Port
 525 options must precede this option for non-port qualified addresses.
 526 .It Cm LoginGraceTime
 527 The server disconnects after this time if the user has not
 528 successfully logged in.
 529 If the value is 0, there is no time limit.
 530 The default is 120 seconds.
 531 .It Cm LogLevel
 532 Gives the verbosity level that is used when logging messages from
 533 .Xr sshd 8 .
 534 The possible values are:
 535 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
 536 The default is INFO.
 537 DEBUG and DEBUG1 are equivalent.
 538 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
 539 Logging with a DEBUG level violates the privacy of users and is not recommended.
 540 .It Cm MACs
 541 Specifies the available MAC (message authentication code) algorithms.
 542 The MAC algorithm is used in protocol version 2
 543 for data integrity protection.
 544 Multiple algorithms must be comma-separated.
 545 The default is:
 546 .Bd -literal -offset indent
 547 hmac-md5,hmac-sha1,umac-64@openssh.com,
 548 hmac-ripemd160,hmac-sha1-96,hmac-md5-96
 549 .Ed
 550 .It Cm Match
 551 Introduces a conditional block.
 552 If all of the criteria on the
 553 .Cm Match
 554 line are satisfied, the keywords on the following lines override those
 555 set in the global section of the config file, until either another
 556 .Cm Match
 557 line or the end of the file.
 558 .Pp
 559 The arguments to
 560 .Cm Match
 561 are one or more criteria-pattern pairs.
 562 The available criteria are
 563 .Cm User ,
 564 .Cm Group ,
 565 .Cm Host ,
 566 and
 567 .Cm Address .
 568 The match patterns may consist of single entries or comma-separated
 569 lists and may use the wildcard and negation operators described in the
 570 .Sx PATTERNS
 571 section of
 572 .Xr ssh_config 5 .
 573 .Pp
 574 The patterns in an
 575 .Cm Address
 576 criteria may additionally contain addresses to match in CIDR
 577 address/masklen format, e.g.\&
 578 .Dq 192.0.2.0/24
 579 or
 580 .Dq 3ffe:ffff::/32 .
 581 Note that the mask length provided must be consistent with the address -
 582 it is an error to specify a mask length that is too long for the address
 583 or one with bits set in this host portion of the address.
 584 For example,
 585 .Dq 192.0.2.0/33
 586 and
 587 .Dq 192.0.2.0/8
 588 respectively.
 589 .Pp
 590 Only a subset of keywords may be used on the lines following a
 591 .Cm Match
 592 keyword.
 593 Available keywords are
 594 .Cm AllowTcpForwarding ,
 595 .Cm Banner ,
 596 .Cm ChrootDirectory ,
 597 .Cm ForceCommand ,
 598 .Cm GatewayPorts ,
 599 .Cm GSSAPIAuthentication ,
 600 .Cm HostbasedAuthentication ,
 601 .Cm KbdInteractiveAuthentication ,
 602 .Cm KerberosAuthentication ,
 603 .Cm MaxAuthTries ,
 604 .Cm MaxSessions ,
 605 .Cm PasswordAuthentication ,
 606 .Cm PermitOpen ,
 607 .Cm PermitRootLogin ,
 608 .Cm RhostsRSAAuthentication ,
 609 .Cm RSAAuthentication ,
 610 .Cm X11DisplayOffset ,
 611 .Cm X11Forwarding ,
 612 and
 613 .Cm X11UseLocalHost .
 614 .It Cm MaxAuthTries
 615 Specifies the maximum number of authentication attempts permitted per
 616 connection.
 617 Once the number of failures reaches half this value,
 618 additional failures are logged.
 619 The default is 6.
 620 .It Cm MaxSessions
 621 Specifies the maximum number of open sessions permitted per network connection.
 622 The default is 10.
 623 .It Cm MaxStartups
 624 Specifies the maximum number of concurrent unauthenticated connections to the
 625 SSH daemon.
 626 Additional connections will be dropped until authentication succeeds or the
 627 .Cm LoginGraceTime
 628 expires for a connection.
 629 The default is 10.
 630 .Pp
 631 Alternatively, random early drop can be enabled by specifying
 632 the three colon separated values
 633 .Dq start:rate:full
 634 (e.g. "10:30:60").
 635 .Xr sshd 8
 636 will refuse connection attempts with a probability of
 637 .Dq rate/100
 638 (30%)
 639 if there are currently
 640 .Dq start
 641 (10)
 642 unauthenticated connections.
 643 The probability increases linearly and all connection attempts
 644 are refused if the number of unauthenticated connections reaches
 645 .Dq full
 646 (60).
 647 .It Cm PasswordAuthentication
 648 Specifies whether password authentication is allowed.
 649 See also
 650 .Cm UsePAM .
 651 The default is
 652 .Dq no .
 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 no .
 696 Note that if
 697 .Cm ChallengeResponseAuthentication
 698 is
 699 .Dq yes ,
 700 the root user may be allowed in with its password even if
 701 .Cm PermitRootLogin is set to
 702 .Dq without-password .
 703 .Pp
 704 If this option is set to
 705 .Dq without-password ,
 706 password authentication is disabled for root.
 707 .Pp
 708 If this option is set to
 709 .Dq forced-commands-only ,
 710 root login with public key authentication will be allowed,
 711 but only if the
 712 .Ar command
 713 option has been specified
 714 (which may be useful for taking remote backups even if root login is
 715 normally not allowed).
 716 All other authentication methods are disabled for root.
 717 .Pp
 718 If this option is set to
 719 .Dq no ,
 720 root is not allowed to log in.
 721 .It Cm PermitTunnel
 722 Specifies whether
 723 .Xr tun 4
 724 device forwarding is allowed.
 725 The argument must be
 726 .Dq yes ,
 727 .Dq point-to-point
 728 (layer 3),
 729 .Dq ethernet
 730 (layer 2), or
 731 .Dq no .
 732 Specifying
 733 .Dq yes
 734 permits both
 735 .Dq point-to-point
 736 and
 737 .Dq ethernet .
 738 The default is
 739 .Dq no .
 740 .It Cm PermitUserEnvironment
 741 Specifies whether
 742 .Pa ~/.ssh/environment
 743 and
 744 .Cm environment=
 745 options in
 746 .Pa ~/.ssh/authorized_keys
 747 are processed by
 748 .Xr sshd 8 .
 749 The default is
 750 .Dq no .
 751 Enabling environment processing may enable users to bypass access
 752 restrictions in some configurations using mechanisms such as
 753 .Ev LD_PRELOAD .
 754 .It Cm PidFile
 755 Specifies the file that contains the process ID of the
 756 SSH daemon.
 757 The default is
 758 .Pa /var/run/sshd.pid .
 759 .It Cm Port
 760 Specifies the port number that
 761 .Xr sshd 8
 762 listens on.
 763 The default is 22.
 764 Multiple options of this type are permitted.
 765 See also
 766 .Cm ListenAddress .
 767 .It Cm PrintLastLog
 768 Specifies whether
 769 .Xr sshd 8
 770 should print the date and time of the last user login when a user logs
 771 in interactively.
 772 The default is
 773 .Dq yes .
 774 .It Cm PrintMotd
 775 Specifies whether
 776 .Xr sshd 8
 777 should print
 778 .Pa /etc/motd
 779 when a user logs in interactively.
 780 (On some systems it is also printed by the shell,
 781 .Pa /etc/profile ,
 782 or equivalent.)
 783 The default is
 784 .Dq yes .
 785 .It Cm Protocol
 786 Specifies the protocol versions
 787 .Xr sshd 8
 788 supports.
 789 The possible values are
 790 .Sq 1
 791 and
 792 .Sq 2 .
 793 Multiple versions must be comma-separated.
 794 The default is
 795 .Dq 2 .
 796 Note that the order of the protocol list does not indicate preference,
 797 because the client selects among multiple protocol versions offered
 798 by the server.
 799 Specifying
 800 .Dq 2,1
 801 is identical to
 802 .Dq 1,2 .
 803 .It Cm PubkeyAuthentication
 804 Specifies whether public key authentication is allowed.
 805 The default is
 806 .Dq yes .
 807 Note that this option applies to protocol version 2 only.
 808 .It Cm RhostsRSAAuthentication
 809 Specifies whether rhosts or
 810 .Pa /etc/hosts.equiv
 811 authentication together
 812 with successful RSA host authentication is allowed.
 813 The default is
 814 .Dq no .
 815 This option applies to protocol version 1 only.
 816 .It Cm RSAAuthentication
 817 Specifies whether pure RSA authentication is allowed.
 818 The default is
 819 .Dq yes .
 820 This option applies to protocol version 1 only.
 821 .It Cm ServerKeyBits
 822 Defines the number of bits in the ephemeral protocol version 1 server key.
 823 The minimum value is 512, and the default is 1024.
 824 .It Cm StrictModes
 825 Specifies whether
 826 .Xr sshd 8
 827 should check file modes and ownership of the
 828 user's files and home directory before accepting login.
 829 This is normally desirable because novices sometimes accidentally leave their
 830 directory or files world-writable.
 831 The default is
 832 .Dq yes .
 833 .It Cm Subsystem
 834 Configures an external subsystem (e.g. file transfer daemon).
 835 Arguments should be a subsystem name and a command (with optional arguments)
 836 to execute upon subsystem request.
 837 .Pp
 838 The command
 839 .Xr sftp-server 8
 840 implements the
 841 .Dq sftp
 842 file transfer subsystem.
 843 .Pp
 844 Alternately the name
 845 .Dq internal-sftp
 846 implements an in-process
 847 .Dq sftp
 848 server.
 849 This may simplify configurations using
 850 .Cm ChrootDirectory
 851 to force a different filesystem root on clients.
 852 .Pp
 853 By default no subsystems are defined.
 854 Note that this option applies to protocol version 2 only.
 855 .It Cm SyslogFacility
 856 Gives the facility code that is used when logging messages from
 857 .Xr sshd 8 .
 858 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
 859 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
 860 The default is AUTH.
 861 .It Cm TCPKeepAlive
 862 Specifies whether the system should send TCP keepalive messages to the
 863 other side.
 864 If they are sent, death of the connection or crash of one
 865 of the machines will be properly noticed.
 866 However, this means that
 867 connections will die if the route is down temporarily, and some people
 868 find it annoying.
 869 On the other hand, if TCP keepalives are not sent,
 870 sessions may hang indefinitely on the server, leaving
 871 .Dq ghost
 872 users and consuming server resources.
 873 .Pp
 874 The default is
 875 .Dq yes
 876 (to send TCP keepalive messages), and the server will notice
 877 if the network goes down or the client host crashes.
 878 This avoids infinitely hanging sessions.
 879 .Pp
 880 To disable TCP keepalive messages, the value should be set to
 881 .Dq no .
 882 .It Cm UseDNS
 883 Specifies whether
 884 .Xr sshd 8
 885 should look up the remote host name and check that
 886 the resolved host name for the remote IP address maps back to the
 887 very same IP address.
 888 The default is
 889 .Dq yes .
 890 .It Cm UseLogin
 891 Specifies whether
 892 .Xr login 1
 893 is used for interactive login sessions.
 894 The default is
 895 .Dq no .
 896 Note that
 897 .Xr login 1
 898 is never used for remote command execution.
 899 Note also, that if this is enabled,
 900 .Cm X11Forwarding
 901 will be disabled because
 902 .Xr login 1
 903 does not know how to handle
 904 .Xr xauth 1
 905 cookies.
 906 If
 907 .Cm UsePrivilegeSeparation
 908 is specified, it will be disabled after authentication.
 909 .It Cm UsePAM
 910 Enables the Pluggable Authentication Module interface.
 911 If set to
 912 .Dq yes
 913 this will enable PAM authentication using
 914 .Cm ChallengeResponseAuthentication
 915 and
 916 .Cm PasswordAuthentication
 917 in addition to PAM account and session module processing for all
 918 authentication types.
 919 .Pp
 920 Because PAM challenge-response authentication usually serves an equivalent
 921 role to password authentication, you should disable either
 922 .Cm PasswordAuthentication
 923 or
 924 .Cm ChallengeResponseAuthentication.
 925 .Pp
 926 If
 927 .Cm UsePAM
 928 is enabled, you will not be able to run
 929 .Xr sshd 8
 930 as a non-root user.
 931 The default is
 932 .Dq yes .
 933 .It Cm UsePrivilegeSeparation
 934 Specifies whether
 935 .Xr sshd 8
 936 separates privileges by creating an unprivileged child process
 937 to deal with incoming network traffic.
 938 After successful authentication, another process will be created that has
 939 the privilege of the authenticated user.
 940 The goal of privilege separation is to prevent privilege
 941 escalation by containing any corruption within the unprivileged processes.
 942 The default is
 943 .Dq yes .
 944 .It Cm VersionAddendum
 945 Specifies a string to append to the regular version string to identify
 946 OS- or site-specific modifications.
 947 The default is
 948 .Dq FreeBSD-20080901 .
 949 .It Cm X11DisplayOffset
 950 Specifies the first display number available for
 951 .Xr sshd 8 Ns 's
 952 X11 forwarding.
 953 This prevents sshd from interfering with real X11 servers.
 954 The default is 10.
 955 .It Cm X11Forwarding
 956 Specifies whether X11 forwarding is permitted.
 957 The argument must be
 958 .Dq yes
 959 or
 960 .Dq no .
 961 The default is
 962 .Dq yes .
 963 .Pp
 964 When X11 forwarding is enabled, there may be additional exposure to
 965 the server and to client displays if the
 966 .Xr sshd 8
 967 proxy display is configured to listen on the wildcard address (see
 968 .Cm X11UseLocalhost
 969 below), though this is not the default.
 970 Additionally, the authentication spoofing and authentication data
 971 verification and substitution occur on the client side.
 972 The security risk of using X11 forwarding is that the client's X11
 973 display server may be exposed to attack when the SSH client requests
 974 forwarding (see the warnings for
 975 .Cm ForwardX11
 976 in
 977 .Xr ssh_config 5 ) .
 978 A system administrator may have a stance in which they want to
 979 protect clients that may expose themselves to attack by unwittingly
 980 requesting X11 forwarding, which can warrant a
 981 .Dq no
 982 setting.
 983 .Pp
 984 Note that disabling X11 forwarding does not prevent users from
 985 forwarding X11 traffic, as users can always install their own forwarders.
 986 X11 forwarding is automatically disabled if
 987 .Cm UseLogin
 988 is enabled.
 989 .It Cm X11UseLocalhost
 990 Specifies whether
 991 .Xr sshd 8
 992 should bind the X11 forwarding server to the loopback address or to
 993 the wildcard address.
 994 By default,
 995 sshd binds the forwarding server to the loopback address and sets the
 996 hostname part of the
 997 .Ev DISPLAY
 998 environment variable to
 999 .Dq localhost .
1000 This prevents remote hosts from connecting to the proxy display.
1001 However, some older X11 clients may not function with this
1002 configuration.
1003 .Cm X11UseLocalhost
1004 may be set to
1005 .Dq no
1006 to specify that the forwarding server should be bound to the wildcard
1007 address.
1008 The argument must be
1009 .Dq yes
1010 or
1011 .Dq no .
1012 The default is
1013 .Dq yes .
1014 .It Cm XAuthLocation
1015 Specifies the full pathname of the
1016 .Xr xauth 1
1017 program.
1018 The default is
1019 .Pa /usr/local/bin/xauth .
1020 .El
1021 .Sh TIME FORMATS
1022 .Xr sshd 8
1023 command-line arguments and configuration file options that specify time
1024 may be expressed using a sequence of the form:
1025 .Sm off
1026 .Ar time Op Ar qualifier ,
1027 .Sm on
1028 where
1029 .Ar time
1030 is a positive integer value and
1031 .Ar qualifier
1032 is one of the following:
1033 .Pp
1034 .Bl -tag -width Ds -compact -offset indent
1035 .It Aq Cm none
1036 seconds
1037 .It Cm s | Cm S
1038 seconds
1039 .It Cm m | Cm M
1040 minutes
1041 .It Cm h | Cm H
1042 hours
1043 .It Cm d | Cm D
1044 days
1045 .It Cm w | Cm W
1046 weeks
1047 .El
1048 .Pp
1049 Each member of the sequence is added together to calculate
1050 the total time value.
1051 .Pp
1052 Time format examples:
1053 .Pp
1054 .Bl -tag -width Ds -compact -offset indent
1055 .It 600
1056 600 seconds (10 minutes)
1057 .It 10m
1058 10 minutes
1059 .It 1h30m
1060 1 hour 30 minutes (90 minutes)
1061 .El
1062 .Sh FILES
1063 .Bl -tag -width Ds
1064 .It Pa /etc/ssh/sshd_config
1065 Contains configuration data for
1066 .Xr sshd 8 .
1067 This file should be writable by root only, but it is recommended
1068 (though not necessary) that it be world-readable.
1069 .El
1070 .Sh SEE ALSO
1071 .Xr sshd 8
1072 .Sh AUTHORS
1073 OpenSSH is a derivative of the original and free
1074 ssh 1.2.12 release by Tatu Ylonen.
1075 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1076 Theo de Raadt and Dug Song
1077 removed many bugs, re-added newer features and
1078 created OpenSSH.
1079 Markus Friedl contributed the support for SSH
1080 protocol versions 1.5 and 2.0.
1081 Niels Provos and Markus Friedl contributed support
1082 for privilege separation.