crypto/openssh/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.38 2004/06/26 09:11:14 jmc Exp $
  38 .\" $FreeBSD$
  39 .Dd September 25, 1999
  40 .Dt SSH_CONFIG 5
  41 .Os
  42 .Sh NAME
  43 .Nm ssh_config
  44 .Nd OpenSSH SSH client configuration files
  45 .Sh SYNOPSIS
  46 .Bl -tag -width Ds -compact
  47 .It Pa $HOME/.ssh/config
  48 .It Pa /etc/ssh/ssh_config
  49 .El
  50 .Sh DESCRIPTION
  51 .Nm ssh
  52 obtains configuration data from the following sources in
  53 the following order:
  54 .Bl -enum -offset indent -compact
  55 .It
  56 command-line options
  57 .It
  58 user's configuration file
  59 .Pq Pa $HOME/.ssh/config
  60 .It
  61 system-wide configuration file
  62 .Pq Pa /etc/ssh/ssh_config
  63 .El
  64 .Pp
  65 For each parameter, the first obtained value
  66 will be used.
  67 The configuration files contain sections bracketed by
  68 .Dq Host
  69 specifications, and that section is only applied for hosts that
  70 match one of the patterns given in the specification.
  71 The matched host name is the one given on the command line.
  72 .Pp
  73 Since the first obtained value for each parameter is used, more
  74 host-specific declarations should be given near the beginning of the
  75 file, and general defaults at the end.
  76 .Pp
  77 The configuration file has the following format:
  78 .Pp
  79 Empty lines and lines starting with
  80 .Ql #
  81 are comments.
  82 .Pp
  83 Otherwise a line is of the format
  84 .Dq keyword arguments .
  85 Configuration options may be separated by whitespace or
  86 optional whitespace and exactly one
  87 .Ql = ;
  88 the latter format is useful to avoid the need to quote whitespace
  89 when specifying configuration options using the
  90 .Nm ssh ,
  91 .Nm scp
  92 and
  93 .Nm sftp
  94 .Fl o
  95 option.
  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 .Ql \&*
 107 and
 108 .Ql \&?
 109 can be used as wildcards in the
 110 patterns.
 111 A single
 112 .Ql \&*
 113 as a pattern can be used to provide global
 114 defaults for all hosts.
 115 The host is the
 116 .Ar hostname
 117 argument given on the command line (i.e., the name is not converted to
 118 a canonicalized host name before matching).
 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 Specify the interface to transmit from on machines with multiple
 141 interfaces or aliased addresses.
 142 Note that this option does not work if
 143 .Cm UsePrivilegedPort
 144 is set to
 145 .Dq yes .
 146 .It Cm ChallengeResponseAuthentication
 147 Specifies whether to use challenge response authentication.
 148 The argument to this keyword must be
 149 .Dq yes
 150 or
 151 .Dq no .
 152 The default is
 153 .Dq yes .
 154 .It Cm CheckHostIP
 155 If this flag is set to
 156 .Dq yes ,
 157 ssh will additionally check the host IP address in the
 158 .Pa known_hosts
 159 file.
 160 This allows ssh to detect if a host key changed due to DNS spoofing.
 161 If the option is set to
 162 .Dq no ,
 163 the check will not be executed.
 164 The default is
 165 .Dq no .
 166 .It Cm Cipher
 167 Specifies the cipher to use for encrypting the session
 168 in protocol version 1.
 169 Currently,
 170 .Dq blowfish ,
 171 .Dq 3des ,
 172 and
 173 .Dq des
 174 are supported.
 175 .Ar des
 176 is only supported in the
 177 .Nm ssh
 178 client for interoperability with legacy protocol 1 implementations
 179 that do not support the
 180 .Ar 3des
 181 cipher.
 182 Its use is strongly discouraged due to cryptographic weaknesses.
 183 The default is
 184 .Dq 3des .
 185 .It Cm Ciphers
 186 Specifies the ciphers allowed for protocol version 2
 187 in order of preference.
 188 Multiple ciphers must be comma-separated.
 189 The supported ciphers are
 190 .Dq 3des-cbc ,
 191 .Dq aes128-cbc ,
 192 .Dq aes192-cbc ,
 193 .Dq aes256-cbc ,
 194 .Dq aes128-ctr ,
 195 .Dq aes192-ctr ,
 196 .Dq aes256-ctr ,
 197 .Dq arcfour ,
 198 .Dq blowfish-cbc ,
 199 and
 200 .Dq cast128-cbc .
 201 The default is
 202 .Bd -literal
 203   ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
 204     aes192-cbc,aes256-cbc''
 205 .Ed
 206 .It Cm ClearAllForwardings
 207 Specifies that all local, remote and dynamic port forwardings
 208 specified in the configuration files or on the command line be
 209 cleared.
 210 This option is primarily useful when used from the
 211 .Nm ssh
 212 command line to clear port forwardings set in
 213 configuration files, and is automatically set by
 214 .Xr scp 1
 215 and
 216 .Xr sftp 1 .
 217 The argument must be
 218 .Dq yes
 219 or
 220 .Dq no .
 221 The default is
 222 .Dq no .
 223 .It Cm Compression
 224 Specifies whether to use compression.
 225 The argument must be
 226 .Dq yes
 227 or
 228 .Dq no .
 229 The default is
 230 .Dq no .
 231 .It Cm CompressionLevel
 232 Specifies the compression level to use if compression is enabled.
 233 The argument must be an integer from 1 (fast) to 9 (slow, best).
 234 The default level is 6, which is good for most applications.
 235 The meaning of the values is the same as in
 236 .Xr gzip 1 .
 237 Note that this option applies to protocol version 1 only.
 238 .It Cm ConnectionAttempts
 239 Specifies the number of tries (one per second) to make before exiting.
 240 The argument must be an integer.
 241 This may be useful in scripts if the connection sometimes fails.
 242 The default is 1.
 243 .It Cm ConnectTimeout
 244 Specifies the timeout (in seconds) used when connecting to the ssh
 245 server, instead of using the default system TCP timeout.
 246 This value is used only when the target is down or really unreachable,
 247 not when it refuses the connection.
 248 .It Cm ControlMaster
 249 Enables the sharing of multiple sessions over a single network connection.
 250 When set to
 251 .Dq yes
 252 .Nm ssh
 253 will listen for connections on a control socket specified using the
 254 .Cm ControlPath
 255 argument.
 256 Additional sessions can connect to this socket using the same
 257 .Cm ControlPath
 258 with
 259 .Cm ControlMaster
 260 set to
 261 .Dq no
 262 (the default).
 263 These sessions will reuse the master instance's network connection rather
 264 than initiating new ones.
 265 Setting this to
 266 .Dq ask
 267 will cause
 268 .Nm ssh
 269 to listen for control connections, but require confirmation using the
 270 .Ev SSH_ASKPASS
 271 program before they are accepted (see
 272 .Xr ssh-add 1
 273 for details).
 274 .It Cm ControlPath
 275 Specify the path to the control socket used for connection sharing.
 276 See
 277 .Cm ControlMaster
 278 above.
 279 .It Cm DynamicForward
 280 Specifies that a TCP/IP port on the local machine be forwarded
 281 over the secure channel, and the application
 282 protocol is then used to determine where to connect to from the
 283 remote machine.
 284 The argument must be a port number.
 285 Currently the SOCKS4 and SOCKS5 protocols are supported, and
 286 .Nm ssh
 287 will act as a SOCKS server.
 288 Multiple forwardings may be specified, and
 289 additional forwardings can be given on the command line.
 290 Only the superuser can forward privileged ports.
 291 .It Cm EnableSSHKeysign
 292 Setting this option to
 293 .Dq yes
 294 in the global client configuration file
 295 .Pa /etc/ssh/ssh_config
 296 enables the use of the helper program
 297 .Xr ssh-keysign 8
 298 during
 299 .Cm HostbasedAuthentication .
 300 The argument must be
 301 .Dq yes
 302 or
 303 .Dq no .
 304 The default is
 305 .Dq no .
 306 This option should be placed in the non-hostspecific section.
 307 See
 308 .Xr ssh-keysign 8
 309 for more information.
 310 .It Cm EscapeChar
 311 Sets the escape character (default:
 312 .Ql ~ ) .
 313 The escape character can also
 314 be set on the command line.
 315 The argument should be a single character,
 316 .Ql ^
 317 followed by a letter, or
 318 .Dq none
 319 to disable the escape
 320 character entirely (making the connection transparent for binary
 321 data).
 322 .It Cm ForwardAgent
 323 Specifies whether the connection to the authentication agent (if any)
 324 will be forwarded to the remote machine.
 325 The argument must be
 326 .Dq yes
 327 or
 328 .Dq no .
 329 The default is
 330 .Dq no .
 331 .Pp
 332 Agent forwarding should be enabled with caution.
 333 Users with the ability to bypass file permissions on the remote host
 334 (for the agent's Unix-domain socket)
 335 can access the local agent through the forwarded connection.
 336 An attacker cannot obtain key material from the agent,
 337 however they can perform operations on the keys that enable them to
 338 authenticate using the identities loaded into the agent.
 339 .It Cm ForwardX11
 340 Specifies whether X11 connections will be automatically redirected
 341 over the secure channel and
 342 .Ev DISPLAY
 343 set.
 344 The argument must be
 345 .Dq yes
 346 or
 347 .Dq no .
 348 The default is
 349 .Dq no .
 350 .Pp
 351 X11 forwarding should be enabled with caution.
 352 Users with the ability to bypass file permissions on the remote host
 353 (for the user's X11 authorization database)
 354 can access the local X11 display through the forwarded connection.
 355 An attacker may then be able to perform activities such as keystroke monitoring
 356 if the
 357 .Cm ForwardX11Trusted
 358 option is also enabled.
 359 .It Cm ForwardX11Trusted
 360 If this option is set to
 361 .Dq yes
 362 then remote X11 clients will have full access to the original X11 display.
 363 If this option is set to
 364 .Dq no
 365 then remote X11 clients will be considered untrusted and prevented
 366 from stealing or tampering with data belonging to trusted X11
 367 clients.
 368 .Pp
 369 The default is
 370 .Dq no .
 371 .Pp
 372 See the X11 SECURITY extension specification for full details on
 373 the restrictions imposed on untrusted clients.
 374 .It Cm GatewayPorts
 375 Specifies whether remote hosts are allowed to connect to local
 376 forwarded ports.
 377 By default,
 378 .Nm ssh
 379 binds local port forwardings to the loopback address.
 380 This prevents other remote hosts from connecting to forwarded ports.
 381 .Cm GatewayPorts
 382 can be used to specify that
 383 .Nm ssh
 384 should bind local port forwardings to the wildcard address,
 385 thus allowing remote hosts to connect to forwarded ports.
 386 The argument must be
 387 .Dq yes
 388 or
 389 .Dq no .
 390 The default is
 391 .Dq no .
 392 .It Cm GlobalKnownHostsFile
 393 Specifies a file to use for the global
 394 host key database instead of
 395 .Pa /etc/ssh/ssh_known_hosts .
 396 .It Cm GSSAPIAuthentication
 397 Specifies whether user authentication based on GSSAPI is allowed.
 398 The default is
 399 .Dq no .
 400 Note that this option applies to protocol version 2 only.
 401 .It Cm GSSAPIDelegateCredentials
 402 Forward (delegate) credentials to the server.
 403 The default is
 404 .Dq no .
 405 Note that this option applies to protocol version 2 only.
 406 .It Cm HostbasedAuthentication
 407 Specifies whether to try rhosts based authentication with public key
 408 authentication.
 409 The argument must be
 410 .Dq yes
 411 or
 412 .Dq no .
 413 The default is
 414 .Dq no .
 415 This option applies to protocol version 2 only and
 416 is similar to
 417 .Cm RhostsRSAAuthentication .
 418 .It Cm HostKeyAlgorithms
 419 Specifies the protocol version 2 host key algorithms
 420 that the client wants to use in order of preference.
 421 The default for this option is:
 422 .Dq ssh-rsa,ssh-dss .
 423 .It Cm HostKeyAlias
 424 Specifies an alias that should be used instead of the
 425 real host name when looking up or saving the host key
 426 in the host key database files.
 427 This option is useful for tunneling ssh connections
 428 or for multiple servers running on a single host.
 429 .It Cm HostName
 430 Specifies the real host name to log into.
 431 This can be used to specify nicknames or abbreviations for hosts.
 432 Default is the name given on the command line.
 433 Numeric IP addresses are also permitted (both on the command line and in
 434 .Cm HostName
 435 specifications).
 436 .It Cm IdentityFile
 437 Specifies a file from which the user's RSA or DSA authentication identity
 438 is read.
 439 The default is
 440 .Pa $HOME/.ssh/identity
 441 for protocol version 1, and
 442 .Pa $HOME/.ssh/id_rsa
 443 and
 444 .Pa $HOME/.ssh/id_dsa
 445 for protocol version 2.
 446 Additionally, any identities represented by the authentication agent
 447 will be used for authentication.
 448 The file name may use the tilde
 449 syntax to refer to a user's home directory.
 450 It is possible to have
 451 multiple identity files specified in configuration files; all these
 452 identities will be tried in sequence.
 453 .It Cm IdentitiesOnly
 454 Specifies that
 455 .Nm ssh
 456 should only use the authentication identity files configured in the
 457 .Nm
 458 files,
 459 even if the
 460 .Nm ssh-agent
 461 offers more identities.
 462 The argument to this keyword must be
 463 .Dq yes
 464 or
 465 .Dq no .
 466 This option is intented for situations where
 467 .Nm ssh-agent
 468 offers many different identities.
 469 The default is
 470 .Dq no .
 471 .It Cm LocalForward
 472 Specifies that a TCP/IP port on the local machine be forwarded over
 473 the secure channel to the specified host and port from the remote machine.
 474 The first argument must be a port number, and the second must be
 475 .Ar host:port .
 476 IPv6 addresses can be specified with an alternative syntax:
 477 .Ar host/port .
 478 Multiple forwardings may be specified, and additional
 479 forwardings can be given on the command line.
 480 Only the superuser can forward privileged ports.
 481 .It Cm LogLevel
 482 Gives the verbosity level that is used when logging messages from
 483 .Nm ssh .
 484 The possible values are:
 485 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
 486 The default is INFO.
 487 DEBUG and DEBUG1 are equivalent.
 488 DEBUG2 and DEBUG3 each specify higher levels of verbose output.
 489 .It Cm MACs
 490 Specifies the MAC (message authentication code) algorithms
 491 in order of preference.
 492 The MAC algorithm is used in protocol version 2
 493 for data integrity protection.
 494 Multiple algorithms must be comma-separated.
 495 The default is
 496 .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
 497 .It Cm NoHostAuthenticationForLocalhost
 498 This option can be used if the home directory is shared across machines.
 499 In this case localhost will refer to a different machine on each of
 500 the machines and the user will get many warnings about changed host keys.
 501 However, this option disables host authentication for localhost.
 502 The argument to this keyword must be
 503 .Dq yes
 504 or
 505 .Dq no .
 506 The default is to check the host key for localhost.
 507 .It Cm NumberOfPasswordPrompts
 508 Specifies the number of password prompts before giving up.
 509 The argument to this keyword must be an integer.
 510 Default is 3.
 511 .It Cm PasswordAuthentication
 512 Specifies whether to use password authentication.
 513 The argument to this keyword must be
 514 .Dq yes
 515 or
 516 .Dq no .
 517 The default is
 518 .Dq yes .
 519 .It Cm Port
 520 Specifies the port number to connect on the remote host.
 521 Default is 22.
 522 .It Cm PreferredAuthentications
 523 Specifies the order in which the client should try protocol 2
 524 authentication methods.
 525 This allows a client to prefer one method (e.g.
 526 .Cm keyboard-interactive )
 527 over another method (e.g.
 528 .Cm password )
 529 The default for this option is:
 530 .Dq hostbased,publickey,keyboard-interactive,password .
 531 .It Cm Protocol
 532 Specifies the protocol versions
 533 .Nm ssh
 534 should support in order of preference.
 535 The possible values are
 536 .Dq 1
 537 and
 538 .Dq 2 .
 539 Multiple versions must be comma-separated.
 540 The default is
 541 .Dq 2,1 .
 542 This means that
 543 .Nm ssh
 544 tries version 2 and falls back to version 1
 545 if version 2 is not available.
 546 .It Cm ProxyCommand
 547 Specifies the command to use to connect to the server.
 548 The command
 549 string extends to the end of the line, and is executed with
 550 .Pa /bin/sh .
 551 In the command string,
 552 .Ql %h
 553 will be substituted by the host name to
 554 connect and
 555 .Ql %p
 556 by the port.
 557 The command can be basically anything,
 558 and should read from its standard input and write to its standard output.
 559 It should eventually connect an
 560 .Xr sshd 8
 561 server running on some machine, or execute
 562 .Ic sshd -i
 563 somewhere.
 564 Host key management will be done using the
 565 HostName of the host being connected (defaulting to the name typed by
 566 the user).
 567 Setting the command to
 568 .Dq none
 569 disables this option entirely.
 570 Note that
 571 .Cm CheckHostIP
 572 is not available for connects with a proxy command.
 573 .Pp
 574 .It Cm PubkeyAuthentication
 575 Specifies whether to try public key authentication.
 576 The argument to this keyword must be
 577 .Dq yes
 578 or
 579 .Dq no .
 580 The default is
 581 .Dq yes .
 582 This option applies to protocol version 2 only.
 583 .It Cm RemoteForward
 584 Specifies that a TCP/IP port on the remote machine be forwarded over
 585 the secure channel to the specified host and port from the local machine.
 586 The first argument must be a port number, and the second must be
 587 .Ar host:port .
 588 IPv6 addresses can be specified with an alternative syntax:
 589 .Ar host/port .
 590 Multiple forwardings may be specified, and additional
 591 forwardings can be given on the command line.
 592 Only the superuser can forward privileged ports.
 593 .It Cm RhostsRSAAuthentication
 594 Specifies whether to try rhosts based authentication with RSA host
 595 authentication.
 596 The argument must be
 597 .Dq yes
 598 or
 599 .Dq no .
 600 The default is
 601 .Dq no .
 602 This option applies to protocol version 1 only and requires
 603 .Nm ssh
 604 to be setuid root.
 605 .It Cm RSAAuthentication
 606 Specifies whether to try RSA authentication.
 607 The argument to this keyword must be
 608 .Dq yes
 609 or
 610 .Dq no .
 611 RSA authentication will only be
 612 attempted if the identity file exists, or an authentication agent is
 613 running.
 614 The default is
 615 .Dq yes .
 616 Note that this option applies to protocol version 1 only.
 617 .It Cm SendEnv
 618 Specifies what variables from the local
 619 .Xr environ 7
 620 should be sent to the server.
 621 Note that environment passing is only supported for protocol 2, the
 622 server must also support it, and the server must be configured to
 623 accept these environment variables.
 624 Refer to
 625 .Cm AcceptEnv
 626 in
 627 .Xr sshd_config 5
 628 for how to configure the server.
 629 Variables are specified by name, which may contain the wildcard characters
 630 .Ql \&*
 631 and
 632 .Ql \&? .
 633 Multiple environment variables may be separated by whitespace or spread
 634 across multiple
 635 .Cm SendEnv
 636 directives.
 637 The default is not to send any environment variables.
 638 .It Cm ServerAliveInterval
 639 Sets a timeout interval in seconds after which if no data has been received
 640 from the server,
 641 .Nm ssh
 642 will send a message through the encrypted
 643 channel to request a response from the server.
 644 The default
 645 is 0, indicating that these messages will not be sent to the server.
 646 This option applies to protocol version 2 only.
 647 .It Cm ServerAliveCountMax
 648 Sets the number of server alive messages (see above) which may be
 649 sent without
 650 .Nm ssh
 651 receiving any messages back from the server.
 652 If this threshold is reached while server alive messages are being sent,
 653 .Nm ssh
 654 will disconnect from the server, terminating the session.
 655 It is important to note that the use of server alive messages is very
 656 different from
 657 .Cm TCPKeepAlive
 658 (below).
 659 The server alive messages are sent through the encrypted channel
 660 and therefore will not be spoofable.
 661 The TCP keepalive option enabled by
 662 .Cm TCPKeepAlive
 663 is spoofable.
 664 The server alive mechanism is valuable when the client or
 665 server depend on knowing when a connection has become inactive.
 666 .Pp
 667 The default value is 3.
 668 If, for example,
 669 .Cm ServerAliveInterval
 670 (above) is set to 15, and
 671 .Cm ServerAliveCountMax
 672 is left at the default, if the server becomes unresponsive ssh
 673 will disconnect after approximately 45 seconds.
 674 .It Cm SmartcardDevice
 675 Specifies which smartcard device to use.
 676 The argument to this keyword is the device
 677 .Nm ssh
 678 should use to communicate with a smartcard used for storing the user's
 679 private RSA key.
 680 By default, no device is specified and smartcard support is not activated.
 681 .It Cm StrictHostKeyChecking
 682 If this flag is set to
 683 .Dq yes ,
 684 .Nm ssh
 685 will never automatically add host keys to the
 686 .Pa $HOME/.ssh/known_hosts
 687 file, and refuses to connect to hosts whose host key has changed.
 688 This provides maximum protection against trojan horse attacks,
 689 however, can be annoying when the
 690 .Pa /etc/ssh/ssh_known_hosts
 691 file is poorly maintained, or connections to new hosts are
 692 frequently made.
 693 This option forces the user to manually
 694 add all new hosts.
 695 If this flag is set to
 696 .Dq no ,
 697 .Nm ssh
 698 will automatically add new host keys to the
 699 user known hosts files.
 700 If this flag is set to
 701 .Dq ask ,
 702 new host keys
 703 will be added to the user known host files only after the user
 704 has confirmed that is what they really want to do, and
 705 .Nm ssh
 706 will refuse to connect to hosts whose host key has changed.
 707 The host keys of
 708 known hosts will be verified automatically in all cases.
 709 The argument must be
 710 .Dq yes ,
 711 .Dq no
 712 or
 713 .Dq ask .
 714 The default is
 715 .Dq ask .
 716 .It Cm TCPKeepAlive
 717 Specifies whether the system should send TCP keepalive messages to the
 718 other side.
 719 If they are sent, death of the connection or crash of one
 720 of the machines will be properly noticed.
 721 However, this means that
 722 connections will die if the route is down temporarily, and some people
 723 find it annoying.
 724 .Pp
 725 The default is
 726 .Dq yes
 727 (to send TCP keepalive messages), and the client will notice
 728 if the network goes down or the remote host dies.
 729 This is important in scripts, and many users want it too.
 730 .Pp
 731 To disable TCP keepalive messages, the value should be set to
 732 .Dq no .
 733 .It Cm UsePrivilegedPort
 734 Specifies whether to use a privileged port for outgoing connections.
 735 The argument must be
 736 .Dq yes
 737 or
 738 .Dq no .
 739 The default is
 740 .Dq no .
 741 If set to
 742 .Dq yes
 743 .Nm ssh
 744 must be setuid root.
 745 Note that this option must be set to
 746 .Dq yes
 747 for
 748 .Cm RhostsRSAAuthentication
 749 with older servers.
 750 .It Cm User
 751 Specifies the user to log in as.
 752 This can be useful when a different user name is used on different machines.
 753 This saves the trouble of
 754 having to remember to give the user name on the command line.
 755 .It Cm UserKnownHostsFile
 756 Specifies a file to use for the user
 757 host key database instead of
 758 .Pa $HOME/.ssh/known_hosts .
 759 .It Cm VerifyHostKeyDNS
 760 Specifies whether to verify the remote key using DNS and SSHFP resource
 761 records.
 762 If this option is set to
 763 .Dq yes ,
 764 the client will implicitly trust keys that match a secure fingerprint
 765 from DNS.
 766 Insecure fingerprints will be handled as if this option was set to
 767 .Dq ask .
 768 If this option is set to
 769 .Dq ask ,
 770 information on fingerprint match will be displayed, but the user will still
 771 need to confirm new host keys according to the
 772 .Cm StrictHostKeyChecking
 773 option.
 774 The argument must be
 775 .Dq yes ,
 776 .Dq no
 777 or
 778 .Dq ask .
 779 The default is
 780 .Dq no .
 781 Note that this option applies to protocol version 2 only.
 782 .It Cm VersionAddendum
 783 Specifies a string to append to the regular version string to identify
 784 OS- or site-specific modifications.
 785 The default is
 786 .Dq FreeBSD-20041028 .
 787 .It Cm XAuthLocation
 788 Specifies the full pathname of the
 789 .Xr xauth 1
 790 program.
 791 The default is
 792 .Pa /usr/X11R6/bin/xauth .
 793 .El
 794 .Sh FILES
 795 .Bl -tag -width Ds
 796 .It Pa $HOME/.ssh/config
 797 This is the per-user configuration file.
 798 The format of this file is described above.
 799 This file is used by the
 800 .Nm ssh
 801 client.
 802 Because of the potential for abuse, this file must have strict permissions:
 803 read/write for the user, and not accessible by others.
 804 .It Pa /etc/ssh/ssh_config
 805 Systemwide configuration file.
 806 This file provides defaults for those
 807 values that are not specified in the user's configuration file, and
 808 for those users who do not have a configuration file.
 809 This file must be world-readable.
 810 .El
 811 .Sh SEE ALSO
 812 .Xr ssh 1
 813 .Sh AUTHORS
 814 OpenSSH is a derivative of the original and free
 815 ssh 1.2.12 release by Tatu Ylonen.
 816 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
 817 Theo de Raadt and Dug Song
 818 removed many bugs, re-added newer features and
 819 created OpenSSH.
 820 Markus Friedl contributed the support for SSH
 821 protocol versions 1.5 and 2.0.