2 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
3 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 .\" All rights reserved
6 .\" As far as I am concerned, the code I have written for this software
7 .\" can be used freely for any purpose. Any derived versions of this
8 .\" software must be clearly marked as such, and if the derived work is
9 .\" incompatible with the protocol description in the RFC file, it must be
10 .\" called by a name other than "ssh" or "Secure Shell".
12 .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
13 .\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
14 .\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
16 .\" Redistribution and use in source and binary forms, with or without
17 .\" modification, are permitted provided that the following conditions
19 .\" 1. Redistributions of source code must retain the above copyright
20 .\" notice, this list of conditions and the following disclaimer.
21 .\" 2. Redistributions in binary form must reproduce the above copyright
22 .\" notice, this list of conditions and the following disclaimer in the
23 .\" documentation and/or other materials provided with the distribution.
25 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 .\" $OpenBSD: ssh_config.5,v 1.228 2016/02/20 23:01:46 sobrado Exp $
38 .Dd $Mdocdate: February 20 2016 $
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 usually the one given on the command line
71 .Cm CanonicalizeHostname
72 option for exceptions.)
74 Since the first obtained value for each parameter is used, more
75 host-specific declarations should be given near the beginning of the
76 file, and general defaults at the end.
78 The configuration file has the following format:
80 Empty lines and lines starting with
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
88 the latter format is useful to avoid the need to quote whitespace
89 when specifying configuration options using the
96 Arguments may optionally be enclosed in double quotes
98 in order to represent arguments containing spaces.
101 keywords and their meanings are as follows (note that
102 keywords are case-insensitive and arguments are case-sensitive):
105 Restricts the following declarations (up to the next
109 keyword) to be only for those hosts that match one of the patterns
110 given after the keyword.
111 If more than one pattern is provided, they should be separated by whitespace.
114 as a pattern can be used to provide global
115 defaults for all hosts.
116 The host is usually the
118 argument given on the command line
120 .Cm CanonicalizeHostname
121 option for exceptions.)
123 A pattern entry may be negated by prefixing it with an exclamation mark
125 If a negated entry is matched, then the
127 entry is ignored, regardless of whether any other patterns on the line
129 Negated matches are therefore useful to provide exceptions for wildcard
134 for more information on patterns.
136 Restricts the following declarations (up to the next
140 keyword) to be used only when the conditions following the
142 keyword are satisfied.
143 Match conditions are specified using one or more criteria
146 which always matches.
147 The available criteria keywords are:
157 criteria must appear alone or immediately after
159 Other criteria may be combined arbitrarily.
165 Criteria may be negated by prepending an exclamation mark
170 keyword matches only when the configuration file is being re-parsed
171 after hostname canonicalization (see the
172 .Cm CanonicalizeHostname
174 This may be useful to specify conditions that work with canonical host
178 keyword executes the specified command under the user's shell.
179 If the command returns a zero exit status then the condition is considered true.
180 Commands containing whitespace characters must be quoted.
181 The following character sequences in the command will be expanded prior to
184 will be substituted by the first component of the local host name,
186 will be substituted by the local host name (including any domain name),
188 will be substituted by the target host name,
190 will be substituted by the original target host name
191 specified on the command-line,
193 the destination port,
195 by the remote login username, and
197 by the username of the user running
200 The other keywords' criteria must be single entries or comma-separated
201 lists and may use the wildcard and negation operators described in the
206 keyword are matched against the target hostname, after any substitution
210 .Cm CanonicalizeHostname
214 keyword matches against the hostname as it was specified on the command-line.
217 keyword matches against the target username on the remote host.
220 keyword matches against the name of the local user running
222 (this keyword may be useful in system-wide
225 .It Cm AddKeysToAgent
226 Specifies whether keys should be automatically added to a running
228 If this option is set to
230 and a key is loaded from a file, the key and its passphrase are added to
231 the agent with the default lifetime, as if by
233 If this option is set to
236 will require confirmation using the
238 program before adding a key (see
241 If this option is set to
243 each use of the key must be confirmed, as if the
245 option was specified to
247 If this option is set to
249 no keys are added to the agent.
259 Specifies which address family to use when connecting.
271 passphrase/password querying will be disabled.
272 This option is useful in scripts and other batch jobs where no user
273 is present to supply the password.
281 Use the specified address on the local machine as the source address of
283 Only useful on systems with more than one address.
284 Note that this option does not work if
285 .Cm UsePrivilegedPort
288 .It Cm CanonicalDomains
290 .Cm CanonicalizeHostname
291 is enabled, this option specifies the list of domain suffixes in which to
292 search for the specified destination host.
293 .It Cm CanonicalizeFallbackLocal
294 Specifies whether to fail with an error when hostname canonicalization fails.
297 will attempt to look up the unqualified hostname using the system resolver's
304 .Cm CanonicalizeHostname
305 is enabled and the target hostname cannot be found in any of the domains
307 .Cm CanonicalDomains .
308 .It Cm CanonicalizeHostname
309 Controls whether explicit hostname canonicalization is performed.
312 is not to perform any name rewriting and let the system resolver handle all
316 then, for connections that do not use a
319 will attempt to canonicalize the hostname specified on the command line
323 .Cm CanonicalizePermittedCNAMEs
326 .Cm CanonicalizeHostname
329 then canonicalization is applied to proxied connections too.
331 If this option is enabled, then the configuration files are processed
332 again using the new target name to pick up any new configuration in matching
337 .It Cm CanonicalizeMaxDots
338 Specifies the maximum number of dot characters in a hostname before
339 canonicalization is disabled.
342 allows a single dot (i.e. hostname.subdomain).
343 .It Cm CanonicalizePermittedCNAMEs
344 Specifies rules to determine whether CNAMEs should be followed when
345 canonicalizing hostnames.
346 The rules consist of one or more arguments of
347 .Ar source_domain_list : Ns Ar target_domain_list ,
349 .Ar source_domain_list
350 is a pattern-list of domains that may follow CNAMEs in canonicalization,
352 .Ar target_domain_list
353 is a pattern-list of domains that they may resolve to.
356 .Dq *.a.example.com:*.b.example.com,*.c.example.com
357 will allow hostnames matching
359 to be canonicalized to names in the
364 .It Cm CertificateFile
365 Specifies a file from which the user's certificate is read.
366 A corresponding private key must be provided separately in order
367 to use this certificate either
379 The file name may use the tilde
380 syntax to refer to a user's home directory or one of the following
383 (local user's home directory),
389 (remote host name) or
393 It is possible to have multiple certificate files specified in
394 configuration files; these certificates will be tried in sequence.
397 directives will add to the list of certificates used for
399 .It Cm ChallengeResponseAuthentication
400 Specifies whether to use challenge-response authentication.
401 The argument to this keyword must be
408 If this flag is set to
411 will additionally check the host IP address in the
414 This allows ssh to detect if a host key changed due to DNS spoofing
415 and will add addresses of destination hosts to
416 .Pa ~/.ssh/known_hosts
417 in the process, regardless of the setting of
418 .Cm StrictHostKeyChecking .
419 If the option is set to
421 the check will not be executed.
425 Specifies the cipher to use for encrypting the session
426 in protocol version 1.
434 is only supported in the
436 client for interoperability with legacy protocol 1 implementations
437 that do not support the
440 Its use is strongly discouraged due to cryptographic weaknesses.
444 Specifies the ciphers allowed for protocol version 2
445 in order of preference.
446 Multiple ciphers must be comma-separated.
447 If the specified value begins with a
449 character, then the specified ciphers will be appended to the default set
450 instead of replacing them.
452 The supported ciphers are:
454 .Bl -item -compact -offset indent
470 aes128-gcm@openssh.com
472 aes256-gcm@openssh.com
484 chacha20-poly1305@openssh.com
488 .Bd -literal -offset indent
489 chacha20-poly1305@openssh.com,
490 aes128-ctr,aes192-ctr,aes256-ctr,
491 aes128-gcm@openssh.com,aes256-gcm@openssh.com,
492 aes128-cbc,aes192-cbc,aes256-cbc,3des-cbc
495 The list of available ciphers may also be obtained using the
501 .It Cm ClearAllForwardings
502 Specifies that all local, remote, and dynamic port forwardings
503 specified in the configuration files or on the command line be
505 This option is primarily useful when used from the
507 command line to clear port forwardings set in
508 configuration files, and is automatically set by
519 Specifies whether to use compression.
526 .It Cm CompressionLevel
527 Specifies the compression level to use if compression is enabled.
528 The argument must be an integer from 1 (fast) to 9 (slow, best).
529 The default level is 6, which is good for most applications.
530 The meaning of the values is the same as in
532 Note that this option applies to protocol version 1 only.
533 .It Cm ConnectionAttempts
534 Specifies the number of tries (one per second) to make before exiting.
535 The argument must be an integer.
536 This may be useful in scripts if the connection sometimes fails.
538 .It Cm ConnectTimeout
539 Specifies the timeout (in seconds) used when connecting to the
540 SSH server, instead of using the default system TCP timeout.
541 This value is used only when the target is down or really unreachable,
542 not when it refuses the connection.
544 Enables the sharing of multiple sessions over a single network connection.
548 will listen for connections on a control socket specified using the
551 Additional sessions can connect to this socket using the same
558 These sessions will try to reuse the master instance's network connection
559 rather than initiating new ones, but will fall back to connecting normally
560 if the control socket does not exist, or is not listening.
565 to listen for control connections, but require confirmation using
570 ssh will continue without connecting to a master instance.
574 forwarding is supported over these multiplexed connections, however the
575 display and agent forwarded will be the one belonging to the master
576 connection i.e. it is not possible to forward multiple displays or agents.
578 Two additional options allow for opportunistic multiplexing: try to use a
579 master connection but fall back to creating a new one if one does not already
585 The latter requires confirmation like the
589 Specify the path to the control socket used for connection sharing as described
592 section above or the string
594 to disable connection sharing.
597 will be substituted by the first component of the local host name,
599 will be substituted by the local host name (including any domain name),
601 will be substituted by the target host name,
603 will be substituted by the original target host name
604 specified on the command line,
606 the destination port,
608 by the remote login username,
612 by the numeric user ID (uid) of the user running
616 by a hash of the concatenation: %l%h%p%r.
617 It is recommended that any
619 used for opportunistic connection sharing include
620 at least %h, %p, and %r (or alternatively %C) and be placed in a directory
621 that is not writable by other users.
622 This ensures that shared connections are uniquely identified.
623 .It Cm ControlPersist
624 When used in conjunction with
626 specifies that the master connection should remain open
627 in the background (waiting for future client connections)
628 after the initial client connection has been closed.
631 then the master connection will not be placed into the background,
632 and will close as soon as the initial client connection is closed.
637 then the master connection will remain in the background indefinitely
638 (until killed or closed via a mechanism such as the
642 If set to a time in seconds, or a time in any of the formats documented in
644 then the backgrounded master connection will automatically terminate
645 after it has remained idle (with no client connections) for the
647 .It Cm DynamicForward
648 Specifies that a TCP port on the local machine be forwarded
649 over the secure channel, and the application
650 protocol is then used to determine where to connect to from the
655 .Oo Ar bind_address : Oc Ar port .
657 IPv6 addresses can be specified by enclosing addresses in square brackets.
658 By default, the local port is bound in accordance with the
663 may be used to bind the connection to a specific address.
668 indicates that the listening port be bound for local use only, while an
671 indicates that the port should be available from all interfaces.
673 Currently the SOCKS4 and SOCKS5 protocols are supported, and
675 will act as a SOCKS server.
676 Multiple forwardings may be specified, and
677 additional forwardings can be given on the command line.
678 Only the superuser can forward privileged ports.
679 .It Cm EnableSSHKeysign
680 Setting this option to
682 in the global client configuration file
683 .Pa /etc/ssh/ssh_config
684 enables the use of the helper program
687 .Cm HostbasedAuthentication .
694 This option should be placed in the non-hostspecific section.
697 for more information.
699 Sets the escape character (default:
701 The escape character can also
702 be set on the command line.
703 The argument should be a single character,
705 followed by a letter, or
707 to disable the escape
708 character entirely (making the connection transparent for binary
710 .It Cm ExitOnForwardFailure
713 should terminate the connection if it cannot set up all requested
714 dynamic, tunnel, local, and remote port forwardings, (e.g.\&
715 if either end is unable to bind and listen on a specified port).
717 .Cm ExitOnForwardFailure
718 does not apply to connections made over port forwardings and will not,
721 to exit if TCP connections to the ultimate forwarding destination fail.
728 .It Cm FingerprintHash
729 Specifies the hash algorithm used when displaying key fingerprints.
737 Specifies whether the connection to the authentication agent (if any)
738 will be forwarded to the remote machine.
746 Agent forwarding should be enabled with caution.
747 Users with the ability to bypass file permissions on the remote host
748 (for the agent's Unix-domain socket)
749 can access the local agent through the forwarded connection.
750 An attacker cannot obtain key material from the agent,
751 however they can perform operations on the keys that enable them to
752 authenticate using the identities loaded into the agent.
754 Specifies whether X11 connections will be automatically redirected
755 over the secure channel and
765 X11 forwarding should be enabled with caution.
766 Users with the ability to bypass file permissions on the remote host
767 (for the user's X11 authorization database)
768 can access the local X11 display through the forwarded connection.
769 An attacker may then be able to perform activities such as keystroke monitoring
771 .Cm ForwardX11Trusted
772 option is also enabled.
773 .It Cm ForwardX11Timeout
774 Specify a timeout for untrusted X11 forwarding
775 using the format described in the
776 TIME FORMATS section of
778 X11 connections received by
780 after this time will be refused.
781 The default is to disable untrusted X11 forwarding after twenty minutes has
783 .It Cm ForwardX11Trusted
784 If this option is set to
786 remote X11 clients will have full access to the original X11 display.
788 If this option is set to
790 remote X11 clients will be considered untrusted and prevented
791 from stealing or tampering with data belonging to trusted X11
795 token used for the session will be set to expire after 20 minutes.
796 Remote clients will be refused access after this time.
801 See the X11 SECURITY extension specification for full details on
802 the restrictions imposed on untrusted clients.
804 Specifies whether remote hosts are allowed to connect to local
808 binds local port forwardings to the loopback address.
809 This prevents other remote hosts from connecting to forwarded ports.
811 can be used to specify that ssh
812 should bind local port forwardings to the wildcard address,
813 thus allowing remote hosts to connect to forwarded ports.
820 .It Cm GlobalKnownHostsFile
821 Specifies one or more files to use for the global
822 host key database, separated by whitespace.
824 .Pa /etc/ssh/ssh_known_hosts ,
825 .Pa /etc/ssh/ssh_known_hosts2 .
826 .It Cm GSSAPIAuthentication
827 Specifies whether user authentication based on GSSAPI is allowed.
830 .It Cm GSSAPIDelegateCredentials
831 Forward (delegate) credentials to the server.
834 .It Cm HashKnownHosts
837 should hash host names and addresses when they are added to
838 .Pa ~/.ssh/known_hosts .
839 These hashed names may be used normally by
843 but they do not reveal identifying information should the file's contents
847 Note that existing names and addresses in known hosts files
848 will not be converted automatically,
849 but may be manually hashed using
851 .It Cm HostbasedAuthentication
852 Specifies whether to try rhosts based authentication with public key
860 .It Cm HostbasedKeyTypes
861 Specifies the key types that will be used for hostbased authentication
862 as a comma-separated pattern list.
863 Alternately if the specified value begins with a
865 character, then the specified key types will be appended to the default set
866 instead of replacing them.
867 The default for this option is:
868 .Bd -literal -offset 3n
869 ecdsa-sha2-nistp256-cert-v01@openssh.com,
870 ecdsa-sha2-nistp384-cert-v01@openssh.com,
871 ecdsa-sha2-nistp521-cert-v01@openssh.com,
872 ssh-ed25519-cert-v01@openssh.com,
873 ssh-rsa-cert-v01@openssh.com,
874 ssh-dss-cert-v01@openssh.com,
875 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,
876 ecdsa-sha2-nistp521,ssh-ed25519,
884 may be used to list supported key types.
885 .It Cm HostKeyAlgorithms
886 Specifies the host key algorithms
887 that the client wants to use in order of preference.
888 Alternately if the specified value begins with a
890 character, then the specified key types will be appended to the default set
891 instead of replacing them.
892 The default for this option is:
893 .Bd -literal -offset 3n
894 ecdsa-sha2-nistp256-cert-v01@openssh.com,
895 ecdsa-sha2-nistp384-cert-v01@openssh.com,
896 ecdsa-sha2-nistp521-cert-v01@openssh.com,
897 ssh-ed25519-cert-v01@openssh.com,
898 ssh-rsa-cert-v01@openssh.com,
899 ssh-dss-cert-v01@openssh.com,
900 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,
901 ecdsa-sha2-nistp521,ssh-ed25519,
905 If hostkeys are known for the destination host then this default is modified
906 to prefer their algorithms.
908 The list of available key types may also be obtained using the
915 Specifies an alias that should be used instead of the
916 real host name when looking up or saving the host key
917 in the host key database files.
918 This option is useful for tunneling SSH connections
919 or for multiple servers running on a single host.
921 Specifies the real host name to log into.
922 This can be used to specify nicknames or abbreviations for hosts.
923 If the hostname contains the character sequence
925 then this will be replaced with the host name specified on the command line
926 (this is useful for manipulating unqualified names).
927 The character sequence
929 will be replaced by a single
931 character, which may be used when specifying IPv6 link-local addresses.
933 The default is the name given on the command line.
934 Numeric IP addresses are also permitted (both on the command line and in
937 .It Cm IdentitiesOnly
940 should only use the authentication identity and certificate files explicitly
951 offers more identities.
952 The argument to this keyword must be
956 This option is intended for situations where ssh-agent
957 offers many different identities.
961 Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication
965 for protocol version 1, and
967 .Pa ~/.ssh/id_ecdsa ,
968 .Pa ~/.ssh/id_ed25519
971 for protocol version 2.
972 Additionally, any identities represented by the authentication agent
973 will be used for authentication unless
976 If no certificates have been explicitly specified by
977 .Cm CertificateFile ,
979 will try to load certificate information from the filename obtained by
982 to the path of a specified
985 The file name may use the tilde
986 syntax to refer to a user's home directory or one of the following
989 (local user's home directory),
995 (remote host name) or
999 It is possible to have
1000 multiple identity files specified in configuration files; all these
1001 identities will be tried in sequence.
1004 directives will add to the list of identities tried (this behaviour
1005 differs from that of other configuration directives).
1008 may be used in conjunction with
1010 to select which identities in an agent are offered during authentication.
1012 may also be used in conjunction with
1014 in order to provide any certificate also needed for authentication with
1016 .It Cm IgnoreUnknown
1017 Specifies a pattern-list of unknown options to be ignored if they are
1018 encountered in configuration parsing.
1019 This may be used to suppress errors if
1021 contains options that are unrecognised by
1023 It is recommended that
1025 be listed early in the configuration file as it will not be applied
1026 to unknown options that appear before it.
1028 Specifies the IPv4 type-of-service or DSCP class for connections.
1055 This option may take one or two arguments, separated by whitespace.
1056 If one argument is specified, it is used as the packet class unconditionally.
1057 If two values are specified, the first is automatically selected for
1058 interactive sessions and the second for non-interactive sessions.
1061 for interactive sessions and
1063 for non-interactive sessions.
1064 .It Cm KbdInteractiveAuthentication
1065 Specifies whether to use keyboard-interactive authentication.
1066 The argument to this keyword must be
1072 .It Cm KbdInteractiveDevices
1073 Specifies the list of methods to use in keyboard-interactive authentication.
1074 Multiple method names must be comma-separated.
1075 The default is to use the server specified list.
1076 The methods available vary depending on what the server supports.
1077 For an OpenSSH server,
1078 it may be zero or more of:
1083 .It Cm KexAlgorithms
1084 Specifies the available KEX (Key Exchange) algorithms.
1085 Multiple algorithms must be comma-separated.
1086 Alternately if the specified value begins with a
1088 character, then the specified methods will be appended to the default set
1089 instead of replacing them.
1091 .Bd -literal -offset indent
1092 curve25519-sha256@libssh.org,
1093 ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1094 diffie-hellman-group-exchange-sha256,
1095 diffie-hellman-group-exchange-sha1,
1096 diffie-hellman-group14-sha1
1099 The list of available key exchange algorithms may also be obtained using the
1106 Specifies a command to execute on the local machine after successfully
1107 connecting to the server.
1108 The command string extends to the end of the line, and is executed with
1110 The following escape character substitutions will be performed:
1112 (local user's home directory),
1118 (host name as provided on the command line),
1122 (remote user name) or
1124 (local user name) or
1126 by a hash of the concatenation: %l%h%p%r.
1128 The command is run synchronously and does not have access to the
1132 It should not be used for interactive commands.
1134 This directive is ignored unless
1135 .Cm PermitLocalCommand
1138 Specifies that a TCP port on the local machine be forwarded over
1139 the secure channel to the specified host and port from the remote machine.
1140 The first argument must be
1142 .Oo Ar bind_address : Oc Ar port
1144 and the second argument must be
1145 .Ar host : Ns Ar hostport .
1146 IPv6 addresses can be specified by enclosing addresses in square brackets.
1147 Multiple forwardings may be specified, and additional forwardings can be
1148 given on the command line.
1149 Only the superuser can forward privileged ports.
1150 By default, the local port is bound in accordance with the
1153 However, an explicit
1155 may be used to bind the connection to a specific address.
1160 indicates that the listening port be bound for local use only, while an
1163 indicates that the port should be available from all interfaces.
1165 Gives the verbosity level that is used when logging messages from
1167 The possible values are:
1168 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
1169 The default is INFO.
1170 DEBUG and DEBUG1 are equivalent.
1171 DEBUG2 and DEBUG3 each specify higher levels of verbose output.
1173 Specifies the MAC (message authentication code) algorithms
1174 in order of preference.
1175 The MAC algorithm is used for data integrity protection.
1176 Multiple algorithms must be comma-separated.
1177 If the specified value begins with a
1179 character, then the specified algorithms will be appended to the default set
1180 instead of replacing them.
1182 The algorithms that contain
1184 calculate the MAC after encryption (encrypt-then-mac).
1185 These are considered safer and their use recommended.
1188 .Bd -literal -offset indent
1189 umac-64-etm@openssh.com,umac-128-etm@openssh.com,
1190 hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
1191 hmac-sha1-etm@openssh.com,
1192 umac-64@openssh.com,umac-128@openssh.com,
1193 hmac-sha2-256,hmac-sha2-512,hmac-sha1
1196 The list of available MAC algorithms may also be obtained using the
1202 .It Cm NoHostAuthenticationForLocalhost
1203 This option can be used if the home directory is shared across machines.
1204 In this case localhost will refer to a different machine on each of
1205 the machines and the user will get many warnings about changed host keys.
1206 However, this option disables host authentication for localhost.
1207 The argument to this keyword must be
1211 The default is to check the host key for localhost.
1212 .It Cm NumberOfPasswordPrompts
1213 Specifies the number of password prompts before giving up.
1214 The argument to this keyword must be an integer.
1216 .It Cm PasswordAuthentication
1217 Specifies whether to use password authentication.
1218 The argument to this keyword must be
1224 .It Cm PermitLocalCommand
1225 Allow local command execution via the
1228 .Ic !\& Ns Ar command
1231 The argument must be
1237 .It Cm PKCS11Provider
1238 Specifies which PKCS#11 provider to use.
1239 The argument to this keyword is the PKCS#11 shared library
1241 should use to communicate with a PKCS#11 token providing the user's
1244 Specifies the port number to connect on the remote host.
1246 .It Cm PreferredAuthentications
1247 Specifies the order in which the client should try authentication methods.
1248 This allows a client to prefer one method (e.g.\&
1249 .Cm keyboard-interactive )
1250 over another method (e.g.\&
1253 .Bd -literal -offset indent
1254 gssapi-with-mic,hostbased,publickey,
1255 keyboard-interactive,password
1258 Specifies the protocol versions
1260 should support in order of preference.
1261 The possible values are
1265 Multiple versions must be comma-separated.
1266 When this option is set to
1269 will try version 2 and fall back to version 1
1270 if version 2 is not available.
1273 Protocol 1 suffers from a number of cryptographic weaknesses and should
1275 It is only offered to support legacy devices.
1277 Specifies the command to use to connect to the server.
1279 string extends to the end of the line, and is executed
1280 using the user's shell
1282 directive to avoid a lingering shell process.
1284 In the command string, any occurrence of
1286 will be substituted by the host name to
1291 by the remote user name.
1292 The command can be basically anything,
1293 and should read from its standard input and write to its standard output.
1294 It should eventually connect an
1296 server running on some machine, or execute
1299 Host key management will be done using the
1300 HostName of the host being connected (defaulting to the name typed by
1302 Setting the command to
1304 disables this option entirely.
1307 is not available for connects with a proxy command.
1309 This directive is useful in conjunction with
1311 and its proxy support.
1312 For example, the following directive would connect via an HTTP proxy at
1314 .Bd -literal -offset 3n
1315 ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
1317 .It Cm ProxyUseFdpass
1320 will pass a connected file descriptor back to
1322 instead of continuing to execute and pass data.
1325 .It Cm PubkeyAcceptedKeyTypes
1326 Specifies the key types that will be used for public key authentication
1327 as a comma-separated pattern list.
1328 Alternately if the specified value begins with a
1330 character, then the key types after it will be appended to the default
1331 instead of replacing it.
1332 The default for this option is:
1333 .Bd -literal -offset 3n
1334 ecdsa-sha2-nistp256-cert-v01@openssh.com,
1335 ecdsa-sha2-nistp384-cert-v01@openssh.com,
1336 ecdsa-sha2-nistp521-cert-v01@openssh.com,
1337 ssh-ed25519-cert-v01@openssh.com,
1338 ssh-rsa-cert-v01@openssh.com,
1339 ssh-dss-cert-v01@openssh.com,
1340 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,
1341 ecdsa-sha2-nistp521,ssh-ed25519,
1349 may be used to list supported key types.
1350 .It Cm PubkeyAuthentication
1351 Specifies whether to try public key authentication.
1352 The argument to this keyword must be
1359 Specifies the maximum amount of data that may be transmitted before the
1360 session key is renegotiated, optionally followed a maximum amount of
1361 time that may pass before the session key is renegotiated.
1362 The first argument is specified in bytes and may have a suffix of
1367 to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1368 The default is between
1372 depending on the cipher.
1373 The optional second value is specified in seconds and may use any of the
1374 units documented in the
1375 TIME FORMATS section of
1377 The default value for
1381 which means that rekeying is performed after the cipher's default amount
1382 of data has been sent or received and no time based rekeying is done.
1383 .It Cm RemoteForward
1384 Specifies that a TCP port on the remote machine be forwarded over
1385 the secure channel to the specified host and port from the local machine.
1386 The first argument must be
1388 .Oo Ar bind_address : Oc Ar port
1390 and the second argument must be
1391 .Ar host : Ns Ar hostport .
1392 IPv6 addresses can be specified by enclosing addresses in square brackets.
1393 Multiple forwardings may be specified, and additional
1394 forwardings can be given on the command line.
1395 Privileged ports can be forwarded only when
1396 logging in as root on the remote machine.
1402 the listen port will be dynamically allocated on the server and reported
1403 to the client at run time.
1407 is not specified, the default is to only bind to loopback addresses.
1412 or an empty string, then the forwarding is requested to listen on all
1416 will only succeed if the server's
1418 option is enabled (see
1419 .Xr sshd_config 5 ) .
1421 Specifies whether to request a pseudo-tty for the session.
1422 The argument may be one of:
1424 (never request a TTY),
1426 (always request a TTY when standard input is a TTY),
1428 (always request a TTY) or
1430 (request a TTY when opening a login session).
1431 This option mirrors the
1437 .It Cm RevokedHostKeys
1438 Specifies revoked host public keys.
1439 Keys listed in this file will be refused for host authentication.
1440 Note that if this file does not exist or is not readable,
1441 then host authentication will be refused for all hosts.
1442 Keys may be specified as a text file, listing one public key per line, or as
1443 an OpenSSH Key Revocation List (KRL) as generated by
1445 For more information on KRLs, see the KEY REVOCATION LISTS section in
1447 .It Cm RhostsRSAAuthentication
1448 Specifies whether to try rhosts based authentication with RSA host
1450 The argument must be
1456 This option applies to protocol version 1 only and requires
1459 .It Cm RSAAuthentication
1460 Specifies whether to try RSA authentication.
1461 The argument to this keyword must be
1465 RSA authentication will only be
1466 attempted if the identity file exists, or an authentication agent is
1470 Note that this option applies to protocol version 1 only.
1472 Specifies what variables from the local
1474 should be sent to the server.
1475 The server must also support it, and the server must be configured to
1476 accept these environment variables.
1479 environment variable is always sent whenever a
1480 pseudo-terminal is requested as it is required by the protocol.
1485 for how to configure the server.
1486 Variables are specified by name, which may contain wildcard characters.
1487 Multiple environment variables may be separated by whitespace or spread
1491 The default is not to send any environment variables.
1495 for more information on patterns.
1496 .It Cm ServerAliveCountMax
1497 Sets the number of server alive messages (see below) which may be
1500 receiving any messages back from the server.
1501 If this threshold is reached while server alive messages are being sent,
1502 ssh will disconnect from the server, terminating the session.
1503 It is important to note that the use of server alive messages is very
1507 The server alive messages are sent through the encrypted channel
1508 and therefore will not be spoofable.
1509 The TCP keepalive option enabled by
1512 The server alive mechanism is valuable when the client or
1513 server depend on knowing when a connection has become inactive.
1515 The default value is 3.
1517 .Cm ServerAliveInterval
1518 (see below) is set to 15 and
1519 .Cm ServerAliveCountMax
1520 is left at the default, if the server becomes unresponsive,
1521 ssh will disconnect after approximately 45 seconds.
1522 .It Cm ServerAliveInterval
1523 Sets a timeout interval in seconds after which if no data has been received
1526 will send a message through the encrypted
1527 channel to request a response from the server.
1529 is 0, indicating that these messages will not be sent to the server.
1530 .It Cm StreamLocalBindMask
1531 Sets the octal file creation mode mask
1533 used when creating a Unix-domain socket file for local or remote
1535 This option is only used for port forwarding to a Unix-domain socket file.
1537 The default value is 0177, which creates a Unix-domain socket file that is
1538 readable and writable only by the owner.
1539 Note that not all operating systems honor the file mode on Unix-domain
1541 .It Cm StreamLocalBindUnlink
1542 Specifies whether to remove an existing Unix-domain socket file for local
1543 or remote port forwarding before creating a new one.
1544 If the socket file already exists and
1545 .Cm StreamLocalBindUnlink
1548 will be unable to forward the port to the Unix-domain socket file.
1549 This option is only used for port forwarding to a Unix-domain socket file.
1551 The argument must be
1557 .It Cm StrictHostKeyChecking
1558 If this flag is set to
1561 will never automatically add host keys to the
1562 .Pa ~/.ssh/known_hosts
1563 file, and refuses to connect to hosts whose host key has changed.
1564 This provides maximum protection against trojan horse attacks,
1565 though it can be annoying when the
1566 .Pa /etc/ssh/ssh_known_hosts
1567 file is poorly maintained or when connections to new hosts are
1569 This option forces the user to manually
1571 If this flag is set to
1573 ssh will automatically add new host keys to the
1574 user known hosts files.
1575 If this flag is set to
1578 will be added to the user known host files only after the user
1579 has confirmed that is what they really want to do, and
1580 ssh will refuse to connect to hosts whose host key has changed.
1582 known hosts will be verified automatically in all cases.
1583 The argument must be
1591 Specifies whether the system should send TCP keepalive messages to the
1593 If they are sent, death of the connection or crash of one
1594 of the machines will be properly noticed.
1595 However, this means that
1596 connections will die if the route is down temporarily, and some people
1601 (to send TCP keepalive messages), and the client will notice
1602 if the network goes down or the remote host dies.
1603 This is important in scripts, and many users want it too.
1605 To disable TCP keepalive messages, the value should be set to
1610 device forwarding between the client and the server.
1611 The argument must be
1621 requests the default tunnel mode, which is
1622 .Dq point-to-point .
1628 devices to open on the client
1633 The argument must be
1635 .Ar local_tun Op : Ar remote_tun .
1637 The devices may be specified by numerical ID or the keyword
1639 which uses the next available tunnel device.
1642 is not specified, it defaults to
1646 .It Cm UpdateHostKeys
1649 should accept notifications of additional hostkeys from the server sent
1650 after authentication has completed and add them to
1651 .Cm UserKnownHostsFile .
1652 The argument must be
1657 Enabling this option allows learning alternate hostkeys for a server
1658 and supports graceful key rotation by allowing a server to send replacement
1659 public keys before old ones are removed.
1660 Additional hostkeys are only accepted if the key used to authenticate the
1661 host was already trusted or explicitly accepted by the user.
1666 then the user is asked to confirm the modifications to the known_hosts file.
1667 Confirmation is currently incompatible with
1668 .Cm ControlPersist ,
1669 and will be disabled if it is enabled.
1673 from OpenSSH 6.8 and greater support the
1674 .Dq hostkeys@openssh.com
1675 protocol extension used to inform the client of all the server's hostkeys.
1676 .It Cm UsePrivilegedPort
1677 Specifies whether to use a privileged port for outgoing connections.
1678 The argument must be
1687 must be setuid root.
1688 Note that this option must be set to
1691 .Cm RhostsRSAAuthentication
1694 Specifies the user to log in as.
1695 This can be useful when a different user name is used on different machines.
1696 This saves the trouble of
1697 having to remember to give the user name on the command line.
1698 .It Cm UserKnownHostsFile
1699 Specifies one or more files to use for the user
1700 host key database, separated by whitespace.
1702 .Pa ~/.ssh/known_hosts ,
1703 .Pa ~/.ssh/known_hosts2 .
1704 .It Cm VerifyHostKeyDNS
1705 Specifies whether to verify the remote key using DNS and SSHFP resource
1707 If this option is set to
1709 the client will implicitly trust keys that match a secure fingerprint
1711 Insecure fingerprints will be handled as if this option was set to
1713 If this option is set to
1715 information on fingerprint match will be displayed, but the user will still
1716 need to confirm new host keys according to the
1717 .Cm StrictHostKeyChecking
1719 The argument must be
1726 if compiled with LDNS and
1730 See also VERIFYING HOST KEYS in
1732 .It Cm VersionAddendum
1733 Specifies a string to append to the regular version string to identify
1734 OS- or site-specific modifications.
1736 .Dq FreeBSD-20160310 .
1739 may be used to disable this.
1740 .It Cm VisualHostKey
1741 If this flag is set to
1743 an ASCII art representation of the remote host key fingerprint is
1744 printed in addition to the fingerprint string at login and
1745 for unknown host keys.
1746 If this flag is set to
1748 no fingerprint strings are printed at login and
1749 only the fingerprint string will be printed for unknown host keys.
1752 .It Cm XAuthLocation
1753 Specifies the full pathname of the
1757 .Pa /usr/local/bin/xauth .
1762 consists of zero or more non-whitespace characters,
1764 (a wildcard that matches zero or more characters),
1767 (a wildcard that matches exactly one character).
1768 For example, to specify a set of declarations for any host in the
1771 the following pattern could be used:
1775 The following pattern
1776 would match any host in the 192.168.0.[0-9] network range:
1778 .Dl Host 192.168.0.?
1782 is a comma-separated list of patterns.
1783 Patterns within pattern-lists may be negated
1784 by preceding them with an exclamation mark
1787 to allow a key to be used from anywhere within an organization
1791 the following entry (in authorized_keys) could be used:
1793 .Dl from=\&"!*.dialup.example.com,*.example.com\&"
1796 .It Pa ~/.ssh/config
1797 This is the per-user configuration file.
1798 The format of this file is described above.
1799 This file is used by the SSH client.
1800 Because of the potential for abuse, this file must have strict permissions:
1801 read/write for the user, and not accessible by others.
1802 .It Pa /etc/ssh/ssh_config
1803 Systemwide configuration file.
1804 This file provides defaults for those
1805 values that are not specified in the user's configuration file, and
1806 for those users who do not have a configuration file.
1807 This file must be world-readable.
1812 OpenSSH is a derivative of the original and free
1813 ssh 1.2.12 release by Tatu Ylonen.
1814 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1815 Theo de Raadt and Dug Song
1816 removed many bugs, re-added newer features and
1818 Markus Friedl contributed the support for SSH
1819 protocol versions 1.5 and 2.0.
projects / FreeBSD / releng / 10.3.git / blob