summaryrefslogtreecommitdiff
path: root/ssh_config.0
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2005-01-04 12:58:23 +0000
committerColin Watson <cjwatson@debian.org>2005-01-04 12:58:23 +0000
commitebd2ce335af5861020c79fddb1ae35c03bf036cf (patch)
treeec008b93c62e3241ab611d8c949ebc92905c66b4 /ssh_config.0
parente17cc75fe35f62ba52928b5889b5e7aadb62bedb (diff)
parent16f1d21ea191deaaeeba719d01c0ad82aa044653 (diff)
Import OpenSSH 3.9p1.
Diffstat (limited to 'ssh_config.0')
-rw-r--r--ssh_config.0494
1 files changed, 494 insertions, 0 deletions
diff --git a/ssh_config.0 b/ssh_config.0
new file mode 100644
index 000000000..d1a6ab364
--- /dev/null
+++ b/ssh_config.0
@@ -0,0 +1,494 @@
1SSH_CONFIG(5) OpenBSD Programmer's Manual SSH_CONFIG(5)
2
3NAME
4 ssh_config - OpenSSH SSH client configuration files
5
6SYNOPSIS
7 $HOME/.ssh/config
8 /etc/ssh/ssh_config
9
10DESCRIPTION
11 ssh obtains configuration data from the following sources in the follow-
12 ing order:
13 1. command-line options
14 2. user's configuration file ($HOME/.ssh/config)
15 3. system-wide configuration file (/etc/ssh/ssh_config)
16
17 For each parameter, the first obtained value will be used. The configu-
18 ration files contain sections bracketed by ``Host'' specifications, and
19 that section is only applied for hosts that match one of the patterns
20 given in the specification. The matched host name is the one given on
21 the command line.
22
23 Since the first obtained value for each parameter is used, more host-spe-
24 cific declarations should be given near the beginning of the file, and
25 general defaults at the end.
26
27 The configuration file has the following format:
28
29 Empty lines and lines starting with `#' are comments.
30
31 Otherwise a line is of the format ``keyword arguments''. Configuration
32 options may be separated by whitespace or optional whitespace and exactly
33 one `='; the latter format is useful to avoid the need to quote whites-
34 pace when specifying configuration options using the ssh, scp and sftp -o
35 option.
36
37 The possible keywords and their meanings are as follows (note that key-
38 words are case-insensitive and arguments are case-sensitive):
39
40 Host Restricts the following declarations (up to the next Host key-
41 word) to be only for those hosts that match one of the patterns
42 given after the keyword. `*' and `?' can be used as wildcards in
43 the patterns. A single `*' as a pattern can be used to provide
44 global defaults for all hosts. The host is the hostname argument
45 given on the command line (i.e., the name is not converted to a
46 canonicalized host name before matching).
47
48 AddressFamily
49 Specifies which address family to use when connecting. Valid ar-
50 guments are ``any'', ``inet'' (Use IPv4 only) or ``inet6'' (Use
51 IPv6 only.)
52
53 BatchMode
54 If set to ``yes'', passphrase/password querying will be disabled.
55 This option is useful in scripts and other batch jobs where no
56 user is present to supply the password. The argument must be
57 ``yes'' or ``no''. The default is ``no''.
58
59 BindAddress
60 Specify the interface to transmit from on machines with multiple
61 interfaces or aliased addresses. Note that this option does not
62 work if UsePrivilegedPort is set to ``yes''.
63
64 ChallengeResponseAuthentication
65 Specifies whether to use challenge response authentication. The
66 argument to this keyword must be ``yes'' or ``no''. The default
67 is ``yes''.
68
69 CheckHostIP
70 If this flag is set to ``yes'', ssh will additionally check the
71 host IP address in the known_hosts file. This allows ssh to de-
72 tect if a host key changed due to DNS spoofing. If the option is
73 set to ``no'', the check will not be executed. The default is
74 ``yes''.
75
76 Cipher Specifies the cipher to use for encrypting the session in proto-
77 col version 1. Currently, ``blowfish'', ``3des'', and ``des''
78 are supported. des is only supported in the ssh client for in-
79 teroperability with legacy protocol 1 implementations that do not
80 support the 3des cipher. Its use is strongly discouraged due to
81 cryptographic weaknesses. The default is ``3des''.
82
83 Ciphers
84 Specifies the ciphers allowed for protocol version 2 in order of
85 preference. Multiple ciphers must be comma-separated. The sup-
86 ported ciphers are ``3des-cbc'', ``aes128-cbc'', ``aes192-cbc'',
87 ``aes256-cbc'', ``aes128-ctr'', ``aes192-ctr'', ``aes256-ctr'',
88 ``arcfour'', ``blowfish-cbc'', and ``cast128-cbc''. The default
89 is
90
91 ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour,
92 aes192-cbc,aes256-cbc''
93
94 ClearAllForwardings
95 Specifies that all local, remote and dynamic port forwardings
96 specified in the configuration files or on the command line be
97 cleared. This option is primarily useful when used from the ssh
98 command line to clear port forwardings set in configuration
99 files, and is automatically set by scp(1) and sftp(1). The argu-
100 ment must be ``yes'' or ``no''. The default is ``no''.
101
102 Compression
103 Specifies whether to use compression. The argument must be
104 ``yes'' or ``no''. The default is ``no''.
105
106 CompressionLevel
107 Specifies the compression level to use if compression is enabled.
108 The argument must be an integer from 1 (fast) to 9 (slow, best).
109 The default level is 6, which is good for most applications. The
110 meaning of the values is the same as in gzip(1). Note that this
111 option applies to protocol version 1 only.
112
113 ConnectionAttempts
114 Specifies the number of tries (one per second) to make before ex-
115 iting. The argument must be an integer. This may be useful in
116 scripts if the connection sometimes fails. The default is 1.
117
118 ConnectTimeout
119 Specifies the timeout (in seconds) used when connecting to the
120 ssh server, instead of using the default system TCP timeout.
121 This value is used only when the target is down or really un-
122 reachable, not when it refuses the connection.
123
124 ControlMaster
125 Enables the sharing of multiple sessions over a single network
126 connection. When set to ``yes'' ssh will listen for connections
127 on a control socket specified using the ControlPath argument.
128 Additional sessions can connect to this socket using the same
129 ControlPath with ControlMaster set to ``no'' (the default).
130 These sessions will reuse the master instance's network connec-
131 tion rather than initiating new ones. Setting this to ``ask''
132 will cause ssh to listen for control connections, but require
133 confirmation using the SSH_ASKPASS program before they are ac-
134 cepted (see ssh-add(1) for details).
135
136 ControlPath
137 Specify the path to the control socket used for connection shar-
138 ing. See ControlMaster above.
139
140 DynamicForward
141 Specifies that a TCP/IP port on the local machine be forwarded
142 over the secure channel, and the application protocol is then
143 used to determine where to connect to from the remote machine.
144 The argument must be a port number. Currently the SOCKS4 and
145 SOCKS5 protocols are supported, and ssh will act as a SOCKS serv-
146 er. Multiple forwardings may be specified, and additional for-
147 wardings can be given on the command line. Only the superuser
148 can forward privileged ports.
149
150 EnableSSHKeysign
151 Setting this option to ``yes'' in the global client configuration
152 file /etc/ssh/ssh_config enables the use of the helper program
153 ssh-keysign(8) during HostbasedAuthentication. The argument must
154 be ``yes'' or ``no''. The default is ``no''. This option should
155 be placed in the non-hostspecific section. See ssh-keysign(8)
156 for more information.
157
158 EscapeChar
159 Sets the escape character (default: `~'). The escape character
160 can also be set on the command line. The argument should be a
161 single character, `^' followed by a letter, or ``none'' to dis-
162 able the escape character entirely (making the connection trans-
163 parent for binary data).
164
165 ForwardAgent
166 Specifies whether the connection to the authentication agent (if
167 any) will be forwarded to the remote machine. The argument must
168 be ``yes'' or ``no''. The default is ``no''.
169
170 Agent forwarding should be enabled with caution. Users with the
171 ability to bypass file permissions on the remote host (for the
172 agent's Unix-domain socket) can access the local agent through
173 the forwarded connection. An attacker cannot obtain key material
174 from the agent, however they can perform operations on the keys
175 that enable them to authenticate using the identities loaded into
176 the agent.
177
178 ForwardX11
179 Specifies whether X11 connections will be automatically redirect-
180 ed over the secure channel and DISPLAY set. The argument must be
181 ``yes'' or ``no''. The default is ``no''.
182
183 X11 forwarding should be enabled with caution. Users with the
184 ability to bypass file permissions on the remote host (for the
185 user's X11 authorization database) can access the local X11 dis-
186 play through the forwarded connection. An attacker may then be
187 able to perform activities such as keystroke monitoring if the
188 ForwardX11Trusted option is also enabled.
189
190 ForwardX11Trusted
191 If this option is set to ``yes'' then remote X11 clients will
192 have full access to the original X11 display. If this option is
193 set to ``no'' then remote X11 clients will be considered untrust-
194 ed and prevented from stealing or tampering with data belonging
195 to trusted X11 clients.
196
197 The default is ``no''.
198
199 See the X11 SECURITY extension specification for full details on
200 the restrictions imposed on untrusted clients.
201
202 GatewayPorts
203 Specifies whether remote hosts are allowed to connect to local
204 forwarded ports. By default, ssh binds local port forwardings to
205 the loopback address. This prevents other remote hosts from con-
206 necting to forwarded ports. GatewayPorts can be used to specify
207 that ssh should bind local port forwardings to the wildcard ad-
208 dress, thus allowing remote hosts to connect to forwarded ports.
209 The argument must be ``yes'' or ``no''. The default is ``no''.
210
211 GlobalKnownHostsFile
212 Specifies a file to use for the global host key database instead
213 of /etc/ssh/ssh_known_hosts.
214
215 GSSAPIAuthentication
216 Specifies whether user authentication based on GSSAPI is allowed.
217 The default is ``no''. Note that this option applies to protocol
218 version 2 only.
219
220 GSSAPIDelegateCredentials
221 Forward (delegate) credentials to the server. The default is
222 ``no''. Note that this option applies to protocol version 2 on-
223 ly.
224
225 HostbasedAuthentication
226 Specifies whether to try rhosts based authentication with public
227 key authentication. The argument must be ``yes'' or ``no''. The
228 default is ``no''. This option applies to protocol version 2 on-
229 ly and is similar to RhostsRSAAuthentication.
230
231 HostKeyAlgorithms
232 Specifies the protocol version 2 host key algorithms that the
233 client wants to use in order of preference. The default for this
234 option is: ``ssh-rsa,ssh-dss''.
235
236 HostKeyAlias
237 Specifies an alias that should be used instead of the real host
238 name when looking up or saving the host key in the host key
239 database files. This option is useful for tunneling ssh connec-
240 tions or for multiple servers running on a single host.
241
242 HostName
243 Specifies the real host name to log into. This can be used to
244 specify nicknames or abbreviations for hosts. Default is the
245 name given on the command line. Numeric IP addresses are also
246 permitted (both on the command line and in HostName specifica-
247 tions).
248
249 IdentityFile
250 Specifies a file from which the user's RSA or DSA authentication
251 identity is read. The default is $HOME/.ssh/identity for proto-
252 col version 1, and $HOME/.ssh/id_rsa and $HOME/.ssh/id_dsa for
253 protocol version 2. Additionally, any identities represented by
254 the authentication agent will be used for authentication. The
255 file name may use the tilde syntax to refer to a user's home di-
256 rectory. It is possible to have multiple identity files speci-
257 fied in configuration files; all these identities will be tried
258 in sequence.
259
260 IdentitiesOnly
261 Specifies that ssh should only use the authentication identity
262 files configured in the ssh_config files, even if the ssh-agent
263 offers more identities. The argument to this keyword must be
264 ``yes'' or ``no''. This option is intented for situations where
265 ssh-agent offers many different identities. The default is
266 ``no''.
267
268 LocalForward
269 Specifies that a TCP/IP port on the local machine be forwarded
270 over the secure channel to the specified host and port from the
271 remote machine. The first argument must be a port number, and
272 the second must be host:port. IPv6 addresses can be specified
273 with an alternative syntax: host/port. Multiple forwardings may
274 be specified, and additional forwardings can be given on the com-
275 mand line. Only the superuser can forward privileged ports.
276
277 LogLevel
278 Gives the verbosity level that is used when logging messages from
279 ssh. The possible values are: QUIET, FATAL, ERROR, INFO, VER-
280 BOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3. The default is INFO.
281 DEBUG and DEBUG1 are equivalent. DEBUG2 and DEBUG3 each specify
282 higher levels of verbose output.
283
284 MACs Specifies the MAC (message authentication code) algorithms in or-
285 der of preference. The MAC algorithm is used in protocol version
286 2 for data integrity protection. Multiple algorithms must be
287 comma-separated. The default is ``hmac-md5,hmac-sha1,hmac-
288 ripemd160,hmac-sha1-96,hmac-md5-96''.
289
290 NoHostAuthenticationForLocalhost
291 This option can be used if the home directory is shared across
292 machines. In this case localhost will refer to a different ma-
293 chine on each of the machines and the user will get many warnings
294 about changed host keys. However, this option disables host au-
295 thentication for localhost. The argument to this keyword must be
296 ``yes'' or ``no''. The default is to check the host key for lo-
297 calhost.
298
299 NumberOfPasswordPrompts
300 Specifies the number of password prompts before giving up. The
301 argument to this keyword must be an integer. Default is 3.
302
303 PasswordAuthentication
304 Specifies whether to use password authentication. The argument
305 to this keyword must be ``yes'' or ``no''. The default is
306 ``yes''.
307
308 Port Specifies the port number to connect on the remote host. Default
309 is 22.
310
311 PreferredAuthentications
312 Specifies the order in which the client should try protocol 2 au-
313 thentication methods. This allows a client to prefer one method
314 (e.g. keyboard-interactive) over another method (e.g. password)
315 The default for this option is: ``hostbased,publickey,keyboard-
316 interactive,password''.
317
318 Protocol
319 Specifies the protocol versions ssh should support in order of
320 preference. The possible values are ``1'' and ``2''. Multiple
321 versions must be comma-separated. The default is ``2,1''. This
322 means that ssh tries version 2 and falls back to version 1 if
323 version 2 is not available.
324
325 ProxyCommand
326 Specifies the command to use to connect to the server. The com-
327 mand string extends to the end of the line, and is executed with
328 /bin/sh. In the command string, `%h' will be substituted by the
329 host name to connect and `%p' by the port. The command can be
330 basically anything, and should read from its standard input and
331 write to its standard output. It should eventually connect an
332 sshd(8) server running on some machine, or execute sshd -i some-
333 where. Host key management will be done using the HostName of
334 the host being connected (defaulting to the name typed by the us-
335 er). Setting the command to ``none'' disables this option en-
336 tirely. Note that CheckHostIP is not available for connects with
337 a proxy command.
338
339 PubkeyAuthentication
340 Specifies whether to try public key authentication. The argument
341 to this keyword must be ``yes'' or ``no''. The default is
342 ``yes''. This option applies to protocol version 2 only.
343
344 RemoteForward
345 Specifies that a TCP/IP port on the remote machine be forwarded
346 over the secure channel to the specified host and port from the
347 local machine. The first argument must be a port number, and the
348 second must be host:port. IPv6 addresses can be specified with
349 an alternative syntax: host/port. Multiple forwardings may be
350 specified, and additional forwardings can be given on the command
351 line. Only the superuser can forward privileged ports.
352
353 RhostsRSAAuthentication
354 Specifies whether to try rhosts based authentication with RSA
355 host authentication. The argument must be ``yes'' or ``no''.
356 The default is ``no''. This option applies to protocol version 1
357 only and requires ssh to be setuid root.
358
359 RSAAuthentication
360 Specifies whether to try RSA authentication. The argument to
361 this keyword must be ``yes'' or ``no''. RSA authentication will
362 only be attempted if the identity file exists, or an authentica-
363 tion agent is running. The default is ``yes''. Note that this
364 option applies to protocol version 1 only.
365
366 SendEnv
367 Specifies what variables from the local environ(7) should be sent
368 to the server. Note that environment passing is only supported
369 for protocol 2, the server must also support it, and the server
370 must be configured to accept these environment variables. Refer
371 to AcceptEnv in sshd_config(5) for how to configure the server.
372 Variables are specified by name, which may contain the wildcard
373 characters `*' and `?'. Multiple environment variables may be
374 separated by whitespace or spread across multiple SendEnv direc-
375 tives. The default is not to send any environment variables.
376
377 ServerAliveInterval
378 Sets a timeout interval in seconds after which if no data has
379 been received from the server, ssh will send a message through
380 the encrypted channel to request a response from the server. The
381 default is 0, indicating that these messages will not be sent to
382 the server. This option applies to protocol version 2 only.
383
384 ServerAliveCountMax
385 Sets the number of server alive messages (see above) which may be
386 sent without ssh receiving any messages back from the server. If
387 this threshold is reached while server alive messages are being
388 sent, ssh will disconnect from the server, terminating the ses-
389 sion. It is important to note that the use of server alive mes-
390 sages is very different from TCPKeepAlive (below). The server
391 alive messages are sent through the encrypted channel and there-
392 fore will not be spoofable. The TCP keepalive option enabled by
393 TCPKeepAlive is spoofable. The server alive mechanism is valu-
394 able when the client or server depend on knowing when a connec-
395 tion has become inactive.
396
397 The default value is 3. If, for example, ServerAliveInterval
398 (above) is set to 15, and ServerAliveCountMax is left at the de-
399 fault, if the server becomes unresponsive ssh will disconnect af-
400 ter approximately 45 seconds.
401
402 SmartcardDevice
403 Specifies which smartcard device to use. The argument to this
404 keyword is the device ssh should use to communicate with a smart-
405 card used for storing the user's private RSA key. By default, no
406 device is specified and smartcard support is not activated.
407
408 StrictHostKeyChecking
409 If this flag is set to ``yes'', ssh will never automatically add
410 host keys to the $HOME/.ssh/known_hosts file, and refuses to con-
411 nect to hosts whose host key has changed. This provides maximum
412 protection against trojan horse attacks, however, can be annoying
413 when the /etc/ssh/ssh_known_hosts file is poorly maintained, or
414 connections to new hosts are frequently made. This option forces
415 the user to manually add all new hosts. If this flag is set to
416 ``no'', ssh will automatically add new host keys to the user
417 known hosts files. If this flag is set to ``ask'', new host keys
418 will be added to the user known host files only after the user
419 has confirmed that is what they really want to do, and ssh will
420 refuse to connect to hosts whose host key has changed. The host
421 keys of known hosts will be verified automatically in all cases.
422 The argument must be ``yes'', ``no'' or ``ask''. The default is
423 ``ask''.
424
425 TCPKeepAlive
426 Specifies whether the system should send TCP keepalive messages
427 to the other side. If they are sent, death of the connection or
428 crash of one of the machines will be properly noticed. However,
429 this means that connections will die if the route is down tem-
430 porarily, and some people find it annoying.
431
432 The default is ``yes'' (to send TCP keepalive messages), and the
433 client will notice if the network goes down or the remote host
434 dies. This is important in scripts, and many users want it too.
435
436 To disable TCP keepalive messages, the value should be set to
437 ``no''.
438
439 UsePrivilegedPort
440 Specifies whether to use a privileged port for outgoing connec-
441 tions. The argument must be ``yes'' or ``no''. The default is
442 ``no''. If set to ``yes'' ssh must be setuid root. Note that
443 this option must be set to ``yes'' for RhostsRSAAuthentication
444 with older servers.
445
446 User Specifies the user to log in as. This can be useful when a dif-
447 ferent user name is used on different machines. This saves the
448 trouble of having to remember to give the user name on the com-
449 mand line.
450
451 UserKnownHostsFile
452 Specifies a file to use for the user host key database instead of
453 $HOME/.ssh/known_hosts.
454
455 VerifyHostKeyDNS
456 Specifies whether to verify the remote key using DNS and SSHFP
457 resource records. If this option is set to ``yes'', the client
458 will implicitly trust keys that match a secure fingerprint from
459 DNS. Insecure fingerprints will be handled as if this option was
460 set to ``ask''. If this option is set to ``ask'', information on
461 fingerprint match will be displayed, but the user will still need
462 to confirm new host keys according to the StrictHostKeyChecking
463 option. The argument must be ``yes'', ``no'' or ``ask''. The
464 default is ``no''. Note that this option applies to protocol
465 version 2 only.
466
467 XAuthLocation
468 Specifies the full pathname of the xauth(1) program. The default
469 is /usr/X11R6/bin/xauth.
470
471FILES
472 $HOME/.ssh/config
473 This is the per-user configuration file. The format of this file
474 is described above. This file is used by the ssh client. Be-
475 cause of the potential for abuse, this file must have strict per-
476 missions: read/write for the user, and not accessible by others.
477
478 /etc/ssh/ssh_config
479 Systemwide configuration file. This file provides defaults for
480 those values that are not specified in the user's configuration
481 file, and for those users who do not have a configuration file.
482 This file must be world-readable.
483
484SEE ALSO
485 ssh(1)
486
487AUTHORS
488 OpenSSH is a derivative of the original and free ssh 1.2.12 release by
489 Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo
490 de Raadt and Dug Song removed many bugs, re-added newer features and cre-
491 ated OpenSSH. Markus Friedl contributed the support for SSH protocol
492 versions 1.5 and 2.0.
493
494OpenBSD 3.6 September 25, 1999 8