diff options
author | Colin Watson <cjwatson@debian.org> | 2015-08-19 14:23:51 +0100 |
---|---|---|
committer | Colin Watson <cjwatson@debian.org> | 2015-08-19 16:48:11 +0100 |
commit | 0f0841b2d28b7463267d4d91577e72e3340a1d3a (patch) | |
tree | ba55fcd2b6e2cc22b30f5afb561dbb3da4c8b6c7 /ssh_config.5 | |
parent | f2a5f5dae656759efb0b76c3d94890b65c197a02 (diff) | |
parent | 8698446b972003b63dfe5dcbdb86acfe986afb85 (diff) |
New upstream release (6.8p1).
Diffstat (limited to 'ssh_config.5')
-rw-r--r-- | ssh_config.5 | 152 |
1 files changed, 133 insertions, 19 deletions
diff --git a/ssh_config.5 b/ssh_config.5 index da3c1771a..da8e54428 100644 --- a/ssh_config.5 +++ b/ssh_config.5 | |||
@@ -33,8 +33,8 @@ | |||
33 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | 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. | 34 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
35 | .\" | 35 | .\" |
36 | .\" $OpenBSD: ssh_config.5,v 1.191 2014/07/15 15:54:14 millert Exp $ | 36 | .\" $OpenBSD: ssh_config.5,v 1.205 2015/02/20 22:17:21 djm Exp $ |
37 | .Dd $Mdocdate: July 15 2014 $ | 37 | .Dd $Mdocdate: February 20 2015 $ |
38 | .Dt SSH_CONFIG 5 | 38 | .Dt SSH_CONFIG 5 |
39 | .Os | 39 | .Os |
40 | .Sh NAME | 40 | .Sh NAME |
@@ -65,7 +65,10 @@ The configuration files contain sections separated by | |||
65 | .Dq Host | 65 | .Dq Host |
66 | specifications, and that section is only applied for hosts that | 66 | specifications, and that section is only applied for hosts that |
67 | match one of the patterns given in the specification. | 67 | match one of the patterns given in the specification. |
68 | The matched host name is the one given on the command line. | 68 | The matched host name is usually the one given on the command line |
69 | (see the | ||
70 | .Cm CanonicalizeHostname | ||
71 | option for exceptions.) | ||
69 | .Pp | 72 | .Pp |
70 | Since the first obtained value for each parameter is used, more | 73 | Since the first obtained value for each parameter is used, more |
71 | host-specific declarations should be given near the beginning of the | 74 | host-specific declarations should be given near the beginning of the |
@@ -125,10 +128,12 @@ A single | |||
125 | .Ql * | 128 | .Ql * |
126 | as a pattern can be used to provide global | 129 | as a pattern can be used to provide global |
127 | defaults for all hosts. | 130 | defaults for all hosts. |
128 | The host is the | 131 | The host is usually the |
129 | .Ar hostname | 132 | .Ar hostname |
130 | argument given on the command line (i.e. the name is not converted to | 133 | argument given on the command line |
131 | a canonicalized host name before matching). | 134 | (see the |
135 | .Cm CanonicalizeHostname | ||
136 | option for exceptions.) | ||
132 | .Pp | 137 | .Pp |
133 | A pattern entry may be negated by prefixing it with an exclamation mark | 138 | A pattern entry may be negated by prefixing it with an exclamation mark |
134 | .Pq Sq !\& . | 139 | .Pq Sq !\& . |
@@ -150,19 +155,40 @@ or | |||
150 | keyword) to be used only when the conditions following the | 155 | keyword) to be used only when the conditions following the |
151 | .Cm Match | 156 | .Cm Match |
152 | keyword are satisfied. | 157 | keyword are satisfied. |
153 | Match conditions are specified using one or more keyword/criteria pairs | 158 | Match conditions are specified using one or more critera |
154 | or the single token | 159 | or the single token |
155 | .Cm all | 160 | .Cm all |
156 | which matches all criteria. | 161 | which always matches. |
157 | The available keywords are: | 162 | The available criteria keywords are: |
163 | .Cm canonical , | ||
158 | .Cm exec , | 164 | .Cm exec , |
159 | .Cm host , | 165 | .Cm host , |
160 | .Cm originalhost , | 166 | .Cm originalhost , |
161 | .Cm user , | 167 | .Cm user , |
162 | and | 168 | and |
163 | .Cm localuser . | 169 | .Cm localuser . |
170 | The | ||
171 | .Cm all | ||
172 | criteria must appear alone or immediately after | ||
173 | .Cm canonical . | ||
174 | Other criteria may be combined arbitrarily. | ||
175 | All criteria but | ||
176 | .Cm all | ||
177 | and | ||
178 | .Cm canonical | ||
179 | require an argument. | ||
180 | Criteria may be negated by prepending an exclamation mark | ||
181 | .Pq Sq !\& . | ||
164 | .Pp | 182 | .Pp |
165 | The | 183 | The |
184 | .Cm canonical | ||
185 | keywork matches only when the configuration file is being re-parsed | ||
186 | after hostname canonicalization (see the | ||
187 | .Cm CanonicalizeHostname | ||
188 | option.) | ||
189 | This may be useful to specify conditions that work with canonical host | ||
190 | names only. | ||
191 | The | ||
166 | .Cm exec | 192 | .Cm exec |
167 | keyword executes the specified command under the user's shell. | 193 | keyword executes the specified command under the user's shell. |
168 | If the command returns a zero exit status then the condition is considered true. | 194 | If the command returns a zero exit status then the condition is considered true. |
@@ -195,7 +221,9 @@ The criteria for the | |||
195 | keyword are matched against the target hostname, after any substitution | 221 | keyword are matched against the target hostname, after any substitution |
196 | by the | 222 | by the |
197 | .Cm Hostname | 223 | .Cm Hostname |
198 | option. | 224 | or |
225 | .Cm CanonicalizeHostname | ||
226 | options. | ||
199 | The | 227 | The |
200 | .Cm originalhost | 228 | .Cm originalhost |
201 | keyword matches against the hostname as it was specified on the command-line. | 229 | keyword matches against the hostname as it was specified on the command-line. |
@@ -284,10 +312,11 @@ is set to | |||
284 | .Dq always , | 312 | .Dq always , |
285 | then canonicalization is applied to proxied connections too. | 313 | then canonicalization is applied to proxied connections too. |
286 | .Pp | 314 | .Pp |
287 | If this option is enabled and canonicalisation results in the target hostname | 315 | If this option is enabled, then the configuration files are processed |
288 | changing, then the configuration files are processed again using the new | 316 | again using the new target name to pick up any new configuration in matching |
289 | target name to pick up any new configuration in matching | ||
290 | .Cm Host | 317 | .Cm Host |
318 | and | ||
319 | .Cm Match | ||
291 | stanzas. | 320 | stanzas. |
292 | .It Cm CanonicalizeMaxDots | 321 | .It Cm CanonicalizeMaxDots |
293 | Specifies the maximum number of dot characters in a hostname before | 322 | Specifies the maximum number of dot characters in a hostname before |
@@ -408,7 +437,9 @@ aes192-cbc,aes256-cbc,arcfour | |||
408 | The list of available ciphers may also be obtained using the | 437 | The list of available ciphers may also be obtained using the |
409 | .Fl Q | 438 | .Fl Q |
410 | option of | 439 | option of |
411 | .Xr ssh 1 . | 440 | .Xr ssh 1 |
441 | with an argument of | ||
442 | .Dq cipher . | ||
412 | .It Cm ClearAllForwardings | 443 | .It Cm ClearAllForwardings |
413 | Specifies that all local, remote, and dynamic port forwardings | 444 | Specifies that all local, remote, and dynamic port forwardings |
414 | specified in the configuration files or on the command line be | 445 | specified in the configuration files or on the command line be |
@@ -528,7 +559,8 @@ by a hash of the concatenation: %l%h%p%r. | |||
528 | It is recommended that any | 559 | It is recommended that any |
529 | .Cm ControlPath | 560 | .Cm ControlPath |
530 | used for opportunistic connection sharing include | 561 | used for opportunistic connection sharing include |
531 | at least %h, %p, and %r (or alternatively %C). | 562 | at least %h, %p, and %r (or alternatively %C) and be placed in a directory |
563 | that is not writable by other users. | ||
532 | This ensures that shared connections are uniquely identified. | 564 | This ensures that shared connections are uniquely identified. |
533 | .It Cm ControlPersist | 565 | .It Cm ControlPersist |
534 | When used in conjunction with | 566 | When used in conjunction with |
@@ -541,7 +573,9 @@ If set to | |||
541 | then the master connection will not be placed into the background, | 573 | then the master connection will not be placed into the background, |
542 | and will close as soon as the initial client connection is closed. | 574 | and will close as soon as the initial client connection is closed. |
543 | If set to | 575 | If set to |
544 | .Dq yes , | 576 | .Dq yes |
577 | or | ||
578 | .Dq 0 , | ||
545 | then the master connection will remain in the background indefinitely | 579 | then the master connection will remain in the background indefinitely |
546 | (until killed or closed via a mechanism such as the | 580 | (until killed or closed via a mechanism such as the |
547 | .Xr ssh 1 | 581 | .Xr ssh 1 |
@@ -626,6 +660,14 @@ or | |||
626 | .Dq no . | 660 | .Dq no . |
627 | The default is | 661 | The default is |
628 | .Dq no . | 662 | .Dq no . |
663 | .It Cm FingerprintHash | ||
664 | Specifies the hash algorithm used when displaying key fingerprints. | ||
665 | Valid options are: | ||
666 | .Dq md5 | ||
667 | and | ||
668 | .Dq sha256 . | ||
669 | The default is | ||
670 | .Dq sha256 . | ||
629 | .It Cm ForwardAgent | 671 | .It Cm ForwardAgent |
630 | Specifies whether the connection to the authentication agent (if any) | 672 | Specifies whether the connection to the authentication agent (if any) |
631 | will be forwarded to the remote machine. | 673 | will be forwarded to the remote machine. |
@@ -791,6 +833,17 @@ The default is | |||
791 | This option applies to protocol version 2 only and | 833 | This option applies to protocol version 2 only and |
792 | is similar to | 834 | is similar to |
793 | .Cm RhostsRSAAuthentication . | 835 | .Cm RhostsRSAAuthentication . |
836 | .It Cm HostbasedKeyTypes | ||
837 | Specifies the key types that will be used for hostbased authentication | ||
838 | as a comma-separated pattern list. | ||
839 | The default | ||
840 | .Dq * | ||
841 | will allow all key types. | ||
842 | The | ||
843 | .Fl Q | ||
844 | option of | ||
845 | .Xr ssh 1 | ||
846 | may be used to list supported key types. | ||
794 | .It Cm HostKeyAlgorithms | 847 | .It Cm HostKeyAlgorithms |
795 | Specifies the protocol version 2 host key algorithms | 848 | Specifies the protocol version 2 host key algorithms |
796 | that the client wants to use in order of preference. | 849 | that the client wants to use in order of preference. |
@@ -808,6 +861,13 @@ ssh-ed25519,ssh-rsa,ssh-dss | |||
808 | .Pp | 861 | .Pp |
809 | If hostkeys are known for the destination host then this default is modified | 862 | If hostkeys are known for the destination host then this default is modified |
810 | to prefer their algorithms. | 863 | to prefer their algorithms. |
864 | .Pp | ||
865 | The list of available key types may also be obtained using the | ||
866 | .Fl Q | ||
867 | option of | ||
868 | .Xr ssh 1 | ||
869 | with an argument of | ||
870 | .Dq key . | ||
811 | .It Cm HostKeyAlias | 871 | .It Cm HostKeyAlias |
812 | Specifies an alias that should be used instead of the | 872 | Specifies an alias that should be used instead of the |
813 | real host name when looking up or saving the host key | 873 | real host name when looking up or saving the host key |
@@ -851,7 +911,7 @@ offers many different identities. | |||
851 | The default is | 911 | The default is |
852 | .Dq no . | 912 | .Dq no . |
853 | .It Cm IdentityFile | 913 | .It Cm IdentityFile |
854 | Specifies a file from which the user's DSA, ECDSA, ED25519 or RSA authentication | 914 | Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication |
855 | identity is read. | 915 | identity is read. |
856 | The default is | 916 | The default is |
857 | .Pa ~/.ssh/identity | 917 | .Pa ~/.ssh/identity |
@@ -978,6 +1038,13 @@ diffie-hellman-group14-sha1, | |||
978 | diffie-hellman-group-exchange-sha1, | 1038 | diffie-hellman-group-exchange-sha1, |
979 | diffie-hellman-group1-sha1 | 1039 | diffie-hellman-group1-sha1 |
980 | .Ed | 1040 | .Ed |
1041 | .Pp | ||
1042 | The list of available key exchange algorithms may also be obtained using the | ||
1043 | .Fl Q | ||
1044 | option of | ||
1045 | .Xr ssh 1 | ||
1046 | with an argument of | ||
1047 | .Dq kex . | ||
981 | .It Cm LocalCommand | 1048 | .It Cm LocalCommand |
982 | Specifies a command to execute on the local machine after successfully | 1049 | Specifies a command to execute on the local machine after successfully |
983 | connecting to the server. | 1050 | connecting to the server. |
@@ -1067,6 +1134,13 @@ hmac-sha1-96-etm@openssh.com,hmac-md5-96-etm@openssh.com, | |||
1067 | hmac-md5,hmac-sha1,hmac-ripemd160, | 1134 | hmac-md5,hmac-sha1,hmac-ripemd160, |
1068 | hmac-sha1-96,hmac-md5-96 | 1135 | hmac-sha1-96,hmac-md5-96 |
1069 | .Ed | 1136 | .Ed |
1137 | .Pp | ||
1138 | The list of available MAC algorithms may also be obtained using the | ||
1139 | .Fl Q | ||
1140 | option of | ||
1141 | .Xr ssh 1 | ||
1142 | with an argument of | ||
1143 | .Dq mac . | ||
1070 | .It Cm NoHostAuthenticationForLocalhost | 1144 | .It Cm NoHostAuthenticationForLocalhost |
1071 | This option can be used if the home directory is shared across machines. | 1145 | This option can be used if the home directory is shared across machines. |
1072 | In this case localhost will refer to a different machine on each of | 1146 | In this case localhost will refer to a different machine on each of |
@@ -1277,6 +1351,16 @@ and | |||
1277 | .Fl T | 1351 | .Fl T |
1278 | flags for | 1352 | flags for |
1279 | .Xr ssh 1 . | 1353 | .Xr ssh 1 . |
1354 | .It Cm RevokedHostKeys | ||
1355 | Specifies revoked host public keys. | ||
1356 | Keys listed in this file will be refused for host authentication. | ||
1357 | Note that if this file does not exist or is not readable, | ||
1358 | then host authentication will be refused for all hosts. | ||
1359 | Keys may be specified as a text file, listing one public key per line, or as | ||
1360 | an OpenSSH Key Revocation List (KRL) as generated by | ||
1361 | .Xr ssh-keygen 1 . | ||
1362 | For more information on KRLs, see the KEY REVOCATION LISTS section in | ||
1363 | .Xr ssh-keygen 1 . | ||
1280 | .It Cm RhostsRSAAuthentication | 1364 | .It Cm RhostsRSAAuthentication |
1281 | Specifies whether to try rhosts based authentication with RSA host | 1365 | Specifies whether to try rhosts based authentication with RSA host |
1282 | authentication. | 1366 | authentication. |
@@ -1491,6 +1575,36 @@ is not specified, it defaults to | |||
1491 | .Dq any . | 1575 | .Dq any . |
1492 | The default is | 1576 | The default is |
1493 | .Dq any:any . | 1577 | .Dq any:any . |
1578 | .It Cm UpdateHostKeys | ||
1579 | Specifies whether | ||
1580 | .Xr ssh 1 | ||
1581 | should accept notifications of additional hostkeys from the server sent | ||
1582 | after authentication has completed and add them to | ||
1583 | .Cm UserKnownHostsFile . | ||
1584 | The argument must be | ||
1585 | .Dq yes , | ||
1586 | .Dq no | ||
1587 | (the default) or | ||
1588 | .Dq ask . | ||
1589 | Enabling this option allows learning alternate hostkeys for a server | ||
1590 | and supports graceful key rotation by allowing a server to send replacement | ||
1591 | public keys before old ones are removed. | ||
1592 | Additional hostkeys are only accepted if the key used to authenticate the | ||
1593 | host was already trusted or explicity accepted by the user. | ||
1594 | If | ||
1595 | .Cm UpdateHostKeys | ||
1596 | is set to | ||
1597 | .Dq ask , | ||
1598 | then the user is asked to confirm the modifications to the known_hosts file. | ||
1599 | Confirmation is currently incompatible with | ||
1600 | .Cm ControlPersist , | ||
1601 | and will be disabled if it is enabled. | ||
1602 | .Pp | ||
1603 | Presently, only | ||
1604 | .Xr sshd 8 | ||
1605 | from OpenSSH 6.8 and greater support the | ||
1606 | .Dq hostkeys@openssh.com | ||
1607 | protocol extension used to inform the client of all the server's hostkeys. | ||
1494 | .It Cm UsePrivilegedPort | 1608 | .It Cm UsePrivilegedPort |
1495 | Specifies whether to use a privileged port for outgoing connections. | 1609 | Specifies whether to use a privileged port for outgoing connections. |
1496 | The argument must be | 1610 | The argument must be |
@@ -1549,12 +1663,12 @@ See also VERIFYING HOST KEYS in | |||
1549 | If this flag is set to | 1663 | If this flag is set to |
1550 | .Dq yes , | 1664 | .Dq yes , |
1551 | an ASCII art representation of the remote host key fingerprint is | 1665 | an ASCII art representation of the remote host key fingerprint is |
1552 | printed in addition to the hex fingerprint string at login and | 1666 | printed in addition to the fingerprint string at login and |
1553 | for unknown host keys. | 1667 | for unknown host keys. |
1554 | If this flag is set to | 1668 | If this flag is set to |
1555 | .Dq no , | 1669 | .Dq no , |
1556 | no fingerprint strings are printed at login and | 1670 | no fingerprint strings are printed at login and |
1557 | only the hex fingerprint string will be printed for unknown host keys. | 1671 | only the fingerprint string will be printed for unknown host keys. |
1558 | The default is | 1672 | The default is |
1559 | .Dq no . | 1673 | .Dq no . |
1560 | .It Cm XAuthLocation | 1674 | .It Cm XAuthLocation |