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.1 2002/06/20 19:56:07 stevesk Exp $
  38 .Dd September 25, 1999
  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 .Bl -tag -width Ds -compact
  46 .It Pa $HOME/.ssh/config
  47 .It Pa /etc/ssh/ssh_config
  48 .El
  49 .Sh DESCRIPTION
  50 .Nm ssh
  51 obtains configuration data from the following sources in
  52 the following order:
  53 command line options,
  54 feature-specific user configuration file(s) (see below),
  55 user's configuration file
  56 .Pq Pa $HOME/.ssh/config ,
  57 and system-wide configuration file
  58 .Pq Pa /etc/ssh/ssh_config .
  59 For compatibility with other
  60 .Nm
  61 versions, the following feature-specific user configuration files
  62 will be processed after the command line options but before the user's
  63 main configuration file, so options that other
  64 .Nm
  65 versions may not support don't need to go in the main configuration file:
  66 .Bl -tag -width Ds
  67 .It Pa $HOME/.ssh/config.gssapi
  68 Read if GSSAPI authentication is supported.  This is a good place for
  69 the GssapiAuthentication and GssapiDelegateCredentials options.
  70 .It Pa $HOME/.ssh/config.krb
  71 Read if Kerberos authentication is supported.  This is a good place
  72 for the KerberosAuthentication and KerberosTgtPassing options.
  73 .It Pa $HOME/.ssh/config.afs
  74 Read if AFS token passing is supported.  This is a good place for the
  75 AfsTokenPassing option.
  76 .El
  77 .Pp
  78 For each parameter, the first obtained value
  79 will be used.
  80 The configuration files contain sections bracketed by
  81 .Dq Host
  82 specifications, and that section is only applied for hosts that
  83 match one of the patterns given in the specification.
  84 The matched host name is the one given on the command line.
  85 .Pp
  86 Since the first obtained value for each parameter is used, more
  87 host-specific declarations should be given near the beginning of the
  88 file, and general defaults at the end.
  89 .Pp
  90 The configuration file has the following format:
  91 .Pp
  92 Empty lines and lines starting with
  93 .Ql #
  94 are comments.
  95 .Pp
  96 Otherwise a line is of the format
  97 .Dq keyword arguments .
  98 Configuration options may be separated by whitespace or
  99 optional whitespace and exactly one
 100 .Ql = ;
 101 the latter format is useful to avoid the need to quote whitespace
 102 when specifying configuration options using the
 103 .Nm ssh ,
 104 .Nm scp
 105 and
 106 .Nm sftp
 107 .Fl o
 108 option.
 109 .Pp
 110 The possible
 111 keywords and their meanings are as follows (note that
 112 keywords are case-insensitive and arguments are case-sensitive):
 113 .Bl -tag -width Ds
 114 .It Cm Host
 115 Restricts the following declarations (up to the next
 116 .Cm Host
 117 keyword) to be only for those hosts that match one of the patterns
 118 given after the keyword.
 119 .Ql \&*
 120 and
 121 .Ql ?
 122 can be used as wildcards in the
 123 patterns.
 124 A single
 125 .Ql \&*
 126 as a pattern can be used to provide global
 127 defaults for all hosts.
 128 The host is the
 129 .Ar hostname
 130 argument given on the command line (i.e., the name is not converted to
 131 a canonicalized host name before matching).
 132 .It Cm AFSTokenPassing
 133 Specifies whether to pass AFS tokens to remote host.
 134 The argument to this keyword must be
 135 .Dq yes
 136 or
 137 .Dq no .
 138 This option applies to protocol version 1 only.
 139 .It Cm BatchMode
 140 If set to
 141 .Dq yes ,
 142 passphrase/password querying will be disabled.
 143 This option is useful in scripts and other batch jobs where no user
 144 is present to supply the password.
 145 The argument must be
 146 .Dq yes
 147 or
 148 .Dq no .
 149 The default is
 150 .Dq no .
 151 .It Cm BindAddress
 152 Specify the interface to transmit from on machines with multiple
 153 interfaces or aliased addresses.
 154 Note that this option does not work if
 155 .Cm UsePrivilegedPort
 156 is set to
 157 .Dq yes .
 158 .It Cm ChallengeResponseAuthentication
 159 Specifies whether to use challenge response authentication.
 160 The argument to this keyword must be
 161 .Dq yes
 162 or
 163 .Dq no .
 164 The default is
 165 .Dq yes .
 166 .It Cm CheckHostIP
 167 If this flag is set to
 168 .Dq yes ,
 169 ssh will additionally check the host IP address in the
 170 .Pa known_hosts
 171 file.
 172 This allows ssh to detect if a host key changed due to DNS spoofing.
 173 If the option is set to
 174 .Dq no ,
 175 the check will not be executed.
 176 The default is
 177 .Dq yes .
 178 .It Cm Cipher
 179 Specifies the cipher to use for encrypting the session
 180 in protocol version 1.
 181 Currently,
 182 .Dq blowfish ,
 183 .Dq 3des ,
 184 and
 185 .Dq des
 186 are supported.
 187 .Ar des
 188 is only supported in the
 189 .Nm ssh
 190 client for interoperability with legacy protocol 1 implementations
 191 that do not support the
 192 .Ar 3des
 193 cipher.  Its use is strongly discouraged due to cryptographic
 194 weaknesses.
 195 The default is
 196 .Dq 3des .
 197 .It Cm Ciphers
 198 Specifies the ciphers allowed for protocol version 2
 199 in order of preference.
 200 Multiple ciphers must be comma-separated.
 201 The default is
 202 .Pp
 203 .Bd -literal
 204   ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
 205     aes192-cbc,aes256-cbc''
 206 .Ed
 207 .It Cm ClearAllForwardings
 208 Specifies that all local, remote and dynamic port forwardings
 209 specified in the configuration files or on the command line be
 210 cleared.  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 DynamicForward
 244 Specifies that a TCP/IP port on the local machine be forwarded
 245 over the secure channel, and the application
 246 protocol is then used to determine where to connect to from the
 247 remote machine.  The argument must be a port number.
 248 Currently the SOCKS4 protocol is supported, and
 249 .Nm ssh
 250 will act as a SOCKS4 server.
 251 Multiple forwardings may be specified, and
 252 additional forwardings can be given on the command line.  Only
 253 the superuser can forward privileged ports.
 254 .It Cm EscapeChar
 255 Sets the escape character (default:
 256 .Ql ~ ) .
 257 The escape character can also
 258 be set on the command line.
 259 The argument should be a single character,
 260 .Ql ^
 261 followed by a letter, or
 262 .Dq none
 263 to disable the escape
 264 character entirely (making the connection transparent for binary
 265 data).
 266 .It Cm ForwardAgent
 267 Specifies whether the connection to the authentication agent (if any)
 268 will be forwarded to the remote machine.
 269 The argument must be
 270 .Dq yes
 271 or
 272 .Dq no .
 273 The default is
 274 .Dq no .
 275 .It Cm ForwardX11
 276 Specifies whether X11 connections will be automatically redirected
 277 over the secure channel and
 278 .Ev DISPLAY
 279 set.
 280 The argument must be
 281 .Dq yes
 282 or
 283 .Dq no .
 284 The default is
 285 .Dq no .
 286 .It Cm GatewayPorts
 287 Specifies whether remote hosts are allowed to connect to local
 288 forwarded ports.
 289 By default,
 290 .Nm ssh
 291 binds local port forwardings to the loopback address.  This
 292 prevents other remote hosts from connecting to forwarded ports.
 293 .Cm GatewayPorts
 294 can be used to specify that
 295 .Nm ssh
 296 should bind local port forwardings to the wildcard address,
 297 thus allowing remote hosts to connect to forwarded ports.
 298 The argument must be
 299 .Dq yes
 300 or
 301 .Dq no .
 302 The default is
 303 .Dq no .
 304 .It Cm GlobalKnownHostsFile
 305 Specifies a file to use for the global
 306 host key database instead of
 307 .Pa /etc/ssh/ssh_known_hosts .
 308 .It Cm GssapiAuthentication
 309 Specifies whether authentication based on GSSAPI may be used, either using
 310 the result of a successful key exchange, or using GSSAPI user
 311 authentication.
 312 The default is
 313 .Dq yes .
 314 .It Cm GssapiDelegateCredentials
 315 Specifies whether GSSAPI credentials will be delegated (forwarded) to
 316 the server.
 317 The default is
 318 .Dq yes .
 319 .It Cm HostbasedAuthentication
 320 Specifies whether to try rhosts based authentication with public key
 321 authentication.
 322 The argument must be
 323 .Dq yes
 324 or
 325 .Dq no .
 326 The default is
 327 .Dq no .
 328 This option applies to protocol version 2 only and
 329 is similar to
 330 .Cm RhostsRSAAuthentication .
 331 .It Cm HostKeyAlgorithms
 332 Specifies the protocol version 2 host key algorithms
 333 that the client wants to use in order of preference.
 334 The default for this option is:
 335 .Dq ssh-rsa,ssh-dss .
 336 .It Cm HostKeyAlias
 337 Specifies an alias that should be used instead of the
 338 real host name when looking up or saving the host key
 339 in the host key database files.
 340 This option is useful for tunneling ssh connections
 341 or for multiple servers running on a single host.
 342 .It Cm HostName
 343 Specifies the real host name to log into.
 344 This can be used to specify nicknames or abbreviations for hosts.
 345 Default is the name given on the command line.
 346 Numeric IP addresses are also permitted (both on the command line and in
 347 .Cm HostName
 348 specifications).
 349 .It Cm IdentityFile
 350 Specifies a file from which the user's RSA or DSA authentication identity
 351 is read. The default is
 352 .Pa $HOME/.ssh/identity
 353 for protocol version 1, and
 354 .Pa $HOME/.ssh/id_rsa
 355 and
 356 .Pa $HOME/.ssh/id_dsa
 357 for protocol version 2.
 358 Additionally, any identities represented by the authentication agent
 359 will be used for authentication.
 360 The file name may use the tilde
 361 syntax to refer to a user's home directory.
 362 It is possible to have
 363 multiple identity files specified in configuration files; all these
 364 identities will be tried in sequence.
 365 .It Cm KeepAlive
 366 Specifies whether the system should send TCP keepalive messages to the
 367 other side.
 368 If they are sent, death of the connection or crash of one
 369 of the machines will be properly noticed.
 370 However, this means that
 371 connections will die if the route is down temporarily, and some people
 372 find it annoying.
 373 .Pp
 374 The default is
 375 .Dq yes
 376 (to send keepalives), and the client will notice
 377 if the network goes down or the remote host dies.
 378 This is important in scripts, and many users want it too.
 379 .Pp
 380 To disable keepalives, the value should be set to
 381 .Dq no .
 382 .It Cm KerberosAuthentication
 383 Specifies whether Kerberos authentication will be used.
 384 The argument to this keyword must be
 385 .Dq yes
 386 or
 387 .Dq no .
 388 .It Cm KerberosTgtPassing
 389 Specifies whether a Kerberos TGT will be forwarded to the server.
 390 This will only work if the Kerberos server is actually an AFS kaserver.
 391 The argument to this keyword must be
 392 .Dq yes
 393 or
 394 .Dq no .
 395 .It Cm LocalForward
 396 Specifies that a TCP/IP port on the local machine be forwarded over
 397 the secure channel to the specified host and port from the remote machine.
 398 The first argument must be a port number, and the second must be
 399 .Ar host:port .
 400 IPv6 addresses can be specified with an alternative syntax:
 401 .Ar host/port .
 402 Multiple forwardings may be specified, and additional
 403 forwardings can be given on the command line.
 404 Only the superuser can forward privileged ports.
 405 .It Cm LogLevel
 406 Gives the verbosity level that is used when logging messages from
 407 .Nm ssh .
 408 The possible values are:
 409 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
 410 The default is INFO.  DEBUG and DEBUG1 are equivalent.  DEBUG2
 411 and DEBUG3 each specify higher levels of verbose output.
 412 .It Cm MACs
 413 Specifies the MAC (message authentication code) algorithms
 414 in order of preference.
 415 The MAC algorithm is used in protocol version 2
 416 for data integrity protection.
 417 Multiple algorithms must be comma-separated.
 418 The default is
 419 .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
 420 .It Cm NoHostAuthenticationForLocalhost
 421 This option can be used if the home directory is shared across machines.
 422 In this case localhost will refer to a different machine on each of
 423 the machines and the user will get many warnings about changed host keys.
 424 However, this option disables host authentication for localhost.
 425 The argument to this keyword must be
 426 .Dq yes
 427 or
 428 .Dq no .
 429 The default is to check the host key for localhost.
 430 .It Cm NumberOfPasswordPrompts
 431 Specifies the number of password prompts before giving up.
 432 The argument to this keyword must be an integer.
 433 Default is 3.
 434 .It Cm PasswordAuthentication
 435 Specifies whether to use password authentication.
 436 The argument to this keyword must be
 437 .Dq yes
 438 or
 439 .Dq no .
 440 The default is
 441 .Dq yes .
 442 .It Cm Port
 443 Specifies the port number to connect on the remote host.
 444 Default is 22.
 445 .It Cm PreferredAuthentications
 446 Specifies the order in which the client should try protocol 2
 447 authentication methods. This allows a client to prefer one method (e.g.
 448 .Cm keyboard-interactive )
 449 over another method (e.g.
 450 .Cm password )
 451 The default for this option is:
 452 .Dq hostbased,external-keyx,gssapi,publickey,keyboard-interactive,password .
 453 .It Cm Protocol
 454 Specifies the protocol versions
 455 .Nm ssh
 456 should support in order of preference.
 457 The possible values are
 458 .Dq 1
 459 and
 460 .Dq 2 .
 461 Multiple versions must be comma-separated.
 462 The default is
 463 .Dq 2,1 .
 464 This means that
 465 .Nm ssh
 466 tries version 2 and falls back to version 1
 467 if version 2 is not available.
 468 .It Cm ProxyCommand
 469 Specifies the command to use to connect to the server.
 470 The command
 471 string extends to the end of the line, and is executed with
 472 .Pa /bin/sh .
 473 In the command string,
 474 .Ql %h
 475 will be substituted by the host name to
 476 connect and
 477 .Ql %p
 478 by the port.
 479 The command can be basically anything,
 480 and should read from its standard input and write to its standard output.
 481 It should eventually connect an
 482 .Xr sshd 8
 483 server running on some machine, or execute
 484 .Ic sshd -i
 485 somewhere.
 486 Host key management will be done using the
 487 HostName of the host being connected (defaulting to the name typed by
 488 the user).
 489 Note that
 490 .Cm CheckHostIP
 491 is not available for connects with a proxy command.
 492 .Pp
 493 .It Cm PubkeyAuthentication
 494 Specifies whether to try public key authentication.
 495 The argument to this keyword must be
 496 .Dq yes
 497 or
 498 .Dq no .
 499 The default is
 500 .Dq yes .
 501 This option applies to protocol version 2 only.
 502 .It Cm RemoteForward
 503 Specifies that a TCP/IP port on the remote machine be forwarded over
 504 the secure channel to the specified host and port from the local machine.
 505 The first argument must be a port number, and the second must be
 506 .Ar host:port .
 507 IPv6 addresses can be specified with an alternative syntax:
 508 .Ar host/port .
 509 Multiple forwardings may be specified, and additional
 510 forwardings can be given on the command line.
 511 Only the superuser can forward privileged ports.
 512 .It Cm RhostsAuthentication
 513 Specifies whether to try rhosts based authentication.
 514 Note that this
 515 declaration only affects the client side and has no effect whatsoever
 516 on security.
 517 Most servers do not permit RhostsAuthentication because it
 518 is not secure (see
 519 .Cm RhostsRSAAuthentication ) .
 520 The argument to this keyword must be
 521 .Dq yes
 522 or
 523 .Dq no .
 524 The default is
 525 .Dq no .
 526 This option applies to protocol version 1 only.
 527 .It Cm RhostsRSAAuthentication
 528 Specifies whether to try rhosts based authentication with RSA host
 529 authentication.
 530 The argument must be
 531 .Dq yes
 532 or
 533 .Dq no .
 534 The default is
 535 .Dq no .
 536 This option applies to protocol version 1 only and requires
 537 .Nm ssh
 538 to be setuid root.
 539 .It Cm RSAAuthentication
 540 Specifies whether to try RSA authentication.
 541 The argument to this keyword must be
 542 .Dq yes
 543 or
 544 .Dq no .
 545 RSA authentication will only be
 546 attempted if the identity file exists, or an authentication agent is
 547 running.
 548 The default is
 549 .Dq yes .
 550 Note that this option applies to protocol version 1 only.
 551 .It Cm SmartcardDevice
 552 Specifies which smartcard device to use. The argument to this keyword is
 553 the device
 554 .Nm ssh
 555 should use to communicate with a smartcard used for storing the user's
 556 private RSA key. By default, no device is specified and smartcard support
 557 is not activated.
 558 .It Cm StrictHostKeyChecking
 559 If this flag is set to
 560 .Dq yes ,
 561 .Nm ssh
 562 will never automatically add host keys to the
 563 .Pa $HOME/.ssh/known_hosts
 564 file, and refuses to connect to hosts whose host key has changed.
 565 This provides maximum protection against trojan horse attacks,
 566 however, can be annoying when the
 567 .Pa /etc/ssh/ssh_known_hosts
 568 file is poorly maintained, or connections to new hosts are
 569 frequently made.
 570 This option forces the user to manually
 571 add all new hosts.
 572 If this flag is set to
 573 .Dq no ,
 574 .Nm ssh
 575 will automatically add new host keys to the
 576 user known hosts files.
 577 If this flag is set to
 578 .Dq ask ,
 579 new host keys
 580 will be added to the user known host files only after the user
 581 has confirmed that is what they really want to do, and
 582 .Nm ssh
 583 will refuse to connect to hosts whose host key has changed.
 584 The host keys of
 585 known hosts will be verified automatically in all cases.
 586 The argument must be
 587 .Dq yes ,
 588 .Dq no
 589 or
 590 .Dq ask .
 591 The default is
 592 .Dq ask .
 593 .It Cm UsePrivilegedPort
 594 Specifies whether to use a privileged port for outgoing connections.
 595 The argument must be
 596 .Dq yes
 597 or
 598 .Dq no .
 599 The default is
 600 .Dq no .
 601 Note that this option must be set to
 602 .Dq yes
 603 if
 604 .Cm RhostsAuthentication
 605 and
 606 .Cm RhostsRSAAuthentication
 607 authentications are needed with older servers.
 608 .It Cm User
 609 Specifies the user to log in as.
 610 This can be useful when a different user name is used on different machines.
 611 This saves the trouble of
 612 having to remember to give the user name on the command line.
 613 .It Cm UserKnownHostsFile
 614 Specifies a file to use for the user
 615 host key database instead of
 616 .Pa $HOME/.ssh/known_hosts .
 617 .It Cm XAuthLocation
 618 Specifies the location of the
 619 .Xr xauth 1
 620 program.
 621 The default is
 622 .Pa /usr/X11R6/bin/xauth .
 623 .El
 624 .Sh FILES
 625 .Bl -tag -width Ds
 626 .It Pa $HOME/.ssh/config
 627 This is the per-user configuration file.
 628 The format of this file is described above.
 629 This file is used by the
 630 .Nm ssh
 631 client.
 632 This file does not usually contain any sensitive information,
 633 but the recommended permissions are read/write for the user, and not
 634 accessible by others.
 635 .It Pa /etc/ssh/ssh_config
 636 Systemwide configuration file.
 637 This file provides defaults for those
 638 values that are not specified in the user's configuration file, and
 639 for those users who do not have a configuration file.
 640 This file must be world-readable.
 641 .El
 642 .Sh AUTHORS
 643 OpenSSH is a derivative of the original and free
 644 ssh 1.2.12 release by Tatu Ylonen.
 645 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
 646 Theo de Raadt and Dug Song
 647 removed many bugs, re-added newer features and
 648 created OpenSSH.
 649 Markus Friedl contributed the support for SSH
 650 protocol versions 1.5 and 2.0.
 651 .Sh SEE ALSO
 652 .Xr ssh 1