]> CyberLeo.Net >> Repos - FreeBSD/releng/8.1.git/blob - crypto/openssh/ssh_config.5
Copy stable/8 to releng/8.1 in preparation for 8.1-RC1.
[FreeBSD/releng/8.1.git] / crypto / openssh / ssh_config.5
1 .\"  -*- nroff -*-
2 .\"
3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 .\"                    All rights reserved
6 .\"
7 .\" As far as I am concerned, the code I have written for this software
8 .\" can be used freely for any purpose.  Any derived versions of this
9 .\" software must be clearly marked as such, and if the derived work is
10 .\" incompatible with the protocol description in the RFC file, it must be
11 .\" called by a name other than "ssh" or "Secure Shell".
12 .\"
13 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
14 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
15 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
16 .\"
17 .\" Redistribution and use in source and binary forms, with or without
18 .\" modification, are permitted provided that the following conditions
19 .\" are met:
20 .\" 1. Redistributions of source code must retain the above copyright
21 .\"    notice, this list of conditions and the following disclaimer.
22 .\" 2. Redistributions in binary form must reproduce the above copyright
23 .\"    notice, this list of conditions and the following disclaimer in the
24 .\"    documentation and/or other materials provided with the distribution.
25 .\"
26 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 .\"
37 .\" $OpenBSD: ssh_config.5,v 1.129 2010/03/05 10:28:21 djm Exp $
38 .\" $FreeBSD$
39 .Dd March 5, 2010
40 .Dt SSH_CONFIG 5
41 .Os
42 .Sh NAME
43 .Nm ssh_config
44 .Nd OpenSSH SSH client configuration files
45 .Sh SYNOPSIS
46 .Nm ~/.ssh/config
47 .Nm /etc/ssh/ssh_config
48 .Sh DESCRIPTION
49 .Xr ssh 1
50 obtains configuration data from the following sources in
51 the following order:
52 .Pp
53 .Bl -enum -offset indent -compact
54 .It
55 command-line options
56 .It
57 user's configuration file
58 .Pq Pa ~/.ssh/config
59 .It
60 system-wide configuration file
61 .Pq Pa /etc/ssh/ssh_config
62 .El
63 .Pp
64 For each parameter, the first obtained value
65 will be used.
66 The configuration files contain sections separated by
67 .Dq Host
68 specifications, and that section is only applied for hosts that
69 match one of the patterns given in the specification.
70 The matched host name is the one given on the command line.
71 .Pp
72 Since the first obtained value for each parameter is used, more
73 host-specific declarations should be given near the beginning of the
74 file, and general defaults at the end.
75 .Pp
76 The configuration file has the following format:
77 .Pp
78 Empty lines and lines starting with
79 .Ql #
80 are comments.
81 Otherwise a line is of the format
82 .Dq keyword arguments .
83 Configuration options may be separated by whitespace or
84 optional whitespace and exactly one
85 .Ql = ;
86 the latter format is useful to avoid the need to quote whitespace
87 when specifying configuration options using the
88 .Nm ssh ,
89 .Nm scp ,
90 and
91 .Nm sftp
92 .Fl o
93 option.
94 Arguments may optionally be enclosed in double quotes
95 .Pq \&"
96 in order to represent arguments containing spaces.
97 .Pp
98 The possible
99 keywords and their meanings are as follows (note that
100 keywords are case-insensitive and arguments are case-sensitive):
101 .Bl -tag -width Ds
102 .It Cm Host
103 Restricts the following declarations (up to the next
104 .Cm Host
105 keyword) to be only for those hosts that match one of the patterns
106 given after the keyword.
107 If more than one pattern is provided, they should be separated by whitespace.
108 A single
109 .Ql *
110 as a pattern can be used to provide global
111 defaults for all hosts.
112 The host is the
113 .Ar hostname
114 argument given on the command line (i.e. the name is not converted to
115 a canonicalized host name before matching).
116 .Pp
117 See
118 .Sx PATTERNS
119 for more information on patterns.
120 .It Cm AddressFamily
121 Specifies which address family to use when connecting.
122 Valid arguments are
123 .Dq any ,
124 .Dq inet
125 (use IPv4 only), or
126 .Dq inet6
127 (use IPv6 only).
128 .It Cm BatchMode
129 If set to
130 .Dq yes ,
131 passphrase/password querying will be disabled.
132 This option is useful in scripts and other batch jobs where no user
133 is present to supply the password.
134 The argument must be
135 .Dq yes
136 or
137 .Dq no .
138 The default is
139 .Dq no .
140 .It Cm BindAddress
141 Use the specified address on the local machine as the source address of
142 the connection.
143 Only useful on systems with more than one address.
144 Note that this option does not work if
145 .Cm UsePrivilegedPort
146 is set to
147 .Dq yes .
148 .It Cm ChallengeResponseAuthentication
149 Specifies whether to use challenge-response authentication.
150 The argument to this keyword must be
151 .Dq yes
152 or
153 .Dq no .
154 The default is
155 .Dq yes .
156 .It Cm CheckHostIP
157 If this flag is set to
158 .Dq yes ,
159 .Xr ssh 1
160 will additionally check the host IP address in the
161 .Pa known_hosts
162 file.
163 This allows ssh to detect if a host key changed due to DNS spoofing.
164 If the option is set to
165 .Dq no ,
166 the check will not be executed.
167 The default is
168 .Dq no .
169 .It Cm Cipher
170 Specifies the cipher to use for encrypting the session
171 in protocol version 1.
172 Currently,
173 .Dq blowfish ,
174 .Dq 3des ,
175 and
176 .Dq des
177 are supported.
178 .Ar des
179 is only supported in the
180 .Xr ssh 1
181 client for interoperability with legacy protocol 1 implementations
182 that do not support the
183 .Ar 3des
184 cipher.
185 Its use is strongly discouraged due to cryptographic weaknesses.
186 The default is
187 .Dq 3des .
188 .It Cm Ciphers
189 Specifies the ciphers allowed for protocol version 2
190 in order of preference.
191 Multiple ciphers must be comma-separated.
192 The supported ciphers are
193 .Dq 3des-cbc ,
194 .Dq aes128-cbc ,
195 .Dq aes192-cbc ,
196 .Dq aes256-cbc ,
197 .Dq aes128-ctr ,
198 .Dq aes192-ctr ,
199 .Dq aes256-ctr ,
200 .Dq arcfour128 ,
201 .Dq arcfour256 ,
202 .Dq arcfour ,
203 .Dq blowfish-cbc ,
204 and
205 .Dq cast128-cbc .
206 The default is:
207 .Bd -literal -offset 3n
208 aes128-ctr,aes192-ctr,aes256-ctr,arcfour256,arcfour128,
209 aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,aes192-cbc,
210 aes256-cbc,arcfour
211 .Ed
212 .It Cm ClearAllForwardings
213 Specifies that all local, remote, and dynamic port forwardings
214 specified in the configuration files or on the command line be
215 cleared.
216 This option is primarily useful when used from the
217 .Xr ssh 1
218 command line to clear port forwardings set in
219 configuration files, and is automatically set by
220 .Xr scp 1
221 and
222 .Xr sftp 1 .
223 The argument must be
224 .Dq yes
225 or
226 .Dq no .
227 The default is
228 .Dq no .
229 .It Cm Compression
230 Specifies whether to use compression.
231 The argument must be
232 .Dq yes
233 or
234 .Dq no .
235 The default is
236 .Dq no .
237 .It Cm CompressionLevel
238 Specifies the compression level to use if compression is enabled.
239 The argument must be an integer from 1 (fast) to 9 (slow, best).
240 The default level is 6, which is good for most applications.
241 The meaning of the values is the same as in
242 .Xr gzip 1 .
243 Note that this option applies to protocol version 1 only.
244 .It Cm ConnectionAttempts
245 Specifies the number of tries (one per second) to make before exiting.
246 The argument must be an integer.
247 This may be useful in scripts if the connection sometimes fails.
248 The default is 1.
249 .It Cm ConnectTimeout
250 Specifies the timeout (in seconds) used when connecting to the
251 SSH server, instead of using the default system TCP timeout.
252 This value is used only when the target is down or really unreachable,
253 not when it refuses the connection.
254 .It Cm ControlMaster
255 Enables the sharing of multiple sessions over a single network connection.
256 When set to
257 .Dq yes ,
258 .Xr ssh 1
259 will listen for connections on a control socket specified using the
260 .Cm ControlPath
261 argument.
262 Additional sessions can connect to this socket using the same
263 .Cm ControlPath
264 with
265 .Cm ControlMaster
266 set to
267 .Dq no
268 (the default).
269 These sessions will try to reuse the master instance's network connection
270 rather than initiating new ones, but will fall back to connecting normally
271 if the control socket does not exist, or is not listening.
272 .Pp
273 Setting this to
274 .Dq ask
275 will cause ssh
276 to listen for control connections, but require confirmation using the
277 .Ev SSH_ASKPASS
278 program before they are accepted (see
279 .Xr ssh-add 1
280 for details).
281 If the
282 .Cm ControlPath
283 cannot be opened,
284 ssh will continue without connecting to a master instance.
285 .Pp
286 X11 and
287 .Xr ssh-agent 1
288 forwarding is supported over these multiplexed connections, however the
289 display and agent forwarded will be the one belonging to the master
290 connection i.e. it is not possible to forward multiple displays or agents.
291 .Pp
292 Two additional options allow for opportunistic multiplexing: try to use a
293 master connection but fall back to creating a new one if one does not already
294 exist.
295 These options are:
296 .Dq auto
297 and
298 .Dq autoask .
299 The latter requires confirmation like the
300 .Dq ask
301 option.
302 .It Cm ControlPath
303 Specify the path to the control socket used for connection sharing as described
304 in the
305 .Cm ControlMaster
306 section above or the string
307 .Dq none
308 to disable connection sharing.
309 In the path,
310 .Ql %l
311 will be substituted by the local host name,
312 .Ql %h
313 will be substituted by the target host name,
314 .Ql %p
315 the port, and
316 .Ql %r
317 by the remote login username.
318 It is recommended that any
319 .Cm ControlPath
320 used for opportunistic connection sharing include
321 at least %h, %p, and %r.
322 This ensures that shared connections are uniquely identified.
323 .It Cm DynamicForward
324 Specifies that a TCP port on the local machine be forwarded
325 over the secure channel, and the application
326 protocol is then used to determine where to connect to from the
327 remote machine.
328 .Pp
329 The argument must be
330 .Sm off
331 .Oo Ar bind_address : Oc Ar port .
332 .Sm on
333 IPv6 addresses can be specified by enclosing addresses in square brackets or
334 by using an alternative syntax:
335 .Oo Ar bind_address Ns / Oc Ns Ar port .
336 By default, the local port is bound in accordance with the
337 .Cm GatewayPorts
338 setting.
339 However, an explicit
340 .Ar bind_address
341 may be used to bind the connection to a specific address.
342 The
343 .Ar bind_address
344 of
345 .Dq localhost
346 indicates that the listening port be bound for local use only, while an
347 empty address or
348 .Sq *
349 indicates that the port should be available from all interfaces.
350 .Pp
351 Currently the SOCKS4 and SOCKS5 protocols are supported, and
352 .Xr ssh 1
353 will act as a SOCKS server.
354 Multiple forwardings may be specified, and
355 additional forwardings can be given on the command line.
356 Only the superuser can forward privileged ports.
357 .It Cm EnableSSHKeysign
358 Setting this option to
359 .Dq yes
360 in the global client configuration file
361 .Pa /etc/ssh/ssh_config
362 enables the use of the helper program
363 .Xr ssh-keysign 8
364 during
365 .Cm HostbasedAuthentication .
366 The argument must be
367 .Dq yes
368 or
369 .Dq no .
370 The default is
371 .Dq no .
372 This option should be placed in the non-hostspecific section.
373 See
374 .Xr ssh-keysign 8
375 for more information.
376 .It Cm EscapeChar
377 Sets the escape character (default:
378 .Ql ~ ) .
379 The escape character can also
380 be set on the command line.
381 The argument should be a single character,
382 .Ql ^
383 followed by a letter, or
384 .Dq none
385 to disable the escape
386 character entirely (making the connection transparent for binary
387 data).
388 .It Cm ExitOnForwardFailure
389 Specifies whether
390 .Xr ssh 1
391 should terminate the connection if it cannot set up all requested
392 dynamic, tunnel, local, and remote port forwardings.
393 The argument must be
394 .Dq yes
395 or
396 .Dq no .
397 The default is
398 .Dq no .
399 .It Cm ForwardAgent
400 Specifies whether the connection to the authentication agent (if any)
401 will be forwarded to the remote machine.
402 The argument must be
403 .Dq yes
404 or
405 .Dq no .
406 The default is
407 .Dq no .
408 .Pp
409 Agent forwarding should be enabled with caution.
410 Users with the ability to bypass file permissions on the remote host
411 (for the agent's Unix-domain socket)
412 can access the local agent through the forwarded connection.
413 An attacker cannot obtain key material from the agent,
414 however they can perform operations on the keys that enable them to
415 authenticate using the identities loaded into the agent.
416 .It Cm ForwardX11
417 Specifies whether X11 connections will be automatically redirected
418 over the secure channel and
419 .Ev DISPLAY
420 set.
421 The argument must be
422 .Dq yes
423 or
424 .Dq no .
425 The default is
426 .Dq no .
427 .Pp
428 X11 forwarding should be enabled with caution.
429 Users with the ability to bypass file permissions on the remote host
430 (for the user's X11 authorization database)
431 can access the local X11 display through the forwarded connection.
432 An attacker may then be able to perform activities such as keystroke monitoring
433 if the
434 .Cm ForwardX11Trusted
435 option is also enabled.
436 .It Cm ForwardX11Trusted
437 If this option is set to
438 .Dq yes ,
439 remote X11 clients will have full access to the original X11 display.
440 .Pp
441 If this option is set to
442 .Dq no ,
443 remote X11 clients will be considered untrusted and prevented
444 from stealing or tampering with data belonging to trusted X11
445 clients.
446 Furthermore, the
447 .Xr xauth 1
448 token used for the session will be set to expire after 20 minutes.
449 Remote clients will be refused access after this time.
450 .Pp
451 The default is
452 .Dq no .
453 .Pp
454 See the X11 SECURITY extension specification for full details on
455 the restrictions imposed on untrusted clients.
456 .It Cm GatewayPorts
457 Specifies whether remote hosts are allowed to connect to local
458 forwarded ports.
459 By default,
460 .Xr ssh 1
461 binds local port forwardings to the loopback address.
462 This prevents other remote hosts from connecting to forwarded ports.
463 .Cm GatewayPorts
464 can be used to specify that ssh
465 should bind local port forwardings to the wildcard address,
466 thus allowing remote hosts to connect to forwarded ports.
467 The argument must be
468 .Dq yes
469 or
470 .Dq no .
471 The default is
472 .Dq no .
473 .It Cm GlobalKnownHostsFile
474 Specifies a file to use for the global
475 host key database instead of
476 .Pa /etc/ssh/ssh_known_hosts .
477 .It Cm GSSAPIAuthentication
478 Specifies whether user authentication based on GSSAPI is allowed.
479 The default is
480 .Dq no .
481 Note that this option applies to protocol version 2 only.
482 .It Cm GSSAPIDelegateCredentials
483 Forward (delegate) credentials to the server.
484 The default is
485 .Dq no .
486 Note that this option applies to protocol version 2 only.
487 .It Cm HashKnownHosts
488 Indicates that
489 .Xr ssh 1
490 should hash host names and addresses when they are added to
491 .Pa ~/.ssh/known_hosts .
492 These hashed names may be used normally by
493 .Xr ssh 1
494 and
495 .Xr sshd 8 ,
496 but they do not reveal identifying information should the file's contents
497 be disclosed.
498 The default is
499 .Dq no .
500 Note that existing names and addresses in known hosts files
501 will not be converted automatically,
502 but may be manually hashed using
503 .Xr ssh-keygen 1 .
504 .It Cm HostbasedAuthentication
505 Specifies whether to try rhosts based authentication with public key
506 authentication.
507 The argument must be
508 .Dq yes
509 or
510 .Dq no .
511 The default is
512 .Dq no .
513 This option applies to protocol version 2 only and
514 is similar to
515 .Cm RhostsRSAAuthentication .
516 .It Cm HostKeyAlgorithms
517 Specifies the protocol version 2 host key algorithms
518 that the client wants to use in order of preference.
519 The default for this option is:
520 .Dq ssh-rsa,ssh-dss .
521 .It Cm HostKeyAlias
522 Specifies an alias that should be used instead of the
523 real host name when looking up or saving the host key
524 in the host key database files.
525 This option is useful for tunneling SSH connections
526 or for multiple servers running on a single host.
527 .It Cm HostName
528 Specifies the real host name to log into.
529 This can be used to specify nicknames or abbreviations for hosts.
530 The default is the name given on the command line.
531 Numeric IP addresses are also permitted (both on the command line and in
532 .Cm HostName
533 specifications).
534 .It Cm IdentitiesOnly
535 Specifies that
536 .Xr ssh 1
537 should only use the authentication identity files configured in the
538 .Nm
539 files,
540 even if
541 .Xr ssh-agent 1
542 offers more identities.
543 The argument to this keyword must be
544 .Dq yes
545 or
546 .Dq no .
547 This option is intended for situations where ssh-agent
548 offers many different identities.
549 The default is
550 .Dq no .
551 .It Cm IdentityFile
552 Specifies a file from which the user's RSA or DSA authentication identity
553 is read.
554 The default is
555 .Pa ~/.ssh/identity
556 for protocol version 1, and
557 .Pa ~/.ssh/id_rsa
558 and
559 .Pa ~/.ssh/id_dsa
560 for protocol version 2.
561 Additionally, any identities represented by the authentication agent
562 will be used for authentication.
563 .Xr ssh 1
564 will try to load certificate information from the filename obtained by
565 appending
566 .Pa -cert.pub
567 to the path of a specified
568 .Cm IdentityFile .
569 .Pp
570 The file name may use the tilde
571 syntax to refer to a user's home directory or one of the following
572 escape characters:
573 .Ql %d
574 (local user's home directory),
575 .Ql %u
576 (local user name),
577 .Ql %l
578 (local host name),
579 .Ql %h
580 (remote host name) or
581 .Ql %r
582 (remote user name).
583 .Pp
584 It is possible to have
585 multiple identity files specified in configuration files; all these
586 identities will be tried in sequence.
587 .It Cm KbdInteractiveAuthentication
588 Specifies whether to use keyboard-interactive authentication.
589 The argument to this keyword must be
590 .Dq yes
591 or
592 .Dq no .
593 The default is
594 .Dq yes .
595 .It Cm KbdInteractiveDevices
596 Specifies the list of methods to use in keyboard-interactive authentication.
597 Multiple method names must be comma-separated.
598 The default is to use the server specified list.
599 The methods available vary depending on what the server supports.
600 For an OpenSSH server,
601 it may be zero or more of:
602 .Dq bsdauth ,
603 .Dq pam ,
604 and
605 .Dq skey .
606 .It Cm LocalCommand
607 Specifies a command to execute on the local machine after successfully
608 connecting to the server.
609 The command string extends to the end of the line, and is executed with
610 the user's shell.
611 The following escape character substitutions will be performed:
612 .Ql %d
613 (local user's home directory),
614 .Ql %h
615 (remote host name),
616 .Ql %l
617 (local host name),
618 .Ql %n
619 (host name as provided on the command line),
620 .Ql %p
621 (remote port),
622 .Ql %r
623 (remote user name) or
624 .Ql %u
625 (local user name).
626 .Pp
627 The command is run synchronously and does not have access to the
628 session of the
629 .Xr ssh 1
630 that spawned it.
631 It should not be used for interactive commands.
632 .Pp
633 This directive is ignored unless
634 .Cm PermitLocalCommand
635 has been enabled.
636 .It Cm LocalForward
637 Specifies that a TCP port on the local machine be forwarded over
638 the secure channel to the specified host and port from the remote machine.
639 The first argument must be
640 .Sm off
641 .Oo Ar bind_address : Oc Ar port
642 .Sm on
643 and the second argument must be
644 .Ar host : Ns Ar hostport .
645 IPv6 addresses can be specified by enclosing addresses in square brackets or
646 by using an alternative syntax:
647 .Oo Ar bind_address Ns / Oc Ns Ar port
648 and
649 .Ar host Ns / Ns Ar hostport .
650 Multiple forwardings may be specified, and additional forwardings can be
651 given on the command line.
652 Only the superuser can forward privileged ports.
653 By default, the local port is bound in accordance with the
654 .Cm GatewayPorts
655 setting.
656 However, an explicit
657 .Ar bind_address
658 may be used to bind the connection to a specific address.
659 The
660 .Ar bind_address
661 of
662 .Dq localhost
663 indicates that the listening port be bound for local use only, while an
664 empty address or
665 .Sq *
666 indicates that the port should be available from all interfaces.
667 .It Cm LogLevel
668 Gives the verbosity level that is used when logging messages from
669 .Xr ssh 1 .
670 The possible values are:
671 QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
672 The default is INFO.
673 DEBUG and DEBUG1 are equivalent.
674 DEBUG2 and DEBUG3 each specify higher levels of verbose output.
675 .It Cm MACs
676 Specifies the MAC (message authentication code) algorithms
677 in order of preference.
678 The MAC algorithm is used in protocol version 2
679 for data integrity protection.
680 Multiple algorithms must be comma-separated.
681 The default is:
682 .Bd -literal -offset indent
683 hmac-md5,hmac-sha1,umac-64@openssh.com,
684 hmac-ripemd160,hmac-sha1-96,hmac-md5-96
685 .Ed
686 .It Cm NoHostAuthenticationForLocalhost
687 This option can be used if the home directory is shared across machines.
688 In this case localhost will refer to a different machine on each of
689 the machines and the user will get many warnings about changed host keys.
690 However, this option disables host authentication for localhost.
691 The argument to this keyword must be
692 .Dq yes
693 or
694 .Dq no .
695 The default is to check the host key for localhost.
696 .It Cm NumberOfPasswordPrompts
697 Specifies the number of password prompts before giving up.
698 The argument to this keyword must be an integer.
699 The default is 3.
700 .It Cm PasswordAuthentication
701 Specifies whether to use password authentication.
702 The argument to this keyword must be
703 .Dq yes
704 or
705 .Dq no .
706 The default is
707 .Dq yes .
708 .It Cm PermitLocalCommand
709 Allow local command execution via the
710 .Ic LocalCommand
711 option or using the
712 .Ic !\& Ns Ar command
713 escape sequence in
714 .Xr ssh 1 .
715 The argument must be
716 .Dq yes
717 or
718 .Dq no .
719 The default is
720 .Dq no .
721 .It Cm PKCS11Provider
722 Specifies which PKCS#11 provider to use.
723 The argument to this keyword is the PKCS#11 shared libary
724 .Xr ssh 1
725 should use to communicate with a PKCS#11 token providing the user's
726 private RSA key.
727 .It Cm Port
728 Specifies the port number to connect on the remote host.
729 The default is 22.
730 .It Cm PreferredAuthentications
731 Specifies the order in which the client should try protocol 2
732 authentication methods.
733 This allows a client to prefer one method (e.g.\&
734 .Cm keyboard-interactive )
735 over another method (e.g.\&
736 .Cm password )
737 The default for this option is:
738 .Do gssapi-with-mic ,
739 hostbased,
740 publickey,
741 keyboard-interactive,
742 password
743 .Dc .
744 .It Cm Protocol
745 Specifies the protocol versions
746 .Xr ssh 1
747 should support in order of preference.
748 The possible values are
749 .Sq 1
750 and
751 .Sq 2 .
752 Multiple versions must be comma-separated.
753 When this option is set to
754 .Dq 2,1
755 .Nm ssh
756 will try version 2 and fall back to version 1
757 if version 2 is not available.
758 The default is
759 .Sq 2 .
760 .It Cm ProxyCommand
761 Specifies the command to use to connect to the server.
762 The command
763 string extends to the end of the line, and is executed with
764 the user's shell.
765 In the command string,
766 .Ql %h
767 will be substituted by the host name to
768 connect and
769 .Ql %p
770 by the port.
771 The command can be basically anything,
772 and should read from its standard input and write to its standard output.
773 It should eventually connect an
774 .Xr sshd 8
775 server running on some machine, or execute
776 .Ic sshd -i
777 somewhere.
778 Host key management will be done using the
779 HostName of the host being connected (defaulting to the name typed by
780 the user).
781 Setting the command to
782 .Dq none
783 disables this option entirely.
784 Note that
785 .Cm CheckHostIP
786 is not available for connects with a proxy command.
787 .Pp
788 This directive is useful in conjunction with
789 .Xr nc 1
790 and its proxy support.
791 For example, the following directive would connect via an HTTP proxy at
792 192.0.2.0:
793 .Bd -literal -offset 3n
794 ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
795 .Ed
796 .It Cm PubkeyAuthentication
797 Specifies whether to try public key authentication.
798 The argument to this keyword must be
799 .Dq yes
800 or
801 .Dq no .
802 The default is
803 .Dq yes .
804 This option applies to protocol version 2 only.
805 .It Cm RekeyLimit
806 Specifies the maximum amount of data that may be transmitted before the
807 session key is renegotiated.
808 The argument is the number of bytes, with an optional suffix of
809 .Sq K ,
810 .Sq M ,
811 or
812 .Sq G
813 to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
814 The default is between
815 .Sq 1G
816 and
817 .Sq 4G ,
818 depending on the cipher.
819 This option applies to protocol version 2 only.
820 .It Cm RemoteForward
821 Specifies that a TCP port on the remote machine be forwarded over
822 the secure channel to the specified host and port from the local machine.
823 The first argument must be
824 .Sm off
825 .Oo Ar bind_address : Oc Ar port
826 .Sm on
827 and the second argument must be
828 .Ar host : Ns Ar hostport .
829 IPv6 addresses can be specified by enclosing addresses in square brackets
830 or by using an alternative syntax:
831 .Oo Ar bind_address Ns / Oc Ns Ar port
832 and
833 .Ar host Ns / Ns Ar hostport .
834 Multiple forwardings may be specified, and additional
835 forwardings can be given on the command line.
836 Privileged ports can be forwarded only when
837 logging in as root on the remote machine.
838 .Pp
839 If the
840 .Ar port
841 argument is
842 .Ql 0 ,
843 the listen port will be dynamically allocated on the server and reported
844 to the client at run time.
845 .Pp
846 If the
847 .Ar bind_address
848 is not specified, the default is to only bind to loopback addresses.
849 If the
850 .Ar bind_address
851 is
852 .Ql *
853 or an empty string, then the forwarding is requested to listen on all
854 interfaces.
855 Specifying a remote
856 .Ar bind_address
857 will only succeed if the server's
858 .Cm GatewayPorts
859 option is enabled (see
860 .Xr sshd_config 5 ) .
861 .It Cm RhostsRSAAuthentication
862 Specifies whether to try rhosts based authentication with RSA host
863 authentication.
864 The argument must be
865 .Dq yes
866 or
867 .Dq no .
868 The default is
869 .Dq no .
870 This option applies to protocol version 1 only and requires
871 .Xr ssh 1
872 to be setuid root.
873 .It Cm RSAAuthentication
874 Specifies whether to try RSA authentication.
875 The argument to this keyword must be
876 .Dq yes
877 or
878 .Dq no .
879 RSA authentication will only be
880 attempted if the identity file exists, or an authentication agent is
881 running.
882 The default is
883 .Dq yes .
884 Note that this option applies to protocol version 1 only.
885 .It Cm SendEnv
886 Specifies what variables from the local
887 .Xr environ 7
888 should be sent to the server.
889 Note that environment passing is only supported for protocol 2.
890 The server must also support it, and the server must be configured to
891 accept these environment variables.
892 Refer to
893 .Cm AcceptEnv
894 in
895 .Xr sshd_config 5
896 for how to configure the server.
897 Variables are specified by name, which may contain wildcard characters.
898 Multiple environment variables may be separated by whitespace or spread
899 across multiple
900 .Cm SendEnv
901 directives.
902 The default is not to send any environment variables.
903 .Pp
904 See
905 .Sx PATTERNS
906 for more information on patterns.
907 .It Cm ServerAliveCountMax
908 Sets the number of server alive messages (see below) which may be
909 sent without
910 .Xr ssh 1
911 receiving any messages back from the server.
912 If this threshold is reached while server alive messages are being sent,
913 ssh will disconnect from the server, terminating the session.
914 It is important to note that the use of server alive messages is very
915 different from
916 .Cm TCPKeepAlive
917 (below).
918 The server alive messages are sent through the encrypted channel
919 and therefore will not be spoofable.
920 The TCP keepalive option enabled by
921 .Cm TCPKeepAlive
922 is spoofable.
923 The server alive mechanism is valuable when the client or
924 server depend on knowing when a connection has become inactive.
925 .Pp
926 The default value is 3.
927 If, for example,
928 .Cm ServerAliveInterval
929 (see below) is set to 15 and
930 .Cm ServerAliveCountMax
931 is left at the default, if the server becomes unresponsive,
932 ssh will disconnect after approximately 45 seconds.
933 This option applies to protocol version 2 only.
934 .It Cm ServerAliveInterval
935 Sets a timeout interval in seconds after which if no data has been received
936 from the server,
937 .Xr ssh 1
938 will send a message through the encrypted
939 channel to request a response from the server.
940 The default
941 is 0, indicating that these messages will not be sent to the server.
942 This option applies to protocol version 2 only.
943 .It Cm StrictHostKeyChecking
944 If this flag is set to
945 .Dq yes ,
946 .Xr ssh 1
947 will never automatically add host keys to the
948 .Pa ~/.ssh/known_hosts
949 file, and refuses to connect to hosts whose host key has changed.
950 This provides maximum protection against trojan horse attacks,
951 though it can be annoying when the
952 .Pa /etc/ssh/ssh_known_hosts
953 file is poorly maintained or when connections to new hosts are
954 frequently made.
955 This option forces the user to manually
956 add all new hosts.
957 If this flag is set to
958 .Dq no ,
959 ssh will automatically add new host keys to the
960 user known hosts files.
961 If this flag is set to
962 .Dq ask ,
963 new host keys
964 will be added to the user known host files only after the user
965 has confirmed that is what they really want to do, and
966 ssh will refuse to connect to hosts whose host key has changed.
967 The host keys of
968 known hosts will be verified automatically in all cases.
969 The argument must be
970 .Dq yes ,
971 .Dq no ,
972 or
973 .Dq ask .
974 The default is
975 .Dq ask .
976 .It Cm TCPKeepAlive
977 Specifies whether the system should send TCP keepalive messages to the
978 other side.
979 If they are sent, death of the connection or crash of one
980 of the machines will be properly noticed.
981 However, this means that
982 connections will die if the route is down temporarily, and some people
983 find it annoying.
984 .Pp
985 The default is
986 .Dq yes
987 (to send TCP keepalive messages), and the client will notice
988 if the network goes down or the remote host dies.
989 This is important in scripts, and many users want it too.
990 .Pp
991 To disable TCP keepalive messages, the value should be set to
992 .Dq no .
993 .It Cm Tunnel
994 Request
995 .Xr tun 4
996 device forwarding between the client and the server.
997 The argument must be
998 .Dq yes ,
999 .Dq point-to-point
1000 (layer 3),
1001 .Dq ethernet
1002 (layer 2),
1003 or
1004 .Dq no .
1005 Specifying
1006 .Dq yes
1007 requests the default tunnel mode, which is
1008 .Dq point-to-point .
1009 The default is
1010 .Dq no .
1011 .It Cm TunnelDevice
1012 Specifies the
1013 .Xr tun 4
1014 devices to open on the client
1015 .Pq Ar local_tun
1016 and the server
1017 .Pq Ar remote_tun .
1018 .Pp
1019 The argument must be
1020 .Sm off
1021 .Ar local_tun Op : Ar remote_tun .
1022 .Sm on
1023 The devices may be specified by numerical ID or the keyword
1024 .Dq any ,
1025 which uses the next available tunnel device.
1026 If
1027 .Ar remote_tun
1028 is not specified, it defaults to
1029 .Dq any .
1030 The default is
1031 .Dq any:any .
1032 .It Cm UsePrivilegedPort
1033 Specifies whether to use a privileged port for outgoing connections.
1034 The argument must be
1035 .Dq yes
1036 or
1037 .Dq no .
1038 The default is
1039 .Dq no .
1040 If set to
1041 .Dq yes ,
1042 .Xr ssh 1
1043 must be setuid root.
1044 Note that this option must be set to
1045 .Dq yes
1046 for
1047 .Cm RhostsRSAAuthentication
1048 with older servers.
1049 .It Cm User
1050 Specifies the user to log in as.
1051 This can be useful when a different user name is used on different machines.
1052 This saves the trouble of
1053 having to remember to give the user name on the command line.
1054 .It Cm UserKnownHostsFile
1055 Specifies a file to use for the user
1056 host key database instead of
1057 .Pa ~/.ssh/known_hosts .
1058 .It Cm VerifyHostKeyDNS
1059 Specifies whether to verify the remote key using DNS and SSHFP resource
1060 records.
1061 If this option is set to
1062 .Dq yes ,
1063 the client will implicitly trust keys that match a secure fingerprint
1064 from DNS.
1065 Insecure fingerprints will be handled as if this option was set to
1066 .Dq ask .
1067 If this option is set to
1068 .Dq ask ,
1069 information on fingerprint match will be displayed, but the user will still
1070 need to confirm new host keys according to the
1071 .Cm StrictHostKeyChecking
1072 option.
1073 The argument must be
1074 .Dq yes ,
1075 .Dq no ,
1076 or
1077 .Dq ask .
1078 The default is
1079 .Dq no .
1080 Note that this option applies to protocol version 2 only.
1081 .Pp
1082 See also
1083 .Sx VERIFYING HOST KEYS
1084 in
1085 .Xr ssh 1 .
1086 .It Cm VersionAddendum
1087 Specifies a string to append to the regular version string to identify
1088 OS- or site-specific modifications.
1089 The default is
1090 .Dq FreeBSD-20100308 .
1091 .It Cm VisualHostKey
1092 If this flag is set to
1093 .Dq yes ,
1094 an ASCII art representation of the remote host key fingerprint is
1095 printed in addition to the hex fingerprint string at login and
1096 for unknown host keys.
1097 If this flag is set to
1098 .Dq no ,
1099 no fingerprint strings are printed at login and
1100 only the hex fingerprint string will be printed for unknown host keys.
1101 The default is
1102 .Dq no .
1103 .It Cm XAuthLocation
1104 Specifies the full pathname of the
1105 .Xr xauth 1
1106 program.
1107 The default is
1108 .Pa /usr/local/bin/xauth .
1109 .El
1110 .Sh PATTERNS
1111 A
1112 .Em pattern
1113 consists of zero or more non-whitespace characters,
1114 .Sq *
1115 (a wildcard that matches zero or more characters),
1116 or
1117 .Sq ?\&
1118 (a wildcard that matches exactly one character).
1119 For example, to specify a set of declarations for any host in the
1120 .Dq .co.uk
1121 set of domains,
1122 the following pattern could be used:
1123 .Pp
1124 .Dl Host *.co.uk
1125 .Pp
1126 The following pattern
1127 would match any host in the 192.168.0.[0-9] network range:
1128 .Pp
1129 .Dl Host 192.168.0.?
1130 .Pp
1131 A
1132 .Em pattern-list
1133 is a comma-separated list of patterns.
1134 Patterns within pattern-lists may be negated
1135 by preceding them with an exclamation mark
1136 .Pq Sq !\& .
1137 For example,
1138 to allow a key to be used from anywhere within an organisation
1139 except from the
1140 .Dq dialup
1141 pool,
1142 the following entry (in authorized_keys) could be used:
1143 .Pp
1144 .Dl from=\&"!*.dialup.example.com,*.example.com\&"
1145 .Sh FILES
1146 .Bl -tag -width Ds
1147 .It Pa ~/.ssh/config
1148 This is the per-user configuration file.
1149 The format of this file is described above.
1150 This file is used by the SSH client.
1151 Because of the potential for abuse, this file must have strict permissions:
1152 read/write for the user, and not accessible by others.
1153 .It Pa /etc/ssh/ssh_config
1154 Systemwide configuration file.
1155 This file provides defaults for those
1156 values that are not specified in the user's configuration file, and
1157 for those users who do not have a configuration file.
1158 This file must be world-readable.
1159 .El
1160 .Sh SEE ALSO
1161 .Xr ssh 1
1162 .Sh AUTHORS
1163 OpenSSH is a derivative of the original and free
1164 ssh 1.2.12 release by Tatu Ylonen.
1165 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1166 Theo de Raadt and Dug Song
1167 removed many bugs, re-added newer features and
1168 created OpenSSH.
1169 Markus Friedl contributed the support for SSH
1170 protocol versions 1.5 and 2.0.