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.102 2009/02/22 23:59:25 djm Exp $
  38 .Dd $Mdocdate: February 22 2009 $
  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 AllowAgentForwarding
  99 Specifies whether
 100 .Xr ssh-agent 1
 101 forwarding is permitted.
 102 The default is
 103 .Dq yes .
 104 Note that disabling agent forwarding does not improve security
 105 unless users are also denied shell access, as they can always install
 106 their own forwarders.
 107 .It Cm AllowGroups
 108 This keyword can be followed by a list of group name patterns, separated
 109 by spaces.
 110 If specified, login is allowed only for users whose primary
 111 group or supplementary group list matches one of the patterns.
 112 Only group names are valid; a numerical group ID is not recognized.
 113 By default, login is allowed for all groups.
 114 The allow/deny directives are processed in the following order:
 115 .Cm DenyUsers ,
 116 .Cm AllowUsers ,
 117 .Cm DenyGroups ,
 118 and finally
 119 .Cm AllowGroups .
 120 .Pp
 121 See
 122 .Sx PATTERNS
 123 in
 124 .Xr ssh_config 5
 125 for more information on patterns.
 126 .It Cm AllowTcpForwarding
 127 Specifies whether TCP forwarding is permitted.
 128 The default is
 129 .Dq yes .
 130 Note that disabling TCP forwarding does not improve security unless
 131 users are also denied shell access, as they can always install their
 132 own forwarders.
 133 .It Cm AllowUsers
 134 This keyword can be followed by a list of user name patterns, separated
 135 by spaces.
 136 If specified, login is allowed only for user names that
 137 match one of the patterns.
 138 Only user names are valid; a numerical user ID is not recognized.
 139 By default, login is allowed for all users.
 140 If the pattern takes the form USER@HOST then USER and HOST
 141 are separately checked, restricting logins to particular
 142 users from particular hosts.
 143 The allow/deny directives are processed in the following order:
 144 .Cm DenyUsers ,
 145 .Cm AllowUsers ,
 146 .Cm DenyGroups ,
 147 and finally
 148 .Cm AllowGroups .
 149 .Pp
 150 See
 151 .Sx PATTERNS
 152 in
 153 .Xr ssh_config 5
 154 for more information on patterns.
 155 .It Cm AuthorizedKeysFile
 156 Specifies the file that contains the public keys that can be used
 157 for user authentication.
 158 .Cm AuthorizedKeysFile
 159 may contain tokens of the form %T which are substituted during connection
 160 setup.
 161 The following tokens are defined: %% is replaced by a literal '%',
 162 %h is replaced by the home directory of the user being authenticated, and
 163 %u is replaced by the username of that user.
 164 After expansion,
 165 .Cm AuthorizedKeysFile
 166 is taken to be an absolute path or one relative to the user's home
 167 directory.
 168 The default is
 169 .Dq .ssh/authorized_keys .
 170 .It Cm Banner
 171 The contents of the specified file are sent to the remote user before
 172 authentication is allowed.
 173 If the argument is
 174 .Dq none
 175 then no banner is displayed.
 176 This option is only available for protocol version 2.
 177 By default, no banner is displayed.
 178 .It Cm ChallengeResponseAuthentication
 179 Specifies whether challenge-response authentication is allowed.
 180 All authentication styles from
 181 .Xr login.conf 5
 182 are supported.
 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-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,
 244 aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,
 245 aes256-cbc,arcfour
 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 yes .
 376 Note that this option applies to protocol version 2 only.
 377 .It Cm GSSAPIDelegateCredentials
 378 Specifies whether delegated credentials are stored in the user's environment.
 379 The default is
 380 .Dq yes .
 381 .It Cm GSSAPIKeyExchange
 382 Specifies whether key exchange based on GSSAPI is allowed. GSSAPI key exchange
 383 doesn't rely on ssh keys to verify host identity.
 384 The default is
 385 .Dq yes .
 386 Note that this option applies to protocol version 2 only.
 387 .It Cm GSSAPICleanupCredentials
 388 Specifies whether to automatically destroy the user's credentials cache
 389 on logout.
 390 The default is
 391 .Dq yes .
 392 Note that this option applies to protocol version 2 only.
 393 .It Cm GSSAPICredentialsPath
 394 If specified, the delegated GSSAPI credential is stored in the
 395 given path, overwriting any existing credentials.
 396 Paths can be specified with syntax similar to the AuthorizedKeysFile
 397 option (i.e., accepting %h and %u tokens).
 398 When using this option,
 399 setting 'GssapiCleanupCredentials no' is recommended,
 400 so logging out of one session
 401 doesn't remove the credentials in use by another session of
 402 the same user.
 403 Currently only implemented for the GSI mechanism.
 404 .It Cm GSIAllowLimitedProxy
 405 Specifies whether to accept limited proxy credentials for
 406 authentication.
 407 The default is
 408 .Dq no .
 409 .It Cm GSSAPIStrictAcceptorCheck
 410 Determines whether to be strict about the identity of the GSSAPI acceptor
 411 a client authenticates against. If
 412 .Dq yes
 413 then the client must authenticate against the
 414 .Pa host
 415 service on the current hostname. If
 416 .Dq no
 417 then the client may authenticate against any service key stored in the
 418 machine's default store. This facility is provided to assist with operation
 419 on multi homed machines.
 420 The default is
 421 .Dq yes .
 422 Note that this option applies only to protocol version 2 GSSAPI connections,
 423 and setting it to
 424 .Dq no
 425 may only work with recent Kerberos GSSAPI libraries.
 426 .It Cm GSSAPIStoreCredentialsOnRekey
 427 Controls whether the user's GSSAPI credentials should be updated following a
 428 successful connection rekeying. This option can be used to accepted renewed
 429 or updated credentials from a compatible client. The default is
 430 .Dq no .
 431 .It Cm HostbasedAuthentication
 432 Specifies whether rhosts or /etc/hosts.equiv authentication together
 433 with successful public key client host authentication is allowed
 434 (host-based authentication).
 435 This option is similar to
 436 .Cm RhostsRSAAuthentication
 437 and applies to protocol version 2 only.
 438 The default is
 439 .Dq no .
 440 .It Cm HostbasedUsesNameFromPacketOnly
 441 Specifies whether or not the server will attempt to perform a reverse
 442 name lookup when matching the name in the
 443 .Pa ~/.shosts ,
 444 .Pa ~/.rhosts ,
 445 and
 446 .Pa /etc/hosts.equiv
 447 files during
 448 .Cm HostbasedAuthentication .
 449 A setting of
 450 .Dq yes
 451 means that
 452 .Xr sshd 8
 453 uses the name supplied by the client rather than
 454 attempting to resolve the name from the TCP connection itself.
 455 The default is
 456 .Dq no .
 457 .It Cm HostKey
 458 Specifies a file containing a private host key
 459 used by SSH.
 460 The default is
 461 .Pa /etc/ssh/ssh_host_key
 462 for protocol version 1, and
 463 .Pa /etc/ssh/ssh_host_rsa_key
 464 and
 465 .Pa /etc/ssh/ssh_host_dsa_key
 466 for protocol version 2.
 467 Note that
 468 .Xr sshd 8
 469 will refuse to use a file if it is group/world-accessible.
 470 It is possible to have multiple host key files.
 471 .Dq rsa1
 472 keys are used for version 1 and
 473 .Dq dsa
 474 or
 475 .Dq rsa
 476 are used for version 2 of the SSH protocol.
 477 .It Cm IgnoreRhosts
 478 Specifies that
 479 .Pa .rhosts
 480 and
 481 .Pa .shosts
 482 files will not be used in
 483 .Cm RhostsRSAAuthentication
 484 or
 485 .Cm HostbasedAuthentication .
 486 .Pp
 487 .Pa /etc/hosts.equiv
 488 and
 489 .Pa /etc/shosts.equiv
 490 are still used.
 491 The default is
 492 .Dq yes .
 493 .It Cm IgnoreUserKnownHosts
 494 Specifies whether
 495 .Xr sshd 8
 496 should ignore the user's
 497 .Pa ~/.ssh/known_hosts
 498 during
 499 .Cm RhostsRSAAuthentication
 500 or
 501 .Cm HostbasedAuthentication .
 502 The default is
 503 .Dq no .
 504 .It Cm KerberosAuthentication
 505 Specifies whether the password provided by the user for
 506 .Cm PasswordAuthentication
 507 will be validated through the Kerberos KDC.
 508 To use this option, the server needs a
 509 Kerberos servtab which allows the verification of the KDC's identity.
 510 The default is
 511 .Dq no .
 512 .It Cm KerberosGetAFSToken
 513 If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
 514 an AFS token before accessing the user's home directory.
 515 The default is
 516 .Dq no .
 517 .It Cm KerberosOrLocalPasswd
 518 If password authentication through Kerberos fails then
 519 the password will be validated via any additional local mechanism
 520 such as
 521 .Pa /etc/passwd .
 522 The default is
 523 .Dq yes .
 524 .It Cm KerberosTicketCleanup
 525 Specifies whether to automatically destroy the user's ticket cache
 526 file on logout.
 527 The default is
 528 .Dq yes .
 529 .It Cm KeyRegenerationInterval
 530 In protocol version 1, the ephemeral server key is automatically regenerated
 531 after this many seconds (if it has been used).
 532 The purpose of regeneration is to prevent
 533 decrypting captured sessions by later breaking into the machine and
 534 stealing the keys.
 535 The key is never stored anywhere.
 536 If the value is 0, the key is never regenerated.
 537 The default is 3600 (seconds).
 538 .It Cm ListenAddress
 539 Specifies the local addresses
 540 .Xr sshd 8
 541 should listen on.
 542 The following forms may be used:
 543 .Pp
 544 .Bl -item -offset indent -compact
 545 .It
 546 .Cm ListenAddress
 547 .Sm off
 548 .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
 549 .Sm on
 550 .It
 551 .Cm ListenAddress
 552 .Sm off
 553 .Ar host No | Ar IPv4_addr No : Ar port
 554 .Sm on
 555 .It
 556 .Cm ListenAddress
 557 .Sm off
 558 .Oo
 559 .Ar host No | Ar IPv6_addr Oc : Ar port
 560 .Sm on
 561 .El
 562 .Pp
 563 If
 564 .Ar port
 565 is not specified,
 566 sshd will listen on the address and all prior
 567 .Cm Port
 568 options specified.
 569 The default is to listen on all local addresses.
 570 Multiple
 571 .Cm ListenAddress
 572 options are permitted.
 573 Additionally, any
 574 .Cm Port
 575 options must precede this option for non-port qualified addresses.
 576 .It Cm LoginGraceTime
 577 The server disconnects after this time if the user has not
 578 successfully logged in.
 579 If the value is 0, there is no time limit.
 580 The default is 120 seconds.
 581 .It Cm LogLevel
 582 Gives the verbosity level that is used when logging messages from
 583 .Xr sshd 8 .
 584 The possible values are:
 585 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
 586 The default is INFO.
 587 DEBUG and DEBUG1 are equivalent.
 588 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
 589 Logging with a DEBUG level violates the privacy of users and is not recommended.
 590 .It Cm MACs
 591 Specifies the available MAC (message authentication code) algorithms.
 592 The MAC algorithm is used in protocol version 2
 593 for data integrity protection.
 594 Multiple algorithms must be comma-separated.
 595 The default is:
 596 .Bd -literal -offset indent
 597 hmac-md5,hmac-sha1,umac-64@openssh.com,
 598 hmac-ripemd160,hmac-sha1-96,hmac-md5-96
 599 .Ed
 600 .It Cm Match
 601 Introduces a conditional block.
 602 If all of the criteria on the
 603 .Cm Match
 604 line are satisfied, the keywords on the following lines override those
 605 set in the global section of the config file, until either another
 606 .Cm Match
 607 line or the end of the file.
 608 .Pp
 609 The arguments to
 610 .Cm Match
 611 are one or more criteria-pattern pairs.
 612 The available criteria are
 613 .Cm User ,
 614 .Cm Group ,
 615 .Cm Host ,
 616 and
 617 .Cm Address .
 618 The match patterns may consist of single entries or comma-separated
 619 lists and may use the wildcard and negation operators described in the
 620 .Sx PATTERNS
 621 section of
 622 .Xr ssh_config 5 .
 623 .Pp
 624 The patterns in an
 625 .Cm Address
 626 criteria may additionally contain addresses to match in CIDR
 627 address/masklen format, e.g.\&
 628 .Dq 192.0.2.0/24
 629 or
 630 .Dq 3ffe:ffff::/32 .
 631 Note that the mask length provided must be consistent with the address -
 632 it is an error to specify a mask length that is too long for the address
 633 or one with bits set in this host portion of the address.
 634 For example,
 635 .Dq 192.0.2.0/33
 636 and
 637 .Dq 192.0.2.0/8
 638 respectively.
 639 .Pp
 640 Only a subset of keywords may be used on the lines following a
 641 .Cm Match
 642 keyword.
 643 Available keywords are
 644 .Cm AllowAgentForwarding ,
 645 .Cm AllowTcpForwarding ,
 646 .Cm Banner ,
 647 .Cm ChrootDirectory ,
 648 .Cm ForceCommand ,
 649 .Cm GatewayPorts ,
 650 .Cm GSSAPIAuthentication ,
 651 .Cm HostbasedAuthentication ,
 652 .Cm KbdInteractiveAuthentication ,
 653 .Cm KerberosAuthentication ,
 654 .Cm MaxAuthTries ,
 655 .Cm MaxSessions ,
 656 .Cm PasswordAuthentication ,
 657 .Cm PermitEmptyPasswords ,
 658 .Cm PermitOpen ,
 659 .Cm PermitRootLogin ,
 660 .Cm RhostsRSAAuthentication ,
 661 .Cm RSAAuthentication ,
 662 .Cm X11DisplayOffset ,
 663 .Cm X11Forwarding
 664 and
 665 .Cm X11UseLocalHost .
 666 .It Cm MaxAuthTries
 667 Specifies the maximum number of authentication attempts permitted per
 668 connection.
 669 Once the number of failures reaches half this value,
 670 additional failures are logged.
 671 The default is 6.
 672 .It Cm MaxSessions
 673 Specifies the maximum number of open sessions permitted per network connection.
 674 The default is 10.
 675 .It Cm MaxStartups
 676 Specifies the maximum number of concurrent unauthenticated connections to the
 677 SSH daemon.
 678 Additional connections will be dropped until authentication succeeds or the
 679 .Cm LoginGraceTime
 680 expires for a connection.
 681 The default is 10.
 682 .Pp
 683 Alternatively, random early drop can be enabled by specifying
 684 the three colon separated values
 685 .Dq start:rate:full
 686 (e.g. "10:30:60").
 687 .Xr sshd 8
 688 will refuse connection attempts with a probability of
 689 .Dq rate/100
 690 (30%)
 691 if there are currently
 692 .Dq start
 693 (10)
 694 unauthenticated connections.
 695 The probability increases linearly and all connection attempts
 696 are refused if the number of unauthenticated connections reaches
 697 .Dq full
 698 (60).
 699 .It Cm PasswordAuthentication
 700 Specifies whether password authentication is allowed.
 701 The default is
 702 .Dq yes .
 703 .It Cm PermitEmptyPasswords
 704 When password authentication is allowed, it specifies whether the
 705 server allows login to accounts with empty password strings.
 706 The default is
 707 .Dq no .
 708 .It Cm PermitOpen
 709 Specifies the destinations to which TCP port forwarding is permitted.
 710 The forwarding specification must be one of the following forms:
 711 .Pp
 712 .Bl -item -offset indent -compact
 713 .It
 714 .Cm PermitOpen
 715 .Sm off
 716 .Ar host : port
 717 .Sm on
 718 .It
 719 .Cm PermitOpen
 720 .Sm off
 721 .Ar IPv4_addr : port
 722 .Sm on
 723 .It
 724 .Cm PermitOpen
 725 .Sm off
 726 .Ar \&[ IPv6_addr \&] : port
 727 .Sm on
 728 .El
 729 .Pp
 730 Multiple forwards may be specified by separating them with whitespace.
 731 An argument of
 732 .Dq any
 733 can be used to remove all restrictions and permit any forwarding requests.
 734 By default all port forwarding requests are permitted.
 735 .It Cm PermitRootLogin
 736 Specifies whether root can log in using
 737 .Xr ssh 1 .
 738 The argument must be
 739 .Dq yes ,
 740 .Dq without-password ,
 741 .Dq forced-commands-only ,
 742 or
 743 .Dq no .
 744 The default is
 745 .Dq yes .
 746 .Pp
 747 If this option is set to
 748 .Dq without-password ,
 749 password authentication is disabled for root.
 750 .Pp
 751 If this option is set to
 752 .Dq forced-commands-only ,
 753 root login with public key authentication will be allowed,
 754 but only if the
 755 .Ar command
 756 option has been specified
 757 (which may be useful for taking remote backups even if root login is
 758 normally not allowed).
 759 All other authentication methods are disabled for root.
 760 .Pp
 761 If this option is set to
 762 .Dq no ,
 763 root is not allowed to log in.
 764 .It Cm PermitTunnel
 765 Specifies whether
 766 .Xr tun 4
 767 device forwarding is allowed.
 768 The argument must be
 769 .Dq yes ,
 770 .Dq point-to-point
 771 (layer 3),
 772 .Dq ethernet
 773 (layer 2), or
 774 .Dq no .
 775 Specifying
 776 .Dq yes
 777 permits both
 778 .Dq point-to-point
 779 and
 780 .Dq ethernet .
 781 The default is
 782 .Dq no .
 783 .It Cm PermitUserEnvironment
 784 Specifies whether
 785 .Pa ~/.ssh/environment
 786 and
 787 .Cm environment=
 788 options in
 789 .Pa ~/.ssh/authorized_keys
 790 are processed by
 791 .Xr sshd 8 .
 792 The default is
 793 .Dq no .
 794 Enabling environment processing may enable users to bypass access
 795 restrictions in some configurations using mechanisms such as
 796 .Ev LD_PRELOAD .
 797 .It Cm PidFile
 798 Specifies the file that contains the process ID of the
 799 SSH daemon.
 800 The default is
 801 .Pa /var/run/sshd.pid .
 802 .It Cm Port
 803 Specifies the port number that
 804 .Xr sshd 8
 805 listens on.
 806 The default is 22.
 807 Multiple options of this type are permitted.
 808 See also
 809 .Cm ListenAddress .
 810 .It Cm PrintLastLog
 811 Specifies whether
 812 .Xr sshd 8
 813 should print the date and time of the last user login when a user logs
 814 in interactively.
 815 The default is
 816 .Dq yes .
 817 .It Cm PrintMotd
 818 Specifies whether
 819 .Xr sshd 8
 820 should print
 821 .Pa /etc/motd
 822 when a user logs in interactively.
 823 (On some systems it is also printed by the shell,
 824 .Pa /etc/profile ,
 825 or equivalent.)
 826 The default is
 827 .Dq yes .
 828 .It Cm Protocol
 829 Specifies the protocol versions
 830 .Xr sshd 8
 831 supports.
 832 The possible values are
 833 .Sq 1
 834 and
 835 .Sq 2 .
 836 Multiple versions must be comma-separated.
 837 The default is
 838 .Dq 2,1 .
 839 Note that the order of the protocol list does not indicate preference,
 840 because the client selects among multiple protocol versions offered
 841 by the server.
 842 Specifying
 843 .Dq 2,1
 844 is identical to
 845 .Dq 1,2 .
 846 .It Cm PubkeyAuthentication
 847 Specifies whether public key authentication is allowed.
 848 The default is
 849 .Dq yes .
 850 Note that this option applies to protocol version 2 only.
 851 .It Cm RhostsRSAAuthentication
 852 Specifies whether rhosts or /etc/hosts.equiv authentication together
 853 with successful RSA host authentication is allowed.
 854 The default is
 855 .Dq no .
 856 This option applies to protocol version 1 only.
 857 .It Cm RSAAuthentication
 858 Specifies whether pure RSA authentication is allowed.
 859 The default is
 860 .Dq yes .
 861 This option applies to protocol version 1 only.
 862 .It Cm ServerKeyBits
 863 Defines the number of bits in the ephemeral protocol version 1 server key.
 864 The minimum value is 512, and the default is 1024.
 865 .It Cm StrictModes
 866 Specifies whether
 867 .Xr sshd 8
 868 should check file modes and ownership of the
 869 user's files and home directory before accepting login.
 870 This is normally desirable because novices sometimes accidentally leave their
 871 directory or files world-writable.
 872 The default is
 873 .Dq yes .
 874 .It Cm Subsystem
 875 Configures an external subsystem (e.g. file transfer daemon).
 876 Arguments should be a subsystem name and a command (with optional arguments)
 877 to execute upon subsystem request.
 878 .Pp
 879 The command
 880 .Xr sftp-server 8
 881 implements the
 882 .Dq sftp
 883 file transfer subsystem.
 884 .Pp
 885 Alternately the name
 886 .Dq internal-sftp
 887 implements an in-process
 888 .Dq sftp
 889 server.
 890 This may simplify configurations using
 891 .Cm ChrootDirectory
 892 to force a different filesystem root on clients.
 893 .Pp
 894 By default no subsystems are defined.
 895 Note that this option applies to protocol version 2 only.
 896 .It Cm SyslogFacility
 897 Gives the facility code that is used when logging messages from
 898 .Xr sshd 8 .
 899 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
 900 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
 901 The default is AUTH.
 902 .It Cm TCPKeepAlive
 903 Specifies whether the system should send TCP keepalive messages to the
 904 other side.
 905 If they are sent, death of the connection or crash of one
 906 of the machines will be properly noticed.
 907 However, this means that
 908 connections will die if the route is down temporarily, and some people
 909 find it annoying.
 910 On the other hand, if TCP keepalives are not sent,
 911 sessions may hang indefinitely on the server, leaving
 912 .Dq ghost
 913 users and consuming server resources.
 914 .Pp
 915 The default is
 916 .Dq yes
 917 (to send TCP keepalive messages), and the server will notice
 918 if the network goes down or the client host crashes.
 919 This avoids infinitely hanging sessions.
 920 .Pp
 921 To disable TCP keepalive messages, the value should be set to
 922 .Dq no .
 923 .It Cm UseDNS
 924 Specifies whether
 925 .Xr sshd 8
 926 should look up the remote host name and check that
 927 the resolved host name for the remote IP address maps back to the
 928 very same IP address.
 929 The default is
 930 .Dq yes .
 931 .It Cm UseLogin
 932 Specifies whether
 933 .Xr login 1
 934 is used for interactive login sessions.
 935 The default is
 936 .Dq no .
 937 Note that
 938 .Xr login 1
 939 is never used for remote command execution.
 940 Note also, that if this is enabled,
 941 .Cm X11Forwarding
 942 will be disabled because
 943 .Xr login 1
 944 does not know how to handle
 945 .Xr xauth 1
 946 cookies.
 947 If
 948 .Cm UsePrivilegeSeparation
 949 is specified, it will be disabled after authentication.
 950 .It Cm UsePAM
 951 Enables the Pluggable Authentication Module interface.
 952 If set to
 953 .Dq yes
 954 this will enable PAM authentication using
 955 .Cm ChallengeResponseAuthentication
 956 and
 957 .Cm PasswordAuthentication
 958 in addition to PAM account and session module processing for all
 959 authentication types.
 960 .Pp
 961 Because PAM challenge-response authentication usually serves an equivalent
 962 role to password authentication, you should disable either
 963 .Cm PasswordAuthentication
 964 or
 965 .Cm ChallengeResponseAuthentication.
 966 .Pp
 967 If
 968 .Cm UsePAM
 969 is enabled, you will not be able to run
 970 .Xr sshd 8
 971 as a non-root user.
 972 The default is
 973 .Dq no .
 974 .It Cm PermitPAMUserChange
 975 If set to
 976 .Dq yes
 977 this will enable PAM authentication to change the name of the user being
 978 authenticated.  The default is
 979 .Dq no .
 980 .It Cm UsePrivilegeSeparation
 981 Specifies whether
 982 .Xr sshd 8
 983 separates privileges by creating an unprivileged child process
 984 to deal with incoming network traffic.
 985 After successful authentication, another process will be created that has
 986 the privilege of the authenticated user.
 987 The goal of privilege separation is to prevent privilege
 988 escalation by containing any corruption within the unprivileged processes.
 989 The default is
 990 .Dq yes .
 991 .It Cm X11DisplayOffset
 992 Specifies the first display number available for
 993 .Xr sshd 8 Ns 's
 994 X11 forwarding.
 995 This prevents sshd from interfering with real X11 servers.
 996 The default is 10.
 997 .It Cm X11Forwarding
 998 Specifies whether X11 forwarding is permitted.
 999 The argument must be
1000 .Dq yes
1001 or
1002 .Dq no .
1003 The default is
1004 .Dq no .
1005 .Pp
1006 When X11 forwarding is enabled, there may be additional exposure to
1007 the server and to client displays if the
1008 .Xr sshd 8
1009 proxy display is configured to listen on the wildcard address (see
1010 .Cm X11UseLocalhost
1011 below), though this is not the default.
1012 Additionally, the authentication spoofing and authentication data
1013 verification and substitution occur on the client side.
1014 The security risk of using X11 forwarding is that the client's X11
1015 display server may be exposed to attack when the SSH client requests
1016 forwarding (see the warnings for
1017 .Cm ForwardX11
1018 in
1019 .Xr ssh_config 5 ) .
1020 A system administrator may have a stance in which they want to
1021 protect clients that may expose themselves to attack by unwittingly
1022 requesting X11 forwarding, which can warrant a
1023 .Dq no
1024 setting.
1025 .Pp
1026 Note that disabling X11 forwarding does not prevent users from
1027 forwarding X11 traffic, as users can always install their own forwarders.
1028 X11 forwarding is automatically disabled if
1029 .Cm UseLogin
1030 is enabled.
1031 .It Cm X11UseLocalhost
1032 Specifies whether
1033 .Xr sshd 8
1034 should bind the X11 forwarding server to the loopback address or to
1035 the wildcard address.
1036 By default,
1037 sshd binds the forwarding server to the loopback address and sets the
1038 hostname part of the
1039 .Ev DISPLAY
1040 environment variable to
1041 .Dq localhost .
1042 This prevents remote hosts from connecting to the proxy display.
1043 However, some older X11 clients may not function with this
1044 configuration.
1045 .Cm X11UseLocalhost
1046 may be set to
1047 .Dq no
1048 to specify that the forwarding server should be bound to the wildcard
1049 address.
1050 The argument must be
1051 .Dq yes
1052 or
1053 .Dq no .
1054 The default is
1055 .Dq yes .
1056 .It Cm XAuthLocation
1057 Specifies the full pathname of the
1058 .Xr xauth 1
1059 program.
1060 The default is
1061 .Pa /usr/X11R6/bin/xauth .
1062 .El
1063 .Sh TIME FORMATS
1064 .Xr sshd 8
1065 command-line arguments and configuration file options that specify time
1066 may be expressed using a sequence of the form:
1067 .Sm off
1068 .Ar time Op Ar qualifier ,
1069 .Sm on
1070 where
1071 .Ar time
1072 is a positive integer value and
1073 .Ar qualifier
1074 is one of the following:
1075 .Pp
1076 .Bl -tag -width Ds -compact -offset indent
1077 .It Aq Cm none
1078 seconds
1079 .It Cm s | Cm S
1080 seconds
1081 .It Cm m | Cm M
1082 minutes
1083 .It Cm h | Cm H
1084 hours
1085 .It Cm d | Cm D
1086 days
1087 .It Cm w | Cm W
1088 weeks
1089 .El
1090 .Pp
1091 Each member of the sequence is added together to calculate
1092 the total time value.
1093 .Pp
1094 Time format examples:
1095 .Pp
1096 .Bl -tag -width Ds -compact -offset indent
1097 .It 600
1098 600 seconds (10 minutes)
1099 .It 10m
1100 10 minutes
1101 .It 1h30m
1102 1 hour 30 minutes (90 minutes)
1103 .El
1104 .Sh FILES
1105 .Bl -tag -width Ds
1106 .It Pa /etc/ssh/sshd_config
1107 Contains configuration data for
1108 .Xr sshd 8 .
1109 This file should be writable by root only, but it is recommended
1110 (though not necessary) that it be world-readable.
1111 .El
1112 .Sh SEE ALSO
1113 .Xr sshd 8
1114 .Sh AUTHORS
1115 OpenSSH is a derivative of the original and free
1116 ssh 1.2.12 release by Tatu Ylonen.
1117 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1118 Theo de Raadt and Dug Song
1119 removed many bugs, re-added newer features and
1120 created OpenSSH.
1121 Markus Friedl contributed the support for SSH
1122 protocol versions 1.5 and 2.0.
1123 Niels Provos and Markus Friedl contributed support
1124 for privilege separation.