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