blob: d98246aa469d6832d7b2691bec5ad535af298193 [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 Millerdadfd4d2005-05-26 12:07:13 +100037.\" $OpenBSD: ssh_config.5,v 1.51 2005/04/26 13:08:37 jakob 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 ,
196.Dq arcfour ,
197.Dq blowfish-cbc ,
198and
199.Dq cast128-cbc .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000200The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000201.Bd -literal
202 ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
203 aes192-cbc,aes256-cbc''
204.Ed
205.It Cm ClearAllForwardings
206Specifies that all local, remote and dynamic port forwardings
207specified in the configuration files or on the command line be
Damien Miller495dca32003-04-01 21:42:14 +1000208cleared.
209This option is primarily useful when used from the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000210.Nm ssh
211command line to clear port forwardings set in
212configuration files, and is automatically set by
213.Xr scp 1
214and
215.Xr sftp 1 .
216The argument must be
217.Dq yes
218or
219.Dq no .
220The default is
221.Dq no .
222.It Cm Compression
223Specifies whether to use compression.
224The argument must be
225.Dq yes
226or
227.Dq no .
228The default is
229.Dq no .
230.It Cm CompressionLevel
231Specifies the compression level to use if compression is enabled.
232The argument must be an integer from 1 (fast) to 9 (slow, best).
233The default level is 6, which is good for most applications.
234The meaning of the values is the same as in
235.Xr gzip 1 .
236Note that this option applies to protocol version 1 only.
237.It Cm ConnectionAttempts
238Specifies the number of tries (one per second) to make before exiting.
239The argument must be an integer.
240This may be useful in scripts if the connection sometimes fails.
241The default is 1.
Damien Millerb78d5eb2003-05-16 11:39:04 +1000242.It Cm ConnectTimeout
243Specifies the timeout (in seconds) used when connecting to the ssh
Damien Millerfbf486b2003-05-23 18:44:23 +1000244server, instead of using the default system TCP timeout.
245This value is used only when the target is down or really unreachable,
246not when it refuses the connection.
Damien Miller0e220db2004-06-15 10:34:08 +1000247.It Cm ControlMaster
248Enables the sharing of multiple sessions over a single network connection.
249When set to
250.Dq yes
251.Nm ssh
252will listen for connections on a control socket specified using the
253.Cm ControlPath
254argument.
255Additional sessions can connect to this socket using the same
256.Cm ControlPath
257with
258.Cm ControlMaster
259set to
260.Dq no
Damien Miller2234bac2004-06-30 22:38:52 +1000261(the default).
Damien Miller0e220db2004-06-15 10:34:08 +1000262These sessions will reuse the master instance's network connection rather
263than initiating new ones.
Damien Miller23f07702004-06-18 01:19:03 +1000264Setting this to
265.Dq ask
266will cause
267.Nm ssh
268to listen for control connections, but require confirmation using the
269.Ev SSH_ASKPASS
270program before they are accepted (see
271.Xr ssh-add 1
Damien Miller2234bac2004-06-30 22:38:52 +1000272for details).
Damien Millerdadfd4d2005-05-26 12:07:13 +1000273If the
274.Cm ControlPath
275can not be opened,
276.Nm ssh
277will continue without connecting to a master instance.
Damien Miller0e220db2004-06-15 10:34:08 +1000278.It Cm ControlPath
Damien Miller2234bac2004-06-30 22:38:52 +1000279Specify the path to the control socket used for connection sharing.
Damien Miller0e220db2004-06-15 10:34:08 +1000280See
281.Cm ControlMaster
282above.
Damien Miller2234bac2004-06-30 22:38:52 +1000283.It Cm DynamicForward
284Specifies that a TCP/IP port on the local machine be forwarded
285over the secure channel, and the application
286protocol is then used to determine where to connect to from the
287remote machine.
288The argument must be a port number.
289Currently the SOCKS4 and SOCKS5 protocols are supported, and
290.Nm ssh
291will act as a SOCKS server.
292Multiple forwardings may be specified, and
293additional forwardings can be given on the command line.
294Only the superuser can forward privileged ports.
Darren Tucker674f71d2003-06-28 12:33:12 +1000295.It Cm EnableSSHKeysign
296Setting this option to
297.Dq yes
298in the global client configuration file
299.Pa /etc/ssh/ssh_config
300enables the use of the helper program
301.Xr ssh-keysign 8
302during
303.Cm HostbasedAuthentication .
304The argument must be
305.Dq yes
306or
307.Dq no .
308The default is
309.Dq no .
Darren Tuckerf132c672003-10-15 15:58:18 +1000310This option should be placed in the non-hostspecific section.
Darren Tucker674f71d2003-06-28 12:33:12 +1000311See
312.Xr ssh-keysign 8
313for more information.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000314.It Cm EscapeChar
315Sets the escape character (default:
316.Ql ~ ) .
317The escape character can also
318be set on the command line.
319The argument should be a single character,
320.Ql ^
321followed by a letter, or
322.Dq none
323to disable the escape
324character entirely (making the connection transparent for binary
325data).
326.It Cm ForwardAgent
327Specifies whether the connection to the authentication agent (if any)
328will be forwarded to the remote machine.
329The argument must be
330.Dq yes
331or
332.Dq no .
333The default is
334.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000335.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000336Agent forwarding should be enabled with caution.
337Users with the ability to bypass file permissions on the remote host
338(for the agent's Unix-domain socket)
339can access the local agent through the forwarded connection.
340An attacker cannot obtain key material from the agent,
Damien Milleraf653042002-09-04 16:40:37 +1000341however they can perform operations on the keys that enable them to
342authenticate using the identities loaded into the agent.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000343.It Cm ForwardX11
344Specifies whether X11 connections will be automatically redirected
345over the secure channel and
346.Ev DISPLAY
347set.
348The argument must be
349.Dq yes
350or
351.Dq no .
352The default is
353.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000354.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000355X11 forwarding should be enabled with caution.
356Users with the ability to bypass file permissions on the remote host
Darren Tucker0a118da2003-10-15 15:54:32 +1000357(for the user's X11 authorization database)
Damien Miller495dca32003-04-01 21:42:14 +1000358can access the local X11 display through the forwarded connection.
Darren Tucker0a118da2003-10-15 15:54:32 +1000359An attacker may then be able to perform activities such as keystroke monitoring
360if the
361.Cm ForwardX11Trusted
362option is also enabled.
363.It Cm ForwardX11Trusted
Darren Tuckerdcf6ec42004-05-13 13:03:56 +1000364If this option is set to
Darren Tucker0a118da2003-10-15 15:54:32 +1000365.Dq yes
366then remote X11 clients will have full access to the original X11 display.
Damien Miller1717fd42005-03-01 21:17:31 +1100367.Pp
Darren Tucker0a118da2003-10-15 15:54:32 +1000368If this option is set to
369.Dq no
370then remote X11 clients will be considered untrusted and prevented
371from stealing or tampering with data belonging to trusted X11
372clients.
Damien Miller1717fd42005-03-01 21:17:31 +1100373Furthermore, the
374.Xr xauth 1
375token used for the session will be set to expire after 20 minutes.
376Remote clients will be refused access after this time.
Darren Tucker0a118da2003-10-15 15:54:32 +1000377.Pp
378The default is
379.Dq no .
380.Pp
381See the X11 SECURITY extension specification for full details on
382the restrictions imposed on untrusted clients.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000383.It Cm GatewayPorts
384Specifies whether remote hosts are allowed to connect to local
385forwarded ports.
386By default,
387.Nm ssh
Damien Miller495dca32003-04-01 21:42:14 +1000388binds local port forwardings to the loopback address.
389This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000390.Cm GatewayPorts
391can be used to specify that
392.Nm ssh
393should bind local port forwardings to the wildcard address,
394thus allowing remote hosts to connect to forwarded ports.
395The argument must be
396.Dq yes
397or
398.Dq no .
399The default is
400.Dq no .
401.It Cm GlobalKnownHostsFile
402Specifies a file to use for the global
403host key database instead of
404.Pa /etc/ssh/ssh_known_hosts .
Darren Tucker0efd1552003-08-26 11:49:55 +1000405.It Cm GSSAPIAuthentication
Damien Millerbaafb982003-12-17 16:32:23 +1100406Specifies whether user authentication based on GSSAPI is allowed.
Damien Millerc2b98272003-09-03 12:13:30 +1000407The default is
Darren Tuckera044f472003-10-15 15:52:03 +1000408.Dq no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000409Note that this option applies to protocol version 2 only.
410.It Cm GSSAPIDelegateCredentials
411Forward (delegate) credentials to the server.
412The default is
413.Dq no .
414Note that this option applies to protocol version 2 only.
Damien Millere1776152005-03-01 21:47:37 +1100415.It Cm HashKnownHosts
416Indicates that
417.Nm ssh
418should hash host names and addresses when they are added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000419.Pa ~/.ssh/known_hosts .
Damien Millere1776152005-03-01 21:47:37 +1100420These hashed names may be used normally by
421.Nm ssh
422and
423.Nm sshd ,
424but they do not reveal identifying information should the file's contents
425be disclosed.
426The default is
427.Dq no .
Damien Millerf8c55462005-03-02 12:03:05 +1100428Note that hashing of names and addresses will not be retrospectively applied
Damien Miller4b42d7f2005-03-01 21:48:35 +1100429to existing known hosts files, but these may be manually hashed using
430.Xr ssh-keygen 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000431.It Cm HostbasedAuthentication
432Specifies whether to try rhosts based authentication with public key
433authentication.
434The argument must be
435.Dq yes
436or
437.Dq no .
438The default is
439.Dq no .
440This option applies to protocol version 2 only and
441is similar to
442.Cm RhostsRSAAuthentication .
443.It Cm HostKeyAlgorithms
444Specifies the protocol version 2 host key algorithms
445that the client wants to use in order of preference.
446The default for this option is:
447.Dq ssh-rsa,ssh-dss .
448.It Cm HostKeyAlias
449Specifies an alias that should be used instead of the
450real host name when looking up or saving the host key
451in the host key database files.
452This option is useful for tunneling ssh connections
453or for multiple servers running on a single host.
454.It Cm HostName
455Specifies the real host name to log into.
456This can be used to specify nicknames or abbreviations for hosts.
457Default is the name given on the command line.
458Numeric IP addresses are also permitted (both on the command line and in
459.Cm HostName
460specifications).
461.It Cm IdentityFile
462Specifies a file from which the user's RSA or DSA authentication identity
Damien Millerfbf486b2003-05-23 18:44:23 +1000463is read.
464The default is
Damien Miller167ea5d2005-05-26 12:04:02 +1000465.Pa ~/.ssh/identity
Ben Lindstrom9f049032002-06-21 00:59:05 +0000466for protocol version 1, and
Damien Miller167ea5d2005-05-26 12:04:02 +1000467.Pa ~/.ssh/id_rsa
Ben Lindstrom9f049032002-06-21 00:59:05 +0000468and
Damien Miller167ea5d2005-05-26 12:04:02 +1000469.Pa ~/.ssh/id_dsa
Ben Lindstrom9f049032002-06-21 00:59:05 +0000470for protocol version 2.
471Additionally, any identities represented by the authentication agent
472will be used for authentication.
473The file name may use the tilde
474syntax to refer to a user's home directory.
475It is possible to have
476multiple identity files specified in configuration files; all these
477identities will be tried in sequence.
Damien Millerbd394c32004-03-08 23:12:36 +1100478.It Cm IdentitiesOnly
479Specifies that
480.Nm ssh
481should only use the authentication identity files configured in the
Damien Miller1a812582004-04-20 20:13:32 +1000482.Nm
Damien Millerbd394c32004-03-08 23:12:36 +1100483files,
484even if the
485.Nm ssh-agent
486offers more identities.
487The argument to this keyword must be
488.Dq yes
489or
490.Dq no .
491This option is intented for situations where
492.Nm ssh-agent
493offers many different identities.
494The default is
495.Dq no .
Darren Tucker636ca902004-11-05 20:22:00 +1100496.It Cm KbdInteractiveDevices
497Specifies the list of methods to use in keyboard-interactive authentication.
498Multiple method names must be comma-separated.
499The default is to use the server specified list.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000500.It Cm LocalForward
501Specifies that a TCP/IP port on the local machine be forwarded over
502the secure channel to the specified host and port from the remote machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000503The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +1100504.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000505.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +1100506.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000507and the second argument must be
508.Ar host : Ns Ar hostport .
Damien Millerf8c55462005-03-02 12:03:05 +1100509IPv6 addresses can be specified by enclosing addresses in square brackets or
Damien Millerf91ee4c2005-03-01 21:24:33 +1100510by using an alternative syntax:
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000511.Oo Ar bind_address Ns / Oc Ns Ar port
512and
513.Ar host Ns / Ns Ar hostport .
Damien Millerf8c55462005-03-02 12:03:05 +1100514Multiple forwardings may be specified, and additional forwardings can be
Damien Millerf91ee4c2005-03-01 21:24:33 +1100515given on the command line.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000516Only the superuser can forward privileged ports.
Damien Millerf91ee4c2005-03-01 21:24:33 +1100517By default, the local port is bound in accordance with the
518.Cm GatewayPorts
519setting.
520However, an explicit
521.Ar bind_address
522may be used to bind the connection to a specific address.
523The
524.Ar bind_address
525of
526.Dq localhost
Damien Millerf8c55462005-03-02 12:03:05 +1100527indicates that the listening port be bound for local use only, while an
528empty address or
529.Sq *
Damien Millerf91ee4c2005-03-01 21:24:33 +1100530indicates that the port should be available from all interfaces.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000531.It Cm LogLevel
532Gives the verbosity level that is used when logging messages from
533.Nm ssh .
534The possible values are:
535QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +1000536The default is INFO.
537DEBUG and DEBUG1 are equivalent.
538DEBUG2 and DEBUG3 each specify higher levels of verbose output.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000539.It Cm MACs
540Specifies the MAC (message authentication code) algorithms
541in order of preference.
542The MAC algorithm is used in protocol version 2
543for data integrity protection.
544Multiple algorithms must be comma-separated.
545The default is
546.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
547.It Cm NoHostAuthenticationForLocalhost
548This option can be used if the home directory is shared across machines.
549In this case localhost will refer to a different machine on each of
550the machines and the user will get many warnings about changed host keys.
551However, this option disables host authentication for localhost.
552The argument to this keyword must be
553.Dq yes
554or
555.Dq no .
556The default is to check the host key for localhost.
557.It Cm NumberOfPasswordPrompts
558Specifies the number of password prompts before giving up.
559The argument to this keyword must be an integer.
560Default is 3.
561.It Cm PasswordAuthentication
562Specifies whether to use password authentication.
563The argument to this keyword must be
564.Dq yes
565or
566.Dq no .
567The default is
568.Dq yes .
569.It Cm Port
570Specifies the port number to connect on the remote host.
571Default is 22.
572.It Cm PreferredAuthentications
573Specifies the order in which the client should try protocol 2
Damien Millerfbf486b2003-05-23 18:44:23 +1000574authentication methods.
Darren Tucker1adc2bd2005-03-14 23:14:20 +1100575This allows a client to prefer one method (e.g.\&
Ben Lindstrom9f049032002-06-21 00:59:05 +0000576.Cm keyboard-interactive )
Darren Tucker1adc2bd2005-03-14 23:14:20 +1100577over another method (e.g.\&
Ben Lindstrom9f049032002-06-21 00:59:05 +0000578.Cm password )
579The default for this option is:
580.Dq hostbased,publickey,keyboard-interactive,password .
581.It Cm Protocol
582Specifies the protocol versions
583.Nm ssh
584should support in order of preference.
585The possible values are
586.Dq 1
587and
588.Dq 2 .
589Multiple versions must be comma-separated.
590The default is
591.Dq 2,1 .
592This means that
593.Nm ssh
594tries version 2 and falls back to version 1
595if version 2 is not available.
596.It Cm ProxyCommand
597Specifies the command to use to connect to the server.
598The command
599string extends to the end of the line, and is executed with
600.Pa /bin/sh .
601In the command string,
602.Ql %h
603will be substituted by the host name to
604connect and
605.Ql %p
606by the port.
607The command can be basically anything,
608and should read from its standard input and write to its standard output.
609It should eventually connect an
610.Xr sshd 8
611server running on some machine, or execute
612.Ic sshd -i
613somewhere.
614Host key management will be done using the
615HostName of the host being connected (defaulting to the name typed by
616the user).
Damien Miller495dca32003-04-01 21:42:14 +1000617Setting the command to
618.Dq none
Damien Miller9f1e33a2003-02-24 11:57:32 +1100619disables this option entirely.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000620Note that
621.Cm CheckHostIP
622is not available for connects with a proxy command.
623.Pp
624.It Cm PubkeyAuthentication
625Specifies whether to try public key authentication.
626The argument to this keyword must be
627.Dq yes
628or
629.Dq no .
630The default is
631.Dq yes .
632This option applies to protocol version 2 only.
633.It Cm RemoteForward
634Specifies that a TCP/IP port on the remote machine be forwarded over
635the secure channel to the specified host and port from the local machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000636The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +1100637.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000638.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +1100639.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +1000640and the second argument must be
641.Ar host : Ns Ar hostport .
642IPv6 addresses can be specified by enclosing addresses in square brackets
643or by using an alternative syntax:
644.Oo Ar bind_address Ns / Oc Ns Ar port
645and
646.Ar host Ns / Ns Ar hostport .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000647Multiple forwardings may be specified, and additional
648forwardings can be given on the command line.
649Only the superuser can forward privileged ports.
Damien Millerf91ee4c2005-03-01 21:24:33 +1100650.Pp
651If the
652.Ar bind_address
653is not specified, the default is to only bind to loopback addresses.
654If the
655.Ar bind_address
656is
657.Ql *
658or an empty string, then the forwarding is requested to listen on all
659interfaces.
660Specifying a remote
661.Ar bind_address
Damien Millerf8c55462005-03-02 12:03:05 +1100662will only succeed if the server's
663.Cm GatewayPorts
Damien Millerf91ee4c2005-03-01 21:24:33 +1100664option is enabled (see
Damien Millerf8c55462005-03-02 12:03:05 +1100665.Xr sshd_config 5 ) .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000666.It Cm RhostsRSAAuthentication
667Specifies whether to try rhosts based authentication with RSA host
668authentication.
669The argument must be
670.Dq yes
671or
672.Dq no .
673The default is
674.Dq no .
675This option applies to protocol version 1 only and requires
676.Nm ssh
677to be setuid root.
678.It Cm RSAAuthentication
679Specifies whether to try RSA authentication.
680The argument to this keyword must be
681.Dq yes
682or
683.Dq no .
684RSA authentication will only be
685attempted if the identity file exists, or an authentication agent is
686running.
687The default is
688.Dq yes .
689Note that this option applies to protocol version 1 only.
Darren Tucker46bc0752004-05-02 22:11:30 +1000690.It Cm SendEnv
691Specifies what variables from the local
692.Xr environ 7
693should be sent to the server.
694Note that environment passing is only supported for protocol 2, the
Darren Tucker1e0c9bf2004-05-02 22:12:48 +1000695server must also support it, and the server must be configured to
696accept these environment variables.
Darren Tucker46bc0752004-05-02 22:11:30 +1000697Refer to
698.Cm AcceptEnv
699in
700.Xr sshd_config 5
701for how to configure the server.
702Variables are specified by name, which may contain the wildcard characters
703.Ql \&*
704and
705.Ql \&? .
Darren Tucker1e0c9bf2004-05-02 22:12:48 +1000706Multiple environment variables may be separated by whitespace or spread
Darren Tucker46bc0752004-05-02 22:11:30 +1000707across multiple
708.Cm SendEnv
709directives.
710The default is not to send any environment variables.
Damien Miller509b0102003-12-17 16:33:10 +1100711.It Cm ServerAliveInterval
712Sets a timeout interval in seconds after which if no data has been received
713from the server,
714.Nm ssh
715will send a message through the encrypted
716channel to request a response from the server.
717The default
718is 0, indicating that these messages will not be sent to the server.
719This option applies to protocol version 2 only.
720.It Cm ServerAliveCountMax
721Sets the number of server alive messages (see above) which may be
722sent without
723.Nm ssh
724receiving any messages back from the server.
725If this threshold is reached while server alive messages are being sent,
726.Nm ssh
727will disconnect from the server, terminating the session.
728It is important to note that the use of server alive messages is very
729different from
730.Cm TCPKeepAlive
731(below).
732The server alive messages are sent through the encrypted channel
733and therefore will not be spoofable.
734The TCP keepalive option enabled by
735.Cm TCPKeepAlive
736is spoofable.
737The server alive mechanism is valuable when the client or
738server depend on knowing when a connection has become inactive.
739.Pp
740The default value is 3.
741If, for example,
742.Cm ServerAliveInterval
743(above) is set to 15, and
744.Cm ServerAliveCountMax
745is left at the default, if the server becomes unresponsive ssh
746will disconnect after approximately 45 seconds.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000747.It Cm SmartcardDevice
Damien Millerfbf486b2003-05-23 18:44:23 +1000748Specifies which smartcard device to use.
749The argument to this keyword is the device
Ben Lindstrom9f049032002-06-21 00:59:05 +0000750.Nm ssh
751should use to communicate with a smartcard used for storing the user's
Damien Millerfbf486b2003-05-23 18:44:23 +1000752private RSA key.
753By default, no device is specified and smartcard support is not activated.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000754.It Cm StrictHostKeyChecking
755If this flag is set to
756.Dq yes ,
757.Nm ssh
758will never automatically add host keys to the
Damien Miller167ea5d2005-05-26 12:04:02 +1000759.Pa ~/.ssh/known_hosts
Ben Lindstrom9f049032002-06-21 00:59:05 +0000760file, and refuses to connect to hosts whose host key has changed.
761This provides maximum protection against trojan horse attacks,
762however, can be annoying when the
763.Pa /etc/ssh/ssh_known_hosts
764file is poorly maintained, or connections to new hosts are
765frequently made.
766This option forces the user to manually
767add all new hosts.
768If this flag is set to
769.Dq no ,
770.Nm ssh
771will automatically add new host keys to the
772user known hosts files.
773If this flag is set to
774.Dq ask ,
775new host keys
776will be added to the user known host files only after the user
777has confirmed that is what they really want to do, and
778.Nm ssh
779will refuse to connect to hosts whose host key has changed.
780The host keys of
781known hosts will be verified automatically in all cases.
782The argument must be
783.Dq yes ,
784.Dq no
785or
786.Dq ask .
787The default is
788.Dq ask .
Damien Miller12c150e2003-12-17 16:31:10 +1100789.It Cm TCPKeepAlive
790Specifies whether the system should send TCP keepalive messages to the
791other side.
792If they are sent, death of the connection or crash of one
793of the machines will be properly noticed.
794However, this means that
795connections will die if the route is down temporarily, and some people
796find it annoying.
797.Pp
798The default is
799.Dq yes
800(to send TCP keepalive messages), and the client will notice
801if the network goes down or the remote host dies.
802This is important in scripts, and many users want it too.
803.Pp
804To disable TCP keepalive messages, the value should be set to
805.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000806.It Cm UsePrivilegedPort
807Specifies whether to use a privileged port for outgoing connections.
808The argument must be
809.Dq yes
810or
811.Dq no .
812The default is
813.Dq no .
Damien Miller9b1dacd2002-09-04 16:47:35 +1000814If set to
815.Dq yes
816.Nm ssh
817must be setuid root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000818Note that this option must be set to
819.Dq yes
Darren Tuckerec960f22003-08-13 20:37:05 +1000820for
Ben Lindstrom9f049032002-06-21 00:59:05 +0000821.Cm RhostsRSAAuthentication
Darren Tuckerec960f22003-08-13 20:37:05 +1000822with older servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000823.It Cm User
824Specifies the user to log in as.
825This can be useful when a different user name is used on different machines.
826This saves the trouble of
827having to remember to give the user name on the command line.
828.It Cm UserKnownHostsFile
829Specifies a file to use for the user
830host key database instead of
Damien Miller167ea5d2005-05-26 12:04:02 +1000831.Pa ~/.ssh/known_hosts .
Damien Miller37876e92003-05-15 10:19:46 +1000832.It Cm VerifyHostKeyDNS
833Specifies whether to verify the remote key using DNS and SSHFP resource
834records.
Damien Miller150b5572003-11-17 21:19:29 +1100835If this option is set to
836.Dq yes ,
Damien Millerfe448472003-11-17 21:19:49 +1100837the client will implicitly trust keys that match a secure fingerprint
Damien Miller150b5572003-11-17 21:19:29 +1100838from DNS.
839Insecure fingerprints will be handled as if this option was set to
840.Dq ask .
841If this option is set to
842.Dq ask ,
843information on fingerprint match will be displayed, but the user will still
844need to confirm new host keys according to the
845.Cm StrictHostKeyChecking
846option.
847The argument must be
848.Dq yes ,
849.Dq no
Damien Millerfe448472003-11-17 21:19:49 +1100850or
851.Dq ask .
Damien Miller37876e92003-05-15 10:19:46 +1000852The default is
853.Dq no .
Damien Millereacbb4f2003-06-02 19:10:41 +1000854Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000855.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +1000856Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000857.Xr xauth 1
858program.
859The default is
860.Pa /usr/X11R6/bin/xauth .
861.El
862.Sh FILES
863.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +1000864.It Pa ~/.ssh/config
Ben Lindstrom9f049032002-06-21 00:59:05 +0000865This is the per-user configuration file.
866The format of this file is described above.
867This file is used by the
868.Nm ssh
869client.
Damien Millerc970cb92004-04-20 20:12:53 +1000870Because of the potential for abuse, this file must have strict permissions:
871read/write for the user, and not accessible by others.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000872.It Pa /etc/ssh/ssh_config
873Systemwide configuration file.
874This file provides defaults for those
875values that are not specified in the user's configuration file, and
876for those users who do not have a configuration file.
877This file must be world-readable.
878.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000879.Sh SEE ALSO
880.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000881.Sh AUTHORS
882OpenSSH is a derivative of the original and free
883ssh 1.2.12 release by Tatu Ylonen.
884Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
885Theo de Raadt and Dug Song
886removed many bugs, re-added newer features and
887created OpenSSH.
888Markus Friedl contributed the support for SSH
889protocol versions 1.5 and 2.0.