openssh/sshd_config.5

   1 .\"  -*- nroff -*-
   2 .\"
   3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   5 .\"                    All rights reserved
   6 .\"
   7 .\" As far as I am concerned, the code I have written for this software
   8 .\" can be used freely for any purpose.  Any derived versions of this
   9 .\" software must be clearly marked as such, and if the derived work is
  10 .\" incompatible with the protocol description in the RFC file, it must be
  11 .\" called by a name other than "ssh" or "Secure Shell".
  12 .\"
  13 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
  14 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
  15 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
  16 .\"
  17 .\" Redistribution and use in source and binary forms, with or without
  18 .\" modification, are permitted provided that the following conditions
  19 .\" are met:
  20 .\" 1. Redistributions of source code must retain the above copyright
  21 .\"    notice, this list of conditions and the following disclaimer.
  22 .\" 2. Redistributions in binary form must reproduce the above copyright
  23 .\"    notice, this list of conditions and the following disclaimer in the
  24 .\"    documentation and/or other materials provided with the distribution.
  25 .\"
  26 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  27 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  28 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  30 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  35 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .\" $OpenBSD: sshd_config.5,v 1.96 2008/07/02 02:24:18 djm Exp $
  38 .Dd $Mdocdate: July 2 2008 $
  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-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
 244 arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
 245 aes192-ctr,aes256-ctr
 246 .Ed
 247 .It Cm ClientAliveCountMax
 248 Sets the number of client alive messages (see below) which may be
 249 sent without
 250 .Xr sshd 8
 251 receiving any messages back from the client.
 252 If this threshold is reached while client alive messages are being sent,
 253 sshd will disconnect the client, terminating the session.
 254 It is important to note that the use of client alive messages is very
 255 different from
 256 .Cm TCPKeepAlive
 257 (below).
 258 The client alive messages are sent through the encrypted channel
 259 and therefore will not be spoofable.
 260 The TCP keepalive option enabled by
 261 .Cm TCPKeepAlive
 262 is spoofable.
 263 The client alive mechanism is valuable when the client or
 264 server depend on knowing when a connection has become inactive.
 265 .Pp
 266 The default value is 3.
 267 If
 268 .Cm ClientAliveInterval
 269 (see below) is set to 15, and
 270 .Cm ClientAliveCountMax
 271 is left at the default, unresponsive SSH clients
 272 will be disconnected after approximately 45 seconds.
 273 This option applies to protocol version 2 only.
 274 .It Cm ClientAliveInterval
 275 Sets a timeout interval in seconds after which if no data has been received
 276 from the client,
 277 .Xr sshd 8
 278 will send a message through the encrypted
 279 channel to request a response from the client.
 280 The default
 281 is 0, indicating that these messages will not be sent to the client.
 282 This option applies to protocol version 2 only.
 283 .It Cm Compression
 284 Specifies whether compression is allowed, or delayed until
 285 the user has authenticated successfully.
 286 The argument must be
 287 .Dq yes ,
 288 .Dq delayed ,
 289 or
 290 .Dq no .
 291 The default is
 292 .Dq delayed .
 293 .It Cm DenyGroups
 294 This keyword can be followed by a list of group name patterns, separated
 295 by spaces.
 296 Login is disallowed for users whose primary group or supplementary
 297 group list matches one of the patterns.
 298 Only group names are valid; a numerical group ID is not recognized.
 299 By default, login is allowed for all groups.
 300 The allow/deny directives are processed in the following order:
 301 .Cm DenyUsers ,
 302 .Cm AllowUsers ,
 303 .Cm DenyGroups ,
 304 and finally
 305 .Cm AllowGroups .
 306 .Pp
 307 See
 308 .Sx PATTERNS
 309 in
 310 .Xr ssh_config 5
 311 for more information on patterns.
 312 .It Cm DenyUsers
 313 This keyword can be followed by a list of user name patterns, separated
 314 by spaces.
 315 Login is disallowed for user names that match one of the patterns.
 316 Only user names are valid; a numerical user ID is not recognized.
 317 By default, login is allowed for all users.
 318 If the pattern takes the form USER@HOST then USER and HOST
 319 are separately checked, restricting logins to particular
 320 users from particular hosts.
 321 The allow/deny directives are processed in the following order:
 322 .Cm DenyUsers ,
 323 .Cm AllowUsers ,
 324 .Cm DenyGroups ,
 325 and finally
 326 .Cm AllowGroups .
 327 .Pp
 328 See
 329 .Sx PATTERNS
 330 in
 331 .Xr ssh_config 5
 332 for more information on patterns.
 333 .It Cm ForceCommand
 334 Forces the execution of the command specified by
 335 .Cm ForceCommand ,
 336 ignoring any command supplied by the client and
 337 .Pa ~/.ssh/rc
 338 if present.
 339 The command is invoked by using the user's login shell with the -c option.
 340 This applies to shell, command, or subsystem execution.
 341 It is most useful inside a
 342 .Cm Match
 343 block.
 344 The command originally supplied by the client is available in the
 345 .Ev SSH_ORIGINAL_COMMAND
 346 environment variable.
 347 Specifying a command of
 348 .Dq internal-sftp
 349 will force the use of an in-process sftp server that requires no support
 350 files when used with
 351 .Cm ChrootDirectory .
 352 .It Cm GatewayPorts
 353 Specifies whether remote hosts are allowed to connect to ports
 354 forwarded for the client.
 355 By default,
 356 .Xr sshd 8
 357 binds remote port forwardings to the loopback address.
 358 This prevents other remote hosts from connecting to forwarded ports.
 359 .Cm GatewayPorts
 360 can be used to specify that sshd
 361 should allow remote port forwardings to bind to non-loopback addresses, thus
 362 allowing other hosts to connect.
 363 The argument may be
 364 .Dq no
 365 to force remote port forwardings to be available to the local host only,
 366 .Dq yes
 367 to force remote port forwardings to bind to the wildcard address, or
 368 .Dq clientspecified
 369 to allow the client to select the address to which the forwarding is bound.
 370 The default is
 371 .Dq no .
 372 .It Cm GSSAPIAuthentication
 373 Specifies whether user authentication based on GSSAPI is allowed.
 374 The default is
 375 .Dq 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 GSSAPIStrictAcceptorCheck
 394 Determines whether to be strict about the identity of the GSSAPI acceptor
 395 a client authenticates against. If
 396 .Dq yes
 397 then the client must authenticate against the
 398 .Pa host
 399 service on the current hostname. If
 400 .Dq no
 401 then the client may authenticate against any service key stored in the
 402 machine's default store. This facility is provided to assist with operation
 403 on multi homed machines.
 404 The default is
 405 .Dq yes .
 406 Note that this option applies only to protocol version 2 GSSAPI connections,
 407 and setting it to
 408 .Dq no
 409 may only work with recent Kerberos GSSAPI libraries.
 410 .It Cm GSSAPICredentialsPath
 411 If specified, the delegated GSSAPI credential is stored in the
 412 given path, overwriting any existing credentials.
 413 Paths can be specified with syntax similar to the AuthorizedKeysFile
 414 option (i.e., accepting %h and %u tokens).
 415 When using this option,
 416 setting 'GssapiCleanupCredentials no' is recommended,
 417 so logging out of one session
 418 doesn't remove the credentials in use by another session of
 419 the same user.
 420 Currently only implemented for the GSI mechanism.
 421 .It Cm GSIAllowLimitedProxy
 422 Specifies whether to accept limited proxy credentials for
 423 authentication.
 424 The default is
 425 .Dq no .
 426 .It Cm HostbasedAuthentication
 427 Specifies whether rhosts or /etc/hosts.equiv authentication together
 428 with successful public key client host authentication is allowed
 429 (host-based authentication).
 430 This option is similar to
 431 .Cm RhostsRSAAuthentication
 432 and applies to protocol version 2 only.
 433 The default is
 434 .Dq no .
 435 .It Cm HostbasedUsesNameFromPacketOnly
 436 Specifies whether or not the server will attempt to perform a reverse
 437 name lookup when matching the name in the
 438 .Pa ~/.shosts ,
 439 .Pa ~/.rhosts ,
 440 and
 441 .Pa /etc/hosts.equiv
 442 files during
 443 .Cm HostbasedAuthentication .
 444 A setting of
 445 .Dq yes
 446 means that
 447 .Xr sshd 8
 448 uses the name supplied by the client rather than
 449 attempting to resolve the name from the TCP connection itself.
 450 The default is
 451 .Dq no .
 452 .It Cm HostKey
 453 Specifies a file containing a private host key
 454 used by SSH.
 455 The default is
 456 .Pa /etc/ssh/ssh_host_key
 457 for protocol version 1, and
 458 .Pa /etc/ssh/ssh_host_rsa_key
 459 and
 460 .Pa /etc/ssh/ssh_host_dsa_key
 461 for protocol version 2.
 462 Note that
 463 .Xr sshd 8
 464 will refuse to use a file if it is group/world-accessible.
 465 It is possible to have multiple host key files.
 466 .Dq rsa1
 467 keys are used for version 1 and
 468 .Dq dsa
 469 or
 470 .Dq rsa
 471 are used for version 2 of the SSH protocol.
 472 .It Cm IgnoreRhosts
 473 Specifies that
 474 .Pa .rhosts
 475 and
 476 .Pa .shosts
 477 files will not be used in
 478 .Cm RhostsRSAAuthentication
 479 or
 480 .Cm HostbasedAuthentication .
 481 .Pp
 482 .Pa /etc/hosts.equiv
 483 and
 484 .Pa /etc/shosts.equiv
 485 are still used.
 486 The default is
 487 .Dq yes .
 488 .It Cm IgnoreUserKnownHosts
 489 Specifies whether
 490 .Xr sshd 8
 491 should ignore the user's
 492 .Pa ~/.ssh/known_hosts
 493 during
 494 .Cm RhostsRSAAuthentication
 495 or
 496 .Cm HostbasedAuthentication .
 497 The default is
 498 .Dq no .
 499 .It Cm KerberosAuthentication
 500 Specifies whether the password provided by the user for
 501 .Cm PasswordAuthentication
 502 will be validated through the Kerberos KDC.
 503 To use this option, the server needs a
 504 Kerberos servtab which allows the verification of the KDC's identity.
 505 The default is
 506 .Dq no .
 507 .It Cm KerberosGetAFSToken
 508 If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
 509 an AFS token before accessing the user's home directory.
 510 The default is
 511 .Dq no .
 512 .It Cm KerberosOrLocalPasswd
 513 If password authentication through Kerberos fails then
 514 the password will be validated via any additional local mechanism
 515 such as
 516 .Pa /etc/passwd .
 517 The default is
 518 .Dq yes .
 519 .It Cm KerberosTicketCleanup
 520 Specifies whether to automatically destroy the user's ticket cache
 521 file on logout.
 522 The default is
 523 .Dq yes .
 524 .It Cm KeyRegenerationInterval
 525 In protocol version 1, the ephemeral server key is automatically regenerated
 526 after this many seconds (if it has been used).
 527 The purpose of regeneration is to prevent
 528 decrypting captured sessions by later breaking into the machine and
 529 stealing the keys.
 530 The key is never stored anywhere.
 531 If the value is 0, the key is never regenerated.
 532 The default is 3600 (seconds).
 533 .It Cm ListenAddress
 534 Specifies the local addresses
 535 .Xr sshd 8
 536 should listen on.
 537 The following forms may be used:
 538 .Pp
 539 .Bl -item -offset indent -compact
 540 .It
 541 .Cm ListenAddress
 542 .Sm off
 543 .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
 544 .Sm on
 545 .It
 546 .Cm ListenAddress
 547 .Sm off
 548 .Ar host No | Ar IPv4_addr No : Ar port
 549 .Sm on
 550 .It
 551 .Cm ListenAddress
 552 .Sm off
 553 .Oo
 554 .Ar host No | Ar IPv6_addr Oc : Ar port
 555 .Sm on
 556 .El
 557 .Pp
 558 If
 559 .Ar port
 560 is not specified,
 561 sshd will listen on the address and all prior
 562 .Cm Port
 563 options specified.
 564 The default is to listen on all local addresses.
 565 Multiple
 566 .Cm ListenAddress
 567 options are permitted.
 568 Additionally, any
 569 .Cm Port
 570 options must precede this option for non-port qualified addresses.
 571 .It Cm LoginGraceTime
 572 The server disconnects after this time if the user has not
 573 successfully logged in.
 574 If the value is 0, there is no time limit.
 575 The default is 120 seconds.
 576 .It Cm LogLevel
 577 Gives the verbosity level that is used when logging messages from
 578 .Xr sshd 8 .
 579 The possible values are:
 580 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
 581 The default is INFO.
 582 DEBUG and DEBUG1 are equivalent.
 583 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
 584 Logging with a DEBUG level violates the privacy of users and is not recommended.
 585 .It Cm MACs
 586 Specifies the available MAC (message authentication code) algorithms.
 587 The MAC algorithm is used in protocol version 2
 588 for data integrity protection.
 589 Multiple algorithms must be comma-separated.
 590 The default is:
 591 .Bd -literal -offset indent
 592 hmac-md5,hmac-sha1,umac-64@openssh.com,
 593 hmac-ripemd160,hmac-sha1-96,hmac-md5-96
 594 .Ed
 595 .It Cm Match
 596 Introduces a conditional block.
 597 If all of the criteria on the
 598 .Cm Match
 599 line are satisfied, the keywords on the following lines override those
 600 set in the global section of the config file, until either another
 601 .Cm Match
 602 line or the end of the file.
 603 .Pp
 604 The arguments to
 605 .Cm Match
 606 are one or more criteria-pattern pairs.
 607 The available criteria are
 608 .Cm User ,
 609 .Cm Group ,
 610 .Cm Host ,
 611 and
 612 .Cm Address .
 613 The match patterns may consist of single entries or comma-separated
 614 lists and may use the wildcard and negation operators described in the
 615 .Sx PATTERNS
 616 section of
 617 .Xr ssh_config 5 .
 618 .Pp
 619 The patterns in an
 620 .Cm Address
 621 criteria may additionally contain addresses to match in CIDR
 622 address/masklen format, e.g.\&
 623 .Dq 192.0.2.0/24
 624 or
 625 .Dq 3ffe:ffff::/32 .
 626 Note that the mask length provided must be consistent with the address -
 627 it is an error to specify a mask length that is too long for the address
 628 or one with bits set in this host portion of the address.
 629 For example,
 630 .Dq 192.0.2.0/33
 631 and
 632 .Dq 192.0.2.0/8
 633 respectively.
 634 .Pp
 635 Only a subset of keywords may be used on the lines following a
 636 .Cm Match
 637 keyword.
 638 Available keywords are
 639 .Cm AllowTcpForwarding ,
 640 .Cm Banner ,
 641 .Cm ChrootDirectory ,
 642 .Cm ForceCommand ,
 643 .Cm GatewayPorts ,
 644 .Cm GSSAPIAuthentication ,
 645 .Cm HostbasedAuthentication ,
 646 .Cm KbdInteractiveAuthentication ,
 647 .Cm KerberosAuthentication ,
 648 .Cm MaxAuthTries ,
 649 .Cm MaxSessions ,
 650 .Cm PasswordAuthentication ,
 651 .Cm PermitOpen ,
 652 .Cm PermitRootLogin ,
 653 .Cm RhostsRSAAuthentication ,
 654 .Cm RSAAuthentication ,
 655 .Cm X11DisplayOffset ,
 656 .Cm X11Forwarding ,
 657 and
 658 .Cm X11UseLocalHost .
 659 .It Cm MaxAuthTries
 660 Specifies the maximum number of authentication attempts permitted per
 661 connection.
 662 Once the number of failures reaches half this value,
 663 additional failures are logged.
 664 The default is 6.
 665 .It Cm MaxSessions
 666 Specifies the maximum number of open sessions permitted per network connection.
 667 The default is 10.
 668 .It Cm MaxStartups
 669 Specifies the maximum number of concurrent unauthenticated connections to the
 670 SSH daemon.
 671 Additional connections will be dropped until authentication succeeds or the
 672 .Cm LoginGraceTime
 673 expires for a connection.
 674 The default is 10.
 675 .Pp
 676 Alternatively, random early drop can be enabled by specifying
 677 the three colon separated values
 678 .Dq start:rate:full
 679 (e.g. "10:30:60").
 680 .Xr sshd 8
 681 will refuse connection attempts with a probability of
 682 .Dq rate/100
 683 (30%)
 684 if there are currently
 685 .Dq start
 686 (10)
 687 unauthenticated connections.
 688 The probability increases linearly and all connection attempts
 689 are refused if the number of unauthenticated connections reaches
 690 .Dq full
 691 (60).
 692 .It Cm PasswordAuthentication
 693 Specifies whether password authentication is allowed.
 694 The default is
 695 .Dq yes .
 696 .It Cm PermitEmptyPasswords
 697 When password authentication is allowed, it specifies whether the
 698 server allows login to accounts with empty password strings.
 699 The default is
 700 .Dq no .
 701 .It Cm PermitOpen
 702 Specifies the destinations to which TCP port forwarding is permitted.
 703 The forwarding specification must be one of the following forms:
 704 .Pp
 705 .Bl -item -offset indent -compact
 706 .It
 707 .Cm PermitOpen
 708 .Sm off
 709 .Ar host : port
 710 .Sm on
 711 .It
 712 .Cm PermitOpen
 713 .Sm off
 714 .Ar IPv4_addr : port
 715 .Sm on
 716 .It
 717 .Cm PermitOpen
 718 .Sm off
 719 .Ar \&[ IPv6_addr \&] : port
 720 .Sm on
 721 .El
 722 .Pp
 723 Multiple forwards may be specified by separating them with whitespace.
 724 An argument of
 725 .Dq any
 726 can be used to remove all restrictions and permit any forwarding requests.
 727 By default all port forwarding requests are permitted.
 728 .It Cm PermitRootLogin
 729 Specifies whether root can log in using
 730 .Xr ssh 1 .
 731 The argument must be
 732 .Dq yes ,
 733 .Dq without-password ,
 734 .Dq forced-commands-only ,
 735 or
 736 .Dq no .
 737 The default is
 738 .Dq yes .
 739 .Pp
 740 If this option is set to
 741 .Dq without-password ,
 742 password authentication is disabled for root.
 743 .Pp
 744 If this option is set to
 745 .Dq forced-commands-only ,
 746 root login with public key authentication will be allowed,
 747 but only if the
 748 .Ar command
 749 option has been specified
 750 (which may be useful for taking remote backups even if root login is
 751 normally not allowed).
 752 All other authentication methods are disabled for root.
 753 .Pp
 754 If this option is set to
 755 .Dq no ,
 756 root is not allowed to log in.
 757 .It Cm PermitTunnel
 758 Specifies whether
 759 .Xr tun 4
 760 device forwarding is allowed.
 761 The argument must be
 762 .Dq yes ,
 763 .Dq point-to-point
 764 (layer 3),
 765 .Dq ethernet
 766 (layer 2), or
 767 .Dq no .
 768 Specifying
 769 .Dq yes
 770 permits both
 771 .Dq point-to-point
 772 and
 773 .Dq ethernet .
 774 The default is
 775 .Dq no .
 776 .It Cm PermitUserEnvironment
 777 Specifies whether
 778 .Pa ~/.ssh/environment
 779 and
 780 .Cm environment=
 781 options in
 782 .Pa ~/.ssh/authorized_keys
 783 are processed by
 784 .Xr sshd 8 .
 785 The default is
 786 .Dq no .
 787 Enabling environment processing may enable users to bypass access
 788 restrictions in some configurations using mechanisms such as
 789 .Ev LD_PRELOAD .
 790 .It Cm PidFile
 791 Specifies the file that contains the process ID of the
 792 SSH daemon.
 793 The default is
 794 .Pa /var/run/sshd.pid .
 795 .It Cm Port
 796 Specifies the port number that
 797 .Xr sshd 8
 798 listens on.
 799 The default is 22.
 800 Multiple options of this type are permitted.
 801 See also
 802 .Cm ListenAddress .
 803 .It Cm PrintLastLog
 804 Specifies whether
 805 .Xr sshd 8
 806 should print the date and time of the last user login when a user logs
 807 in interactively.
 808 The default is
 809 .Dq yes .
 810 .It Cm PrintMotd
 811 Specifies whether
 812 .Xr sshd 8
 813 should print
 814 .Pa /etc/motd
 815 when a user logs in interactively.
 816 (On some systems it is also printed by the shell,
 817 .Pa /etc/profile ,
 818 or equivalent.)
 819 The default is
 820 .Dq yes .
 821 .It Cm Protocol
 822 Specifies the protocol versions
 823 .Xr sshd 8
 824 supports.
 825 The possible values are
 826 .Sq 1
 827 and
 828 .Sq 2 .
 829 Multiple versions must be comma-separated.
 830 The default is
 831 .Dq 2,1 .
 832 Note that the order of the protocol list does not indicate preference,
 833 because the client selects among multiple protocol versions offered
 834 by the server.
 835 Specifying
 836 .Dq 2,1
 837 is identical to
 838 .Dq 1,2 .
 839 .It Cm PubkeyAuthentication
 840 Specifies whether public key authentication is allowed.
 841 The default is
 842 .Dq yes .
 843 Note that this option applies to protocol version 2 only.
 844 .It Cm RhostsRSAAuthentication
 845 Specifies whether rhosts or /etc/hosts.equiv authentication together
 846 with successful RSA host authentication is allowed.
 847 The default is
 848 .Dq no .
 849 This option applies to protocol version 1 only.
 850 .It Cm RSAAuthentication
 851 Specifies whether pure RSA authentication is allowed.
 852 The default is
 853 .Dq yes .
 854 This option applies to protocol version 1 only.
 855 .It Cm ServerKeyBits
 856 Defines the number of bits in the ephemeral protocol version 1 server key.
 857 The minimum value is 512, and the default is 1024.
 858 .It Cm StrictModes
 859 Specifies whether
 860 .Xr sshd 8
 861 should check file modes and ownership of the
 862 user's files and home directory before accepting login.
 863 This is normally desirable because novices sometimes accidentally leave their
 864 directory or files world-writable.
 865 The default is
 866 .Dq yes .
 867 .It Cm Subsystem
 868 Configures an external subsystem (e.g. file transfer daemon).
 869 Arguments should be a subsystem name and a command (with optional arguments)
 870 to execute upon subsystem request.
 871 .Pp
 872 The command
 873 .Xr sftp-server 8
 874 implements the
 875 .Dq sftp
 876 file transfer subsystem.
 877 .Pp
 878 Alternately the name
 879 .Dq internal-sftp
 880 implements an in-process
 881 .Dq sftp
 882 server.
 883 This may simplify configurations using
 884 .Cm ChrootDirectory
 885 to force a different filesystem root on clients.
 886 .Pp
 887 By default no subsystems are defined.
 888 Note that this option applies to protocol version 2 only.
 889 .It Cm SyslogFacility
 890 Gives the facility code that is used when logging messages from
 891 .Xr sshd 8 .
 892 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
 893 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
 894 The default is AUTH.
 895 .It Cm TCPKeepAlive
 896 Specifies whether the system should send TCP keepalive messages to the
 897 other side.
 898 If they are sent, death of the connection or crash of one
 899 of the machines will be properly noticed.
 900 However, this means that
 901 connections will die if the route is down temporarily, and some people
 902 find it annoying.
 903 On the other hand, if TCP keepalives are not sent,
 904 sessions may hang indefinitely on the server, leaving
 905 .Dq ghost
 906 users and consuming server resources.
 907 .Pp
 908 The default is
 909 .Dq yes
 910 (to send TCP keepalive messages), and the server will notice
 911 if the network goes down or the client host crashes.
 912 This avoids infinitely hanging sessions.
 913 .Pp
 914 To disable TCP keepalive messages, the value should be set to
 915 .Dq no .
 916 .It Cm UseDNS
 917 Specifies whether
 918 .Xr sshd 8
 919 should look up the remote host name and check that
 920 the resolved host name for the remote IP address maps back to the
 921 very same IP address.
 922 The default is
 923 .Dq yes .
 924 .It Cm UseLogin
 925 Specifies whether
 926 .Xr login 1
 927 is used for interactive login sessions.
 928 The default is
 929 .Dq no .
 930 Note that
 931 .Xr login 1
 932 is never used for remote command execution.
 933 Note also, that if this is enabled,
 934 .Cm X11Forwarding
 935 will be disabled because
 936 .Xr login 1
 937 does not know how to handle
 938 .Xr xauth 1
 939 cookies.
 940 If
 941 .Cm UsePrivilegeSeparation
 942 is specified, it will be disabled after authentication.
 943 .It Cm UsePAM
 944 Enables the Pluggable Authentication Module interface.
 945 If set to
 946 .Dq yes
 947 this will enable PAM authentication using
 948 .Cm ChallengeResponseAuthentication
 949 and
 950 .Cm PasswordAuthentication
 951 in addition to PAM account and session module processing for all
 952 authentication types.
 953 .Pp
 954 Because PAM challenge-response authentication usually serves an equivalent
 955 role to password authentication, you should disable either
 956 .Cm PasswordAuthentication
 957 or
 958 .Cm ChallengeResponseAuthentication.
 959 .Pp
 960 If
 961 .Cm UsePAM
 962 is enabled, you will not be able to run
 963 .Xr sshd 8
 964 as a non-root user.
 965 The default is
 966 .Dq no .
 967 .It Cm UsePrivilegeSeparation
 968 Specifies whether
 969 .Xr sshd 8
 970 separates privileges by creating an unprivileged child process
 971 to deal with incoming network traffic.
 972 After successful authentication, another process will be created that has
 973 the privilege of the authenticated user.
 974 The goal of privilege separation is to prevent privilege
 975 escalation by containing any corruption within the unprivileged processes.
 976 The default is
 977 .Dq yes .
 978 .It Cm X11DisplayOffset
 979 Specifies the first display number available for
 980 .Xr sshd 8 Ns 's
 981 X11 forwarding.
 982 This prevents sshd from interfering with real X11 servers.
 983 The default is 10.
 984 .It Cm X11Forwarding
 985 Specifies whether X11 forwarding is permitted.
 986 The argument must be
 987 .Dq yes
 988 or
 989 .Dq no .
 990 The default is
 991 .Dq no .
 992 .Pp
 993 When X11 forwarding is enabled, there may be additional exposure to
 994 the server and to client displays if the
 995 .Xr sshd 8
 996 proxy display is configured to listen on the wildcard address (see
 997 .Cm X11UseLocalhost
 998 below), though this is not the default.
 999 Additionally, the authentication spoofing and authentication data
1000 verification and substitution occur on the client side.
1001 The security risk of using X11 forwarding is that the client's X11
1002 display server may be exposed to attack when the SSH client requests
1003 forwarding (see the warnings for
1004 .Cm ForwardX11
1005 in
1006 .Xr ssh_config 5 ) .
1007 A system administrator may have a stance in which they want to
1008 protect clients that may expose themselves to attack by unwittingly
1009 requesting X11 forwarding, which can warrant a
1010 .Dq no
1011 setting.
1012 .Pp
1013 Note that disabling X11 forwarding does not prevent users from
1014 forwarding X11 traffic, as users can always install their own forwarders.
1015 X11 forwarding is automatically disabled if
1016 .Cm UseLogin
1017 is enabled.
1018 .It Cm X11UseLocalhost
1019 Specifies whether
1020 .Xr sshd 8
1021 should bind the X11 forwarding server to the loopback address or to
1022 the wildcard address.
1023 By default,
1024 sshd binds the forwarding server to the loopback address and sets the
1025 hostname part of the
1026 .Ev DISPLAY
1027 environment variable to
1028 .Dq localhost .
1029 This prevents remote hosts from connecting to the proxy display.
1030 However, some older X11 clients may not function with this
1031 configuration.
1032 .Cm X11UseLocalhost
1033 may be set to
1034 .Dq no
1035 to specify that the forwarding server should be bound to the wildcard
1036 address.
1037 The argument must be
1038 .Dq yes
1039 or
1040 .Dq no .
1041 The default is
1042 .Dq yes .
1043 .It Cm XAuthLocation
1044 Specifies the full pathname of the
1045 .Xr xauth 1
1046 program.
1047 The default is
1048 .Pa /usr/X11R6/bin/xauth .
1049 .El
1050 .Sh TIME FORMATS
1051 .Xr sshd 8
1052 command-line arguments and configuration file options that specify time
1053 may be expressed using a sequence of the form:
1054 .Sm off
1055 .Ar time Op Ar qualifier ,
1056 .Sm on
1057 where
1058 .Ar time
1059 is a positive integer value and
1060 .Ar qualifier
1061 is one of the following:
1062 .Pp
1063 .Bl -tag -width Ds -compact -offset indent
1064 .It Aq Cm none
1065 seconds
1066 .It Cm s | Cm S
1067 seconds
1068 .It Cm m | Cm M
1069 minutes
1070 .It Cm h | Cm H
1071 hours
1072 .It Cm d | Cm D
1073 days
1074 .It Cm w | Cm W
1075 weeks
1076 .El
1077 .Pp
1078 Each member of the sequence is added together to calculate
1079 the total time value.
1080 .Pp
1081 Time format examples:
1082 .Pp
1083 .Bl -tag -width Ds -compact -offset indent
1084 .It 600
1085 600 seconds (10 minutes)
1086 .It 10m
1087 10 minutes
1088 .It 1h30m
1089 1 hour 30 minutes (90 minutes)
1090 .El
1091 .Sh FILES
1092 .Bl -tag -width Ds
1093 .It Pa /etc/ssh/sshd_config
1094 Contains configuration data for
1095 .Xr sshd 8 .
1096 This file should be writable by root only, but it is recommended
1097 (though not necessary) that it be world-readable.
1098 .El
1099 .Sh SEE ALSO
1100 .Xr sshd 8
1101 .Sh AUTHORS
1102 OpenSSH is a derivative of the original and free
1103 ssh 1.2.12 release by Tatu Ylonen.
1104 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1105 Theo de Raadt and Dug Song
1106 removed many bugs, re-added newer features and
1107 created OpenSSH.
1108 Markus Friedl contributed the support for SSH
1109 protocol versions 1.5 and 2.0.
1110 Niels Provos and Markus Friedl contributed support
1111 for privilege separation.