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.348 2023/03/03 04:36:20 djm Exp $
  37 .Dd $Mdocdate: March 3 2023 $
  38 .Dt SSHD_CONFIG 5
  39 .Os
  40 .Sh NAME
  41 .Nm sshd_config
  42 .Nd OpenSSH daemon configuration file
  43 .Sh DESCRIPTION
  44 .Xr sshd 8
  45 reads configuration data from
  46 .Pa /etc/ssh/sshd_config
  47 (or the file specified with
  48 .Fl f
  49 on the command line).
  50 The file contains keyword-argument pairs, one per line.
  51 Unless noted otherwise, for each keyword, the first obtained value will be used.
  52 Lines starting with
  53 .Ql #
  54 and empty lines are interpreted as comments.
  55 Arguments may optionally be enclosed in double quotes
  56 .Pq \&"
  57 in order to represent arguments containing spaces.
  58 .Pp
  59 The possible
  60 keywords and their meanings are as follows (note that
  61 keywords are case-insensitive and arguments are case-sensitive):
  62 .Bl -tag -width Ds
  63 .It Cm AcceptEnv
  64 Specifies what environment variables sent by the client will be copied into
  65 the session's
  66 .Xr environ 7 .
  67 See
  68 .Cm SendEnv
  69 and
  70 .Cm SetEnv
  71 in
  72 .Xr ssh_config 5
  73 for how to configure the client.
  74 The
  75 .Ev TERM
  76 environment variable is always accepted whenever the client
  77 requests a pseudo-terminal as it is required by the protocol.
  78 Variables are specified by name, which may contain the wildcard characters
  79 .Ql *
  80 and
  81 .Ql \&? .
  82 Multiple environment variables may be separated by whitespace or spread
  83 across multiple
  84 .Cm AcceptEnv
  85 directives.
  86 Be warned that some environment variables could be used to bypass restricted
  87 user environments.
  88 For this reason, care should be taken in the use of this directive.
  89 The default is not to accept any environment variables.
  90 .It Cm AddressFamily
  91 Specifies which address family should be used by
  92 .Xr sshd 8 .
  93 Valid arguments are
  94 .Cm any
  95 (the default),
  96 .Cm inet
  97 (use IPv4 only), or
  98 .Cm inet6
  99 (use IPv6 only).
 100 .It Cm AllowAgentForwarding
 101 Specifies whether
 102 .Xr ssh-agent 1
 103 forwarding is permitted.
 104 The default is
 105 .Cm yes .
 106 Note that disabling agent forwarding does not improve security
 107 unless users are also denied shell access, as they can always install
 108 their own forwarders.
 109 .It Cm AllowGroups
 110 This keyword can be followed by a list of group name patterns, separated
 111 by spaces.
 112 If specified, login is allowed only for users whose primary
 113 group or supplementary group list matches one of the patterns.
 114 Only group names are valid; a numerical group ID is not recognized.
 115 By default, login is allowed for all groups.
 116 The allow/deny groups directives are processed in the following order:
 117 .Cm DenyGroups ,
 118 .Cm AllowGroups .
 119 .Pp
 120 See PATTERNS in
 121 .Xr ssh_config 5
 122 for more information on patterns.
 123 This keyword may appear multiple times in
 124 .Nm
 125 with each instance appending to the list.
 126 .It Cm AllowStreamLocalForwarding
 127 Specifies whether StreamLocal (Unix-domain socket) forwarding is permitted.
 128 The available options are
 129 .Cm yes
 130 (the default)
 131 or
 132 .Cm all
 133 to allow StreamLocal forwarding,
 134 .Cm no
 135 to prevent all StreamLocal forwarding,
 136 .Cm local
 137 to allow local (from the perspective of
 138 .Xr ssh 1 )
 139 forwarding only or
 140 .Cm remote
 141 to allow remote forwarding only.
 142 Note that disabling StreamLocal forwarding does not improve security unless
 143 users are also denied shell access, as they can always install their
 144 own forwarders.
 145 .It Cm AllowTcpForwarding
 146 Specifies whether TCP forwarding is permitted.
 147 The available options are
 148 .Cm yes
 149 (the default)
 150 or
 151 .Cm all
 152 to allow TCP forwarding,
 153 .Cm no
 154 to prevent all TCP forwarding,
 155 .Cm local
 156 to allow local (from the perspective of
 157 .Xr ssh 1 )
 158 forwarding only or
 159 .Cm remote
 160 to allow remote forwarding only.
 161 Note that disabling TCP forwarding does not improve security unless
 162 users are also denied shell access, as they can always install their
 163 own forwarders.
 164 .It Cm AllowUsers
 165 This keyword can be followed by a list of user name patterns, separated
 166 by spaces.
 167 If specified, login is allowed only for user names that
 168 match one of the patterns.
 169 Only user names are valid; a numerical user ID is not recognized.
 170 By default, login is allowed for all users.
 171 If the pattern takes the form USER@HOST then USER and HOST
 172 are separately checked, restricting logins to particular
 173 users from particular hosts.
 174 HOST criteria may additionally contain addresses to match in CIDR
 175 address/masklen format.
 176 The allow/deny users directives are processed in the following order:
 177 .Cm DenyUsers ,
 178 .Cm AllowUsers .
 179 .Pp
 180 See PATTERNS in
 181 .Xr ssh_config 5
 182 for more information on patterns.
 183 This keyword may appear multiple times in
 184 .Nm
 185 with each instance appending to the list.
 186 .It Cm AuthenticationMethods
 187 Specifies the authentication methods that must be successfully completed
 188 for a user to be granted access.
 189 This option must be followed by one or more lists of comma-separated
 190 authentication method names, or by the single string
 191 .Cm any
 192 to indicate the default behaviour of accepting any single authentication
 193 method.
 194 If the default is overridden, then successful authentication requires
 195 completion of every method in at least one of these lists.
 196 .Pp
 197 For example,
 198 .Qq publickey,password publickey,keyboard-interactive
 199 would require the user to complete public key authentication, followed by
 200 either password or keyboard interactive authentication.
 201 Only methods that are next in one or more lists are offered at each stage,
 202 so for this example it would not be possible to attempt password or
 203 keyboard-interactive authentication before public key.
 204 .Pp
 205 For keyboard interactive authentication it is also possible to
 206 restrict authentication to a specific device by appending a
 207 colon followed by the device identifier
 208 .Cm bsdauth
 209 or
 210 .Cm pam .
 211 depending on the server configuration.
 212 For example,
 213 .Qq keyboard-interactive:bsdauth
 214 would restrict keyboard interactive authentication to the
 215 .Cm bsdauth
 216 device.
 217 .Pp
 218 If the publickey method is listed more than once,
 219 .Xr sshd 8
 220 verifies that keys that have been used successfully are not reused for
 221 subsequent authentications.
 222 For example,
 223 .Qq publickey,publickey
 224 requires successful authentication using two different public keys.
 225 .Pp
 226 Note that each authentication method listed should also be explicitly enabled
 227 in the configuration.
 228 .Pp
 229 The available authentication methods are:
 230 .Qq gssapi-with-mic ,
 231 .Qq hostbased ,
 232 .Qq keyboard-interactive ,
 233 .Qq none
 234 (used for access to password-less accounts when
 235 .Cm PermitEmptyPasswords
 236 is enabled),
 237 .Qq password
 238 and
 239 .Qq publickey .
 240 .It Cm AuthorizedKeysCommand
 241 Specifies a program to be used to look up the user's public keys.
 242 The program must be owned by root, not writable by group or others and
 243 specified by an absolute path.
 244 Arguments to
 245 .Cm AuthorizedKeysCommand
 246 accept the tokens described in the
 247 .Sx TOKENS
 248 section.
 249 If no arguments are specified then the username of the target user is used.
 250 .Pp
 251 The program should produce on standard output zero or
 252 more lines of authorized_keys output (see
 253 .Sx AUTHORIZED_KEYS
 254 in
 255 .Xr sshd 8 ) .
 256 .Cm AuthorizedKeysCommand
 257 is tried after the usual
 258 .Cm AuthorizedKeysFile
 259 files and will not be executed if a matching key is found there.
 260 By default, no
 261 .Cm AuthorizedKeysCommand
 262 is run.
 263 .It Cm AuthorizedKeysCommandUser
 264 Specifies the user under whose account the
 265 .Cm AuthorizedKeysCommand
 266 is run.
 267 It is recommended to use a dedicated user that has no other role on the host
 268 than running authorized keys commands.
 269 If
 270 .Cm AuthorizedKeysCommand
 271 is specified but
 272 .Cm AuthorizedKeysCommandUser
 273 is not, then
 274 .Xr sshd 8
 275 will refuse to start.
 276 .It Cm AuthorizedKeysFile
 277 Specifies the file that contains the public keys used for user authentication.
 278 The format is described in the AUTHORIZED_KEYS FILE FORMAT section of
 279 .Xr sshd 8 .
 280 Arguments to
 281 .Cm AuthorizedKeysFile
 282 accept the tokens described in the
 283 .Sx TOKENS
 284 section.
 285 After expansion,
 286 .Cm AuthorizedKeysFile
 287 is taken to be an absolute path or one relative to the user's home
 288 directory.
 289 Multiple files may be listed, separated by whitespace.
 290 Alternately this option may be set to
 291 .Cm none
 292 to skip checking for user keys in files.
 293 The default is
 294 .Qq .ssh/authorized_keys .ssh/authorized_keys2 .
 295 .It Cm AuthorizedPrincipalsCommand
 296 Specifies a program to be used to generate the list of allowed
 297 certificate principals as per
 298 .Cm AuthorizedPrincipalsFile .
 299 The program must be owned by root, not writable by group or others and
 300 specified by an absolute path.
 301 Arguments to
 302 .Cm AuthorizedPrincipalsCommand
 303 accept the tokens described in the
 304 .Sx TOKENS
 305 section.
 306 If no arguments are specified then the username of the target user is used.
 307 .Pp
 308 The program should produce on standard output zero or
 309 more lines of
 310 .Cm AuthorizedPrincipalsFile
 311 output.
 312 If either
 313 .Cm AuthorizedPrincipalsCommand
 314 or
 315 .Cm AuthorizedPrincipalsFile
 316 is specified, then certificates offered by the client for authentication
 317 must contain a principal that is listed.
 318 By default, no
 319 .Cm AuthorizedPrincipalsCommand
 320 is run.
 321 .It Cm AuthorizedPrincipalsCommandUser
 322 Specifies the user under whose account the
 323 .Cm AuthorizedPrincipalsCommand
 324 is run.
 325 It is recommended to use a dedicated user that has no other role on the host
 326 than running authorized principals commands.
 327 If
 328 .Cm AuthorizedPrincipalsCommand
 329 is specified but
 330 .Cm AuthorizedPrincipalsCommandUser
 331 is not, then
 332 .Xr sshd 8
 333 will refuse to start.
 334 .It Cm AuthorizedPrincipalsFile
 335 Specifies a file that lists principal names that are accepted for
 336 certificate authentication.
 337 When using certificates signed by a key listed in
 338 .Cm TrustedUserCAKeys ,
 339 this file lists names, one of which must appear in the certificate for it
 340 to be accepted for authentication.
 341 Names are listed one per line preceded by key options (as described in
 342 .Sx AUTHORIZED_KEYS FILE FORMAT
 343 in
 344 .Xr sshd 8 ) .
 345 Empty lines and comments starting with
 346 .Ql #
 347 are ignored.
 348 .Pp
 349 Arguments to
 350 .Cm AuthorizedPrincipalsFile
 351 accept the tokens described in the
 352 .Sx TOKENS
 353 section.
 354 After expansion,
 355 .Cm AuthorizedPrincipalsFile
 356 is taken to be an absolute path or one relative to the user's home directory.
 357 The default is
 358 .Cm none ,
 359 i.e. not to use a principals file \(en in this case, the username
 360 of the user must appear in a certificate's principals list for it to be
 361 accepted.
 362 .Pp
 363 Note that
 364 .Cm AuthorizedPrincipalsFile
 365 is only used when authentication proceeds using a CA listed in
 366 .Cm TrustedUserCAKeys
 367 and is not consulted for certification authorities trusted via
 368 .Pa ~/.ssh/authorized_keys ,
 369 though the
 370 .Cm principals=
 371 key option offers a similar facility (see
 372 .Xr sshd 8
 373 for details).
 374 .It Cm Banner
 375 The contents of the specified file are sent to the remote user before
 376 authentication is allowed.
 377 If the argument is
 378 .Cm none
 379 then no banner is displayed.
 380 By default, no banner is displayed.
 381 .It Cm CASignatureAlgorithms
 382 Specifies which algorithms are allowed for signing of certificates
 383 by certificate authorities (CAs).
 384 The default is:
 385 .Bd -literal -offset indent
 386 ssh-ed25519,ecdsa-sha2-nistp256,
 387 ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
 388 sk-ssh-ed25519@openssh.com,
 389 sk-ecdsa-sha2-nistp256@openssh.com,
 390 rsa-sha2-512,rsa-sha2-256
 391 .Ed
 392 .Pp
 393 If the specified list begins with a
 394 .Sq +
 395 character, then the specified algorithms will be appended to the default set
 396 instead of replacing them.
 397 If the specified list begins with a
 398 .Sq -
 399 character, then the specified algorithms (including wildcards) will be removed
 400 from the default set instead of replacing them.
 401 .Pp
 402 Certificates signed using other algorithms will not be accepted for
 403 public key or host-based authentication.
 404 .It Cm ChannelTimeout
 405 Specifies whether and how quickly
 406 .Xr sshd 8
 407 should close inactive channels.
 408 Timeouts are specified as one or more
 409 .Dq type=interval
 410 pairs separated by whitespace, where the
 411 .Dq type
 412 must be a channel type name (as described in the table below), optionally
 413 containing wildcard characters.
 414 .Pp
 415 The timeout value
 416 .Dq interval
 417 is specified in seconds or may use any of the units documented in the
 418 .Sx TIME FORMATS
 419 section.
 420 For example,
 421 .Dq session:*=5m
 422 would cause all sessions to terminate after five minutes of inactivity.
 423 Specifying a zero value disables the inactivity timeout.
 424 .Pp
 425 The available channel types include:
 426 .Bl -tag -width Ds
 427 .It Cm agent-connection
 428 Open connections to
 429 .Xr ssh-agent 1 .
 430 .It Cm direct-tcpip , Cm direct-streamlocal@openssh.com
 431 Open TCP or Unix socket (respectively) connections that have
 432 been established from a
 433 .Xr ssh 1
 434 local forwarding, i.e.\&
 435 .Cm LocalForward
 436 or
 437 .Cm DynamicForward .
 438 .It Cm forwarded-tcpip , Cm forwarded-streamlocal@openssh.com
 439 Open TCP or Unix socket (respectively) connections that have been
 440 established to a
 441 .Xr sshd 8
 442 listening on behalf of a
 443 .Xr ssh 1
 444 remote forwarding, i.e.\&
 445 .Cm RemoteForward .
 446 .It Cm session:command
 447 Command execution sessions.
 448 .It Cm session:shell
 449 Interactive shell sessions.
 450 .It Cm session:subsystem:...
 451 Subsystem sessions, e.g. for
 452 .Xr sftp 1 ,
 453 which could be identified as
 454 .Cm session:subsystem:sftp .
 455 .It Cm x11-connection
 456 Open X11 forwarding sessions.
 457 .El
 458 .Pp
 459 Note that in all the above cases, terminating an inactive session does not
 460 guarantee to remove all resources associated with the session, e.g. shell
 461 processes or X11 clients relating to the session may continue to execute.
 462 .Pp
 463 Moreover, terminating an inactive channel or session does not necessarily
 464 close the SSH connection, nor does it prevent a client from
 465 requesting another channel of the same type.
 466 In particular, expiring an inactive forwarding session does not prevent
 467 another identical forwarding from being subsequently created.
 468 See also
 469 .Cm UnusedConnectionTimeout ,
 470 which may be used in conjunction with this option.
 471 .Pp
 472 The default is not to expire channels of any type for inactivity.
 473 .It Cm ChrootDirectory
 474 Specifies the pathname of a directory to
 475 .Xr chroot 2
 476 to after authentication.
 477 At session startup
 478 .Xr sshd 8
 479 checks that all components of the pathname are root-owned directories
 480 which are not writable by any other user or group.
 481 After the chroot,
 482 .Xr sshd 8
 483 changes the working directory to the user's home directory.
 484 Arguments to
 485 .Cm ChrootDirectory
 486 accept the tokens described in the
 487 .Sx TOKENS
 488 section.
 489 .Pp
 490 The
 491 .Cm ChrootDirectory
 492 must contain the necessary files and directories to support the
 493 user's session.
 494 For an interactive session this requires at least a shell, typically
 495 .Xr sh 1 ,
 496 and basic
 497 .Pa /dev
 498 nodes such as
 499 .Xr null 4 ,
 500 .Xr zero 4 ,
 501 .Xr stdin 4 ,
 502 .Xr stdout 4 ,
 503 .Xr stderr 4 ,
 504 and
 505 .Xr tty 4
 506 devices.
 507 For file transfer sessions using SFTP
 508 no additional configuration of the environment is necessary if the in-process
 509 sftp-server is used,
 510 though sessions which use logging may require
 511 .Pa /dev/log
 512 inside the chroot directory on some operating systems (see
 513 .Xr sftp-server 8
 514 for details).
 515 .Pp
 516 For safety, it is very important that the directory hierarchy be
 517 prevented from modification by other processes on the system (especially
 518 those outside the jail).
 519 Misconfiguration can lead to unsafe environments which
 520 .Xr sshd 8
 521 cannot detect.
 522 .Pp
 523 The default is
 524 .Cm none ,
 525 indicating not to
 526 .Xr chroot 2 .
 527 .It Cm Ciphers
 528 Specifies the ciphers allowed.
 529 Multiple ciphers must be comma-separated.
 530 If the specified list begins with a
 531 .Sq +
 532 character, then the specified ciphers will be appended to the default set
 533 instead of replacing them.
 534 If the specified list begins with a
 535 .Sq -
 536 character, then the specified ciphers (including wildcards) will be removed
 537 from the default set instead of replacing them.
 538 If the specified list begins with a
 539 .Sq ^
 540 character, then the specified ciphers will be placed at the head of the
 541 default set.
 542 .Pp
 543 The supported ciphers are:
 544 .Pp
 545 .Bl -item -compact -offset indent
 546 .It
 547 3des-cbc
 548 .It
 549 aes128-cbc
 550 .It
 551 aes192-cbc
 552 .It
 553 aes256-cbc
 554 .It
 555 aes128-ctr
 556 .It
 557 aes192-ctr
 558 .It
 559 aes256-ctr
 560 .It
 561 aes128-gcm@openssh.com
 562 .It
 563 aes256-gcm@openssh.com
 564 .It
 565 chacha20-poly1305@openssh.com
 566 .El
 567 .Pp
 568 The default is:
 569 .Bd -literal -offset indent
 570 chacha20-poly1305@openssh.com,
 571 aes128-ctr,aes192-ctr,aes256-ctr,
 572 aes128-gcm@openssh.com,aes256-gcm@openssh.com
 573 .Ed
 574 .Pp
 575 The list of available ciphers may also be obtained using
 576 .Qq ssh -Q cipher .
 577 .It Cm ClientAliveCountMax
 578 Sets the number of client alive messages which may be sent without
 579 .Xr sshd 8
 580 receiving any messages back from the client.
 581 If this threshold is reached while client alive messages are being sent,
 582 sshd will disconnect the client, terminating the session.
 583 It is important to note that the use of client alive messages is very
 584 different from
 585 .Cm TCPKeepAlive .
 586 The client alive messages are sent through the encrypted channel
 587 and therefore will not be spoofable.
 588 The TCP keepalive option enabled by
 589 .Cm TCPKeepAlive
 590 is spoofable.
 591 The client alive mechanism is valuable when the client or
 592 server depend on knowing when a connection has become unresponsive.
 593 .Pp
 594 The default value is 3.
 595 If
 596 .Cm ClientAliveInterval
 597 is set to 15, and
 598 .Cm ClientAliveCountMax
 599 is left at the default, unresponsive SSH clients
 600 will be disconnected after approximately 45 seconds.
 601 Setting a zero
 602 .Cm ClientAliveCountMax
 603 disables connection termination.
 604 .It Cm ClientAliveInterval
 605 Sets a timeout interval in seconds after which if no data has been received
 606 from the client,
 607 .Xr sshd 8
 608 will send a message through the encrypted
 609 channel to request a response from the client.
 610 The default
 611 is 0, indicating that these messages will not be sent to the client.
 612 .It Cm Compression
 613 Specifies whether compression is enabled after
 614 the user has authenticated successfully.
 615 The argument must be
 616 .Cm yes ,
 617 .Cm delayed
 618 (a legacy synonym for
 619 .Cm yes )
 620 or
 621 .Cm no .
 622 The default is
 623 .Cm yes .
 624 .It Cm DenyGroups
 625 This keyword can be followed by a list of group name patterns, separated
 626 by spaces.
 627 Login is disallowed for users whose primary group or supplementary
 628 group list matches one of the patterns.
 629 Only group names are valid; a numerical group ID is not recognized.
 630 By default, login is allowed for all groups.
 631 The allow/deny groups directives are processed in the following order:
 632 .Cm DenyGroups ,
 633 .Cm AllowGroups .
 634 .Pp
 635 See PATTERNS in
 636 .Xr ssh_config 5
 637 for more information on patterns.
 638 This keyword may appear multiple times in
 639 .Nm
 640 with each instance appending to the list.
 641 .It Cm DenyUsers
 642 This keyword can be followed by a list of user name patterns, separated
 643 by spaces.
 644 Login is disallowed for user names that match one of the patterns.
 645 Only user names are valid; a numerical user ID is not recognized.
 646 By default, login is allowed for all users.
 647 If the pattern takes the form USER@HOST then USER and HOST
 648 are separately checked, restricting logins to particular
 649 users from particular hosts.
 650 HOST criteria may additionally contain addresses to match in CIDR
 651 address/masklen format.
 652 The allow/deny users directives are processed in the following order:
 653 .Cm DenyUsers ,
 654 .Cm AllowUsers .
 655 .Pp
 656 See PATTERNS in
 657 .Xr ssh_config 5
 658 for more information on patterns.
 659 This keyword may appear multiple times in
 660 .Nm
 661 with each instance appending to the list.
 662 .It Cm DisableForwarding
 663 Disables all forwarding features, including X11,
 664 .Xr ssh-agent 1 ,
 665 TCP and StreamLocal.
 666 This option overrides all other forwarding-related options and may
 667 simplify restricted configurations.
 668 .It Cm ExposeAuthInfo
 669 Writes a temporary file containing a list of authentication methods and
 670 public credentials (e.g. keys) used to authenticate the user.
 671 The location of the file is exposed to the user session through the
 672 .Ev SSH_USER_AUTH
 673 environment variable.
 674 The default is
 675 .Cm no .
 676 .It Cm FingerprintHash
 677 Specifies the hash algorithm used when logging key fingerprints.
 678 Valid options are:
 679 .Cm md5
 680 and
 681 .Cm sha256 .
 682 The default is
 683 .Cm sha256 .
 684 .It Cm ForceCommand
 685 Forces the execution of the command specified by
 686 .Cm ForceCommand ,
 687 ignoring any command supplied by the client and
 688 .Pa ~/.ssh/rc
 689 if present.
 690 The command is invoked by using the user's login shell with the -c option.
 691 This applies to shell, command, or subsystem execution.
 692 It is most useful inside a
 693 .Cm Match
 694 block.
 695 The command originally supplied by the client is available in the
 696 .Ev SSH_ORIGINAL_COMMAND
 697 environment variable.
 698 Specifying a command of
 699 .Cm internal-sftp
 700 will force the use of an in-process SFTP server that requires no support
 701 files when used with
 702 .Cm ChrootDirectory .
 703 The default is
 704 .Cm none .
 705 .It Cm GatewayPorts
 706 Specifies whether remote hosts are allowed to connect to ports
 707 forwarded for the client.
 708 By default,
 709 .Xr sshd 8
 710 binds remote port forwardings to the loopback address.
 711 This prevents other remote hosts from connecting to forwarded ports.
 712 .Cm GatewayPorts
 713 can be used to specify that sshd
 714 should allow remote port forwardings to bind to non-loopback addresses, thus
 715 allowing other hosts to connect.
 716 The argument may be
 717 .Cm no
 718 to force remote port forwardings to be available to the local host only,
 719 .Cm yes
 720 to force remote port forwardings to bind to the wildcard address, or
 721 .Cm clientspecified
 722 to allow the client to select the address to which the forwarding is bound.
 723 The default is
 724 .Cm no .
 725 .It Cm GSSAPIAuthentication
 726 Specifies whether user authentication based on GSSAPI is allowed.
 727 The default is
 728 .Cm no .
 729 .It Cm GSSAPICleanupCredentials
 730 Specifies whether to automatically destroy the user's credentials cache
 731 on logout.
 732 The default is
 733 .Cm yes .
 734 .It Cm GSSAPIStrictAcceptorCheck
 735 Determines whether to be strict about the identity of the GSSAPI acceptor
 736 a client authenticates against.
 737 If set to
 738 .Cm yes
 739 then the client must authenticate against the host
 740 service on the current hostname.
 741 If set to
 742 .Cm no
 743 then the client may authenticate against any service key stored in the
 744 machine's default store.
 745 This facility is provided to assist with operation on multi homed machines.
 746 The default is
 747 .Cm yes .
 748 .It Cm HostbasedAcceptedAlgorithms
 749 Specifies the signature algorithms that will be accepted for hostbased
 750 authentication as a list of comma-separated patterns.
 751 Alternately if the specified list begins with a
 752 .Sq +
 753 character, then the specified signature algorithms will be appended to
 754 the default set instead of replacing them.
 755 If the specified list begins with a
 756 .Sq -
 757 character, then the specified signature algorithms (including wildcards)
 758 will be removed from the default set instead of replacing them.
 759 If the specified list begins with a
 760 .Sq ^
 761 character, then the specified signature algorithms will be placed at
 762 the head of the default set.
 763 The default for this option is:
 764 .Bd -literal -offset 3n
 765 ssh-ed25519-cert-v01@openssh.com,
 766 ecdsa-sha2-nistp256-cert-v01@openssh.com,
 767 ecdsa-sha2-nistp384-cert-v01@openssh.com,
 768 ecdsa-sha2-nistp521-cert-v01@openssh.com,
 769 sk-ssh-ed25519-cert-v01@openssh.com,
 770 sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
 771 rsa-sha2-512-cert-v01@openssh.com,
 772 rsa-sha2-256-cert-v01@openssh.com,
 773 ssh-ed25519,
 774 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
 775 sk-ssh-ed25519@openssh.com,
 776 sk-ecdsa-sha2-nistp256@openssh.com,
 777 rsa-sha2-512,rsa-sha2-256
 778 .Ed
 779 .Pp
 780 The list of available signature algorithms may also be obtained using
 781 .Qq ssh -Q HostbasedAcceptedAlgorithms .
 782 This was formerly named HostbasedAcceptedKeyTypes.
 783 .It Cm HostbasedAuthentication
 784 Specifies whether rhosts or /etc/hosts.equiv authentication together
 785 with successful public key client host authentication is allowed
 786 (host-based authentication).
 787 The default is
 788 .Cm no .
 789 .It Cm HostbasedUsesNameFromPacketOnly
 790 Specifies whether or not the server will attempt to perform a reverse
 791 name lookup when matching the name in the
 792 .Pa ~/.shosts ,
 793 .Pa ~/.rhosts ,
 794 and
 795 .Pa /etc/hosts.equiv
 796 files during
 797 .Cm HostbasedAuthentication .
 798 A setting of
 799 .Cm yes
 800 means that
 801 .Xr sshd 8
 802 uses the name supplied by the client rather than
 803 attempting to resolve the name from the TCP connection itself.
 804 The default is
 805 .Cm no .
 806 .It Cm HostCertificate
 807 Specifies a file containing a public host certificate.
 808 The certificate's public key must match a private host key already specified
 809 by
 810 .Cm HostKey .
 811 The default behaviour of
 812 .Xr sshd 8
 813 is not to load any certificates.
 814 .It Cm HostKey
 815 Specifies a file containing a private host key
 816 used by SSH.
 817 The defaults are
 818 .Pa /etc/ssh/ssh_host_ecdsa_key ,
 819 .Pa /etc/ssh/ssh_host_ed25519_key
 820 and
 821 .Pa /etc/ssh/ssh_host_rsa_key .
 822 .Pp
 823 Note that
 824 .Xr sshd 8
 825 will refuse to use a file if it is group/world-accessible
 826 and that the
 827 .Cm HostKeyAlgorithms
 828 option restricts which of the keys are actually used by
 829 .Xr sshd 8 .
 830 .Pp
 831 It is possible to have multiple host key files.
 832 It is also possible to specify public host key files instead.
 833 In this case operations on the private key will be delegated
 834 to an
 835 .Xr ssh-agent 1 .
 836 .It Cm HostKeyAgent
 837 Identifies the UNIX-domain socket used to communicate
 838 with an agent that has access to the private host keys.
 839 If the string
 840 .Qq SSH_AUTH_SOCK
 841 is specified, the location of the socket will be read from the
 842 .Ev SSH_AUTH_SOCK
 843 environment variable.
 844 .It Cm HostKeyAlgorithms
 845 Specifies the host key signature algorithms
 846 that the server offers.
 847 The default for this option is:
 848 .Bd -literal -offset 3n
 849 ssh-ed25519-cert-v01@openssh.com,
 850 ecdsa-sha2-nistp256-cert-v01@openssh.com,
 851 ecdsa-sha2-nistp384-cert-v01@openssh.com,
 852 ecdsa-sha2-nistp521-cert-v01@openssh.com,
 853 sk-ssh-ed25519-cert-v01@openssh.com,
 854 sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
 855 rsa-sha2-512-cert-v01@openssh.com,
 856 rsa-sha2-256-cert-v01@openssh.com,
 857 ssh-ed25519,
 858 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
 859 sk-ssh-ed25519@openssh.com,
 860 sk-ecdsa-sha2-nistp256@openssh.com,
 861 rsa-sha2-512,rsa-sha2-256
 862 .Ed
 863 .Pp
 864 The list of available signature algorithms may also be obtained using
 865 .Qq ssh -Q HostKeyAlgorithms .
 866 .It Cm IgnoreRhosts
 867 Specifies whether to ignore per-user
 868 .Pa .rhosts
 869 and
 870 .Pa .shosts
 871 files during
 872 .Cm HostbasedAuthentication .
 873 The system-wide
 874 .Pa /etc/hosts.equiv
 875 and
 876 .Pa /etc/ssh/shosts.equiv
 877 are still used regardless of this setting.
 878 .Pp
 879 Accepted values are
 880 .Cm yes
 881 (the default) to ignore all per-user files,
 882 .Cm shosts-only
 883 to allow the use of
 884 .Pa .shosts
 885 but to ignore
 886 .Pa .rhosts
 887 or
 888 .Cm no
 889 to allow both
 890 .Pa .shosts
 891 and
 892 .Pa rhosts .
 893 .It Cm IgnoreUserKnownHosts
 894 Specifies whether
 895 .Xr sshd 8
 896 should ignore the user's
 897 .Pa ~/.ssh/known_hosts
 898 during
 899 .Cm HostbasedAuthentication
 900 and use only the system-wide known hosts file
 901 .Pa /etc/ssh/ssh_known_hosts .
 902 The default is
 903 .Dq no .
 904 .It Cm Include
 905 Include the specified configuration file(s).
 906 Multiple pathnames may be specified and each pathname may contain
 907 .Xr glob 7
 908 wildcards that will be expanded and processed in lexical order.
 909 Files without absolute paths are assumed to be in
 910 .Pa /etc/ssh .
 911 An
 912 .Cm Include
 913 directive may appear inside a
 914 .Cm Match
 915 block
 916 to perform conditional inclusion.
 917 .It Cm IPQoS
 918 Specifies the IPv4 type-of-service or DSCP class for the connection.
 919 Accepted values are
 920 .Cm af11 ,
 921 .Cm af12 ,
 922 .Cm af13 ,
 923 .Cm af21 ,
 924 .Cm af22 ,
 925 .Cm af23 ,
 926 .Cm af31 ,
 927 .Cm af32 ,
 928 .Cm af33 ,
 929 .Cm af41 ,
 930 .Cm af42 ,
 931 .Cm af43 ,
 932 .Cm cs0 ,
 933 .Cm cs1 ,
 934 .Cm cs2 ,
 935 .Cm cs3 ,
 936 .Cm cs4 ,
 937 .Cm cs5 ,
 938 .Cm cs6 ,
 939 .Cm cs7 ,
 940 .Cm ef ,
 941 .Cm le ,
 942 .Cm lowdelay ,
 943 .Cm throughput ,
 944 .Cm reliability ,
 945 a numeric value, or
 946 .Cm none
 947 to use the operating system default.
 948 This option may take one or two arguments, separated by whitespace.
 949 If one argument is specified, it is used as the packet class unconditionally.
 950 If two values are specified, the first is automatically selected for
 951 interactive sessions and the second for non-interactive sessions.
 952 The default is
 953 .Cm af21
 954 (Low-Latency Data)
 955 for interactive sessions and
 956 .Cm cs1
 957 (Lower Effort)
 958 for non-interactive sessions.
 959 .It Cm KbdInteractiveAuthentication
 960 Specifies whether to allow keyboard-interactive authentication.
 961 All authentication styles from
 962 .Xr login.conf 5
 963 are supported.
 964 The default is
 965 .Cm yes .
 966 The argument to this keyword must be
 967 .Cm yes
 968 or
 969 .Cm no .
 970 .Cm ChallengeResponseAuthentication
 971 is a deprecated alias for this.
 972 .It Cm KerberosAuthentication
 973 Specifies whether the password provided by the user for
 974 .Cm PasswordAuthentication
 975 will be validated through the Kerberos KDC.
 976 To use this option, the server needs a
 977 Kerberos servtab which allows the verification of the KDC's identity.
 978 The default is
 979 .Cm no .
 980 .It Cm KerberosGetAFSToken
 981 If AFS is active and the user has a Kerberos 5 TGT, attempt to acquire
 982 an AFS token before accessing the user's home directory.
 983 The default is
 984 .Cm no .
 985 .It Cm KerberosOrLocalPasswd
 986 If password authentication through Kerberos fails then
 987 the password will be validated via any additional local mechanism
 988 such as
 989 .Pa /etc/passwd .
 990 The default is
 991 .Cm yes .
 992 .It Cm KerberosTicketCleanup
 993 Specifies whether to automatically destroy the user's ticket cache
 994 file on logout.
 995 The default is
 996 .Cm yes .
 997 .It Cm KexAlgorithms
 998 Specifies the available KEX (Key Exchange) algorithms.
 999 Multiple algorithms must be comma-separated.
1000 Alternately if the specified list begins with a
1001 .Sq +
1002 character, then the specified algorithms will be appended to the default set
1003 instead of replacing them.
1004 If the specified list begins with a
1005 .Sq -
1006 character, then the specified algorithms (including wildcards) will be removed
1007 from the default set instead of replacing them.
1008 If the specified list begins with a
1009 .Sq ^
1010 character, then the specified algorithms will be placed at the head of the
1011 default set.
1012 The supported algorithms are:
1013 .Pp
1014 .Bl -item -compact -offset indent
1015 .It
1016 curve25519-sha256
1017 .It
1018 curve25519-sha256@libssh.org
1019 .It
1020 diffie-hellman-group1-sha1
1021 .It
1022 diffie-hellman-group14-sha1
1023 .It
1024 diffie-hellman-group14-sha256
1025 .It
1026 diffie-hellman-group16-sha512
1027 .It
1028 diffie-hellman-group18-sha512
1029 .It
1030 diffie-hellman-group-exchange-sha1
1031 .It
1032 diffie-hellman-group-exchange-sha256
1033 .It
1034 ecdh-sha2-nistp256
1035 .It
1036 ecdh-sha2-nistp384
1037 .It
1038 ecdh-sha2-nistp521
1039 .It
1040 sntrup761x25519-sha512@openssh.com
1041 .El
1042 .Pp
1043 The default is:
1044 .Bd -literal -offset indent
1045 sntrup761x25519-sha512@openssh.com,
1046 curve25519-sha256,curve25519-sha256@libssh.org,
1047 ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1048 diffie-hellman-group-exchange-sha256,
1049 diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,
1050 diffie-hellman-group14-sha256
1051 .Ed
1052 .Pp
1053 The list of available key exchange algorithms may also be obtained using
1054 .Qq ssh -Q KexAlgorithms .
1055 .It Cm ListenAddress
1056 Specifies the local addresses
1057 .Xr sshd 8
1058 should listen on.
1059 The following forms may be used:
1060 .Pp
1061 .Bl -item -offset indent -compact
1062 .It
1063 .Cm ListenAddress
1064 .Sm off
1065 .Ar hostname | address
1066 .Sm on
1067 .Op Cm rdomain Ar domain
1068 .It
1069 .Cm ListenAddress
1070 .Sm off
1071 .Ar hostname : port
1072 .Sm on
1073 .Op Cm rdomain Ar domain
1074 .It
1075 .Cm ListenAddress
1076 .Sm off
1077 .Ar IPv4_address : port
1078 .Sm on
1079 .Op Cm rdomain Ar domain
1080 .It
1081 .Cm ListenAddress
1082 .Sm off
1083 .Oo Ar hostname | address Oc : Ar port
1084 .Sm on
1085 .Op Cm rdomain Ar domain
1086 .El
1087 .Pp
1088 The optional
1089 .Cm rdomain
1090 qualifier requests
1091 .Xr sshd 8
1092 listen in an explicit routing domain.
1093 If
1094 .Ar port
1095 is not specified,
1096 sshd will listen on the address and all
1097 .Cm Port
1098 options specified.
1099 The default is to listen on all local addresses on the current default
1100 routing domain.
1101 Multiple
1102 .Cm ListenAddress
1103 options are permitted.
1104 For more information on routing domains, see
1105 .Xr rdomain 4 .
1106 .It Cm LoginGraceTime
1107 The server disconnects after this time if the user has not
1108 successfully logged in.
1109 If the value is 0, there is no time limit.
1110 The default is 120 seconds.
1111 .It Cm LogLevel
1112 Gives the verbosity level that is used when logging messages from
1113 .Xr sshd 8 .
1114 The possible values are:
1115 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
1116 The default is INFO.
1117 DEBUG and DEBUG1 are equivalent.
1118 DEBUG2 and DEBUG3 each specify higher levels of debugging output.
1119 Logging with a DEBUG level violates the privacy of users and is not recommended.
1120 .It Cm LogVerbose
1121 Specify one or more overrides to LogLevel.
1122 An override consists of a pattern lists that matches the source file, function
1123 and line number to force detailed logging for.
1124 For example, an override pattern of:
1125 .Bd -literal -offset indent
1126 kex.c:*:1000,*:kex_exchange_identification():*,packet.c:*
1127 .Ed
1128 .Pp
1129 would enable detailed logging for line 1000 of
1130 .Pa kex.c ,
1131 everything in the
1132 .Fn kex_exchange_identification
1133 function, and all code in the
1134 .Pa packet.c
1135 file.
1136 This option is intended for debugging and no overrides are enabled by default.
1137 .It Cm MACs
1138 Specifies the available MAC (message authentication code) algorithms.
1139 The MAC algorithm is used for data integrity protection.
1140 Multiple algorithms must be comma-separated.
1141 If the specified list begins with a
1142 .Sq +
1143 character, then the specified algorithms will be appended to the default set
1144 instead of replacing them.
1145 If the specified list begins with a
1146 .Sq -
1147 character, then the specified algorithms (including wildcards) will be removed
1148 from the default set instead of replacing them.
1149 If the specified list begins with a
1150 .Sq ^
1151 character, then the specified algorithms will be placed at the head of the
1152 default set.
1153 .Pp
1154 The algorithms that contain
1155 .Qq -etm
1156 calculate the MAC after encryption (encrypt-then-mac).
1157 These are considered safer and their use recommended.
1158 The supported MACs are:
1159 .Pp
1160 .Bl -item -compact -offset indent
1161 .It
1162 hmac-md5
1163 .It
1164 hmac-md5-96
1165 .It
1166 hmac-sha1
1167 .It
1168 hmac-sha1-96
1169 .It
1170 hmac-sha2-256
1171 .It
1172 hmac-sha2-512
1173 .It
1174 umac-64@openssh.com
1175 .It
1176 umac-128@openssh.com
1177 .It
1178 hmac-md5-etm@openssh.com
1179 .It
1180 hmac-md5-96-etm@openssh.com
1181 .It
1182 hmac-sha1-etm@openssh.com
1183 .It
1184 hmac-sha1-96-etm@openssh.com
1185 .It
1186 hmac-sha2-256-etm@openssh.com
1187 .It
1188 hmac-sha2-512-etm@openssh.com
1189 .It
1190 umac-64-etm@openssh.com
1191 .It
1192 umac-128-etm@openssh.com
1193 .El
1194 .Pp
1195 The default is:
1196 .Bd -literal -offset indent
1197 umac-64-etm@openssh.com,umac-128-etm@openssh.com,
1198 hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
1199 hmac-sha1-etm@openssh.com,
1200 umac-64@openssh.com,umac-128@openssh.com,
1201 hmac-sha2-256,hmac-sha2-512,hmac-sha1
1202 .Ed
1203 .Pp
1204 The list of available MAC algorithms may also be obtained using
1205 .Qq ssh -Q mac .
1206 .It Cm Match
1207 Introduces a conditional block.
1208 If all of the criteria on the
1209 .Cm Match
1210 line are satisfied, the keywords on the following lines override those
1211 set in the global section of the config file, until either another
1212 .Cm Match
1213 line or the end of the file.
1214 If a keyword appears in multiple
1215 .Cm Match
1216 blocks that are satisfied, only the first instance of the keyword is
1217 applied.
1218 .Pp
1219 The arguments to
1220 .Cm Match
1221 are one or more criteria-pattern pairs or the single token
1222 .Cm All
1223 which matches all criteria.
1224 The available criteria are
1225 .Cm User ,
1226 .Cm Group ,
1227 .Cm Host ,
1228 .Cm LocalAddress ,
1229 .Cm LocalPort ,
1230 .Cm RDomain ,
1231 and
1232 .Cm Address
1233 (with
1234 .Cm RDomain
1235 representing the
1236 .Xr rdomain 4
1237 on which the connection was received).
1238 .Pp
1239 The match patterns may consist of single entries or comma-separated
1240 lists and may use the wildcard and negation operators described in the
1241 .Sx PATTERNS
1242 section of
1243 .Xr ssh_config 5 .
1244 .Pp
1245 The patterns in an
1246 .Cm Address
1247 criteria may additionally contain addresses to match in CIDR
1248 address/masklen format,
1249 such as 192.0.2.0/24 or 2001:db8::/32.
1250 Note that the mask length provided must be consistent with the address -
1251 it is an error to specify a mask length that is too long for the address
1252 or one with bits set in this host portion of the address.
1253 For example, 192.0.2.0/33 and 192.0.2.0/8, respectively.
1254 .Pp
1255 Only a subset of keywords may be used on the lines following a
1256 .Cm Match
1257 keyword.
1258 Available keywords are
1259 .Cm AcceptEnv ,
1260 .Cm AllowAgentForwarding ,
1261 .Cm AllowGroups ,
1262 .Cm AllowStreamLocalForwarding ,
1263 .Cm AllowTcpForwarding ,
1264 .Cm AllowUsers ,
1265 .Cm AuthenticationMethods ,
1266 .Cm AuthorizedKeysCommand ,
1267 .Cm AuthorizedKeysCommandUser ,
1268 .Cm AuthorizedKeysFile ,
1269 .Cm AuthorizedPrincipalsCommand ,
1270 .Cm AuthorizedPrincipalsCommandUser ,
1271 .Cm AuthorizedPrincipalsFile ,
1272 .Cm Banner ,
1273 .Cm CASignatureAlgorithms ,
1274 .Cm ChannelTimeout ,
1275 .Cm ChrootDirectory ,
1276 .Cm ClientAliveCountMax ,
1277 .Cm ClientAliveInterval ,
1278 .Cm DenyGroups ,
1279 .Cm DenyUsers ,
1280 .Cm DisableForwarding ,
1281 .Cm ExposeAuthInfo ,
1282 .Cm ForceCommand ,
1283 .Cm GatewayPorts ,
1284 .Cm GSSAPIAuthentication ,
1285 .Cm HostbasedAcceptedAlgorithms ,
1286 .Cm HostbasedAuthentication ,
1287 .Cm HostbasedUsesNameFromPacketOnly ,
1288 .Cm IgnoreRhosts ,
1289 .Cm Include ,
1290 .Cm IPQoS ,
1291 .Cm KbdInteractiveAuthentication ,
1292 .Cm KerberosAuthentication ,
1293 .Cm LogLevel ,
1294 .Cm MaxAuthTries ,
1295 .Cm MaxSessions ,
1296 .Cm PasswordAuthentication ,
1297 .Cm PermitEmptyPasswords ,
1298 .Cm PermitListen ,
1299 .Cm PermitOpen ,
1300 .Cm PermitRootLogin ,
1301 .Cm PermitTTY ,
1302 .Cm PermitTunnel ,
1303 .Cm PermitUserRC ,
1304 .Cm PubkeyAcceptedAlgorithms ,
1305 .Cm PubkeyAuthentication ,
1306 .Cm PubkeyAuthOptions ,
1307 .Cm RekeyLimit ,
1308 .Cm RevokedKeys ,
1309 .Cm RDomain ,
1310 .Cm SetEnv ,
1311 .Cm StreamLocalBindMask ,
1312 .Cm StreamLocalBindUnlink ,
1313 .Cm TrustedUserCAKeys ,
1314 .Cm UnusedConnectionTimeout ,
1315 .Cm X11DisplayOffset ,
1316 .Cm X11Forwarding
1317 and
1318 .Cm X11UseLocalhost .
1319 .It Cm MaxAuthTries
1320 Specifies the maximum number of authentication attempts permitted per
1321 connection.
1322 Once the number of failures reaches half this value,
1323 additional failures are logged.
1324 The default is 6.
1325 .It Cm MaxSessions
1326 Specifies the maximum number of open shell, login or subsystem (e.g. sftp)
1327 sessions permitted per network connection.
1328 Multiple sessions may be established by clients that support connection
1329 multiplexing.
1330 Setting
1331 .Cm MaxSessions
1332 to 1 will effectively disable session multiplexing, whereas setting it to 0
1333 will prevent all shell, login and subsystem sessions while still permitting
1334 forwarding.
1335 The default is 10.
1336 .It Cm MaxStartups
1337 Specifies the maximum number of concurrent unauthenticated connections to the
1338 SSH daemon.
1339 Additional connections will be dropped until authentication succeeds or the
1340 .Cm LoginGraceTime
1341 expires for a connection.
1342 The default is 10:30:100.
1343 .Pp
1344 Alternatively, random early drop can be enabled by specifying
1345 the three colon separated values
1346 start:rate:full (e.g. "10:30:60").
1347 .Xr sshd 8
1348 will refuse connection attempts with a probability of rate/100 (30%)
1349 if there are currently start (10) unauthenticated connections.
1350 The probability increases linearly and all connection attempts
1351 are refused if the number of unauthenticated connections reaches full (60).
1352 .It Cm ModuliFile
1353 Specifies the
1354 .Xr moduli 5
1355 file that contains the Diffie-Hellman groups used for the
1356 .Dq diffie-hellman-group-exchange-sha1
1357 and
1358 .Dq diffie-hellman-group-exchange-sha256
1359 key exchange methods.
1360 The default is
1361 .Pa /etc/moduli .
1362 .It Cm PasswordAuthentication
1363 Specifies whether password authentication is allowed.
1364 Note that passwords may also be accepted via
1365 .Cm KbdInteractiveAuthentication .
1366 See also
1367 .Cm UsePAM .
1368 The default is
1369 .Cm no .
1370 .It Cm PermitEmptyPasswords
1371 When password authentication is allowed, it specifies whether the
1372 server allows login to accounts with empty password strings.
1373 The default is
1374 .Cm no .
1375 .It Cm PermitListen
1376 Specifies the addresses/ports on which a remote TCP port forwarding may listen.
1377 The listen specification must be one of the following forms:
1378 .Pp
1379 .Bl -item -offset indent -compact
1380 .It
1381 .Cm PermitListen
1382 .Sm off
1383 .Ar port
1384 .Sm on
1385 .It
1386 .Cm PermitListen
1387 .Sm off
1388 .Ar host : port
1389 .Sm on
1390 .El
1391 .Pp
1392 Multiple permissions may be specified by separating them with whitespace.
1393 An argument of
1394 .Cm any
1395 can be used to remove all restrictions and permit any listen requests.
1396 An argument of
1397 .Cm none
1398 can be used to prohibit all listen requests.
1399 The host name may contain wildcards as described in the PATTERNS section in
1400 .Xr ssh_config 5 .
1401 The wildcard
1402 .Sq *
1403 can also be used in place of a port number to allow all ports.
1404 By default all port forwarding listen requests are permitted.
1405 Note that the
1406 .Cm GatewayPorts
1407 option may further restrict which addresses may be listened on.
1408 Note also that
1409 .Xr ssh 1
1410 will request a listen host of
1411 .Dq localhost
1412 if no listen host was specifically requested, and this name is
1413 treated differently to explicit localhost addresses of
1414 .Dq 127.0.0.1
1415 and
1416 .Dq ::1 .
1417 .It Cm PermitOpen
1418 Specifies the destinations to which TCP port forwarding is permitted.
1419 The forwarding specification must be one of the following forms:
1420 .Pp
1421 .Bl -item -offset indent -compact
1422 .It
1423 .Cm PermitOpen
1424 .Sm off
1425 .Ar host : port
1426 .Sm on
1427 .It
1428 .Cm PermitOpen
1429 .Sm off
1430 .Ar IPv4_addr : port
1431 .Sm on
1432 .It
1433 .Cm PermitOpen
1434 .Sm off
1435 .Ar \&[ IPv6_addr \&] : port
1436 .Sm on
1437 .El
1438 .Pp
1439 Multiple forwards may be specified by separating them with whitespace.
1440 An argument of
1441 .Cm any
1442 can be used to remove all restrictions and permit any forwarding requests.
1443 An argument of
1444 .Cm none
1445 can be used to prohibit all forwarding requests.
1446 The wildcard
1447 .Sq *
1448 can be used for host or port to allow all hosts or ports respectively.
1449 Otherwise, no pattern matching or address lookups are performed on supplied
1450 names.
1451 By default all port forwarding requests are permitted.
1452 .It Cm PermitRootLogin
1453 Specifies whether root can log in using
1454 .Xr ssh 1 .
1455 The argument must be
1456 .Cm yes ,
1457 .Cm prohibit-password ,
1458 .Cm forced-commands-only ,
1459 or
1460 .Cm no .
1461 The default is
1462 .Cm no .
1463 Note that if
1464 .Cm ChallengeResponseAuthentication
1465 and
1466 .Cm UsePAM
1467 are both
1468 .Cm yes ,
1469 this setting may be overridden by the PAM policy.
1470 .Pp
1471 If this option is set to
1472 .Cm prohibit-password
1473 (or its deprecated alias,
1474 .Cm without-password ) ,
1475 password and keyboard-interactive authentication are disabled for root.
1476 .Pp
1477 If this option is set to
1478 .Cm forced-commands-only ,
1479 root login with public key authentication will be allowed,
1480 but only if the
1481 .Ar command
1482 option has been specified
1483 (which may be useful for taking remote backups even if root login is
1484 normally not allowed).
1485 All other authentication methods are disabled for root.
1486 .Pp
1487 If this option is set to
1488 .Cm no ,
1489 root is not allowed to log in.
1490 .It Cm PermitTTY
1491 Specifies whether
1492 .Xr pty 4
1493 allocation is permitted.
1494 The default is
1495 .Cm yes .
1496 .It Cm PermitTunnel
1497 Specifies whether
1498 .Xr tun 4
1499 device forwarding is allowed.
1500 The argument must be
1501 .Cm yes ,
1502 .Cm point-to-point
1503 (layer 3),
1504 .Cm ethernet
1505 (layer 2), or
1506 .Cm no .
1507 Specifying
1508 .Cm yes
1509 permits both
1510 .Cm point-to-point
1511 and
1512 .Cm ethernet .
1513 The default is
1514 .Cm no .
1515 .Pp
1516 Independent of this setting, the permissions of the selected
1517 .Xr tun 4
1518 device must allow access to the user.
1519 .It Cm PermitUserEnvironment
1520 Specifies whether
1521 .Pa ~/.ssh/environment
1522 and
1523 .Cm environment=
1524 options in
1525 .Pa ~/.ssh/authorized_keys
1526 are processed by
1527 .Xr sshd 8 .
1528 Valid options are
1529 .Cm yes ,
1530 .Cm no
1531 or a pattern-list specifying which environment variable names to accept
1532 (for example
1533 .Qq LANG,LC_* ) .
1534 The default is
1535 .Cm no .
1536 Enabling environment processing may enable users to bypass access
1537 restrictions in some configurations using mechanisms such as
1538 .Ev LD_PRELOAD .
1539 .It Cm PermitUserRC
1540 Specifies whether any
1541 .Pa ~/.ssh/rc
1542 file is executed.
1543 The default is
1544 .Cm yes .
1545 .It Cm PerSourceMaxStartups
1546 Specifies the number of unauthenticated connections allowed from a
1547 given source address, or
1548 .Dq none
1549 if there is no limit.
1550 This limit is applied in addition to
1551 .Cm MaxStartups ,
1552 whichever is lower.
1553 The default is
1554 .Cm none .
1555 .It Cm PerSourceNetBlockSize
1556 Specifies the number of bits of source address that are grouped together
1557 for the purposes of applying PerSourceMaxStartups limits.
1558 Values for IPv4 and optionally IPv6 may be specified, separated by a colon.
1559 The default is
1560 .Cm 32:128 ,
1561 which means each address is considered individually.
1562 .It Cm PidFile
1563 Specifies the file that contains the process ID of the
1564 SSH daemon, or
1565 .Cm none
1566 to not write one.
1567 The default is
1568 .Pa /var/run/sshd.pid .
1569 .It Cm Port
1570 Specifies the port number that
1571 .Xr sshd 8
1572 listens on.
1573 The default is 22.
1574 Multiple options of this type are permitted.
1575 See also
1576 .Cm ListenAddress .
1577 .It Cm PrintLastLog
1578 Specifies whether
1579 .Xr sshd 8
1580 should print the date and time of the last user login when a user logs
1581 in interactively.
1582 The default is
1583 .Cm yes .
1584 .It Cm PrintMotd
1585 Specifies whether
1586 .Xr sshd 8
1587 should print
1588 .Pa /etc/motd
1589 when a user logs in interactively.
1590 (On some systems it is also printed by the shell,
1591 .Pa /etc/profile ,
1592 or equivalent.)
1593 The default is
1594 .Cm yes .
1595 .It Cm PubkeyAcceptedAlgorithms
1596 Specifies the signature algorithms that will be accepted for public key
1597 authentication as a list of comma-separated patterns.
1598 Alternately if the specified list begins with a
1599 .Sq +
1600 character, then the specified algorithms will be appended to the default set
1601 instead of replacing them.
1602 If the specified list begins with a
1603 .Sq -
1604 character, then the specified algorithms (including wildcards) will be removed
1605 from the default set instead of replacing them.
1606 If the specified list begins with a
1607 .Sq ^
1608 character, then the specified algorithms will be placed at the head of the
1609 default set.
1610 The default for this option is:
1611 .Bd -literal -offset 3n
1612 ssh-ed25519-cert-v01@openssh.com,
1613 ecdsa-sha2-nistp256-cert-v01@openssh.com,
1614 ecdsa-sha2-nistp384-cert-v01@openssh.com,
1615 ecdsa-sha2-nistp521-cert-v01@openssh.com,
1616 sk-ssh-ed25519-cert-v01@openssh.com,
1617 sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
1618 rsa-sha2-512-cert-v01@openssh.com,
1619 rsa-sha2-256-cert-v01@openssh.com,
1620 ssh-ed25519,
1621 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1622 sk-ssh-ed25519@openssh.com,
1623 sk-ecdsa-sha2-nistp256@openssh.com,
1624 rsa-sha2-512,rsa-sha2-256
1625 .Ed
1626 .Pp
1627 The list of available signature algorithms may also be obtained using
1628 .Qq ssh -Q PubkeyAcceptedAlgorithms .
1629 .It Cm PubkeyAuthOptions
1630 Sets one or more public key authentication options.
1631 The supported keywords are:
1632 .Cm none
1633 (the default; indicating no additional options are enabled),
1634 .Cm touch-required
1635 and
1636 .Cm verify-required .
1637 .Pp
1638 The
1639 .Cm touch-required
1640 option causes public key authentication using a FIDO authenticator algorithm
1641 (i.e.\&
1642 .Cm ecdsa-sk
1643 or
1644 .Cm ed25519-sk )
1645 to always require the signature to attest that a physically present user
1646 explicitly confirmed the authentication (usually by touching the authenticator).
1647 By default,
1648 .Xr sshd 8
1649 requires user presence unless overridden with an authorized_keys option.
1650 The
1651 .Cm touch-required
1652 flag disables this override.
1653 .Pp
1654 The
1655 .Cm verify-required
1656 option requires a FIDO key signature attest that the user was verified,
1657 e.g. via a PIN.
1658 .Pp
1659 Neither the
1660 .Cm touch-required
1661 or
1662 .Cm verify-required
1663 options have any effect for other, non-FIDO, public key types.
1664 .It Cm PubkeyAuthentication
1665 Specifies whether public key authentication is allowed.
1666 The default is
1667 .Cm yes .
1668 .It Cm RekeyLimit
1669 Specifies the maximum amount of data that may be transmitted or received
1670 before the session key is renegotiated, optionally followed by a maximum
1671 amount of time that may pass before the session key is renegotiated.
1672 The first argument is specified in bytes and may have a suffix of
1673 .Sq K ,
1674 .Sq M ,
1675 or
1676 .Sq G
1677 to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1678 The default is between
1679 .Sq 1G
1680 and
1681 .Sq 4G ,
1682 depending on the cipher.
1683 The optional second value is specified in seconds and may use any of the
1684 units documented in the
1685 .Sx TIME FORMATS
1686 section.
1687 The default value for
1688 .Cm RekeyLimit
1689 is
1690 .Cm default none ,
1691 which means that rekeying is performed after the cipher's default amount
1692 of data has been sent or received and no time based rekeying is done.
1693 .It Cm RequiredRSASize
1694 Specifies the minimum RSA key size (in bits) that
1695 .Xr sshd 8
1696 will accept.
1697 User and host-based authentication keys smaller than this limit will be
1698 refused.
1699 The default is
1700 .Cm 1024
1701 bits.
1702 Note that this limit may only be raised from the default.
1703 .It Cm RevokedKeys
1704 Specifies revoked public keys file, or
1705 .Cm none
1706 to not use one.
1707 Keys listed in this file will be refused for public key authentication.
1708 Note that if this file is not readable, then public key authentication will
1709 be refused for all users.
1710 Keys may be specified as a text file, listing one public key per line, or as
1711 an OpenSSH Key Revocation List (KRL) as generated by
1712 .Xr ssh-keygen 1 .
1713 For more information on KRLs, see the KEY REVOCATION LISTS section in
1714 .Xr ssh-keygen 1 .
1715 .It Cm RDomain
1716 Specifies an explicit routing domain that is applied after authentication
1717 has completed.
1718 The user session, as well as any forwarded or listening IP sockets,
1719 will be bound to this
1720 .Xr rdomain 4 .
1721 If the routing domain is set to
1722 .Cm \&%D ,
1723 then the domain in which the incoming connection was received will be applied.
1724 .It Cm SecurityKeyProvider
1725 Specifies a path to a library that will be used when loading
1726 FIDO authenticator-hosted keys, overriding the default of using
1727 the built-in USB HID support.
1728 .It Cm SetEnv
1729 Specifies one or more environment variables to set in child sessions started
1730 by
1731 .Xr sshd 8
1732 as
1733 .Dq NAME=VALUE .
1734 The environment value may be quoted (e.g. if it contains whitespace
1735 characters).
1736 Environment variables set by
1737 .Cm SetEnv
1738 override the default environment and any variables specified by the user
1739 via
1740 .Cm AcceptEnv
1741 or
1742 .Cm PermitUserEnvironment .
1743 .It Cm StreamLocalBindMask
1744 Sets the octal file creation mode mask
1745 .Pq umask
1746 used when creating a Unix-domain socket file for local or remote
1747 port forwarding.
1748 This option is only used for port forwarding to a Unix-domain socket file.
1749 .Pp
1750 The default value is 0177, which creates a Unix-domain socket file that is
1751 readable and writable only by the owner.
1752 Note that not all operating systems honor the file mode on Unix-domain
1753 socket files.
1754 .It Cm StreamLocalBindUnlink
1755 Specifies whether to remove an existing Unix-domain socket file for local
1756 or remote port forwarding before creating a new one.
1757 If the socket file already exists and
1758 .Cm StreamLocalBindUnlink
1759 is not enabled,
1760 .Nm sshd
1761 will be unable to forward the port to the Unix-domain socket file.
1762 This option is only used for port forwarding to a Unix-domain socket file.
1763 .Pp
1764 The argument must be
1765 .Cm yes
1766 or
1767 .Cm no .
1768 The default is
1769 .Cm no .
1770 .It Cm StrictModes
1771 Specifies whether
1772 .Xr sshd 8
1773 should check file modes and ownership of the
1774 user's files and home directory before accepting login.
1775 This is normally desirable because novices sometimes accidentally leave their
1776 directory or files world-writable.
1777 The default is
1778 .Cm yes .
1779 Note that this does not apply to
1780 .Cm ChrootDirectory ,
1781 whose permissions and ownership are checked unconditionally.
1782 .It Cm Subsystem
1783 Configures an external subsystem (e.g. file transfer daemon).
1784 Arguments should be a subsystem name and a command (with optional arguments)
1785 to execute upon subsystem request.
1786 .Pp
1787 The command
1788 .Cm sftp-server
1789 implements the SFTP file transfer subsystem.
1790 .Pp
1791 Alternately the name
1792 .Cm internal-sftp
1793 implements an in-process SFTP server.
1794 This may simplify configurations using
1795 .Cm ChrootDirectory
1796 to force a different filesystem root on clients.
1797 .Pp
1798 By default no subsystems are defined.
1799 .It Cm SyslogFacility
1800 Gives the facility code that is used when logging messages from
1801 .Xr sshd 8 .
1802 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
1803 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
1804 The default is AUTH.
1805 .It Cm TCPKeepAlive
1806 Specifies whether the system should send TCP keepalive messages to the
1807 other side.
1808 If they are sent, death of the connection or crash of one
1809 of the machines will be properly noticed.
1810 However, this means that
1811 connections will die if the route is down temporarily, and some people
1812 find it annoying.
1813 On the other hand, if TCP keepalives are not sent,
1814 sessions may hang indefinitely on the server, leaving
1815 .Qq ghost
1816 users and consuming server resources.
1817 .Pp
1818 The default is
1819 .Cm yes
1820 (to send TCP keepalive messages), and the server will notice
1821 if the network goes down or the client host crashes.
1822 This avoids infinitely hanging sessions.
1823 .Pp
1824 To disable TCP keepalive messages, the value should be set to
1825 .Cm no .
1826 .It Cm TrustedUserCAKeys
1827 Specifies a file containing public keys of certificate authorities that are
1828 trusted to sign user certificates for authentication, or
1829 .Cm none
1830 to not use one.
1831 Keys are listed one per line; empty lines and comments starting with
1832 .Ql #
1833 are allowed.
1834 If a certificate is presented for authentication and has its signing CA key
1835 listed in this file, then it may be used for authentication for any user
1836 listed in the certificate's principals list.
1837 Note that certificates that lack a list of principals will not be permitted
1838 for authentication using
1839 .Cm TrustedUserCAKeys .
1840 For more details on certificates, see the CERTIFICATES section in
1841 .Xr ssh-keygen 1 .
1842 .It Cm UnusedConnectionTimeout
1843 Specifies whether and how quickly
1844 .Xr sshd 8
1845 should close client connections with no open channels.
1846 Open channels include active shell, command execution or subsystem
1847 sessions, connected network, socket, agent or X11 forwardings.
1848 Forwarding listeners, such as those from the
1849 .Xr ssh 1
1850 .Fl R
1851 flag, are not considered as open channels and do not prevent the timeout.
1852 The timeout value
1853 is specified in seconds or may use any of the units documented in the
1854 .Sx TIME FORMATS
1855 section.
1856 .Pp
1857 Note that this timeout starts when the client connection completes
1858 user authentication but before the client has an opportunity to open any
1859 channels.
1860 Caution should be used when using short timeout values, as they may not
1861 provide sufficient time for the client to request and open its channels
1862 before terminating the connection.
1863 .Pp
1864 The default
1865 .Cm none
1866 is to never expire connections for having no open channels.
1867 This option may be useful in conjunction with
1868 .Cm ChannelTimeout .
1869 .It Cm UseBlacklist
1870 Specifies whether
1871 .Xr sshd 8
1872 attempts to send authentication success and failure messages
1873 to the
1874 .Xr blacklistd 8
1875 daemon.
1876 The default is
1877 .Cm no .
1878 For forward compatibility with an upcoming
1879 .Xr blacklistd
1880 rename, the
1881 .Cm UseBlocklist
1882 alias can be used instead.
1883 .It Cm UseDNS
1884 Specifies whether
1885 .Xr sshd 8
1886 should look up the remote host name, and to check that
1887 the resolved host name for the remote IP address maps back to the
1888 very same IP address.
1889 .Pp
1890 If this option is set to
1891 .Cm no ,
1892 then only addresses and not host names may be used in
1893 .Pa ~/.ssh/authorized_keys
1894 .Cm from
1895 and
1896 .Nm
1897 .Cm Match
1898 .Cm Host
1899 directives.
1900 The default is
1901 .Dq yes .
1902 .It Cm UsePAM
1903 Enables the Pluggable Authentication Module interface.
1904 If set to
1905 .Cm yes
1906 this will enable PAM authentication using
1907 .Cm KbdInteractiveAuthentication
1908 and
1909 .Cm PasswordAuthentication
1910 in addition to PAM account and session module processing for all
1911 authentication types.
1912 .Pp
1913 Because PAM keyboard-interactive authentication usually serves an equivalent
1914 role to password authentication, you should disable either
1915 .Cm PasswordAuthentication
1916 or
1917 .Cm KbdInteractiveAuthentication .
1918 .Pp
1919 If
1920 .Cm UsePAM
1921 is enabled, you will not be able to run
1922 .Xr sshd 8
1923 as a non-root user.
1924 The default is
1925 .Cm yes .
1926 .It Cm VersionAddendum
1927 Optionally specifies additional text to append to the SSH protocol banner
1928 sent by the server upon connection.
1929 The default is
1930 .Qq FreeBSD-20230316 .
1931 The value
1932 .Cm none
1933 may be used to disable this.
1934 .It Cm X11DisplayOffset
1935 Specifies the first display number available for
1936 .Xr sshd 8 Ns 's
1937 X11 forwarding.
1938 This prevents sshd from interfering with real X11 servers.
1939 The default is 10.
1940 .It Cm X11Forwarding
1941 Specifies whether X11 forwarding is permitted.
1942 The argument must be
1943 .Cm yes
1944 or
1945 .Cm no .
1946 The default is
1947 .Cm no .
1948 .Pp
1949 When X11 forwarding is enabled, there may be additional exposure to
1950 the server and to client displays if the
1951 .Xr sshd 8
1952 proxy display is configured to listen on the wildcard address (see
1953 .Cm X11UseLocalhost ) ,
1954 though this is not the default.
1955 Additionally, the authentication spoofing and authentication data
1956 verification and substitution occur on the client side.
1957 The security risk of using X11 forwarding is that the client's X11
1958 display server may be exposed to attack when the SSH client requests
1959 forwarding (see the warnings for
1960 .Cm ForwardX11
1961 in
1962 .Xr ssh_config 5 ) .
1963 A system administrator may have a stance in which they want to
1964 protect clients that may expose themselves to attack by unwittingly
1965 requesting X11 forwarding, which can warrant a
1966 .Cm no
1967 setting.
1968 .Pp
1969 Note that disabling X11 forwarding does not prevent users from
1970 forwarding X11 traffic, as users can always install their own forwarders.
1971 .It Cm X11UseLocalhost
1972 Specifies whether
1973 .Xr sshd 8
1974 should bind the X11 forwarding server to the loopback address or to
1975 the wildcard address.
1976 By default,
1977 sshd binds the forwarding server to the loopback address and sets the
1978 hostname part of the
1979 .Ev DISPLAY
1980 environment variable to
1981 .Cm localhost .
1982 This prevents remote hosts from connecting to the proxy display.
1983 However, some older X11 clients may not function with this
1984 configuration.
1985 .Cm X11UseLocalhost
1986 may be set to
1987 .Cm no
1988 to specify that the forwarding server should be bound to the wildcard
1989 address.
1990 The argument must be
1991 .Cm yes
1992 or
1993 .Cm no .
1994 The default is
1995 .Cm yes .
1996 .It Cm XAuthLocation
1997 Specifies the full pathname of the
1998 .Xr xauth 1
1999 program, or
2000 .Cm none
2001 to not use one.
2002 The default is
2003 .Pa /usr/local/bin/xauth .
2004 .El
2005 .Sh TIME FORMATS
2006 .Xr sshd 8
2007 command-line arguments and configuration file options that specify time
2008 may be expressed using a sequence of the form:
2009 .Sm off
2010 .Ar time Op Ar qualifier ,
2011 .Sm on
2012 where
2013 .Ar time
2014 is a positive integer value and
2015 .Ar qualifier
2016 is one of the following:
2017 .Pp
2018 .Bl -tag -width Ds -compact -offset indent
2019 .It Aq Cm none
2020 seconds
2021 .It Cm s | Cm S
2022 seconds
2023 .It Cm m | Cm M
2024 minutes
2025 .It Cm h | Cm H
2026 hours
2027 .It Cm d | Cm D
2028 days
2029 .It Cm w | Cm W
2030 weeks
2031 .El
2032 .Pp
2033 Each member of the sequence is added together to calculate
2034 the total time value.
2035 .Pp
2036 Time format examples:
2037 .Pp
2038 .Bl -tag -width Ds -compact -offset indent
2039 .It 600
2040 600 seconds (10 minutes)
2041 .It 10m
2042 10 minutes
2043 .It 1h30m
2044 1 hour 30 minutes (90 minutes)
2045 .El
2046 .Sh TOKENS
2047 Arguments to some keywords can make use of tokens,
2048 which are expanded at runtime:
2049 .Pp
2050 .Bl -tag -width XXXX -offset indent -compact
2051 .It %%
2052 A literal
2053 .Sq % .
2054 .It \&%D
2055 The routing domain in which the incoming connection was received.
2056 .It %F
2057 The fingerprint of the CA key.
2058 .It %f
2059 The fingerprint of the key or certificate.
2060 .It %h
2061 The home directory of the user.
2062 .It %i
2063 The key ID in the certificate.
2064 .It %K
2065 The base64-encoded CA key.
2066 .It %k
2067 The base64-encoded key or certificate for authentication.
2068 .It %s
2069 The serial number of the certificate.
2070 .It \&%T
2071 The type of the CA key.
2072 .It %t
2073 The key or certificate type.
2074 .It \&%U
2075 The numeric user ID of the target user.
2076 .It %u
2077 The username.
2078 .El
2079 .Pp
2080 .Cm AuthorizedKeysCommand
2081 accepts the tokens %%, %f, %h, %k, %t, %U, and %u.
2082 .Pp
2083 .Cm AuthorizedKeysFile
2084 accepts the tokens %%, %h, %U, and %u.
2085 .Pp
2086 .Cm AuthorizedPrincipalsCommand
2087 accepts the tokens %%, %F, %f, %h, %i, %K, %k, %s, %T, %t, %U, and %u.
2088 .Pp
2089 .Cm AuthorizedPrincipalsFile
2090 accepts the tokens %%, %h, %U, and %u.
2091 .Pp
2092 .Cm ChrootDirectory
2093 accepts the tokens %%, %h, %U, and %u.
2094 .Pp
2095 .Cm RoutingDomain
2096 accepts the token %D.
2097 .Sh FILES
2098 .Bl -tag -width Ds
2099 .It Pa /etc/ssh/sshd_config
2100 Contains configuration data for
2101 .Xr sshd 8 .
2102 This file should be writable by root only, but it is recommended
2103 (though not necessary) that it be world-readable.
2104 .El
2105 .Sh SEE ALSO
2106 .Xr sftp-server 8 ,
2107 .Xr sshd 8
2108 .Sh AUTHORS
2109 .An -nosplit
2110 OpenSSH is a derivative of the original and free
2111 ssh 1.2.12 release by
2112 .An Tatu Ylonen .
2113 .An Aaron Campbell , Bob Beck , Markus Friedl , Niels Provos ,
2114 .An Theo de Raadt
2115 and
2116 .An Dug Song
2117 removed many bugs, re-added newer features and
2118 created OpenSSH.
2119 .An Markus Friedl
2120 contributed the support for SSH protocol versions 1.5 and 2.0.
2121 .An Niels Provos
2122 and
2123 .An Markus Friedl
2124 contributed support for privilege separation.