Annotation of src/usr.bin/ssh/ssh_config.5, Revision 1.41
1.1 stevesk 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: .\"
1.41 ! jmc 37: .\" $OpenBSD: ssh_config.5,v 1.40 2005/01/28 15:05:43 jmc Exp $
1.1 stevesk 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
51: obtains configuration data from the following sources in
52: the following order:
1.2 stevesk 53: .Bl -enum -offset indent -compact
54: .It
55: command-line options
56: .It
57: user's configuration file
58: .Pq Pa $HOME/.ssh/config
59: .It
60: system-wide configuration file
61: .Pq Pa /etc/ssh/ssh_config
62: .El
1.1 stevesk 63: .Pp
64: For each parameter, the first obtained value
65: will be used.
1.41 ! jmc 66: The configuration files contain sections separated by
1.1 stevesk 67: .Dq Host
68: specifications, and that section is only applied for hosts that
69: match one of the patterns given in the specification.
70: The matched host name is the one given on the command line.
71: .Pp
72: Since the first obtained value for each parameter is used, more
73: host-specific declarations should be given near the beginning of the
74: file, and general defaults at the end.
75: .Pp
76: The configuration file has the following format:
77: .Pp
78: Empty lines and lines starting with
79: .Ql #
80: are comments.
81: .Pp
82: Otherwise a line is of the format
83: .Dq keyword arguments .
84: Configuration options may be separated by whitespace or
85: optional whitespace and exactly one
86: .Ql = ;
87: the latter format is useful to avoid the need to quote whitespace
88: when specifying configuration options using the
89: .Nm ssh ,
90: .Nm scp
91: and
92: .Nm sftp
93: .Fl o
94: option.
95: .Pp
96: The possible
97: keywords and their meanings are as follows (note that
98: keywords are case-insensitive and arguments are case-sensitive):
99: .Bl -tag -width Ds
100: .It Cm Host
101: Restricts the following declarations (up to the next
102: .Cm Host
103: keyword) to be only for those hosts that match one of the patterns
104: given after the keyword.
105: .Ql \&*
106: and
1.20 jmc 107: .Ql \&?
1.1 stevesk 108: can be used as wildcards in the
109: patterns.
110: A single
111: .Ql \&*
112: as a pattern can be used to provide global
113: defaults for all hosts.
114: The host is the
115: .Ar hostname
116: argument given on the command line (i.e., the name is not converted to
117: a canonicalized host name before matching).
1.10 djm 118: .It Cm AddressFamily
1.11 jmc 119: Specifies which address family to use when connecting.
120: Valid arguments are
1.10 djm 121: .Dq any ,
122: .Dq inet
1.40 jmc 123: (use IPv4 only) or
1.10 djm 124: .Dq inet6
1.40 jmc 125: (use IPv6 only).
1.1 stevesk 126: .It Cm BatchMode
127: If set to
128: .Dq yes ,
129: passphrase/password querying will be disabled.
130: This option is useful in scripts and other batch jobs where no user
131: is present to supply the password.
132: The argument must be
133: .Dq yes
134: or
135: .Dq no .
136: The default is
137: .Dq no .
138: .It Cm BindAddress
139: Specify the interface to transmit from on machines with multiple
140: interfaces or aliased addresses.
141: Note that this option does not work if
142: .Cm UsePrivilegedPort
143: is set to
144: .Dq yes .
145: .It Cm ChallengeResponseAuthentication
146: Specifies whether to use challenge response authentication.
147: The argument to this keyword must be
148: .Dq yes
149: or
150: .Dq no .
151: The default is
152: .Dq yes .
153: .It Cm CheckHostIP
154: If this flag is set to
155: .Dq yes ,
156: ssh will additionally check the host IP address in the
157: .Pa known_hosts
158: file.
159: This allows ssh to detect if a host key changed due to DNS spoofing.
160: If the option is set to
161: .Dq no ,
162: the check will not be executed.
163: The default is
164: .Dq yes .
165: .It Cm Cipher
166: Specifies the cipher to use for encrypting the session
167: in protocol version 1.
168: Currently,
169: .Dq blowfish ,
170: .Dq 3des ,
171: and
172: .Dq des
173: are supported.
174: .Ar des
175: is only supported in the
176: .Nm ssh
177: client for interoperability with legacy protocol 1 implementations
178: that do not support the
179: .Ar 3des
1.7 jmc 180: cipher.
181: Its use is strongly discouraged due to cryptographic weaknesses.
1.1 stevesk 182: The default is
183: .Dq 3des .
184: .It Cm Ciphers
185: Specifies the ciphers allowed for protocol version 2
186: in order of preference.
187: Multiple ciphers must be comma-separated.
1.35 dtucker 188: The 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 ,
198: and
199: .Dq cast128-cbc .
1.1 stevesk 200: The default is
201: .Bd -literal
202: ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
203: aes192-cbc,aes256-cbc''
204: .Ed
205: .It Cm ClearAllForwardings
206: Specifies that all local, remote and dynamic port forwardings
207: specified in the configuration files or on the command line be
1.7 jmc 208: cleared.
209: This option is primarily useful when used from the
1.1 stevesk 210: .Nm ssh
211: command line to clear port forwardings set in
212: configuration files, and is automatically set by
213: .Xr scp 1
214: and
215: .Xr sftp 1 .
216: The argument must be
217: .Dq yes
218: or
219: .Dq no .
220: The default is
221: .Dq no .
222: .It Cm Compression
223: Specifies whether to use compression.
224: The argument must be
225: .Dq yes
226: or
227: .Dq no .
228: The default is
229: .Dq no .
230: .It Cm CompressionLevel
231: Specifies the compression level to use if compression is enabled.
232: The argument must be an integer from 1 (fast) to 9 (slow, best).
233: The default level is 6, which is good for most applications.
234: The meaning of the values is the same as in
235: .Xr gzip 1 .
236: Note that this option applies to protocol version 1 only.
237: .It Cm ConnectionAttempts
238: Specifies the number of tries (one per second) to make before exiting.
239: The argument must be an integer.
240: This may be useful in scripts if the connection sometimes fails.
241: The default is 1.
1.9 djm 242: .It Cm ConnectTimeout
243: Specifies the timeout (in seconds) used when connecting to the ssh
1.11 jmc 244: server, instead of using the default system TCP timeout.
245: This value is used only when the target is down or really unreachable,
246: not when it refuses the connection.
1.36 djm 247: .It Cm ControlMaster
248: Enables the sharing of multiple sessions over a single network connection.
249: When set to
250: .Dq yes
251: .Nm ssh
252: will listen for connections on a control socket specified using the
253: .Cm ControlPath
254: argument.
255: Additional sessions can connect to this socket using the same
256: .Cm ControlPath
257: with
258: .Cm ControlMaster
259: set to
260: .Dq no
1.38 jmc 261: (the default).
1.36 djm 262: These sessions will reuse the master instance's network connection rather
263: than initiating new ones.
1.37 djm 264: Setting this to
265: .Dq ask
266: will cause
267: .Nm ssh
268: to listen for control connections, but require confirmation using the
269: .Ev SSH_ASKPASS
270: program before they are accepted (see
271: .Xr ssh-add 1
1.38 jmc 272: for details).
1.36 djm 273: .It Cm ControlPath
1.38 jmc 274: Specify the path to the control socket used for connection sharing.
1.36 djm 275: See
276: .Cm ControlMaster
277: above.
1.38 jmc 278: .It Cm DynamicForward
279: Specifies that a TCP/IP port on the local machine be forwarded
280: over the secure channel, and the application
281: protocol is then used to determine where to connect to from the
282: remote machine.
283: The argument must be a port number.
284: Currently the SOCKS4 and SOCKS5 protocols are supported, and
285: .Nm ssh
286: will act as a SOCKS server.
287: Multiple forwardings may be specified, and
288: additional forwardings can be given on the command line.
289: Only the superuser can forward privileged ports.
1.14 markus 290: .It Cm EnableSSHKeysign
291: Setting this option to
292: .Dq yes
293: in the global client configuration file
294: .Pa /etc/ssh/ssh_config
295: enables the use of the helper program
296: .Xr ssh-keysign 8
297: during
298: .Cm HostbasedAuthentication .
299: The argument must be
300: .Dq yes
301: or
302: .Dq no .
303: The default is
304: .Dq no .
1.23 jmc 305: This option should be placed in the non-hostspecific section.
1.14 markus 306: See
307: .Xr ssh-keysign 8
308: for more information.
1.1 stevesk 309: .It Cm EscapeChar
310: Sets the escape character (default:
311: .Ql ~ ) .
312: The escape character can also
313: be set on the command line.
314: The argument should be a single character,
315: .Ql ^
316: followed by a letter, or
317: .Dq none
318: to disable the escape
319: character entirely (making the connection transparent for binary
320: data).
321: .It Cm ForwardAgent
322: Specifies whether the connection to the authentication agent (if any)
323: will be forwarded to the remote machine.
324: The argument must be
325: .Dq yes
326: or
327: .Dq no .
328: The default is
329: .Dq no .
1.3 stevesk 330: .Pp
1.7 jmc 331: Agent forwarding should be enabled with caution.
332: Users with the ability to bypass file permissions on the remote host
333: (for the agent's Unix-domain socket)
334: can access the local agent through the forwarded connection.
335: An attacker cannot obtain key material from the agent,
1.3 stevesk 336: however they can perform operations on the keys that enable them to
337: authenticate using the identities loaded into the agent.
1.1 stevesk 338: .It Cm ForwardX11
339: Specifies whether X11 connections will be automatically redirected
340: over the secure channel and
341: .Ev DISPLAY
342: set.
343: The argument must be
344: .Dq yes
345: or
346: .Dq no .
347: The default is
348: .Dq no .
1.3 stevesk 349: .Pp
1.7 jmc 350: X11 forwarding should be enabled with caution.
351: Users with the ability to bypass file permissions on the remote host
1.22 markus 352: (for the user's X11 authorization database)
1.7 jmc 353: can access the local X11 display through the forwarded connection.
1.22 markus 354: An attacker may then be able to perform activities such as keystroke monitoring
355: if the
356: .Cm ForwardX11Trusted
357: option is also enabled.
358: .It Cm ForwardX11Trusted
1.34 jmc 359: If this option is set to
1.22 markus 360: .Dq yes
361: then remote X11 clients will have full access to the original X11 display.
362: If this option is set to
363: .Dq no
364: then remote X11 clients will be considered untrusted and prevented
365: from stealing or tampering with data belonging to trusted X11
366: clients.
367: .Pp
368: The default is
369: .Dq no .
370: .Pp
371: See the X11 SECURITY extension specification for full details on
372: the restrictions imposed on untrusted clients.
1.1 stevesk 373: .It Cm GatewayPorts
374: Specifies whether remote hosts are allowed to connect to local
375: forwarded ports.
376: By default,
377: .Nm ssh
1.7 jmc 378: binds local port forwardings to the loopback address.
379: This prevents other remote hosts from connecting to forwarded ports.
1.1 stevesk 380: .Cm GatewayPorts
381: can be used to specify that
382: .Nm ssh
383: should bind local port forwardings to the wildcard address,
384: thus allowing remote hosts to connect to forwarded ports.
385: The argument must be
386: .Dq yes
387: or
388: .Dq no .
389: The default is
390: .Dq no .
391: .It Cm GlobalKnownHostsFile
392: Specifies a file to use for the global
393: host key database instead of
394: .Pa /etc/ssh/ssh_known_hosts .
1.18 markus 395: .It Cm GSSAPIAuthentication
1.27 markus 396: Specifies whether user authentication based on GSSAPI is allowed.
1.20 jmc 397: The default is
1.21 markus 398: .Dq no .
1.18 markus 399: Note that this option applies to protocol version 2 only.
400: .It Cm GSSAPIDelegateCredentials
401: Forward (delegate) credentials to the server.
402: The default is
403: .Dq no .
404: Note that this option applies to protocol version 2 only.
1.1 stevesk 405: .It Cm HostbasedAuthentication
406: Specifies whether to try rhosts based authentication with public key
407: authentication.
408: The argument must be
409: .Dq yes
410: or
411: .Dq no .
412: The default is
413: .Dq no .
414: This option applies to protocol version 2 only and
415: is similar to
416: .Cm RhostsRSAAuthentication .
417: .It Cm HostKeyAlgorithms
418: Specifies the protocol version 2 host key algorithms
419: that the client wants to use in order of preference.
420: The default for this option is:
421: .Dq ssh-rsa,ssh-dss .
422: .It Cm HostKeyAlias
423: Specifies an alias that should be used instead of the
424: real host name when looking up or saving the host key
425: in the host key database files.
426: This option is useful for tunneling ssh connections
427: or for multiple servers running on a single host.
428: .It Cm HostName
429: Specifies the real host name to log into.
430: This can be used to specify nicknames or abbreviations for hosts.
431: Default is the name given on the command line.
432: Numeric IP addresses are also permitted (both on the command line and in
433: .Cm HostName
434: specifications).
435: .It Cm IdentityFile
436: Specifies a file from which the user's RSA or DSA authentication identity
1.11 jmc 437: is read.
438: The default is
1.1 stevesk 439: .Pa $HOME/.ssh/identity
440: for protocol version 1, and
441: .Pa $HOME/.ssh/id_rsa
442: and
443: .Pa $HOME/.ssh/id_dsa
444: for protocol version 2.
445: Additionally, any identities represented by the authentication agent
446: will be used for authentication.
447: The file name may use the tilde
448: syntax to refer to a user's home directory.
449: It is possible to have
450: multiple identity files specified in configuration files; all these
451: identities will be tried in sequence.
1.29 markus 452: .It Cm IdentitiesOnly
453: Specifies that
454: .Nm ssh
455: should only use the authentication identity files configured in the
1.31 jmc 456: .Nm
1.29 markus 457: files,
458: even if the
459: .Nm ssh-agent
460: offers more identities.
461: The argument to this keyword must be
462: .Dq yes
463: or
464: .Dq no .
465: This option is intented for situations where
466: .Nm ssh-agent
467: offers many different identities.
468: The default is
469: .Dq no .
1.39 djm 470: .It Cm KbdInteractiveDevices
471: Specifies the list of methods to use in keyboard-interactive authentication.
472: Multiple method names must be comma-separated.
473: The default is to use the server specified list.
1.1 stevesk 474: .It Cm LocalForward
475: Specifies that a TCP/IP port on the local machine be forwarded over
476: the secure channel to the specified host and port from the remote machine.
477: The first argument must be a port number, and the second must be
478: .Ar host:port .
479: IPv6 addresses can be specified with an alternative syntax:
480: .Ar host/port .
481: Multiple forwardings may be specified, and additional
482: forwardings can be given on the command line.
483: Only the superuser can forward privileged ports.
484: .It Cm LogLevel
485: Gives the verbosity level that is used when logging messages from
486: .Nm ssh .
487: The possible values are:
488: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3.
1.7 jmc 489: The default is INFO.
490: DEBUG and DEBUG1 are equivalent.
491: DEBUG2 and DEBUG3 each specify higher levels of verbose output.
1.1 stevesk 492: .It Cm MACs
493: Specifies the MAC (message authentication code) algorithms
494: in order of preference.
495: The MAC algorithm is used in protocol version 2
496: for data integrity protection.
497: Multiple algorithms must be comma-separated.
498: The default is
499: .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 .
500: .It Cm NoHostAuthenticationForLocalhost
501: This option can be used if the home directory is shared across machines.
502: In this case localhost will refer to a different machine on each of
503: the machines and the user will get many warnings about changed host keys.
504: However, this option disables host authentication for localhost.
505: The argument to this keyword must be
506: .Dq yes
507: or
508: .Dq no .
509: The default is to check the host key for localhost.
510: .It Cm NumberOfPasswordPrompts
511: Specifies the number of password prompts before giving up.
512: The argument to this keyword must be an integer.
513: Default is 3.
514: .It Cm PasswordAuthentication
515: Specifies whether to use password authentication.
516: The argument to this keyword must be
517: .Dq yes
518: or
519: .Dq no .
520: The default is
521: .Dq yes .
522: .It Cm Port
523: Specifies the port number to connect on the remote host.
524: Default is 22.
525: .It Cm PreferredAuthentications
526: Specifies the order in which the client should try protocol 2
1.11 jmc 527: authentication methods.
528: This allows a client to prefer one method (e.g.
1.1 stevesk 529: .Cm keyboard-interactive )
530: over another method (e.g.
531: .Cm password )
532: The default for this option is:
533: .Dq hostbased,publickey,keyboard-interactive,password .
534: .It Cm Protocol
535: Specifies the protocol versions
536: .Nm ssh
537: should support in order of preference.
538: The possible values are
539: .Dq 1
540: and
541: .Dq 2 .
542: Multiple versions must be comma-separated.
543: The default is
544: .Dq 2,1 .
545: This means that
546: .Nm ssh
547: tries version 2 and falls back to version 1
548: if version 2 is not available.
549: .It Cm ProxyCommand
550: Specifies the command to use to connect to the server.
551: The command
552: string extends to the end of the line, and is executed with
553: .Pa /bin/sh .
554: In the command string,
555: .Ql %h
556: will be substituted by the host name to
557: connect and
558: .Ql %p
559: by the port.
560: The command can be basically anything,
561: and should read from its standard input and write to its standard output.
562: It should eventually connect an
563: .Xr sshd 8
564: server running on some machine, or execute
565: .Ic sshd -i
566: somewhere.
567: Host key management will be done using the
568: HostName of the host being connected (defaulting to the name typed by
569: the user).
1.7 jmc 570: Setting the command to
571: .Dq none
1.6 markus 572: disables this option entirely.
1.1 stevesk 573: Note that
574: .Cm CheckHostIP
575: is not available for connects with a proxy command.
576: .Pp
577: .It Cm PubkeyAuthentication
578: Specifies whether to try public key authentication.
579: The argument to this keyword must be
580: .Dq yes
581: or
582: .Dq no .
583: The default is
584: .Dq yes .
585: This option applies to protocol version 2 only.
586: .It Cm RemoteForward
587: Specifies that a TCP/IP port on the remote machine be forwarded over
588: the secure channel to the specified host and port from the local machine.
589: The first argument must be a port number, and the second must be
590: .Ar host:port .
591: IPv6 addresses can be specified with an alternative syntax:
592: .Ar host/port .
593: Multiple forwardings may be specified, and additional
594: forwardings can be given on the command line.
595: Only the superuser can forward privileged ports.
596: .It Cm RhostsRSAAuthentication
597: Specifies whether to try rhosts based authentication with RSA host
598: authentication.
599: The argument must be
600: .Dq yes
601: or
602: .Dq no .
603: The default is
604: .Dq no .
605: This option applies to protocol version 1 only and requires
606: .Nm ssh
607: to be setuid root.
608: .It Cm RSAAuthentication
609: Specifies whether to try RSA authentication.
610: The argument to this keyword must be
611: .Dq yes
612: or
613: .Dq no .
614: RSA authentication will only be
615: attempted if the identity file exists, or an authentication agent is
616: running.
617: The default is
618: .Dq yes .
619: Note that this option applies to protocol version 1 only.
1.32 djm 620: .It Cm SendEnv
621: Specifies what variables from the local
622: .Xr environ 7
623: should be sent to the server.
624: Note that environment passing is only supported for protocol 2, the
1.33 djm 625: server must also support it, and the server must be configured to
626: accept these environment variables.
1.32 djm 627: Refer to
628: .Cm AcceptEnv
629: in
630: .Xr sshd_config 5
631: for how to configure the server.
632: Variables are specified by name, which may contain the wildcard characters
633: .Ql \&*
634: and
635: .Ql \&? .
1.33 djm 636: Multiple environment variables may be separated by whitespace or spread
1.32 djm 637: across multiple
638: .Cm SendEnv
639: directives.
640: The default is not to send any environment variables.
1.28 markus 641: .It Cm ServerAliveInterval
642: Sets a timeout interval in seconds after which if no data has been received
643: from the server,
644: .Nm ssh
645: will send a message through the encrypted
646: channel to request a response from the server.
647: The default
648: is 0, indicating that these messages will not be sent to the server.
649: This option applies to protocol version 2 only.
650: .It Cm ServerAliveCountMax
651: Sets the number of server alive messages (see above) which may be
652: sent without
653: .Nm ssh
654: receiving any messages back from the server.
655: If this threshold is reached while server alive messages are being sent,
656: .Nm ssh
657: will disconnect from the server, terminating the session.
658: It is important to note that the use of server alive messages is very
659: different from
660: .Cm TCPKeepAlive
661: (below).
662: The server alive messages are sent through the encrypted channel
663: and therefore will not be spoofable.
664: The TCP keepalive option enabled by
665: .Cm TCPKeepAlive
666: is spoofable.
667: The server alive mechanism is valuable when the client or
668: server depend on knowing when a connection has become inactive.
669: .Pp
670: The default value is 3.
671: If, for example,
672: .Cm ServerAliveInterval
673: (above) is set to 15, and
674: .Cm ServerAliveCountMax
675: is left at the default, if the server becomes unresponsive ssh
676: will disconnect after approximately 45 seconds.
1.1 stevesk 677: .It Cm SmartcardDevice
1.11 jmc 678: Specifies which smartcard device to use.
679: The argument to this keyword is the device
1.1 stevesk 680: .Nm ssh
681: should use to communicate with a smartcard used for storing the user's
1.11 jmc 682: private RSA key.
683: By default, no device is specified and smartcard support is not activated.
1.1 stevesk 684: .It Cm StrictHostKeyChecking
685: If this flag is set to
686: .Dq yes ,
687: .Nm ssh
688: will never automatically add host keys to the
689: .Pa $HOME/.ssh/known_hosts
690: file, and refuses to connect to hosts whose host key has changed.
691: This provides maximum protection against trojan horse attacks,
692: however, can be annoying when the
693: .Pa /etc/ssh/ssh_known_hosts
694: file is poorly maintained, or connections to new hosts are
695: frequently made.
696: This option forces the user to manually
697: add all new hosts.
698: If this flag is set to
699: .Dq no ,
700: .Nm ssh
701: will automatically add new host keys to the
702: user known hosts files.
703: If this flag is set to
704: .Dq ask ,
705: new host keys
706: will be added to the user known host files only after the user
707: has confirmed that is what they really want to do, and
708: .Nm ssh
709: will refuse to connect to hosts whose host key has changed.
710: The host keys of
711: known hosts will be verified automatically in all cases.
712: The argument must be
713: .Dq yes ,
714: .Dq no
715: or
716: .Dq ask .
717: The default is
718: .Dq ask .
1.26 markus 719: .It Cm TCPKeepAlive
720: Specifies whether the system should send TCP keepalive messages to the
721: other side.
722: If they are sent, death of the connection or crash of one
723: of the machines will be properly noticed.
724: However, this means that
725: connections will die if the route is down temporarily, and some people
726: find it annoying.
727: .Pp
728: The default is
729: .Dq yes
730: (to send TCP keepalive messages), and the client will notice
731: if the network goes down or the remote host dies.
732: This is important in scripts, and many users want it too.
733: .Pp
734: To disable TCP keepalive messages, the value should be set to
735: .Dq no .
1.1 stevesk 736: .It Cm UsePrivilegedPort
737: Specifies whether to use a privileged port for outgoing connections.
738: The argument must be
739: .Dq yes
740: or
741: .Dq no .
742: The default is
743: .Dq no .
1.4 stevesk 744: If set to
745: .Dq yes
746: .Nm ssh
747: must be setuid root.
1.1 stevesk 748: Note that this option must be set to
749: .Dq yes
1.17 markus 750: for
1.1 stevesk 751: .Cm RhostsRSAAuthentication
1.17 markus 752: with older servers.
1.1 stevesk 753: .It Cm User
754: Specifies the user to log in as.
755: This can be useful when a different user name is used on different machines.
756: This saves the trouble of
757: having to remember to give the user name on the command line.
758: .It Cm UserKnownHostsFile
759: Specifies a file to use for the user
760: host key database instead of
761: .Pa $HOME/.ssh/known_hosts .
1.8 jakob 762: .It Cm VerifyHostKeyDNS
763: Specifies whether to verify the remote key using DNS and SSHFP resource
764: records.
1.24 jakob 765: If this option is set to
766: .Dq yes ,
1.25 jmc 767: the client will implicitly trust keys that match a secure fingerprint
1.24 jakob 768: from DNS.
769: Insecure fingerprints will be handled as if this option was set to
770: .Dq ask .
771: If this option is set to
772: .Dq ask ,
773: information on fingerprint match will be displayed, but the user will still
774: need to confirm new host keys according to the
775: .Cm StrictHostKeyChecking
776: option.
777: The argument must be
778: .Dq yes ,
779: .Dq no
1.25 jmc 780: or
781: .Dq ask .
1.8 jakob 782: The default is
783: .Dq no .
1.12 jakob 784: Note that this option applies to protocol version 2 only.
1.1 stevesk 785: .It Cm XAuthLocation
1.5 stevesk 786: Specifies the full pathname of the
1.1 stevesk 787: .Xr xauth 1
788: program.
789: The default is
790: .Pa /usr/X11R6/bin/xauth .
791: .El
792: .Sh FILES
793: .Bl -tag -width Ds
794: .It Pa $HOME/.ssh/config
795: This is the per-user configuration file.
796: The format of this file is described above.
797: This file is used by the
798: .Nm ssh
799: client.
1.30 djm 800: Because of the potential for abuse, this file must have strict permissions:
801: read/write for the user, and not accessible by others.
1.1 stevesk 802: .It Pa /etc/ssh/ssh_config
803: Systemwide configuration file.
804: This file provides defaults for those
805: values that are not specified in the user's configuration file, and
806: for those users who do not have a configuration file.
807: This file must be world-readable.
808: .El
1.13 jmc 809: .Sh SEE ALSO
810: .Xr ssh 1
1.1 stevesk 811: .Sh AUTHORS
812: OpenSSH is a derivative of the original and free
813: ssh 1.2.12 release by Tatu Ylonen.
814: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
815: Theo de Raadt and Dug Song
816: removed many bugs, re-added newer features and
817: created OpenSSH.
818: Markus Friedl contributed the support for SSH
819: protocol versions 1.5 and 2.0.
![[BACK]](/icons/back.gif){kind=icon}
Return to ssh_config.5 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh