crypto/openssh/sshd_config.5

   1 .\"
   2 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   3 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4 .\"                    All rights reserved
   5 .\"
   6 .\" As far as I am concerned, the code I have written for this software
   7 .\" can be used freely for any purpose.  Any derived versions of this
   8 .\" software must be clearly marked as such, and if the derived work is
   9 .\" incompatible with the protocol description in the RFC file, it must be
  10 .\" called by a name other than "ssh" or "Secure Shell".
  11 .\"
  12 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
  13 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
  14 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
  15 .\"
  16 .\" Redistribution and use in source and binary forms, with or without
  17 .\" modification, are permitted provided that the following conditions
  18 .\" are met:
  19 .\" 1. Redistributions of source code must retain the above copyright
  20 .\"    notice, this list of conditions and the following disclaimer.
  21 .\" 2. Redistributions in binary form must reproduce the above copyright
  22 .\"    notice, this list of conditions and the following disclaimer in the
  23 .\"    documentation and/or other materials provided with the distribution.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  26 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  28 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  29 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  30 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  34 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35 .\"
  36 .\" $OpenBSD: sshd_config.5,v 1.135 2011/08/02 01:22:11 djm Exp $
  37 .Dd $Mdocdate: August 2 2011 $
  38 .Dt SSHD_CONFIG 5
  39 .Os
  40 .Sh NAME
  41 .Nm sshd_config
  42 .Nd OpenSSH SSH daemon configuration file
  43 .Sh SYNOPSIS
  44 .Nm /etc/ssh/sshd_config
  45 .Sh DESCRIPTION
  46 .Xr sshd 8
  47 reads configuration data from
  48 .Pa /etc/ssh/sshd_config
  49 (or the file specified with
  50 .Fl f
  51 on the command line).
  52 The file contains keyword-argument pairs, one per line.
  53 Lines starting with
  54 .Ql #
  55 and empty lines are interpreted as comments.
  56 Arguments may optionally be enclosed in double quotes
  57 .Pq \&"
  58 in order to represent arguments containing spaces.
  59 .Pp
  60 The possible
  61 keywords and their meanings are as follows (note that
  62 keywords are case-insensitive and arguments are case-sensitive):
  63 .Bl -tag -width Ds
  64 .It Cm AcceptEnv
  65 Specifies what environment variables sent by the client will be copied into
  66 the session's
  67 .Xr environ 7 .
  68 See
  69 .Cm SendEnv
  70 in
  71 .Xr ssh_config 5
  72 for how to configure the client.
  73 Note that environment passing is only supported for protocol 2.
  74 Variables are specified by name, which may contain the wildcard characters
  75 .Ql *
  76 and
  77 .Ql \&? .
  78 Multiple environment variables may be separated by whitespace or spread
  79 across multiple
  80 .Cm AcceptEnv
  81 directives.
  82 Be warned that some environment variables could be used to bypass restricted
  83 user environments.
  84 For this reason, care should be taken in the use of this directive.
  85 The default is not to accept any environment variables.
  86 .It Cm AddressFamily
  87 Specifies which address family should be used by
  88 .Xr sshd 8 .
  89 Valid arguments are
  90 .Dq any ,
  91 .Dq inet
  92 (use IPv4 only), or
  93 .Dq inet6
  94 (use IPv6 only).
  95 The default is
  96 .Dq any .
  97 .It Cm AllowAgentForwarding
  98 Specifies whether
  99 .Xr ssh-agent 1
 100 forwarding is permitted.
 101 The default is
 102 .Dq yes .
 103 Note that disabling agent forwarding does not improve security
 104 unless users are also denied shell access, as they can always install
 105 their own forwarders.
 106 .It Cm AllowGroups
 107 This keyword can be followed by a list of group name patterns, separated
 108 by spaces.
 109 If specified, login is allowed only for users whose primary
 110 group or supplementary group list matches one of the patterns.
 111 Only group names are valid; a numerical group ID is not recognized.
 112 By default, login is allowed for all groups.
 113 The allow/deny directives are processed in the following order:
 114 .Cm DenyUsers ,
 115 .Cm AllowUsers ,
 116 .Cm DenyGroups ,
 117 and finally
 118 .Cm AllowGroups .
 119 .Pp
 120 See
 121 .Sx PATTERNS
 122 in
 123 .Xr ssh_config 5
 124 for more information on patterns.
 125 .It Cm AllowTcpForwarding
 126 Specifies whether TCP forwarding is permitted.
 127 The default is
 128 .Dq yes .
 129 Note that disabling TCP forwarding does not improve security unless
 130 users are also denied shell access, as they can always install their
 131 own forwarders.
 132 .It Cm AllowUsers
 133 This keyword can be followed by a list of user name patterns, separated
 134 by spaces.
 135 If specified, login is allowed only for user names that
 136 match one of the patterns.
 137 Only user names are valid; a numerical user ID is not recognized.
 138 By default, login is allowed for all users.
 139 If the pattern takes the form USER@HOST then USER and HOST
 140 are separately checked, restricting logins to particular
 141 users from particular hosts.
 142 The allow/deny directives are processed in the following order:
 143 .Cm DenyUsers ,
 144 .Cm AllowUsers ,
 145 .Cm DenyGroups ,
 146 and finally
 147 .Cm AllowGroups .
 148 .Pp
 149 See
 150 .Sx PATTERNS
 151 in
 152 .Xr ssh_config 5
 153 for more information on patterns.
 154 .It Cm AuthorizedKeysFile
 155 Specifies the file that contains the public keys that can be used
 156 for user authentication.
 157 The format is described in the
 158 .Sx AUTHORIZED_KEYS FILE FORMAT
 159 section of
 160 .Xr sshd 8 .
 161 .Cm AuthorizedKeysFile
 162 may contain tokens of the form %T which are substituted during connection
 163 setup.
 164 The following tokens are defined: %% is replaced by a literal '%',
 165 %h is replaced by the home directory of the user being authenticated, and
 166 %u is replaced by the username of that user.
 167 After expansion,
 168 .Cm AuthorizedKeysFile
 169 is taken to be an absolute path or one relative to the user's home
 170 directory.
 171 Multiple files may be listed, separated by whitespace.
 172 The default is
 173 .Dq .ssh/authorized_keys .ssh/authorized_keys2 .
 174 .It Cm AuthorizedPrincipalsFile
 175 Specifies a file that lists principal names that are accepted for
 176 certificate authentication.
 177 When using certificates signed by a key listed in
 178 .Cm TrustedUserCAKeys ,
 179 this file lists names, one of which must appear in the certificate for it
 180 to be accepted for authentication.
 181 Names are listed one per line preceded by key options (as described
 182 in
 183 .Sx AUTHORIZED_KEYS FILE FORMAT
 184 in
 185 .Xr sshd 8 ) .
 186 Empty lines and comments starting with
 187 .Ql #
 188 are ignored.
 189 .Pp
 190 .Cm AuthorizedPrincipalsFile
 191 may contain tokens of the form %T which are substituted during connection
 192 setup.
 193 The following tokens are defined: %% 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 After expansion,
 197 .Cm AuthorizedPrincipalsFile
 198 is taken to be an absolute path or one relative to the user's home
 199 directory.
 200 .Pp
 201 The default is not to use a principals file \(en in this case, the username
 202 of the user must appear in a certificate's principals list for it to be
 203 accepted.
 204 Note that
 205 .Cm AuthorizedPrincipalsFile
 206 is only used when authentication proceeds using a CA listed in
 207 .Cm TrustedUserCAKeys
 208 and is not consulted for certification authorities trusted via
 209 .Pa ~/.ssh/authorized_keys ,
 210 though the
 211 .Cm principals=
 212 key option offers a similar facility (see
 213 .Xr sshd 8
 214 for details).
 215 .It Cm Banner
 216 The contents of the specified file are sent to the remote user before
 217 authentication is allowed.
 218 If the argument is
 219 .Dq none
 220 then no banner is displayed.
 221 This option is only available for protocol version 2.
 222 By default, no banner is displayed.
 223 .It Cm ChallengeResponseAuthentication
 224 Specifies whether challenge-response authentication is allowed (e.g. via
 225 PAM or though authentication styles supported in
 226 .Xr login.conf 5 )
 227 The default is
 228 .Dq yes .
 229 .It Cm ChrootDirectory
 230 Specifies the pathname of a directory to
 231 .Xr chroot 2
 232 to after authentication.
 233 All components of the pathname must be root-owned directories that are
 234 not writable by any other user or group.
 235 After the chroot,
 236 .Xr sshd 8
 237 changes the working directory to the user's home directory.
 238 .Pp
 239 The pathname may contain the following tokens that are expanded at runtime once
 240 the connecting user has been authenticated: %% is replaced by a literal '%',
 241 %h is replaced by the home directory of the user being authenticated, and
 242 %u is replaced by the username of that user.
 243 .Pp
 244 The
 245 .Cm ChrootDirectory
 246 must contain the necessary files and directories to support the
 247 user's session.
 248 For an interactive session this requires at least a shell, typically
 249 .Xr sh 1 ,
 250 and basic
 251 .Pa /dev
 252 nodes such as
 253 .Xr null 4 ,
 254 .Xr zero 4 ,
 255 .Xr stdin 4 ,
 256 .Xr stdout 4 ,
 257 .Xr stderr 4 ,
 258 .Xr arandom 4
 259 and
 260 .Xr tty 4
 261 devices.
 262 For file transfer sessions using
 263 .Dq sftp ,
 264 no additional configuration of the environment is necessary if the
 265 in-process sftp server is used,
 266 though sessions which use logging do require
 267 .Pa /dev/log
 268 inside the chroot directory (see
 269 .Xr sftp-server 8
 270 for details).
 271 .Pp
 272 The default is not to
 273 .Xr chroot 2 .
 274 .It Cm Ciphers
 275 Specifies the ciphers allowed for protocol version 2.
 276 Multiple ciphers must be comma-separated.
 277 The supported ciphers are
 278 .Dq 3des-cbc ,
 279 .Dq aes128-cbc ,
 280 .Dq aes192-cbc ,
 281 .Dq aes256-cbc ,
 282 .Dq aes128-ctr ,
 283 .Dq aes192-ctr ,
 284 .Dq aes256-ctr ,
 285 .Dq arcfour128 ,
 286 .Dq arcfour256 ,
 287 .Dq arcfour ,
 288 .Dq blowfish-cbc ,
 289 and
 290 .Dq cast128-cbc .
 291 The default is:
 292 .Bd -literal -offset 3n
 293 aes128-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,
 294 aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,
 295 aes256-cbc,arcfour
 296 .Ed
 297 .It Cm ClientAliveCountMax
 298 Sets the number of client alive messages (see below) which may be
 299 sent without
 300 .Xr sshd 8
 301 receiving any messages back from the client.
 302 If this threshold is reached while client alive messages are being sent,
 303 sshd will disconnect the client, terminating the session.
 304 It is important to note that the use of client alive messages is very
 305 different from
 306 .Cm TCPKeepAlive
 307 (below).
 308 The client alive messages are sent through the encrypted channel
 309 and therefore will not be spoofable.
 310 The TCP keepalive option enabled by
 311 .Cm TCPKeepAlive
 312 is spoofable.
 313 The client alive mechanism is valuable when the client or
 314 server depend on knowing when a connection has become inactive.
 315 .Pp
 316 The default value is 3.
 317 If
 318 .Cm ClientAliveInterval
 319 (see below) is set to 15, and
 320 .Cm ClientAliveCountMax
 321 is left at the default, unresponsive SSH clients
 322 will be disconnected after approximately 45 seconds.
 323 This option applies to protocol version 2 only.
 324 .It Cm ClientAliveInterval
 325 Sets a timeout interval in seconds after which if no data has been received
 326 from the client,
 327 .Xr sshd 8
 328 will send a message through the encrypted
 329 channel to request a response from the client.
 330 The default
 331 is 0, indicating that these messages will not be sent to the client.
 332 This option applies to protocol version 2 only.
 333 .It Cm Compression
 334 Specifies whether compression is allowed, or delayed until
 335 the user has authenticated successfully.
 336 The argument must be
 337 .Dq yes ,
 338 .Dq delayed ,
 339 or
 340 .Dq no .
 341 The default is
 342 .Dq delayed .
 343 .It Cm DenyGroups
 344 This keyword can be followed by a list of group name patterns, separated
 345 by spaces.
 346 Login is disallowed for users whose primary group or supplementary
 347 group list matches one of the patterns.
 348 Only group names are valid; a numerical group ID is not recognized.
 349 By default, login is allowed for all groups.
 350 The allow/deny directives are processed in the following order:
 351 .Cm DenyUsers ,
 352 .Cm AllowUsers ,
 353 .Cm DenyGroups ,
 354 and finally
 355 .Cm AllowGroups .
 356 .Pp
 357 See
 358 .Sx PATTERNS
 359 in
 360 .Xr ssh_config 5
 361 for more information on patterns.
 362 .It Cm DenyUsers
 363 This keyword can be followed by a list of user name patterns, separated
 364 by spaces.
 365 Login is disallowed for user names that match one of the patterns.
 366 Only user names are valid; a numerical user ID is not recognized.
 367 By default, login is allowed for all users.
 368 If the pattern takes the form USER@HOST then USER and HOST
 369 are separately checked, restricting logins to particular
 370 users from particular hosts.
 371 The allow/deny directives are processed in the following order:
 372 .Cm DenyUsers ,
 373 .Cm AllowUsers ,
 374 .Cm DenyGroups ,
 375 and finally
 376 .Cm AllowGroups .
 377 .Pp
 378 See
 379 .Sx PATTERNS
 380 in
 381 .Xr ssh_config 5
 382 for more information on patterns.
 383 .It Cm ForceCommand
 384 Forces the execution of the command specified by
 385 .Cm ForceCommand ,
 386 ignoring any command supplied by the client and
 387 .Pa ~/.ssh/rc
 388 if present.
 389 The command is invoked by using the user's login shell with the -c option.
 390 This applies to shell, command, or subsystem execution.
 391 It is most useful inside a
 392 .Cm Match
 393 block.
 394 The command originally supplied by the client is available in the
 395 .Ev SSH_ORIGINAL_COMMAND
 396 environment variable.
 397 Specifying a command of
 398 .Dq internal-sftp
 399 will force the use of an in-process sftp server that requires no support
 400 files when used with
 401 .Cm ChrootDirectory .
 402 .It Cm GatewayPorts
 403 Specifies whether remote hosts are allowed to connect to ports
 404 forwarded for the client.
 405 By default,
 406 .Xr sshd 8
 407 binds remote port forwardings to the loopback address.
 408 This prevents other remote hosts from connecting to forwarded ports.
 409 .Cm GatewayPorts
 410 can be used to specify that sshd
 411 should allow remote port forwardings to bind to non-loopback addresses, thus
 412 allowing other hosts to connect.
 413 The argument may be
 414 .Dq no
 415 to force remote port forwardings to be available to the local host only,
 416 .Dq yes
 417 to force remote port forwardings to bind to the wildcard address, or
 418 .Dq clientspecified
 419 to allow the client to select the address to which the forwarding is bound.
 420 The default is
 421 .Dq no .
 422 .It Cm GSSAPIAuthentication
 423 Specifies whether user authentication based on GSSAPI is allowed.
 424 The default is
 425 .Dq no .
 426 Note that this option applies to protocol version 2 only.
 427 .It Cm GSSAPICleanupCredentials
 428 Specifies whether to automatically destroy the user's credentials cache
 429 on logout.
 430 The default is
 431 .Dq yes .
 432 Note that this option applies to protocol version 2 only.
 433 .It Cm HostbasedAuthentication
 434 Specifies whether rhosts or /etc/hosts.equiv authentication together
 435 with successful public key client host authentication is allowed
 436 (host-based authentication).
 437 This option is similar to
 438 .Cm RhostsRSAAuthentication
 439 and applies to protocol version 2 only.
 440 The default is
 441 .Dq no .
 442 .It Cm HostbasedUsesNameFromPacketOnly
 443 Specifies whether or not the server will attempt to perform a reverse
 444 name lookup when matching the name in the
 445 .Pa ~/.shosts ,
 446 .Pa ~/.rhosts ,
 447 and
 448 .Pa /etc/hosts.equiv
 449 files during
 450 .Cm HostbasedAuthentication .
 451 A setting of
 452 .Dq yes
 453 means that
 454 .Xr sshd 8
 455 uses the name supplied by the client rather than
 456 attempting to resolve the name from the TCP connection itself.
 457 The default is
 458 .Dq no .
 459 .It Cm HostCertificate
 460 Specifies a file containing a public host certificate.
 461 The certificate's public key must match a private host key already specified
 462 by
 463 .Cm HostKey .
 464 The default behaviour of
 465 .Xr sshd 8
 466 is not to load any certificates.
 467 .It Cm HostKey
 468 Specifies a file containing a private host key
 469 used by SSH.
 470 The default is
 471 .Pa /etc/ssh/ssh_host_key
 472 for protocol version 1, and
 473 .Pa /etc/ssh/ssh_host_dsa_key ,
 474 .Pa /etc/ssh/ssh_host_ecdsa_key
 475 and
 476 .Pa /etc/ssh/ssh_host_rsa_key
 477 for protocol version 2.
 478 Note that
 479 .Xr sshd 8
 480 will refuse to use a file if it is group/world-accessible.
 481 It is possible to have multiple host key files.
 482 .Dq rsa1
 483 keys are used for version 1 and
 484 .Dq dsa ,
 485 .Dq ecdsa
 486 or
 487 .Dq rsa
 488 are used for version 2 of the SSH protocol.
 489 .It Cm IgnoreRhosts
 490 Specifies that
 491 .Pa .rhosts
 492 and
 493 .Pa .shosts
 494 files will not be used in
 495 .Cm RhostsRSAAuthentication
 496 or
 497 .Cm HostbasedAuthentication .
 498 .Pp
 499 .Pa /etc/hosts.equiv
 500 and
 501 .Pa /etc/shosts.equiv
 502 are still used.
 503 The default is
 504 .Dq yes .
 505 .It Cm IgnoreUserKnownHosts
 506 Specifies whether
 507 .Xr sshd 8
 508 should ignore the user's
 509 .Pa ~/.ssh/known_hosts
 510 during
 511 .Cm RhostsRSAAuthentication
 512 or
 513 .Cm HostbasedAuthentication .
 514 The default is
 515 .Dq no .
 516 .It Cm IPQoS
 517 Specifies the IPv4 type-of-service or DSCP class for the connection.
 518 Accepted values are
 519 .Dq af11 ,
 520 .Dq af12 ,
 521 .Dq af13 ,
 522 .Dq af14 ,
 523 .Dq af22 ,
 524 .Dq af23 ,
 525 .Dq af31 ,
 526 .Dq af32 ,
 527 .Dq af33 ,
 528 .Dq af41 ,
 529 .Dq af42 ,
 530 .Dq af43 ,
 531 .Dq cs0 ,
 532 .Dq cs1 ,
 533 .Dq cs2 ,
 534 .Dq cs3 ,
 535 .Dq cs4 ,
 536 .Dq cs5 ,
 537 .Dq cs6 ,
 538 .Dq cs7 ,
 539 .Dq ef ,
 540 .Dq lowdelay ,
 541 .Dq throughput ,
 542 .Dq reliability ,
 543 or a numeric value.
 544 This option may take one or two arguments, separated by whitespace.
 545 If one argument is specified, it is used as the packet class unconditionally.
 546 If two values are specified, the first is automatically selected for
 547 interactive sessions and the second for non-interactive sessions.
 548 The default is
 549 .Dq lowdelay
 550 for interactive sessions and
 551 .Dq throughput
 552 for non-interactive sessions.
 553 .It Cm KerberosAuthentication
 554 Specifies whether the password provided by the user for
 555 .Cm PasswordAuthentication
 556 will be validated through the Kerberos KDC.
 557 To use this option, the server needs a
 558 Kerberos servtab which allows the verification of the KDC's identity.
 559 The default is
 560 .Dq no .
 561 .It Cm KerberosGetAFSToken
 562 If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
 563 an AFS token before accessing the user's home directory.
 564 The default is
 565 .Dq no .
 566 .It Cm KerberosOrLocalPasswd
 567 If password authentication through Kerberos fails then
 568 the password will be validated via any additional local mechanism
 569 such as
 570 .Pa /etc/passwd .
 571 The default is
 572 .Dq yes .
 573 .It Cm KerberosTicketCleanup
 574 Specifies whether to automatically destroy the user's ticket cache
 575 file on logout.
 576 The default is
 577 .Dq yes .
 578 .It Cm KexAlgorithms
 579 Specifies the available KEX (Key Exchange) algorithms.
 580 Multiple algorithms must be comma-separated.
 581 The default is
 582 .Dq ecdh-sha2-nistp256 ,
 583 .Dq ecdh-sha2-nistp384 ,
 584 .Dq ecdh-sha2-nistp521 ,
 585 .Dq diffie-hellman-group-exchange-sha256 ,
 586 .Dq diffie-hellman-group-exchange-sha1 ,
 587 .Dq diffie-hellman-group14-sha1 ,
 588 .Dq diffie-hellman-group1-sha1 .
 589 .It Cm KeyRegenerationInterval
 590 In protocol version 1, the ephemeral server key is automatically regenerated
 591 after this many seconds (if it has been used).
 592 The purpose of regeneration is to prevent
 593 decrypting captured sessions by later breaking into the machine and
 594 stealing the keys.
 595 The key is never stored anywhere.
 596 If the value is 0, the key is never regenerated.
 597 The default is 3600 (seconds).
 598 .It Cm ListenAddress
 599 Specifies the local addresses
 600 .Xr sshd 8
 601 should listen on.
 602 The following forms may be used:
 603 .Pp
 604 .Bl -item -offset indent -compact
 605 .It
 606 .Cm ListenAddress
 607 .Sm off
 608 .Ar host No | Ar IPv4_addr No | Ar IPv6_addr
 609 .Sm on
 610 .It
 611 .Cm ListenAddress
 612 .Sm off
 613 .Ar host No | Ar IPv4_addr No : Ar port
 614 .Sm on
 615 .It
 616 .Cm ListenAddress
 617 .Sm off
 618 .Oo
 619 .Ar host No | Ar IPv6_addr Oc : Ar port
 620 .Sm on
 621 .El
 622 .Pp
 623 If
 624 .Ar port
 625 is not specified,
 626 sshd will listen on the address and all prior
 627 .Cm Port
 628 options specified.
 629 The default is to listen on all local addresses.
 630 Multiple
 631 .Cm ListenAddress
 632 options are permitted.
 633 Additionally, any
 634 .Cm Port
 635 options must precede this option for non-port qualified addresses.
 636 .It Cm LoginGraceTime
 637 The server disconnects after this time if the user has not
 638 successfully logged in.
 639 If the value is 0, there is no time limit.
 640 The default is 120 seconds.
 641 .It Cm LogLevel
 642 Gives the verbosity level that is used when logging messages from
 643 .Xr sshd 8 .
 644 The possible values are:
 645 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
 646 The default is INFO.
 647 DEBUG and DEBUG1 are equivalent.
 648 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
 649 Logging with a DEBUG level violates the privacy of users and is not recommended.
 650 .It Cm MACs
 651 Specifies the available MAC (message authentication code) algorithms.
 652 The MAC algorithm is used in protocol version 2
 653 for data integrity protection.
 654 Multiple algorithms must be comma-separated.
 655 The default is:
 656 .Bd -literal -offset indent
 657 hmac-md5,hmac-sha1,umac-64@openssh.com,
 658 hmac-ripemd160,hmac-sha1-96,hmac-md5-96,
 659 hmac-sha2-256,hmac-sha256-96,hmac-sha2-512,
 660 hmac-sha2-512-96
 661 .Ed
 662 .It Cm Match
 663 Introduces a conditional block.
 664 If all of the criteria on the
 665 .Cm Match
 666 line are satisfied, the keywords on the following lines override those
 667 set in the global section of the config file, until either another
 668 .Cm Match
 669 line or the end of the file.
 670 .Pp
 671 The arguments to
 672 .Cm Match
 673 are one or more criteria-pattern pairs.
 674 The available criteria are
 675 .Cm User ,
 676 .Cm Group ,
 677 .Cm Host ,
 678 and
 679 .Cm Address .
 680 The match patterns may consist of single entries or comma-separated
 681 lists and may use the wildcard and negation operators described in the
 682 .Sx PATTERNS
 683 section of
 684 .Xr ssh_config 5 .
 685 .Pp
 686 The patterns in an
 687 .Cm Address
 688 criteria may additionally contain addresses to match in CIDR
 689 address/masklen format, e.g.\&
 690 .Dq 192.0.2.0/24
 691 or
 692 .Dq 3ffe:ffff::/32 .
 693 Note that the mask length provided must be consistent with the address -
 694 it is an error to specify a mask length that is too long for the address
 695 or one with bits set in this host portion of the address.
 696 For example,
 697 .Dq 192.0.2.0/33
 698 and
 699 .Dq 192.0.2.0/8
 700 respectively.
 701 .Pp
 702 Only a subset of keywords may be used on the lines following a
 703 .Cm Match
 704 keyword.
 705 Available keywords are
 706 .Cm AllowAgentForwarding ,
 707 .Cm AllowTcpForwarding ,
 708 .Cm AuthorizedKeysFile ,
 709 .Cm AuthorizedPrincipalsFile ,
 710 .Cm Banner ,
 711 .Cm ChrootDirectory ,
 712 .Cm ForceCommand ,
 713 .Cm GatewayPorts ,
 714 .Cm GSSAPIAuthentication ,
 715 .Cm HostbasedAuthentication ,
 716 .Cm HostbasedUsesNameFromPacketOnly ,
 717 .Cm KbdInteractiveAuthentication ,
 718 .Cm KerberosAuthentication ,
 719 .Cm MaxAuthTries ,
 720 .Cm MaxSessions ,
 721 .Cm PasswordAuthentication ,
 722 .Cm PermitEmptyPasswords ,
 723 .Cm PermitOpen ,
 724 .Cm PermitRootLogin ,
 725 .Cm PermitTunnel ,
 726 .Cm PubkeyAuthentication ,
 727 .Cm RhostsRSAAuthentication ,
 728 .Cm RSAAuthentication ,
 729 .Cm X11DisplayOffset ,
 730 .Cm X11Forwarding
 731 and
 732 .Cm X11UseLocalHost .
 733 .It Cm MaxAuthTries
 734 Specifies the maximum number of authentication attempts permitted per
 735 connection.
 736 Once the number of failures reaches half this value,
 737 additional failures are logged.
 738 The default is 6.
 739 .It Cm MaxSessions
 740 Specifies the maximum number of open sessions permitted per network connection.
 741 The default is 10.
 742 .It Cm MaxStartups
 743 Specifies the maximum number of concurrent unauthenticated connections to the
 744 SSH daemon.
 745 Additional connections will be dropped until authentication succeeds or the
 746 .Cm LoginGraceTime
 747 expires for a connection.
 748 The default is 10.
 749 .Pp
 750 Alternatively, random early drop can be enabled by specifying
 751 the three colon separated values
 752 .Dq start:rate:full
 753 (e.g. "10:30:60").
 754 .Xr sshd 8
 755 will refuse connection attempts with a probability of
 756 .Dq rate/100
 757 (30%)
 758 if there are currently
 759 .Dq start
 760 (10)
 761 unauthenticated connections.
 762 The probability increases linearly and all connection attempts
 763 are refused if the number of unauthenticated connections reaches
 764 .Dq full
 765 (60).
 766 .It Cm PasswordAuthentication
 767 Specifies whether password authentication is allowed.
 768 The default is
 769 .Dq yes .
 770 .It Cm PermitEmptyPasswords
 771 When password authentication is allowed, it specifies whether the
 772 server allows login to accounts with empty password strings.
 773 The default is
 774 .Dq no .
 775 .It Cm PermitOpen
 776 Specifies the destinations to which TCP port forwarding is permitted.
 777 The forwarding specification must be one of the following forms:
 778 .Pp
 779 .Bl -item -offset indent -compact
 780 .It
 781 .Cm PermitOpen
 782 .Sm off
 783 .Ar host : port
 784 .Sm on
 785 .It
 786 .Cm PermitOpen
 787 .Sm off
 788 .Ar IPv4_addr : port
 789 .Sm on
 790 .It
 791 .Cm PermitOpen
 792 .Sm off
 793 .Ar \&[ IPv6_addr \&] : port
 794 .Sm on
 795 .El
 796 .Pp
 797 Multiple forwards may be specified by separating them with whitespace.
 798 An argument of
 799 .Dq any
 800 can be used to remove all restrictions and permit any forwarding requests.
 801 By default all port forwarding requests are permitted.
 802 .It Cm PermitRootLogin
 803 Specifies whether root can log in using
 804 .Xr ssh 1 .
 805 The argument must be
 806 .Dq yes ,
 807 .Dq without-password ,
 808 .Dq forced-commands-only ,
 809 or
 810 .Dq no .
 811 The default is
 812 .Dq yes .
 813 .Pp
 814 If this option is set to
 815 .Dq without-password ,
 816 password authentication is disabled for root.
 817 .Pp
 818 If this option is set to
 819 .Dq forced-commands-only ,
 820 root login with public key authentication will be allowed,
 821 but only if the
 822 .Ar command
 823 option has been specified
 824 (which may be useful for taking remote backups even if root login is
 825 normally not allowed).
 826 All other authentication methods are disabled for root.
 827 .Pp
 828 If this option is set to
 829 .Dq no ,
 830 root is not allowed to log in.
 831 .It Cm PermitTunnel
 832 Specifies whether
 833 .Xr tun 4
 834 device forwarding is allowed.
 835 The argument must be
 836 .Dq yes ,
 837 .Dq point-to-point
 838 (layer 3),
 839 .Dq ethernet
 840 (layer 2), or
 841 .Dq no .
 842 Specifying
 843 .Dq yes
 844 permits both
 845 .Dq point-to-point
 846 and
 847 .Dq ethernet .
 848 The default is
 849 .Dq no .
 850 .It Cm PermitUserEnvironment
 851 Specifies whether
 852 .Pa ~/.ssh/environment
 853 and
 854 .Cm environment=
 855 options in
 856 .Pa ~/.ssh/authorized_keys
 857 are processed by
 858 .Xr sshd 8 .
 859 The default is
 860 .Dq no .
 861 Enabling environment processing may enable users to bypass access
 862 restrictions in some configurations using mechanisms such as
 863 .Ev LD_PRELOAD .
 864 .It Cm PidFile
 865 Specifies the file that contains the process ID of the
 866 SSH daemon.
 867 The default is
 868 .Pa /var/run/sshd.pid .
 869 .It Cm Port
 870 Specifies the port number that
 871 .Xr sshd 8
 872 listens on.
 873 The default is 22.
 874 Multiple options of this type are permitted.
 875 See also
 876 .Cm ListenAddress .
 877 .It Cm PrintLastLog
 878 Specifies whether
 879 .Xr sshd 8
 880 should print the date and time of the last user login when a user logs
 881 in interactively.
 882 The default is
 883 .Dq yes .
 884 .It Cm PrintMotd
 885 Specifies whether
 886 .Xr sshd 8
 887 should print
 888 .Pa /etc/motd
 889 when a user logs in interactively.
 890 (On some systems it is also printed by the shell,
 891 .Pa /etc/profile ,
 892 or equivalent.)
 893 The default is
 894 .Dq yes .
 895 .It Cm Protocol
 896 Specifies the protocol versions
 897 .Xr sshd 8
 898 supports.
 899 The possible values are
 900 .Sq 1
 901 and
 902 .Sq 2 .
 903 Multiple versions must be comma-separated.
 904 The default is
 905 .Sq 2 .
 906 Note that the order of the protocol list does not indicate preference,
 907 because the client selects among multiple protocol versions offered
 908 by the server.
 909 Specifying
 910 .Dq 2,1
 911 is identical to
 912 .Dq 1,2 .
 913 .It Cm PubkeyAuthentication
 914 Specifies whether public key authentication is allowed.
 915 The default is
 916 .Dq yes .
 917 Note that this option applies to protocol version 2 only.
 918 .It Cm RevokedKeys
 919 Specifies a list of revoked public keys.
 920 Keys listed in this file will be refused for public key authentication.
 921 Note that if this file is not readable, then public key authentication will
 922 be refused for all users.
 923 .It Cm RhostsRSAAuthentication
 924 Specifies whether rhosts or /etc/hosts.equiv authentication together
 925 with successful RSA host authentication is allowed.
 926 The default is
 927 .Dq no .
 928 This option applies to protocol version 1 only.
 929 .It Cm RSAAuthentication
 930 Specifies whether pure RSA authentication is allowed.
 931 The default is
 932 .Dq yes .
 933 This option applies to protocol version 1 only.
 934 .It Cm ServerKeyBits
 935 Defines the number of bits in the ephemeral protocol version 1 server key.
 936 The minimum value is 512, and the default is 1024.
 937 .It Cm StrictModes
 938 Specifies whether
 939 .Xr sshd 8
 940 should check file modes and ownership of the
 941 user's files and home directory before accepting login.
 942 This is normally desirable because novices sometimes accidentally leave their
 943 directory or files world-writable.
 944 The default is
 945 .Dq yes .
 946 Note that this does not apply to
 947 .Cm ChrootDirectory ,
 948 whose permissions and ownership are checked unconditionally.
 949 .It Cm Subsystem
 950 Configures an external subsystem (e.g. file transfer daemon).
 951 Arguments should be a subsystem name and a command (with optional arguments)
 952 to execute upon subsystem request.
 953 .Pp
 954 The command
 955 .Xr sftp-server 8
 956 implements the
 957 .Dq sftp
 958 file transfer subsystem.
 959 .Pp
 960 Alternately the name
 961 .Dq internal-sftp
 962 implements an in-process
 963 .Dq sftp
 964 server.
 965 This may simplify configurations using
 966 .Cm ChrootDirectory
 967 to force a different filesystem root on clients.
 968 .Pp
 969 By default no subsystems are defined.
 970 Note that this option applies to protocol version 2 only.
 971 .It Cm SyslogFacility
 972 Gives the facility code that is used when logging messages from
 973 .Xr sshd 8 .
 974 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
 975 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
 976 The default is AUTH.
 977 .It Cm TCPKeepAlive
 978 Specifies whether the system should send TCP keepalive messages to the
 979 other side.
 980 If they are sent, death of the connection or crash of one
 981 of the machines will be properly noticed.
 982 However, this means that
 983 connections will die if the route is down temporarily, and some people
 984 find it annoying.
 985 On the other hand, if TCP keepalives are not sent,
 986 sessions may hang indefinitely on the server, leaving
 987 .Dq ghost
 988 users and consuming server resources.
 989 .Pp
 990 The default is
 991 .Dq yes
 992 (to send TCP keepalive messages), and the server will notice
 993 if the network goes down or the client host crashes.
 994 This avoids infinitely hanging sessions.
 995 .Pp
 996 To disable TCP keepalive messages, the value should be set to
 997 .Dq no .
 998 .It Cm TrustedUserCAKeys
 999 Specifies a file containing public keys of certificate authorities that are
1000 trusted to sign user certificates for authentication.
1001 Keys are listed one per line; empty lines and comments starting with
1002 .Ql #
1003 are allowed.
1004 If a certificate is presented for authentication and has its signing CA key
1005 listed in this file, then it may be used for authentication for any user
1006 listed in the certificate's principals list.
1007 Note that certificates that lack a list of principals will not be permitted
1008 for authentication using
1009 .Cm TrustedUserCAKeys .
1010 For more details on certificates, see the
1011 .Sx CERTIFICATES
1012 section in
1013 .Xr ssh-keygen 1 .
1014 .It Cm UseDNS
1015 Specifies whether
1016 .Xr sshd 8
1017 should look up the remote host name and check that
1018 the resolved host name for the remote IP address maps back to the
1019 very same IP address.
1020 The default is
1021 .Dq yes .
1022 .It Cm UseLogin
1023 Specifies whether
1024 .Xr login 1
1025 is used for interactive login sessions.
1026 The default is
1027 .Dq no .
1028 Note that
1029 .Xr login 1
1030 is never used for remote command execution.
1031 Note also, that if this is enabled,
1032 .Cm X11Forwarding
1033 will be disabled because
1034 .Xr login 1
1035 does not know how to handle
1036 .Xr xauth 1
1037 cookies.
1038 If
1039 .Cm UsePrivilegeSeparation
1040 is specified, it will be disabled after authentication.
1041 .It Cm UsePAM
1042 Enables the Pluggable Authentication Module interface.
1043 If set to
1044 .Dq yes
1045 this will enable PAM authentication using
1046 .Cm ChallengeResponseAuthentication
1047 and
1048 .Cm PasswordAuthentication
1049 in addition to PAM account and session module processing for all
1050 authentication types.
1051 .Pp
1052 Because PAM challenge-response authentication usually serves an equivalent
1053 role to password authentication, you should disable either
1054 .Cm PasswordAuthentication
1055 or
1056 .Cm ChallengeResponseAuthentication.
1057 .Pp
1058 If
1059 .Cm UsePAM
1060 is enabled, you will not be able to run
1061 .Xr sshd 8
1062 as a non-root user.
1063 The default is
1064 .Dq no .
1065 .It Cm UsePrivilegeSeparation
1066 Specifies whether
1067 .Xr sshd 8
1068 separates privileges by creating an unprivileged child process
1069 to deal with incoming network traffic.
1070 After successful authentication, another process will be created that has
1071 the privilege of the authenticated user.
1072 The goal of privilege separation is to prevent privilege
1073 escalation by containing any corruption within the unprivileged processes.
1074 The default is
1075 .Dq yes .
1076 If
1077 .Cm UsePrivilegeSeparation
1078 is set to
1079 .Dq sandbox
1080 then the pre-authentication unprivileged process is subject to additional
1081 restrictions.
1082 .It Cm X11DisplayOffset
1083 Specifies the first display number available for
1084 .Xr sshd 8 Ns 's
1085 X11 forwarding.
1086 This prevents sshd from interfering with real X11 servers.
1087 The default is 10.
1088 .It Cm X11Forwarding
1089 Specifies whether X11 forwarding is permitted.
1090 The argument must be
1091 .Dq yes
1092 or
1093 .Dq no .
1094 The default is
1095 .Dq no .
1096 .Pp
1097 When X11 forwarding is enabled, there may be additional exposure to
1098 the server and to client displays if the
1099 .Xr sshd 8
1100 proxy display is configured to listen on the wildcard address (see
1101 .Cm X11UseLocalhost
1102 below), though this is not the default.
1103 Additionally, the authentication spoofing and authentication data
1104 verification and substitution occur on the client side.
1105 The security risk of using X11 forwarding is that the client's X11
1106 display server may be exposed to attack when the SSH client requests
1107 forwarding (see the warnings for
1108 .Cm ForwardX11
1109 in
1110 .Xr ssh_config 5 ) .
1111 A system administrator may have a stance in which they want to
1112 protect clients that may expose themselves to attack by unwittingly
1113 requesting X11 forwarding, which can warrant a
1114 .Dq no
1115 setting.
1116 .Pp
1117 Note that disabling X11 forwarding does not prevent users from
1118 forwarding X11 traffic, as users can always install their own forwarders.
1119 X11 forwarding is automatically disabled if
1120 .Cm UseLogin
1121 is enabled.
1122 .It Cm X11UseLocalhost
1123 Specifies whether
1124 .Xr sshd 8
1125 should bind the X11 forwarding server to the loopback address or to
1126 the wildcard address.
1127 By default,
1128 sshd binds the forwarding server to the loopback address and sets the
1129 hostname part of the
1130 .Ev DISPLAY
1131 environment variable to
1132 .Dq localhost .
1133 This prevents remote hosts from connecting to the proxy display.
1134 However, some older X11 clients may not function with this
1135 configuration.
1136 .Cm X11UseLocalhost
1137 may be set to
1138 .Dq no
1139 to specify that the forwarding server should be bound to the wildcard
1140 address.
1141 The argument must be
1142 .Dq yes
1143 or
1144 .Dq no .
1145 The default is
1146 .Dq yes .
1147 .It Cm XAuthLocation
1148 Specifies the full pathname of the
1149 .Xr xauth 1
1150 program.
1151 The default is
1152 .Pa /usr/X11R6/bin/xauth .
1153 .El
1154 .Sh TIME FORMATS
1155 .Xr sshd 8
1156 command-line arguments and configuration file options that specify time
1157 may be expressed using a sequence of the form:
1158 .Sm off
1159 .Ar time Op Ar qualifier ,
1160 .Sm on
1161 where
1162 .Ar time
1163 is a positive integer value and
1164 .Ar qualifier
1165 is one of the following:
1166 .Pp
1167 .Bl -tag -width Ds -compact -offset indent
1168 .It Aq Cm none
1169 seconds
1170 .It Cm s | Cm S
1171 seconds
1172 .It Cm m | Cm M
1173 minutes
1174 .It Cm h | Cm H
1175 hours
1176 .It Cm d | Cm D
1177 days
1178 .It Cm w | Cm W
1179 weeks
1180 .El
1181 .Pp
1182 Each member of the sequence is added together to calculate
1183 the total time value.
1184 .Pp
1185 Time format examples:
1186 .Pp
1187 .Bl -tag -width Ds -compact -offset indent
1188 .It 600
1189 600 seconds (10 minutes)
1190 .It 10m
1191 10 minutes
1192 .It 1h30m
1193 1 hour 30 minutes (90 minutes)
1194 .El
1195 .Sh FILES
1196 .Bl -tag -width Ds
1197 .It Pa /etc/ssh/sshd_config
1198 Contains configuration data for
1199 .Xr sshd 8 .
1200 This file should be writable by root only, but it is recommended
1201 (though not necessary) that it be world-readable.
1202 .El
1203 .Sh SEE ALSO
1204 .Xr sshd 8
1205 .Sh AUTHORS
1206 OpenSSH is a derivative of the original and free
1207 ssh 1.2.12 release by Tatu Ylonen.
1208 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1209 Theo de Raadt and Dug Song
1210 removed many bugs, re-added newer features and
1211 created OpenSSH.
1212 Markus Friedl contributed the support for SSH
1213 protocol versions 1.5 and 2.0.
1214 Niels Provos and Markus Friedl contributed support
1215 for privilege separation.