]>
Commit | Line | Data |
---|---|---|
884dc78b | 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 | .\" | |
08822d99 | 37 | .\" $OpenBSD: ssh_config.5,v 1.76 2006/01/20 11:21:45 jmc Exp $ |
884dc78b | 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 | |
2ce0bfe4 | 46 | .It Pa ~/.ssh/config |
884dc78b | 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: | |
d03f4262 | 53 | .Bl -enum -offset indent -compact |
54 | .It | |
55 | command-line options | |
56 | .It | |
44a053a3 | 57 | user's configuration file |
2ce0bfe4 | 58 | .Pq Pa ~/.ssh/config |
d03f4262 | 59 | .It |
d6862c36 | 60 | GSSAPI configuration file |
d03f4262 | 61 | .Pq Pa $HOME/.ssh/config.gssapi |
62 | .It | |
d6862c36 | 63 | Kerberos configuration file |
d03f4262 | 64 | .Pq Pa $HOME/.ssh/config.krb |
65 | .It | |
d03f4262 | 66 | system-wide configuration file |
67 | .Pq Pa /etc/ssh/ssh_config | |
44a053a3 | 68 | .El |
884dc78b | 69 | .Pp |
70 | For each parameter, the first obtained value | |
71 | will be used. | |
dfddba3d | 72 | The configuration files contain sections separated by |
884dc78b | 73 | .Dq Host |
74 | specifications, and that section is only applied for hosts that | |
75 | match one of the patterns given in the specification. | |
76 | The matched host name is the one given on the command line. | |
77 | .Pp | |
78 | Since the first obtained value for each parameter is used, more | |
79 | host-specific declarations should be given near the beginning of the | |
80 | file, and general defaults at the end. | |
81 | .Pp | |
82 | The configuration file has the following format: | |
83 | .Pp | |
84 | Empty lines and lines starting with | |
85 | .Ql # | |
86 | are comments. | |
87 | .Pp | |
88 | Otherwise a line is of the format | |
89 | .Dq keyword arguments . | |
90 | Configuration options may be separated by whitespace or | |
91 | optional whitespace and exactly one | |
92 | .Ql = ; | |
93 | the latter format is useful to avoid the need to quote whitespace | |
94 | when specifying configuration options using the | |
95 | .Nm ssh , | |
96 | .Nm scp | |
97 | and | |
98 | .Nm sftp | |
99 | .Fl o | |
100 | option. | |
101 | .Pp | |
102 | The possible | |
103 | keywords and their meanings are as follows (note that | |
104 | keywords are case-insensitive and arguments are case-sensitive): | |
105 | .Bl -tag -width Ds | |
106 | .It Cm Host | |
107 | Restricts the following declarations (up to the next | |
108 | .Cm Host | |
109 | keyword) to be only for those hosts that match one of the patterns | |
110 | given after the keyword. | |
111 | .Ql \&* | |
112 | and | |
7cac2b65 | 113 | .Ql \&? |
884dc78b | 114 | can be used as wildcards in the |
115 | patterns. | |
116 | A single | |
117 | .Ql \&* | |
118 | as a pattern can be used to provide global | |
119 | defaults for all hosts. | |
120 | The host is the | |
121 | .Ar hostname | |
122 | argument given on the command line (i.e., the name is not converted to | |
123 | a canonicalized host name before matching). | |
7cac2b65 | 124 | .It Cm AddressFamily |
125 | Specifies which address family to use when connecting. | |
126 | Valid arguments are | |
127 | .Dq any , | |
128 | .Dq inet | |
dfddba3d | 129 | (use IPv4 only) or |
7cac2b65 | 130 | .Dq inet6 |
dfddba3d | 131 | (use IPv6 only). |
884dc78b | 132 | .It Cm BatchMode |
133 | If set to | |
134 | .Dq yes , | |
135 | passphrase/password querying will be disabled. | |
136 | This option is useful in scripts and other batch jobs where no user | |
137 | is present to supply the password. | |
138 | The argument must be | |
139 | .Dq yes | |
140 | or | |
141 | .Dq no . | |
142 | The default is | |
143 | .Dq no . | |
144 | .It Cm BindAddress | |
2ce0bfe4 | 145 | Use the specified address on the local machine as the source address of |
146 | the connection. | |
147 | Only useful on systems with more than one address. | |
884dc78b | 148 | Note that this option does not work if |
149 | .Cm UsePrivilegedPort | |
150 | is set to | |
151 | .Dq yes . | |
152 | .It Cm ChallengeResponseAuthentication | |
153 | Specifies whether to use challenge response authentication. | |
154 | The argument to this keyword must be | |
155 | .Dq yes | |
156 | or | |
157 | .Dq no . | |
158 | The default is | |
159 | .Dq yes . | |
160 | .It Cm CheckHostIP | |
161 | If this flag is set to | |
162 | .Dq yes , | |
163 | ssh will additionally check the host IP address in the | |
164 | .Pa known_hosts | |
165 | file. | |
166 | This allows ssh to detect if a host key changed due to DNS spoofing. | |
167 | If the option is set to | |
168 | .Dq no , | |
169 | the check will not be executed. | |
170 | The default is | |
171 | .Dq yes . | |
172 | .It Cm Cipher | |
173 | Specifies the cipher to use for encrypting the session | |
174 | in protocol version 1. | |
175 | Currently, | |
176 | .Dq blowfish , | |
177 | .Dq 3des , | |
178 | and | |
179 | .Dq des | |
180 | are supported. | |
181 | .Ar des | |
182 | is only supported in the | |
183 | .Nm ssh | |
184 | client for interoperability with legacy protocol 1 implementations | |
185 | that do not support the | |
186 | .Ar 3des | |
bfe49944 | 187 | cipher. |
188 | Its use is strongly discouraged due to cryptographic weaknesses. | |
884dc78b | 189 | The default is |
190 | .Dq 3des . | |
191 | .It Cm Ciphers | |
192 | Specifies the ciphers allowed for protocol version 2 | |
193 | in order of preference. | |
194 | Multiple ciphers must be comma-separated. | |
7e82606e | 195 | The supported ciphers are |
196 | .Dq 3des-cbc , | |
197 | .Dq aes128-cbc , | |
198 | .Dq aes192-cbc , | |
199 | .Dq aes256-cbc , | |
200 | .Dq aes128-ctr , | |
201 | .Dq aes192-ctr , | |
202 | .Dq aes256-ctr , | |
2ce0bfe4 | 203 | .Dq arcfour128 , |
204 | .Dq arcfour256 , | |
7e82606e | 205 | .Dq arcfour , |
206 | .Dq blowfish-cbc , | |
207 | and | |
208 | .Dq cast128-cbc . | |
884dc78b | 209 | The default is |
884dc78b | 210 | .Bd -literal |
2ce0bfe4 | 211 | ``aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,arcfour128, |
212 | arcfour256,arcfour,aes192-cbc,aes256-cbc,aes128-ctr, | |
213 | aes192-ctr,aes256-ctr'' | |
884dc78b | 214 | .Ed |
215 | .It Cm ClearAllForwardings | |
216 | Specifies that all local, remote and dynamic port forwardings | |
217 | specified in the configuration files or on the command line be | |
bfe49944 | 218 | cleared. |
219 | This option is primarily useful when used from the | |
884dc78b | 220 | .Nm ssh |
221 | command line to clear port forwardings set in | |
222 | configuration files, and is automatically set by | |
223 | .Xr scp 1 | |
224 | and | |
225 | .Xr sftp 1 . | |
226 | The argument must be | |
227 | .Dq yes | |
228 | or | |
229 | .Dq no . | |
230 | The default is | |
231 | .Dq no . | |
232 | .It Cm Compression | |
233 | Specifies whether to use compression. | |
234 | The argument must be | |
235 | .Dq yes | |
236 | or | |
237 | .Dq no . | |
238 | The default is | |
239 | .Dq no . | |
240 | .It Cm CompressionLevel | |
241 | Specifies the compression level to use if compression is enabled. | |
242 | The argument must be an integer from 1 (fast) to 9 (slow, best). | |
243 | The default level is 6, which is good for most applications. | |
244 | The meaning of the values is the same as in | |
245 | .Xr gzip 1 . | |
246 | Note that this option applies to protocol version 1 only. | |
247 | .It Cm ConnectionAttempts | |
248 | Specifies the number of tries (one per second) to make before exiting. | |
249 | The argument must be an integer. | |
250 | This may be useful in scripts if the connection sometimes fails. | |
251 | The default is 1. | |
7cac2b65 | 252 | .It Cm ConnectTimeout |
253 | Specifies the timeout (in seconds) used when connecting to the ssh | |
254 | server, instead of using the default system TCP timeout. | |
255 | This value is used only when the target is down or really unreachable, | |
256 | not when it refuses the connection. | |
7e82606e | 257 | .It Cm ControlMaster |
258 | Enables the sharing of multiple sessions over a single network connection. | |
259 | When set to | |
260 | .Dq yes | |
261 | .Nm ssh | |
262 | will listen for connections on a control socket specified using the | |
263 | .Cm ControlPath | |
264 | argument. | |
265 | Additional sessions can connect to this socket using the same | |
266 | .Cm ControlPath | |
267 | with | |
268 | .Cm ControlMaster | |
269 | set to | |
270 | .Dq no | |
271 | (the default). | |
08822d99 | 272 | These sessions will try to reuse the master instance's network connection |
273 | rather than initiating new ones, but will fall back to connecting normally | |
274 | if the control socket does not exist, or is not listening. | |
275 | .Pp | |
7e82606e | 276 | Setting this to |
277 | .Dq ask | |
278 | will cause | |
279 | .Nm ssh | |
280 | to listen for control connections, but require confirmation using the | |
281 | .Ev SSH_ASKPASS | |
282 | program before they are accepted (see | |
283 | .Xr ssh-add 1 | |
284 | for details). | |
2ce0bfe4 | 285 | If the |
286 | .Cm ControlPath | |
287 | can not be opened, | |
288 | .Nm ssh | |
289 | will continue without connecting to a master instance. | |
290 | .Pp | |
291 | X11 and | |
292 | .Xr ssh-agent 1 | |
293 | forwarding is supported over these multiplexed connections, however the | |
08822d99 | 294 | display and agent forwarded will be the one belonging to the master |
2ce0bfe4 | 295 | connection i.e. it is not possible to forward multiple displays or agents. |
296 | .Pp | |
297 | Two additional options allow for opportunistic multiplexing: try to use a | |
298 | master connection but fall back to creating a new one if one does not already | |
299 | exist. | |
300 | These options are: | |
301 | .Dq auto | |
302 | and | |
303 | .Dq autoask . | |
304 | The latter requires confirmation like the | |
305 | .Dq ask | |
306 | option. | |
7e82606e | 307 | .It Cm ControlPath |
2ce0bfe4 | 308 | Specify the path to the control socket used for connection sharing as described |
309 | in the | |
7e82606e | 310 | .Cm ControlMaster |
2ce0bfe4 | 311 | section above or the string |
312 | .Dq none | |
313 | to disable connection sharing. | |
314 | In the path, | |
315 | .Ql %h | |
316 | will be substituted by the target host name, | |
317 | .Ql %p | |
318 | the port and | |
319 | .Ql %r | |
320 | by the remote login username. | |
321 | It is recommended that any | |
322 | .Cm ControlPath | |
323 | used for opportunistic connection sharing include | |
324 | all three of these escape sequences. | |
325 | This ensures that shared connections are uniquely identified. | |
884dc78b | 326 | .It Cm DynamicForward |
08822d99 | 327 | Specifies that a TCP port on the local machine be forwarded |
884dc78b | 328 | over the secure channel, and the application |
329 | protocol is then used to determine where to connect to from the | |
bfe49944 | 330 | remote machine. |
08822d99 | 331 | .Pp |
332 | The argument must be | |
333 | .Sm off | |
334 | .Oo Ar bind_address : Oc Ar port . | |
335 | .Sm on | |
336 | IPv6 addresses can be specified by enclosing addresses in square brackets or | |
337 | by using an alternative syntax: | |
338 | .Oo Ar bind_address Ns / Oc Ns Ar port . | |
339 | By default, the local port is bound in accordance with the | |
340 | .Cm GatewayPorts | |
341 | setting. | |
342 | However, an explicit | |
343 | .Ar bind_address | |
344 | may be used to bind the connection to a specific address. | |
345 | The | |
346 | .Ar bind_address | |
347 | of | |
348 | .Dq localhost | |
349 | indicates that the listening port be bound for local use only, while an | |
350 | empty address or | |
351 | .Sq * | |
352 | indicates that the port should be available from all interfaces. | |
353 | .Pp | |
7cac2b65 | 354 | Currently the SOCKS4 and SOCKS5 protocols are supported, and |
884dc78b | 355 | .Nm ssh |
7cac2b65 | 356 | will act as a SOCKS server. |
884dc78b | 357 | Multiple forwardings may be specified, and |
bfe49944 | 358 | additional forwardings can be given on the command line. |
359 | Only the superuser can forward privileged ports. | |
7cac2b65 | 360 | .It Cm EnableSSHKeysign |
361 | Setting this option to | |
362 | .Dq yes | |
363 | in the global client configuration file | |
364 | .Pa /etc/ssh/ssh_config | |
365 | enables the use of the helper program | |
366 | .Xr ssh-keysign 8 | |
367 | during | |
368 | .Cm HostbasedAuthentication . | |
369 | The argument must be | |
370 | .Dq yes | |
371 | or | |
372 | .Dq no . | |
373 | The default is | |
374 | .Dq no . | |
540d72c3 | 375 | This option should be placed in the non-hostspecific section. |
7cac2b65 | 376 | See |
377 | .Xr ssh-keysign 8 | |
378 | for more information. | |
884dc78b | 379 | .It Cm EscapeChar |
380 | Sets the escape character (default: | |
381 | .Ql ~ ) . | |
382 | The escape character can also | |
383 | be set on the command line. | |
384 | The argument should be a single character, | |
385 | .Ql ^ | |
386 | followed by a letter, or | |
387 | .Dq none | |
388 | to disable the escape | |
389 | character entirely (making the connection transparent for binary | |
390 | data). | |
391 | .It Cm ForwardAgent | |
392 | Specifies whether the connection to the authentication agent (if any) | |
393 | will be forwarded to the remote machine. | |
394 | The argument must be | |
395 | .Dq yes | |
396 | or | |
397 | .Dq no . | |
398 | The default is | |
399 | .Dq no . | |
d03f4262 | 400 | .Pp |
bfe49944 | 401 | Agent forwarding should be enabled with caution. |
402 | Users with the ability to bypass file permissions on the remote host | |
403 | (for the agent's Unix-domain socket) | |
404 | can access the local agent through the forwarded connection. | |
405 | An attacker cannot obtain key material from the agent, | |
d03f4262 | 406 | however they can perform operations on the keys that enable them to |
407 | authenticate using the identities loaded into the agent. | |
884dc78b | 408 | .It Cm ForwardX11 |
409 | Specifies whether X11 connections will be automatically redirected | |
410 | over the secure channel and | |
411 | .Ev DISPLAY | |
412 | set. | |
413 | The argument must be | |
414 | .Dq yes | |
415 | or | |
416 | .Dq no . | |
417 | The default is | |
418 | .Dq no . | |
d03f4262 | 419 | .Pp |
bfe49944 | 420 | X11 forwarding should be enabled with caution. |
421 | Users with the ability to bypass file permissions on the remote host | |
540d72c3 | 422 | (for the user's X11 authorization database) |
bfe49944 | 423 | can access the local X11 display through the forwarded connection. |
540d72c3 | 424 | An attacker may then be able to perform activities such as keystroke monitoring |
425 | if the | |
426 | .Cm ForwardX11Trusted | |
427 | option is also enabled. | |
428 | .It Cm ForwardX11Trusted | |
7e82606e | 429 | If this option is set to |
540d72c3 | 430 | .Dq yes |
431 | then remote X11 clients will have full access to the original X11 display. | |
dfddba3d | 432 | .Pp |
540d72c3 | 433 | If this option is set to |
434 | .Dq no | |
435 | then remote X11 clients will be considered untrusted and prevented | |
436 | from stealing or tampering with data belonging to trusted X11 | |
437 | clients. | |
dfddba3d | 438 | Furthermore, the |
439 | .Xr xauth 1 | |
440 | token used for the session will be set to expire after 20 minutes. | |
441 | Remote clients will be refused access after this time. | |
540d72c3 | 442 | .Pp |
443 | The default is | |
444 | .Dq no . | |
445 | .Pp | |
446 | See the X11 SECURITY extension specification for full details on | |
447 | the restrictions imposed on untrusted clients. | |
884dc78b | 448 | .It Cm GatewayPorts |
449 | Specifies whether remote hosts are allowed to connect to local | |
450 | forwarded ports. | |
451 | By default, | |
452 | .Nm ssh | |
bfe49944 | 453 | binds local port forwardings to the loopback address. |
454 | This prevents other remote hosts from connecting to forwarded ports. | |
884dc78b | 455 | .Cm GatewayPorts |
456 | can be used to specify that | |
457 | .Nm ssh | |
458 | should bind local port forwardings to the wildcard address, | |
459 | thus allowing remote hosts to connect to forwarded ports. | |
460 | The argument must be | |
461 | .Dq yes | |
462 | or | |
463 | .Dq no . | |
464 | The default is | |
465 | .Dq no . | |
466 | .It Cm GlobalKnownHostsFile | |
467 | Specifies a file to use for the global | |
468 | host key database instead of | |
469 | .Pa /etc/ssh/ssh_known_hosts . | |
7cac2b65 | 470 | .It Cm GSSAPIAuthentication |
540d72c3 | 471 | Specifies whether user authentication based on GSSAPI is allowed. |
44a053a3 | 472 | The default is |
473 | .Dq yes . | |
85740ad2 | 474 | Note that this option applies to protocol version 2 only. |
7cac2b65 | 475 | .It Cm GSSAPIKeyExchange |
7a056ed1 | 476 | Specifies whether key exchange based on GSSAPI may be used. When using |
477 | GSSAPI key exchange the server need not have a host key. | |
478 | The default is | |
479 | .Dq yes . | |
85740ad2 | 480 | Note that this option applies to protocol version 2 only. |
7cac2b65 | 481 | .It Cm GSSAPIDelegateCredentials |
85740ad2 | 482 | Forward (delegate) credentials to the server. |
44a053a3 | 483 | The default is |
484 | .Dq yes . | |
85740ad2 | 485 | Note that this option applies to protocol version 2 only. |
fe4ad273 | 486 | .It Cm GSSAPITrustDns |
487 | Set to | |
488 | .Dq yes to indicate that the DNS is trusted to securely canonicalize | |
489 | the name of the host being connected to. If | |
490 | .Dq no, the hostname entered on the | |
491 | command line will be passed untouched to the GSSAPI library. | |
492 | The default is | |
493 | .Dq yes . | |
494 | This option only applies to protocol version 2 connections using GSSAPI | |
495 | key exchange. | |
dfddba3d | 496 | .It Cm HashKnownHosts |
497 | Indicates that | |
498 | .Nm ssh | |
499 | should hash host names and addresses when they are added to | |
2ce0bfe4 | 500 | .Pa ~/.ssh/known_hosts . |
dfddba3d | 501 | These hashed names may be used normally by |
502 | .Nm ssh | |
503 | and | |
504 | .Nm sshd , | |
505 | but they do not reveal identifying information should the file's contents | |
506 | be disclosed. | |
507 | The default is | |
508 | .Dq no . | |
509 | Note that hashing of names and addresses will not be retrospectively applied | |
510 | to existing known hosts files, but these may be manually hashed using | |
511 | .Xr ssh-keygen 1 . | |
884dc78b | 512 | .It Cm HostbasedAuthentication |
513 | Specifies whether to try rhosts based authentication with public key | |
514 | authentication. | |
515 | The argument must be | |
516 | .Dq yes | |
517 | or | |
518 | .Dq no . | |
519 | The default is | |
520 | .Dq no . | |
521 | This option applies to protocol version 2 only and | |
522 | is similar to | |
523 | .Cm RhostsRSAAuthentication . | |
524 | .It Cm HostKeyAlgorithms | |
525 | Specifies the protocol version 2 host key algorithms | |
526 | that the client wants to use in order of preference. | |
527 | The default for this option is: | |
528 | .Dq ssh-rsa,ssh-dss . | |
529 | .It Cm HostKeyAlias | |
530 | Specifies an alias that should be used instead of the | |
531 | real host name when looking up or saving the host key | |
532 | in the host key database files. | |
533 | This option is useful for tunneling ssh connections | |
534 | or for multiple servers running on a single host. | |
535 | .It Cm HostName | |
536 | Specifies the real host name to log into. | |
537 | This can be used to specify nicknames or abbreviations for hosts. | |
538 | Default is the name given on the command line. | |
539 | Numeric IP addresses are also permitted (both on the command line and in | |
540 | .Cm HostName | |
541 | specifications). | |
12a403af | 542 | .It Cm IdentitiesOnly |
543 | Specifies that | |
544 | .Nm ssh | |
545 | should only use the authentication identity files configured in the | |
7e82606e | 546 | .Nm |
12a403af | 547 | files, |
548 | even if the | |
549 | .Nm ssh-agent | |
550 | offers more identities. | |
551 | The argument to this keyword must be | |
552 | .Dq yes | |
553 | or | |
554 | .Dq no . | |
08822d99 | 555 | This option is intended for situations where |
12a403af | 556 | .Nm ssh-agent |
557 | offers many different identities. | |
558 | The default is | |
559 | .Dq no . | |
08822d99 | 560 | .It Cm IdentityFile |
561 | Specifies a file from which the user's RSA or DSA authentication identity | |
562 | is read. | |
563 | The default is | |
564 | .Pa ~/.ssh/identity | |
565 | for protocol version 1, and | |
566 | .Pa ~/.ssh/id_rsa | |
567 | and | |
568 | .Pa ~/.ssh/id_dsa | |
569 | for protocol version 2. | |
570 | Additionally, any identities represented by the authentication agent | |
571 | will be used for authentication. | |
572 | The file name may use the tilde | |
573 | syntax to refer to a user's home directory. | |
574 | It is possible to have | |
575 | multiple identity files specified in configuration files; all these | |
576 | identities will be tried in sequence. | |
dfddba3d | 577 | .It Cm KbdInteractiveDevices |
578 | Specifies the list of methods to use in keyboard-interactive authentication. | |
579 | Multiple method names must be comma-separated. | |
580 | The default is to use the server specified list. | |
08822d99 | 581 | .It Cm LocalCommand |
582 | Specifies a command to execute on the local machine after successfully | |
583 | connecting to the server. | |
584 | The command string extends to the end of the line, and is executed with | |
585 | .Pa /bin/sh . | |
586 | This directive is ignored unless | |
587 | .Cm PermitLocalCommand | |
588 | has been enabled. | |
884dc78b | 589 | .It Cm LocalForward |
08822d99 | 590 | Specifies that a TCP port on the local machine be forwarded over |
884dc78b | 591 | the secure channel to the specified host and port from the remote machine. |
8b32eddc | 592 | The first argument must be |
dfddba3d | 593 | .Sm off |
8b32eddc | 594 | .Oo Ar bind_address : Oc Ar port |
dfddba3d | 595 | .Sm on |
8b32eddc | 596 | and the second argument must be |
597 | .Ar host : Ns Ar hostport . | |
dfddba3d | 598 | IPv6 addresses can be specified by enclosing addresses in square brackets or |
599 | by using an alternative syntax: | |
8b32eddc | 600 | .Oo Ar bind_address Ns / Oc Ns Ar port |
601 | and | |
602 | .Ar host Ns / Ns Ar hostport . | |
dfddba3d | 603 | Multiple forwardings may be specified, and additional forwardings can be |
604 | given on the command line. | |
884dc78b | 605 | Only the superuser can forward privileged ports. |
dfddba3d | 606 | By default, the local port is bound in accordance with the |
607 | .Cm GatewayPorts | |
608 | setting. | |
609 | However, an explicit | |
610 | .Ar bind_address | |
611 | may be used to bind the connection to a specific address. | |
612 | The | |
613 | .Ar bind_address | |
614 | of | |
615 | .Dq localhost | |
616 | indicates that the listening port be bound for local use only, while an | |
617 | empty address or | |
618 | .Sq * | |
619 | indicates that the port should be available from all interfaces. | |
884dc78b | 620 | .It Cm LogLevel |
621 | Gives the verbosity level that is used when logging messages from | |
622 | .Nm ssh . | |
623 | The possible values are: | |
624 | QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2 and DEBUG3. | |
bfe49944 | 625 | The default is INFO. |
626 | DEBUG and DEBUG1 are equivalent. | |
627 | DEBUG2 and DEBUG3 each specify higher levels of verbose output. | |
884dc78b | 628 | .It Cm MACs |
629 | Specifies the MAC (message authentication code) algorithms | |
630 | in order of preference. | |
631 | The MAC algorithm is used in protocol version 2 | |
632 | for data integrity protection. | |
633 | Multiple algorithms must be comma-separated. | |
634 | The default is | |
635 | .Dq hmac-md5,hmac-sha1,hmac-ripemd160,hmac-sha1-96,hmac-md5-96 . | |
636 | .It Cm NoHostAuthenticationForLocalhost | |
637 | This option can be used if the home directory is shared across machines. | |
638 | In this case localhost will refer to a different machine on each of | |
639 | the machines and the user will get many warnings about changed host keys. | |
640 | However, this option disables host authentication for localhost. | |
641 | The argument to this keyword must be | |
642 | .Dq yes | |
643 | or | |
644 | .Dq no . | |
645 | The default is to check the host key for localhost. | |
646 | .It Cm NumberOfPasswordPrompts | |
647 | Specifies the number of password prompts before giving up. | |
648 | The argument to this keyword must be an integer. | |
649 | Default is 3. | |
650 | .It Cm PasswordAuthentication | |
651 | Specifies whether to use password authentication. | |
652 | The argument to this keyword must be | |
653 | .Dq yes | |
654 | or | |
655 | .Dq no . | |
656 | The default is | |
657 | .Dq yes . | |
08822d99 | 658 | .It Cm PermitLocalCommand |
659 | Allow local command execution via the | |
660 | .Ic LocalCommand | |
661 | option or using the | |
662 | .Ic !\& Ns Ar command | |
663 | escape sequence in | |
664 | .Xr ssh 1 . | |
665 | The argument must be | |
666 | .Dq yes | |
667 | or | |
668 | .Dq no . | |
669 | The default is | |
670 | .Dq no . | |
884dc78b | 671 | .It Cm Port |
672 | Specifies the port number to connect on the remote host. | |
673 | Default is 22. | |
674 | .It Cm PreferredAuthentications | |
675 | Specifies the order in which the client should try protocol 2 | |
7cac2b65 | 676 | authentication methods. |
8b32eddc | 677 | This allows a client to prefer one method (e.g.\& |
884dc78b | 678 | .Cm keyboard-interactive ) |
8b32eddc | 679 | over another method (e.g.\& |
884dc78b | 680 | .Cm password ) |
681 | The default for this option is: | |
fe4ad273 | 682 | .Dq publickey,gssapi-keyex,external-keyx,gssapi-with-mic,gssapi,password,keyboard-interactive . |
884dc78b | 683 | .It Cm Protocol |
684 | Specifies the protocol versions | |
685 | .Nm ssh | |
686 | should support in order of preference. | |
687 | The possible values are | |
688 | .Dq 1 | |
689 | and | |
690 | .Dq 2 . | |
691 | Multiple versions must be comma-separated. | |
692 | The default is | |
693 | .Dq 2,1 . | |
694 | This means that | |
695 | .Nm ssh | |
696 | tries version 2 and falls back to version 1 | |
697 | if version 2 is not available. | |
698 | .It Cm ProxyCommand | |
699 | Specifies the command to use to connect to the server. | |
700 | The command | |
701 | string extends to the end of the line, and is executed with | |
702 | .Pa /bin/sh . | |
703 | In the command string, | |
704 | .Ql %h | |
705 | will be substituted by the host name to | |
706 | connect and | |
707 | .Ql %p | |
708 | by the port. | |
709 | The command can be basically anything, | |
710 | and should read from its standard input and write to its standard output. | |
711 | It should eventually connect an | |
712 | .Xr sshd 8 | |
713 | server running on some machine, or execute | |
714 | .Ic sshd -i | |
715 | somewhere. | |
716 | Host key management will be done using the | |
717 | HostName of the host being connected (defaulting to the name typed by | |
718 | the user). | |
bfe49944 | 719 | Setting the command to |
720 | .Dq none | |
721 | disables this option entirely. | |
884dc78b | 722 | Note that |
723 | .Cm CheckHostIP | |
724 | is not available for connects with a proxy command. | |
725 | .Pp | |
2ce0bfe4 | 726 | This directive is useful in conjunction with |
727 | .Xr nc 1 | |
728 | and its proxy support. | |
729 | For example, the following directive would connect via an HTTP proxy at | |
730 | 192.0.2.0: | |
731 | .Bd -literal -offset 3n | |
732 | ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p | |
733 | .Ed | |
884dc78b | 734 | .It Cm PubkeyAuthentication |
735 | Specifies whether to try public key authentication. | |
736 | The argument to this keyword must be | |
737 | .Dq yes | |
738 | or | |
739 | .Dq no . | |
740 | The default is | |
741 | .Dq yes . | |
742 | This option applies to protocol version 2 only. | |
08822d99 | 743 | .It Cm RekeyLimit |
744 | Specifies the maximum amount of data that may be transmitted before the | |
745 | session key is renegotiated. | |
746 | The argument is the number of bytes, with an optional suffix of | |
747 | .Sq K , | |
748 | .Sq M , | |
749 | or | |
750 | .Sq G | |
751 | to indicate Kilobytes, Megabytes, or Gigabytes, respectively. | |
752 | The default is between | |
753 | .Dq 1G | |
754 | and | |
755 | .Dq 4G , | |
756 | depending on the cipher. | |
757 | This option applies to protocol version 2 only. | |
884dc78b | 758 | .It Cm RemoteForward |
08822d99 | 759 | Specifies that a TCP port on the remote machine be forwarded over |
884dc78b | 760 | the secure channel to the specified host and port from the local machine. |
8b32eddc | 761 | The first argument must be |
dfddba3d | 762 | .Sm off |
8b32eddc | 763 | .Oo Ar bind_address : Oc Ar port |
dfddba3d | 764 | .Sm on |
8b32eddc | 765 | and the second argument must be |
766 | .Ar host : Ns Ar hostport . | |
767 | IPv6 addresses can be specified by enclosing addresses in square brackets | |
768 | or by using an alternative syntax: | |
769 | .Oo Ar bind_address Ns / Oc Ns Ar port | |
770 | and | |
771 | .Ar host Ns / Ns Ar hostport . | |
884dc78b | 772 | Multiple forwardings may be specified, and additional |
773 | forwardings can be given on the command line. | |
774 | Only the superuser can forward privileged ports. | |
dfddba3d | 775 | .Pp |
776 | If the | |
777 | .Ar bind_address | |
778 | is not specified, the default is to only bind to loopback addresses. | |
779 | If the | |
780 | .Ar bind_address | |
781 | is | |
782 | .Ql * | |
783 | or an empty string, then the forwarding is requested to listen on all | |
784 | interfaces. | |
785 | Specifying a remote | |
786 | .Ar bind_address | |
787 | will only succeed if the server's | |
788 | .Cm GatewayPorts | |
789 | option is enabled (see | |
790 | .Xr sshd_config 5 ) . | |
884dc78b | 791 | .It Cm RhostsRSAAuthentication |
792 | Specifies whether to try rhosts based authentication with RSA host | |
793 | authentication. | |
794 | The argument must be | |
795 | .Dq yes | |
796 | or | |
797 | .Dq no . | |
798 | The default is | |
799 | .Dq no . | |
800 | This option applies to protocol version 1 only and requires | |
801 | .Nm ssh | |
802 | to be setuid root. | |
803 | .It Cm RSAAuthentication | |
804 | Specifies whether to try RSA authentication. | |
805 | The argument to this keyword must be | |
806 | .Dq yes | |
807 | or | |
808 | .Dq no . | |
809 | RSA authentication will only be | |
810 | attempted if the identity file exists, or an authentication agent is | |
811 | running. | |
812 | The default is | |
813 | .Dq yes . | |
814 | Note that this option applies to protocol version 1 only. | |
7e82606e | 815 | .It Cm SendEnv |
816 | Specifies what variables from the local | |
817 | .Xr environ 7 | |
818 | should be sent to the server. | |
819 | Note that environment passing is only supported for protocol 2, the | |
820 | server must also support it, and the server must be configured to | |
821 | accept these environment variables. | |
822 | Refer to | |
823 | .Cm AcceptEnv | |
824 | in | |
825 | .Xr sshd_config 5 | |
826 | for how to configure the server. | |
827 | Variables are specified by name, which may contain the wildcard characters | |
828 | .Ql \&* | |
829 | and | |
830 | .Ql \&? . | |
831 | Multiple environment variables may be separated by whitespace or spread | |
832 | across multiple | |
833 | .Cm SendEnv | |
834 | directives. | |
835 | The default is not to send any environment variables. | |
540d72c3 | 836 | .It Cm ServerAliveCountMax |
08822d99 | 837 | Sets the number of server alive messages (see below) which may be |
540d72c3 | 838 | sent without |
839 | .Nm ssh | |
840 | receiving any messages back from the server. | |
841 | If this threshold is reached while server alive messages are being sent, | |
842 | .Nm ssh | |
843 | will disconnect from the server, terminating the session. | |
844 | It is important to note that the use of server alive messages is very | |
845 | different from | |
846 | .Cm TCPKeepAlive | |
847 | (below). | |
848 | The server alive messages are sent through the encrypted channel | |
849 | and therefore will not be spoofable. | |
850 | The TCP keepalive option enabled by | |
851 | .Cm TCPKeepAlive | |
852 | is spoofable. | |
853 | The server alive mechanism is valuable when the client or | |
854 | server depend on knowing when a connection has become inactive. | |
855 | .Pp | |
856 | The default value is 3. | |
857 | If, for example, | |
858 | .Cm ServerAliveInterval | |
08822d99 | 859 | (see below) is set to 15, and |
540d72c3 | 860 | .Cm ServerAliveCountMax |
861 | is left at the default, if the server becomes unresponsive ssh | |
862 | will disconnect after approximately 45 seconds. | |
08822d99 | 863 | .It Cm ServerAliveInterval |
864 | Sets a timeout interval in seconds after which if no data has been received | |
865 | from the server, | |
866 | .Nm ssh | |
867 | will send a message through the encrypted | |
868 | channel to request a response from the server. | |
869 | The default | |
870 | is 0, indicating that these messages will not be sent to the server. | |
871 | This option applies to protocol version 2 only. | |
884dc78b | 872 | .It Cm SmartcardDevice |
7cac2b65 | 873 | Specifies which smartcard device to use. |
874 | The argument to this keyword is the device | |
884dc78b | 875 | .Nm ssh |
876 | should use to communicate with a smartcard used for storing the user's | |
7cac2b65 | 877 | private RSA key. |
878 | By default, no device is specified and smartcard support is not activated. | |
884dc78b | 879 | .It Cm StrictHostKeyChecking |
880 | If this flag is set to | |
881 | .Dq yes , | |
882 | .Nm ssh | |
883 | will never automatically add host keys to the | |
2ce0bfe4 | 884 | .Pa ~/.ssh/known_hosts |
884dc78b | 885 | file, and refuses to connect to hosts whose host key has changed. |
886 | This provides maximum protection against trojan horse attacks, | |
887 | however, can be annoying when the | |
888 | .Pa /etc/ssh/ssh_known_hosts | |
889 | file is poorly maintained, or connections to new hosts are | |
890 | frequently made. | |
891 | This option forces the user to manually | |
892 | add all new hosts. | |
893 | If this flag is set to | |
894 | .Dq no , | |
895 | .Nm ssh | |
896 | will automatically add new host keys to the | |
897 | user known hosts files. | |
898 | If this flag is set to | |
899 | .Dq ask , | |
900 | new host keys | |
901 | will be added to the user known host files only after the user | |
902 | has confirmed that is what they really want to do, and | |
903 | .Nm ssh | |
904 | will refuse to connect to hosts whose host key has changed. | |
905 | The host keys of | |
906 | known hosts will be verified automatically in all cases. | |
907 | The argument must be | |
908 | .Dq yes , | |
909 | .Dq no | |
910 | or | |
911 | .Dq ask . | |
912 | The default is | |
913 | .Dq ask . | |
540d72c3 | 914 | .It Cm TCPKeepAlive |
915 | Specifies whether the system should send TCP keepalive messages to the | |
916 | other side. | |
917 | If they are sent, death of the connection or crash of one | |
918 | of the machines will be properly noticed. | |
919 | However, this means that | |
920 | connections will die if the route is down temporarily, and some people | |
921 | find it annoying. | |
922 | .Pp | |
923 | The default is | |
924 | .Dq yes | |
925 | (to send TCP keepalive messages), and the client will notice | |
926 | if the network goes down or the remote host dies. | |
927 | This is important in scripts, and many users want it too. | |
928 | .Pp | |
929 | To disable TCP keepalive messages, the value should be set to | |
930 | .Dq no . | |
08822d99 | 931 | .It Cm Tunnel |
932 | Request starting | |
933 | .Xr tun 4 | |
934 | device forwarding between the client and the server. | |
935 | This option also allows requesting layer 2 (ethernet) | |
936 | instead of layer 3 (point-to-point) tunneling from the server. | |
937 | The argument must be | |
938 | .Dq yes , | |
939 | .Dq point-to-point , | |
940 | .Dq ethernet | |
941 | or | |
942 | .Dq no . | |
943 | The default is | |
944 | .Dq no . | |
945 | .It Cm TunnelDevice | |
946 | Force a specified | |
947 | .Xr tun 4 | |
948 | device on the client. | |
949 | Without this option, the next available device will be used. | |
884dc78b | 950 | .It Cm UsePrivilegedPort |
951 | Specifies whether to use a privileged port for outgoing connections. | |
952 | The argument must be | |
953 | .Dq yes | |
954 | or | |
955 | .Dq no . | |
956 | The default is | |
957 | .Dq no . | |
d03f4262 | 958 | If set to |
959 | .Dq yes | |
960 | .Nm ssh | |
961 | must be setuid root. | |
884dc78b | 962 | Note that this option must be set to |
963 | .Dq yes | |
7cac2b65 | 964 | for |
884dc78b | 965 | .Cm RhostsRSAAuthentication |
7cac2b65 | 966 | with older servers. |
884dc78b | 967 | .It Cm User |
968 | Specifies the user to log in as. | |
969 | This can be useful when a different user name is used on different machines. | |
970 | This saves the trouble of | |
971 | having to remember to give the user name on the command line. | |
972 | .It Cm UserKnownHostsFile | |
973 | Specifies a file to use for the user | |
974 | host key database instead of | |
2ce0bfe4 | 975 | .Pa ~/.ssh/known_hosts . |
7cac2b65 | 976 | .It Cm VerifyHostKeyDNS |
977 | Specifies whether to verify the remote key using DNS and SSHFP resource | |
978 | records. | |
540d72c3 | 979 | If this option is set to |
980 | .Dq yes , | |
981 | the client will implicitly trust keys that match a secure fingerprint | |
982 | from DNS. | |
983 | Insecure fingerprints will be handled as if this option was set to | |
984 | .Dq ask . | |
985 | If this option is set to | |
986 | .Dq ask , | |
987 | information on fingerprint match will be displayed, but the user will still | |
988 | need to confirm new host keys according to the | |
989 | .Cm StrictHostKeyChecking | |
990 | option. | |
991 | The argument must be | |
992 | .Dq yes , | |
993 | .Dq no | |
994 | or | |
995 | .Dq ask . | |
7cac2b65 | 996 | The default is |
997 | .Dq no . | |
998 | Note that this option applies to protocol version 2 only. | |
884dc78b | 999 | .It Cm XAuthLocation |
d03f4262 | 1000 | Specifies the full pathname of the |
884dc78b | 1001 | .Xr xauth 1 |
1002 | program. | |
1003 | The default is | |
1004 | .Pa /usr/X11R6/bin/xauth . | |
1005 | .El | |
1006 | .Sh FILES | |
1007 | .Bl -tag -width Ds | |
2ce0bfe4 | 1008 | .It Pa ~/.ssh/config |
884dc78b | 1009 | This is the per-user configuration file. |
1010 | The format of this file is described above. | |
1011 | This file is used by the | |
1012 | .Nm ssh | |
1013 | client. | |
7e82606e | 1014 | Because of the potential for abuse, this file must have strict permissions: |
1015 | read/write for the user, and not accessible by others. | |
884dc78b | 1016 | .It Pa /etc/ssh/ssh_config |
1017 | Systemwide configuration file. | |
1018 | This file provides defaults for those | |
1019 | values that are not specified in the user's configuration file, and | |
1020 | for those users who do not have a configuration file. | |
1021 | This file must be world-readable. | |
1022 | .El | |
7cac2b65 | 1023 | .Sh SEE ALSO |
1024 | .Xr ssh 1 | |
884dc78b | 1025 | .Sh AUTHORS |
1026 | OpenSSH is a derivative of the original and free | |
1027 | ssh 1.2.12 release by Tatu Ylonen. | |
1028 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, | |
1029 | Theo de Raadt and Dug Song | |
1030 | removed many bugs, re-added newer features and | |
1031 | created OpenSSH. | |
1032 | Markus Friedl contributed the support for SSH | |
1033 | protocol versions 1.5 and 2.0. |