]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - crypto/openssh/ssh_config.5
tcp: Rack compressed ack path updates the recv window too easily
[FreeBSD/FreeBSD.git] / crypto / openssh / ssh_config.5
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 .\"
36 .\" $OpenBSD: ssh_config.5,v 1.362 2021/08/12 23:59:25 djm Exp $
37 .\" $FreeBSD$
38 .Dd $Mdocdate: August 12 2021 $
39 .Dt SSH_CONFIG 5
40 .Os
41 .Sh NAME
42 .Nm ssh_config
43 .Nd OpenSSH client configuration file
44 .Sh DESCRIPTION
45 .Xr ssh 1
46 obtains configuration data from the following sources in
47 the following order:
48 .Pp
49 .Bl -enum -offset indent -compact
50 .It
51 command-line options
52 .It
53 user's configuration file
54 .Pq Pa ~/.ssh/config
55 .It
56 system-wide configuration file
57 .Pq Pa /etc/ssh/ssh_config
58 .El
59 .Pp
60 For each parameter, the first obtained value
61 will be used.
62 The configuration files contain sections separated by
63 .Cm Host
64 specifications, and that section is only applied for hosts that
65 match one of the patterns given in the specification.
66 The matched host name is usually the one given on the command line
67 (see the
68 .Cm CanonicalizeHostname
69 option for exceptions).
70 .Pp
71 Since the first obtained value for each parameter is used, more
72 host-specific declarations should be given near the beginning of the
73 file, and general defaults at the end.
74 .Pp
75 The file contains keyword-argument pairs, one per line.
76 Lines starting with
77 .Ql #
78 and empty lines are interpreted as comments.
79 Arguments may optionally be enclosed in double quotes
80 .Pq \&"
81 in order to represent arguments containing spaces.
82 Configuration options may be separated by whitespace or
83 optional whitespace and exactly one
84 .Ql = ;
85 the latter format is useful to avoid the need to quote whitespace
86 when specifying configuration options using the
87 .Nm ssh ,
88 .Nm scp ,
89 and
90 .Nm sftp
91 .Fl o
92 option.
93 .Pp
94 The possible
95 keywords and their meanings are as follows (note that
96 keywords are case-insensitive and arguments are case-sensitive):
97 .Bl -tag -width Ds
98 .It Cm Host
99 Restricts the following declarations (up to the next
100 .Cm Host
101 or
102 .Cm Match
103 keyword) to be only for those hosts that match one of the patterns
104 given after the keyword.
105 If more than one pattern is provided, they should be separated by whitespace.
106 A single
107 .Ql *
108 as a pattern can be used to provide global
109 defaults for all hosts.
110 The host is usually the
111 .Ar hostname
112 argument given on the command line
113 (see the
114 .Cm CanonicalizeHostname
115 keyword for exceptions).
116 .Pp
117 A pattern entry may be negated by prefixing it with an exclamation mark
118 .Pq Sq !\& .
119 If a negated entry is matched, then the
120 .Cm Host
121 entry is ignored, regardless of whether any other patterns on the line
122 match.
123 Negated matches are therefore useful to provide exceptions for wildcard
124 matches.
125 .Pp
126 See
127 .Sx PATTERNS
128 for more information on patterns.
129 .It Cm Match
130 Restricts the following declarations (up to the next
131 .Cm Host
132 or
133 .Cm Match
134 keyword) to be used only when the conditions following the
135 .Cm Match
136 keyword are satisfied.
137 Match conditions are specified using one or more criteria
138 or the single token
139 .Cm all
140 which always matches.
141 The available criteria keywords are:
142 .Cm canonical ,
143 .Cm final ,
144 .Cm exec ,
145 .Cm host ,
146 .Cm originalhost ,
147 .Cm user ,
148 and
149 .Cm localuser .
150 The
151 .Cm all
152 criteria must appear alone or immediately after
153 .Cm canonical
154 or
155 .Cm final .
156 Other criteria may be combined arbitrarily.
157 All criteria but
158 .Cm all ,
159 .Cm canonical ,
160 and
161 .Cm final
162 require an argument.
163 Criteria may be negated by prepending an exclamation mark
164 .Pq Sq !\& .
165 .Pp
166 The
167 .Cm canonical
168 keyword matches only when the configuration file is being re-parsed
169 after hostname canonicalization (see the
170 .Cm CanonicalizeHostname
171 option).
172 This may be useful to specify conditions that work with canonical host
173 names only.
174 .Pp
175 The
176 .Cm final
177 keyword requests that the configuration be re-parsed (regardless of whether
178 .Cm CanonicalizeHostname
179 is enabled), and matches only during this final pass.
180 If
181 .Cm CanonicalizeHostname
182 is enabled, then
183 .Cm canonical
184 and
185 .Cm final
186 match during the same pass.
187 .Pp
188 The
189 .Cm exec
190 keyword executes the specified command under the user's shell.
191 If the command returns a zero exit status then the condition is considered true.
192 Commands containing whitespace characters must be quoted.
193 Arguments to
194 .Cm exec
195 accept the tokens described in the
196 .Sx TOKENS
197 section.
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
208 or
209 .Cm CanonicalizeHostname
210 options.
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).
224 .It Cm AddKeysToAgent
225 Specifies whether keys should be automatically added to a running
226 .Xr ssh-agent 1 .
227 If this option is set to
228 .Cm 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 .Cm ask ,
234 .Xr ssh 1
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 .Cm 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 .Cm no ,
248 no keys are added to the agent.
249 Alternately, this option may be specified as a time interval
250 using the format described in the
251 .Sx TIME FORMATS
252 section of
253 .Xr sshd_config 5
254 to specify the key's lifetime in
255 .Xr ssh-agent 1 ,
256 after which it will automatically be removed.
257 The argument must be
258 .Cm no
259 (the default),
260 .Cm yes ,
261 .Cm confirm
262 (optionally followed by a time interval),
263 .Cm ask
264 or a time interval.
265 .It Cm AddressFamily
266 Specifies which address family to use when connecting.
267 Valid arguments are
268 .Cm any
269 (the default),
270 .Cm inet
271 (use IPv4 only), or
272 .Cm inet6
273 (use IPv6 only).
274 .It Cm BatchMode
275 If set to
276 .Cm yes ,
277 user interaction such as password prompts and host key confirmation requests
278 will be disabled.
279 This option is useful in scripts and other batch jobs where no user
280 is present to interact with
281 .Xr ssh 1 .
282 The argument must be
283 .Cm yes
284 or
285 .Cm no
286 (the default).
287 .It Cm BindAddress
288 Use the specified address on the local machine as the source address of
289 the connection.
290 Only useful on systems with more than one address.
291 .It Cm BindInterface
292 Use the address of the specified interface on the local machine as the
293 source address of the connection.
294 .It Cm CanonicalDomains
295 When
296 .Cm CanonicalizeHostname
297 is enabled, this option specifies the list of domain suffixes in which to
298 search for the specified destination host.
299 .It Cm CanonicalizeFallbackLocal
300 Specifies whether to fail with an error when hostname canonicalization fails.
301 The default,
302 .Cm yes ,
303 will attempt to look up the unqualified hostname using the system resolver's
304 search rules.
305 A value of
306 .Cm no
307 will cause
308 .Xr ssh 1
309 to fail instantly if
310 .Cm CanonicalizeHostname
311 is enabled and the target hostname cannot be found in any of the domains
312 specified by
313 .Cm CanonicalDomains .
314 .It Cm CanonicalizeHostname
315 Controls whether explicit hostname canonicalization is performed.
316 The default,
317 .Cm no ,
318 is not to perform any name rewriting and let the system resolver handle all
319 hostname lookups.
320 If set to
321 .Cm yes
322 then, for connections that do not use a
323 .Cm ProxyCommand
324 or
325 .Cm ProxyJump ,
326 .Xr ssh 1
327 will attempt to canonicalize the hostname specified on the command line
328 using the
329 .Cm CanonicalDomains
330 suffixes and
331 .Cm CanonicalizePermittedCNAMEs
332 rules.
333 If
334 .Cm CanonicalizeHostname
335 is set to
336 .Cm always ,
337 then canonicalization is applied to proxied connections too.
338 .Pp
339 If this option is enabled, then the configuration files are processed
340 again using the new target name to pick up any new configuration in matching
341 .Cm Host
342 and
343 .Cm Match
344 stanzas.
345 A value of
346 .Cm none
347 disables the use of a
348 .Cm ProxyJump
349 host.
350 .It Cm CanonicalizeMaxDots
351 Specifies the maximum number of dot characters in a hostname before
352 canonicalization is disabled.
353 The default, 1,
354 allows a single dot (i.e. hostname.subdomain).
355 .It Cm CanonicalizePermittedCNAMEs
356 Specifies rules to determine whether CNAMEs should be followed when
357 canonicalizing hostnames.
358 The rules consist of one or more arguments of
359 .Ar source_domain_list : Ns Ar target_domain_list ,
360 where
361 .Ar source_domain_list
362 is a pattern-list of domains that may follow CNAMEs in canonicalization,
363 and
364 .Ar target_domain_list
365 is a pattern-list of domains that they may resolve to.
366 .Pp
367 For example,
368 .Qq *.a.example.com:*.b.example.com,*.c.example.com
369 will allow hostnames matching
370 .Qq *.a.example.com
371 to be canonicalized to names in the
372 .Qq *.b.example.com
373 or
374 .Qq *.c.example.com
375 domains.
376 .It Cm CASignatureAlgorithms
377 Specifies which algorithms are allowed for signing of certificates
378 by certificate authorities (CAs).
379 The default is:
380 .Bd -literal -offset indent
381 ssh-ed25519,ecdsa-sha2-nistp256,
382 ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
383 sk-ssh-ed25519@openssh.com,
384 sk-ecdsa-sha2-nistp256@openssh.com,
385 rsa-sha2-512,rsa-sha2-256
386 .Ed
387 .Pp
388 If the specified list begins with a
389 .Sq +
390 character, then the specified algorithms will be appended to the default set
391 instead of replacing them.
392 If the specified list begins with a
393 .Sq -
394 character, then the specified algorithms (including wildcards) will be removed
395 from the default set instead of replacing them.
396 .Pp
397 .Xr ssh 1
398 will not accept host certificates signed using algorithms other than those
399 specified.
400 .It Cm CertificateFile
401 Specifies a file from which the user's certificate is read.
402 A corresponding private key must be provided separately in order
403 to use this certificate either
404 from an
405 .Cm IdentityFile
406 directive or
407 .Fl i
408 flag to
409 .Xr ssh 1 ,
410 via
411 .Xr ssh-agent 1 ,
412 or via a
413 .Cm PKCS11Provider
414 or
415 .Cm SecurityKeyProvider .
416 .Pp
417 Arguments to
418 .Cm CertificateFile
419 may use the tilde syntax to refer to a user's home directory,
420 the tokens described in the
421 .Sx TOKENS
422 section and environment variables as described in the
423 .Sx ENVIRONMENT VARIABLES
424 section.
425 .Pp
426 It is possible to have multiple certificate files specified in
427 configuration files; these certificates will be tried in sequence.
428 Multiple
429 .Cm CertificateFile
430 directives will add to the list of certificates used for
431 authentication.
432 .It Cm CheckHostIP
433 If set to
434 .Cm yes ,
435 .Xr ssh 1
436 will additionally check the host IP address in the
437 .Pa known_hosts
438 file.
439 This allows it to detect if a host key changed due to DNS spoofing
440 and will add addresses of destination hosts to
441 .Pa ~/.ssh/known_hosts
442 in the process, regardless of the setting of
443 .Cm StrictHostKeyChecking .
444 If the option is set to
445 .Cm no
446 (the default),
447 the check will not be executed.
448 The default is
449 .Cm no .
450 .It Cm Ciphers
451 Specifies the ciphers allowed and their order of preference.
452 Multiple ciphers must be comma-separated.
453 If the specified list begins with a
454 .Sq +
455 character, then the specified ciphers will be appended to the default set
456 instead of replacing them.
457 If the specified list begins with a
458 .Sq -
459 character, then the specified ciphers (including wildcards) will be removed
460 from the default set instead of replacing them.
461 If the specified list begins with a
462 .Sq ^
463 character, then the specified ciphers will be placed at the head of the
464 default set.
465 .Pp
466 The supported ciphers are:
467 .Bd -literal -offset indent
468 3des-cbc
469 aes128-cbc
470 aes192-cbc
471 aes256-cbc
472 aes128-ctr
473 aes192-ctr
474 aes256-ctr
475 aes128-gcm@openssh.com
476 aes256-gcm@openssh.com
477 chacha20-poly1305@openssh.com
478 .Ed
479 .Pp
480 The default is:
481 .Bd -literal -offset indent
482 chacha20-poly1305@openssh.com,
483 aes128-ctr,aes192-ctr,aes256-ctr,
484 aes128-gcm@openssh.com,aes256-gcm@openssh.com
485 .Ed
486 .Pp
487 The list of available ciphers may also be obtained using
488 .Qq ssh -Q cipher .
489 .It Cm ClearAllForwardings
490 Specifies that all local, remote, and dynamic port forwardings
491 specified in the configuration files or on the command line be
492 cleared.
493 This option is primarily useful when used from the
494 .Xr ssh 1
495 command line to clear port forwardings set in
496 configuration files, and is automatically set by
497 .Xr scp 1
498 and
499 .Xr sftp 1 .
500 The argument must be
501 .Cm yes
502 or
503 .Cm no
504 (the default).
505 .It Cm Compression
506 Specifies whether to use compression.
507 The argument must be
508 .Cm yes
509 or
510 .Cm no
511 (the default).
512 .It Cm ConnectionAttempts
513 Specifies the number of tries (one per second) to make before exiting.
514 The argument must be an integer.
515 This may be useful in scripts if the connection sometimes fails.
516 The default is 1.
517 .It Cm ConnectTimeout
518 Specifies the timeout (in seconds) used when connecting to the
519 SSH server, instead of using the default system TCP timeout.
520 This timeout is applied both to establishing the connection and to performing
521 the initial SSH protocol handshake and key exchange.
522 .It Cm ControlMaster
523 Enables the sharing of multiple sessions over a single network connection.
524 When set to
525 .Cm yes ,
526 .Xr ssh 1
527 will listen for connections on a control socket specified using the
528 .Cm ControlPath
529 argument.
530 Additional sessions can connect to this socket using the same
531 .Cm ControlPath
532 with
533 .Cm ControlMaster
534 set to
535 .Cm no
536 (the default).
537 These sessions will try to reuse the master instance's network connection
538 rather than initiating new ones, but will fall back to connecting normally
539 if the control socket does not exist, or is not listening.
540 .Pp
541 Setting this to
542 .Cm ask
543 will cause
544 .Xr ssh 1
545 to listen for control connections, but require confirmation using
546 .Xr ssh-askpass 1 .
547 If the
548 .Cm ControlPath
549 cannot be opened,
550 .Xr ssh 1
551 will continue without connecting to a master instance.
552 .Pp
553 X11 and
554 .Xr ssh-agent 1
555 forwarding is supported over these multiplexed connections, however the
556 display and agent forwarded will be the one belonging to the master
557 connection i.e. it is not possible to forward multiple displays or agents.
558 .Pp
559 Two additional options allow for opportunistic multiplexing: try to use a
560 master connection but fall back to creating a new one if one does not already
561 exist.
562 These options are:
563 .Cm auto
564 and
565 .Cm autoask .
566 The latter requires confirmation like the
567 .Cm ask
568 option.
569 .It Cm ControlPath
570 Specify the path to the control socket used for connection sharing as described
571 in the
572 .Cm ControlMaster
573 section above or the string
574 .Cm none
575 to disable connection sharing.
576 Arguments to
577 .Cm ControlPath
578 may use the tilde syntax to refer to a user's home directory,
579 the tokens described in the
580 .Sx TOKENS
581 section and environment variables as described in the
582 .Sx ENVIRONMENT VARIABLES
583 section.
584 It is recommended that any
585 .Cm ControlPath
586 used for opportunistic connection sharing include
587 at least %h, %p, and %r (or alternatively %C) and be placed in a directory
588 that is not writable by other users.
589 This ensures that shared connections are uniquely identified.
590 .It Cm ControlPersist
591 When used in conjunction with
592 .Cm ControlMaster ,
593 specifies that the master connection should remain open
594 in the background (waiting for future client connections)
595 after the initial client connection has been closed.
596 If set to
597 .Cm no
598 (the default),
599 then the master connection will not be placed into the background,
600 and will close as soon as the initial client connection is closed.
601 If set to
602 .Cm yes
603 or 0,
604 then the master connection will remain in the background indefinitely
605 (until killed or closed via a mechanism such as the
606 .Qq ssh -O exit ) .
607 If set to a time in seconds, or a time in any of the formats documented in
608 .Xr sshd_config 5 ,
609 then the backgrounded master connection will automatically terminate
610 after it has remained idle (with no client connections) for the
611 specified time.
612 .It Cm DynamicForward
613 Specifies that a TCP port on the local machine be forwarded
614 over the secure channel, and the application
615 protocol is then used to determine where to connect to from the
616 remote machine.
617 .Pp
618 The argument must be
619 .Sm off
620 .Oo Ar bind_address : Oc Ar port .
621 .Sm on
622 IPv6 addresses can be specified by enclosing addresses in square brackets.
623 By default, the local port is bound in accordance with the
624 .Cm GatewayPorts
625 setting.
626 However, an explicit
627 .Ar bind_address
628 may be used to bind the connection to a specific address.
629 The
630 .Ar bind_address
631 of
632 .Cm localhost
633 indicates that the listening port be bound for local use only, while an
634 empty address or
635 .Sq *
636 indicates that the port should be available from all interfaces.
637 .Pp
638 Currently the SOCKS4 and SOCKS5 protocols are supported, and
639 .Xr ssh 1
640 will act as a SOCKS server.
641 Multiple forwardings may be specified, and
642 additional forwardings can be given on the command line.
643 Only the superuser can forward privileged ports.
644 .It Cm EnableSSHKeysign
645 Setting this option to
646 .Cm yes
647 in the global client configuration file
648 .Pa /etc/ssh/ssh_config
649 enables the use of the helper program
650 .Xr ssh-keysign 8
651 during
652 .Cm HostbasedAuthentication .
653 The argument must be
654 .Cm yes
655 or
656 .Cm no
657 (the default).
658 This option should be placed in the non-hostspecific section.
659 See
660 .Xr ssh-keysign 8
661 for more information.
662 .It Cm EscapeChar
663 Sets the escape character (default:
664 .Ql ~ ) .
665 The escape character can also
666 be set on the command line.
667 The argument should be a single character,
668 .Ql ^
669 followed by a letter, or
670 .Cm none
671 to disable the escape
672 character entirely (making the connection transparent for binary
673 data).
674 .It Cm ExitOnForwardFailure
675 Specifies whether
676 .Xr ssh 1
677 should terminate the connection if it cannot set up all requested
678 dynamic, tunnel, local, and remote port forwardings, (e.g.\&
679 if either end is unable to bind and listen on a specified port).
680 Note that
681 .Cm ExitOnForwardFailure
682 does not apply to connections made over port forwardings and will not,
683 for example, cause
684 .Xr ssh 1
685 to exit if TCP connections to the ultimate forwarding destination fail.
686 The argument must be
687 .Cm yes
688 or
689 .Cm no
690 (the default).
691 .It Cm FingerprintHash
692 Specifies the hash algorithm used when displaying key fingerprints.
693 Valid options are:
694 .Cm md5
695 and
696 .Cm sha256
697 (the default).
698 .It Cm ForkAfterAuthentication
699 Requests
700 .Nm ssh
701 to go to background just before command execution.
702 This is useful if
703 .Nm ssh
704 is going to ask for passwords or passphrases, but the user
705 wants it in the background.
706 This implies the
707 .Cm StdinNull
708 configuration option being set to
709 .Dq yes .
710 The recommended way to start X11 programs at a remote site is with
711 something like
712 .Ic ssh -f host xterm ,
713 which is the same as
714 .Ic ssh host xterm
715 if the
716 .Cm ForkAfterAuthentication
717 configuration option is set to
718 .Dq yes .
719 .Pp
720 If the
721 .Cm ExitOnForwardFailure
722 configuration option is set to
723 .Dq yes ,
724 then a client started with the
725 .Cm ForkAfterAuthentication
726 configuration option being set to
727 .Dq yes
728 will wait for all remote port forwards to be successfully established
729 before placing itself in the background.
730 The argument to this keyword must be
731 .Cm yes
732 (same as the
733 .Fl f
734 option) or
735 .Cm no
736 (the default).
737 .It Cm ForwardAgent
738 Specifies whether the connection to the authentication agent (if any)
739 will be forwarded to the remote machine.
740 The argument may be
741 .Cm yes ,
742 .Cm no
743 (the default),
744 an explicit path to an agent socket or the name of an environment variable
745 (beginning with
746 .Sq $ )
747 in which to find the path.
748 .Pp
749 Agent forwarding should be enabled with caution.
750 Users with the ability to bypass file permissions on the remote host
751 (for the agent's Unix-domain socket)
752 can access the local agent through the forwarded connection.
753 An attacker cannot obtain key material from the agent,
754 however they can perform operations on the keys that enable them to
755 authenticate using the identities loaded into the agent.
756 .It Cm ForwardX11
757 Specifies whether X11 connections will be automatically redirected
758 over the secure channel and
759 .Ev DISPLAY
760 set.
761 The argument must be
762 .Cm yes
763 or
764 .Cm no
765 (the default).
766 .Pp
767 X11 forwarding should be enabled with caution.
768 Users with the ability to bypass file permissions on the remote host
769 (for the user's X11 authorization database)
770 can access the local X11 display through the forwarded connection.
771 An attacker may then be able to perform activities such as keystroke monitoring
772 if the
773 .Cm ForwardX11Trusted
774 option is also enabled.
775 .It Cm ForwardX11Timeout
776 Specify a timeout for untrusted X11 forwarding
777 using the format described in the
778 .Sx TIME FORMATS
779 section of
780 .Xr sshd_config 5 .
781 X11 connections received by
782 .Xr ssh 1
783 after this time will be refused.
784 Setting
785 .Cm ForwardX11Timeout
786 to zero will disable the timeout and permit X11 forwarding for the life
787 of the connection.
788 The default is to disable untrusted X11 forwarding after twenty minutes has
789 elapsed.
790 .It Cm ForwardX11Trusted
791 If this option is set to
792 .Cm yes ,
793 remote X11 clients will have full access to the original X11 display.
794 .Pp
795 If this option is set to
796 .Cm no
797 (the default),
798 remote X11 clients will be considered untrusted and prevented
799 from stealing or tampering with data belonging to trusted X11
800 clients.
801 Furthermore, the
802 .Xr xauth 1
803 token used for the session will be set to expire after 20 minutes.
804 Remote clients will be refused access after this time.
805 .Pp
806 See the X11 SECURITY extension specification for full details on
807 the restrictions imposed on untrusted clients.
808 .It Cm GatewayPorts
809 Specifies whether remote hosts are allowed to connect to local
810 forwarded ports.
811 By default,
812 .Xr ssh 1
813 binds local port forwardings to the loopback address.
814 This prevents other remote hosts from connecting to forwarded ports.
815 .Cm GatewayPorts
816 can be used to specify that ssh
817 should bind local port forwardings to the wildcard address,
818 thus allowing remote hosts to connect to forwarded ports.
819 The argument must be
820 .Cm yes
821 or
822 .Cm no
823 (the default).
824 .It Cm GlobalKnownHostsFile
825 Specifies one or more files to use for the global
826 host key database, separated by whitespace.
827 The default is
828 .Pa /etc/ssh/ssh_known_hosts ,
829 .Pa /etc/ssh/ssh_known_hosts2 .
830 .It Cm GSSAPIAuthentication
831 Specifies whether user authentication based on GSSAPI is allowed.
832 The default is
833 .Cm no .
834 .It Cm GSSAPIDelegateCredentials
835 Forward (delegate) credentials to the server.
836 The default is
837 .Cm no .
838 .It Cm HashKnownHosts
839 Indicates that
840 .Xr ssh 1
841 should hash host names and addresses when they are added to
842 .Pa ~/.ssh/known_hosts .
843 These hashed names may be used normally by
844 .Xr ssh 1
845 and
846 .Xr sshd 8 ,
847 but they do not visually reveal identifying information if the
848 file's contents are disclosed.
849 The default is
850 .Cm no .
851 Note that existing names and addresses in known hosts files
852 will not be converted automatically,
853 but may be manually hashed using
854 .Xr ssh-keygen 1 .
855 .It Cm HostbasedAcceptedAlgorithms
856 Specifies the signature algorithms that will be used for hostbased
857 authentication as a comma-separated list of patterns.
858 Alternately if the specified list begins with a
859 .Sq +
860 character, then the specified signature algorithms will be appended
861 to the default set instead of replacing them.
862 If the specified list begins with a
863 .Sq -
864 character, then the specified signature algorithms (including wildcards)
865 will be removed from the default set instead of replacing them.
866 If the specified list begins with a
867 .Sq ^
868 character, then the specified signature algorithms will be placed
869 at the head of the default set.
870 The default for this option is:
871 .Bd -literal -offset 3n
872 ssh-ed25519-cert-v01@openssh.com,
873 ecdsa-sha2-nistp256-cert-v01@openssh.com,
874 ecdsa-sha2-nistp384-cert-v01@openssh.com,
875 ecdsa-sha2-nistp521-cert-v01@openssh.com,
876 sk-ssh-ed25519-cert-v01@openssh.com,
877 sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
878 rsa-sha2-512-cert-v01@openssh.com,
879 rsa-sha2-256-cert-v01@openssh.com,
880 ssh-rsa-cert-v01@openssh.com,
881 ssh-ed25519,
882 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
883 sk-ssh-ed25519@openssh.com,
884 sk-ecdsa-sha2-nistp256@openssh.com,
885 rsa-sha2-512,rsa-sha2-256,ssh-rsa
886 .Ed
887 .Pp
888 The
889 .Fl Q
890 option of
891 .Xr ssh 1
892 may be used to list supported signature algorithms.
893 This was formerly named HostbasedKeyTypes.
894 .It Cm HostbasedAuthentication
895 Specifies whether to try rhosts based authentication with public key
896 authentication.
897 The argument must be
898 .Cm yes
899 or
900 .Cm no
901 (the default).
902 .It Cm HostKeyAlgorithms
903 Specifies the host key signature algorithms
904 that the client wants to use in order of preference.
905 Alternately if the specified list begins with a
906 .Sq +
907 character, then the specified signature algorithms will be appended to
908 the default set instead of replacing them.
909 If the specified list begins with a
910 .Sq -
911 character, then the specified signature algorithms (including wildcards)
912 will be removed from the default set instead of replacing them.
913 If the specified list begins with a
914 .Sq ^
915 character, then the specified signature algorithms will be placed
916 at the head of the default set.
917 The default for this option is:
918 .Bd -literal -offset 3n
919 ssh-ed25519-cert-v01@openssh.com,
920 ecdsa-sha2-nistp256-cert-v01@openssh.com,
921 ecdsa-sha2-nistp384-cert-v01@openssh.com,
922 ecdsa-sha2-nistp521-cert-v01@openssh.com,
923 sk-ssh-ed25519-cert-v01@openssh.com,
924 sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
925 rsa-sha2-512-cert-v01@openssh.com,
926 rsa-sha2-256-cert-v01@openssh.com,
927 ssh-rsa-cert-v01@openssh.com,
928 ssh-ed25519,
929 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
930 sk-ecdsa-sha2-nistp256@openssh.com,
931 sk-ssh-ed25519@openssh.com,
932 rsa-sha2-512,rsa-sha2-256,ssh-rsa
933 .Ed
934 .Pp
935 If hostkeys are known for the destination host then this default is modified
936 to prefer their algorithms.
937 .Pp
938 The list of available signature algorithms may also be obtained using
939 .Qq ssh -Q HostKeyAlgorithms .
940 .It Cm HostKeyAlias
941 Specifies an alias that should be used instead of the
942 real host name when looking up or saving the host key
943 in the host key database files and when validating host certificates.
944 This option is useful for tunneling SSH connections
945 or for multiple servers running on a single host.
946 .It Cm Hostname
947 Specifies the real host name to log into.
948 This can be used to specify nicknames or abbreviations for hosts.
949 Arguments to
950 .Cm Hostname
951 accept the tokens described in the
952 .Sx TOKENS
953 section.
954 Numeric IP addresses are also permitted (both on the command line and in
955 .Cm Hostname
956 specifications).
957 The default is the name given on the command line.
958 .It Cm IdentitiesOnly
959 Specifies that
960 .Xr ssh 1
961 should only use the configured authentication identity and certificate files
962 (either the default files, or those explicitly configured in the
963 .Nm
964 files
965 or passed on the
966 .Xr ssh 1
967 command-line),
968 even if
969 .Xr ssh-agent 1
970 or a
971 .Cm PKCS11Provider
972 or
973 .Cm SecurityKeyProvider
974 offers more identities.
975 The argument to this keyword must be
976 .Cm yes
977 or
978 .Cm no
979 (the default).
980 This option is intended for situations where ssh-agent
981 offers many different identities.
982 .It Cm IdentityAgent
983 Specifies the
984 .Ux Ns -domain
985 socket used to communicate with the authentication agent.
986 .Pp
987 This option overrides the
988 .Ev SSH_AUTH_SOCK
989 environment variable and can be used to select a specific agent.
990 Setting the socket name to
991 .Cm none
992 disables the use of an authentication agent.
993 If the string
994 .Qq SSH_AUTH_SOCK
995 is specified, the location of the socket will be read from the
996 .Ev SSH_AUTH_SOCK
997 environment variable.
998 Otherwise if the specified value begins with a
999 .Sq $
1000 character, then it will be treated as an environment variable containing
1001 the location of the socket.
1002 .Pp
1003 Arguments to
1004 .Cm IdentityAgent
1005 may use the tilde syntax to refer to a user's home directory,
1006 the tokens described in the
1007 .Sx TOKENS
1008 section and environment variables as described in the
1009 .Sx ENVIRONMENT VARIABLES
1010 section.
1011 .It Cm IdentityFile
1012 Specifies a file from which the user's DSA, ECDSA, authenticator-hosted ECDSA,
1013 Ed25519, authenticator-hosted Ed25519 or RSA authentication identity is read.
1014 The default is
1015 .Pa ~/.ssh/id_dsa ,
1016 .Pa ~/.ssh/id_ecdsa ,
1017 .Pa ~/.ssh/id_ecdsa_sk ,
1018 .Pa ~/.ssh/id_ed25519 ,
1019 .Pa ~/.ssh/id_ed25519_sk
1020 and
1021 .Pa ~/.ssh/id_rsa .
1022 Additionally, any identities represented by the authentication agent
1023 will be used for authentication unless
1024 .Cm IdentitiesOnly
1025 is set.
1026 If no certificates have been explicitly specified by
1027 .Cm CertificateFile ,
1028 .Xr ssh 1
1029 will try to load certificate information from the filename obtained by
1030 appending
1031 .Pa -cert.pub
1032 to the path of a specified
1033 .Cm IdentityFile .
1034 .Pp
1035 Arguments to
1036 .Cm IdentityFile
1037 may use the tilde syntax to refer to a user's home directory
1038 or the tokens described in the
1039 .Sx TOKENS
1040 section.
1041 .Pp
1042 It is possible to have
1043 multiple identity files specified in configuration files; all these
1044 identities will be tried in sequence.
1045 Multiple
1046 .Cm IdentityFile
1047 directives will add to the list of identities tried (this behaviour
1048 differs from that of other configuration directives).
1049 .Pp
1050 .Cm IdentityFile
1051 may be used in conjunction with
1052 .Cm IdentitiesOnly
1053 to select which identities in an agent are offered during authentication.
1054 .Cm IdentityFile
1055 may also be used in conjunction with
1056 .Cm CertificateFile
1057 in order to provide any certificate also needed for authentication with
1058 the identity.
1059 .It Cm IgnoreUnknown
1060 Specifies a pattern-list of unknown options to be ignored if they are
1061 encountered in configuration parsing.
1062 This may be used to suppress errors if
1063 .Nm
1064 contains options that are unrecognised by
1065 .Xr ssh 1 .
1066 It is recommended that
1067 .Cm IgnoreUnknown
1068 be listed early in the configuration file as it will not be applied
1069 to unknown options that appear before it.
1070 .It Cm Include
1071 Include the specified configuration file(s).
1072 Multiple pathnames may be specified and each pathname may contain
1073 .Xr glob 7
1074 wildcards and, for user configurations, shell-like
1075 .Sq ~
1076 references to user home directories.
1077 Wildcards will be expanded and processed in lexical order.
1078 Files without absolute paths are assumed to be in
1079 .Pa ~/.ssh
1080 if included in a user configuration file or
1081 .Pa /etc/ssh
1082 if included from the system configuration file.
1083 .Cm Include
1084 directive may appear inside a
1085 .Cm Match
1086 or
1087 .Cm Host
1088 block
1089 to perform conditional inclusion.
1090 .It Cm IPQoS
1091 Specifies the IPv4 type-of-service or DSCP class for connections.
1092 Accepted values are
1093 .Cm af11 ,
1094 .Cm af12 ,
1095 .Cm af13 ,
1096 .Cm af21 ,
1097 .Cm af22 ,
1098 .Cm af23 ,
1099 .Cm af31 ,
1100 .Cm af32 ,
1101 .Cm af33 ,
1102 .Cm af41 ,
1103 .Cm af42 ,
1104 .Cm af43 ,
1105 .Cm cs0 ,
1106 .Cm cs1 ,
1107 .Cm cs2 ,
1108 .Cm cs3 ,
1109 .Cm cs4 ,
1110 .Cm cs5 ,
1111 .Cm cs6 ,
1112 .Cm cs7 ,
1113 .Cm ef ,
1114 .Cm le ,
1115 .Cm lowdelay ,
1116 .Cm throughput ,
1117 .Cm reliability ,
1118 a numeric value, or
1119 .Cm none
1120 to use the operating system default.
1121 This option may take one or two arguments, separated by whitespace.
1122 If one argument is specified, it is used as the packet class unconditionally.
1123 If two values are specified, the first is automatically selected for
1124 interactive sessions and the second for non-interactive sessions.
1125 The default is
1126 .Cm af21
1127 (Low-Latency Data)
1128 for interactive sessions and
1129 .Cm cs1
1130 (Lower Effort)
1131 for non-interactive sessions.
1132 .It Cm KbdInteractiveAuthentication
1133 Specifies whether to use keyboard-interactive authentication.
1134 The argument to this keyword must be
1135 .Cm yes
1136 (the default)
1137 or
1138 .Cm no .
1139 .Cm ChallengeResponseAuthentication
1140 is a deprecated alias for this.
1141 .It Cm KbdInteractiveDevices
1142 Specifies the list of methods to use in keyboard-interactive authentication.
1143 Multiple method names must be comma-separated.
1144 The default is to use the server specified list.
1145 The methods available vary depending on what the server supports.
1146 For an OpenSSH server,
1147 it may be zero or more of:
1148 .Cm bsdauth
1149 and
1150 .Cm pam .
1151 .It Cm KexAlgorithms
1152 Specifies the available KEX (Key Exchange) algorithms.
1153 Multiple algorithms must be comma-separated.
1154 If the specified list begins with a
1155 .Sq +
1156 character, then the specified methods will be appended to the default set
1157 instead of replacing them.
1158 If the specified list begins with a
1159 .Sq -
1160 character, then the specified methods (including wildcards) will be removed
1161 from the default set instead of replacing them.
1162 If the specified list begins with a
1163 .Sq ^
1164 character, then the specified methods will be placed at the head of the
1165 default set.
1166 The default is:
1167 .Bd -literal -offset indent
1168 curve25519-sha256,curve25519-sha256@libssh.org,
1169 ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1170 diffie-hellman-group-exchange-sha256,
1171 diffie-hellman-group16-sha512,
1172 diffie-hellman-group18-sha512,
1173 diffie-hellman-group14-sha256
1174 .Ed
1175 .Pp
1176 The list of available key exchange algorithms may also be obtained using
1177 .Qq ssh -Q kex .
1178 .It Cm KnownHostsCommand
1179 Specifies a command to use to obtain a list of host keys, in addition to
1180 those listed in
1181 .Cm UserKnownHostsFile
1182 and
1183 .Cm GlobalKnownHostsFile .
1184 This command is executed after the files have been read.
1185 It may write host key lines to standard output in identical format to the
1186 usual files (described in the
1187 .Sx VERIFYING HOST KEYS
1188 section in
1189 .Xr ssh 1 ) .
1190 Arguments to
1191 .Cm KnownHostsCommand
1192 accept the tokens described in the
1193 .Sx TOKENS
1194 section.
1195 The command may be invoked multiple times per connection: once when preparing
1196 the preference list of host key algorithms to use, again to obtain the
1197 host key for the requested host name and, if
1198 .Cm CheckHostIP
1199 is enabled, one more time to obtain the host key matching the server's
1200 address.
1201 If the command exits abnormally or returns a non-zero exit status then the
1202 connection is terminated.
1203 .It Cm LocalCommand
1204 Specifies a command to execute on the local machine after successfully
1205 connecting to the server.
1206 The command string extends to the end of the line, and is executed with
1207 the user's shell.
1208 Arguments to
1209 .Cm LocalCommand
1210 accept the tokens described in the
1211 .Sx TOKENS
1212 section.
1213 .Pp
1214 The command is run synchronously and does not have access to the
1215 session of the
1216 .Xr ssh 1
1217 that spawned it.
1218 It should not be used for interactive commands.
1219 .Pp
1220 This directive is ignored unless
1221 .Cm PermitLocalCommand
1222 has been enabled.
1223 .It Cm LocalForward
1224 Specifies that a TCP port on the local machine be forwarded over
1225 the secure channel to the specified host and port from the remote machine.
1226 The first argument specifies the listener and may be
1227 .Sm off
1228 .Oo Ar bind_address : Oc Ar port
1229 .Sm on
1230 or a Unix domain socket path.
1231 The second argument is the destination and may be
1232 .Ar host : Ns Ar hostport
1233 or a Unix domain socket path if the remote host supports it.
1234 .Pp
1235 IPv6 addresses can be specified by enclosing addresses in square brackets.
1236 Multiple forwardings may be specified, and additional forwardings can be
1237 given on the command line.
1238 Only the superuser can forward privileged ports.
1239 By default, the local port is bound in accordance with the
1240 .Cm GatewayPorts
1241 setting.
1242 However, an explicit
1243 .Ar bind_address
1244 may be used to bind the connection to a specific address.
1245 The
1246 .Ar bind_address
1247 of
1248 .Cm localhost
1249 indicates that the listening port be bound for local use only, while an
1250 empty address or
1251 .Sq *
1252 indicates that the port should be available from all interfaces.
1253 Unix domain socket paths may use the tokens described in the
1254 .Sx TOKENS
1255 section and environment variables as described in the
1256 .Sx ENVIRONMENT VARIABLES
1257 section.
1258 .It Cm LogLevel
1259 Gives the verbosity level that is used when logging messages from
1260 .Xr ssh 1 .
1261 The possible values are:
1262 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
1263 The default is INFO.
1264 DEBUG and DEBUG1 are equivalent.
1265 DEBUG2 and DEBUG3 each specify higher levels of verbose output.
1266 .It Cm LogVerbose
1267 Specify one or more overrides to LogLevel.
1268 An override consists of a pattern lists that matches the source file, function
1269 and line number to force detailed logging for.
1270 For example, an override pattern of:
1271 .Bd -literal -offset indent
1272 kex.c:*:1000,*:kex_exchange_identification():*,packet.c:*
1273 .Ed
1274 .Pp
1275 would enable detailed logging for line 1000 of
1276 .Pa kex.c ,
1277 everything in the
1278 .Fn kex_exchange_identification
1279 function, and all code in the
1280 .Pa packet.c
1281 file.
1282 This option is intended for debugging and no overrides are enabled by default.
1283 .It Cm MACs
1284 Specifies the MAC (message authentication code) algorithms
1285 in order of preference.
1286 The MAC algorithm is used for data integrity protection.
1287 Multiple algorithms must be comma-separated.
1288 If the specified list begins with a
1289 .Sq +
1290 character, then the specified algorithms will be appended to the default set
1291 instead of replacing them.
1292 If the specified list begins with a
1293 .Sq -
1294 character, then the specified algorithms (including wildcards) will be removed
1295 from the default set instead of replacing them.
1296 If the specified list begins with a
1297 .Sq ^
1298 character, then the specified algorithms will be placed at the head of the
1299 default set.
1300 .Pp
1301 The algorithms that contain
1302 .Qq -etm
1303 calculate the MAC after encryption (encrypt-then-mac).
1304 These are considered safer and their use recommended.
1305 .Pp
1306 The default is:
1307 .Bd -literal -offset indent
1308 umac-64-etm@openssh.com,umac-128-etm@openssh.com,
1309 hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
1310 hmac-sha1-etm@openssh.com,
1311 umac-64@openssh.com,umac-128@openssh.com,
1312 hmac-sha2-256,hmac-sha2-512,hmac-sha1
1313 .Ed
1314 .Pp
1315 The list of available MAC algorithms may also be obtained using
1316 .Qq ssh -Q mac .
1317 .It Cm NoHostAuthenticationForLocalhost
1318 Disable host authentication for localhost (loopback addresses).
1319 The argument to this keyword must be
1320 .Cm yes
1321 or
1322 .Cm no
1323 (the default).
1324 .It Cm NumberOfPasswordPrompts
1325 Specifies the number of password prompts before giving up.
1326 The argument to this keyword must be an integer.
1327 The default is 3.
1328 .It Cm PasswordAuthentication
1329 Specifies whether to use password authentication.
1330 The argument to this keyword must be
1331 .Cm yes
1332 (the default)
1333 or
1334 .Cm no .
1335 .It Cm PermitLocalCommand
1336 Allow local command execution via the
1337 .Ic LocalCommand
1338 option or using the
1339 .Ic !\& Ns Ar command
1340 escape sequence in
1341 .Xr ssh 1 .
1342 The argument must be
1343 .Cm yes
1344 or
1345 .Cm no
1346 (the default).
1347 .It Cm PermitRemoteOpen
1348 Specifies the destinations to which remote TCP port forwarding is permitted when
1349 .Cm RemoteForward
1350 is used as a SOCKS proxy.
1351 The forwarding specification must be one of the following forms:
1352 .Pp
1353 .Bl -item -offset indent -compact
1354 .It
1355 .Cm PermitRemoteOpen
1356 .Sm off
1357 .Ar host : port
1358 .Sm on
1359 .It
1360 .Cm PermitRemoteOpen
1361 .Sm off
1362 .Ar IPv4_addr : port
1363 .Sm on
1364 .It
1365 .Cm PermitRemoteOpen
1366 .Sm off
1367 .Ar \&[ IPv6_addr \&] : port
1368 .Sm on
1369 .El
1370 .Pp
1371 Multiple forwards may be specified by separating them with whitespace.
1372 An argument of
1373 .Cm any
1374 can be used to remove all restrictions and permit any forwarding requests.
1375 An argument of
1376 .Cm none
1377 can be used to prohibit all forwarding requests.
1378 The wildcard
1379 .Sq *
1380 can be used for host or port to allow all hosts or ports respectively.
1381 Otherwise, no pattern matching or address lookups are performed on supplied
1382 names.
1383 .It Cm PKCS11Provider
1384 Specifies which PKCS#11 provider to use or
1385 .Cm none
1386 to indicate that no provider should be used (the default).
1387 The argument to this keyword is a path to the PKCS#11 shared library
1388 .Xr ssh 1
1389 should use to communicate with a PKCS#11 token providing keys for user
1390 authentication.
1391 .It Cm Port
1392 Specifies the port number to connect on the remote host.
1393 The default is 22.
1394 .It Cm PreferredAuthentications
1395 Specifies the order in which the client should try authentication methods.
1396 This allows a client to prefer one method (e.g.\&
1397 .Cm keyboard-interactive )
1398 over another method (e.g.\&
1399 .Cm password ) .
1400 The default is:
1401 .Bd -literal -offset indent
1402 gssapi-with-mic,hostbased,publickey,
1403 keyboard-interactive,password
1404 .Ed
1405 .It Cm ProxyCommand
1406 Specifies the command to use to connect to the server.
1407 The command
1408 string extends to the end of the line, and is executed
1409 using the user's shell
1410 .Ql exec
1411 directive to avoid a lingering shell process.
1412 .Pp
1413 Arguments to
1414 .Cm ProxyCommand
1415 accept the tokens described in the
1416 .Sx TOKENS
1417 section.
1418 The command can be basically anything,
1419 and should read from its standard input and write to its standard output.
1420 It should eventually connect an
1421 .Xr sshd 8
1422 server running on some machine, or execute
1423 .Ic sshd -i
1424 somewhere.
1425 Host key management will be done using the
1426 .Cm Hostname
1427 of the host being connected (defaulting to the name typed by the user).
1428 Setting the command to
1429 .Cm none
1430 disables this option entirely.
1431 Note that
1432 .Cm CheckHostIP
1433 is not available for connects with a proxy command.
1434 .Pp
1435 This directive is useful in conjunction with
1436 .Xr nc 1
1437 and its proxy support.
1438 For example, the following directive would connect via an HTTP proxy at
1439 192.0.2.0:
1440 .Bd -literal -offset 3n
1441 ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
1442 .Ed
1443 .It Cm ProxyJump
1444 Specifies one or more jump proxies as either
1445 .Xo
1446 .Sm off
1447 .Op Ar user No @
1448 .Ar host
1449 .Op : Ns Ar port
1450 .Sm on
1451 or an ssh URI
1452 .Xc .
1453 Multiple proxies may be separated by comma characters and will be visited
1454 sequentially.
1455 Setting this option will cause
1456 .Xr ssh 1
1457 to connect to the target host by first making a
1458 .Xr ssh 1
1459 connection to the specified
1460 .Cm ProxyJump
1461 host and then establishing a
1462 TCP forwarding to the ultimate target from there.
1463 Setting the host to
1464 .Cm none
1465 disables this option entirely.
1466 .Pp
1467 Note that this option will compete with the
1468 .Cm ProxyCommand
1469 option - whichever is specified first will prevent later instances of the
1470 other from taking effect.
1471 .Pp
1472 Note also that the configuration for the destination host (either supplied
1473 via the command-line or the configuration file) is not generally applied
1474 to jump hosts.
1475 .Pa ~/.ssh/config
1476 should be used if specific configuration is required for jump hosts.
1477 .It Cm ProxyUseFdpass
1478 Specifies that
1479 .Cm ProxyCommand
1480 will pass a connected file descriptor back to
1481 .Xr ssh 1
1482 instead of continuing to execute and pass data.
1483 The default is
1484 .Cm no .
1485 .It Cm PubkeyAcceptedAlgorithms
1486 Specifies the signature algorithms that will be used for public key
1487 authentication as a comma-separated list of patterns.
1488 If the specified list begins with a
1489 .Sq +
1490 character, then the algorithms after it will be appended to the default
1491 instead of replacing it.
1492 If the specified list begins with a
1493 .Sq -
1494 character, then the specified algorithms (including wildcards) will be removed
1495 from the default set instead of replacing them.
1496 If the specified list begins with a
1497 .Sq ^
1498 character, then the specified algorithms will be placed at the head of the
1499 default set.
1500 The default for this option is:
1501 .Bd -literal -offset 3n
1502 ssh-ed25519-cert-v01@openssh.com,
1503 ecdsa-sha2-nistp256-cert-v01@openssh.com,
1504 ecdsa-sha2-nistp384-cert-v01@openssh.com,
1505 ecdsa-sha2-nistp521-cert-v01@openssh.com,
1506 sk-ssh-ed25519-cert-v01@openssh.com,
1507 sk-ecdsa-sha2-nistp256-cert-v01@openssh.com,
1508 rsa-sha2-512-cert-v01@openssh.com,
1509 rsa-sha2-256-cert-v01@openssh.com,
1510 ssh-rsa-cert-v01@openssh.com,
1511 ssh-ed25519,
1512 ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1513 sk-ssh-ed25519@openssh.com,
1514 sk-ecdsa-sha2-nistp256@openssh.com,
1515 rsa-sha2-512,rsa-sha2-256,ssh-rsa
1516 .Ed
1517 .Pp
1518 The list of available signature algorithms may also be obtained using
1519 .Qq ssh -Q PubkeyAcceptedAlgorithms .
1520 .It Cm PubkeyAuthentication
1521 Specifies whether to try public key authentication.
1522 The argument to this keyword must be
1523 .Cm yes
1524 (the default)
1525 or
1526 .Cm no .
1527 .It Cm RekeyLimit
1528 Specifies the maximum amount of data that may be transmitted before the
1529 session key is renegotiated, optionally followed by a maximum amount of
1530 time that may pass before the session key is renegotiated.
1531 The first argument is specified in bytes and may have a suffix of
1532 .Sq K ,
1533 .Sq M ,
1534 or
1535 .Sq G
1536 to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1537 The default is between
1538 .Sq 1G
1539 and
1540 .Sq 4G ,
1541 depending on the cipher.
1542 The optional second value is specified in seconds and may use any of the
1543 units documented in the TIME FORMATS section of
1544 .Xr sshd_config 5 .
1545 The default value for
1546 .Cm RekeyLimit
1547 is
1548 .Cm default none ,
1549 which means that rekeying is performed after the cipher's default amount
1550 of data has been sent or received and no time based rekeying is done.
1551 .It Cm RemoteCommand
1552 Specifies a command to execute on the remote machine after successfully
1553 connecting to the server.
1554 The command string extends to the end of the line, and is executed with
1555 the user's shell.
1556 Arguments to
1557 .Cm RemoteCommand
1558 accept the tokens described in the
1559 .Sx TOKENS
1560 section.
1561 .It Cm RemoteForward
1562 Specifies that a TCP port on the remote machine be forwarded over
1563 the secure channel.
1564 The remote port may either be forwarded to a specified host and port
1565 from the local machine, or may act as a SOCKS 4/5 proxy that allows a remote
1566 client to connect to arbitrary destinations from the local machine.
1567 The first argument is the listening specification and may be
1568 .Sm off
1569 .Oo Ar bind_address : Oc Ar port
1570 .Sm on
1571 or, if the remote host supports it, a Unix domain socket path.
1572 If forwarding to a specific destination then the second argument must be
1573 .Ar host : Ns Ar hostport
1574 or a Unix domain socket path,
1575 otherwise if no destination argument is specified then the remote forwarding
1576 will be established as a SOCKS proxy.
1577 When acting as a SOCKS proxy the destination of the connection can be
1578 restricted by
1579 .Cm PermitRemoteOpen .
1580 .Pp
1581 IPv6 addresses can be specified by enclosing addresses in square brackets.
1582 Multiple forwardings may be specified, and additional
1583 forwardings can be given on the command line.
1584 Privileged ports can be forwarded only when
1585 logging in as root on the remote machine.
1586 Unix domain socket paths may use the tokens described in the
1587 .Sx TOKENS
1588 section and environment variables as described in the
1589 .Sx ENVIRONMENT VARIABLES
1590 section.
1591 .Pp
1592 If the
1593 .Ar port
1594 argument is 0,
1595 the listen port will be dynamically allocated on the server and reported
1596 to the client at run time.
1597 .Pp
1598 If the
1599 .Ar bind_address
1600 is not specified, the default is to only bind to loopback addresses.
1601 If the
1602 .Ar bind_address
1603 is
1604 .Ql *
1605 or an empty string, then the forwarding is requested to listen on all
1606 interfaces.
1607 Specifying a remote
1608 .Ar bind_address
1609 will only succeed if the server's
1610 .Cm GatewayPorts
1611 option is enabled (see
1612 .Xr sshd_config 5 ) .
1613 .It Cm RequestTTY
1614 Specifies whether to request a pseudo-tty for the session.
1615 The argument may be one of:
1616 .Cm no
1617 (never request a TTY),
1618 .Cm yes
1619 (always request a TTY when standard input is a TTY),
1620 .Cm force
1621 (always request a TTY) or
1622 .Cm auto
1623 (request a TTY when opening a login session).
1624 This option mirrors the
1625 .Fl t
1626 and
1627 .Fl T
1628 flags for
1629 .Xr ssh 1 .
1630 .It Cm RevokedHostKeys
1631 Specifies revoked host public keys.
1632 Keys listed in this file will be refused for host authentication.
1633 Note that if this file does not exist or is not readable,
1634 then host authentication will be refused for all hosts.
1635 Keys may be specified as a text file, listing one public key per line, or as
1636 an OpenSSH Key Revocation List (KRL) as generated by
1637 .Xr ssh-keygen 1 .
1638 For more information on KRLs, see the KEY REVOCATION LISTS section in
1639 .Xr ssh-keygen 1 .
1640 .It Cm SecurityKeyProvider
1641 Specifies a path to a library that will be used when loading any
1642 FIDO authenticator-hosted keys, overriding the default of using
1643 the built-in USB HID support.
1644 .Pp
1645 If the specified value begins with a
1646 .Sq $
1647 character, then it will be treated as an environment variable containing
1648 the path to the library.
1649 .It Cm SendEnv
1650 Specifies what variables from the local
1651 .Xr environ 7
1652 should be sent to the server.
1653 The server must also support it, and the server must be configured to
1654 accept these environment variables.
1655 Note that the
1656 .Ev TERM
1657 environment variable is always sent whenever a
1658 pseudo-terminal is requested as it is required by the protocol.
1659 Refer to
1660 .Cm AcceptEnv
1661 in
1662 .Xr sshd_config 5
1663 for how to configure the server.
1664 Variables are specified by name, which may contain wildcard characters.
1665 Multiple environment variables may be separated by whitespace or spread
1666 across multiple
1667 .Cm SendEnv
1668 directives.
1669 .Pp
1670 See
1671 .Sx PATTERNS
1672 for more information on patterns.
1673 .Pp
1674 It is possible to clear previously set
1675 .Cm SendEnv
1676 variable names by prefixing patterns with
1677 .Pa - .
1678 The default is not to send any environment variables.
1679 .It Cm ServerAliveCountMax
1680 Sets the number of server alive messages (see below) which may be
1681 sent without
1682 .Xr ssh 1
1683 receiving any messages back from the server.
1684 If this threshold is reached while server alive messages are being sent,
1685 ssh will disconnect from the server, terminating the session.
1686 It is important to note that the use of server alive messages is very
1687 different from
1688 .Cm TCPKeepAlive
1689 (below).
1690 The server alive messages are sent through the encrypted channel
1691 and therefore will not be spoofable.
1692 The TCP keepalive option enabled by
1693 .Cm TCPKeepAlive
1694 is spoofable.
1695 The server alive mechanism is valuable when the client or
1696 server depend on knowing when a connection has become unresponsive.
1697 .Pp
1698 The default value is 3.
1699 If, for example,
1700 .Cm ServerAliveInterval
1701 (see below) is set to 15 and
1702 .Cm ServerAliveCountMax
1703 is left at the default, if the server becomes unresponsive,
1704 ssh will disconnect after approximately 45 seconds.
1705 .It Cm ServerAliveInterval
1706 Sets a timeout interval in seconds after which if no data has been received
1707 from the server,
1708 .Xr ssh 1
1709 will send a message through the encrypted
1710 channel to request a response from the server.
1711 The default
1712 is 0, indicating that these messages will not be sent to the server.
1713 .It Cm SessionType
1714 May be used to either request invocation of a subsystem on the remote system,
1715 or to prevent the execution of a remote command at all.
1716 The latter is useful for just forwarding ports.
1717 The argument to this keyword must be
1718 .Cm none
1719 (same as the
1720 .Fl N
1721 option),
1722 .Cm subsystem
1723 (same as the
1724 .Fl s
1725 option) or
1726 .Cm default
1727 (shell or command execution).
1728 .It Cm SetEnv
1729 Directly specify one or more environment variables and their contents to
1730 be sent to the server.
1731 Similarly to
1732 .Cm SendEnv ,
1733 with the exception of the
1734 .Ev TERM
1735 variable, the server must be prepared to accept the environment variable.
1736 .It Cm StdinNull
1737 Redirects stdin from
1738 .Pa /dev/null
1739 (actually, prevents reading from stdin).
1740 Either this or the equivalent
1741 .Fl n
1742 option must be used when
1743 .Nm ssh
1744 is run in the background.
1745 The argument to this keyword must be
1746 .Cm yes
1747 (same as the
1748 .Fl n
1749 option) or
1750 .Cm no
1751 (the default).
1752 .It Cm StreamLocalBindMask
1753 Sets the octal file creation mode mask
1754 .Pq umask
1755 used when creating a Unix-domain socket file for local or remote
1756 port forwarding.
1757 This option is only used for port forwarding to a Unix-domain socket file.
1758 .Pp
1759 The default value is 0177, which creates a Unix-domain socket file that is
1760 readable and writable only by the owner.
1761 Note that not all operating systems honor the file mode on Unix-domain
1762 socket files.
1763 .It Cm StreamLocalBindUnlink
1764 Specifies whether to remove an existing Unix-domain socket file for local
1765 or remote port forwarding before creating a new one.
1766 If the socket file already exists and
1767 .Cm StreamLocalBindUnlink
1768 is not enabled,
1769 .Nm ssh
1770 will be unable to forward the port to the Unix-domain socket file.
1771 This option is only used for port forwarding to a Unix-domain socket file.
1772 .Pp
1773 The argument must be
1774 .Cm yes
1775 or
1776 .Cm no
1777 (the default).
1778 .It Cm StrictHostKeyChecking
1779 If this flag is set to
1780 .Cm yes ,
1781 .Xr ssh 1
1782 will never automatically add host keys to the
1783 .Pa ~/.ssh/known_hosts
1784 file, and refuses to connect to hosts whose host key has changed.
1785 This provides maximum protection against man-in-the-middle (MITM) attacks,
1786 though it can be annoying when the
1787 .Pa /etc/ssh/ssh_known_hosts
1788 file is poorly maintained or when connections to new hosts are
1789 frequently made.
1790 This option forces the user to manually
1791 add all new hosts.
1792 .Pp
1793 If this flag is set to
1794 .Dq accept-new
1795 then ssh will automatically add new host keys to the user's
1796 .Pa known_hosts
1797 file, but will not permit connections to hosts with
1798 changed host keys.
1799 If this flag is set to
1800 .Dq no
1801 or
1802 .Dq off ,
1803 ssh will automatically add new host keys to the user known hosts files
1804 and allow connections to hosts with changed hostkeys to proceed,
1805 subject to some restrictions.
1806 If this flag is set to
1807 .Cm ask
1808 (the default),
1809 new host keys
1810 will be added to the user known host files only after the user
1811 has confirmed that is what they really want to do, and
1812 ssh will refuse to connect to hosts whose host key has changed.
1813 The host keys of
1814 known hosts will be verified automatically in all cases.
1815 .It Cm SyslogFacility
1816 Gives the facility code that is used when logging messages from
1817 .Xr ssh 1 .
1818 The possible values are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2,
1819 LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7.
1820 The default is USER.
1821 .It Cm TCPKeepAlive
1822 Specifies whether the system should send TCP keepalive messages to the
1823 other side.
1824 If they are sent, death of the connection or crash of one
1825 of the machines will be properly noticed.
1826 However, this means that
1827 connections will die if the route is down temporarily, and some people
1828 find it annoying.
1829 .Pp
1830 The default is
1831 .Cm yes
1832 (to send TCP keepalive messages), and the client will notice
1833 if the network goes down or the remote host dies.
1834 This is important in scripts, and many users want it too.
1835 .Pp
1836 To disable TCP keepalive messages, the value should be set to
1837 .Cm no .
1838 See also
1839 .Cm ServerAliveInterval
1840 for protocol-level keepalives.
1841 .It Cm Tunnel
1842 Request
1843 .Xr tun 4
1844 device forwarding between the client and the server.
1845 The argument must be
1846 .Cm yes ,
1847 .Cm point-to-point
1848 (layer 3),
1849 .Cm ethernet
1850 (layer 2),
1851 or
1852 .Cm no
1853 (the default).
1854 Specifying
1855 .Cm yes
1856 requests the default tunnel mode, which is
1857 .Cm point-to-point .
1858 .It Cm TunnelDevice
1859 Specifies the
1860 .Xr tun 4
1861 devices to open on the client
1862 .Pq Ar local_tun
1863 and the server
1864 .Pq Ar remote_tun .
1865 .Pp
1866 The argument must be
1867 .Sm off
1868 .Ar local_tun Op : Ar remote_tun .
1869 .Sm on
1870 The devices may be specified by numerical ID or the keyword
1871 .Cm any ,
1872 which uses the next available tunnel device.
1873 If
1874 .Ar remote_tun
1875 is not specified, it defaults to
1876 .Cm any .
1877 The default is
1878 .Cm any:any .
1879 .It Cm UpdateHostKeys
1880 Specifies whether
1881 .Xr ssh 1
1882 should accept notifications of additional hostkeys from the server sent
1883 after authentication has completed and add them to
1884 .Cm UserKnownHostsFile .
1885 The argument must be
1886 .Cm yes ,
1887 .Cm no
1888 or
1889 .Cm ask .
1890 This option allows learning alternate hostkeys for a server
1891 and supports graceful key rotation by allowing a server to send replacement
1892 public keys before old ones are removed.
1893 .Pp
1894 Additional hostkeys are only accepted if the key used to authenticate the
1895 host was already trusted or explicitly accepted by the user, the host was
1896 authenticated via
1897 .Cm UserKnownHostsFile
1898 (i.e. not
1899 .Cm GlobalKnownHostsFile )
1900 and the host was authenticated using a plain key and not a certificate.
1901 .Pp
1902 .Cm UpdateHostKeys
1903 is enabled by default if the user has not overridden the default
1904 .Cm UserKnownHostsFile
1905 setting and has not enabled
1906 .Cm VerifyHostKeyDNS ,
1907 otherwise
1908 .Cm UpdateHostKeys
1909 will be set to
1910 .Cm no .
1911 .Pp
1912 If
1913 .Cm UpdateHostKeys
1914 is set to
1915 .Cm ask ,
1916 then the user is asked to confirm the modifications to the known_hosts file.
1917 Confirmation is currently incompatible with
1918 .Cm ControlPersist ,
1919 and will be disabled if it is enabled.
1920 .Pp
1921 Presently, only
1922 .Xr sshd 8
1923 from OpenSSH 6.8 and greater support the
1924 .Qq hostkeys@openssh.com
1925 protocol extension used to inform the client of all the server's hostkeys.
1926 .It Cm User
1927 Specifies the user to log in as.
1928 This can be useful when a different user name is used on different machines.
1929 This saves the trouble of
1930 having to remember to give the user name on the command line.
1931 .It Cm UserKnownHostsFile
1932 Specifies one or more files to use for the user
1933 host key database, separated by whitespace.
1934 Each filename may use tilde notation to refer to the user's home directory,
1935 the tokens described in the
1936 .Sx TOKENS
1937 section and environment variables as described in the
1938 .Sx ENVIRONMENT VARIABLES
1939 section.
1940 The default is
1941 .Pa ~/.ssh/known_hosts ,
1942 .Pa ~/.ssh/known_hosts2 .
1943 .It Cm VerifyHostKeyDNS
1944 Specifies whether to verify the remote key using DNS and SSHFP resource
1945 records.
1946 If this option is set to
1947 .Cm yes ,
1948 the client will implicitly trust keys that match a secure fingerprint
1949 from DNS.
1950 Insecure fingerprints will be handled as if this option was set to
1951 .Cm ask .
1952 If this option is set to
1953 .Cm ask ,
1954 information on fingerprint match will be displayed, but the user will still
1955 need to confirm new host keys according to the
1956 .Cm StrictHostKeyChecking
1957 option.
1958 The default is
1959 .Cm yes
1960 if compiled with LDNS and
1961 .Cm no
1962 otherwise.
1963 .Pp
1964 See also
1965 .Sx VERIFYING HOST KEYS
1966 in
1967 .Xr ssh 1 .
1968 .It Cm VersionAddendum
1969 Specifies a string to append to the regular version string to identify
1970 OS- or site-specific modifications.
1971 The default is
1972 .Dq FreeBSD-20210907 .
1973 The value
1974 .Cm none
1975 may be used to disable this.
1976 .It Cm VisualHostKey
1977 If this flag is set to
1978 .Cm yes ,
1979 an ASCII art representation of the remote host key fingerprint is
1980 printed in addition to the fingerprint string at login and
1981 for unknown host keys.
1982 If this flag is set to
1983 .Cm no
1984 (the default),
1985 no fingerprint strings are printed at login and
1986 only the fingerprint string will be printed for unknown host keys.
1987 .It Cm XAuthLocation
1988 Specifies the full pathname of the
1989 .Xr xauth 1
1990 program.
1991 The default is
1992 .Pa /usr/local/bin/xauth .
1993 .El
1994 .Sh PATTERNS
1995 A
1996 .Em pattern
1997 consists of zero or more non-whitespace characters,
1998 .Sq *
1999 (a wildcard that matches zero or more characters),
2000 or
2001 .Sq ?\&
2002 (a wildcard that matches exactly one character).
2003 For example, to specify a set of declarations for any host in the
2004 .Qq .co.uk
2005 set of domains,
2006 the following pattern could be used:
2007 .Pp
2008 .Dl Host *.co.uk
2009 .Pp
2010 The following pattern
2011 would match any host in the 192.168.0.[0-9] network range:
2012 .Pp
2013 .Dl Host 192.168.0.?
2014 .Pp
2015 A
2016 .Em pattern-list
2017 is a comma-separated list of patterns.
2018 Patterns within pattern-lists may be negated
2019 by preceding them with an exclamation mark
2020 .Pq Sq !\& .
2021 For example,
2022 to allow a key to be used from anywhere within an organization
2023 except from the
2024 .Qq dialup
2025 pool,
2026 the following entry (in authorized_keys) could be used:
2027 .Pp
2028 .Dl from=\&"!*.dialup.example.com,*.example.com\&"
2029 .Pp
2030 Note that a negated match will never produce a positive result by itself.
2031 For example, attempting to match
2032 .Qq host3
2033 against the following pattern-list will fail:
2034 .Pp
2035 .Dl from=\&"!host1,!host2\&"
2036 .Pp
2037 The solution here is to include a term that will yield a positive match,
2038 such as a wildcard:
2039 .Pp
2040 .Dl from=\&"!host1,!host2,*\&"
2041 .Sh TOKENS
2042 Arguments to some keywords can make use of tokens,
2043 which are expanded at runtime:
2044 .Pp
2045 .Bl -tag -width XXXX -offset indent -compact
2046 .It %%
2047 A literal
2048 .Sq % .
2049 .It \&%C
2050 Hash of %l%h%p%r.
2051 .It %d
2052 Local user's home directory.
2053 .It %f
2054 The fingerprint of the server's host key.
2055 .It %H
2056 The
2057 .Pa known_hosts
2058 hostname or address that is being searched for.
2059 .It %h
2060 The remote hostname.
2061 .It \%%I
2062 A string describing the reason for a
2063 .Cm KnownHostsCommand
2064 execution: either
2065 .Cm ADDRESS
2066 when looking up a host by address (only when
2067 .Cm CheckHostIP
2068 is enabled),
2069 .Cm HOSTNAME
2070 when searching by hostname, or
2071 .Cm ORDER
2072 when preparing the host key algorithm preference list to use for the
2073 destination host.
2074 .It %i
2075 The local user ID.
2076 .It %K
2077 The base64 encoded host key.
2078 .It %k
2079 The host key alias if specified, otherwise the original remote hostname given
2080 on the command line.
2081 .It %L
2082 The local hostname.
2083 .It %l
2084 The local hostname, including the domain name.
2085 .It %n
2086 The original remote hostname, as given on the command line.
2087 .It %p
2088 The remote port.
2089 .It %r
2090 The remote username.
2091 .It \&%T
2092 The local
2093 .Xr tun 4
2094 or
2095 .Xr tap 4
2096 network interface assigned if
2097 tunnel forwarding was requested, or
2098 .Qq NONE
2099 otherwise.
2100 .It %t
2101 The type of the server host key, e.g.
2102 .Cm ssh-ed25519 .
2103 .It %u
2104 The local username.
2105 .El
2106 .Pp
2107 .Cm CertificateFile ,
2108 .Cm ControlPath ,
2109 .Cm IdentityAgent ,
2110 .Cm IdentityFile ,
2111 .Cm KnownHostsCommand ,
2112 .Cm LocalForward ,
2113 .Cm Match exec ,
2114 .Cm RemoteCommand ,
2115 .Cm RemoteForward ,
2116 and
2117 .Cm UserKnownHostsFile
2118 accept the tokens %%, %C, %d, %h, %i, %k, %L, %l, %n, %p, %r, and %u.
2119 .Pp
2120 .Cm KnownHostsCommand
2121 additionally accepts the tokens %f, %H, %I, %K and %t.
2122 .Pp
2123 .Cm Hostname
2124 accepts the tokens %% and %h.
2125 .Pp
2126 .Cm LocalCommand
2127 accepts all tokens.
2128 .Pp
2129 .Cm ProxyCommand
2130 accepts the tokens %%, %h, %n, %p, and %r.
2131 .Sh ENVIRONMENT VARIABLES
2132 Arguments to some keywords can be expanded at runtime from environment
2133 variables on the client by enclosing them in
2134 .Ic ${} ,
2135 for example
2136 .Ic ${HOME}/.ssh
2137 would refer to the user's .ssh directory.
2138 If a specified environment variable does not exist then an error will be
2139 returned and the setting for that keyword will be ignored.
2140 .Pp
2141 The keywords
2142 .Cm CertificateFile ,
2143 .Cm ControlPath ,
2144 .Cm IdentityAgent ,
2145 .Cm IdentityFile ,
2146 .Cm KnownHostsCommand ,
2147 and
2148 .Cm UserKnownHostsFile
2149 support environment variables.
2150 The keywords
2151 .Cm LocalForward
2152 and
2153 .Cm RemoteForward
2154 support environment variables only for Unix domain socket paths.
2155 .Sh FILES
2156 .Bl -tag -width Ds
2157 .It Pa ~/.ssh/config
2158 This is the per-user configuration file.
2159 The format of this file is described above.
2160 This file is used by the SSH client.
2161 Because of the potential for abuse, this file must have strict permissions:
2162 read/write for the user, and not writable by others.
2163 .It Pa /etc/ssh/ssh_config
2164 Systemwide configuration file.
2165 This file provides defaults for those
2166 values that are not specified in the user's configuration file, and
2167 for those users who do not have a configuration file.
2168 This file must be world-readable.
2169 .El
2170 .Sh SEE ALSO
2171 .Xr ssh 1
2172 .Sh AUTHORS
2173 .An -nosplit
2174 OpenSSH is a derivative of the original and free
2175 ssh 1.2.12 release by
2176 .An Tatu Ylonen .
2177 .An Aaron Campbell , Bob Beck , Markus Friedl ,
2178 .An Niels Provos , Theo de Raadt
2179 and
2180 .An Dug Song
2181 removed many bugs, re-added newer features and
2182 created OpenSSH.
2183 .An Markus Friedl
2184 contributed the support for SSH protocol versions 1.5 and 2.0.