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