blob: 210da059b5501328d1bfd69f944798a44a37d912 [file] [log] [blame]
Ben Lindstrom9f049032002-06-21 00:59:05 +00001.\" -*- 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.\"
Damien Miller509b0102003-12-17 16:33:10 +110037.\" $OpenBSD: ssh_config.5,v 1.28 2003/12/16 15:49:51 markus Exp $
Ben Lindstrom9f049032002-06-21 00:59:05 +000038.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
46.It Pa $HOME/.ssh/config
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:
Ben Lindstrom479b4762002-08-20 19:04:51 +000053.Bl -enum -offset indent -compact
54.It
55command-line options
56.It
57user's configuration file
58.Pq Pa $HOME/.ssh/config
59.It
60system-wide configuration file
61.Pq Pa /etc/ssh/ssh_config
62.El
Ben Lindstrom9f049032002-06-21 00:59:05 +000063.Pp
64For each parameter, the first obtained value
65will be used.
66The configuration files contain sections bracketed by
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
Damien Millerc2b98272003-09-03 12:13:30 +1000107.Ql \&?
Ben Lindstrom9f049032002-06-21 00:59:05 +0000108can 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).
Damien Miller20a8f972003-05-18 20:50:30 +1000118.It Cm AddressFamily
Damien Millerfbf486b2003-05-23 18:44:23 +1000119Specifies which address family to use when connecting.
120Valid arguments are
Damien Miller20a8f972003-05-18 20:50:30 +1000121.Dq any ,
122.Dq inet
123(Use IPv4 only) or
124.Dq inet6
125(Use IPv6 only.)
Ben Lindstrom9f049032002-06-21 00:59:05 +0000126.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
Damien Miller495dca32003-04-01 21:42:14 +1000180cipher.
181Its use is strongly discouraged due to cryptographic weaknesses.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000182The 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.
188The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000189.Bd -literal
190 ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
191 aes192-cbc,aes256-cbc''
192.Ed
193.It Cm ClearAllForwardings
194Specifies that all local, remote and dynamic port forwardings
195specified in the configuration files or on the command line be
Damien Miller495dca32003-04-01 21:42:14 +1000196cleared.
197This option is primarily useful when used from the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000198.Nm ssh
199command line to clear port forwardings set in
200configuration files, and is automatically set by
201.Xr scp 1
202and
203.Xr sftp 1 .
204The argument must be
205.Dq yes
206or
207.Dq no .
208The default is
209.Dq no .
210.It Cm Compression
211Specifies whether to use compression.
212The argument must be
213.Dq yes
214or
215.Dq no .
216The default is
217.Dq no .
218.It Cm CompressionLevel
219Specifies the compression level to use if compression is enabled.
220The argument must be an integer from 1 (fast) to 9 (slow, best).
221The default level is 6, which is good for most applications.
222The meaning of the values is the same as in
223.Xr gzip 1 .
224Note that this option applies to protocol version 1 only.
225.It Cm ConnectionAttempts
226Specifies the number of tries (one per second) to make before exiting.
227The argument must be an integer.
228This may be useful in scripts if the connection sometimes fails.
229The default is 1.
Damien Millerb78d5eb2003-05-16 11:39:04 +1000230.It Cm ConnectTimeout
231Specifies the timeout (in seconds) used when connecting to the ssh
Damien Millerfbf486b2003-05-23 18:44:23 +1000232server, instead of using the default system TCP timeout.
233This value is used only when the target is down or really unreachable,
234not when it refuses the connection.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000235.It Cm DynamicForward
236Specifies that a TCP/IP port on the local machine be forwarded
237over the secure channel, and the application
238protocol is then used to determine where to connect to from the
Damien Miller495dca32003-04-01 21:42:14 +1000239remote machine.
240The argument must be a port number.
Darren Tucker46471c92003-07-03 13:55:19 +1000241Currently the SOCKS4 and SOCKS5 protocols are supported, and
Ben Lindstrom9f049032002-06-21 00:59:05 +0000242.Nm ssh
Darren Tucker46471c92003-07-03 13:55:19 +1000243will act as a SOCKS server.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000244Multiple forwardings may be specified, and
Damien Miller495dca32003-04-01 21:42:14 +1000245additional forwardings can be given on the command line.
246Only the superuser can forward privileged ports.
Darren Tucker674f71d2003-06-28 12:33:12 +1000247.It Cm EnableSSHKeysign
248Setting this option to
249.Dq yes
250in the global client configuration file
251.Pa /etc/ssh/ssh_config
252enables the use of the helper program
253.Xr ssh-keysign 8
254during
255.Cm HostbasedAuthentication .
256The argument must be
257.Dq yes
258or
259.Dq no .
260The default is
261.Dq no .
Darren Tuckerf132c672003-10-15 15:58:18 +1000262This option should be placed in the non-hostspecific section.
Darren Tucker674f71d2003-06-28 12:33:12 +1000263See
264.Xr ssh-keysign 8
265for more information.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000266.It Cm EscapeChar
267Sets the escape character (default:
268.Ql ~ ) .
269The escape character can also
270be set on the command line.
271The argument should be a single character,
272.Ql ^
273followed by a letter, or
274.Dq none
275to disable the escape
276character entirely (making the connection transparent for binary
277data).
278.It Cm ForwardAgent
279Specifies whether the connection to the authentication agent (if any)
280will be forwarded to the remote machine.
281The argument must be
282.Dq yes
283or
284.Dq no .
285The default is
286.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000287.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000288Agent forwarding should be enabled with caution.
289Users with the ability to bypass file permissions on the remote host
290(for the agent's Unix-domain socket)
291can access the local agent through the forwarded connection.
292An attacker cannot obtain key material from the agent,
Damien Milleraf653042002-09-04 16:40:37 +1000293however they can perform operations on the keys that enable them to
294authenticate using the identities loaded into the agent.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000295.It Cm ForwardX11
296Specifies whether X11 connections will be automatically redirected
297over the secure channel and
298.Ev DISPLAY
299set.
300The argument must be
301.Dq yes
302or
303.Dq no .
304The default is
305.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000306.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000307X11 forwarding should be enabled with caution.
308Users with the ability to bypass file permissions on the remote host
Darren Tucker0a118da2003-10-15 15:54:32 +1000309(for the user's X11 authorization database)
Damien Miller495dca32003-04-01 21:42:14 +1000310can access the local X11 display through the forwarded connection.
Darren Tucker0a118da2003-10-15 15:54:32 +1000311An attacker may then be able to perform activities such as keystroke monitoring
312if the
313.Cm ForwardX11Trusted
314option is also enabled.
315.It Cm ForwardX11Trusted
316If the this option is set to
317.Dq yes
318then remote X11 clients will have full access to the original X11 display.
319If this option is set to
320.Dq no
321then remote X11 clients will be considered untrusted and prevented
322from stealing or tampering with data belonging to trusted X11
323clients.
324.Pp
325The default is
326.Dq no .
327.Pp
328See the X11 SECURITY extension specification for full details on
329the restrictions imposed on untrusted clients.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000330.It Cm GatewayPorts
331Specifies whether remote hosts are allowed to connect to local
332forwarded ports.
333By default,
334.Nm ssh
Damien Miller495dca32003-04-01 21:42:14 +1000335binds local port forwardings to the loopback address.
336This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000337.Cm GatewayPorts
338can be used to specify that
339.Nm ssh
340should bind local port forwardings to the wildcard address,
341thus allowing remote hosts to connect to forwarded ports.
342The argument must be
343.Dq yes
344or
345.Dq no .
346The default is
347.Dq no .
348.It Cm GlobalKnownHostsFile
349Specifies a file to use for the global
350host key database instead of
351.Pa /etc/ssh/ssh_known_hosts .
Darren Tucker0efd1552003-08-26 11:49:55 +1000352.It Cm GSSAPIAuthentication
Damien Millerbaafb982003-12-17 16:32:23 +1100353Specifies whether user authentication based on GSSAPI is allowed.
Damien Millerc2b98272003-09-03 12:13:30 +1000354The default is
Darren Tuckera044f472003-10-15 15:52:03 +1000355.Dq no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000356Note that this option applies to protocol version 2 only.
357.It Cm GSSAPIDelegateCredentials
358Forward (delegate) credentials to the server.
359The default is
360.Dq no .
361Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000362.It Cm HostbasedAuthentication
363Specifies whether to try rhosts based authentication with public key
364authentication.
365The argument must be
366.Dq yes
367or
368.Dq no .
369The default is
370.Dq no .
371This option applies to protocol version 2 only and
372is similar to
373.Cm RhostsRSAAuthentication .
374.It Cm HostKeyAlgorithms
375Specifies the protocol version 2 host key algorithms
376that the client wants to use in order of preference.
377The default for this option is:
378.Dq ssh-rsa,ssh-dss .
379.It Cm HostKeyAlias
380Specifies an alias that should be used instead of the
381real host name when looking up or saving the host key
382in the host key database files.
383This option is useful for tunneling ssh connections
384or for multiple servers running on a single host.
385.It Cm HostName
386Specifies the real host name to log into.
387This can be used to specify nicknames or abbreviations for hosts.
388Default is the name given on the command line.
389Numeric IP addresses are also permitted (both on the command line and in
390.Cm HostName
391specifications).
392.It Cm IdentityFile
393Specifies a file from which the user's RSA or DSA authentication identity
Damien Millerfbf486b2003-05-23 18:44:23 +1000394is read.
395The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000396.Pa $HOME/.ssh/identity
397for protocol version 1, and
398.Pa $HOME/.ssh/id_rsa
399and
400.Pa $HOME/.ssh/id_dsa
401for protocol version 2.
402Additionally, any identities represented by the authentication agent
403will be used for authentication.
404The file name may use the tilde
405syntax to refer to a user's home directory.
406It is possible to have
407multiple identity files specified in configuration files; all these
408identities will be tried in sequence.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000409.It Cm LocalForward
410Specifies that a TCP/IP port on the local machine be forwarded over
411the secure channel to the specified host and port from the remote machine.
412The first argument must be a port number, and the second must be
413.Ar host:port .
414IPv6 addresses can be specified with an alternative syntax:
415.Ar host/port .
416Multiple forwardings may be specified, and additional
417forwardings can be given on the command line.
418Only the superuser can forward privileged ports.
419.It Cm LogLevel
420Gives the verbosity level that is used when logging messages from
421.Nm ssh .
422The possible values are:
423QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +1000424The default is INFO.
425DEBUG and DEBUG1 are equivalent.
426DEBUG2 and DEBUG3 each specify higher levels of verbose output.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000427.It Cm MACs
428Specifies the MAC (message authentication code) algorithms
429in order of preference.
430The MAC algorithm is used in protocol version 2
431for data integrity protection.
432Multiple algorithms must be comma-separated.
433The default is
434.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
435.It Cm NoHostAuthenticationForLocalhost
436This option can be used if the home directory is shared across machines.
437In this case localhost will refer to a different machine on each of
438the machines and the user will get many warnings about changed host keys.
439However, this option disables host authentication for localhost.
440The argument to this keyword must be
441.Dq yes
442or
443.Dq no .
444The default is to check the host key for localhost.
445.It Cm NumberOfPasswordPrompts
446Specifies the number of password prompts before giving up.
447The argument to this keyword must be an integer.
448Default is 3.
449.It Cm PasswordAuthentication
450Specifies whether to use password authentication.
451The argument to this keyword must be
452.Dq yes
453or
454.Dq no .
455The default is
456.Dq yes .
457.It Cm Port
458Specifies the port number to connect on the remote host.
459Default is 22.
460.It Cm PreferredAuthentications
461Specifies the order in which the client should try protocol 2
Damien Millerfbf486b2003-05-23 18:44:23 +1000462authentication methods.
463This allows a client to prefer one method (e.g.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000464.Cm keyboard-interactive )
465over another method (e.g.
466.Cm password )
467The default for this option is:
468.Dq hostbased,publickey,keyboard-interactive,password .
469.It Cm Protocol
470Specifies the protocol versions
471.Nm ssh
472should support in order of preference.
473The possible values are
474.Dq 1
475and
476.Dq 2 .
477Multiple versions must be comma-separated.
478The default is
479.Dq 2,1 .
480This means that
481.Nm ssh
482tries version 2 and falls back to version 1
483if version 2 is not available.
484.It Cm ProxyCommand
485Specifies the command to use to connect to the server.
486The command
487string extends to the end of the line, and is executed with
488.Pa /bin/sh .
489In the command string,
490.Ql %h
491will be substituted by the host name to
492connect and
493.Ql %p
494by the port.
495The command can be basically anything,
496and should read from its standard input and write to its standard output.
497It should eventually connect an
498.Xr sshd 8
499server running on some machine, or execute
500.Ic sshd -i
501somewhere.
502Host key management will be done using the
503HostName of the host being connected (defaulting to the name typed by
504the user).
Damien Miller495dca32003-04-01 21:42:14 +1000505Setting the command to
506.Dq none
Damien Miller9f1e33a2003-02-24 11:57:32 +1100507disables this option entirely.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000508Note that
509.Cm CheckHostIP
510is not available for connects with a proxy command.
511.Pp
512.It Cm PubkeyAuthentication
513Specifies whether to try public key authentication.
514The argument to this keyword must be
515.Dq yes
516or
517.Dq no .
518The default is
519.Dq yes .
520This option applies to protocol version 2 only.
521.It Cm RemoteForward
522Specifies that a TCP/IP port on the remote machine be forwarded over
523the secure channel to the specified host and port from the local machine.
524The first argument must be a port number, and the second must be
525.Ar host:port .
526IPv6 addresses can be specified with an alternative syntax:
527.Ar host/port .
528Multiple forwardings may be specified, and additional
529forwardings can be given on the command line.
530Only the superuser can forward privileged ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000531.It Cm RhostsRSAAuthentication
532Specifies whether to try rhosts based authentication with RSA host
533authentication.
534The argument must be
535.Dq yes
536or
537.Dq no .
538The default is
539.Dq no .
540This option applies to protocol version 1 only and requires
541.Nm ssh
542to be setuid root.
543.It Cm RSAAuthentication
544Specifies whether to try RSA authentication.
545The argument to this keyword must be
546.Dq yes
547or
548.Dq no .
549RSA authentication will only be
550attempted if the identity file exists, or an authentication agent is
551running.
552The default is
553.Dq yes .
554Note that this option applies to protocol version 1 only.
Damien Miller509b0102003-12-17 16:33:10 +1100555.It Cm ServerAliveInterval
556Sets a timeout interval in seconds after which if no data has been received
557from the server,
558.Nm ssh
559will send a message through the encrypted
560channel to request a response from the server.
561The default
562is 0, indicating that these messages will not be sent to the server.
563This option applies to protocol version 2 only.
564.It Cm ServerAliveCountMax
565Sets the number of server alive messages (see above) which may be
566sent without
567.Nm ssh
568receiving any messages back from the server.
569If this threshold is reached while server alive messages are being sent,
570.Nm ssh
571will disconnect from the server, terminating the session.
572It is important to note that the use of server alive messages is very
573different from
574.Cm TCPKeepAlive
575(below).
576The server alive messages are sent through the encrypted channel
577and therefore will not be spoofable.
578The TCP keepalive option enabled by
579.Cm TCPKeepAlive
580is spoofable.
581The server alive mechanism is valuable when the client or
582server depend on knowing when a connection has become inactive.
583.Pp
584The default value is 3.
585If, for example,
586.Cm ServerAliveInterval
587(above) is set to 15, and
588.Cm ServerAliveCountMax
589is left at the default, if the server becomes unresponsive ssh
590will disconnect after approximately 45 seconds.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000591.It Cm SmartcardDevice
Damien Millerfbf486b2003-05-23 18:44:23 +1000592Specifies which smartcard device to use.
593The argument to this keyword is the device
Ben Lindstrom9f049032002-06-21 00:59:05 +0000594.Nm ssh
595should use to communicate with a smartcard used for storing the user's
Damien Millerfbf486b2003-05-23 18:44:23 +1000596private RSA key.
597By default, no device is specified and smartcard support is not activated.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000598.It Cm StrictHostKeyChecking
599If this flag is set to
600.Dq yes ,
601.Nm ssh
602will never automatically add host keys to the
603.Pa $HOME/.ssh/known_hosts
604file, and refuses to connect to hosts whose host key has changed.
605This provides maximum protection against trojan horse attacks,
606however, can be annoying when the
607.Pa /etc/ssh/ssh_known_hosts
608file is poorly maintained, or connections to new hosts are
609frequently made.
610This option forces the user to manually
611add all new hosts.
612If this flag is set to
613.Dq no ,
614.Nm ssh
615will automatically add new host keys to the
616user known hosts files.
617If this flag is set to
618.Dq ask ,
619new host keys
620will be added to the user known host files only after the user
621has confirmed that is what they really want to do, and
622.Nm ssh
623will refuse to connect to hosts whose host key has changed.
624The host keys of
625known hosts will be verified automatically in all cases.
626The argument must be
627.Dq yes ,
628.Dq no
629or
630.Dq ask .
631The default is
632.Dq ask .
Damien Miller12c150e2003-12-17 16:31:10 +1100633.It Cm TCPKeepAlive
634Specifies whether the system should send TCP keepalive messages to the
635other side.
636If they are sent, death of the connection or crash of one
637of the machines will be properly noticed.
638However, this means that
639connections will die if the route is down temporarily, and some people
640find it annoying.
641.Pp
642The default is
643.Dq yes
644(to send TCP keepalive messages), and the client will notice
645if the network goes down or the remote host dies.
646This is important in scripts, and many users want it too.
647.Pp
648To disable TCP keepalive messages, the value should be set to
649.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000650.It Cm UsePrivilegedPort
651Specifies whether to use a privileged port for outgoing connections.
652The argument must be
653.Dq yes
654or
655.Dq no .
656The default is
657.Dq no .
Damien Miller9b1dacd2002-09-04 16:47:35 +1000658If set to
659.Dq yes
660.Nm ssh
661must be setuid root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000662Note that this option must be set to
663.Dq yes
Darren Tuckerec960f22003-08-13 20:37:05 +1000664for
Ben Lindstrom9f049032002-06-21 00:59:05 +0000665.Cm RhostsRSAAuthentication
Darren Tuckerec960f22003-08-13 20:37:05 +1000666with older servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000667.It Cm User
668Specifies the user to log in as.
669This can be useful when a different user name is used on different machines.
670This saves the trouble of
671having to remember to give the user name on the command line.
672.It Cm UserKnownHostsFile
673Specifies a file to use for the user
674host key database instead of
675.Pa $HOME/.ssh/known_hosts .
Damien Miller37876e92003-05-15 10:19:46 +1000676.It Cm VerifyHostKeyDNS
677Specifies whether to verify the remote key using DNS and SSHFP resource
678records.
Damien Miller150b5572003-11-17 21:19:29 +1100679If this option is set to
680.Dq yes ,
Damien Millerfe448472003-11-17 21:19:49 +1100681the client will implicitly trust keys that match a secure fingerprint
Damien Miller150b5572003-11-17 21:19:29 +1100682from DNS.
683Insecure fingerprints will be handled as if this option was set to
684.Dq ask .
685If this option is set to
686.Dq ask ,
687information on fingerprint match will be displayed, but the user will still
688need to confirm new host keys according to the
689.Cm StrictHostKeyChecking
690option.
691The argument must be
692.Dq yes ,
693.Dq no
Damien Millerfe448472003-11-17 21:19:49 +1100694or
695.Dq ask .
Damien Miller37876e92003-05-15 10:19:46 +1000696The default is
697.Dq no .
Damien Millereacbb4f2003-06-02 19:10:41 +1000698Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000699.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +1000700Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000701.Xr xauth 1
702program.
703The default is
704.Pa /usr/X11R6/bin/xauth .
705.El
706.Sh FILES
707.Bl -tag -width Ds
708.It Pa $HOME/.ssh/config
709This is the per-user configuration file.
710The format of this file is described above.
711This file is used by the
712.Nm ssh
713client.
714This file does not usually contain any sensitive information,
715but the recommended permissions are read/write for the user, and not
716accessible by others.
717.It Pa /etc/ssh/ssh_config
718Systemwide configuration file.
719This file provides defaults for those
720values that are not specified in the user's configuration file, and
721for those users who do not have a configuration file.
722This file must be world-readable.
723.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000724.Sh SEE ALSO
725.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000726.Sh AUTHORS
727OpenSSH is a derivative of the original and free
728ssh 1.2.12 release by Tatu Ylonen.
729Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
730Theo de Raadt and Dug Song
731removed many bugs, re-added newer features and
732created OpenSSH.
733Markus Friedl contributed the support for SSH
734protocol versions 1.5 and 2.0.