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