blob: 2afc3c093916b7c9d18b0953f7ac8c0da824b7a3 [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 Miller6476cad2005-06-16 13:18:34 +100037.\" $OpenBSD: ssh_config.5,v 1.55 2005/06/06 11:20:36 djm 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
Damien Miller167ea5d2005-05-26 12:04:02 +100046.It Pa ~/.ssh/config
Ben Lindstrom9f049032002-06-21 00:59:05 +000047.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
Damien Miller167ea5d2005-05-26 12:04:02 +100058.Pq Pa ~/.ssh/config
Ben Lindstrom479b4762002-08-20 19:04:51 +000059.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.
Darren Tucker43d8e282005-02-09 09:51:08 +110066The configuration files contain sections separated by
Ben Lindstrom9f049032002-06-21 00:59:05 +000067.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
Darren Tucker79a7acf2005-02-09 09:48:57 +1100123(use IPv4 only) or
Damien Miller20a8f972003-05-18 20:50:30 +1000124.Dq inet6
Darren Tucker79a7acf2005-02-09 09:48:57 +1100125(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.
Damien Miller05202ff2004-06-15 10:30:39 +1000188The 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 ,
Damien Miller3710f272005-05-26 12:19:17 +1000196.Dq arcfour128 ,
197.Dq arcfour256 ,
Damien Miller05202ff2004-06-15 10:30:39 +1000198.Dq arcfour ,
199.Dq blowfish-cbc ,
200and
201.Dq cast128-cbc .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000202The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000203.Bd -literal
Damien Miller3710f272005-05-26 12:19:17 +1000204 ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128,
205 arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr,
206 aes192-ctr,aes256-ctr''
Ben Lindstrom9f049032002-06-21 00:59:05 +0000207.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
Damien Miller495dca32003-04-01 21:42:14 +1000211cleared.
212This option is primarily useful when used from the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000213.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.
Damien Millerb78d5eb2003-05-16 11:39:04 +1000245.It Cm ConnectTimeout
246Specifies the timeout (in seconds) used when connecting to the ssh
Damien Millerfbf486b2003-05-23 18:44:23 +1000247server, 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.
Damien Miller0e220db2004-06-15 10:34:08 +1000250.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
Damien Miller2234bac2004-06-30 22:38:52 +1000264(the default).
Damien Miller0e220db2004-06-15 10:34:08 +1000265These sessions will reuse the master instance's network connection rather
266than initiating new ones.
Damien Miller23f07702004-06-18 01:19:03 +1000267Setting 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
Damien Miller2234bac2004-06-30 22:38:52 +1000275for details).
Damien Millerdadfd4d2005-05-26 12:07:13 +1000276If the
277.Cm ControlPath
278can not be opened,
279.Nm ssh
280will continue without connecting to a master instance.
Damien Miller0e220db2004-06-15 10:34:08 +1000281.It Cm ControlPath
Damien Miller6476cad2005-06-16 13:18:34 +1000282Specify the path to the control socket used for connection sharing as described
283in the
Damien Miller0e220db2004-06-15 10:34:08 +1000284.Cm ControlMaster
Damien Miller6476cad2005-06-16 13:18:34 +1000285section above.
286In the path,
287.Ql %h
288will be substituted by the target host name,
289.Ql %p
290the port and
291.Ql %r
292by the remote login username.
Damien Miller2234bac2004-06-30 22:38:52 +1000293.It Cm DynamicForward
294Specifies that a TCP/IP port on the local machine be forwarded
295over the secure channel, and the application
296protocol is then used to determine where to connect to from the
297remote machine.
298The argument must be a port number.
299Currently the SOCKS4 and SOCKS5 protocols are supported, and
300.Nm ssh
301will act as a SOCKS server.
302Multiple forwardings may be specified, and
303additional forwardings can be given on the command line.
304Only the superuser can forward privileged ports.
Darren Tucker674f71d2003-06-28 12:33:12 +1000305.It Cm EnableSSHKeysign
306Setting this option to
307.Dq yes
308in the global client configuration file
309.Pa /etc/ssh/ssh_config
310enables the use of the helper program
311.Xr ssh-keysign 8
312during
313.Cm HostbasedAuthentication .
314The argument must be
315.Dq yes
316or
317.Dq no .
318The default is
319.Dq no .
Darren Tuckerf132c672003-10-15 15:58:18 +1000320This option should be placed in the non-hostspecific section.
Darren Tucker674f71d2003-06-28 12:33:12 +1000321See
322.Xr ssh-keysign 8
323for more information.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000324.It Cm EscapeChar
325Sets the escape character (default:
326.Ql ~ ) .
327The escape character can also
328be set on the command line.
329The argument should be a single character,
330.Ql ^
331followed by a letter, or
332.Dq none
333to disable the escape
334character entirely (making the connection transparent for binary
335data).
336.It Cm ForwardAgent
337Specifies whether the connection to the authentication agent (if any)
338will be forwarded to the remote machine.
339The argument must be
340.Dq yes
341or
342.Dq no .
343The default is
344.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000345.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000346Agent forwarding should be enabled with caution.
347Users with the ability to bypass file permissions on the remote host
348(for the agent's Unix-domain socket)
349can access the local agent through the forwarded connection.
350An attacker cannot obtain key material from the agent,
Damien Milleraf653042002-09-04 16:40:37 +1000351however they can perform operations on the keys that enable them to
352authenticate using the identities loaded into the agent.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000353.It Cm ForwardX11
354Specifies whether X11 connections will be automatically redirected
355over the secure channel and
356.Ev DISPLAY
357set.
358The argument must be
359.Dq yes
360or
361.Dq no .
362The default is
363.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000364.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000365X11 forwarding should be enabled with caution.
366Users with the ability to bypass file permissions on the remote host
Darren Tucker0a118da2003-10-15 15:54:32 +1000367(for the user's X11 authorization database)
Damien Miller495dca32003-04-01 21:42:14 +1000368can access the local X11 display through the forwarded connection.
Darren Tucker0a118da2003-10-15 15:54:32 +1000369An attacker may then be able to perform activities such as keystroke monitoring
370if the
371.Cm ForwardX11Trusted
372option is also enabled.
373.It Cm ForwardX11Trusted
Darren Tuckerdcf6ec42004-05-13 13:03:56 +1000374If this option is set to
Darren Tucker0a118da2003-10-15 15:54:32 +1000375.Dq yes
376then remote X11 clients will have full access to the original X11 display.
Damien Miller1717fd42005-03-01 21:17:31 +1100377.Pp
Darren Tucker0a118da2003-10-15 15:54:32 +1000378If this option is set to
379.Dq no
380then remote X11 clients will be considered untrusted and prevented
381from stealing or tampering with data belonging to trusted X11
382clients.
Damien Miller1717fd42005-03-01 21:17:31 +1100383Furthermore, the
384.Xr xauth 1
385token used for the session will be set to expire after 20 minutes.
386Remote clients will be refused access after this time.
Darren Tucker0a118da2003-10-15 15:54:32 +1000387.Pp
388The default is
389.Dq no .
390.Pp
391See the X11 SECURITY extension specification for full details on
392the restrictions imposed on untrusted clients.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000393.It Cm GatewayPorts
394Specifies whether remote hosts are allowed to connect to local
395forwarded ports.
396By default,
397.Nm ssh
Damien Miller495dca32003-04-01 21:42:14 +1000398binds local port forwardings to the loopback address.
399This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000400.Cm GatewayPorts
401can be used to specify that
402.Nm ssh
403should bind local port forwardings to the wildcard address,
404thus allowing remote hosts to connect to forwarded ports.
405The argument must be
406.Dq yes
407or
408.Dq no .
409The default is
410.Dq no .
411.It Cm GlobalKnownHostsFile
412Specifies a file to use for the global
413host key database instead of
414.Pa /etc/ssh/ssh_known_hosts .
Darren Tucker0efd1552003-08-26 11:49:55 +1000415.It Cm GSSAPIAuthentication
Damien Millerbaafb982003-12-17 16:32:23 +1100416Specifies whether user authentication based on GSSAPI is allowed.
Damien Millerc2b98272003-09-03 12:13:30 +1000417The default is
Darren Tuckera044f472003-10-15 15:52:03 +1000418.Dq no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000419Note that this option applies to protocol version 2 only.
420.It Cm GSSAPIDelegateCredentials
421Forward (delegate) credentials to the server.
422The default is
423.Dq no .
424Note that this option applies to protocol version 2 only.
Damien Millere1776152005-03-01 21:47:37 +1100425.It Cm HashKnownHosts
426Indicates that
427.Nm ssh
428should hash host names and addresses when they are added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000429.Pa ~/.ssh/known_hosts .
Damien Millere1776152005-03-01 21:47:37 +1100430These hashed names may be used normally by
431.Nm ssh
432and
433.Nm sshd ,
434but they do not reveal identifying information should the file's contents
435be disclosed.
436The default is
437.Dq no .
Damien Millerf8c55462005-03-02 12:03:05 +1100438Note that hashing of names and addresses will not be retrospectively applied
Damien Miller4b42d7f2005-03-01 21:48:35 +1100439to existing known hosts files, but these may be manually hashed using
440.Xr ssh-keygen 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000441.It Cm HostbasedAuthentication
442Specifies whether to try rhosts based authentication with public key
443authentication.
444The argument must be
445.Dq yes
446or
447.Dq no .
448The default is
449.Dq no .
450This option applies to protocol version 2 only and
451is similar to
452.Cm RhostsRSAAuthentication .
453.It Cm HostKeyAlgorithms
454Specifies the protocol version 2 host key algorithms
455that the client wants to use in order of preference.
456The default for this option is:
457.Dq ssh-rsa,ssh-dss .
458.It Cm HostKeyAlias
459Specifies an alias that should be used instead of the
460real host name when looking up or saving the host key
461in the host key database files.
462This option is useful for tunneling ssh connections
463or for multiple servers running on a single host.
464.It Cm HostName
465Specifies the real host name to log into.
466This can be used to specify nicknames or abbreviations for hosts.
467Default is the name given on the command line.
468Numeric IP addresses are also permitted (both on the command line and in
469.Cm HostName
470specifications).
471.It Cm IdentityFile
472Specifies a file from which the user's RSA or DSA authentication identity
Damien Millerfbf486b2003-05-23 18:44:23 +1000473is read.
474The default is
Damien Miller167ea5d2005-05-26 12:04:02 +1000475.Pa ~/.ssh/identity
Ben Lindstrom9f049032002-06-21 00:59:05 +0000476for protocol version 1, and
Damien Miller167ea5d2005-05-26 12:04:02 +1000477.Pa ~/.ssh/id_rsa
Ben Lindstrom9f049032002-06-21 00:59:05 +0000478and
Damien Miller167ea5d2005-05-26 12:04:02 +1000479.Pa ~/.ssh/id_dsa
Ben Lindstrom9f049032002-06-21 00:59:05 +0000480for protocol version 2.
481Additionally, any identities represented by the authentication agent
482will be used for authentication.
483The file name may use the tilde
484syntax to refer to a user's home directory.
485It is possible to have
486multiple identity files specified in configuration files; all these
487identities will be tried in sequence.
Damien Millerbd394c32004-03-08 23:12:36 +1100488.It Cm IdentitiesOnly
489Specifies that
490.Nm ssh
491should only use the authentication identity files configured in the
Damien Miller1a812582004-04-20 20:13:32 +1000492.Nm
Damien Millerbd394c32004-03-08 23:12:36 +1100493files,
494even if the
495.Nm ssh-agent
496offers more identities.
497The argument to this keyword must be
498.Dq yes
499or
500.Dq no .
501This option is intented for situations where
502.Nm ssh-agent
503offers many different identities.
504The default is
505.Dq no .
Darren Tucker636ca902004-11-05 20:22:00 +1100506.It Cm KbdInteractiveDevices
507Specifies the list of methods to use in keyboard-interactive authentication.
508Multiple method names must be comma-separated.
509The default is to use the server specified list.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000510.It Cm LocalForward
511Specifies that a TCP/IP port on the local machine be forwarded over
512the secure channel to the specified host and port from the remote machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000513The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +1100514.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000515.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +1100516.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000517and the second argument must be
518.Ar host : Ns Ar hostport .
Damien Millerf8c55462005-03-02 12:03:05 +1100519IPv6 addresses can be specified by enclosing addresses in square brackets or
Damien Millerf91ee4c2005-03-01 21:24:33 +1100520by using an alternative syntax:
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000521.Oo Ar bind_address Ns / Oc Ns Ar port
522and
523.Ar host Ns / Ns Ar hostport .
Damien Millerf8c55462005-03-02 12:03:05 +1100524Multiple forwardings may be specified, and additional forwardings can be
Damien Millerf91ee4c2005-03-01 21:24:33 +1100525given on the command line.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000526Only the superuser can forward privileged ports.
Damien Millerf91ee4c2005-03-01 21:24:33 +1100527By default, the local port is bound in accordance with the
528.Cm GatewayPorts
529setting.
530However, an explicit
531.Ar bind_address
532may be used to bind the connection to a specific address.
533The
534.Ar bind_address
535of
536.Dq localhost
Damien Millerf8c55462005-03-02 12:03:05 +1100537indicates that the listening port be bound for local use only, while an
538empty address or
539.Sq *
Damien Millerf91ee4c2005-03-01 21:24:33 +1100540indicates that the port should be available from all interfaces.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000541.It Cm LogLevel
542Gives the verbosity level that is used when logging messages from
543.Nm ssh .
544The possible values are:
545QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +1000546The default is INFO.
547DEBUG and DEBUG1 are equivalent.
548DEBUG2 and DEBUG3 each specify higher levels of verbose output.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000549.It Cm MACs
550Specifies the MAC (message authentication code) algorithms
551in order of preference.
552The MAC algorithm is used in protocol version 2
553for data integrity protection.
554Multiple algorithms must be comma-separated.
555The default is
556.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
557.It Cm NoHostAuthenticationForLocalhost
558This option can be used if the home directory is shared across machines.
559In this case localhost will refer to a different machine on each of
560the machines and the user will get many warnings about changed host keys.
561However, this option disables host authentication for localhost.
562The argument to this keyword must be
563.Dq yes
564or
565.Dq no .
566The default is to check the host key for localhost.
567.It Cm NumberOfPasswordPrompts
568Specifies the number of password prompts before giving up.
569The argument to this keyword must be an integer.
570Default is 3.
571.It Cm PasswordAuthentication
572Specifies whether to use password authentication.
573The argument to this keyword must be
574.Dq yes
575or
576.Dq no .
577The default is
578.Dq yes .
579.It Cm Port
580Specifies the port number to connect on the remote host.
581Default is 22.
582.It Cm PreferredAuthentications
583Specifies the order in which the client should try protocol 2
Damien Millerfbf486b2003-05-23 18:44:23 +1000584authentication methods.
Darren Tucker1adc2bd2005-03-14 23:14:20 +1100585This allows a client to prefer one method (e.g.\&
Ben Lindstrom9f049032002-06-21 00:59:05 +0000586.Cm keyboard-interactive )
Darren Tucker1adc2bd2005-03-14 23:14:20 +1100587over another method (e.g.\&
Ben Lindstrom9f049032002-06-21 00:59:05 +0000588.Cm password )
589The default for this option is:
590.Dq hostbased,publickey,keyboard-interactive,password .
591.It Cm Protocol
592Specifies the protocol versions
593.Nm ssh
594should support in order of preference.
595The possible values are
596.Dq 1
597and
598.Dq 2 .
599Multiple versions must be comma-separated.
600The default is
601.Dq 2,1 .
602This means that
603.Nm ssh
604tries version 2 and falls back to version 1
605if version 2 is not available.
606.It Cm ProxyCommand
607Specifies the command to use to connect to the server.
608The command
609string extends to the end of the line, and is executed with
610.Pa /bin/sh .
611In the command string,
612.Ql %h
613will be substituted by the host name to
614connect and
615.Ql %p
616by the port.
617The command can be basically anything,
618and should read from its standard input and write to its standard output.
619It should eventually connect an
620.Xr sshd 8
621server running on some machine, or execute
622.Ic sshd -i
623somewhere.
624Host key management will be done using the
625HostName of the host being connected (defaulting to the name typed by
626the user).
Damien Miller495dca32003-04-01 21:42:14 +1000627Setting the command to
628.Dq none
Damien Miller9f1e33a2003-02-24 11:57:32 +1100629disables this option entirely.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000630Note that
631.Cm CheckHostIP
632is not available for connects with a proxy command.
633.Pp
Damien Millerebcfedc2005-05-26 12:13:56 +1000634This directive is useful in conjunction with
635.Xr nc 1
636and its proxy support.
Damien Millerdfec2942005-05-26 12:14:32 +1000637For example, the following directive would connect via an HTTP proxy at
Damien Millerebcfedc2005-05-26 12:13:56 +1000638192.0.2.0:
639.Bd -literal -offset 3n
640ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
641.Ed
Ben Lindstrom9f049032002-06-21 00:59:05 +0000642.It Cm PubkeyAuthentication
643Specifies whether to try public key authentication.
644The argument to this keyword must be
645.Dq yes
646or
647.Dq no .
648The default is
649.Dq yes .
650This option applies to protocol version 2 only.
651.It Cm RemoteForward
652Specifies that a TCP/IP port on the remote machine be forwarded over
653the secure channel to the specified host and port from the local machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000654The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +1100655.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000656.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +1100657.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000658and the second argument must be
659.Ar host : Ns Ar hostport .
660IPv6 addresses can be specified by enclosing addresses in square brackets
661or by using an alternative syntax:
662.Oo Ar bind_address Ns / Oc Ns Ar port
663and
664.Ar host Ns / Ns Ar hostport .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000665Multiple forwardings may be specified, and additional
666forwardings can be given on the command line.
667Only the superuser can forward privileged ports.
Damien Millerf91ee4c2005-03-01 21:24:33 +1100668.Pp
669If the
670.Ar bind_address
671is not specified, the default is to only bind to loopback addresses.
672If the
673.Ar bind_address
674is
675.Ql *
676or an empty string, then the forwarding is requested to listen on all
677interfaces.
678Specifying a remote
679.Ar bind_address
Damien Millerf8c55462005-03-02 12:03:05 +1100680will only succeed if the server's
681.Cm GatewayPorts
Damien Millerf91ee4c2005-03-01 21:24:33 +1100682option is enabled (see
Damien Millerf8c55462005-03-02 12:03:05 +1100683.Xr sshd_config 5 ) .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000684.It Cm RhostsRSAAuthentication
685Specifies whether to try rhosts based authentication with RSA host
686authentication.
687The argument must be
688.Dq yes
689or
690.Dq no .
691The default is
692.Dq no .
693This option applies to protocol version 1 only and requires
694.Nm ssh
695to be setuid root.
696.It Cm RSAAuthentication
697Specifies whether to try RSA authentication.
698The argument to this keyword must be
699.Dq yes
700or
701.Dq no .
702RSA authentication will only be
703attempted if the identity file exists, or an authentication agent is
704running.
705The default is
706.Dq yes .
707Note that this option applies to protocol version 1 only.
Darren Tucker46bc0752004-05-02 22:11:30 +1000708.It Cm SendEnv
709Specifies what variables from the local
710.Xr environ 7
711should be sent to the server.
712Note that environment passing is only supported for protocol 2, the
Darren Tucker1e0c9bf2004-05-02 22:12:48 +1000713server must also support it, and the server must be configured to
714accept these environment variables.
Darren Tucker46bc0752004-05-02 22:11:30 +1000715Refer to
716.Cm AcceptEnv
717in
718.Xr sshd_config 5
719for how to configure the server.
720Variables are specified by name, which may contain the wildcard characters
721.Ql \&*
722and
723.Ql \&? .
Darren Tucker1e0c9bf2004-05-02 22:12:48 +1000724Multiple environment variables may be separated by whitespace or spread
Darren Tucker46bc0752004-05-02 22:11:30 +1000725across multiple
726.Cm SendEnv
727directives.
728The default is not to send any environment variables.
Damien Miller509b0102003-12-17 16:33:10 +1100729.It Cm ServerAliveInterval
730Sets a timeout interval in seconds after which if no data has been received
731from the server,
732.Nm ssh
733will send a message through the encrypted
734channel to request a response from the server.
735The default
736is 0, indicating that these messages will not be sent to the server.
737This option applies to protocol version 2 only.
738.It Cm ServerAliveCountMax
739Sets the number of server alive messages (see above) which may be
740sent without
741.Nm ssh
742receiving any messages back from the server.
743If this threshold is reached while server alive messages are being sent,
744.Nm ssh
745will disconnect from the server, terminating the session.
746It is important to note that the use of server alive messages is very
747different from
748.Cm TCPKeepAlive
749(below).
750The server alive messages are sent through the encrypted channel
751and therefore will not be spoofable.
752The TCP keepalive option enabled by
753.Cm TCPKeepAlive
754is spoofable.
755The server alive mechanism is valuable when the client or
756server depend on knowing when a connection has become inactive.
757.Pp
758The default value is 3.
759If, for example,
760.Cm ServerAliveInterval
761(above) is set to 15, and
762.Cm ServerAliveCountMax
763is left at the default, if the server becomes unresponsive ssh
764will disconnect after approximately 45 seconds.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000765.It Cm SmartcardDevice
Damien Millerfbf486b2003-05-23 18:44:23 +1000766Specifies which smartcard device to use.
767The argument to this keyword is the device
Ben Lindstrom9f049032002-06-21 00:59:05 +0000768.Nm ssh
769should use to communicate with a smartcard used for storing the user's
Damien Millerfbf486b2003-05-23 18:44:23 +1000770private RSA key.
771By default, no device is specified and smartcard support is not activated.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000772.It Cm StrictHostKeyChecking
773If this flag is set to
774.Dq yes ,
775.Nm ssh
776will never automatically add host keys to the
Damien Miller167ea5d2005-05-26 12:04:02 +1000777.Pa ~/.ssh/known_hosts
Ben Lindstrom9f049032002-06-21 00:59:05 +0000778file, and refuses to connect to hosts whose host key has changed.
779This provides maximum protection against trojan horse attacks,
780however, can be annoying when the
781.Pa /etc/ssh/ssh_known_hosts
782file is poorly maintained, or connections to new hosts are
783frequently made.
784This option forces the user to manually
785add all new hosts.
786If this flag is set to
787.Dq no ,
788.Nm ssh
789will automatically add new host keys to the
790user known hosts files.
791If this flag is set to
792.Dq ask ,
793new host keys
794will be added to the user known host files only after the user
795has confirmed that is what they really want to do, and
796.Nm ssh
797will refuse to connect to hosts whose host key has changed.
798The host keys of
799known hosts will be verified automatically in all cases.
800The argument must be
801.Dq yes ,
802.Dq no
803or
804.Dq ask .
805The default is
806.Dq ask .
Damien Miller12c150e2003-12-17 16:31:10 +1100807.It Cm TCPKeepAlive
808Specifies whether the system should send TCP keepalive messages to the
809other side.
810If they are sent, death of the connection or crash of one
811of the machines will be properly noticed.
812However, this means that
813connections will die if the route is down temporarily, and some people
814find it annoying.
815.Pp
816The default is
817.Dq yes
818(to send TCP keepalive messages), and the client will notice
819if the network goes down or the remote host dies.
820This is important in scripts, and many users want it too.
821.Pp
822To disable TCP keepalive messages, the value should be set to
823.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000824.It Cm UsePrivilegedPort
825Specifies whether to use a privileged port for outgoing connections.
826The argument must be
827.Dq yes
828or
829.Dq no .
830The default is
831.Dq no .
Damien Miller9b1dacd2002-09-04 16:47:35 +1000832If set to
833.Dq yes
834.Nm ssh
835must be setuid root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000836Note that this option must be set to
837.Dq yes
Darren Tuckerec960f22003-08-13 20:37:05 +1000838for
Ben Lindstrom9f049032002-06-21 00:59:05 +0000839.Cm RhostsRSAAuthentication
Darren Tuckerec960f22003-08-13 20:37:05 +1000840with older servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000841.It Cm User
842Specifies the user to log in as.
843This can be useful when a different user name is used on different machines.
844This saves the trouble of
845having to remember to give the user name on the command line.
846.It Cm UserKnownHostsFile
847Specifies a file to use for the user
848host key database instead of
Damien Miller167ea5d2005-05-26 12:04:02 +1000849.Pa ~/.ssh/known_hosts .
Damien Miller37876e92003-05-15 10:19:46 +1000850.It Cm VerifyHostKeyDNS
851Specifies whether to verify the remote key using DNS and SSHFP resource
852records.
Damien Miller150b5572003-11-17 21:19:29 +1100853If this option is set to
854.Dq yes ,
Damien Millerfe448472003-11-17 21:19:49 +1100855the client will implicitly trust keys that match a secure fingerprint
Damien Miller150b5572003-11-17 21:19:29 +1100856from DNS.
857Insecure fingerprints will be handled as if this option was set to
858.Dq ask .
859If this option is set to
860.Dq ask ,
861information on fingerprint match will be displayed, but the user will still
862need to confirm new host keys according to the
863.Cm StrictHostKeyChecking
864option.
865The argument must be
866.Dq yes ,
867.Dq no
Damien Millerfe448472003-11-17 21:19:49 +1100868or
869.Dq ask .
Damien Miller37876e92003-05-15 10:19:46 +1000870The default is
871.Dq no .
Damien Millereacbb4f2003-06-02 19:10:41 +1000872Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000873.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +1000874Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000875.Xr xauth 1
876program.
877The default is
878.Pa /usr/X11R6/bin/xauth .
879.El
880.Sh FILES
881.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +1000882.It Pa ~/.ssh/config
Ben Lindstrom9f049032002-06-21 00:59:05 +0000883This is the per-user configuration file.
884The format of this file is described above.
885This file is used by the
886.Nm ssh
887client.
Damien Millerc970cb92004-04-20 20:12:53 +1000888Because of the potential for abuse, this file must have strict permissions:
889read/write for the user, and not accessible by others.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000890.It Pa /etc/ssh/ssh_config
891Systemwide configuration file.
892This file provides defaults for those
893values that are not specified in the user's configuration file, and
894for those users who do not have a configuration file.
895This file must be world-readable.
896.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000897.Sh SEE ALSO
898.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000899.Sh AUTHORS
900OpenSSH is a derivative of the original and free
901ssh 1.2.12 release by Tatu Ylonen.
902Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
903Theo de Raadt and Dug Song
904removed many bugs, re-added newer features and
905created OpenSSH.
906Markus Friedl contributed the support for SSH
907protocol versions 1.5 and 2.0.