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