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