]> andersk Git - openssh.git/blame - ssh_config.5
- djm@cvs.openbsd.org 2005/09/13 23:40:07
[openssh.git] / ssh_config.5
CommitLineData
588df31a 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.\"
82b7531b 37.\" $OpenBSD: ssh_config.5,v 1.61 2005/07/08 12:53:10 jmc Exp $
588df31a 38.Dd September 25, 1999
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.Bl -tag -width Ds -compact
140e3e97 46.It Pa ~/.ssh/config
588df31a 47.It Pa /etc/ssh/ssh_config
48.El
49.Sh DESCRIPTION
50.Nm ssh
51obtains configuration data from the following sources in
52the following order:
4dcbbeea 53.Bl -enum -offset indent -compact
54.It
55command-line options
56.It
57user's configuration file
140e3e97 58.Pq Pa ~/.ssh/config
4dcbbeea 59.It
60system-wide configuration file
61.Pq Pa /etc/ssh/ssh_config
62.El
588df31a 63.Pp
64For each parameter, the first obtained value
65will be used.
7034edae 66The configuration files contain sections separated by
588df31a 67.Dq Host
68specifications, and that section is only applied for hosts that
69match one of the patterns given in the specification.
70The matched host name is the one given on the command line.
71.Pp
72Since the first obtained value for each parameter is used, more
73host-specific declarations should be given near the beginning of the
74file, and general defaults at the end.
75.Pp
76The configuration file has the following format:
77.Pp
78Empty lines and lines starting with
79.Ql #
80are comments.
81.Pp
82Otherwise a line is of the format
83.Dq keyword arguments .
84Configuration options may be separated by whitespace or
85optional whitespace and exactly one
86.Ql = ;
87the latter format is useful to avoid the need to quote whitespace
88when specifying configuration options using the
89.Nm ssh ,
90.Nm scp
91and
92.Nm sftp
93.Fl o
94option.
95.Pp
96The possible
97keywords and their meanings are as follows (note that
98keywords are case-insensitive and arguments are case-sensitive):
99.Bl -tag -width Ds
100.It Cm Host
101Restricts the following declarations (up to the next
102.Cm Host
103keyword) to be only for those hosts that match one of the patterns
104given after the keyword.
105.Ql \&*
106and
d0445371 107.Ql \&?
588df31a 108can be used as wildcards in the
109patterns.
110A single
111.Ql \&*
112as a pattern can be used to provide global
113defaults for all hosts.
114The host is the
115.Ar hostname
116argument given on the command line (i.e., the name is not converted to
117a canonicalized host name before matching).
f811e52a 118.It Cm AddressFamily
3cbc677d 119Specifies which address family to use when connecting.
120Valid arguments are
f811e52a 121.Dq any ,
122.Dq inet
0d6cbe2c 123(use IPv4 only) or
f811e52a 124.Dq inet6
0d6cbe2c 125(use IPv6 only).
588df31a 126.It Cm BatchMode
127If set to
128.Dq yes ,
129passphrase/password querying will be disabled.
130This option is useful in scripts and other batch jobs where no user
131is present to supply the password.
132The argument must be
133.Dq yes
134or
135.Dq no .
136The default is
137.Dq no .
138.It Cm BindAddress
1a8521be 139Use the specified address on the local machine as the source address of
82b7531b 140the connection.
141Only useful on systems with more than one address.
588df31a 142Note that this option does not work if
143.Cm UsePrivilegedPort
144is set to
145.Dq yes .
146.It Cm ChallengeResponseAuthentication
147Specifies whether to use challenge response authentication.
148The argument to this keyword must be
149.Dq yes
150or
151.Dq no .
152The default is
153.Dq yes .
154.It Cm CheckHostIP
155If this flag is set to
156.Dq yes ,
157ssh will additionally check the host IP address in the
158.Pa known_hosts
159file.
160This allows ssh to detect if a host key changed due to DNS spoofing.
161If the option is set to
162.Dq no ,
163the check will not be executed.
164The default is
165.Dq yes .
166.It Cm Cipher
167Specifies the cipher to use for encrypting the session
168in protocol version 1.
169Currently,
170.Dq blowfish ,
171.Dq 3des ,
172and
173.Dq des
174are supported.
175.Ar des
176is only supported in the
177.Nm ssh
178client for interoperability with legacy protocol 1 implementations
179that do not support the
180.Ar 3des
a4e5acef 181cipher.
182Its use is strongly discouraged due to cryptographic weaknesses.
588df31a 183The default is
184.Dq 3des .
185.It Cm Ciphers
186Specifies the ciphers allowed for protocol version 2
187in order of preference.
188Multiple ciphers must be comma-separated.
3b9baa7b 189The supported ciphers are
190.Dq 3des-cbc ,
191.Dq aes128-cbc ,
192.Dq aes192-cbc ,
193.Dq aes256-cbc ,
194.Dq aes128-ctr ,
195.Dq aes192-ctr ,
196.Dq aes256-ctr ,
74a66cc8 197.Dq arcfour128 ,
198.Dq arcfour256 ,
3b9baa7b 199.Dq arcfour ,
200.Dq blowfish-cbc ,
201and
202.Dq cast128-cbc .
588df31a 203The default is
588df31a 204.Bd -literal
74a66cc8 205 ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
206 arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
207 aes192-ctr,aes256-ctr''
588df31a 208.Ed
209.It Cm ClearAllForwardings
210Specifies that all local, remote and dynamic port forwardings
211specified in the configuration files or on the command line be
a4e5acef 212cleared.
213This option is primarily useful when used from the
588df31a 214.Nm ssh
215command line to clear port forwardings set in
216configuration files, and is automatically set by
217.Xr scp 1
218and
219.Xr sftp 1 .
220The argument must be
221.Dq yes
222or
223.Dq no .
224The default is
225.Dq no .
226.It Cm Compression
227Specifies whether to use compression.
228The argument must be
229.Dq yes
230or
231.Dq no .
232The default is
233.Dq no .
234.It Cm CompressionLevel
235Specifies the compression level to use if compression is enabled.
236The argument must be an integer from 1 (fast) to 9 (slow, best).
237The default level is 6, which is good for most applications.
238The meaning of the values is the same as in
239.Xr gzip 1 .
240Note that this option applies to protocol version 1 only.
241.It Cm ConnectionAttempts
242Specifies the number of tries (one per second) to make before exiting.
243The argument must be an integer.
244This may be useful in scripts if the connection sometimes fails.
245The default is 1.
09ab3296 246.It Cm ConnectTimeout
247Specifies the timeout (in seconds) used when connecting to the ssh
3cbc677d 248server, instead of using the default system TCP timeout.
249This value is used only when the target is down or really unreachable,
250not when it refuses the connection.
5e96b616 251.It Cm ControlMaster
252Enables the sharing of multiple sessions over a single network connection.
253When set to
254.Dq yes
255.Nm ssh
256will listen for connections on a control socket specified using the
257.Cm ControlPath
258argument.
259Additional sessions can connect to this socket using the same
260.Cm ControlPath
261with
262.Cm ControlMaster
263set to
264.Dq no
9a5cfb58 265(the default).
5e96b616 266These sessions will reuse the master instance's network connection rather
267than initiating new ones.
0d34d6ce 268Setting this to
269.Dq ask
270will cause
271.Nm ssh
272to listen for control connections, but require confirmation using the
273.Ev SSH_ASKPASS
274program before they are accepted (see
275.Xr ssh-add 1
9a5cfb58 276for details).
cc8ca1e6 277If the
278.Cm ControlPath
279can not be opened,
280.Nm ssh
281will continue without connecting to a master instance.
9dfd96d6 282.Pp
ef07103c 283X11 and
d313869b 284.Xr ssh-agent 1
ef07103c 285forwarding is supported over these multiplexed connections, however the
286display and agent fowarded will be the one belonging to the master
d313869b 287connection i.e. it is not possible to forward multiple displays or agents.
ef07103c 288.Pp
9dfd96d6 289Two additional options allow for opportunistic multiplexing: try to use a
290master connection but fall back to creating a new one if one does not already
291exist.
292These options are:
293.Dq auto
294and
295.Dq autoask .
296The latter requires confirmation like the
297.Dq ask
298option.
5e96b616 299.It Cm ControlPath
a980cbd7 300Specify the path to the control socket used for connection sharing as described
301in the
5e96b616 302.Cm ControlMaster
699255b5 303section above or the string
304.Dq none
305to disable connection sharing.
a980cbd7 306In the path,
307.Ql %h
308will be substituted by the target host name,
309.Ql %p
310the port and
311.Ql %r
312by the remote login username.
9dfd96d6 313It is recommended that any
314.Cm ControlPath
315used for opportunistic connection sharing include
316all three of these escape sequences.
317This ensures that shared connections are uniquely identified.
9a5cfb58 318.It Cm DynamicForward
319Specifies that a TCP/IP port on the local machine be forwarded
320over the secure channel, and the application
321protocol is then used to determine where to connect to from the
322remote machine.
323The argument must be a port number.
324Currently the SOCKS4 and SOCKS5 protocols are supported, and
325.Nm ssh
326will act as a SOCKS server.
327Multiple forwardings may be specified, and
328additional forwardings can be given on the command line.
329Only the superuser can forward privileged ports.
f0677b69 330.It Cm EnableSSHKeysign
331Setting this option to
332.Dq yes
333in the global client configuration file
334.Pa /etc/ssh/ssh_config
335enables the use of the helper program
336.Xr ssh-keysign 8
337during
338.Cm HostbasedAuthentication .
339The argument must be
340.Dq yes
341or
342.Dq no .
343The default is
344.Dq no .
246bb171 345This option should be placed in the non-hostspecific section.
f0677b69 346See
347.Xr ssh-keysign 8
348for more information.
588df31a 349.It Cm EscapeChar
350Sets the escape character (default:
351.Ql ~ ) .
352The escape character can also
353be set on the command line.
354The argument should be a single character,
355.Ql ^
356followed by a letter, or
357.Dq none
358to disable the escape
359character entirely (making the connection transparent for binary
360data).
361.It Cm ForwardAgent
362Specifies whether the connection to the authentication agent (if any)
363will be forwarded to the remote machine.
364The argument must be
365.Dq yes
366or
367.Dq no .
368The default is
369.Dq no .
dbcdea68 370.Pp
a4e5acef 371Agent forwarding should be enabled with caution.
372Users with the ability to bypass file permissions on the remote host
373(for the agent's Unix-domain socket)
374can access the local agent through the forwarded connection.
375An attacker cannot obtain key material from the agent,
dbcdea68 376however they can perform operations on the keys that enable them to
377authenticate using the identities loaded into the agent.
588df31a 378.It Cm ForwardX11
379Specifies whether X11 connections will be automatically redirected
380over the secure channel and
381.Ev DISPLAY
382set.
383The argument must be
384.Dq yes
385or
386.Dq no .
387The default is
388.Dq no .
dbcdea68 389.Pp
a4e5acef 390X11 forwarding should be enabled with caution.
391Users with the ability to bypass file permissions on the remote host
d73a67d7 392(for the user's X11 authorization database)
a4e5acef 393can access the local X11 display through the forwarded connection.
d73a67d7 394An attacker may then be able to perform activities such as keystroke monitoring
395if the
396.Cm ForwardX11Trusted
397option is also enabled.
398.It Cm ForwardX11Trusted
b2e90ab5 399If this option is set to
d73a67d7 400.Dq yes
401then remote X11 clients will have full access to the original X11 display.
9a6b3b7a 402.Pp
d73a67d7 403If this option is set to
404.Dq no
405then remote X11 clients will be considered untrusted and prevented
406from stealing or tampering with data belonging to trusted X11
407clients.
9a6b3b7a 408Furthermore, the
409.Xr xauth 1
410token used for the session will be set to expire after 20 minutes.
411Remote clients will be refused access after this time.
d73a67d7 412.Pp
413The default is
414.Dq no .
415.Pp
416See the X11 SECURITY extension specification for full details on
417the restrictions imposed on untrusted clients.
588df31a 418.It Cm GatewayPorts
419Specifies whether remote hosts are allowed to connect to local
420forwarded ports.
421By default,
422.Nm ssh
a4e5acef 423binds local port forwardings to the loopback address.
424This prevents other remote hosts from connecting to forwarded ports.
588df31a 425.Cm GatewayPorts
426can be used to specify that
427.Nm ssh
428should bind local port forwardings to the wildcard address,
429thus allowing remote hosts to connect to forwarded ports.
430The argument must be
431.Dq yes
432or
433.Dq no .
434The default is
435.Dq no .
436.It Cm GlobalKnownHostsFile
437Specifies a file to use for the global
438host key database instead of
439.Pa /etc/ssh/ssh_known_hosts .
7364bd04 440.It Cm GSSAPIAuthentication
e8dd24a8 441Specifies whether user authentication based on GSSAPI is allowed.
d0445371 442The default is
2ecb78df 443.Dq no .
7364bd04 444Note that this option applies to protocol version 2 only.
445.It Cm GSSAPIDelegateCredentials
446Forward (delegate) credentials to the server.
447The default is
448.Dq no .
449Note that this option applies to protocol version 2 only.
5c63c2ab 450.It Cm HashKnownHosts
451Indicates that
452.Nm ssh
453should hash host names and addresses when they are added to
140e3e97 454.Pa ~/.ssh/known_hosts .
5c63c2ab 455These hashed names may be used normally by
456.Nm ssh
457and
458.Nm sshd ,
459but they do not reveal identifying information should the file's contents
460be disclosed.
461The default is
462.Dq no .
cd8f998c 463Note that hashing of names and addresses will not be retrospectively applied
bdffbcdc 464to existing known hosts files, but these may be manually hashed using
465.Xr ssh-keygen 1 .
588df31a 466.It Cm HostbasedAuthentication
467Specifies whether to try rhosts based authentication with public key
468authentication.
469The argument must be
470.Dq yes
471or
472.Dq no .
473The default is
474.Dq no .
475This option applies to protocol version 2 only and
476is similar to
477.Cm RhostsRSAAuthentication .
478.It Cm HostKeyAlgorithms
479Specifies the protocol version 2 host key algorithms
480that the client wants to use in order of preference.
481The default for this option is:
482.Dq ssh-rsa,ssh-dss .
483.It Cm HostKeyAlias
484Specifies an alias that should be used instead of the
485real host name when looking up or saving the host key
486in the host key database files.
487This option is useful for tunneling ssh connections
488or for multiple servers running on a single host.
489.It Cm HostName
490Specifies the real host name to log into.
491This can be used to specify nicknames or abbreviations for hosts.
492Default is the name given on the command line.
493Numeric IP addresses are also permitted (both on the command line and in
494.Cm HostName
495specifications).
496.It Cm IdentityFile
497Specifies a file from which the user's RSA or DSA authentication identity
3cbc677d 498is read.
499The default is
140e3e97 500.Pa ~/.ssh/identity
588df31a 501for protocol version 1, and
140e3e97 502.Pa ~/.ssh/id_rsa
588df31a 503and
140e3e97 504.Pa ~/.ssh/id_dsa
588df31a 505for protocol version 2.
506Additionally, any identities represented by the authentication agent
507will be used for authentication.
508The file name may use the tilde
509syntax to refer to a user's home directory.
510It is possible to have
511multiple identity files specified in configuration files; all these
512identities will be tried in sequence.
3a065ed0 513.It Cm IdentitiesOnly
514Specifies that
515.Nm ssh
516should only use the authentication identity files configured in the
1e9b1b82 517.Nm
3a065ed0 518files,
519even if the
520.Nm ssh-agent
521offers more identities.
522The argument to this keyword must be
523.Dq yes
524or
525.Dq no .
526This option is intented for situations where
527.Nm ssh-agent
528offers many different identities.
529The default is
530.Dq no .
396070f8 531.It Cm KbdInteractiveDevices
532Specifies the list of methods to use in keyboard-interactive authentication.
533Multiple method names must be comma-separated.
534The default is to use the server specified list.
588df31a 535.It Cm LocalForward
536Specifies that a TCP/IP port on the local machine be forwarded over
537the secure channel to the specified host and port from the remote machine.
ecda4ffb 538The first argument must be
3867aa0a 539.Sm off
ecda4ffb 540.Oo Ar bind_address : Oc Ar port
3867aa0a 541.Sm on
ecda4ffb 542and the second argument must be
543.Ar host : Ns Ar hostport .
cd8f998c 544IPv6 addresses can be specified by enclosing addresses in square brackets or
3867aa0a 545by using an alternative syntax:
ecda4ffb 546.Oo Ar bind_address Ns / Oc Ns Ar port
547and
548.Ar host Ns / Ns Ar hostport .
cd8f998c 549Multiple forwardings may be specified, and additional forwardings can be
3867aa0a 550given on the command line.
588df31a 551Only the superuser can forward privileged ports.
3867aa0a 552By default, the local port is bound in accordance with the
553.Cm GatewayPorts
554setting.
555However, an explicit
556.Ar bind_address
557may be used to bind the connection to a specific address.
558The
559.Ar bind_address
560of
561.Dq localhost
cd8f998c 562indicates that the listening port be bound for local use only, while an
563empty address or
564.Sq *
3867aa0a 565indicates that the port should be available from all interfaces.
588df31a 566.It Cm LogLevel
567Gives the verbosity level that is used when logging messages from
568.Nm ssh .
569The possible values are:
570QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
a4e5acef 571The default is INFO.
572DEBUG and DEBUG1 are equivalent.
573DEBUG2 and DEBUG3 each specify higher levels of verbose output.
588df31a 574.It Cm MACs
575Specifies the MAC (message authentication code) algorithms
576in order of preference.
577The MAC algorithm is used in protocol version 2
578for data integrity protection.
579Multiple algorithms must be comma-separated.
580The default is
581.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
582.It Cm NoHostAuthenticationForLocalhost
583This option can be used if the home directory is shared across machines.
584In this case localhost will refer to a different machine on each of
585the machines and the user will get many warnings about changed host keys.
586However, this option disables host authentication for localhost.
587The argument to this keyword must be
588.Dq yes
589or
590.Dq no .
591The default is to check the host key for localhost.
592.It Cm NumberOfPasswordPrompts
593Specifies the number of password prompts before giving up.
594The argument to this keyword must be an integer.
595Default is 3.
596.It Cm PasswordAuthentication
597Specifies whether to use password authentication.
598The argument to this keyword must be
599.Dq yes
600or
601.Dq no .
602The default is
603.Dq yes .
604.It Cm Port
605Specifies the port number to connect on the remote host.
606Default is 22.
607.It Cm PreferredAuthentications
608Specifies the order in which the client should try protocol 2
3cbc677d 609authentication methods.
4e5038f7 610This allows a client to prefer one method (e.g.\&
588df31a 611.Cm keyboard-interactive )
4e5038f7 612over another method (e.g.\&
588df31a 613.Cm password )
614The default for this option is:
615.Dq hostbased,publickey,keyboard-interactive,password .
616.It Cm Protocol
617Specifies the protocol versions
618.Nm ssh
619should support in order of preference.
620The possible values are
621.Dq 1
622and
623.Dq 2 .
624Multiple versions must be comma-separated.
625The default is
626.Dq 2,1 .
627This means that
628.Nm ssh
629tries version 2 and falls back to version 1
630if version 2 is not available.
631.It Cm ProxyCommand
632Specifies the command to use to connect to the server.
633The command
634string extends to the end of the line, and is executed with
635.Pa /bin/sh .
636In the command string,
637.Ql %h
638will be substituted by the host name to
639connect and
640.Ql %p
641by the port.
642The command can be basically anything,
643and should read from its standard input and write to its standard output.
644It should eventually connect an
645.Xr sshd 8
646server running on some machine, or execute
647.Ic sshd -i
648somewhere.
649Host key management will be done using the
650HostName of the host being connected (defaulting to the name typed by
651the user).
a4e5acef 652Setting the command to
653.Dq none
f78bde70 654disables this option entirely.
588df31a 655Note that
656.Cm CheckHostIP
657is not available for connects with a proxy command.
658.Pp
2b610872 659This directive is useful in conjunction with
660.Xr nc 1
661and its proxy support.
9fa42d41 662For example, the following directive would connect via an HTTP proxy at
2b610872 663192.0.2.0:
664.Bd -literal -offset 3n
665ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
666.Ed
588df31a 667.It Cm PubkeyAuthentication
668Specifies whether to try public key authentication.
669The argument to this keyword must be
670.Dq yes
671or
672.Dq no .
673The default is
674.Dq yes .
675This option applies to protocol version 2 only.
676.It Cm RemoteForward
677Specifies that a TCP/IP port on the remote machine be forwarded over
678the secure channel to the specified host and port from the local machine.
ecda4ffb 679The first argument must be
3867aa0a 680.Sm off
ecda4ffb 681.Oo Ar bind_address : Oc Ar port
6d7a9e8f 682.Sm on
ecda4ffb 683and the second argument must be
684.Ar host : Ns Ar hostport .
685IPv6 addresses can be specified by enclosing addresses in square brackets
686or by using an alternative syntax:
687.Oo Ar bind_address Ns / Oc Ns Ar port
688and
689.Ar host Ns / Ns Ar hostport .
588df31a 690Multiple forwardings may be specified, and additional
691forwardings can be given on the command line.
692Only the superuser can forward privileged ports.
3867aa0a 693.Pp
694If the
695.Ar bind_address
696is not specified, the default is to only bind to loopback addresses.
697If the
698.Ar bind_address
699is
700.Ql *
701or an empty string, then the forwarding is requested to listen on all
702interfaces.
703Specifying a remote
704.Ar bind_address
cd8f998c 705will only succeed if the server's
706.Cm GatewayPorts
3867aa0a 707option is enabled (see
cd8f998c 708.Xr sshd_config 5 ) .
588df31a 709.It Cm RhostsRSAAuthentication
710Specifies whether to try rhosts based authentication with RSA host
711authentication.
712The argument must be
713.Dq yes
714or
715.Dq no .
716The default is
717.Dq no .
718This option applies to protocol version 1 only and requires
719.Nm ssh
720to be setuid root.
721.It Cm RSAAuthentication
722Specifies whether to try RSA authentication.
723The argument to this keyword must be
724.Dq yes
725or
726.Dq no .
727RSA authentication will only be
728attempted if the identity file exists, or an authentication agent is
729running.
730The default is
731.Dq yes .
732Note that this option applies to protocol version 1 only.
61a2c1da 733.It Cm SendEnv
734Specifies what variables from the local
735.Xr environ 7
736should be sent to the server.
737Note that environment passing is only supported for protocol 2, the
b8b9f2e6 738server must also support it, and the server must be configured to
739accept these environment variables.
61a2c1da 740Refer to
741.Cm AcceptEnv
742in
743.Xr sshd_config 5
744for how to configure the server.
745Variables are specified by name, which may contain the wildcard characters
746.Ql \&*
747and
748.Ql \&? .
b8b9f2e6 749Multiple environment variables may be separated by whitespace or spread
61a2c1da 750across multiple
751.Cm SendEnv
752directives.
753The default is not to send any environment variables.
5d8d32a3 754.It Cm ServerAliveInterval
755Sets a timeout interval in seconds after which if no data has been received
756from the server,
757.Nm ssh
758will send a message through the encrypted
759channel to request a response from the server.
760The default
761is 0, indicating that these messages will not be sent to the server.
762This option applies to protocol version 2 only.
763.It Cm ServerAliveCountMax
764Sets the number of server alive messages (see above) which may be
765sent without
766.Nm ssh
767receiving any messages back from the server.
768If this threshold is reached while server alive messages are being sent,
769.Nm ssh
770will disconnect from the server, terminating the session.
771It is important to note that the use of server alive messages is very
772different from
773.Cm TCPKeepAlive
774(below).
775The server alive messages are sent through the encrypted channel
776and therefore will not be spoofable.
777The TCP keepalive option enabled by
778.Cm TCPKeepAlive
779is spoofable.
780The server alive mechanism is valuable when the client or
781server depend on knowing when a connection has become inactive.
782.Pp
783The default value is 3.
784If, for example,
785.Cm ServerAliveInterval
786(above) is set to 15, and
787.Cm ServerAliveCountMax
788is left at the default, if the server becomes unresponsive ssh
789will disconnect after approximately 45 seconds.
588df31a 790.It Cm SmartcardDevice
3cbc677d 791Specifies which smartcard device to use.
792The argument to this keyword is the device
588df31a 793.Nm ssh
794should use to communicate with a smartcard used for storing the user's
3cbc677d 795private RSA key.
796By default, no device is specified and smartcard support is not activated.
588df31a 797.It Cm StrictHostKeyChecking
798If this flag is set to
799.Dq yes ,
800.Nm ssh
801will never automatically add host keys to the
140e3e97 802.Pa ~/.ssh/known_hosts
588df31a 803file, and refuses to connect to hosts whose host key has changed.
804This provides maximum protection against trojan horse attacks,
805however, can be annoying when the
806.Pa /etc/ssh/ssh_known_hosts
807file is poorly maintained, or connections to new hosts are
808frequently made.
809This option forces the user to manually
810add all new hosts.
811If this flag is set to
812.Dq no ,
813.Nm ssh
814will automatically add new host keys to the
815user known hosts files.
816If this flag is set to
817.Dq ask ,
818new host keys
819will be added to the user known host files only after the user
820has confirmed that is what they really want to do, and
821.Nm ssh
822will refuse to connect to hosts whose host key has changed.
823The host keys of
824known hosts will be verified automatically in all cases.
825The argument must be
826.Dq yes ,
827.Dq no
828or
829.Dq ask .
830The default is
831.Dq ask .
fd573618 832.It Cm TCPKeepAlive
833Specifies whether the system should send TCP keepalive messages to the
834other side.
835If they are sent, death of the connection or crash of one
836of the machines will be properly noticed.
837However, this means that
838connections will die if the route is down temporarily, and some people
839find it annoying.
840.Pp
841The default is
842.Dq yes
843(to send TCP keepalive messages), and the client will notice
844if the network goes down or the remote host dies.
845This is important in scripts, and many users want it too.
846.Pp
847To disable TCP keepalive messages, the value should be set to
848.Dq no .
588df31a 849.It Cm UsePrivilegedPort
850Specifies whether to use a privileged port for outgoing connections.
851The argument must be
852.Dq yes
853or
854.Dq no .
855The default is
856.Dq no .
878b8992 857If set to
858.Dq yes
859.Nm ssh
860must be setuid root.
588df31a 861Note that this option must be set to
862.Dq yes
0598d99d 863for
588df31a 864.Cm RhostsRSAAuthentication
0598d99d 865with older servers.
588df31a 866.It Cm User
867Specifies the user to log in as.
868This can be useful when a different user name is used on different machines.
869This saves the trouble of
870having to remember to give the user name on the command line.
871.It Cm UserKnownHostsFile
872Specifies a file to use for the user
873host key database instead of
140e3e97 874.Pa ~/.ssh/known_hosts .
21289cd0 875.It Cm VerifyHostKeyDNS
876Specifies whether to verify the remote key using DNS and SSHFP resource
877records.
0161a13d 878If this option is set to
879.Dq yes ,
dd376e92 880the client will implicitly trust keys that match a secure fingerprint
0161a13d 881from DNS.
882Insecure fingerprints will be handled as if this option was set to
883.Dq ask .
884If this option is set to
885.Dq ask ,
886information on fingerprint match will be displayed, but the user will still
887need to confirm new host keys according to the
888.Cm StrictHostKeyChecking
889option.
890The argument must be
891.Dq yes ,
892.Dq no
dd376e92 893or
894.Dq ask .
21289cd0 895The default is
896.Dq no .
0f92946c 897Note that this option applies to protocol version 2 only.
588df31a 898.It Cm XAuthLocation
57ff5eeb 899Specifies the full pathname of the
588df31a 900.Xr xauth 1
901program.
902The default is
903.Pa /usr/X11R6/bin/xauth .
904.El
905.Sh FILES
906.Bl -tag -width Ds
140e3e97 907.It Pa ~/.ssh/config
588df31a 908This is the per-user configuration file.
909The format of this file is described above.
910This file is used by the
911.Nm ssh
912client.
e1520719 913Because of the potential for abuse, this file must have strict permissions:
914read/write for the user, and not accessible by others.
588df31a 915.It Pa /etc/ssh/ssh_config
916Systemwide configuration file.
917This file provides defaults for those
918values that are not specified in the user's configuration file, and
919for those users who do not have a configuration file.
920This file must be world-readable.
921.El
be193d89 922.Sh SEE ALSO
923.Xr ssh 1
588df31a 924.Sh AUTHORS
925OpenSSH is a derivative of the original and free
926ssh 1.2.12 release by Tatu Ylonen.
927Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
928Theo de Raadt and Dug Song
929removed many bugs, re-added newer features and
930created OpenSSH.
931Markus Friedl contributed the support for SSH
932protocol versions 1.5 and 2.0.
This page took 0.278087 seconds and 5 git commands to generate.