3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 .\" All rights reserved
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".
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.
17 .\" Redistribution and use in source and binary forms, with or without
18 .\" modification, are permitted provided that the following conditions
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.
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.
37 .\" $OpenBSD: ssh_config.5,v 1.108 2008/06/11 23:03:56 grunk Exp $
43 .Nd OpenSSH SSH client configuration files
46 .Nm /etc/ssh/ssh_config
49 obtains configuration data from the following sources in
52 .Bl -enum -offset indent -compact
56 user's configuration file
59 system-wide configuration file
60 .Pq Pa /etc/ssh/ssh_config
63 For each parameter, the first obtained value
65 The configuration files contain sections separated by
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.
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.
75 The configuration file has the following format:
77 Empty lines and lines starting with
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
85 the latter format is useful to avoid the need to quote whitespace
86 when specifying configuration options using the
93 Arguments may optionally be enclosed in double quotes
95 in order to represent arguments containing spaces.
98 keywords and their meanings are as follows (note that
99 keywords are case-insensitive and arguments are case-sensitive):
102 Restricts the following declarations (up to the next
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.
109 as a pattern can be used to provide global
110 defaults for all hosts.
113 argument given on the command line (i.e. the name is not converted to
114 a canonicalized host name before matching).
118 for more information on patterns.
120 Specifies which address family to use when connecting.
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.
140 Use the specified address on the local machine as the source address of
142 Only useful on systems with more than one address.
143 Note that this option does not work if
144 .Cm UsePrivilegedPort
147 .It Cm ChallengeResponseAuthentication
148 Specifies whether to use challenge-response authentication.
149 The argument to this keyword must be
156 If this flag is set to
159 will additionally check the host IP address in the
162 This allows ssh to detect if a host key changed due to DNS spoofing.
163 If the option is set to
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
170 the check will not be executed.
174 Specifies the cipher to use for encrypting the session
175 in protocol version 1.
183 is only supported in the
185 client for interoperability with legacy protocol 1 implementations
186 that do not support the
189 Its use is strongly discouraged due to cryptographic weaknesses.
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
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
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
220 This option is primarily useful when used from the
222 command line to clear port forwardings set in
223 configuration files, and is automatically set by
234 Specifies whether to use compression.
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
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.
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.
259 Enables the sharing of multiple sessions over a single network connection.
263 will listen for connections on a control socket specified using the
266 Additional sessions can connect to this socket using the same
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.
280 to listen for control connections, but require confirmation using the
282 program before they are accepted (see
288 ssh will continue without connecting to a master instance.
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.
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
303 The latter requires confirmation like the
307 Specify the path to the control socket used for connection sharing as described
310 section above or the string
312 to disable connection sharing.
315 will be substituted by the local host name,
317 will be substituted by the target host name,
321 by the remote login username.
322 It is recommended that any
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
335 .Oo Ar bind_address : Oc Ar port .
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
345 may be used to bind the connection to a specific address.
350 indicates that the listening port be bound for local use only, while an
353 indicates that the port should be available from all interfaces.
355 Currently the SOCKS4 and SOCKS5 protocols are supported, and
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
364 in the global client configuration file
365 .Pa /etc/ssh/ssh_config
366 enables the use of the helper program
369 .Cm HostbasedAuthentication .
376 This option should be placed in the non-hostspecific section.
379 for more information.
381 Sets the escape character (default:
383 The escape character can also
384 be set on the command line.
385 The argument should be a single character,
387 followed by a letter, or
389 to disable the escape
390 character entirely (making the connection transparent for binary
392 .It Cm ExitOnForwardFailure
395 should terminate the connection if it cannot set up all requested
396 dynamic, tunnel, local, and remote port forwardings.
404 Specifies whether the connection to the authentication agent (if any)
405 will be forwarded to the remote machine.
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.
421 Specifies whether X11 connections will be automatically redirected
422 over the secure channel and
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
438 .Cm ForwardX11Trusted
439 option is also enabled.
440 .It Cm ForwardX11Trusted
441 If this option is set to
443 remote X11 clients will have full access to the original X11 display.
445 If this option is set to
447 remote X11 clients will be considered untrusted and prevented
448 from stealing or tampering with data belonging to trusted X11
452 token used for the session will be set to expire after 20 minutes.
453 Remote clients will be refused access after this time.
458 See the X11 SECURITY extension specification for full details on
459 the restrictions imposed on untrusted clients.
461 Specifies whether remote hosts are allowed to connect to local
465 binds local port forwardings to the loopback address.
466 This prevents other remote hosts from connecting to forwarded ports.
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.
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.
485 Note that this option applies to protocol version 2 only.
486 .It Cm GSSAPIDelegateCredentials
487 Forward (delegate) credentials to the server.
490 Note that this option applies to protocol version 2 only.
491 .It Cm HashKnownHosts
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
500 but they do not reveal identifying information should the file's contents
504 Note that existing names and addresses in known hosts files
505 will not be converted automatically,
506 but may be manually hashed using
508 .It Cm HostbasedAuthentication
509 Specifies whether to try rhosts based authentication with public key
517 This option applies to protocol version 2 only and
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 .
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.
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
538 .It Cm IdentitiesOnly
541 should only use the authentication identity files configured in the
546 offers more identities.
547 The argument to this keyword must be
551 This option is intended for situations where ssh-agent
552 offers many different identities.
556 Specifies a file from which the user's RSA or DSA authentication identity
560 for protocol version 1, and
564 for protocol version 2.
565 Additionally, any identities represented by the authentication agent
566 will be used for authentication.
568 The file name may use the tilde
569 syntax to refer to a user's home directory or one of the following
572 (local user's home directory),
578 (remote host name) or
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
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:
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
609 This directive is ignored unless
610 .Cm PermitLocalCommand
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
617 .Oo Ar bind_address : Oc Ar port
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
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
634 may be used to bind the connection to a specific address.
639 indicates that the listening port be bound for local use only, while an
642 indicates that the port should be available from all interfaces.
644 Gives the verbosity level that is used when logging messages from
646 The possible values are:
647 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
649 DEBUG and DEBUG1 are equivalent.
650 DEBUG2 and DEBUG3 each specify higher levels of verbose output.
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.
658 .Bd -literal -offset indent
659 hmac-md5,hmac-sha1,umac-64@openssh.com,
660 hmac-ripemd160,hmac-sha1-96,hmac-md5-96
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
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.
676 .It Cm PasswordAuthentication
677 Specifies whether to use password authentication.
678 The argument to this keyword must be
684 .It Cm PermitLocalCommand
685 Allow local command execution via the
688 .Ic !\& Ns Ar command
698 Specifies the port number to connect on the remote host.
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.\&
707 The default for this option is:
708 .Do gssapi-with-mic ,
711 keyboard-interactive,
715 Specifies the protocol versions
717 should support in order of preference.
718 The possible values are
722 Multiple versions must be comma-separated.
726 tries version 2 and falls back to version 1
727 if version 2 is not available.
729 Specifies the command to use to connect to the server.
731 string extends to the end of the line, and is executed with
733 In the command string,
735 will be substituted by the host name to
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
743 server running on some machine, or execute
746 Host key management will be done using the
747 HostName of the host being connected (defaulting to the name typed by
749 Setting the command to
751 disables this option entirely.
754 is not available for connects with a proxy command.
756 This directive is useful in conjunction with
758 and its proxy support.
759 For example, the following directive would connect via an HTTP proxy at
761 .Bd -literal -offset 3n
762 ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
764 .It Cm PubkeyAuthentication
765 Specifies whether to try public key authentication.
766 The argument to this keyword must be
772 This option applies to protocol version 2 only.
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
781 to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
782 The default is between
786 depending on the cipher.
787 This option applies to protocol version 2 only.
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
793 .Oo Ar bind_address : Oc Ar port
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
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.
808 is not specified, the default is to only bind to loopback addresses.
813 or an empty string, then the forwarding is requested to listen on all
817 will only succeed if the server's
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
830 This option applies to protocol version 1 only and requires
833 .It Cm RSAAuthentication
834 Specifies whether to try RSA authentication.
835 The argument to this keyword must be
839 RSA authentication will only be
840 attempted if the identity file exists, or an authentication agent is
844 Note that this option applies to protocol version 1 only.
846 Specifies what variables from the local
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.
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
862 The default is not to send any environment variables.
866 for more information on patterns.
867 .It Cm ServerAliveCountMax
868 Sets the number of server alive messages (see below) which may be
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
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
883 The server alive mechanism is valuable when the client or
884 server depend on knowing when a connection has become inactive.
886 The default value is 3.
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
898 will send a message through the encrypted
899 channel to request a response from the server.
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
907 should use to communicate with a smartcard used for storing the user's
909 By default, no device is specified and smartcard support is not activated.
910 .It Cm StrictHostKeyChecking
911 If this flag is set to
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
922 This option forces the user to manually
924 If this flag is set to
926 ssh will automatically add new host keys to the
927 user known hosts files.
928 If this flag is set to
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.
935 known hosts will be verified automatically in all cases.
944 Specifies whether the system should send TCP keepalive messages to the
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
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.
958 To disable TCP keepalive messages, the value should be set to
963 device forwarding between the client and the server.
974 requests the default tunnel mode, which is
981 devices to open on the client
988 .Ar local_tun Op : Ar remote_tun .
990 The devices may be specified by numerical ID or the keyword
992 which uses the next available tunnel device.
995 is not specified, it defaults to
999 .It Cm UsePrivilegedPort
1000 Specifies whether to use a privileged port for outgoing connections.
1001 The argument must be
1010 must be setuid root.
1011 Note that this option must be set to
1014 .Cm RhostsRSAAuthentication
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
1028 If this option is set to
1030 the client will implicitly trust keys that match a secure fingerprint
1032 Insecure fingerprints will be handled as if this option was set to
1034 If this option is set to
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
1040 The argument must be
1047 Note that this option applies to protocol version 2 only.
1050 .Sx VERIFYING HOST KEYS
1053 .It Cm XAuthLocation
1054 Specifies the full pathname of the
1058 .Pa /usr/X11R6/bin/xauth .
1063 consists of zero or more non-whitespace characters,
1065 (a wildcard that matches zero or more characters),
1068 (a wildcard that matches exactly one character).
1069 For example, to specify a set of declarations for any host in the
1072 the following pattern could be used:
1076 The following pattern
1077 would match any host in the 192.168.0.[0-9] network range:
1079 .Dl Host 192.168.0.?
1083 is a comma-separated list of patterns.
1084 Patterns within pattern-lists may be negated
1085 by preceding them with an exclamation mark
1088 to allow a key to be used from anywhere within an organisation
1092 the following entry (in authorized_keys) could be used:
1094 .Dl from=\&"!*.dialup.example.com,*.example.com\&"
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.
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
1119 Markus Friedl contributed the support for SSH
1120 protocol versions 1.5 and 2.0.
andersk / openssh.git / blob