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