]> andersk Git - openssh.git/blame - ssh_config.5
- djm@cvs.openbsd.org 2005/03/01 10:09:52
[openssh.git] / ssh_config.5
CommitLineData
588df31a 1.\" -*- nroff -*-
2.\"
3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5.\" All rights reserved
6.\"
7.\" As far as I am concerned, the code I have written for this software
8.\" can be used freely for any purpose. Any derived versions of this
9.\" software must be clearly marked as such, and if the derived work is
10.\" incompatible with the protocol description in the RFC file, it must be
11.\" called by a name other than "ssh" or "Secure Shell".
12.\"
13.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
14.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
15.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
16.\"
17.\" Redistribution and use in source and binary forms, with or without
18.\" modification, are permitted provided that the following conditions
19.\" are met:
20.\" 1. Redistributions of source code must retain the above copyright
21.\" notice, this list of conditions and the following disclaimer.
22.\" 2. Redistributions in binary form must reproduce the above copyright
23.\" notice, this list of conditions and the following disclaimer in the
24.\" documentation and/or other materials provided with the distribution.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36.\"
3867aa0a 37.\" $OpenBSD: ssh_config.5,v 1.43 2005/03/01 10:09:52 djm Exp $
588df31a 38.Dd September 25, 1999
39.Dt SSH_CONFIG 5
40.Os
41.Sh NAME
42.Nm ssh_config
43.Nd OpenSSH SSH client configuration files
44.Sh SYNOPSIS
45.Bl -tag -width Ds -compact
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:
4dcbbeea 53.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
588df31a 63.Pp
64For each parameter, the first obtained value
65will be used.
7034edae 66The configuration files contain sections separated by
588df31a 67.Dq Host
68specifications, and that section is only applied for hosts that
69match one of the patterns given in the specification.
70The matched host name is the one given on the command line.
71.Pp
72Since the first obtained value for each parameter is used, more
73host-specific declarations should be given near the beginning of the
74file, and general defaults at the end.
75.Pp
76The configuration file has the following format:
77.Pp
78Empty lines and lines starting with
79.Ql #
80are comments.
81.Pp
82Otherwise a line is of the format
83.Dq keyword arguments .
84Configuration options may be separated by whitespace or
85optional whitespace and exactly one
86.Ql = ;
87the latter format is useful to avoid the need to quote whitespace
88when specifying configuration options using the
89.Nm ssh ,
90.Nm scp
91and
92.Nm sftp
93.Fl o
94option.
95.Pp
96The possible
97keywords and their meanings are as follows (note that
98keywords are case-insensitive and arguments are case-sensitive):
99.Bl -tag -width Ds
100.It Cm Host
101Restricts the following declarations (up to the next
102.Cm Host
103keyword) to be only for those hosts that match one of the patterns
104given after the keyword.
105.Ql \&*
106and
d0445371 107.Ql \&?
588df31a 108can be used as wildcards in the
109patterns.
110A single
111.Ql \&*
112as a pattern can be used to provide global
113defaults for all hosts.
114The host is the
115.Ar hostname
116argument given on the command line (i.e., the name is not converted to
117a canonicalized host name before matching).
f811e52a 118.It Cm AddressFamily
3cbc677d 119Specifies which address family to use when connecting.
120Valid arguments are
f811e52a 121.Dq any ,
122.Dq inet
0d6cbe2c 123(use IPv4 only) or
f811e52a 124.Dq inet6
0d6cbe2c 125(use IPv6 only).
588df31a 126.It Cm BatchMode
127If set to
128.Dq yes ,
129passphrase/password querying will be disabled.
130This option is useful in scripts and other batch jobs where no user
131is present to supply the password.
132The argument must be
133.Dq yes
134or
135.Dq no .
136The default is
137.Dq no .
138.It Cm BindAddress
139Specify the interface to transmit from on machines with multiple
140interfaces or aliased addresses.
141Note that this option does not work if
142.Cm UsePrivilegedPort
143is set to
144.Dq yes .
145.It Cm ChallengeResponseAuthentication
146Specifies whether to use challenge response authentication.
147The argument to this keyword must be
148.Dq yes
149or
150.Dq no .
151The default is
152.Dq yes .
153.It Cm CheckHostIP
154If this flag is set to
155.Dq yes ,
156ssh will additionally check the host IP address in the
157.Pa known_hosts
158file.
159This allows ssh to detect if a host key changed due to DNS spoofing.
160If the option is set to
161.Dq no ,
162the check will not be executed.
163The default is
164.Dq yes .
165.It Cm Cipher
166Specifies the cipher to use for encrypting the session
167in protocol version 1.
168Currently,
169.Dq blowfish ,
170.Dq 3des ,
171and
172.Dq des
173are supported.
174.Ar des
175is only supported in the
176.Nm ssh
177client for interoperability with legacy protocol 1 implementations
178that do not support the
179.Ar 3des
a4e5acef 180cipher.
181Its use is strongly discouraged due to cryptographic weaknesses.
588df31a 182The default is
183.Dq 3des .
184.It Cm Ciphers
185Specifies the ciphers allowed for protocol version 2
186in order of preference.
187Multiple ciphers must be comma-separated.
3b9baa7b 188The supported ciphers are
189.Dq 3des-cbc ,
190.Dq aes128-cbc ,
191.Dq aes192-cbc ,
192.Dq aes256-cbc ,
193.Dq aes128-ctr ,
194.Dq aes192-ctr ,
195.Dq aes256-ctr ,
196.Dq arcfour ,
197.Dq blowfish-cbc ,
198and
199.Dq cast128-cbc .
588df31a 200The default is
588df31a 201.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
a4e5acef 208cleared.
209This option is primarily useful when used from the
588df31a 210.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.
09ab3296 242.It Cm ConnectTimeout
243Specifies the timeout (in seconds) used when connecting to the ssh
3cbc677d 244server, 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.
5e96b616 247.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
9a5cfb58 261(the default).
5e96b616 262These sessions will reuse the master instance's network connection rather
263than initiating new ones.
0d34d6ce 264Setting 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
9a5cfb58 272for details).
5e96b616 273.It Cm ControlPath
9a5cfb58 274Specify the path to the control socket used for connection sharing.
5e96b616 275See
276.Cm ControlMaster
277above.
9a5cfb58 278.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.
f0677b69 290.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 .
246bb171 305This option should be placed in the non-hostspecific section.
f0677b69 306See
307.Xr ssh-keysign 8
308for more information.
588df31a 309.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 .
dbcdea68 330.Pp
a4e5acef 331Agent 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,
dbcdea68 336however they can perform operations on the keys that enable them to
337authenticate using the identities loaded into the agent.
588df31a 338.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 .
dbcdea68 349.Pp
a4e5acef 350X11 forwarding should be enabled with caution.
351Users with the ability to bypass file permissions on the remote host
d73a67d7 352(for the user's X11 authorization database)
a4e5acef 353can access the local X11 display through the forwarded connection.
d73a67d7 354An 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
b2e90ab5 359If this option is set to
d73a67d7 360.Dq yes
361then remote X11 clients will have full access to the original X11 display.
9a6b3b7a 362.Pp
d73a67d7 363If 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.
9a6b3b7a 368Furthermore, 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.
d73a67d7 372.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.
588df31a 378.It Cm GatewayPorts
379Specifies whether remote hosts are allowed to connect to local
380forwarded ports.
381By default,
382.Nm ssh
a4e5acef 383binds local port forwardings to the loopback address.
384This prevents other remote hosts from connecting to forwarded ports.
588df31a 385.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 .
7364bd04 400.It Cm GSSAPIAuthentication
e8dd24a8 401Specifies whether user authentication based on GSSAPI is allowed.
d0445371 402The default is
2ecb78df 403.Dq no .
7364bd04 404Note 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.
588df31a 410.It Cm HostbasedAuthentication
411Specifies whether to try rhosts based authentication with public key
412authentication.
413The argument must be
414.Dq yes
415or
416.Dq no .
417The default is
418.Dq no .
419This option applies to protocol version 2 only and
420is similar to
421.Cm RhostsRSAAuthentication .
422.It Cm HostKeyAlgorithms
423Specifies the protocol version 2 host key algorithms
424that the client wants to use in order of preference.
425The default for this option is:
426.Dq ssh-rsa,ssh-dss .
427.It Cm HostKeyAlias
428Specifies an alias that should be used instead of the
429real host name when looking up or saving the host key
430in the host key database files.
431This option is useful for tunneling ssh connections
432or for multiple servers running on a single host.
433.It Cm HostName
434Specifies the real host name to log into.
435This can be used to specify nicknames or abbreviations for hosts.
436Default is the name given on the command line.
437Numeric IP addresses are also permitted (both on the command line and in
438.Cm HostName
439specifications).
440.It Cm IdentityFile
441Specifies a file from which the user's RSA or DSA authentication identity
3cbc677d 442is read.
443The default is
588df31a 444.Pa $HOME/.ssh/identity
445for protocol version 1, and
446.Pa $HOME/.ssh/id_rsa
447and
448.Pa $HOME/.ssh/id_dsa
449for protocol version 2.
450Additionally, any identities represented by the authentication agent
451will be used for authentication.
452The file name may use the tilde
453syntax to refer to a user's home directory.
454It is possible to have
455multiple identity files specified in configuration files; all these
456identities will be tried in sequence.
3a065ed0 457.It Cm IdentitiesOnly
458Specifies that
459.Nm ssh
460should only use the authentication identity files configured in the
1e9b1b82 461.Nm
3a065ed0 462files,
463even if the
464.Nm ssh-agent
465offers more identities.
466The argument to this keyword must be
467.Dq yes
468or
469.Dq no .
470This option is intented for situations where
471.Nm ssh-agent
472offers many different identities.
473The default is
474.Dq no .
396070f8 475.It Cm KbdInteractiveDevices
476Specifies the list of methods to use in keyboard-interactive authentication.
477Multiple method names must be comma-separated.
478The default is to use the server specified list.
588df31a 479.It Cm LocalForward
480Specifies that a TCP/IP port on the local machine be forwarded over
481the secure channel to the specified host and port from the remote machine.
482The first argument must be a port number, and the second must be
3867aa0a 483.Xo
484.Sm off
485.Oo Ar bind_address : Oc
486.Ar host:port
487.Sm on
488.Xc .
489IPv6 addresses can be specified by enclosing addresses in square brackets or
490by using an alternative syntax:
491.Xo
492.Sm off
493.Oo Ar bind_address / Oc
494.Ar host/port
495.Sm on
496.Xc .
497Multiple forwardings may be specified, and additional forwardings can be
498given on the command line.
588df31a 499Only the superuser can forward privileged ports.
3867aa0a 500By default, the local port is bound in accordance with the
501.Cm GatewayPorts
502setting.
503However, an explicit
504.Ar bind_address
505may be used to bind the connection to a specific address.
506The
507.Ar bind_address
508of
509.Dq localhost
510indicates that the listening port be bound for local use only, while an
511empty address or
512.Dq *
513indicates that the port should be available from all interfaces.
588df31a 514.It Cm LogLevel
515Gives the verbosity level that is used when logging messages from
516.Nm ssh .
517The possible values are:
518QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
a4e5acef 519The default is INFO.
520DEBUG and DEBUG1 are equivalent.
521DEBUG2 and DEBUG3 each specify higher levels of verbose output.
588df31a 522.It Cm MACs
523Specifies the MAC (message authentication code) algorithms
524in order of preference.
525The MAC algorithm is used in protocol version 2
526for data integrity protection.
527Multiple algorithms must be comma-separated.
528The default is
529.Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
530.It Cm NoHostAuthenticationForLocalhost
531This option can be used if the home directory is shared across machines.
532In this case localhost will refer to a different machine on each of
533the machines and the user will get many warnings about changed host keys.
534However, this option disables host authentication for localhost.
535The argument to this keyword must be
536.Dq yes
537or
538.Dq no .
539The default is to check the host key for localhost.
540.It Cm NumberOfPasswordPrompts
541Specifies the number of password prompts before giving up.
542The argument to this keyword must be an integer.
543Default is 3.
544.It Cm PasswordAuthentication
545Specifies whether to use password authentication.
546The argument to this keyword must be
547.Dq yes
548or
549.Dq no .
550The default is
551.Dq yes .
552.It Cm Port
553Specifies the port number to connect on the remote host.
554Default is 22.
555.It Cm PreferredAuthentications
556Specifies the order in which the client should try protocol 2
3cbc677d 557authentication methods.
558This allows a client to prefer one method (e.g.
588df31a 559.Cm keyboard-interactive )
560over another method (e.g.
561.Cm password )
562The default for this option is:
563.Dq hostbased,publickey,keyboard-interactive,password .
564.It Cm Protocol
565Specifies the protocol versions
566.Nm ssh
567should support in order of preference.
568The possible values are
569.Dq 1
570and
571.Dq 2 .
572Multiple versions must be comma-separated.
573The default is
574.Dq 2,1 .
575This means that
576.Nm ssh
577tries version 2 and falls back to version 1
578if version 2 is not available.
579.It Cm ProxyCommand
580Specifies the command to use to connect to the server.
581The command
582string extends to the end of the line, and is executed with
583.Pa /bin/sh .
584In the command string,
585.Ql %h
586will be substituted by the host name to
587connect and
588.Ql %p
589by the port.
590The command can be basically anything,
591and should read from its standard input and write to its standard output.
592It should eventually connect an
593.Xr sshd 8
594server running on some machine, or execute
595.Ic sshd -i
596somewhere.
597Host key management will be done using the
598HostName of the host being connected (defaulting to the name typed by
599the user).
a4e5acef 600Setting the command to
601.Dq none
f78bde70 602disables this option entirely.
588df31a 603Note that
604.Cm CheckHostIP
605is not available for connects with a proxy command.
606.Pp
607.It Cm PubkeyAuthentication
608Specifies whether to try public key authentication.
609The argument to this keyword must be
610.Dq yes
611or
612.Dq no .
613The default is
614.Dq yes .
615This option applies to protocol version 2 only.
616.It Cm RemoteForward
617Specifies that a TCP/IP port on the remote machine be forwarded over
618the secure channel to the specified host and port from the local machine.
619The first argument must be a port number, and the second must be
3867aa0a 620.Xo
621.Sm off
622.Oo Ar bind_address : Oc
623.Ar host:port
624.Sm on
625.Xc .
626IPv6 addresses can be specified by enclosing any addresses in square brackets
627or by using the alternative syntax:
628.Xo
629.Sm off
630.Oo Ar bind_address / Oc
631.Ar host/port
632.Sm on
633.Xc .
588df31a 634Multiple forwardings may be specified, and additional
635forwardings can be given on the command line.
636Only the superuser can forward privileged ports.
3867aa0a 637.Pp
638If the
639.Ar bind_address
640is not specified, the default is to only bind to loopback addresses.
641If the
642.Ar bind_address
643is
644.Ql *
645or an empty string, then the forwarding is requested to listen on all
646interfaces.
647Specifying a remote
648.Ar bind_address
649will only succeed if the server's
650.Cm GatewayPorts
651option is enabled (see
652.Xr sshd_config 5 ).
588df31a 653.It Cm RhostsRSAAuthentication
654Specifies whether to try rhosts based authentication with RSA host
655authentication.
656The argument must be
657.Dq yes
658or
659.Dq no .
660The default is
661.Dq no .
662This option applies to protocol version 1 only and requires
663.Nm ssh
664to be setuid root.
665.It Cm RSAAuthentication
666Specifies whether to try RSA authentication.
667The argument to this keyword must be
668.Dq yes
669or
670.Dq no .
671RSA authentication will only be
672attempted if the identity file exists, or an authentication agent is
673running.
674The default is
675.Dq yes .
676Note that this option applies to protocol version 1 only.
61a2c1da 677.It Cm SendEnv
678Specifies what variables from the local
679.Xr environ 7
680should be sent to the server.
681Note that environment passing is only supported for protocol 2, the
b8b9f2e6 682server must also support it, and the server must be configured to
683accept these environment variables.
61a2c1da 684Refer to
685.Cm AcceptEnv
686in
687.Xr sshd_config 5
688for how to configure the server.
689Variables are specified by name, which may contain the wildcard characters
690.Ql \&*
691and
692.Ql \&? .
b8b9f2e6 693Multiple environment variables may be separated by whitespace or spread
61a2c1da 694across multiple
695.Cm SendEnv
696directives.
697The default is not to send any environment variables.
5d8d32a3 698.It Cm ServerAliveInterval
699Sets a timeout interval in seconds after which if no data has been received
700from the server,
701.Nm ssh
702will send a message through the encrypted
703channel to request a response from the server.
704The default
705is 0, indicating that these messages will not be sent to the server.
706This option applies to protocol version 2 only.
707.It Cm ServerAliveCountMax
708Sets the number of server alive messages (see above) which may be
709sent without
710.Nm ssh
711receiving any messages back from the server.
712If this threshold is reached while server alive messages are being sent,
713.Nm ssh
714will disconnect from the server, terminating the session.
715It is important to note that the use of server alive messages is very
716different from
717.Cm TCPKeepAlive
718(below).
719The server alive messages are sent through the encrypted channel
720and therefore will not be spoofable.
721The TCP keepalive option enabled by
722.Cm TCPKeepAlive
723is spoofable.
724The server alive mechanism is valuable when the client or
725server depend on knowing when a connection has become inactive.
726.Pp
727The default value is 3.
728If, for example,
729.Cm ServerAliveInterval
730(above) is set to 15, and
731.Cm ServerAliveCountMax
732is left at the default, if the server becomes unresponsive ssh
733will disconnect after approximately 45 seconds.
588df31a 734.It Cm SmartcardDevice
3cbc677d 735Specifies which smartcard device to use.
736The argument to this keyword is the device
588df31a 737.Nm ssh
738should use to communicate with a smartcard used for storing the user's
3cbc677d 739private RSA key.
740By default, no device is specified and smartcard support is not activated.
588df31a 741.It Cm StrictHostKeyChecking
742If this flag is set to
743.Dq yes ,
744.Nm ssh
745will never automatically add host keys to the
746.Pa $HOME/.ssh/known_hosts
747file, and refuses to connect to hosts whose host key has changed.
748This provides maximum protection against trojan horse attacks,
749however, can be annoying when the
750.Pa /etc/ssh/ssh_known_hosts
751file is poorly maintained, or connections to new hosts are
752frequently made.
753This option forces the user to manually
754add all new hosts.
755If this flag is set to
756.Dq no ,
757.Nm ssh
758will automatically add new host keys to the
759user known hosts files.
760If this flag is set to
761.Dq ask ,
762new host keys
763will be added to the user known host files only after the user
764has confirmed that is what they really want to do, and
765.Nm ssh
766will refuse to connect to hosts whose host key has changed.
767The host keys of
768known hosts will be verified automatically in all cases.
769The argument must be
770.Dq yes ,
771.Dq no
772or
773.Dq ask .
774The default is
775.Dq ask .
fd573618 776.It Cm TCPKeepAlive
777Specifies whether the system should send TCP keepalive messages to the
778other side.
779If they are sent, death of the connection or crash of one
780of the machines will be properly noticed.
781However, this means that
782connections will die if the route is down temporarily, and some people
783find it annoying.
784.Pp
785The default is
786.Dq yes
787(to send TCP keepalive messages), and the client will notice
788if the network goes down or the remote host dies.
789This is important in scripts, and many users want it too.
790.Pp
791To disable TCP keepalive messages, the value should be set to
792.Dq no .
588df31a 793.It Cm UsePrivilegedPort
794Specifies whether to use a privileged port for outgoing connections.
795The argument must be
796.Dq yes
797or
798.Dq no .
799The default is
800.Dq no .
878b8992 801If set to
802.Dq yes
803.Nm ssh
804must be setuid root.
588df31a 805Note that this option must be set to
806.Dq yes
0598d99d 807for
588df31a 808.Cm RhostsRSAAuthentication
0598d99d 809with older servers.
588df31a 810.It Cm User
811Specifies the user to log in as.
812This can be useful when a different user name is used on different machines.
813This saves the trouble of
814having to remember to give the user name on the command line.
815.It Cm UserKnownHostsFile
816Specifies a file to use for the user
817host key database instead of
818.Pa $HOME/.ssh/known_hosts .
21289cd0 819.It Cm VerifyHostKeyDNS
820Specifies whether to verify the remote key using DNS and SSHFP resource
821records.
0161a13d 822If this option is set to
823.Dq yes ,
dd376e92 824the client will implicitly trust keys that match a secure fingerprint
0161a13d 825from DNS.
826Insecure fingerprints will be handled as if this option was set to
827.Dq ask .
828If this option is set to
829.Dq ask ,
830information on fingerprint match will be displayed, but the user will still
831need to confirm new host keys according to the
832.Cm StrictHostKeyChecking
833option.
834The argument must be
835.Dq yes ,
836.Dq no
dd376e92 837or
838.Dq ask .
21289cd0 839The default is
840.Dq no .
0f92946c 841Note that this option applies to protocol version 2 only.
588df31a 842.It Cm XAuthLocation
57ff5eeb 843Specifies the full pathname of the
588df31a 844.Xr xauth 1
845program.
846The default is
847.Pa /usr/X11R6/bin/xauth .
848.El
849.Sh FILES
850.Bl -tag -width Ds
851.It Pa $HOME/.ssh/config
852This is the per-user configuration file.
853The format of this file is described above.
854This file is used by the
855.Nm ssh
856client.
e1520719 857Because of the potential for abuse, this file must have strict permissions:
858read/write for the user, and not accessible by others.
588df31a 859.It Pa /etc/ssh/ssh_config
860Systemwide configuration file.
861This file provides defaults for those
862values that are not specified in the user's configuration file, and
863for those users who do not have a configuration file.
864This file must be world-readable.
865.El
be193d89 866.Sh SEE ALSO
867.Xr ssh 1
588df31a 868.Sh AUTHORS
869OpenSSH is a derivative of the original and free
870ssh 1.2.12 release by Tatu Ylonen.
871Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
872Theo de Raadt and Dug Song
873removed many bugs, re-added newer features and
874created OpenSSH.
875Markus Friedl contributed the support for SSH
876protocol versions 1.5 and 2.0.
This page took 0.781075 seconds and 5 git commands to generate.