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