blob: 9077acbee71b22384469cb3de30b2d2b436e8c34 [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 Millere1776152005-03-01 21:47:37 +110037.\" $OpenBSD: ssh_config.5,v 1.44 2005/03/01 10:40:27 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
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.
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 Miller0e220db2004-06-15 10:34:08 +1000273.It Cm ControlPath
Damien Miller2234bac2004-06-30 22:38:52 +1000274Specify the path to the control socket used for connection sharing.
Damien Miller0e220db2004-06-15 10:34:08 +1000275See
276.Cm ControlMaster
277above.
Damien Miller2234bac2004-06-30 22:38:52 +1000278.It Cm DynamicForward
279Specifies that a TCP/IP port on the local machine be forwarded
280over the secure channel, and the application
281protocol is then used to determine where to connect to from the
282remote machine.
283The argument must be a port number.
284Currently the SOCKS4 and SOCKS5 protocols are supported, and
285.Nm ssh
286will act as a SOCKS server.
287Multiple forwardings may be specified, and
288additional forwardings can be given on the command line.
289Only the superuser can forward privileged ports.
Darren Tucker674f71d2003-06-28 12:33:12 +1000290.It Cm EnableSSHKeysign
291Setting this option to
292.Dq yes
293in the global client configuration file
294.Pa /etc/ssh/ssh_config
295enables the use of the helper program
296.Xr ssh-keysign 8
297during
298.Cm HostbasedAuthentication .
299The argument must be
300.Dq yes
301or
302.Dq no .
303The default is
304.Dq no .
Darren Tuckerf132c672003-10-15 15:58:18 +1000305This option should be placed in the non-hostspecific section.
Darren Tucker674f71d2003-06-28 12:33:12 +1000306See
307.Xr ssh-keysign 8
308for more information.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000309.It Cm EscapeChar
310Sets the escape character (default:
311.Ql ~ ) .
312The escape character can also
313be set on the command line.
314The argument should be a single character,
315.Ql ^
316followed by a letter, or
317.Dq none
318to disable the escape
319character entirely (making the connection transparent for binary
320data).
321.It Cm ForwardAgent
322Specifies whether the connection to the authentication agent (if any)
323will be forwarded to the remote machine.
324The argument must be
325.Dq yes
326or
327.Dq no .
328The default is
329.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000330.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000331Agent forwarding should be enabled with caution.
332Users with the ability to bypass file permissions on the remote host
333(for the agent's Unix-domain socket)
334can access the local agent through the forwarded connection.
335An attacker cannot obtain key material from the agent,
Damien Milleraf653042002-09-04 16:40:37 +1000336however they can perform operations on the keys that enable them to
337authenticate using the identities loaded into the agent.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000338.It Cm ForwardX11
339Specifies whether X11 connections will be automatically redirected
340over the secure channel and
341.Ev DISPLAY
342set.
343The argument must be
344.Dq yes
345or
346.Dq no .
347The default is
348.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000349.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000350X11 forwarding should be enabled with caution.
351Users with the ability to bypass file permissions on the remote host
Darren Tucker0a118da2003-10-15 15:54:32 +1000352(for the user's X11 authorization database)
Damien Miller495dca32003-04-01 21:42:14 +1000353can access the local X11 display through the forwarded connection.
Darren Tucker0a118da2003-10-15 15:54:32 +1000354An attacker may then be able to perform activities such as keystroke monitoring
355if the
356.Cm ForwardX11Trusted
357option is also enabled.
358.It Cm ForwardX11Trusted
Darren Tuckerdcf6ec42004-05-13 13:03:56 +1000359If this option is set to
Darren Tucker0a118da2003-10-15 15:54:32 +1000360.Dq yes
361then remote X11 clients will have full access to the original X11 display.
Damien Miller1717fd42005-03-01 21:17:31 +1100362.Pp
Darren Tucker0a118da2003-10-15 15:54:32 +1000363If this option is set to
364.Dq no
365then remote X11 clients will be considered untrusted and prevented
366from stealing or tampering with data belonging to trusted X11
367clients.
Damien Miller1717fd42005-03-01 21:17:31 +1100368Furthermore, the
369.Xr xauth 1
370token used for the session will be set to expire after 20 minutes.
371Remote clients will be refused access after this time.
Darren Tucker0a118da2003-10-15 15:54:32 +1000372.Pp
373The default is
374.Dq no .
375.Pp
376See the X11 SECURITY extension specification for full details on
377the restrictions imposed on untrusted clients.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000378.It Cm GatewayPorts
379Specifies whether remote hosts are allowed to connect to local
380forwarded ports.
381By default,
382.Nm ssh
Damien Miller495dca32003-04-01 21:42:14 +1000383binds local port forwardings to the loopback address.
384This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000385.Cm GatewayPorts
386can be used to specify that
387.Nm ssh
388should bind local port forwardings to the wildcard address,
389thus allowing remote hosts to connect to forwarded ports.
390The argument must be
391.Dq yes
392or
393.Dq no .
394The default is
395.Dq no .
396.It Cm GlobalKnownHostsFile
397Specifies a file to use for the global
398host key database instead of
399.Pa /etc/ssh/ssh_known_hosts .
Darren Tucker0efd1552003-08-26 11:49:55 +1000400.It Cm GSSAPIAuthentication
Damien Millerbaafb982003-12-17 16:32:23 +1100401Specifies whether user authentication based on GSSAPI is allowed.
Damien Millerc2b98272003-09-03 12:13:30 +1000402The default is
Darren Tuckera044f472003-10-15 15:52:03 +1000403.Dq no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000404Note that this option applies to protocol version 2 only.
405.It Cm GSSAPIDelegateCredentials
406Forward (delegate) credentials to the server.
407The default is
408.Dq no .
409Note that this option applies to protocol version 2 only.
Damien Millere1776152005-03-01 21:47:37 +1100410.It Cm HashKnownHosts
411Indicates that
412.Nm ssh
413should hash host names and addresses when they are added to
414.Pa $HOME/.ssh/known_hosts .
415These hashed names may be used normally by
416.Nm ssh
417and
418.Nm sshd ,
419but they do not reveal identifying information should the file's contents
420be disclosed.
421The default is
422.Dq no .
423Note that hashing of names and addresses will not be retrospectively applied
424to existing known hosts files.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000425.It Cm HostbasedAuthentication
426Specifies whether to try rhosts based authentication with public key
427authentication.
428The argument must be
429.Dq yes
430or
431.Dq no .
432The default is
433.Dq no .
434This option applies to protocol version 2 only and
435is similar to
436.Cm RhostsRSAAuthentication .
437.It Cm HostKeyAlgorithms
438Specifies the protocol version 2 host key algorithms
439that the client wants to use in order of preference.
440The default for this option is:
441.Dq ssh-rsa,ssh-dss .
442.It Cm HostKeyAlias
443Specifies an alias that should be used instead of the
444real host name when looking up or saving the host key
445in the host key database files.
446This option is useful for tunneling ssh connections
447or for multiple servers running on a single host.
448.It Cm HostName
449Specifies the real host name to log into.
450This can be used to specify nicknames or abbreviations for hosts.
451Default is the name given on the command line.
452Numeric IP addresses are also permitted (both on the command line and in
453.Cm HostName
454specifications).
455.It Cm IdentityFile
456Specifies a file from which the user's RSA or DSA authentication identity
Damien Millerfbf486b2003-05-23 18:44:23 +1000457is read.
458The default is
Ben Lindstrom9f049032002-06-21 00:59:05 +0000459.Pa $HOME/.ssh/identity
460for protocol version 1, and
461.Pa $HOME/.ssh/id_rsa
462and
463.Pa $HOME/.ssh/id_dsa
464for protocol version 2.
465Additionally, any identities represented by the authentication agent
466will be used for authentication.
467The file name may use the tilde
468syntax to refer to a user's home directory.
469It is possible to have
470multiple identity files specified in configuration files; all these
471identities will be tried in sequence.
Damien Millerbd394c32004-03-08 23:12:36 +1100472.It Cm IdentitiesOnly
473Specifies that
474.Nm ssh
475should only use the authentication identity files configured in the
Damien Miller1a812582004-04-20 20:13:32 +1000476.Nm
Damien Millerbd394c32004-03-08 23:12:36 +1100477files,
478even if the
479.Nm ssh-agent
480offers more identities.
481The argument to this keyword must be
482.Dq yes
483or
484.Dq no .
485This option is intented for situations where
486.Nm ssh-agent
487offers many different identities.
488The default is
489.Dq no .
Darren Tucker636ca902004-11-05 20:22:00 +1100490.It Cm KbdInteractiveDevices
491Specifies the list of methods to use in keyboard-interactive authentication.
492Multiple method names must be comma-separated.
493The default is to use the server specified list.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000494.It Cm LocalForward
495Specifies that a TCP/IP port on the local machine be forwarded over
496the secure channel to the specified host and port from the remote machine.
497The first argument must be a port number, and the second must be
Damien Millerf91ee4c2005-03-01 21:24:33 +1100498.Xo
499.Sm off
500.Oo Ar bind_address : Oc
501.Ar host:port
502.Sm on
503.Xc .
504IPv6 addresses can be specified by enclosing addresses in square brackets or
505by using an alternative syntax:
506.Xo
507.Sm off
508.Oo Ar bind_address / Oc
509.Ar host/port
510.Sm on
511.Xc .
512Multiple forwardings may be specified, and additional forwardings can be
513given on the command line.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000514Only the superuser can forward privileged ports.
Damien Millerf91ee4c2005-03-01 21:24:33 +1100515By default, the local port is bound in accordance with the
516.Cm GatewayPorts
517setting.
518However, an explicit
519.Ar bind_address
520may be used to bind the connection to a specific address.
521The
522.Ar bind_address
523of
524.Dq localhost
525indicates that the listening port be bound for local use only, while an
526empty address or
527.Dq *
528indicates that the port should be available from all interfaces.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000529.It Cm LogLevel
530Gives the verbosity level that is used when logging messages from
531.Nm ssh .
532The possible values are:
533QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +1000534The default is INFO.
535DEBUG and DEBUG1 are equivalent.
536DEBUG2 and DEBUG3 each specify higher levels of verbose output.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000537.It Cm MACs
538Specifies the MAC (message authentication code) algorithms
539in order of preference.
540The MAC algorithm is used in protocol version 2
541for data integrity protection.
542Multiple algorithms must be comma-separated.
543The default is
544.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
545.It Cm NoHostAuthenticationForLocalhost
546This option can be used if the home directory is shared across machines.
547In this case localhost will refer to a different machine on each of
548the machines and the user will get many warnings about changed host keys.
549However, this option disables host authentication for localhost.
550The argument to this keyword must be
551.Dq yes
552or
553.Dq no .
554The default is to check the host key for localhost.
555.It Cm NumberOfPasswordPrompts
556Specifies the number of password prompts before giving up.
557The argument to this keyword must be an integer.
558Default is 3.
559.It Cm PasswordAuthentication
560Specifies whether to use password authentication.
561The argument to this keyword must be
562.Dq yes
563or
564.Dq no .
565The default is
566.Dq yes .
567.It Cm Port
568Specifies the port number to connect on the remote host.
569Default is 22.
570.It Cm PreferredAuthentications
571Specifies the order in which the client should try protocol 2
Damien Millerfbf486b2003-05-23 18:44:23 +1000572authentication methods.
573This allows a client to prefer one method (e.g.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000574.Cm keyboard-interactive )
575over another method (e.g.
576.Cm password )
577The default for this option is:
578.Dq hostbased,publickey,keyboard-interactive,password .
579.It Cm Protocol
580Specifies the protocol versions
581.Nm ssh
582should support in order of preference.
583The possible values are
584.Dq 1
585and
586.Dq 2 .
587Multiple versions must be comma-separated.
588The default is
589.Dq 2,1 .
590This means that
591.Nm ssh
592tries version 2 and falls back to version 1
593if version 2 is not available.
594.It Cm ProxyCommand
595Specifies the command to use to connect to the server.
596The command
597string extends to the end of the line, and is executed with
598.Pa /bin/sh .
599In the command string,
600.Ql %h
601will be substituted by the host name to
602connect and
603.Ql %p
604by the port.
605The command can be basically anything,
606and should read from its standard input and write to its standard output.
607It should eventually connect an
608.Xr sshd 8
609server running on some machine, or execute
610.Ic sshd -i
611somewhere.
612Host key management will be done using the
613HostName of the host being connected (defaulting to the name typed by
614the user).
Damien Miller495dca32003-04-01 21:42:14 +1000615Setting the command to
616.Dq none
Damien Miller9f1e33a2003-02-24 11:57:32 +1100617disables this option entirely.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000618Note that
619.Cm CheckHostIP
620is not available for connects with a proxy command.
621.Pp
622.It Cm PubkeyAuthentication
623Specifies whether to try public key authentication.
624The argument to this keyword must be
625.Dq yes
626or
627.Dq no .
628The default is
629.Dq yes .
630This option applies to protocol version 2 only.
631.It Cm RemoteForward
632Specifies that a TCP/IP port on the remote machine be forwarded over
633the secure channel to the specified host and port from the local machine.
634The first argument must be a port number, and the second must be
Damien Millerf91ee4c2005-03-01 21:24:33 +1100635.Xo
636.Sm off
637.Oo Ar bind_address : Oc
638.Ar host:port
639.Sm on
640.Xc .
641IPv6 addresses can be specified by enclosing any addresses in square brackets
642or by using the alternative syntax:
643.Xo
644.Sm off
645.Oo Ar bind_address / Oc
646.Ar host/port
647.Sm on
648.Xc .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000649Multiple forwardings may be specified, and additional
650forwardings can be given on the command line.
651Only the superuser can forward privileged ports.
Damien Millerf91ee4c2005-03-01 21:24:33 +1100652.Pp
653If the
654.Ar bind_address
655is not specified, the default is to only bind to loopback addresses.
656If the
657.Ar bind_address
658is
659.Ql *
660or an empty string, then the forwarding is requested to listen on all
661interfaces.
662Specifying a remote
663.Ar bind_address
664will only succeed if the server's
665.Cm GatewayPorts
666option is enabled (see
667.Xr sshd_config 5 ).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000668.It Cm RhostsRSAAuthentication
669Specifies whether to try rhosts based authentication with RSA host
670authentication.
671The argument must be
672.Dq yes
673or
674.Dq no .
675The default is
676.Dq no .
677This option applies to protocol version 1 only and requires
678.Nm ssh
679to be setuid root.
680.It Cm RSAAuthentication
681Specifies whether to try RSA authentication.
682The argument to this keyword must be
683.Dq yes
684or
685.Dq no .
686RSA authentication will only be
687attempted if the identity file exists, or an authentication agent is
688running.
689The default is
690.Dq yes .
691Note that this option applies to protocol version 1 only.
Darren Tucker46bc0752004-05-02 22:11:30 +1000692.It Cm SendEnv
693Specifies what variables from the local
694.Xr environ 7
695should be sent to the server.
696Note that environment passing is only supported for protocol 2, the
Darren Tucker1e0c9bf2004-05-02 22:12:48 +1000697server must also support it, and the server must be configured to
698accept these environment variables.
Darren Tucker46bc0752004-05-02 22:11:30 +1000699Refer to
700.Cm AcceptEnv
701in
702.Xr sshd_config 5
703for how to configure the server.
704Variables are specified by name, which may contain the wildcard characters
705.Ql \&*
706and
707.Ql \&? .
Darren Tucker1e0c9bf2004-05-02 22:12:48 +1000708Multiple environment variables may be separated by whitespace or spread
Darren Tucker46bc0752004-05-02 22:11:30 +1000709across multiple
710.Cm SendEnv
711directives.
712The default is not to send any environment variables.
Damien Miller509b0102003-12-17 16:33:10 +1100713.It Cm ServerAliveInterval
714Sets a timeout interval in seconds after which if no data has been received
715from the server,
716.Nm ssh
717will send a message through the encrypted
718channel to request a response from the server.
719The default
720is 0, indicating that these messages will not be sent to the server.
721This option applies to protocol version 2 only.
722.It Cm ServerAliveCountMax
723Sets the number of server alive messages (see above) which may be
724sent without
725.Nm ssh
726receiving any messages back from the server.
727If this threshold is reached while server alive messages are being sent,
728.Nm ssh
729will disconnect from the server, terminating the session.
730It is important to note that the use of server alive messages is very
731different from
732.Cm TCPKeepAlive
733(below).
734The server alive messages are sent through the encrypted channel
735and therefore will not be spoofable.
736The TCP keepalive option enabled by
737.Cm TCPKeepAlive
738is spoofable.
739The server alive mechanism is valuable when the client or
740server depend on knowing when a connection has become inactive.
741.Pp
742The default value is 3.
743If, for example,
744.Cm ServerAliveInterval
745(above) is set to 15, and
746.Cm ServerAliveCountMax
747is left at the default, if the server becomes unresponsive ssh
748will disconnect after approximately 45 seconds.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000749.It Cm SmartcardDevice
Damien Millerfbf486b2003-05-23 18:44:23 +1000750Specifies which smartcard device to use.
751The argument to this keyword is the device
Ben Lindstrom9f049032002-06-21 00:59:05 +0000752.Nm ssh
753should use to communicate with a smartcard used for storing the user's
Damien Millerfbf486b2003-05-23 18:44:23 +1000754private RSA key.
755By default, no device is specified and smartcard support is not activated.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000756.It Cm StrictHostKeyChecking
757If this flag is set to
758.Dq yes ,
759.Nm ssh
760will never automatically add host keys to the
761.Pa $HOME/.ssh/known_hosts
762file, and refuses to connect to hosts whose host key has changed.
763This provides maximum protection against trojan horse attacks,
764however, can be annoying when the
765.Pa /etc/ssh/ssh_known_hosts
766file is poorly maintained, or connections to new hosts are
767frequently made.
768This option forces the user to manually
769add all new hosts.
770If this flag is set to
771.Dq no ,
772.Nm ssh
773will automatically add new host keys to the
774user known hosts files.
775If this flag is set to
776.Dq ask ,
777new host keys
778will be added to the user known host files only after the user
779has confirmed that is what they really want to do, and
780.Nm ssh
781will refuse to connect to hosts whose host key has changed.
782The host keys of
783known hosts will be verified automatically in all cases.
784The argument must be
785.Dq yes ,
786.Dq no
787or
788.Dq ask .
789The default is
790.Dq ask .
Damien Miller12c150e2003-12-17 16:31:10 +1100791.It Cm TCPKeepAlive
792Specifies whether the system should send TCP keepalive messages to the
793other side.
794If they are sent, death of the connection or crash of one
795of the machines will be properly noticed.
796However, this means that
797connections will die if the route is down temporarily, and some people
798find it annoying.
799.Pp
800The default is
801.Dq yes
802(to send TCP keepalive messages), and the client will notice
803if the network goes down or the remote host dies.
804This is important in scripts, and many users want it too.
805.Pp
806To disable TCP keepalive messages, the value should be set to
807.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000808.It Cm UsePrivilegedPort
809Specifies whether to use a privileged port for outgoing connections.
810The argument must be
811.Dq yes
812or
813.Dq no .
814The default is
815.Dq no .
Damien Miller9b1dacd2002-09-04 16:47:35 +1000816If set to
817.Dq yes
818.Nm ssh
819must be setuid root.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000820Note that this option must be set to
821.Dq yes
Darren Tuckerec960f22003-08-13 20:37:05 +1000822for
Ben Lindstrom9f049032002-06-21 00:59:05 +0000823.Cm RhostsRSAAuthentication
Darren Tuckerec960f22003-08-13 20:37:05 +1000824with older servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000825.It Cm User
826Specifies the user to log in as.
827This can be useful when a different user name is used on different machines.
828This saves the trouble of
829having to remember to give the user name on the command line.
830.It Cm UserKnownHostsFile
831Specifies a file to use for the user
832host key database instead of
833.Pa $HOME/.ssh/known_hosts .
Damien Miller37876e92003-05-15 10:19:46 +1000834.It Cm VerifyHostKeyDNS
835Specifies whether to verify the remote key using DNS and SSHFP resource
836records.
Damien Miller150b5572003-11-17 21:19:29 +1100837If this option is set to
838.Dq yes ,
Damien Millerfe448472003-11-17 21:19:49 +1100839the client will implicitly trust keys that match a secure fingerprint
Damien Miller150b5572003-11-17 21:19:29 +1100840from DNS.
841Insecure fingerprints will be handled as if this option was set to
842.Dq ask .
843If this option is set to
844.Dq ask ,
845information on fingerprint match will be displayed, but the user will still
846need to confirm new host keys according to the
847.Cm StrictHostKeyChecking
848option.
849The argument must be
850.Dq yes ,
851.Dq no
Damien Millerfe448472003-11-17 21:19:49 +1100852or
853.Dq ask .
Damien Miller37876e92003-05-15 10:19:46 +1000854The default is
855.Dq no .
Damien Millereacbb4f2003-06-02 19:10:41 +1000856Note that this option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000857.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +1000858Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000859.Xr xauth 1
860program.
861The default is
862.Pa /usr/X11R6/bin/xauth .
863.El
864.Sh FILES
865.Bl -tag -width Ds
866.It Pa $HOME/.ssh/config
867This is the per-user configuration file.
868The format of this file is described above.
869This file is used by the
870.Nm ssh
871client.
Damien Millerc970cb92004-04-20 20:12:53 +1000872Because of the potential for abuse, this file must have strict permissions:
873read/write for the user, and not accessible by others.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000874.It Pa /etc/ssh/ssh_config
875Systemwide configuration file.
876This file provides defaults for those
877values that are not specified in the user's configuration file, and
878for those users who do not have a configuration file.
879This file must be world-readable.
880.El
Damien Millerf1ce5052003-06-11 22:04:39 +1000881.Sh SEE ALSO
882.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000883.Sh AUTHORS
884OpenSSH is a derivative of the original and free
885ssh 1.2.12 release by Tatu Ylonen.
886Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
887Theo de Raadt and Dug Song
888removed many bugs, re-added newer features and
889created OpenSSH.
890Markus Friedl contributed the support for SSH
891protocol versions 1.5 and 2.0.