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