ssh_config.5

   1 .\"  -*- nroff -*-
   2 .\"
   3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   5 .\"                    All rights reserved
   6 .\"
   7 .\" As far as I am concerned, the code I have written for this software
   8 .\" can be used freely for any purpose.  Any derived versions of this
   9 .\" software must be clearly marked as such, and if the derived work is
  10 .\" incompatible with the protocol description in the RFC file, it must be
  11 .\" called by a name other than "ssh" or "Secure Shell".
  12 .\"
  13 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
  14 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
  15 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
  16 .\"
  17 .\" Redistribution and use in source and binary forms, with or without
  18 .\" modification, are permitted provided that the following conditions
  19 .\" are met:
  20 .\" 1. Redistributions of source code must retain the above copyright
  21 .\"    notice, this list of conditions and the following disclaimer.
  22 .\" 2. Redistributions in binary form must reproduce the above copyright
  23 .\"    notice, this list of conditions and the following disclaimer in the
  24 .\"    documentation and/or other materials provided with the distribution.
  25 .\"
  26 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  27 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  28 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  30 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  35 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .\" $OpenBSD: ssh_config.5,v 1.108 2008/06/11 23:03:56 grunk Exp $
  38 .Dd $Mdocdate: June 11 2008 $
  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 whitepsace.
 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 fingerprint ,
 165 not only the host IP address will be checked, but also a fingerprint
 166 along with an ASCII art
 167 representation of the key will be printed.
 168 If the option is set to
 169 .Dq no ,
 170 the check will not be executed.
 171 The default is
 172 .Dq yes .
 173 .It Cm Cipher
 174 Specifies the cipher to use for encrypting the session
 175 in protocol version 1.
 176 Currently,
 177 .Dq blowfish ,
 178 .Dq 3des ,
 179 and
 180 .Dq des
 181 are supported.
 182 .Ar des
 183 is only supported in the
 184 .Xr ssh 1
 185 client for interoperability with legacy protocol 1 implementations
 186 that do not support the
 187 .Ar 3des
 188 cipher.
 189 Its use is strongly discouraged due to cryptographic weaknesses.
 190 The default is
 191 .Dq 3des .
 192 .It Cm Ciphers
 193 Specifies the ciphers allowed for protocol version 2
 194 in order of preference.
 195 Multiple ciphers must be comma-separated.
 196 The supported ciphers are
 197 .Dq 3des-cbc ,
 198 .Dq aes128-cbc ,
 199 .Dq aes192-cbc ,
 200 .Dq aes256-cbc ,
 201 .Dq aes128-ctr ,
 202 .Dq aes192-ctr ,
 203 .Dq aes256-ctr ,
 204 .Dq arcfour128 ,
 205 .Dq arcfour256 ,
 206 .Dq arcfour ,
 207 .Dq blowfish-cbc ,
 208 and
 209 .Dq cast128-cbc .
 210 The default is:
 211 .Bd -literal -offset 3n
 212 aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
 213 arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
 214 aes192-ctr,aes256-ctr
 215 .Ed
 216 .It Cm ClearAllForwardings
 217 Specifies that all local, remote, and dynamic port forwardings
 218 specified in the configuration files or on the command line be
 219 cleared.
 220 This option is primarily useful when used from the
 221 .Xr ssh 1
 222 command line to clear port forwardings set in
 223 configuration files, and is automatically set by
 224 .Xr scp 1
 225 and
 226 .Xr sftp 1 .
 227 The argument must be
 228 .Dq yes
 229 or
 230 .Dq no .
 231 The default is
 232 .Dq no .
 233 .It Cm Compression
 234 Specifies whether to use compression.
 235 The argument must be
 236 .Dq yes
 237 or
 238 .Dq no .
 239 The default is
 240 .Dq no .
 241 .It Cm CompressionLevel
 242 Specifies the compression level to use if compression is enabled.
 243 The argument must be an integer from 1 (fast) to 9 (slow, best).
 244 The default level is 6, which is good for most applications.
 245 The meaning of the values is the same as in
 246 .Xr gzip 1 .
 247 Note that this option applies to protocol version 1 only.
 248 .It Cm ConnectionAttempts
 249 Specifies the number of tries (one per second) to make before exiting.
 250 The argument must be an integer.
 251 This may be useful in scripts if the connection sometimes fails.
 252 The default is 1.
 253 .It Cm ConnectTimeout
 254 Specifies the timeout (in seconds) used when connecting to the
 255 SSH server, instead of using the default system TCP timeout.
 256 This value is used only when the target is down or really unreachable,
 257 not when it refuses the connection.
 258 .It Cm ControlMaster
 259 Enables the sharing of multiple sessions over a single network connection.
 260 When set to
 261 .Dq yes ,
 262 .Xr ssh 1
 263 will listen for connections on a control socket specified using the
 264 .Cm ControlPath
 265 argument.
 266 Additional sessions can connect to this socket using the same
 267 .Cm ControlPath
 268 with
 269 .Cm ControlMaster
 270 set to
 271 .Dq no
 272 (the default).
 273 These sessions will try to reuse the master instance's network connection
 274 rather than initiating new ones, but will fall back to connecting normally
 275 if the control socket does not exist, or is not listening.
 276 .Pp
 277 Setting this to
 278 .Dq ask
 279 will cause ssh
 280 to listen for control connections, but require confirmation using the
 281 .Ev SSH_ASKPASS
 282 program before they are accepted (see
 283 .Xr ssh-add 1
 284 for details).
 285 If the
 286 .Cm ControlPath
 287 cannot be opened,
 288 ssh will continue without connecting to a master instance.
 289 .Pp
 290 X11 and
 291 .Xr ssh-agent 1
 292 forwarding is supported over these multiplexed connections, however the
 293 display and agent forwarded will be the one belonging to the master
 294 connection i.e. it is not possible to forward multiple displays or agents.
 295 .Pp
 296 Two additional options allow for opportunistic multiplexing: try to use a
 297 master connection but fall back to creating a new one if one does not already
 298 exist.
 299 These options are:
 300 .Dq auto
 301 and
 302 .Dq autoask .
 303 The latter requires confirmation like the
 304 .Dq ask
 305 option.
 306 .It Cm ControlPath
 307 Specify the path to the control socket used for connection sharing as described
 308 in the
 309 .Cm ControlMaster
 310 section above or the string
 311 .Dq none
 312 to disable connection sharing.
 313 In the path,
 314 .Ql %l
 315 will be substituted by the local host name,
 316 .Ql %h
 317 will be substituted by the target host name,
 318 .Ql %p
 319 the port, and
 320 .Ql %r
 321 by the remote login username.
 322 It is recommended that any
 323 .Cm ControlPath
 324 used for opportunistic connection sharing include
 325 at least %h, %p, and %r.
 326 This ensures that shared connections are uniquely identified.
 327 .It Cm DynamicForward
 328 Specifies that a TCP port on the local machine be forwarded
 329 over the secure channel, and the application
 330 protocol is then used to determine where to connect to from the
 331 remote machine.
 332 .Pp
 333 The argument must be
 334 .Sm off
 335 .Oo Ar bind_address : Oc Ar port .
 336 .Sm on
 337 IPv6 addresses can be specified by enclosing addresses in square brackets or
 338 by using an alternative syntax:
 339 .Oo Ar bind_address Ns / Oc Ns Ar port .
 340 By default, the local port is bound in accordance with the
 341 .Cm GatewayPorts
 342 setting.
 343 However, an explicit
 344 .Ar bind_address
 345 may be used to bind the connection to a specific address.
 346 The
 347 .Ar bind_address
 348 of
 349 .Dq localhost
 350 indicates that the listening port be bound for local use only, while an
 351 empty address or
 352 .Sq *
 353 indicates that the port should be available from all interfaces.
 354 .Pp
 355 Currently the SOCKS4 and SOCKS5 protocols are supported, and
 356 .Xr ssh 1
 357 will act as a SOCKS server.
 358 Multiple forwardings may be specified, and
 359 additional forwardings can be given on the command line.
 360 Only the superuser can forward privileged ports.
 361 .It Cm EnableSSHKeysign
 362 Setting this option to
 363 .Dq yes
 364 in the global client configuration file
 365 .Pa /etc/ssh/ssh_config
 366 enables the use of the helper program
 367 .Xr ssh-keysign 8
 368 during
 369 .Cm HostbasedAuthentication .
 370 The argument must be
 371 .Dq yes
 372 or
 373 .Dq no .
 374 The default is
 375 .Dq no .
 376 This option should be placed in the non-hostspecific section.
 377 See
 378 .Xr ssh-keysign 8
 379 for more information.
 380 .It Cm EscapeChar
 381 Sets the escape character (default:
 382 .Ql ~ ) .
 383 The escape character can also
 384 be set on the command line.
 385 The argument should be a single character,
 386 .Ql ^
 387 followed by a letter, or
 388 .Dq none
 389 to disable the escape
 390 character entirely (making the connection transparent for binary
 391 data).
 392 .It Cm ExitOnForwardFailure
 393 Specifies whether
 394 .Xr ssh 1
 395 should terminate the connection if it cannot set up all requested
 396 dynamic, tunnel, local, and remote port forwardings.
 397 The argument must be
 398 .Dq yes
 399 or
 400 .Dq no .
 401 The default is
 402 .Dq no .
 403 .It Cm ForwardAgent
 404 Specifies whether the connection to the authentication agent (if any)
 405 will be forwarded to the remote machine.
 406 The argument must be
 407 .Dq yes
 408 or
 409 .Dq no .
 410 The default is
 411 .Dq no .
 412 .Pp
 413 Agent forwarding should be enabled with caution.
 414 Users with the ability to bypass file permissions on the remote host
 415 (for the agent's Unix-domain socket)
 416 can access the local agent through the forwarded connection.
 417 An attacker cannot obtain key material from the agent,
 418 however they can perform operations on the keys that enable them to
 419 authenticate using the identities loaded into the agent.
 420 .It Cm ForwardX11
 421 Specifies whether X11 connections will be automatically redirected
 422 over the secure channel and
 423 .Ev DISPLAY
 424 set.
 425 The argument must be
 426 .Dq yes
 427 or
 428 .Dq no .
 429 The default is
 430 .Dq no .
 431 .Pp
 432 X11 forwarding should be enabled with caution.
 433 Users with the ability to bypass file permissions on the remote host
 434 (for the user's X11 authorization database)
 435 can access the local X11 display through the forwarded connection.
 436 An attacker may then be able to perform activities such as keystroke monitoring
 437 if the
 438 .Cm ForwardX11Trusted
 439 option is also enabled.
 440 .It Cm ForwardX11Trusted
 441 If this option is set to
 442 .Dq yes ,
 443 remote X11 clients will have full access to the original X11 display.
 444 .Pp
 445 If this option is set to
 446 .Dq no ,
 447 remote X11 clients will be considered untrusted and prevented
 448 from stealing or tampering with data belonging to trusted X11
 449 clients.
 450 Furthermore, the
 451 .Xr xauth 1
 452 token used for the session will be set to expire after 20 minutes.
 453 Remote clients will be refused access after this time.
 454 .Pp
 455 The default is
 456 .Dq no .
 457 .Pp
 458 See the X11 SECURITY extension specification for full details on
 459 the restrictions imposed on untrusted clients.
 460 .It Cm GatewayPorts
 461 Specifies whether remote hosts are allowed to connect to local
 462 forwarded ports.
 463 By default,
 464 .Xr ssh 1
 465 binds local port forwardings to the loopback address.
 466 This prevents other remote hosts from connecting to forwarded ports.
 467 .Cm GatewayPorts
 468 can be used to specify that ssh
 469 should bind local port forwardings to the wildcard address,
 470 thus allowing remote hosts to connect to forwarded ports.
 471 The argument must be
 472 .Dq yes
 473 or
 474 .Dq no .
 475 The default is
 476 .Dq no .
 477 .It Cm GlobalKnownHostsFile
 478 Specifies a file to use for the global
 479 host key database instead of
 480 .Pa /etc/ssh/ssh_known_hosts .
 481 .It Cm GSSAPIAuthentication
 482 Specifies whether user authentication based on GSSAPI is allowed.
 483 The default is
 484 .Dq no .
 485 Note that this option applies to protocol version 2 only.
 486 .It Cm GSSAPIDelegateCredentials
 487 Forward (delegate) credentials to the server.
 488 The default is
 489 .Dq no .
 490 Note that this option applies to protocol version 2 only.
 491 .It Cm HashKnownHosts
 492 Indicates that
 493 .Xr ssh 1
 494 should hash host names and addresses when they are added to
 495 .Pa ~/.ssh/known_hosts .
 496 These hashed names may be used normally by
 497 .Xr ssh 1
 498 and
 499 .Xr sshd 8 ,
 500 but they do not reveal identifying information should the file's contents
 501 be disclosed.
 502 The default is
 503 .Dq no .
 504 Note that existing names and addresses in known hosts files
 505 will not be converted automatically,
 506 but may be manually hashed using
 507 .Xr ssh-keygen 1 .
 508 .It Cm HostbasedAuthentication
 509 Specifies whether to try rhosts based authentication with public key
 510 authentication.
 511 The argument must be
 512 .Dq yes
 513 or
 514 .Dq no .
 515 The default is
 516 .Dq no .
 517 This option applies to protocol version 2 only and
 518 is similar to
 519 .Cm RhostsRSAAuthentication .
 520 .It Cm HostKeyAlgorithms
 521 Specifies the protocol version 2 host key algorithms
 522 that the client wants to use in order of preference.
 523 The default for this option is:
 524 .Dq ssh-rsa,ssh-dss .
 525 .It Cm HostKeyAlias
 526 Specifies an alias that should be used instead of the
 527 real host name when looking up or saving the host key
 528 in the host key database files.
 529 This option is useful for tunneling SSH connections
 530 or for multiple servers running on a single host.
 531 .It Cm HostName
 532 Specifies the real host name to log into.
 533 This can be used to specify nicknames or abbreviations for hosts.
 534 The default is the name given on the command line.
 535 Numeric IP addresses are also permitted (both on the command line and in
 536 .Cm HostName
 537 specifications).
 538 .It Cm IdentitiesOnly
 539 Specifies that
 540 .Xr ssh 1
 541 should only use the authentication identity files configured in the
 542 .Nm
 543 files,
 544 even if
 545 .Xr ssh-agent 1
 546 offers more identities.
 547 The argument to this keyword must be
 548 .Dq yes
 549 or
 550 .Dq no .
 551 This option is intended for situations where ssh-agent
 552 offers many different identities.
 553 The default is
 554 .Dq no .
 555 .It Cm IdentityFile
 556 Specifies a file from which the user's RSA or DSA authentication identity
 557 is read.
 558 The default is
 559 .Pa ~/.ssh/identity
 560 for protocol version 1, and
 561 .Pa ~/.ssh/id_rsa
 562 and
 563 .Pa ~/.ssh/id_dsa
 564 for protocol version 2.
 565 Additionally, any identities represented by the authentication agent
 566 will be used for authentication.
 567 .Pp
 568 The file name may use the tilde
 569 syntax to refer to a user's home directory or one of the following
 570 escape characters:
 571 .Ql %d
 572 (local user's home directory),
 573 .Ql %u
 574 (local user name),
 575 .Ql %l
 576 (local host name),
 577 .Ql %h
 578 (remote host name) or
 579 .Ql %r
 580 (remote user name).
 581 .Pp
 582 It is possible to have
 583 multiple identity files specified in configuration files; all these
 584 identities will be tried in sequence.
 585 .It Cm KbdInteractiveAuthentication
 586 Specifies whether to use keyboard-interactive authentication.
 587 The argument to this keyword must be
 588 .Dq yes
 589 or
 590 .Dq no .
 591 The default is
 592 .Dq yes .
 593 .It Cm KbdInteractiveDevices
 594 Specifies the list of methods to use in keyboard-interactive authentication.
 595 Multiple method names must be comma-separated.
 596 The default is to use the server specified list.
 597 The methods available vary depending on what the server supports.
 598 For an OpenSSH server,
 599 it may be zero or more of:
 600 .Dq bsdauth ,
 601 .Dq pam ,
 602 and
 603 .Dq skey .
 604 .It Cm LocalCommand
 605 Specifies a command to execute on the local machine after successfully
 606 connecting to the server.
 607 The command string extends to the end of the line, and is executed with
 608 the user's shell.
 609 This directive is ignored unless
 610 .Cm PermitLocalCommand
 611 has been enabled.
 612 .It Cm LocalForward
 613 Specifies that a TCP port on the local machine be forwarded over
 614 the secure channel to the specified host and port from the remote machine.
 615 The first argument must be
 616 .Sm off
 617 .Oo Ar bind_address : Oc Ar port
 618 .Sm on
 619 and the second argument must be
 620 .Ar host : Ns Ar hostport .
 621 IPv6 addresses can be specified by enclosing addresses in square brackets or
 622 by using an alternative syntax:
 623 .Oo Ar bind_address Ns / Oc Ns Ar port
 624 and
 625 .Ar host Ns / Ns Ar hostport .
 626 Multiple forwardings may be specified, and additional forwardings can be
 627 given on the command line.
 628 Only the superuser can forward privileged ports.
 629 By default, the local port is bound in accordance with the
 630 .Cm GatewayPorts
 631 setting.
 632 However, an explicit
 633 .Ar bind_address
 634 may be used to bind the connection to a specific address.
 635 The
 636 .Ar bind_address
 637 of
 638 .Dq localhost
 639 indicates that the listening port be bound for local use only, while an
 640 empty address or
 641 .Sq *
 642 indicates that the port should be available from all interfaces.
 643 .It Cm LogLevel
 644 Gives the verbosity level that is used when logging messages from
 645 .Xr ssh 1 .
 646 The possible values are:
 647 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
 648 The default is INFO.
 649 DEBUG and DEBUG1 are equivalent.
 650 DEBUG2 and DEBUG3 each specify higher levels of verbose output.
 651 .It Cm MACs
 652 Specifies the MAC (message authentication code) algorithms
 653 in order of preference.
 654 The MAC algorithm is used in protocol version 2
 655 for data integrity protection.
 656 Multiple algorithms must be comma-separated.
 657 The default is:
 658 .Bd -literal -offset indent
 659 hmac-md5,hmac-sha1,umac-64@openssh.com,
 660 hmac-ripemd160,hmac-sha1-96,hmac-md5-96
 661 .Ed
 662 .It Cm NoHostAuthenticationForLocalhost
 663 This option can be used if the home directory is shared across machines.
 664 In this case localhost will refer to a different machine on each of
 665 the machines and the user will get many warnings about changed host keys.
 666 However, this option disables host authentication for localhost.
 667 The argument to this keyword must be
 668 .Dq yes
 669 or
 670 .Dq no .
 671 The default is to check the host key for localhost.
 672 .It Cm NumberOfPasswordPrompts
 673 Specifies the number of password prompts before giving up.
 674 The argument to this keyword must be an integer.
 675 The default is 3.
 676 .It Cm PasswordAuthentication
 677 Specifies whether to use password authentication.
 678 The argument to this keyword must be
 679 .Dq yes
 680 or
 681 .Dq no .
 682 The default is
 683 .Dq yes .
 684 .It Cm PermitLocalCommand
 685 Allow local command execution via the
 686 .Ic LocalCommand
 687 option or using the
 688 .Ic !\& Ns Ar command
 689 escape sequence in
 690 .Xr ssh 1 .
 691 The argument must be
 692 .Dq yes
 693 or
 694 .Dq no .
 695 The default is
 696 .Dq no .
 697 .It Cm Port
 698 Specifies the port number to connect on the remote host.
 699 The default is 22.
 700 .It Cm PreferredAuthentications
 701 Specifies the order in which the client should try protocol 2
 702 authentication methods.
 703 This allows a client to prefer one method (e.g.\&
 704 .Cm keyboard-interactive )
 705 over another method (e.g.\&
 706 .Cm password )
 707 The default for this option is:
 708 .Do gssapi-with-mic ,
 709 hostbased,
 710 publickey,
 711 keyboard-interactive,
 712 password
 713 .Dc .
 714 .It Cm Protocol
 715 Specifies the protocol versions
 716 .Xr ssh 1
 717 should support in order of preference.
 718 The possible values are
 719 .Sq 1
 720 and
 721 .Sq 2 .
 722 Multiple versions must be comma-separated.
 723 The default is
 724 .Dq 2,1 .
 725 This means that ssh
 726 tries version 2 and falls back to version 1
 727 if version 2 is not available.
 728 .It Cm ProxyCommand
 729 Specifies the command to use to connect to the server.
 730 The command
 731 string extends to the end of the line, and is executed with
 732 the user's shell.
 733 In the command string,
 734 .Ql %h
 735 will be substituted by the host name to
 736 connect and
 737 .Ql %p
 738 by the port.
 739 The command can be basically anything,
 740 and should read from its standard input and write to its standard output.
 741 It should eventually connect an
 742 .Xr sshd 8
 743 server running on some machine, or execute
 744 .Ic sshd -i
 745 somewhere.
 746 Host key management will be done using the
 747 HostName of the host being connected (defaulting to the name typed by
 748 the user).
 749 Setting the command to
 750 .Dq none
 751 disables this option entirely.
 752 Note that
 753 .Cm CheckHostIP
 754 is not available for connects with a proxy command.
 755 .Pp
 756 This directive is useful in conjunction with
 757 .Xr nc 1
 758 and its proxy support.
 759 For example, the following directive would connect via an HTTP proxy at
 760 192.0.2.0:
 761 .Bd -literal -offset 3n
 762 ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
 763 .Ed
 764 .It Cm PubkeyAuthentication
 765 Specifies whether to try public key authentication.
 766 The argument to this keyword must be
 767 .Dq yes
 768 or
 769 .Dq no .
 770 The default is
 771 .Dq yes .
 772 This option applies to protocol version 2 only.
 773 .It Cm RekeyLimit
 774 Specifies the maximum amount of data that may be transmitted before the
 775 session key is renegotiated.
 776 The argument is the number of bytes, with an optional suffix of
 777 .Sq K ,
 778 .Sq M ,
 779 or
 780 .Sq G
 781 to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
 782 The default is between
 783 .Sq 1G
 784 and
 785 .Sq 4G ,
 786 depending on the cipher.
 787 This option applies to protocol version 2 only.
 788 .It Cm RemoteForward
 789 Specifies that a TCP port on the remote machine be forwarded over
 790 the secure channel to the specified host and port from the local machine.
 791 The first argument must be
 792 .Sm off
 793 .Oo Ar bind_address : Oc Ar port
 794 .Sm on
 795 and the second argument must be
 796 .Ar host : Ns Ar hostport .
 797 IPv6 addresses can be specified by enclosing addresses in square brackets
 798 or by using an alternative syntax:
 799 .Oo Ar bind_address Ns / Oc Ns Ar port
 800 and
 801 .Ar host Ns / Ns Ar hostport .
 802 Multiple forwardings may be specified, and additional
 803 forwardings can be given on the command line.
 804 Only the superuser can forward privileged ports.
 805 .Pp
 806 If the
 807 .Ar bind_address
 808 is not specified, the default is to only bind to loopback addresses.
 809 If the
 810 .Ar bind_address
 811 is
 812 .Ql *
 813 or an empty string, then the forwarding is requested to listen on all
 814 interfaces.
 815 Specifying a remote
 816 .Ar bind_address
 817 will only succeed if the server's
 818 .Cm GatewayPorts
 819 option is enabled (see
 820 .Xr sshd_config 5 ) .
 821 .It Cm RhostsRSAAuthentication
 822 Specifies whether to try rhosts based authentication with RSA host
 823 authentication.
 824 The argument must be
 825 .Dq yes
 826 or
 827 .Dq no .
 828 The default is
 829 .Dq no .
 830 This option applies to protocol version 1 only and requires
 831 .Xr ssh 1
 832 to be setuid root.
 833 .It Cm RSAAuthentication
 834 Specifies whether to try RSA authentication.
 835 The argument to this keyword must be
 836 .Dq yes
 837 or
 838 .Dq no .
 839 RSA authentication will only be
 840 attempted if the identity file exists, or an authentication agent is
 841 running.
 842 The default is
 843 .Dq yes .
 844 Note that this option applies to protocol version 1 only.
 845 .It Cm SendEnv
 846 Specifies what variables from the local
 847 .Xr environ 7
 848 should be sent to the server.
 849 Note that environment passing is only supported for protocol 2.
 850 The server must also support it, and the server must be configured to
 851 accept these environment variables.
 852 Refer to
 853 .Cm AcceptEnv
 854 in
 855 .Xr sshd_config 5
 856 for how to configure the server.
 857 Variables are specified by name, which may contain wildcard characters.
 858 Multiple environment variables may be separated by whitespace or spread
 859 across multiple
 860 .Cm SendEnv
 861 directives.
 862 The default is not to send any environment variables.
 863 .Pp
 864 See
 865 .Sx PATTERNS
 866 for more information on patterns.
 867 .It Cm ServerAliveCountMax
 868 Sets the number of server alive messages (see below) which may be
 869 sent without
 870 .Xr ssh 1
 871 receiving any messages back from the server.
 872 If this threshold is reached while server alive messages are being sent,
 873 ssh will disconnect from the server, terminating the session.
 874 It is important to note that the use of server alive messages is very
 875 different from
 876 .Cm TCPKeepAlive
 877 (below).
 878 The server alive messages are sent through the encrypted channel
 879 and therefore will not be spoofable.
 880 The TCP keepalive option enabled by
 881 .Cm TCPKeepAlive
 882 is spoofable.
 883 The server alive mechanism is valuable when the client or
 884 server depend on knowing when a connection has become inactive.
 885 .Pp
 886 The default value is 3.
 887 If, for example,
 888 .Cm ServerAliveInterval
 889 (see below) is set to 15 and
 890 .Cm ServerAliveCountMax
 891 is left at the default, if the server becomes unresponsive,
 892 ssh will disconnect after approximately 45 seconds.
 893 This option applies to protocol version 2 only.
 894 .It Cm ServerAliveInterval
 895 Sets a timeout interval in seconds after which if no data has been received
 896 from the server,
 897 .Xr ssh 1
 898 will send a message through the encrypted
 899 channel to request a response from the server.
 900 The default
 901 is 0, indicating that these messages will not be sent to the server.
 902 This option applies to protocol version 2 only.
 903 .It Cm SmartcardDevice
 904 Specifies which smartcard device to use.
 905 The argument to this keyword is the device
 906 .Xr ssh 1
 907 should use to communicate with a smartcard used for storing the user's
 908 private RSA key.
 909 By default, no device is specified and smartcard support is not activated.
 910 .It Cm StrictHostKeyChecking
 911 If this flag is set to
 912 .Dq yes ,
 913 .Xr ssh 1
 914 will never automatically add host keys to the
 915 .Pa ~/.ssh/known_hosts
 916 file, and refuses to connect to hosts whose host key has changed.
 917 This provides maximum protection against trojan horse attacks,
 918 though it can be annoying when the
 919 .Pa /etc/ssh/ssh_known_hosts
 920 file is poorly maintained or when connections to new hosts are
 921 frequently made.
 922 This option forces the user to manually
 923 add all new hosts.
 924 If this flag is set to
 925 .Dq no ,
 926 ssh will automatically add new host keys to the
 927 user known hosts files.
 928 If this flag is set to
 929 .Dq ask ,
 930 new host keys
 931 will be added to the user known host files only after the user
 932 has confirmed that is what they really want to do, and
 933 ssh will refuse to connect to hosts whose host key has changed.
 934 The host keys of
 935 known hosts will be verified automatically in all cases.
 936 The argument must be
 937 .Dq yes ,
 938 .Dq no ,
 939 or
 940 .Dq ask .
 941 The default is
 942 .Dq ask .
 943 .It Cm TCPKeepAlive
 944 Specifies whether the system should send TCP keepalive messages to the
 945 other side.
 946 If they are sent, death of the connection or crash of one
 947 of the machines will be properly noticed.
 948 However, this means that
 949 connections will die if the route is down temporarily, and some people
 950 find it annoying.
 951 .Pp
 952 The default is
 953 .Dq yes
 954 (to send TCP keepalive messages), and the client will notice
 955 if the network goes down or the remote host dies.
 956 This is important in scripts, and many users want it too.
 957 .Pp
 958 To disable TCP keepalive messages, the value should be set to
 959 .Dq no .
 960 .It Cm Tunnel
 961 Request
 962 .Xr tun 4
 963 device forwarding between the client and the server.
 964 The argument must be
 965 .Dq yes ,
 966 .Dq point-to-point
 967 (layer 3),
 968 .Dq ethernet
 969 (layer 2),
 970 or
 971 .Dq no .
 972 Specifying
 973 .Dq yes
 974 requests the default tunnel mode, which is
 975 .Dq point-to-point .
 976 The default is
 977 .Dq no .
 978 .It Cm TunnelDevice
 979 Specifies the
 980 .Xr tun 4
 981 devices to open on the client
 982 .Pq Ar local_tun
 983 and the server
 984 .Pq Ar remote_tun .
 985 .Pp
 986 The argument must be
 987 .Sm off
 988 .Ar local_tun Op : Ar remote_tun .
 989 .Sm on
 990 The devices may be specified by numerical ID or the keyword
 991 .Dq any ,
 992 which uses the next available tunnel device.
 993 If
 994 .Ar remote_tun
 995 is not specified, it defaults to
 996 .Dq any .
 997 The default is
 998 .Dq any:any .
 999 .It Cm UsePrivilegedPort
1000 Specifies whether to use a privileged port for outgoing connections.
1001 The argument must be
1002 .Dq yes
1003 or
1004 .Dq no .
1005 The default is
1006 .Dq no .
1007 If set to
1008 .Dq yes ,
1009 .Xr ssh 1
1010 must be setuid root.
1011 Note that this option must be set to
1012 .Dq yes
1013 for
1014 .Cm RhostsRSAAuthentication
1015 with older servers.
1016 .It Cm User
1017 Specifies the user to log in as.
1018 This can be useful when a different user name is used on different machines.
1019 This saves the trouble of
1020 having to remember to give the user name on the command line.
1021 .It Cm UserKnownHostsFile
1022 Specifies a file to use for the user
1023 host key database instead of
1024 .Pa ~/.ssh/known_hosts .
1025 .It Cm VerifyHostKeyDNS
1026 Specifies whether to verify the remote key using DNS and SSHFP resource
1027 records.
1028 If this option is set to
1029 .Dq yes ,
1030 the client will implicitly trust keys that match a secure fingerprint
1031 from DNS.
1032 Insecure fingerprints will be handled as if this option was set to
1033 .Dq ask .
1034 If this option is set to
1035 .Dq ask ,
1036 information on fingerprint match will be displayed, but the user will still
1037 need to confirm new host keys according to the
1038 .Cm StrictHostKeyChecking
1039 option.
1040 The argument must be
1041 .Dq yes ,
1042 .Dq no ,
1043 or
1044 .Dq ask .
1045 The default is
1046 .Dq no .
1047 Note that this option applies to protocol version 2 only.
1048 .Pp
1049 See also
1050 .Sx VERIFYING HOST KEYS
1051 in
1052 .Xr ssh 1 .
1053 .It Cm XAuthLocation
1054 Specifies the full pathname of the
1055 .Xr xauth 1
1056 program.
1057 The default is
1058 .Pa /usr/X11R6/bin/xauth .
1059 .El
1060 .Sh PATTERNS
1061 A
1062 .Em pattern
1063 consists of zero or more non-whitespace characters,
1064 .Sq *
1065 (a wildcard that matches zero or more characters),
1066 or
1067 .Sq ?\&
1068 (a wildcard that matches exactly one character).
1069 For example, to specify a set of declarations for any host in the
1070 .Dq .co.uk
1071 set of domains,
1072 the following pattern could be used:
1073 .Pp
1074 .Dl Host *.co.uk
1075 .Pp
1076 The following pattern
1077 would match any host in the 192.168.0.[0-9] network range:
1078 .Pp
1079 .Dl Host 192.168.0.?
1080 .Pp
1081 A
1082 .Em pattern-list
1083 is a comma-separated list of patterns.
1084 Patterns within pattern-lists may be negated
1085 by preceding them with an exclamation mark
1086 .Pq Sq !\& .
1087 For example,
1088 to allow a key to be used from anywhere within an organisation
1089 except from the
1090 .Dq dialup
1091 pool,
1092 the following entry (in authorized_keys) could be used:
1093 .Pp
1094 .Dl from=\&"!*.dialup.example.com,*.example.com\&"
1095 .Sh FILES
1096 .Bl -tag -width Ds
1097 .It Pa ~/.ssh/config
1098 This is the per-user configuration file.
1099 The format of this file is described above.
1100 This file is used by the SSH client.
1101 Because of the potential for abuse, this file must have strict permissions:
1102 read/write for the user, and not accessible by others.
1103 .It Pa /etc/ssh/ssh_config
1104 Systemwide configuration file.
1105 This file provides defaults for those
1106 values that are not specified in the user's configuration file, and
1107 for those users who do not have a configuration file.
1108 This file must be world-readable.
1109 .El
1110 .Sh SEE ALSO
1111 .Xr ssh 1
1112 .Sh AUTHORS
1113 OpenSSH is a derivative of the original and free
1114 ssh 1.2.12 release by Tatu Ylonen.
1115 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1116 Theo de Raadt and Dug Song
1117 removed many bugs, re-added newer features and
1118 created OpenSSH.
1119 Markus Friedl contributed the support for SSH
1120 protocol versions 1.5 and 2.0.