Annotation of src/usr.bin/ssh/ssh_config.5, Revision 1.214
1.1 stevesk 1: .\"
2: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
3: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4: .\" All rights reserved
5: .\"
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".
11: .\"
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.
15: .\"
16: .\" Redistribution and use in source and binary forms, with or without
17: .\" modification, are permitted provided that the following conditions
18: .\" are met:
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.
24: .\"
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.
35: .\"
1.214 ! djm 36: .\" $OpenBSD: ssh_config.5,v 1.213 2015/07/10 06:21:53 markus Exp $
! 37: .Dd $Mdocdate: July 10 2015 $
1.1 stevesk 38: .Dt SSH_CONFIG 5
39: .Os
40: .Sh NAME
41: .Nm ssh_config
42: .Nd OpenSSH SSH client configuration files
43: .Sh SYNOPSIS
1.98 jmc 44: .Nm ~/.ssh/config
45: .Nm /etc/ssh/ssh_config
1.1 stevesk 46: .Sh DESCRIPTION
1.84 jmc 47: .Xr ssh 1
1.1 stevesk 48: obtains configuration data from the following sources in
49: the following order:
1.79 jmc 50: .Pp
1.2 stevesk 51: .Bl -enum -offset indent -compact
52: .It
53: command-line options
54: .It
55: user's configuration file
1.50 djm 56: .Pq Pa ~/.ssh/config
1.2 stevesk 57: .It
58: system-wide configuration file
59: .Pq Pa /etc/ssh/ssh_config
60: .El
1.1 stevesk 61: .Pp
62: For each parameter, the first obtained value
63: will be used.
1.41 jmc 64: The configuration files contain sections separated by
1.1 stevesk 65: .Dq Host
66: specifications, and that section is only applied for hosts that
67: match one of the patterns given in the specification.
1.193 djm 68: The matched host name is usually the one given on the command line
69: (see the
70: .Cm CanonicalizeHostname
71: option for exceptions.)
1.1 stevesk 72: .Pp
73: Since the first obtained value for each parameter is used, more
74: host-specific declarations should be given near the beginning of the
75: file, and general defaults at the end.
1.80 jmc 76: .Pp
1.1 stevesk 77: The configuration file has the following format:
78: .Pp
79: Empty lines and lines starting with
80: .Ql #
81: are comments.
82: Otherwise a line is of the format
83: .Dq keyword arguments .
84: Configuration options may be separated by whitespace or
85: optional whitespace and exactly one
86: .Ql = ;
87: the latter format is useful to avoid the need to quote whitespace
88: when specifying configuration options using the
89: .Nm ssh ,
1.87 jmc 90: .Nm scp ,
1.1 stevesk 91: and
92: .Nm sftp
93: .Fl o
94: option.
1.88 dtucker 95: Arguments may optionally be enclosed in double quotes
96: .Pq \&"
97: in order to represent arguments containing spaces.
1.1 stevesk 98: .Pp
99: The possible
100: keywords and their meanings are as follows (note that
101: keywords are case-insensitive and arguments are case-sensitive):
102: .Bl -tag -width Ds
103: .It Cm Host
104: Restricts the following declarations (up to the next
105: .Cm Host
1.169 djm 106: or
107: .Cm Match
1.1 stevesk 108: keyword) to be only for those hosts that match one of the patterns
109: given after the keyword.
1.112 krw 110: If more than one pattern is provided, they should be separated by whitespace.
1.1 stevesk 111: A single
1.83 jmc 112: .Ql *
1.1 stevesk 113: as a pattern can be used to provide global
114: defaults for all hosts.
1.193 djm 115: The host is usually the
1.1 stevesk 116: .Ar hostname
1.193 djm 117: argument given on the command line
118: (see the
119: .Cm CanonicalizeHostname
120: option for exceptions.)
1.148 djm 121: .Pp
122: A pattern entry may be negated by prefixing it with an exclamation mark
123: .Pq Sq !\& .
124: If a negated entry is matched, then the
125: .Cm Host
126: entry is ignored, regardless of whether any other patterns on the line
127: match.
128: Negated matches are therefore useful to provide exceptions for wildcard
129: matches.
1.81 jmc 130: .Pp
131: See
132: .Sx PATTERNS
133: for more information on patterns.
1.170 jmc 134: .It Cm Match
1.169 djm 135: Restricts the following declarations (up to the next
136: .Cm Host
137: or
138: .Cm Match
139: keyword) to be used only when the conditions following the
140: .Cm Match
141: keyword are satisfied.
1.193 djm 142: Match conditions are specified using one or more critera
1.178 dtucker 143: or the single token
144: .Cm all
1.193 djm 145: which always matches.
146: The available criteria keywords are:
147: .Cm canonical ,
1.176 djm 148: .Cm exec ,
1.169 djm 149: .Cm host ,
150: .Cm originalhost ,
151: .Cm user ,
152: and
153: .Cm localuser .
1.193 djm 154: The
155: .Cm all
156: criteria must appear alone or immediately after
1.194 jmc 157: .Cm canonical .
1.193 djm 158: Other criteria may be combined arbitrarily.
159: All criteria but
160: .Cm all
161: and
162: .Cm canonical
163: require an argument.
164: Criteria may be negated by prepending an exclamation mark
165: .Pq Sq !\& .
1.169 djm 166: .Pp
1.177 jmc 167: The
1.193 djm 168: .Cm canonical
1.210 dtucker 169: keyword matches only when the configuration file is being re-parsed
1.193 djm 170: after hostname canonicalization (see the
171: .Cm CanonicalizeHostname
172: option.)
173: This may be useful to specify conditions that work with canonical host
174: names only.
175: The
1.176 djm 176: .Cm exec
1.177 jmc 177: keyword executes the specified command under the user's shell.
1.169 djm 178: If the command returns a zero exit status then the condition is considered true.
179: Commands containing whitespace characters must be quoted.
1.175 djm 180: The following character sequences in the command will be expanded prior to
181: execution:
182: .Ql %L
183: will be substituted by the first component of the local host name,
184: .Ql %l
185: will be substituted by the local host name (including any domain name),
186: .Ql %h
187: will be substituted by the target host name,
188: .Ql %n
189: will be substituted by the original target host name
1.176 djm 190: specified on the command-line,
1.175 djm 191: .Ql %p
192: the destination port,
193: .Ql %r
194: by the remote login username, and
195: .Ql %u
196: by the username of the user running
197: .Xr ssh 1 .
1.169 djm 198: .Pp
199: The other keywords' criteria must be single entries or comma-separated
200: lists and may use the wildcard and negation operators described in the
201: .Sx PATTERNS
202: section.
203: The criteria for the
204: .Cm host
205: keyword are matched against the target hostname, after any substitution
206: by the
207: .Cm Hostname
1.193 djm 208: or
209: .Cm CanonicalizeHostname
210: options.
1.169 djm 211: The
212: .Cm originalhost
213: keyword matches against the hostname as it was specified on the command-line.
214: The
215: .Cm user
216: keyword matches against the target username on the remote host.
217: The
218: .Cm localuser
219: keyword matches against the name of the local user running
220: .Xr ssh 1
221: (this keyword may be useful in system-wide
222: .Nm
223: files).
1.10 djm 224: .It Cm AddressFamily
1.11 jmc 225: Specifies which address family to use when connecting.
226: Valid arguments are
1.10 djm 227: .Dq any ,
228: .Dq inet
1.84 jmc 229: (use IPv4 only), or
1.10 djm 230: .Dq inet6
1.40 jmc 231: (use IPv6 only).
1.1 stevesk 232: .It Cm BatchMode
233: If set to
234: .Dq yes ,
235: passphrase/password querying will be disabled.
236: This option is useful in scripts and other batch jobs where no user
237: is present to supply the password.
238: The argument must be
239: .Dq yes
240: or
241: .Dq no .
242: The default is
243: .Dq no .
244: .It Cm BindAddress
1.60 dtucker 245: Use the specified address on the local machine as the source address of
1.61 jmc 246: the connection.
247: Only useful on systems with more than one address.
1.1 stevesk 248: Note that this option does not work if
249: .Cm UsePrivilegedPort
250: is set to
251: .Dq yes .
1.171 djm 252: .It Cm CanonicalDomains
1.172 jmc 253: When
1.173 djm 254: .Cm CanonicalizeHostname
1.171 djm 255: is enabled, this option specifies the list of domain suffixes in which to
256: search for the specified destination host.
1.173 djm 257: .It Cm CanonicalizeFallbackLocal
1.174 djm 258: Specifies whether to fail with an error when hostname canonicalization fails.
1.172 jmc 259: The default,
1.184 djm 260: .Dq yes ,
1.172 jmc 261: will attempt to look up the unqualified hostname using the system resolver's
1.171 djm 262: search rules.
263: A value of
1.184 djm 264: .Dq no
1.171 djm 265: will cause
266: .Xr ssh 1
267: to fail instantly if
1.173 djm 268: .Cm CanonicalizeHostname
1.171 djm 269: is enabled and the target hostname cannot be found in any of the domains
270: specified by
271: .Cm CanonicalDomains .
1.173 djm 272: .It Cm CanonicalizeHostname
1.174 djm 273: Controls whether explicit hostname canonicalization is performed.
1.172 jmc 274: The default,
275: .Dq no ,
1.171 djm 276: is not to perform any name rewriting and let the system resolver handle all
277: hostname lookups.
278: If set to
279: .Dq yes
280: then, for connections that do not use a
281: .Cm ProxyCommand ,
282: .Xr ssh 1
1.173 djm 283: will attempt to canonicalize the hostname specified on the command line
1.171 djm 284: using the
285: .Cm CanonicalDomains
286: suffixes and
1.173 djm 287: .Cm CanonicalizePermittedCNAMEs
1.171 djm 288: rules.
289: If
1.173 djm 290: .Cm CanonicalizeHostname
1.171 djm 291: is set to
292: .Dq always ,
1.174 djm 293: then canonicalization is applied to proxied connections too.
1.185 djm 294: .Pp
1.193 djm 295: If this option is enabled, then the configuration files are processed
296: again using the new target name to pick up any new configuration in matching
1.185 djm 297: .Cm Host
1.193 djm 298: and
299: .Cm Match
1.185 djm 300: stanzas.
1.173 djm 301: .It Cm CanonicalizeMaxDots
1.172 jmc 302: Specifies the maximum number of dot characters in a hostname before
1.174 djm 303: canonicalization is disabled.
1.172 jmc 304: The default,
305: .Dq 1 ,
306: allows a single dot (i.e. hostname.subdomain).
1.173 djm 307: .It Cm CanonicalizePermittedCNAMEs
1.172 jmc 308: Specifies rules to determine whether CNAMEs should be followed when
1.173 djm 309: canonicalizing hostnames.
1.171 djm 310: The rules consist of one or more arguments of
1.172 jmc 311: .Ar source_domain_list : Ns Ar target_domain_list ,
1.171 djm 312: where
313: .Ar source_domain_list
1.174 djm 314: is a pattern-list of domains that may follow CNAMEs in canonicalization,
1.171 djm 315: and
316: .Ar target_domain_list
1.172 jmc 317: is a pattern-list of domains that they may resolve to.
1.171 djm 318: .Pp
319: For example,
320: .Dq *.a.example.com:*.b.example.com,*.c.example.com
321: will allow hostnames matching
322: .Dq *.a.example.com
1.173 djm 323: to be canonicalized to names in the
1.171 djm 324: .Dq *.b.example.com
325: or
326: .Dq *.c.example.com
327: domains.
1.1 stevesk 328: .It Cm ChallengeResponseAuthentication
1.82 jmc 329: Specifies whether to use challenge-response authentication.
1.1 stevesk 330: The argument to this keyword must be
331: .Dq yes
332: or
333: .Dq no .
334: The default is
335: .Dq yes .
336: .It Cm CheckHostIP
337: If this flag is set to
338: .Dq yes ,
1.84 jmc 339: .Xr ssh 1
340: will additionally check the host IP address in the
1.1 stevesk 341: .Pa known_hosts
342: file.
1.211 djm 343: This allows ssh to detect if a host key changed due to DNS spoofing
344: and will add addresses of destination hosts to
345: .Pa ~/.ssh/known_hosts
346: in the process, regardless of the setting of
347: .Cm StrictHostKeyChecking .
1.107 grunk 348: If the option is set to
1.1 stevesk 349: .Dq no ,
350: the check will not be executed.
351: The default is
352: .Dq yes .
353: .It Cm Cipher
354: Specifies the cipher to use for encrypting the session
355: in protocol version 1.
356: Currently,
357: .Dq blowfish ,
358: .Dq 3des ,
359: and
360: .Dq des
361: are supported.
362: .Ar des
363: is only supported in the
1.84 jmc 364: .Xr ssh 1
1.1 stevesk 365: client for interoperability with legacy protocol 1 implementations
366: that do not support the
367: .Ar 3des
1.7 jmc 368: cipher.
369: Its use is strongly discouraged due to cryptographic weaknesses.
1.1 stevesk 370: The default is
371: .Dq 3des .
372: .It Cm Ciphers
373: Specifies the ciphers allowed for protocol version 2
374: in order of preference.
375: Multiple ciphers must be comma-separated.
1.214 ! djm 376: If the specified value begins with a
! 377: .Sq +
! 378: character, then the specified ciphers will be appended to the default set
! 379: instead of replacing them.
! 380: .Pp
1.180 djm 381: The supported ciphers are:
382: .Pp
1.186 naddy 383: .Bl -item -compact -offset indent
384: .It
385: 3des-cbc
386: .It
387: aes128-cbc
388: .It
389: aes192-cbc
390: .It
391: aes256-cbc
392: .It
393: aes128-ctr
394: .It
395: aes192-ctr
396: .It
397: aes256-ctr
398: .It
399: aes128-gcm@openssh.com
400: .It
401: aes256-gcm@openssh.com
402: .It
403: arcfour
404: .It
405: arcfour128
406: .It
407: arcfour256
408: .It
409: blowfish-cbc
410: .It
411: cast128-cbc
412: .It
413: chacha20-poly1305@openssh.com
414: .El
1.180 djm 415: .Pp
1.84 jmc 416: The default is:
1.186 naddy 417: .Bd -literal -offset indent
418: aes128-ctr,aes192-ctr,aes256-ctr,
1.161 markus 419: aes128-gcm@openssh.com,aes256-gcm@openssh.com,
1.180 djm 420: chacha20-poly1305@openssh.com,
1.186 naddy 421: arcfour256,arcfour128,
422: aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,
423: aes192-cbc,aes256-cbc,arcfour
1.1 stevesk 424: .Ed
1.180 djm 425: .Pp
426: The list of available ciphers may also be obtained using the
427: .Fl Q
428: option of
1.198 djm 429: .Xr ssh 1
430: with an argument of
431: .Dq cipher .
1.1 stevesk 432: .It Cm ClearAllForwardings
1.84 jmc 433: Specifies that all local, remote, and dynamic port forwardings
1.1 stevesk 434: specified in the configuration files or on the command line be
1.7 jmc 435: cleared.
436: This option is primarily useful when used from the
1.84 jmc 437: .Xr ssh 1
1.1 stevesk 438: command line to clear port forwardings set in
439: configuration files, and is automatically set by
440: .Xr scp 1
441: and
442: .Xr sftp 1 .
443: The argument must be
444: .Dq yes
445: or
446: .Dq no .
447: The default is
448: .Dq no .
449: .It Cm Compression
450: Specifies whether to use compression.
451: The argument must be
452: .Dq yes
453: or
454: .Dq no .
455: The default is
456: .Dq no .
457: .It Cm CompressionLevel
458: Specifies the compression level to use if compression is enabled.
459: The argument must be an integer from 1 (fast) to 9 (slow, best).
460: The default level is 6, which is good for most applications.
461: The meaning of the values is the same as in
462: .Xr gzip 1 .
463: Note that this option applies to protocol version 1 only.
464: .It Cm ConnectionAttempts
465: Specifies the number of tries (one per second) to make before exiting.
466: The argument must be an integer.
467: This may be useful in scripts if the connection sometimes fails.
468: The default is 1.
1.9 djm 469: .It Cm ConnectTimeout
1.84 jmc 470: Specifies the timeout (in seconds) used when connecting to the
471: SSH server, instead of using the default system TCP timeout.
1.11 jmc 472: This value is used only when the target is down or really unreachable,
473: not when it refuses the connection.
1.36 djm 474: .It Cm ControlMaster
475: Enables the sharing of multiple sessions over a single network connection.
476: When set to
1.84 jmc 477: .Dq yes ,
478: .Xr ssh 1
1.36 djm 479: will listen for connections on a control socket specified using the
480: .Cm ControlPath
481: argument.
482: Additional sessions can connect to this socket using the same
483: .Cm ControlPath
484: with
485: .Cm ControlMaster
486: set to
487: .Dq no
1.38 jmc 488: (the default).
1.64 jmc 489: These sessions will try to reuse the master instance's network connection
1.63 djm 490: rather than initiating new ones, but will fall back to connecting normally
491: if the control socket does not exist, or is not listening.
492: .Pp
1.37 djm 493: Setting this to
494: .Dq ask
1.84 jmc 495: will cause ssh
1.206 jmc 496: to listen for control connections, but require confirmation using
497: .Xr ssh-askpass 1 .
1.51 jakob 498: If the
499: .Cm ControlPath
1.84 jmc 500: cannot be opened,
501: ssh will continue without connecting to a master instance.
1.58 djm 502: .Pp
503: X11 and
1.59 jmc 504: .Xr ssh-agent 1
1.58 djm 505: forwarding is supported over these multiplexed connections, however the
1.70 stevesk 506: display and agent forwarded will be the one belonging to the master
1.59 jmc 507: connection i.e. it is not possible to forward multiple displays or agents.
1.56 djm 508: .Pp
509: Two additional options allow for opportunistic multiplexing: try to use a
510: master connection but fall back to creating a new one if one does not already
511: exist.
512: These options are:
513: .Dq auto
514: and
515: .Dq autoask .
516: The latter requires confirmation like the
517: .Dq ask
518: option.
1.36 djm 519: .It Cm ControlPath
1.55 djm 520: Specify the path to the control socket used for connection sharing as described
521: in the
1.36 djm 522: .Cm ControlMaster
1.57 djm 523: section above or the string
524: .Dq none
525: to disable connection sharing.
1.55 djm 526: In the path,
1.147 djm 527: .Ql %L
528: will be substituted by the first component of the local host name,
1.77 djm 529: .Ql %l
1.147 djm 530: will be substituted by the local host name (including any domain name),
1.55 djm 531: .Ql %h
532: will be substituted by the target host name,
1.150 jmc 533: .Ql %n
534: will be substituted by the original target host name
535: specified on the command line,
1.55 djm 536: .Ql %p
1.175 djm 537: the destination port,
1.55 djm 538: .Ql %r
1.188 djm 539: by the remote login username,
1.147 djm 540: .Ql %u
541: by the username of the user running
1.188 djm 542: .Xr ssh 1 , and
1.189 jmc 543: .Ql \&%C
1.188 djm 544: by a hash of the concatenation: %l%h%p%r.
1.56 djm 545: It is recommended that any
546: .Cm ControlPath
547: used for opportunistic connection sharing include
1.195 djm 548: at least %h, %p, and %r (or alternatively %C) and be placed in a directory
549: that is not writable by other users.
1.56 djm 550: This ensures that shared connections are uniquely identified.
1.137 djm 551: .It Cm ControlPersist
552: When used in conjunction with
553: .Cm ControlMaster ,
554: specifies that the master connection should remain open
555: in the background (waiting for future client connections)
556: after the initial client connection has been closed.
557: If set to
558: .Dq no ,
559: then the master connection will not be placed into the background,
560: and will close as soon as the initial client connection is closed.
561: If set to
1.195 djm 562: .Dq yes
563: or
564: .Dq 0 ,
1.137 djm 565: then the master connection will remain in the background indefinitely
566: (until killed or closed via a mechanism such as the
567: .Xr ssh 1
568: .Dq Fl O No exit
569: option).
570: If set to a time in seconds, or a time in any of the formats documented in
571: .Xr sshd_config 5 ,
572: then the backgrounded master connection will automatically terminate
573: after it has remained idle (with no client connections) for the
574: specified time.
1.38 jmc 575: .It Cm DynamicForward
1.74 jmc 576: Specifies that a TCP port on the local machine be forwarded
1.38 jmc 577: over the secure channel, and the application
578: protocol is then used to determine where to connect to from the
579: remote machine.
1.62 djm 580: .Pp
581: The argument must be
582: .Sm off
583: .Oo Ar bind_address : Oc Ar port .
584: .Sm on
1.138 djm 585: IPv6 addresses can be specified by enclosing addresses in square brackets.
1.62 djm 586: By default, the local port is bound in accordance with the
587: .Cm GatewayPorts
588: setting.
589: However, an explicit
590: .Ar bind_address
591: may be used to bind the connection to a specific address.
592: The
593: .Ar bind_address
594: of
595: .Dq localhost
596: indicates that the listening port be bound for local use only, while an
597: empty address or
598: .Sq *
599: indicates that the port should be available from all interfaces.
600: .Pp
1.38 jmc 601: Currently the SOCKS4 and SOCKS5 protocols are supported, and
1.84 jmc 602: .Xr ssh 1
1.38 jmc 603: will act as a SOCKS server.
604: Multiple forwardings may be specified, and
605: additional forwardings can be given on the command line.
606: Only the superuser can forward privileged ports.
1.14 markus 607: .It Cm EnableSSHKeysign
608: Setting this option to
609: .Dq yes
610: in the global client configuration file
611: .Pa /etc/ssh/ssh_config
612: enables the use of the helper program
613: .Xr ssh-keysign 8
614: during
615: .Cm HostbasedAuthentication .
616: The argument must be
617: .Dq yes
618: or
619: .Dq no .
620: The default is
621: .Dq no .
1.23 jmc 622: This option should be placed in the non-hostspecific section.
1.14 markus 623: See
624: .Xr ssh-keysign 8
625: for more information.
1.1 stevesk 626: .It Cm EscapeChar
627: Sets the escape character (default:
628: .Ql ~ ) .
629: The escape character can also
630: be set on the command line.
631: The argument should be a single character,
632: .Ql ^
633: followed by a letter, or
634: .Dq none
635: to disable the escape
636: character entirely (making the connection transparent for binary
637: data).
1.96 markus 638: .It Cm ExitOnForwardFailure
639: Specifies whether
640: .Xr ssh 1
641: should terminate the connection if it cannot set up all requested
1.102 stevesk 642: dynamic, tunnel, local, and remote port forwardings.
1.96 markus 643: The argument must be
644: .Dq yes
645: or
646: .Dq no .
647: The default is
648: .Dq no .
1.197 djm 649: .It Cm FingerprintHash
650: Specifies the hash algorithm used when displaying key fingerprints.
651: Valid options are:
652: .Dq md5
653: and
654: .Dq sha256 .
655: The default is
656: .Dq sha256 .
1.1 stevesk 657: .It Cm ForwardAgent
658: Specifies whether the connection to the authentication agent (if any)
659: will be forwarded to the remote machine.
660: The argument must be
661: .Dq yes
662: or
663: .Dq no .
664: The default is
665: .Dq no .
1.3 stevesk 666: .Pp
1.7 jmc 667: Agent forwarding should be enabled with caution.
668: Users with the ability to bypass file permissions on the remote host
669: (for the agent's Unix-domain socket)
670: can access the local agent through the forwarded connection.
671: An attacker cannot obtain key material from the agent,
1.3 stevesk 672: however they can perform operations on the keys that enable them to
673: authenticate using the identities loaded into the agent.
1.1 stevesk 674: .It Cm ForwardX11
675: Specifies whether X11 connections will be automatically redirected
676: over the secure channel and
677: .Ev DISPLAY
678: set.
679: The argument must be
680: .Dq yes
681: or
682: .Dq no .
683: The default is
684: .Dq no .
1.3 stevesk 685: .Pp
1.7 jmc 686: X11 forwarding should be enabled with caution.
687: Users with the ability to bypass file permissions on the remote host
1.22 markus 688: (for the user's X11 authorization database)
1.7 jmc 689: can access the local X11 display through the forwarded connection.
1.22 markus 690: An attacker may then be able to perform activities such as keystroke monitoring
691: if the
692: .Cm ForwardX11Trusted
693: option is also enabled.
1.134 djm 694: .It Cm ForwardX11Timeout
1.135 jmc 695: Specify a timeout for untrusted X11 forwarding
696: using the format described in the
1.166 jmc 697: TIME FORMATS section of
1.134 djm 698: .Xr sshd_config 5 .
699: X11 connections received by
700: .Xr ssh 1
701: after this time will be refused.
702: The default is to disable untrusted X11 forwarding after twenty minutes has
703: elapsed.
1.22 markus 704: .It Cm ForwardX11Trusted
1.34 jmc 705: If this option is set to
1.84 jmc 706: .Dq yes ,
707: remote X11 clients will have full access to the original X11 display.
1.42 djm 708: .Pp
1.22 markus 709: If this option is set to
1.84 jmc 710: .Dq no ,
711: remote X11 clients will be considered untrusted and prevented
1.22 markus 712: from stealing or tampering with data belonging to trusted X11
713: clients.
1.42 djm 714: Furthermore, the
715: .Xr xauth 1
716: token used for the session will be set to expire after 20 minutes.
717: Remote clients will be refused access after this time.
1.22 markus 718: .Pp
719: The default is
720: .Dq no .
721: .Pp
722: See the X11 SECURITY extension specification for full details on
723: the restrictions imposed on untrusted clients.
1.1 stevesk 724: .It Cm GatewayPorts
725: Specifies whether remote hosts are allowed to connect to local
726: forwarded ports.
727: By default,
1.84 jmc 728: .Xr ssh 1
1.7 jmc 729: binds local port forwardings to the loopback address.
730: This prevents other remote hosts from connecting to forwarded ports.
1.1 stevesk 731: .Cm GatewayPorts
1.84 jmc 732: can be used to specify that ssh
1.1 stevesk 733: should bind local port forwardings to the wildcard address,
734: thus allowing remote hosts to connect to forwarded ports.
735: The argument must be
736: .Dq yes
737: or
738: .Dq no .
739: The default is
740: .Dq no .
741: .It Cm GlobalKnownHostsFile
1.151 djm 742: Specifies one or more files to use for the global
743: host key database, separated by whitespace.
744: The default is
745: .Pa /etc/ssh/ssh_known_hosts ,
746: .Pa /etc/ssh/ssh_known_hosts2 .
1.18 markus 747: .It Cm GSSAPIAuthentication
1.27 markus 748: Specifies whether user authentication based on GSSAPI is allowed.
1.20 jmc 749: The default is
1.21 markus 750: .Dq no .
1.18 markus 751: Note that this option applies to protocol version 2 only.
752: .It Cm GSSAPIDelegateCredentials
753: Forward (delegate) credentials to the server.
754: The default is
755: .Dq no .
756: Note that this option applies to protocol version 2 only.
1.44 djm 757: .It Cm HashKnownHosts
758: Indicates that
1.84 jmc 759: .Xr ssh 1
1.44 djm 760: should hash host names and addresses when they are added to
1.50 djm 761: .Pa ~/.ssh/known_hosts .
1.44 djm 762: These hashed names may be used normally by
1.84 jmc 763: .Xr ssh 1
1.44 djm 764: and
1.84 jmc 765: .Xr sshd 8 ,
1.44 djm 766: but they do not reveal identifying information should the file's contents
767: be disclosed.
768: The default is
769: .Dq no .
1.97 jmc 770: Note that existing names and addresses in known hosts files
771: will not be converted automatically,
772: but may be manually hashed using
1.45 djm 773: .Xr ssh-keygen 1 .
1.1 stevesk 774: .It Cm HostbasedAuthentication
775: Specifies whether to try rhosts based authentication with public key
776: authentication.
777: The argument must be
778: .Dq yes
779: or
780: .Dq no .
781: The default is
782: .Dq no .
783: This option applies to protocol version 2 only and
784: is similar to
785: .Cm RhostsRSAAuthentication .
1.202 djm 786: .It Cm HostbasedKeyTypes
787: Specifies the key types that will be used for hostbased authentication
788: as a comma-separated pattern list.
1.214 ! djm 789: Alternately if the specified value begins with a
! 790: .Sq +
! 791: character, then the specified key types will be appended to the default set
! 792: instead of replacing them.
1.213 markus 793: The default for this option is:
794: .Bd -literal -offset 3n
795: ecdsa-sha2-nistp256-cert-v01@openssh.com,
796: ecdsa-sha2-nistp384-cert-v01@openssh.com,
797: ecdsa-sha2-nistp521-cert-v01@openssh.com,
798: ssh-ed25519-cert-v01@openssh.com,
799: ssh-rsa-cert-v01@openssh.com,
800: ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
801: ssh-ed25519,ssh-rsa
802: .Ed
803: .Pp
1.202 djm 804: The
805: .Fl Q
806: option of
807: .Xr ssh 1
808: may be used to list supported key types.
1.1 stevesk 809: .It Cm HostKeyAlgorithms
810: Specifies the protocol version 2 host key algorithms
811: that the client wants to use in order of preference.
1.214 ! djm 812: Alternately if the specified value begins with a
! 813: .Sq +
! 814: character, then the specified key types will be appended to the default set
! 815: instead of replacing them.
1.1 stevesk 816: The default for this option is:
1.139 djm 817: .Bd -literal -offset 3n
818: ecdsa-sha2-nistp256-cert-v01@openssh.com,
819: ecdsa-sha2-nistp384-cert-v01@openssh.com,
820: ecdsa-sha2-nistp521-cert-v01@openssh.com,
1.183 naddy 821: ssh-ed25519-cert-v01@openssh.com,
1.213 markus 822: ssh-rsa-cert-v01@openssh.com,
1.139 djm 823: ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1.213 markus 824: ssh-ed25519,ssh-rsa
1.139 djm 825: .Ed
1.145 djm 826: .Pp
827: If hostkeys are known for the destination host then this default is modified
828: to prefer their algorithms.
1.198 djm 829: .Pp
830: The list of available key types may also be obtained using the
831: .Fl Q
832: option of
833: .Xr ssh 1
834: with an argument of
835: .Dq key .
1.1 stevesk 836: .It Cm HostKeyAlias
837: Specifies an alias that should be used instead of the
838: real host name when looking up or saving the host key
839: in the host key database files.
1.84 jmc 840: This option is useful for tunneling SSH connections
1.1 stevesk 841: or for multiple servers running on a single host.
842: .It Cm HostName
843: Specifies the real host name to log into.
844: This can be used to specify nicknames or abbreviations for hosts.
1.136 djm 845: If the hostname contains the character sequence
846: .Ql %h ,
1.150 jmc 847: then this will be replaced with the host name specified on the command line
1.136 djm 848: (this is useful for manipulating unqualified names).
1.187 djm 849: The character sequence
850: .Ql %%
851: will be replaced by a single
852: .Ql %
853: character, which may be used when specifying IPv6 link-local addresses.
854: .Pp
1.84 jmc 855: The default is the name given on the command line.
1.1 stevesk 856: Numeric IP addresses are also permitted (both on the command line and in
857: .Cm HostName
858: specifications).
1.29 markus 859: .It Cm IdentitiesOnly
860: Specifies that
1.84 jmc 861: .Xr ssh 1
1.29 markus 862: should only use the authentication identity files configured in the
1.31 jmc 863: .Nm
1.29 markus 864: files,
1.84 jmc 865: even if
866: .Xr ssh-agent 1
1.159 djm 867: or a
868: .Cm PKCS11Provider
1.29 markus 869: offers more identities.
870: The argument to this keyword must be
871: .Dq yes
872: or
873: .Dq no .
1.84 jmc 874: This option is intended for situations where ssh-agent
1.29 markus 875: offers many different identities.
876: The default is
877: .Dq no .
1.67 jmc 878: .It Cm IdentityFile
1.192 sobrado 879: Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication
1.139 djm 880: identity is read.
1.67 jmc 881: The default is
882: .Pa ~/.ssh/identity
883: for protocol version 1, and
1.139 djm 884: .Pa ~/.ssh/id_dsa ,
1.183 naddy 885: .Pa ~/.ssh/id_ecdsa ,
886: .Pa ~/.ssh/id_ed25519
1.139 djm 887: and
1.67 jmc 888: .Pa ~/.ssh/id_rsa
889: for protocol version 2.
890: Additionally, any identities represented by the authentication agent
1.165 djm 891: will be used for authentication unless
892: .Cm IdentitiesOnly
893: is set.
1.129 djm 894: .Xr ssh 1
895: will try to load certificate information from the filename obtained by
896: appending
897: .Pa -cert.pub
898: to the path of a specified
899: .Cm IdentityFile .
1.90 djm 900: .Pp
1.67 jmc 901: The file name may use the tilde
1.91 jmc 902: syntax to refer to a user's home directory or one of the following
1.90 djm 903: escape characters:
904: .Ql %d
905: (local user's home directory),
906: .Ql %u
907: (local user name),
908: .Ql %l
909: (local host name),
910: .Ql %h
911: (remote host name) or
1.92 djm 912: .Ql %r
1.90 djm 913: (remote user name).
914: .Pp
1.67 jmc 915: It is possible to have
916: multiple identity files specified in configuration files; all these
917: identities will be tried in sequence.
1.152 djm 918: Multiple
919: .Cm IdentityFile
920: directives will add to the list of identities tried (this behaviour
921: differs from that of other configuration directives).
1.165 djm 922: .Pp
923: .Cm IdentityFile
924: may be used in conjunction with
925: .Cm IdentitiesOnly
926: to select which identities in an agent are offered during authentication.
1.164 jmc 927: .It Cm IgnoreUnknown
928: Specifies a pattern-list of unknown options to be ignored if they are
929: encountered in configuration parsing.
930: This may be used to suppress errors if
931: .Nm
932: contains options that are unrecognised by
933: .Xr ssh 1 .
934: It is recommended that
935: .Cm IgnoreUnknown
936: be listed early in the configuration file as it will not be applied
937: to unknown options that appear before it.
1.143 djm 938: .It Cm IPQoS
939: Specifies the IPv4 type-of-service or DSCP class for connections.
940: Accepted values are
941: .Dq af11 ,
942: .Dq af12 ,
943: .Dq af13 ,
1.154 djm 944: .Dq af21 ,
1.143 djm 945: .Dq af22 ,
946: .Dq af23 ,
947: .Dq af31 ,
948: .Dq af32 ,
949: .Dq af33 ,
950: .Dq af41 ,
951: .Dq af42 ,
952: .Dq af43 ,
953: .Dq cs0 ,
954: .Dq cs1 ,
955: .Dq cs2 ,
956: .Dq cs3 ,
957: .Dq cs4 ,
958: .Dq cs5 ,
959: .Dq cs6 ,
960: .Dq cs7 ,
961: .Dq ef ,
962: .Dq lowdelay ,
963: .Dq throughput ,
964: .Dq reliability ,
965: or a numeric value.
1.146 djm 966: This option may take one or two arguments, separated by whitespace.
1.143 djm 967: If one argument is specified, it is used as the packet class unconditionally.
968: If two values are specified, the first is automatically selected for
969: interactive sessions and the second for non-interactive sessions.
970: The default is
971: .Dq lowdelay
972: for interactive sessions and
973: .Dq throughput
974: for non-interactive sessions.
1.103 djm 975: .It Cm KbdInteractiveAuthentication
976: Specifies whether to use keyboard-interactive authentication.
977: The argument to this keyword must be
978: .Dq yes
979: or
980: .Dq no .
981: The default is
982: .Dq yes .
1.39 djm 983: .It Cm KbdInteractiveDevices
984: Specifies the list of methods to use in keyboard-interactive authentication.
985: Multiple method names must be comma-separated.
986: The default is to use the server specified list.
1.85 jmc 987: The methods available vary depending on what the server supports.
988: For an OpenSSH server,
989: it may be zero or more of:
990: .Dq bsdauth ,
991: .Dq pam ,
992: and
993: .Dq skey .
1.140 djm 994: .It Cm KexAlgorithms
995: Specifies the available KEX (Key Exchange) algorithms.
996: Multiple algorithms must be comma-separated.
1.214 ! djm 997: Alternately if the specified value begins with a
! 998: .Sq +
! 999: character, then the specified methods will be appended to the default set
! 1000: instead of replacing them.
1.141 jmc 1001: The default is:
1002: .Bd -literal -offset indent
1.179 markus 1003: curve25519-sha256@libssh.org,
1.141 jmc 1004: ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1005: diffie-hellman-group-exchange-sha256,
1.209 dtucker 1006: diffie-hellman-group-exchange-sha1,
1.212 djm 1007: diffie-hellman-group14-sha1
1.141 jmc 1008: .Ed
1.198 djm 1009: .Pp
1010: The list of available key exchange algorithms may also be obtained using the
1011: .Fl Q
1012: option of
1013: .Xr ssh 1
1014: with an argument of
1015: .Dq kex .
1.65 reyk 1016: .It Cm LocalCommand
1017: Specifies a command to execute on the local machine after successfully
1018: connecting to the server.
1019: The command string extends to the end of the line, and is executed with
1.105 jmc 1020: the user's shell.
1.109 dtucker 1021: The following escape character substitutions will be performed:
1022: .Ql %d
1023: (local user's home directory),
1024: .Ql %h
1025: (remote host name),
1026: .Ql %l
1027: (local host name),
1028: .Ql %n
1029: (host name as provided on the command line),
1030: .Ql %p
1031: (remote port),
1032: .Ql %r
1033: (remote user name) or
1034: .Ql %u
1.188 djm 1035: (local user name) or
1.189 jmc 1036: .Ql \&%C
1.188 djm 1037: by a hash of the concatenation: %l%h%p%r.
1.123 djm 1038: .Pp
1039: The command is run synchronously and does not have access to the
1040: session of the
1041: .Xr ssh 1
1042: that spawned it.
1043: It should not be used for interactive commands.
1044: .Pp
1.65 reyk 1045: This directive is ignored unless
1046: .Cm PermitLocalCommand
1047: has been enabled.
1.1 stevesk 1048: .It Cm LocalForward
1.74 jmc 1049: Specifies that a TCP port on the local machine be forwarded over
1.1 stevesk 1050: the secure channel to the specified host and port from the remote machine.
1.49 jmc 1051: The first argument must be
1.43 djm 1052: .Sm off
1.49 jmc 1053: .Oo Ar bind_address : Oc Ar port
1.43 djm 1054: .Sm on
1.49 jmc 1055: and the second argument must be
1056: .Ar host : Ns Ar hostport .
1.138 djm 1057: IPv6 addresses can be specified by enclosing addresses in square brackets.
1.46 jmc 1058: Multiple forwardings may be specified, and additional forwardings can be
1.43 djm 1059: given on the command line.
1.1 stevesk 1060: Only the superuser can forward privileged ports.
1.43 djm 1061: By default, the local port is bound in accordance with the
1062: .Cm GatewayPorts
1063: setting.
1064: However, an explicit
1065: .Ar bind_address
1066: may be used to bind the connection to a specific address.
1067: The
1068: .Ar bind_address
1069: of
1070: .Dq localhost
1.46 jmc 1071: indicates that the listening port be bound for local use only, while an
1072: empty address or
1073: .Sq *
1.43 djm 1074: indicates that the port should be available from all interfaces.
1.1 stevesk 1075: .It Cm LogLevel
1076: Gives the verbosity level that is used when logging messages from
1.84 jmc 1077: .Xr ssh 1 .
1.1 stevesk 1078: The possible values are:
1.84 jmc 1079: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
1.7 jmc 1080: The default is INFO.
1081: DEBUG and DEBUG1 are equivalent.
1082: DEBUG2 and DEBUG3 each specify higher levels of verbose output.
1.1 stevesk 1083: .It Cm MACs
1084: Specifies the MAC (message authentication code) algorithms
1085: in order of preference.
1086: The MAC algorithm is used in protocol version 2
1087: for data integrity protection.
1088: Multiple algorithms must be comma-separated.
1.214 ! djm 1089: If the specified value begins with a
! 1090: .Sq +
! 1091: character, then the specified algorithms will be appended to the default set
! 1092: instead of replacing them.
! 1093: .Pp
1.160 markus 1094: The algorithms that contain
1095: .Dq -etm
1096: calculate the MAC after encryption (encrypt-then-mac).
1097: These are considered safer and their use recommended.
1.214 ! djm 1098: .Pp
1.84 jmc 1099: The default is:
1.101 jmc 1100: .Bd -literal -offset indent
1.160 markus 1101: umac-64-etm@openssh.com,umac-128-etm@openssh.com,
1102: hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
1.186 naddy 1103: umac-64@openssh.com,umac-128@openssh.com,
1104: hmac-sha2-256,hmac-sha2-512,
1105: hmac-md5-etm@openssh.com,hmac-sha1-etm@openssh.com,
1106: hmac-ripemd160-etm@openssh.com,
1107: hmac-sha1-96-etm@openssh.com,hmac-md5-96-etm@openssh.com,
1108: hmac-md5,hmac-sha1,hmac-ripemd160,
1.157 naddy 1109: hmac-sha1-96,hmac-md5-96
1.101 jmc 1110: .Ed
1.198 djm 1111: .Pp
1112: The list of available MAC algorithms may also be obtained using the
1113: .Fl Q
1114: option of
1115: .Xr ssh 1
1116: with an argument of
1117: .Dq mac .
1.1 stevesk 1118: .It Cm NoHostAuthenticationForLocalhost
1119: This option can be used if the home directory is shared across machines.
1120: In this case localhost will refer to a different machine on each of
1121: the machines and the user will get many warnings about changed host keys.
1122: However, this option disables host authentication for localhost.
1123: The argument to this keyword must be
1124: .Dq yes
1125: or
1126: .Dq no .
1127: The default is to check the host key for localhost.
1128: .It Cm NumberOfPasswordPrompts
1129: Specifies the number of password prompts before giving up.
1130: The argument to this keyword must be an integer.
1.84 jmc 1131: The default is 3.
1.1 stevesk 1132: .It Cm PasswordAuthentication
1133: Specifies whether to use password authentication.
1134: The argument to this keyword must be
1135: .Dq yes
1136: or
1137: .Dq no .
1138: The default is
1139: .Dq yes .
1.65 reyk 1140: .It Cm PermitLocalCommand
1141: Allow local command execution via the
1142: .Ic LocalCommand
1143: option or using the
1.66 jmc 1144: .Ic !\& Ns Ar command
1.65 reyk 1145: escape sequence in
1146: .Xr ssh 1 .
1147: The argument must be
1148: .Dq yes
1149: or
1150: .Dq no .
1151: The default is
1152: .Dq no .
1.127 markus 1153: .It Cm PKCS11Provider
1154: Specifies which PKCS#11 provider to use.
1.144 jmc 1155: The argument to this keyword is the PKCS#11 shared library
1.127 markus 1156: .Xr ssh 1
1.128 markus 1157: should use to communicate with a PKCS#11 token providing the user's
1.127 markus 1158: private RSA key.
1.67 jmc 1159: .It Cm Port
1160: Specifies the port number to connect on the remote host.
1.84 jmc 1161: The default is 22.
1.1 stevesk 1162: .It Cm PreferredAuthentications
1163: Specifies the order in which the client should try protocol 2
1.11 jmc 1164: authentication methods.
1.48 jmc 1165: This allows a client to prefer one method (e.g.\&
1.1 stevesk 1166: .Cm keyboard-interactive )
1.48 jmc 1167: over another method (e.g.\&
1.131 jmc 1168: .Cm password ) .
1169: The default is:
1170: .Bd -literal -offset indent
1171: gssapi-with-mic,hostbased,publickey,
1172: keyboard-interactive,password
1173: .Ed
1.1 stevesk 1174: .It Cm Protocol
1175: Specifies the protocol versions
1.84 jmc 1176: .Xr ssh 1
1.1 stevesk 1177: should support in order of preference.
1178: The possible values are
1.84 jmc 1179: .Sq 1
1.1 stevesk 1180: and
1.84 jmc 1181: .Sq 2 .
1.1 stevesk 1182: Multiple versions must be comma-separated.
1.120 markus 1183: When this option is set to
1.121 jmc 1184: .Dq 2,1
1.120 markus 1185: .Nm ssh
1186: will try version 2 and fall back to version 1
1187: if version 2 is not available.
1.1 stevesk 1188: The default is
1.121 jmc 1189: .Sq 2 .
1.1 stevesk 1190: .It Cm ProxyCommand
1191: Specifies the command to use to connect to the server.
1192: The command
1.190 djm 1193: string extends to the end of the line, and is executed
1194: using the user's shell
1195: .Ql exec
1196: directive to avoid a lingering shell process.
1197: .Pp
1.133 jmc 1198: In the command string, any occurrence of
1.1 stevesk 1199: .Ql %h
1200: will be substituted by the host name to
1.132 djm 1201: connect,
1.1 stevesk 1202: .Ql %p
1.133 jmc 1203: by the port, and
1204: .Ql %r
1.132 djm 1205: by the remote user name.
1.1 stevesk 1206: The command can be basically anything,
1207: and should read from its standard input and write to its standard output.
1208: It should eventually connect an
1209: .Xr sshd 8
1210: server running on some machine, or execute
1211: .Ic sshd -i
1212: somewhere.
1213: Host key management will be done using the
1214: HostName of the host being connected (defaulting to the name typed by
1215: the user).
1.7 jmc 1216: Setting the command to
1217: .Dq none
1.6 markus 1218: disables this option entirely.
1.1 stevesk 1219: Note that
1220: .Cm CheckHostIP
1221: is not available for connects with a proxy command.
1.52 djm 1222: .Pp
1223: This directive is useful in conjunction with
1224: .Xr nc 1
1225: and its proxy support.
1.53 jmc 1226: For example, the following directive would connect via an HTTP proxy at
1.52 djm 1227: 192.0.2.0:
1228: .Bd -literal -offset 3n
1229: ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
1230: .Ed
1.167 djm 1231: .It Cm ProxyUseFdpass
1.168 jmc 1232: Specifies that
1.167 djm 1233: .Cm ProxyCommand
1234: will pass a connected file descriptor back to
1.168 jmc 1235: .Xr ssh 1
1.167 djm 1236: instead of continuing to execute and pass data.
1237: The default is
1238: .Dq no .
1.213 markus 1239: .It Cm PubkeyAcceptedKeyTypes
1240: Specifies the key types that will be used for public key authentication
1241: as a comma-separated pattern list.
1.214 ! djm 1242: Alternately if the specified value begins with a
! 1243: .Sq +
! 1244: character, then the key types after it will be appended to the default
! 1245: instead of replacing it.
1.213 markus 1246: The default for this option is:
1247: .Bd -literal -offset 3n
1248: ecdsa-sha2-nistp256-cert-v01@openssh.com,
1249: ecdsa-sha2-nistp384-cert-v01@openssh.com,
1250: ecdsa-sha2-nistp521-cert-v01@openssh.com,
1251: ssh-ed25519-cert-v01@openssh.com,
1252: ssh-rsa-cert-v01@openssh.com,
1253: ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1254: ssh-ed25519,ssh-rsa
1255: .Ed
1256: .Pp
1257: The
1258: .Fl Q
1259: option of
1260: .Xr ssh 1
1261: may be used to list supported key types.
1.1 stevesk 1262: .It Cm PubkeyAuthentication
1263: Specifies whether to try public key authentication.
1264: The argument to this keyword must be
1265: .Dq yes
1266: or
1267: .Dq no .
1268: The default is
1269: .Dq yes .
1270: This option applies to protocol version 2 only.
1.75 dtucker 1271: .It Cm RekeyLimit
1272: Specifies the maximum amount of data that may be transmitted before the
1.162 dtucker 1273: session key is renegotiated, optionally followed a maximum amount of
1274: time that may pass before the session key is renegotiated.
1275: The first argument is specified in bytes and may have a suffix of
1.76 jmc 1276: .Sq K ,
1277: .Sq M ,
1.75 dtucker 1278: or
1.76 jmc 1279: .Sq G
1.75 dtucker 1280: to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1281: The default is between
1.84 jmc 1282: .Sq 1G
1.75 dtucker 1283: and
1.84 jmc 1284: .Sq 4G ,
1.75 dtucker 1285: depending on the cipher.
1.162 dtucker 1286: The optional second value is specified in seconds and may use any of the
1287: units documented in the
1.166 jmc 1288: TIME FORMATS section of
1.162 dtucker 1289: .Xr sshd_config 5 .
1290: The default value for
1291: .Cm RekeyLimit
1292: is
1293: .Dq default none ,
1294: which means that rekeying is performed after the cipher's default amount
1295: of data has been sent or received and no time based rekeying is done.
1.76 jmc 1296: This option applies to protocol version 2 only.
1.1 stevesk 1297: .It Cm RemoteForward
1.74 jmc 1298: Specifies that a TCP port on the remote machine be forwarded over
1.1 stevesk 1299: the secure channel to the specified host and port from the local machine.
1.49 jmc 1300: The first argument must be
1.43 djm 1301: .Sm off
1.49 jmc 1302: .Oo Ar bind_address : Oc Ar port
1.43 djm 1303: .Sm on
1.49 jmc 1304: and the second argument must be
1305: .Ar host : Ns Ar hostport .
1.138 djm 1306: IPv6 addresses can be specified by enclosing addresses in square brackets.
1.1 stevesk 1307: Multiple forwardings may be specified, and additional
1308: forwardings can be given on the command line.
1.113 stevesk 1309: Privileged ports can be forwarded only when
1310: logging in as root on the remote machine.
1.118 jmc 1311: .Pp
1.117 djm 1312: If the
1313: .Ar port
1314: argument is
1315: .Ql 0 ,
1316: the listen port will be dynamically allocated on the server and reported
1317: to the client at run time.
1.43 djm 1318: .Pp
1319: If the
1320: .Ar bind_address
1321: is not specified, the default is to only bind to loopback addresses.
1322: If the
1323: .Ar bind_address
1324: is
1325: .Ql *
1326: or an empty string, then the forwarding is requested to listen on all
1327: interfaces.
1328: Specifying a remote
1329: .Ar bind_address
1.46 jmc 1330: will only succeed if the server's
1331: .Cm GatewayPorts
1.43 djm 1332: option is enabled (see
1.46 jmc 1333: .Xr sshd_config 5 ) .
1.149 djm 1334: .It Cm RequestTTY
1335: Specifies whether to request a pseudo-tty for the session.
1336: The argument may be one of:
1337: .Dq no
1338: (never request a TTY),
1339: .Dq yes
1340: (always request a TTY when standard input is a TTY),
1341: .Dq force
1342: (always request a TTY) or
1343: .Dq auto
1344: (request a TTY when opening a login session).
1345: This option mirrors the
1346: .Fl t
1347: and
1348: .Fl T
1349: flags for
1350: .Xr ssh 1 .
1.196 djm 1351: .It Cm RevokedHostKeys
1352: Specifies revoked host public keys.
1353: Keys listed in this file will be refused for host authentication.
1354: Note that if this file does not exist or is not readable,
1355: then host authentication will be refused for all hosts.
1356: Keys may be specified as a text file, listing one public key per line, or as
1357: an OpenSSH Key Revocation List (KRL) as generated by
1358: .Xr ssh-keygen 1 .
1359: For more information on KRLs, see the KEY REVOCATION LISTS section in
1360: .Xr ssh-keygen 1 .
1.1 stevesk 1361: .It Cm RhostsRSAAuthentication
1362: Specifies whether to try rhosts based authentication with RSA host
1363: authentication.
1364: The argument must be
1365: .Dq yes
1366: or
1367: .Dq no .
1368: The default is
1369: .Dq no .
1370: This option applies to protocol version 1 only and requires
1.84 jmc 1371: .Xr ssh 1
1.1 stevesk 1372: to be setuid root.
1373: .It Cm RSAAuthentication
1374: Specifies whether to try RSA authentication.
1375: The argument to this keyword must be
1376: .Dq yes
1377: or
1378: .Dq no .
1379: RSA authentication will only be
1380: attempted if the identity file exists, or an authentication agent is
1381: running.
1382: The default is
1383: .Dq yes .
1384: Note that this option applies to protocol version 1 only.
1.32 djm 1385: .It Cm SendEnv
1386: Specifies what variables from the local
1387: .Xr environ 7
1388: should be sent to the server.
1.84 jmc 1389: Note that environment passing is only supported for protocol 2.
1390: The server must also support it, and the server must be configured to
1.33 djm 1391: accept these environment variables.
1.207 dtucker 1392: Note that the
1393: .Ev TERM
1.208 jmc 1394: environment variable is always sent whenever a
1.207 dtucker 1395: pseudo-terminal is requested as it is required by the protocol.
1.32 djm 1396: Refer to
1397: .Cm AcceptEnv
1398: in
1399: .Xr sshd_config 5
1400: for how to configure the server.
1.80 jmc 1401: Variables are specified by name, which may contain wildcard characters.
1.33 djm 1402: Multiple environment variables may be separated by whitespace or spread
1.32 djm 1403: across multiple
1404: .Cm SendEnv
1405: directives.
1406: The default is not to send any environment variables.
1.81 jmc 1407: .Pp
1408: See
1409: .Sx PATTERNS
1410: for more information on patterns.
1.28 markus 1411: .It Cm ServerAliveCountMax
1.73 jmc 1412: Sets the number of server alive messages (see below) which may be
1.28 markus 1413: sent without
1.84 jmc 1414: .Xr ssh 1
1.28 markus 1415: receiving any messages back from the server.
1416: If this threshold is reached while server alive messages are being sent,
1.84 jmc 1417: ssh will disconnect from the server, terminating the session.
1.28 markus 1418: It is important to note that the use of server alive messages is very
1419: different from
1420: .Cm TCPKeepAlive
1421: (below).
1422: The server alive messages are sent through the encrypted channel
1423: and therefore will not be spoofable.
1424: The TCP keepalive option enabled by
1425: .Cm TCPKeepAlive
1426: is spoofable.
1427: The server alive mechanism is valuable when the client or
1428: server depend on knowing when a connection has become inactive.
1429: .Pp
1430: The default value is 3.
1431: If, for example,
1432: .Cm ServerAliveInterval
1.84 jmc 1433: (see below) is set to 15 and
1.28 markus 1434: .Cm ServerAliveCountMax
1.84 jmc 1435: is left at the default, if the server becomes unresponsive,
1436: ssh will disconnect after approximately 45 seconds.
1.89 markus 1437: This option applies to protocol version 2 only.
1.67 jmc 1438: .It Cm ServerAliveInterval
1439: Sets a timeout interval in seconds after which if no data has been received
1440: from the server,
1.84 jmc 1441: .Xr ssh 1
1.67 jmc 1442: will send a message through the encrypted
1443: channel to request a response from the server.
1444: The default
1445: is 0, indicating that these messages will not be sent to the server.
1446: This option applies to protocol version 2 only.
1.191 millert 1447: .It Cm StreamLocalBindMask
1448: Sets the octal file creation mode mask
1449: .Pq umask
1450: used when creating a Unix-domain socket file for local or remote
1451: port forwarding.
1452: This option is only used for port forwarding to a Unix-domain socket file.
1453: .Pp
1454: The default value is 0177, which creates a Unix-domain socket file that is
1455: readable and writable only by the owner.
1456: Note that not all operating systems honor the file mode on Unix-domain
1457: socket files.
1458: .It Cm StreamLocalBindUnlink
1459: Specifies whether to remove an existing Unix-domain socket file for local
1460: or remote port forwarding before creating a new one.
1461: If the socket file already exists and
1462: .Cm StreamLocalBindUnlink
1463: is not enabled,
1464: .Nm ssh
1465: will be unable to forward the port to the Unix-domain socket file.
1466: This option is only used for port forwarding to a Unix-domain socket file.
1467: .Pp
1468: The argument must be
1469: .Dq yes
1470: or
1471: .Dq no .
1472: The default is
1473: .Dq no .
1.1 stevesk 1474: .It Cm StrictHostKeyChecking
1475: If this flag is set to
1476: .Dq yes ,
1.84 jmc 1477: .Xr ssh 1
1.1 stevesk 1478: will never automatically add host keys to the
1.50 djm 1479: .Pa ~/.ssh/known_hosts
1.1 stevesk 1480: file, and refuses to connect to hosts whose host key has changed.
1481: This provides maximum protection against trojan horse attacks,
1.84 jmc 1482: though it can be annoying when the
1.1 stevesk 1483: .Pa /etc/ssh/ssh_known_hosts
1.84 jmc 1484: file is poorly maintained or when connections to new hosts are
1.1 stevesk 1485: frequently made.
1486: This option forces the user to manually
1487: add all new hosts.
1488: If this flag is set to
1489: .Dq no ,
1.84 jmc 1490: ssh will automatically add new host keys to the
1.1 stevesk 1491: user known hosts files.
1492: If this flag is set to
1493: .Dq ask ,
1494: new host keys
1495: will be added to the user known host files only after the user
1496: has confirmed that is what they really want to do, and
1.84 jmc 1497: ssh will refuse to connect to hosts whose host key has changed.
1.1 stevesk 1498: The host keys of
1499: known hosts will be verified automatically in all cases.
1500: The argument must be
1501: .Dq yes ,
1.84 jmc 1502: .Dq no ,
1.1 stevesk 1503: or
1504: .Dq ask .
1505: The default is
1506: .Dq ask .
1.26 markus 1507: .It Cm TCPKeepAlive
1508: Specifies whether the system should send TCP keepalive messages to the
1509: other side.
1510: If they are sent, death of the connection or crash of one
1511: of the machines will be properly noticed.
1512: However, this means that
1513: connections will die if the route is down temporarily, and some people
1514: find it annoying.
1515: .Pp
1516: The default is
1517: .Dq yes
1518: (to send TCP keepalive messages), and the client will notice
1519: if the network goes down or the remote host dies.
1520: This is important in scripts, and many users want it too.
1521: .Pp
1522: To disable TCP keepalive messages, the value should be set to
1523: .Dq no .
1.65 reyk 1524: .It Cm Tunnel
1.95 stevesk 1525: Request
1.65 reyk 1526: .Xr tun 4
1.69 jmc 1527: device forwarding between the client and the server.
1.65 reyk 1528: The argument must be
1.68 reyk 1529: .Dq yes ,
1.95 stevesk 1530: .Dq point-to-point
1531: (layer 3),
1532: .Dq ethernet
1533: (layer 2),
1.65 reyk 1534: or
1535: .Dq no .
1.95 stevesk 1536: Specifying
1537: .Dq yes
1538: requests the default tunnel mode, which is
1539: .Dq point-to-point .
1.65 reyk 1540: The default is
1541: .Dq no .
1542: .It Cm TunnelDevice
1.95 stevesk 1543: Specifies the
1.65 reyk 1544: .Xr tun 4
1.95 stevesk 1545: devices to open on the client
1546: .Pq Ar local_tun
1547: and the server
1548: .Pq Ar remote_tun .
1549: .Pp
1550: The argument must be
1551: .Sm off
1552: .Ar local_tun Op : Ar remote_tun .
1553: .Sm on
1554: The devices may be specified by numerical ID or the keyword
1555: .Dq any ,
1556: which uses the next available tunnel device.
1557: If
1558: .Ar remote_tun
1559: is not specified, it defaults to
1560: .Dq any .
1561: The default is
1562: .Dq any:any .
1.201 djm 1563: .It Cm UpdateHostKeys
1.200 djm 1564: Specifies whether
1565: .Xr ssh 1
1566: should accept notifications of additional hostkeys from the server sent
1567: after authentication has completed and add them to
1568: .Cm UserKnownHostsFile .
1569: The argument must be
1.204 djm 1570: .Dq yes ,
1.203 djm 1571: .Dq no
1.204 djm 1572: (the default) or
1573: .Dq ask .
1.200 djm 1574: Enabling this option allows learning alternate hostkeys for a server
1.201 djm 1575: and supports graceful key rotation by allowing a server to send replacement
1576: public keys before old ones are removed.
1.200 djm 1577: Additional hostkeys are only accepted if the key used to authenticate the
1578: host was already trusted or explicity accepted by the user.
1.204 djm 1579: If
1580: .Cm UpdateHostKeys
1581: is set to
1582: .Dq ask ,
1583: then the user is asked to confirm the modifications to the known_hosts file.
1.205 djm 1584: Confirmation is currently incompatible with
1585: .Cm ControlPersist ,
1586: and will be disabled if it is enabled.
1.200 djm 1587: .Pp
1588: Presently, only
1589: .Xr sshd 8
1590: from OpenSSH 6.8 and greater support the
1591: .Dq hostkeys@openssh.com
1592: protocol extension used to inform the client of all the server's hostkeys.
1.72 jmc 1593: .It Cm UsePrivilegedPort
1594: Specifies whether to use a privileged port for outgoing connections.
1595: The argument must be
1596: .Dq yes
1597: or
1598: .Dq no .
1599: The default is
1600: .Dq no .
1601: If set to
1.84 jmc 1602: .Dq yes ,
1603: .Xr ssh 1
1.72 jmc 1604: must be setuid root.
1605: Note that this option must be set to
1606: .Dq yes
1607: for
1608: .Cm RhostsRSAAuthentication
1609: with older servers.
1.1 stevesk 1610: .It Cm User
1611: Specifies the user to log in as.
1612: This can be useful when a different user name is used on different machines.
1613: This saves the trouble of
1614: having to remember to give the user name on the command line.
1615: .It Cm UserKnownHostsFile
1.151 djm 1616: Specifies one or more files to use for the user
1617: host key database, separated by whitespace.
1618: The default is
1619: .Pa ~/.ssh/known_hosts ,
1620: .Pa ~/.ssh/known_hosts2 .
1.8 jakob 1621: .It Cm VerifyHostKeyDNS
1622: Specifies whether to verify the remote key using DNS and SSHFP resource
1623: records.
1.24 jakob 1624: If this option is set to
1625: .Dq yes ,
1.25 jmc 1626: the client will implicitly trust keys that match a secure fingerprint
1.24 jakob 1627: from DNS.
1628: Insecure fingerprints will be handled as if this option was set to
1629: .Dq ask .
1630: If this option is set to
1631: .Dq ask ,
1632: information on fingerprint match will be displayed, but the user will still
1633: need to confirm new host keys according to the
1634: .Cm StrictHostKeyChecking
1635: option.
1636: The argument must be
1637: .Dq yes ,
1.84 jmc 1638: .Dq no ,
1.25 jmc 1639: or
1640: .Dq ask .
1.8 jakob 1641: The default is
1642: .Dq no .
1.12 jakob 1643: Note that this option applies to protocol version 2 only.
1.84 jmc 1644: .Pp
1.166 jmc 1645: See also VERIFYING HOST KEYS in
1.84 jmc 1646: .Xr ssh 1 .
1.111 grunk 1647: .It Cm VisualHostKey
1648: If this flag is set to
1649: .Dq yes ,
1650: an ASCII art representation of the remote host key fingerprint is
1.197 djm 1651: printed in addition to the fingerprint string at login and
1.114 stevesk 1652: for unknown host keys.
1.111 grunk 1653: If this flag is set to
1654: .Dq no ,
1.114 stevesk 1655: no fingerprint strings are printed at login and
1.197 djm 1656: only the fingerprint string will be printed for unknown host keys.
1.111 grunk 1657: The default is
1658: .Dq no .
1.1 stevesk 1659: .It Cm XAuthLocation
1.5 stevesk 1660: Specifies the full pathname of the
1.1 stevesk 1661: .Xr xauth 1
1662: program.
1663: The default is
1664: .Pa /usr/X11R6/bin/xauth .
1665: .El
1.86 jmc 1666: .Sh PATTERNS
1667: A
1668: .Em pattern
1669: consists of zero or more non-whitespace characters,
1670: .Sq *
1671: (a wildcard that matches zero or more characters),
1672: or
1673: .Sq ?\&
1674: (a wildcard that matches exactly one character).
1675: For example, to specify a set of declarations for any host in the
1676: .Dq .co.uk
1677: set of domains,
1678: the following pattern could be used:
1679: .Pp
1680: .Dl Host *.co.uk
1681: .Pp
1682: The following pattern
1683: would match any host in the 192.168.0.[0-9] network range:
1684: .Pp
1685: .Dl Host 192.168.0.?
1686: .Pp
1687: A
1688: .Em pattern-list
1689: is a comma-separated list of patterns.
1690: Patterns within pattern-lists may be negated
1691: by preceding them with an exclamation mark
1692: .Pq Sq !\& .
1693: For example,
1.174 djm 1694: to allow a key to be used from anywhere within an organization
1.86 jmc 1695: except from the
1696: .Dq dialup
1697: pool,
1698: the following entry (in authorized_keys) could be used:
1699: .Pp
1700: .Dl from=\&"!*.dialup.example.com,*.example.com\&"
1.1 stevesk 1701: .Sh FILES
1702: .Bl -tag -width Ds
1.50 djm 1703: .It Pa ~/.ssh/config
1.1 stevesk 1704: This is the per-user configuration file.
1705: The format of this file is described above.
1.84 jmc 1706: This file is used by the SSH client.
1.30 djm 1707: Because of the potential for abuse, this file must have strict permissions:
1708: read/write for the user, and not accessible by others.
1.1 stevesk 1709: .It Pa /etc/ssh/ssh_config
1710: Systemwide configuration file.
1711: This file provides defaults for those
1712: values that are not specified in the user's configuration file, and
1713: for those users who do not have a configuration file.
1714: This file must be world-readable.
1715: .El
1.13 jmc 1716: .Sh SEE ALSO
1717: .Xr ssh 1
1.1 stevesk 1718: .Sh AUTHORS
1719: OpenSSH is a derivative of the original and free
1720: ssh 1.2.12 release by Tatu Ylonen.
1721: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1722: Theo de Raadt and Dug Song
1723: removed many bugs, re-added newer features and
1724: created OpenSSH.
1725: Markus Friedl contributed the support for SSH
1726: protocol versions 1.5 and 2.0.
![[BACK]](/icons/back.gif){kind=icon}
Return to ssh_config.5 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh