crypto/openssh/ssh_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: ssh_config.5,v 1.166 2013/06/27 14:05:37 jmc Exp $
  37 .\" $FreeBSD$
  38 .Dd June 27, 2013
  39 .Dt SSH_CONFIG 5
  40 .Os
  41 .Sh NAME
  42 .Nm ssh_config
  43 .Nd OpenSSH SSH client configuration files
  44 .Sh SYNOPSIS
  45 .Nm ~/.ssh/config
  46 .Nm /etc/ssh/ssh_config
  47 .Sh DESCRIPTION
  48 .Xr ssh 1
  49 obtains configuration data from the following sources in
  50 the following order:
  51 .Pp
  52 .Bl -enum -offset indent -compact
  53 .It
  54 command-line options
  55 .It
  56 user's configuration file
  57 .Pq Pa ~/.ssh/config
  58 .It
  59 system-wide configuration file
  60 .Pq Pa /etc/ssh/ssh_config
  61 .El
  62 .Pp
  63 For each parameter, the first obtained value
  64 will be used.
  65 The configuration files contain sections separated by
  66 .Dq Host
  67 specifications, and that section is only applied for hosts that
  68 match one of the patterns given in the specification.
  69 The matched host name is the one given on the command line.
  70 .Pp
  71 Since the first obtained value for each parameter is used, more
  72 host-specific declarations should be given near the beginning of the
  73 file, and general defaults at the end.
  74 .Pp
  75 The configuration file has the following format:
  76 .Pp
  77 Empty lines and lines starting with
  78 .Ql #
  79 are comments.
  80 Otherwise a line is of the format
  81 .Dq keyword arguments .
  82 Configuration options may be separated by whitespace or
  83 optional whitespace and exactly one
  84 .Ql = ;
  85 the latter format is useful to avoid the need to quote whitespace
  86 when specifying configuration options using the
  87 .Nm ssh ,
  88 .Nm scp ,
  89 and
  90 .Nm sftp
  91 .Fl o
  92 option.
  93 Arguments may optionally be enclosed in double quotes
  94 .Pq \&"
  95 in order to represent arguments containing spaces.
  96 .Pp
  97 The possible
  98 keywords and their meanings are as follows (note that
  99 keywords are case-insensitive and arguments are case-sensitive):
 100 .Bl -tag -width Ds
 101 .It Cm Host
 102 Restricts the following declarations (up to the next
 103 .Cm Host
 104 keyword) to be only for those hosts that match one of the patterns
 105 given after the keyword.
 106 If more than one pattern is provided, they should be separated by whitespace.
 107 A single
 108 .Ql *
 109 as a pattern can be used to provide global
 110 defaults for all hosts.
 111 The host is the
 112 .Ar hostname
 113 argument given on the command line (i.e. the name is not converted to
 114 a canonicalized host name before matching).
 115 .Pp
 116 A pattern entry may be negated by prefixing it with an exclamation mark
 117 .Pq Sq !\& .
 118 If a negated entry is matched, then the
 119 .Cm Host
 120 entry is ignored, regardless of whether any other patterns on the line
 121 match.
 122 Negated matches are therefore useful to provide exceptions for wildcard
 123 matches.
 124 .Pp
 125 See
 126 .Sx PATTERNS
 127 for more information on patterns.
 128 .It Cm AddressFamily
 129 Specifies which address family to use when connecting.
 130 Valid arguments are
 131 .Dq any ,
 132 .Dq inet
 133 (use IPv4 only), or
 134 .Dq inet6
 135 (use IPv6 only).
 136 .It Cm BatchMode
 137 If set to
 138 .Dq yes ,
 139 passphrase/password querying will be disabled.
 140 This option is useful in scripts and other batch jobs where no user
 141 is present to supply the password.
 142 The argument must be
 143 .Dq yes
 144 or
 145 .Dq no .
 146 The default is
 147 .Dq no .
 148 .It Cm BindAddress
 149 Use the specified address on the local machine as the source address of
 150 the connection.
 151 Only useful on systems with more than one address.
 152 Note that this option does not work if
 153 .Cm UsePrivilegedPort
 154 is set to
 155 .Dq yes .
 156 .It Cm ChallengeResponseAuthentication
 157 Specifies whether to use challenge-response authentication.
 158 The argument to this keyword must be
 159 .Dq yes
 160 or
 161 .Dq no .
 162 The default is
 163 .Dq yes .
 164 .It Cm CheckHostIP
 165 If this flag is set to
 166 .Dq yes ,
 167 .Xr ssh 1
 168 will additionally check the host IP address in the
 169 .Pa known_hosts
 170 file.
 171 This allows ssh to detect if a host key changed due to DNS spoofing.
 172 If the option is set to
 173 .Dq no ,
 174 the check will not be executed.
 175 The default is
 176 .Dq no .
 177 .It Cm Cipher
 178 Specifies the cipher to use for encrypting the session
 179 in protocol version 1.
 180 Currently,
 181 .Dq blowfish ,
 182 .Dq 3des ,
 183 and
 184 .Dq des
 185 are supported.
 186 .Ar des
 187 is only supported in the
 188 .Xr ssh 1
 189 client for interoperability with legacy protocol 1 implementations
 190 that do not support the
 191 .Ar 3des
 192 cipher.
 193 Its use is strongly discouraged due to cryptographic weaknesses.
 194 The default is
 195 .Dq 3des .
 196 .It Cm Ciphers
 197 Specifies the ciphers allowed for protocol version 2
 198 in order of preference.
 199 Multiple ciphers must be comma-separated.
 200 The supported ciphers are
 201 .Dq 3des-cbc ,
 202 .Dq aes128-cbc ,
 203 .Dq aes192-cbc ,
 204 .Dq aes256-cbc ,
 205 .Dq aes128-ctr ,
 206 .Dq aes192-ctr ,
 207 .Dq aes256-ctr ,
 208 .Dq aes128-gcm@openssh.com ,
 209 .Dq aes256-gcm@openssh.com ,
 210 .Dq arcfour128 ,
 211 .Dq arcfour256 ,
 212 .Dq arcfour ,
 213 .Dq blowfish-cbc ,
 214 and
 215 .Dq cast128-cbc .
 216 The default is:
 217 .Bd -literal -offset 3n
 218 aes128-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,
 219 aes128-gcm@openssh.com,aes256-gcm@openssh.com,
 220 aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,
 221 aes256-cbc,arcfour
 222 .Ed
 223 .It Cm ClearAllForwardings
 224 Specifies that all local, remote, and dynamic port forwardings
 225 specified in the configuration files or on the command line be
 226 cleared.
 227 This option is primarily useful when used from the
 228 .Xr ssh 1
 229 command line to clear port forwardings set in
 230 configuration files, and is automatically set by
 231 .Xr scp 1
 232 and
 233 .Xr sftp 1 .
 234 The argument must be
 235 .Dq yes
 236 or
 237 .Dq no .
 238 The default is
 239 .Dq no .
 240 .It Cm Compression
 241 Specifies whether to use compression.
 242 The argument must be
 243 .Dq yes
 244 or
 245 .Dq no .
 246 The default is
 247 .Dq no .
 248 .It Cm CompressionLevel
 249 Specifies the compression level to use if compression is enabled.
 250 The argument must be an integer from 1 (fast) to 9 (slow, best).
 251 The default level is 6, which is good for most applications.
 252 The meaning of the values is the same as in
 253 .Xr gzip 1 .
 254 Note that this option applies to protocol version 1 only.
 255 .It Cm ConnectionAttempts
 256 Specifies the number of tries (one per second) to make before exiting.
 257 The argument must be an integer.
 258 This may be useful in scripts if the connection sometimes fails.
 259 The default is 1.
 260 .It Cm ConnectTimeout
 261 Specifies the timeout (in seconds) used when connecting to the
 262 SSH server, instead of using the default system TCP timeout.
 263 This value is used only when the target is down or really unreachable,
 264 not when it refuses the connection.
 265 .It Cm ControlMaster
 266 Enables the sharing of multiple sessions over a single network connection.
 267 When set to
 268 .Dq yes ,
 269 .Xr ssh 1
 270 will listen for connections on a control socket specified using the
 271 .Cm ControlPath
 272 argument.
 273 Additional sessions can connect to this socket using the same
 274 .Cm ControlPath
 275 with
 276 .Cm ControlMaster
 277 set to
 278 .Dq no
 279 (the default).
 280 These sessions will try to reuse the master instance's network connection
 281 rather than initiating new ones, but will fall back to connecting normally
 282 if the control socket does not exist, or is not listening.
 283 .Pp
 284 Setting this to
 285 .Dq ask
 286 will cause ssh
 287 to listen for control connections, but require confirmation using the
 288 .Ev SSH_ASKPASS
 289 program before they are accepted (see
 290 .Xr ssh-add 1
 291 for details).
 292 If the
 293 .Cm ControlPath
 294 cannot be opened,
 295 ssh will continue without connecting to a master instance.
 296 .Pp
 297 X11 and
 298 .Xr ssh-agent 1
 299 forwarding is supported over these multiplexed connections, however the
 300 display and agent forwarded will be the one belonging to the master
 301 connection i.e. it is not possible to forward multiple displays or agents.
 302 .Pp
 303 Two additional options allow for opportunistic multiplexing: try to use a
 304 master connection but fall back to creating a new one if one does not already
 305 exist.
 306 These options are:
 307 .Dq auto
 308 and
 309 .Dq autoask .
 310 The latter requires confirmation like the
 311 .Dq ask
 312 option.
 313 .It Cm ControlPath
 314 Specify the path to the control socket used for connection sharing as described
 315 in the
 316 .Cm ControlMaster
 317 section above or the string
 318 .Dq none
 319 to disable connection sharing.
 320 In the path,
 321 .Ql %L
 322 will be substituted by the first component of the local host name,
 323 .Ql %l
 324 will be substituted by the local host name (including any domain name),
 325 .Ql %h
 326 will be substituted by the target host name,
 327 .Ql %n
 328 will be substituted by the original target host name
 329 specified on the command line,
 330 .Ql %p
 331 the port,
 332 .Ql %r
 333 by the remote login username, and
 334 .Ql %u
 335 by the username of the user running
 336 .Xr ssh 1 .
 337 It is recommended that any
 338 .Cm ControlPath
 339 used for opportunistic connection sharing include
 340 at least %h, %p, and %r.
 341 This ensures that shared connections are uniquely identified.
 342 .It Cm ControlPersist
 343 When used in conjunction with
 344 .Cm ControlMaster ,
 345 specifies that the master connection should remain open
 346 in the background (waiting for future client connections)
 347 after the initial client connection has been closed.
 348 If set to
 349 .Dq no ,
 350 then the master connection will not be placed into the background,
 351 and will close as soon as the initial client connection is closed.
 352 If set to
 353 .Dq yes ,
 354 then the master connection will remain in the background indefinitely
 355 (until killed or closed via a mechanism such as the
 356 .Xr ssh 1
 357 .Dq Fl O No exit
 358 option).
 359 If set to a time in seconds, or a time in any of the formats documented in
 360 .Xr sshd_config 5 ,
 361 then the backgrounded master connection will automatically terminate
 362 after it has remained idle (with no client connections) for the
 363 specified time.
 364 .It Cm DynamicForward
 365 Specifies that a TCP port on the local machine be forwarded
 366 over the secure channel, and the application
 367 protocol is then used to determine where to connect to from the
 368 remote machine.
 369 .Pp
 370 The argument must be
 371 .Sm off
 372 .Oo Ar bind_address : Oc Ar port .
 373 .Sm on
 374 IPv6 addresses can be specified by enclosing addresses in square brackets.
 375 By default, the local port is bound in accordance with the
 376 .Cm GatewayPorts
 377 setting.
 378 However, an explicit
 379 .Ar bind_address
 380 may be used to bind the connection to a specific address.
 381 The
 382 .Ar bind_address
 383 of
 384 .Dq localhost
 385 indicates that the listening port be bound for local use only, while an
 386 empty address or
 387 .Sq *
 388 indicates that the port should be available from all interfaces.
 389 .Pp
 390 Currently the SOCKS4 and SOCKS5 protocols are supported, and
 391 .Xr ssh 1
 392 will act as a SOCKS server.
 393 Multiple forwardings may be specified, and
 394 additional forwardings can be given on the command line.
 395 Only the superuser can forward privileged ports.
 396 .It Cm EnableSSHKeysign
 397 Setting this option to
 398 .Dq yes
 399 in the global client configuration file
 400 .Pa /etc/ssh/ssh_config
 401 enables the use of the helper program
 402 .Xr ssh-keysign 8
 403 during
 404 .Cm HostbasedAuthentication .
 405 The argument must be
 406 .Dq yes
 407 or
 408 .Dq no .
 409 The default is
 410 .Dq no .
 411 This option should be placed in the non-hostspecific section.
 412 See
 413 .Xr ssh-keysign 8
 414 for more information.
 415 .It Cm EscapeChar
 416 Sets the escape character (default:
 417 .Ql ~ ) .
 418 The escape character can also
 419 be set on the command line.
 420 The argument should be a single character,
 421 .Ql ^
 422 followed by a letter, or
 423 .Dq none
 424 to disable the escape
 425 character entirely (making the connection transparent for binary
 426 data).
 427 .It Cm ExitOnForwardFailure
 428 Specifies whether
 429 .Xr ssh 1
 430 should terminate the connection if it cannot set up all requested
 431 dynamic, tunnel, local, and remote port forwardings.
 432 The argument must be
 433 .Dq yes
 434 or
 435 .Dq no .
 436 The default is
 437 .Dq no .
 438 .It Cm ForwardAgent
 439 Specifies whether the connection to the authentication agent (if any)
 440 will be forwarded to the remote machine.
 441 The argument must be
 442 .Dq yes
 443 or
 444 .Dq no .
 445 The default is
 446 .Dq no .
 447 .Pp
 448 Agent forwarding should be enabled with caution.
 449 Users with the ability to bypass file permissions on the remote host
 450 (for the agent's Unix-domain socket)
 451 can access the local agent through the forwarded connection.
 452 An attacker cannot obtain key material from the agent,
 453 however they can perform operations on the keys that enable them to
 454 authenticate using the identities loaded into the agent.
 455 .It Cm ForwardX11
 456 Specifies whether X11 connections will be automatically redirected
 457 over the secure channel and
 458 .Ev DISPLAY
 459 set.
 460 The argument must be
 461 .Dq yes
 462 or
 463 .Dq no .
 464 The default is
 465 .Dq no .
 466 .Pp
 467 X11 forwarding should be enabled with caution.
 468 Users with the ability to bypass file permissions on the remote host
 469 (for the user's X11 authorization database)
 470 can access the local X11 display through the forwarded connection.
 471 An attacker may then be able to perform activities such as keystroke monitoring
 472 if the
 473 .Cm ForwardX11Trusted
 474 option is also enabled.
 475 .It Cm ForwardX11Timeout
 476 Specify a timeout for untrusted X11 forwarding
 477 using the format described in the
 478 TIME FORMATS section of
 479 .Xr sshd_config 5 .
 480 X11 connections received by
 481 .Xr ssh 1
 482 after this time will be refused.
 483 The default is to disable untrusted X11 forwarding after twenty minutes has
 484 elapsed.
 485 .It Cm ForwardX11Trusted
 486 If this option is set to
 487 .Dq yes ,
 488 remote X11 clients will have full access to the original X11 display.
 489 .Pp
 490 If this option is set to
 491 .Dq no ,
 492 remote X11 clients will be considered untrusted and prevented
 493 from stealing or tampering with data belonging to trusted X11
 494 clients.
 495 Furthermore, the
 496 .Xr xauth 1
 497 token used for the session will be set to expire after 20 minutes.
 498 Remote clients will be refused access after this time.
 499 .Pp
 500 The default is
 501 .Dq no .
 502 .Pp
 503 See the X11 SECURITY extension specification for full details on
 504 the restrictions imposed on untrusted clients.
 505 .It Cm GatewayPorts
 506 Specifies whether remote hosts are allowed to connect to local
 507 forwarded ports.
 508 By default,
 509 .Xr ssh 1
 510 binds local port forwardings to the loopback address.
 511 This prevents other remote hosts from connecting to forwarded ports.
 512 .Cm GatewayPorts
 513 can be used to specify that ssh
 514 should bind local port forwardings to the wildcard address,
 515 thus allowing remote hosts to connect to forwarded ports.
 516 The argument must be
 517 .Dq yes
 518 or
 519 .Dq no .
 520 The default is
 521 .Dq no .
 522 .It Cm GlobalKnownHostsFile
 523 Specifies one or more files to use for the global
 524 host key database, separated by whitespace.
 525 The default is
 526 .Pa /etc/ssh/ssh_known_hosts ,
 527 .Pa /etc/ssh/ssh_known_hosts2 .
 528 .It Cm GSSAPIAuthentication
 529 Specifies whether user authentication based on GSSAPI is allowed.
 530 The default is
 531 .Dq no .
 532 Note that this option applies to protocol version 2 only.
 533 .It Cm GSSAPIDelegateCredentials
 534 Forward (delegate) credentials to the server.
 535 The default is
 536 .Dq no .
 537 Note that this option applies to protocol version 2 only.
 538 .It Cm HashKnownHosts
 539 Indicates that
 540 .Xr ssh 1
 541 should hash host names and addresses when they are added to
 542 .Pa ~/.ssh/known_hosts .
 543 These hashed names may be used normally by
 544 .Xr ssh 1
 545 and
 546 .Xr sshd 8 ,
 547 but they do not reveal identifying information should the file's contents
 548 be disclosed.
 549 The default is
 550 .Dq no .
 551 Note that existing names and addresses in known hosts files
 552 will not be converted automatically,
 553 but may be manually hashed using
 554 .Xr ssh-keygen 1 .
 555 .It Cm HostbasedAuthentication
 556 Specifies whether to try rhosts based authentication with public key
 557 authentication.
 558 The argument must be
 559 .Dq yes
 560 or
 561 .Dq no .
 562 The default is
 563 .Dq no .
 564 This option applies to protocol version 2 only and
 565 is similar to
 566 .Cm RhostsRSAAuthentication .
 567 .It Cm HostKeyAlgorithms
 568 Specifies the protocol version 2 host key algorithms
 569 that the client wants to use in order of preference.
 570 The default for this option is:
 571 .Bd -literal -offset 3n
 572 ecdsa-sha2-nistp256-cert-v01@openssh.com,
 573 ecdsa-sha2-nistp384-cert-v01@openssh.com,
 574 ecdsa-sha2-nistp521-cert-v01@openssh.com,
 575 ssh-rsa-cert-v01@openssh.com,ssh-dss-cert-v01@openssh.com,
 576 ssh-rsa-cert-v00@openssh.com,ssh-dss-cert-v00@openssh.com,
 577 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
 578 ssh-rsa,ssh-dss
 579 .Ed
 580 .Pp
 581 If hostkeys are known for the destination host then this default is modified
 582 to prefer their algorithms.
 583 .It Cm HostKeyAlias
 584 Specifies an alias that should be used instead of the
 585 real host name when looking up or saving the host key
 586 in the host key database files.
 587 This option is useful for tunneling SSH connections
 588 or for multiple servers running on a single host.
 589 .It Cm HostName
 590 Specifies the real host name to log into.
 591 This can be used to specify nicknames or abbreviations for hosts.
 592 If the hostname contains the character sequence
 593 .Ql %h ,
 594 then this will be replaced with the host name specified on the command line
 595 (this is useful for manipulating unqualified names).
 596 The default is the name given on the command line.
 597 Numeric IP addresses are also permitted (both on the command line and in
 598 .Cm HostName
 599 specifications).
 600 .It Cm IdentitiesOnly
 601 Specifies that
 602 .Xr ssh 1
 603 should only use the authentication identity files configured in the
 604 .Nm
 605 files,
 606 even if
 607 .Xr ssh-agent 1
 608 or a
 609 .Cm PKCS11Provider
 610 offers more identities.
 611 The argument to this keyword must be
 612 .Dq yes
 613 or
 614 .Dq no .
 615 This option is intended for situations where ssh-agent
 616 offers many different identities.
 617 The default is
 618 .Dq no .
 619 .It Cm IdentityFile
 620 Specifies a file from which the user's DSA, ECDSA or RSA authentication
 621 identity is read.
 622 The default is
 623 .Pa ~/.ssh/identity
 624 for protocol version 1, and
 625 .Pa ~/.ssh/id_dsa ,
 626 .Pa ~/.ssh/id_ecdsa
 627 and
 628 .Pa ~/.ssh/id_rsa
 629 for protocol version 2.
 630 Additionally, any identities represented by the authentication agent
 631 will be used for authentication unless
 632 .Cm IdentitiesOnly
 633 is set.
 634 .Xr ssh 1
 635 will try to load certificate information from the filename obtained by
 636 appending
 637 .Pa -cert.pub
 638 to the path of a specified
 639 .Cm IdentityFile .
 640 .Pp
 641 The file name may use the tilde
 642 syntax to refer to a user's home directory or one of the following
 643 escape characters:
 644 .Ql %d
 645 (local user's home directory),
 646 .Ql %u
 647 (local user name),
 648 .Ql %l
 649 (local host name),
 650 .Ql %h
 651 (remote host name) or
 652 .Ql %r
 653 (remote user name).
 654 .Pp
 655 It is possible to have
 656 multiple identity files specified in configuration files; all these
 657 identities will be tried in sequence.
 658 Multiple
 659 .Cm IdentityFile
 660 directives will add to the list of identities tried (this behaviour
 661 differs from that of other configuration directives).
 662 .Pp
 663 .Cm IdentityFile
 664 may be used in conjunction with
 665 .Cm IdentitiesOnly
 666 to select which identities in an agent are offered during authentication.
 667 .It Cm IgnoreUnknown
 668 Specifies a pattern-list of unknown options to be ignored if they are
 669 encountered in configuration parsing.
 670 This may be used to suppress errors if
 671 .Nm
 672 contains options that are unrecognised by
 673 .Xr ssh 1 .
 674 It is recommended that
 675 .Cm IgnoreUnknown
 676 be listed early in the configuration file as it will not be applied
 677 to unknown options that appear before it.
 678 .It Cm IPQoS
 679 Specifies the IPv4 type-of-service or DSCP class for connections.
 680 Accepted values are
 681 .Dq af11 ,
 682 .Dq af12 ,
 683 .Dq af13 ,
 684 .Dq af21 ,
 685 .Dq af22 ,
 686 .Dq af23 ,
 687 .Dq af31 ,
 688 .Dq af32 ,
 689 .Dq af33 ,
 690 .Dq af41 ,
 691 .Dq af42 ,
 692 .Dq af43 ,
 693 .Dq cs0 ,
 694 .Dq cs1 ,
 695 .Dq cs2 ,
 696 .Dq cs3 ,
 697 .Dq cs4 ,
 698 .Dq cs5 ,
 699 .Dq cs6 ,
 700 .Dq cs7 ,
 701 .Dq ef ,
 702 .Dq lowdelay ,
 703 .Dq throughput ,
 704 .Dq reliability ,
 705 or a numeric value.
 706 This option may take one or two arguments, separated by whitespace.
 707 If one argument is specified, it is used as the packet class unconditionally.
 708 If two values are specified, the first is automatically selected for
 709 interactive sessions and the second for non-interactive sessions.
 710 The default is
 711 .Dq lowdelay
 712 for interactive sessions and
 713 .Dq throughput
 714 for non-interactive sessions.
 715 .It Cm KbdInteractiveAuthentication
 716 Specifies whether to use keyboard-interactive authentication.
 717 The argument to this keyword must be
 718 .Dq yes
 719 or
 720 .Dq no .
 721 The default is
 722 .Dq yes .
 723 .It Cm KbdInteractiveDevices
 724 Specifies the list of methods to use in keyboard-interactive authentication.
 725 Multiple method names must be comma-separated.
 726 The default is to use the server specified list.
 727 The methods available vary depending on what the server supports.
 728 For an OpenSSH server,
 729 it may be zero or more of:
 730 .Dq bsdauth ,
 731 .Dq pam ,
 732 and
 733 .Dq skey .
 734 .It Cm KexAlgorithms
 735 Specifies the available KEX (Key Exchange) algorithms.
 736 Multiple algorithms must be comma-separated.
 737 The default is:
 738 .Bd -literal -offset indent
 739 ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
 740 diffie-hellman-group-exchange-sha256,
 741 diffie-hellman-group-exchange-sha1,
 742 diffie-hellman-group14-sha1,
 743 diffie-hellman-group1-sha1
 744 .Ed
 745 .It Cm LocalCommand
 746 Specifies a command to execute on the local machine after successfully
 747 connecting to the server.
 748 The command string extends to the end of the line, and is executed with
 749 the user's shell.
 750 The following escape character substitutions will be performed:
 751 .Ql %d
 752 (local user's home directory),
 753 .Ql %h
 754 (remote host name),
 755 .Ql %l
 756 (local host name),
 757 .Ql %n
 758 (host name as provided on the command line),
 759 .Ql %p
 760 (remote port),
 761 .Ql %r
 762 (remote user name) or
 763 .Ql %u
 764 (local user name).
 765 .Pp
 766 The command is run synchronously and does not have access to the
 767 session of the
 768 .Xr ssh 1
 769 that spawned it.
 770 It should not be used for interactive commands.
 771 .Pp
 772 This directive is ignored unless
 773 .Cm PermitLocalCommand
 774 has been enabled.
 775 .It Cm LocalForward
 776 Specifies that a TCP port on the local machine be forwarded over
 777 the secure channel to the specified host and port from the remote machine.
 778 The first argument must be
 779 .Sm off
 780 .Oo Ar bind_address : Oc Ar port
 781 .Sm on
 782 and the second argument must be
 783 .Ar host : Ns Ar hostport .
 784 IPv6 addresses can be specified by enclosing addresses in square brackets.
 785 Multiple forwardings may be specified, and additional forwardings can be
 786 given on the command line.
 787 Only the superuser can forward privileged ports.
 788 By default, the local port is bound in accordance with the
 789 .Cm GatewayPorts
 790 setting.
 791 However, an explicit
 792 .Ar bind_address
 793 may be used to bind the connection to a specific address.
 794 The
 795 .Ar bind_address
 796 of
 797 .Dq localhost
 798 indicates that the listening port be bound for local use only, while an
 799 empty address or
 800 .Sq *
 801 indicates that the port should be available from all interfaces.
 802 .It Cm LogLevel
 803 Gives the verbosity level that is used when logging messages from
 804 .Xr ssh 1 .
 805 The possible values are:
 806 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
 807 The default is INFO.
 808 DEBUG and DEBUG1 are equivalent.
 809 DEBUG2 and DEBUG3 each specify higher levels of verbose output.
 810 .It Cm MACs
 811 Specifies the MAC (message authentication code) algorithms
 812 in order of preference.
 813 The MAC algorithm is used in protocol version 2
 814 for data integrity protection.
 815 Multiple algorithms must be comma-separated.
 816 The algorithms that contain
 817 .Dq -etm
 818 calculate the MAC after encryption (encrypt-then-mac).
 819 These are considered safer and their use recommended.
 820 The default is:
 821 .Bd -literal -offset indent
 822 hmac-md5-etm@openssh.com,hmac-sha1-etm@openssh.com,
 823 umac-64-etm@openssh.com,umac-128-etm@openssh.com,
 824 hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
 825 hmac-ripemd160-etm@openssh.com,hmac-sha1-96-etm@openssh.com,
 826 hmac-md5-96-etm@openssh.com,
 827 hmac-md5,hmac-sha1,umac-64@openssh.com,umac-128@openssh.com,
 828 hmac-sha2-256,hmac-sha2-512,hmac-ripemd160,
 829 hmac-sha1-96,hmac-md5-96
 830 .Ed
 831 .It Cm NoHostAuthenticationForLocalhost
 832 This option can be used if the home directory is shared across machines.
 833 In this case localhost will refer to a different machine on each of
 834 the machines and the user will get many warnings about changed host keys.
 835 However, this option disables host authentication for localhost.
 836 The argument to this keyword must be
 837 .Dq yes
 838 or
 839 .Dq no .
 840 The default is to check the host key for localhost.
 841 .It Cm NumberOfPasswordPrompts
 842 Specifies the number of password prompts before giving up.
 843 The argument to this keyword must be an integer.
 844 The default is 3.
 845 .It Cm PasswordAuthentication
 846 Specifies whether to use password authentication.
 847 The argument to this keyword must be
 848 .Dq yes
 849 or
 850 .Dq no .
 851 The default is
 852 .Dq yes .
 853 .It Cm PermitLocalCommand
 854 Allow local command execution via the
 855 .Ic LocalCommand
 856 option or using the
 857 .Ic !\& Ns Ar command
 858 escape sequence in
 859 .Xr ssh 1 .
 860 The argument must be
 861 .Dq yes
 862 or
 863 .Dq no .
 864 The default is
 865 .Dq no .
 866 .It Cm PKCS11Provider
 867 Specifies which PKCS#11 provider to use.
 868 The argument to this keyword is the PKCS#11 shared library
 869 .Xr ssh 1
 870 should use to communicate with a PKCS#11 token providing the user's
 871 private RSA key.
 872 .It Cm Port
 873 Specifies the port number to connect on the remote host.
 874 The default is 22.
 875 .It Cm PreferredAuthentications
 876 Specifies the order in which the client should try protocol 2
 877 authentication methods.
 878 This allows a client to prefer one method (e.g.\&
 879 .Cm keyboard-interactive )
 880 over another method (e.g.\&
 881 .Cm password ) .
 882 The default is:
 883 .Bd -literal -offset indent
 884 gssapi-with-mic,hostbased,publickey,
 885 keyboard-interactive,password
 886 .Ed
 887 .It Cm Protocol
 888 Specifies the protocol versions
 889 .Xr ssh 1
 890 should support in order of preference.
 891 The possible values are
 892 .Sq 1
 893 and
 894 .Sq 2 .
 895 Multiple versions must be comma-separated.
 896 When this option is set to
 897 .Dq 2,1
 898 .Nm ssh
 899 will try version 2 and fall back to version 1
 900 if version 2 is not available.
 901 The default is
 902 .Sq 2 .
 903 .It Cm ProxyCommand
 904 Specifies the command to use to connect to the server.
 905 The command
 906 string extends to the end of the line, and is executed with
 907 the user's shell.
 908 In the command string, any occurrence of
 909 .Ql %h
 910 will be substituted by the host name to
 911 connect,
 912 .Ql %p
 913 by the port, and
 914 .Ql %r
 915 by the remote user name.
 916 The command can be basically anything,
 917 and should read from its standard input and write to its standard output.
 918 It should eventually connect an
 919 .Xr sshd 8
 920 server running on some machine, or execute
 921 .Ic sshd -i
 922 somewhere.
 923 Host key management will be done using the
 924 HostName of the host being connected (defaulting to the name typed by
 925 the user).
 926 Setting the command to
 927 .Dq none
 928 disables this option entirely.
 929 Note that
 930 .Cm CheckHostIP
 931 is not available for connects with a proxy command.
 932 .Pp
 933 This directive is useful in conjunction with
 934 .Xr nc 1
 935 and its proxy support.
 936 For example, the following directive would connect via an HTTP proxy at
 937 192.0.2.0:
 938 .Bd -literal -offset 3n
 939 ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
 940 .Ed
 941 .It Cm PubkeyAuthentication
 942 Specifies whether to try public key authentication.
 943 The argument to this keyword must be
 944 .Dq yes
 945 or
 946 .Dq no .
 947 The default is
 948 .Dq yes .
 949 This option applies to protocol version 2 only.
 950 .It Cm RekeyLimit
 951 Specifies the maximum amount of data that may be transmitted before the
 952 session key is renegotiated, optionally followed a maximum amount of
 953 time that may pass before the session key is renegotiated.
 954 The first argument is specified in bytes and may have a suffix of
 955 .Sq K ,
 956 .Sq M ,
 957 or
 958 .Sq G
 959 to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
 960 The default is between
 961 .Sq 1G
 962 and
 963 .Sq 4G ,
 964 depending on the cipher.
 965 The optional second value is specified in seconds and may use any of the
 966 units documented in the
 967 TIME FORMATS section of
 968 .Xr sshd_config 5 .
 969 The default value for
 970 .Cm RekeyLimit
 971 is
 972 .Dq default none ,
 973 which means that rekeying is performed after the cipher's default amount
 974 of data has been sent or received and no time based rekeying is done.
 975 This option applies to protocol version 2 only.
 976 .It Cm RemoteForward
 977 Specifies that a TCP port on the remote machine be forwarded over
 978 the secure channel to the specified host and port from the local machine.
 979 The first argument must be
 980 .Sm off
 981 .Oo Ar bind_address : Oc Ar port
 982 .Sm on
 983 and the second argument must be
 984 .Ar host : Ns Ar hostport .
 985 IPv6 addresses can be specified by enclosing addresses in square brackets.
 986 Multiple forwardings may be specified, and additional
 987 forwardings can be given on the command line.
 988 Privileged ports can be forwarded only when
 989 logging in as root on the remote machine.
 990 .Pp
 991 If the
 992 .Ar port
 993 argument is
 994 .Ql 0 ,
 995 the listen port will be dynamically allocated on the server and reported
 996 to the client at run time.
 997 .Pp
 998 If the
 999 .Ar bind_address
1000 is not specified, the default is to only bind to loopback addresses.
1001 If the
1002 .Ar bind_address
1003 is
1004 .Ql *
1005 or an empty string, then the forwarding is requested to listen on all
1006 interfaces.
1007 Specifying a remote
1008 .Ar bind_address
1009 will only succeed if the server's
1010 .Cm GatewayPorts
1011 option is enabled (see
1012 .Xr sshd_config 5 ) .
1013 .It Cm RequestTTY
1014 Specifies whether to request a pseudo-tty for the session.
1015 The argument may be one of:
1016 .Dq no
1017 (never request a TTY),
1018 .Dq yes
1019 (always request a TTY when standard input is a TTY),
1020 .Dq force
1021 (always request a TTY) or
1022 .Dq auto
1023 (request a TTY when opening a login session).
1024 This option mirrors the
1025 .Fl t
1026 and
1027 .Fl T
1028 flags for
1029 .Xr ssh 1 .
1030 .It Cm RhostsRSAAuthentication
1031 Specifies whether to try rhosts based authentication with RSA host
1032 authentication.
1033 The argument must be
1034 .Dq yes
1035 or
1036 .Dq no .
1037 The default is
1038 .Dq no .
1039 This option applies to protocol version 1 only and requires
1040 .Xr ssh 1
1041 to be setuid root.
1042 .It Cm RSAAuthentication
1043 Specifies whether to try RSA authentication.
1044 The argument to this keyword must be
1045 .Dq yes
1046 or
1047 .Dq no .
1048 RSA authentication will only be
1049 attempted if the identity file exists, or an authentication agent is
1050 running.
1051 The default is
1052 .Dq yes .
1053 Note that this option applies to protocol version 1 only.
1054 .It Cm SendEnv
1055 Specifies what variables from the local
1056 .Xr environ 7
1057 should be sent to the server.
1058 Note that environment passing is only supported for protocol 2.
1059 The server must also support it, and the server must be configured to
1060 accept these environment variables.
1061 Refer to
1062 .Cm AcceptEnv
1063 in
1064 .Xr sshd_config 5
1065 for how to configure the server.
1066 Variables are specified by name, which may contain wildcard characters.
1067 Multiple environment variables may be separated by whitespace or spread
1068 across multiple
1069 .Cm SendEnv
1070 directives.
1071 The default is not to send any environment variables.
1072 .Pp
1073 See
1074 .Sx PATTERNS
1075 for more information on patterns.
1076 .It Cm ServerAliveCountMax
1077 Sets the number of server alive messages (see below) which may be
1078 sent without
1079 .Xr ssh 1
1080 receiving any messages back from the server.
1081 If this threshold is reached while server alive messages are being sent,
1082 ssh will disconnect from the server, terminating the session.
1083 It is important to note that the use of server alive messages is very
1084 different from
1085 .Cm TCPKeepAlive
1086 (below).
1087 The server alive messages are sent through the encrypted channel
1088 and therefore will not be spoofable.
1089 The TCP keepalive option enabled by
1090 .Cm TCPKeepAlive
1091 is spoofable.
1092 The server alive mechanism is valuable when the client or
1093 server depend on knowing when a connection has become inactive.
1094 .Pp
1095 The default value is 3.
1096 If, for example,
1097 .Cm ServerAliveInterval
1098 (see below) is set to 15 and
1099 .Cm ServerAliveCountMax
1100 is left at the default, if the server becomes unresponsive,
1101 ssh will disconnect after approximately 45 seconds.
1102 This option applies to protocol version 2 only.
1103 .It Cm ServerAliveInterval
1104 Sets a timeout interval in seconds after which if no data has been received
1105 from the server,
1106 .Xr ssh 1
1107 will send a message through the encrypted
1108 channel to request a response from the server.
1109 The default
1110 is 0, indicating that these messages will not be sent to the server.
1111 This option applies to protocol version 2 only.
1112 .It Cm StrictHostKeyChecking
1113 If this flag is set to
1114 .Dq yes ,
1115 .Xr ssh 1
1116 will never automatically add host keys to the
1117 .Pa ~/.ssh/known_hosts
1118 file, and refuses to connect to hosts whose host key has changed.
1119 This provides maximum protection against trojan horse attacks,
1120 though it can be annoying when the
1121 .Pa /etc/ssh/ssh_known_hosts
1122 file is poorly maintained or when connections to new hosts are
1123 frequently made.
1124 This option forces the user to manually
1125 add all new hosts.
1126 If this flag is set to
1127 .Dq no ,
1128 ssh will automatically add new host keys to the
1129 user known hosts files.
1130 If this flag is set to
1131 .Dq ask ,
1132 new host keys
1133 will be added to the user known host files only after the user
1134 has confirmed that is what they really want to do, and
1135 ssh will refuse to connect to hosts whose host key has changed.
1136 The host keys of
1137 known hosts will be verified automatically in all cases.
1138 The argument must be
1139 .Dq yes ,
1140 .Dq no ,
1141 or
1142 .Dq ask .
1143 The default is
1144 .Dq ask .
1145 .It Cm TCPKeepAlive
1146 Specifies whether the system should send TCP keepalive messages to the
1147 other side.
1148 If they are sent, death of the connection or crash of one
1149 of the machines will be properly noticed.
1150 However, this means that
1151 connections will die if the route is down temporarily, and some people
1152 find it annoying.
1153 .Pp
1154 The default is
1155 .Dq yes
1156 (to send TCP keepalive messages), and the client will notice
1157 if the network goes down or the remote host dies.
1158 This is important in scripts, and many users want it too.
1159 .Pp
1160 To disable TCP keepalive messages, the value should be set to
1161 .Dq no .
1162 .It Cm Tunnel
1163 Request
1164 .Xr tun 4
1165 device forwarding between the client and the server.
1166 The argument must be
1167 .Dq yes ,
1168 .Dq point-to-point
1169 (layer 3),
1170 .Dq ethernet
1171 (layer 2),
1172 or
1173 .Dq no .
1174 Specifying
1175 .Dq yes
1176 requests the default tunnel mode, which is
1177 .Dq point-to-point .
1178 The default is
1179 .Dq no .
1180 .It Cm TunnelDevice
1181 Specifies the
1182 .Xr tun 4
1183 devices to open on the client
1184 .Pq Ar local_tun
1185 and the server
1186 .Pq Ar remote_tun .
1187 .Pp
1188 The argument must be
1189 .Sm off
1190 .Ar local_tun Op : Ar remote_tun .
1191 .Sm on
1192 The devices may be specified by numerical ID or the keyword
1193 .Dq any ,
1194 which uses the next available tunnel device.
1195 If
1196 .Ar remote_tun
1197 is not specified, it defaults to
1198 .Dq any .
1199 The default is
1200 .Dq any:any .
1201 .It Cm UsePrivilegedPort
1202 Specifies whether to use a privileged port for outgoing connections.
1203 The argument must be
1204 .Dq yes
1205 or
1206 .Dq no .
1207 The default is
1208 .Dq no .
1209 If set to
1210 .Dq yes ,
1211 .Xr ssh 1
1212 must be setuid root.
1213 Note that this option must be set to
1214 .Dq yes
1215 for
1216 .Cm RhostsRSAAuthentication
1217 with older servers.
1218 .It Cm User
1219 Specifies the user to log in as.
1220 This can be useful when a different user name is used on different machines.
1221 This saves the trouble of
1222 having to remember to give the user name on the command line.
1223 .It Cm UserKnownHostsFile
1224 Specifies one or more files to use for the user
1225 host key database, separated by whitespace.
1226 The default is
1227 .Pa ~/.ssh/known_hosts ,
1228 .Pa ~/.ssh/known_hosts2 .
1229 .It Cm VerifyHostKeyDNS
1230 Specifies whether to verify the remote key using DNS and SSHFP resource
1231 records.
1232 If this option is set to
1233 .Dq yes ,
1234 the client will implicitly trust keys that match a secure fingerprint
1235 from DNS.
1236 Insecure fingerprints will be handled as if this option was set to
1237 .Dq ask .
1238 If this option is set to
1239 .Dq ask ,
1240 information on fingerprint match will be displayed, but the user will still
1241 need to confirm new host keys according to the
1242 .Cm StrictHostKeyChecking
1243 option.
1244 The argument must be
1245 .Dq yes ,
1246 .Dq no ,
1247 or
1248 .Dq ask .
1249 The default is
1250 .Dq yes
1251 if compiled with LDNS and
1252 .Dq no
1253 otherwise.
1254 Note that this option applies to protocol version 2 only.
1255 .Pp
1256 See also VERIFYING HOST KEYS in
1257 .Xr ssh 1 .
1258 .It Cm VersionAddendum
1259 Specifies a string to append to the regular version string to identify
1260 OS- or site-specific modifications.
1261 The default is
1262 .Dq FreeBSD-20131111 .
1263 .It Cm VisualHostKey
1264 If this flag is set to
1265 .Dq yes ,
1266 an ASCII art representation of the remote host key fingerprint is
1267 printed in addition to the hex fingerprint string at login and
1268 for unknown host keys.
1269 If this flag is set to
1270 .Dq no ,
1271 no fingerprint strings are printed at login and
1272 only the hex fingerprint string will be printed for unknown host keys.
1273 The default is
1274 .Dq no .
1275 .It Cm XAuthLocation
1276 Specifies the full pathname of the
1277 .Xr xauth 1
1278 program.
1279 The default is
1280 .Pa /usr/local/bin/xauth .
1281 .El
1282 .Sh PATTERNS
1283 A
1284 .Em pattern
1285 consists of zero or more non-whitespace characters,
1286 .Sq *
1287 (a wildcard that matches zero or more characters),
1288 or
1289 .Sq ?\&
1290 (a wildcard that matches exactly one character).
1291 For example, to specify a set of declarations for any host in the
1292 .Dq .co.uk
1293 set of domains,
1294 the following pattern could be used:
1295 .Pp
1296 .Dl Host *.co.uk
1297 .Pp
1298 The following pattern
1299 would match any host in the 192.168.0.[0-9] network range:
1300 .Pp
1301 .Dl Host 192.168.0.?
1302 .Pp
1303 A
1304 .Em pattern-list
1305 is a comma-separated list of patterns.
1306 Patterns within pattern-lists may be negated
1307 by preceding them with an exclamation mark
1308 .Pq Sq !\& .
1309 For example,
1310 to allow a key to be used from anywhere within an organisation
1311 except from the
1312 .Dq dialup
1313 pool,
1314 the following entry (in authorized_keys) could be used:
1315 .Pp
1316 .Dl from=\&"!*.dialup.example.com,*.example.com\&"
1317 .Sh FILES
1318 .Bl -tag -width Ds
1319 .It Pa ~/.ssh/config
1320 This is the per-user configuration file.
1321 The format of this file is described above.
1322 This file is used by the SSH client.
1323 Because of the potential for abuse, this file must have strict permissions:
1324 read/write for the user, and not accessible by others.
1325 .It Pa /etc/ssh/ssh_config
1326 Systemwide configuration file.
1327 This file provides defaults for those
1328 values that are not specified in the user's configuration file, and
1329 for those users who do not have a configuration file.
1330 This file must be world-readable.
1331 .El
1332 .Sh SEE ALSO
1333 .Xr ssh 1
1334 .Sh AUTHORS
1335 OpenSSH is a derivative of the original and free
1336 ssh 1.2.12 release by Tatu Ylonen.
1337 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1338 Theo de Raadt and Dug Song
1339 removed many bugs, re-added newer features and
1340 created OpenSSH.
1341 Markus Friedl contributed the support for SSH
1342 protocol versions 1.5 and 2.0.