Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1 | .\" |
| 2 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
| 3 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 4 | .\" All rights reserved |
| 5 | .\" |
| 6 | .\" As far as I am concerned, the code I have written for this software |
| 7 | .\" can be used freely for any purpose. Any derived versions of this |
| 8 | .\" software must be clearly marked as such, and if the derived work is |
| 9 | .\" incompatible with the protocol description in the RFC file, it must be |
| 10 | .\" called by a name other than "ssh" or "Secure Shell". |
| 11 | .\" |
| 12 | .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. |
| 13 | .\" Copyright (c) 1999 Aaron Campbell. All rights reserved. |
| 14 | .\" Copyright (c) 1999 Theo de Raadt. All rights reserved. |
| 15 | .\" |
| 16 | .\" Redistribution and use in source and binary forms, with or without |
| 17 | .\" modification, are permitted provided that the following conditions |
| 18 | .\" are met: |
| 19 | .\" 1. Redistributions of source code must retain the above copyright |
| 20 | .\" notice, this list of conditions and the following disclaimer. |
| 21 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| 22 | .\" notice, this list of conditions and the following disclaimer in the |
| 23 | .\" documentation and/or other materials provided with the distribution. |
| 24 | .\" |
| 25 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| 26 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| 27 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| 28 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 29 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 30 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 31 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 32 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 33 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| 34 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 35 | .\" |
markus@openbsd.org | b02ad1c | 2016-05-04 12:21:53 +0000 | [diff] [blame] | 36 | .\" $OpenBSD: ssh_config.5,v 1.231 2016/05/04 12:21:53 markus Exp $ |
| 37 | .Dd $Mdocdate: May 4 2016 $ |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 38 | .Dt SSH_CONFIG 5 |
| 39 | .Os |
| 40 | .Sh NAME |
| 41 | .Nm ssh_config |
| 42 | .Nd OpenSSH SSH client configuration files |
| 43 | .Sh SYNOPSIS |
Darren Tucker | bf6b328 | 2007-02-19 22:08:17 +1100 | [diff] [blame] | 44 | .Nm ~/.ssh/config |
| 45 | .Nm /etc/ssh/ssh_config |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 46 | .Sh DESCRIPTION |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 47 | .Xr ssh 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 48 | obtains configuration data from the following sources in |
| 49 | the following order: |
Damien Miller | 5c853b5 | 2006-03-15 11:37:02 +1100 | [diff] [blame] | 50 | .Pp |
Ben Lindstrom | 479b476 | 2002-08-20 19:04:51 +0000 | [diff] [blame] | 51 | .Bl -enum -offset indent -compact |
| 52 | .It |
| 53 | command-line options |
| 54 | .It |
| 55 | user's configuration file |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 56 | .Pq Pa ~/.ssh/config |
Ben Lindstrom | 479b476 | 2002-08-20 19:04:51 +0000 | [diff] [blame] | 57 | .It |
| 58 | system-wide configuration file |
| 59 | .Pq Pa /etc/ssh/ssh_config |
| 60 | .El |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 61 | .Pp |
| 62 | For each parameter, the first obtained value |
| 63 | will be used. |
Darren Tucker | 43d8e28 | 2005-02-09 09:51:08 +1100 | [diff] [blame] | 64 | The configuration files contain sections separated by |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 65 | .Dq Host |
| 66 | specifications, and that section is only applied for hosts that |
| 67 | match one of the patterns given in the specification. |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 68 | The matched host name is usually the one given on the command line |
| 69 | (see the |
| 70 | .Cm CanonicalizeHostname |
| 71 | option for exceptions.) |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 72 | .Pp |
| 73 | Since the first obtained value for each parameter is used, more |
| 74 | host-specific declarations should be given near the beginning of the |
| 75 | file, and general defaults at the end. |
| 76 | .Pp |
| 77 | The configuration file has the following format: |
| 78 | .Pp |
| 79 | Empty lines and lines starting with |
| 80 | .Ql # |
| 81 | are comments. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 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 , |
Damien Miller | 4aea974 | 2006-03-15 11:59:39 +1100 | [diff] [blame] | 90 | .Nm scp , |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 91 | and |
| 92 | .Nm sftp |
| 93 | .Fl o |
| 94 | option. |
Damien Miller | 306d118 | 2006-03-15 12:05:59 +1100 | [diff] [blame] | 95 | Arguments may optionally be enclosed in double quotes |
| 96 | .Pq \&" |
| 97 | in order to represent arguments containing spaces. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 98 | .Pp |
| 99 | The possible |
| 100 | keywords and their meanings are as follows (note that |
| 101 | keywords are case-insensitive and arguments are case-sensitive): |
| 102 | .Bl -tag -width Ds |
| 103 | .It Cm Host |
| 104 | Restricts the following declarations (up to the next |
| 105 | .Cm Host |
Damien Miller | 194fd90 | 2013-10-15 12:13:05 +1100 | [diff] [blame] | 106 | or |
| 107 | .Cm Match |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 108 | keyword) to be only for those hosts that match one of the patterns |
| 109 | given after the keyword. |
Damien Miller | fa51b16 | 2008-11-03 19:17:33 +1100 | [diff] [blame] | 110 | If more than one pattern is provided, they should be separated by whitespace. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 111 | A single |
Damien Miller | 208f1ed | 2006-03-15 11:56:03 +1100 | [diff] [blame] | 112 | .Ql * |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 113 | as a pattern can be used to provide global |
| 114 | defaults for all hosts. |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 115 | The host is usually the |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 116 | .Ar hostname |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 117 | argument given on the command line |
| 118 | (see the |
| 119 | .Cm CanonicalizeHostname |
| 120 | option for exceptions.) |
Damien Miller | f54a4b9 | 2006-03-15 11:54:36 +1100 | [diff] [blame] | 121 | .Pp |
Damien Miller | fe92421 | 2011-05-15 08:44:45 +1000 | [diff] [blame] | 122 | A pattern entry may be negated by prefixing it with an exclamation mark |
| 123 | .Pq Sq !\& . |
| 124 | If a negated entry is matched, then the |
| 125 | .Cm Host |
| 126 | entry is ignored, regardless of whether any other patterns on the line |
| 127 | match. |
| 128 | Negated matches are therefore useful to provide exceptions for wildcard |
| 129 | matches. |
| 130 | .Pp |
Damien Miller | f54a4b9 | 2006-03-15 11:54:36 +1100 | [diff] [blame] | 131 | See |
| 132 | .Sx PATTERNS |
| 133 | for more information on patterns. |
Damien Miller | d77b81f | 2013-10-17 11:39:00 +1100 | [diff] [blame] | 134 | .It Cm Match |
Damien Miller | 194fd90 | 2013-10-15 12:13:05 +1100 | [diff] [blame] | 135 | Restricts the following declarations (up to the next |
| 136 | .Cm Host |
| 137 | or |
| 138 | .Cm Match |
| 139 | keyword) to be used only when the conditions following the |
| 140 | .Cm Match |
| 141 | keyword are satisfied. |
sobrado@openbsd.org | e3cbb06 | 2015-09-22 08:33:23 +0000 | [diff] [blame] | 142 | Match conditions are specified using one or more criteria |
Damien Miller | cf31f38 | 2013-10-24 21:02:56 +1100 | [diff] [blame] | 143 | or the single token |
| 144 | .Cm all |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 145 | which always matches. |
| 146 | The available criteria keywords are: |
| 147 | .Cm canonical , |
Damien Miller | 8a04be7 | 2013-10-23 16:29:40 +1100 | [diff] [blame] | 148 | .Cm exec , |
Damien Miller | 194fd90 | 2013-10-15 12:13:05 +1100 | [diff] [blame] | 149 | .Cm host , |
| 150 | .Cm originalhost , |
| 151 | .Cm user , |
| 152 | and |
| 153 | .Cm localuser . |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 154 | The |
| 155 | .Cm all |
| 156 | criteria must appear alone or immediately after |
jmc@openbsd.org | b1ba15f | 2014-10-09 06:21:31 +0000 | [diff] [blame] | 157 | .Cm canonical . |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 158 | Other criteria may be combined arbitrarily. |
| 159 | All criteria but |
| 160 | .Cm all |
| 161 | and |
| 162 | .Cm canonical |
| 163 | require an argument. |
| 164 | Criteria may be negated by prepending an exclamation mark |
| 165 | .Pq Sq !\& . |
Damien Miller | 194fd90 | 2013-10-15 12:13:05 +1100 | [diff] [blame] | 166 | .Pp |
Damien Miller | 8e5a67f | 2013-10-23 16:30:25 +1100 | [diff] [blame] | 167 | The |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 168 | .Cm canonical |
dtucker@openbsd.org | dd2cfeb | 2015-05-28 05:09:45 +0000 | [diff] [blame] | 169 | keyword matches only when the configuration file is being re-parsed |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 170 | after hostname canonicalization (see the |
| 171 | .Cm CanonicalizeHostname |
| 172 | option.) |
| 173 | This may be useful to specify conditions that work with canonical host |
| 174 | names only. |
| 175 | The |
Damien Miller | 8a04be7 | 2013-10-23 16:29:40 +1100 | [diff] [blame] | 176 | .Cm exec |
Damien Miller | 8e5a67f | 2013-10-23 16:30:25 +1100 | [diff] [blame] | 177 | keyword executes the specified command under the user's shell. |
Damien Miller | 194fd90 | 2013-10-15 12:13:05 +1100 | [diff] [blame] | 178 | If the command returns a zero exit status then the condition is considered true. |
| 179 | Commands containing whitespace characters must be quoted. |
Damien Miller | 5c86ebd | 2013-10-23 16:29:12 +1100 | [diff] [blame] | 180 | The following character sequences in the command will be expanded prior to |
| 181 | execution: |
| 182 | .Ql %L |
| 183 | will be substituted by the first component of the local host name, |
| 184 | .Ql %l |
| 185 | will be substituted by the local host name (including any domain name), |
| 186 | .Ql %h |
| 187 | will be substituted by the target host name, |
| 188 | .Ql %n |
| 189 | will be substituted by the original target host name |
Damien Miller | 8a04be7 | 2013-10-23 16:29:40 +1100 | [diff] [blame] | 190 | specified on the command-line, |
Damien Miller | 5c86ebd | 2013-10-23 16:29:12 +1100 | [diff] [blame] | 191 | .Ql %p |
| 192 | the destination port, |
| 193 | .Ql %r |
| 194 | by the remote login username, and |
| 195 | .Ql %u |
| 196 | by the username of the user running |
| 197 | .Xr ssh 1 . |
Damien Miller | 194fd90 | 2013-10-15 12:13:05 +1100 | [diff] [blame] | 198 | .Pp |
| 199 | The other keywords' criteria must be single entries or comma-separated |
| 200 | lists and may use the wildcard and negation operators described in the |
| 201 | .Sx PATTERNS |
| 202 | section. |
| 203 | The criteria for the |
| 204 | .Cm host |
| 205 | keyword are matched against the target hostname, after any substitution |
| 206 | by the |
| 207 | .Cm Hostname |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 208 | or |
| 209 | .Cm CanonicalizeHostname |
| 210 | options. |
Damien Miller | 194fd90 | 2013-10-15 12:13:05 +1100 | [diff] [blame] | 211 | The |
| 212 | .Cm originalhost |
| 213 | keyword matches against the hostname as it was specified on the command-line. |
| 214 | The |
| 215 | .Cm user |
| 216 | keyword matches against the target username on the remote host. |
| 217 | The |
| 218 | .Cm localuser |
| 219 | keyword matches against the name of the local user running |
| 220 | .Xr ssh 1 |
| 221 | (this keyword may be useful in system-wide |
| 222 | .Nm |
| 223 | files). |
jcs@openbsd.org | f361df4 | 2015-11-15 22:26:49 +0000 | [diff] [blame] | 224 | .It Cm AddKeysToAgent |
| 225 | Specifies whether keys should be automatically added to a running |
jmc@openbsd.org | e41a071 | 2015-11-15 23:58:04 +0000 | [diff] [blame] | 226 | .Xr ssh-agent 1 . |
jcs@openbsd.org | f361df4 | 2015-11-15 22:26:49 +0000 | [diff] [blame] | 227 | If this option is set to |
| 228 | .Dq yes |
| 229 | and a key is loaded from a file, the key and its passphrase are added to |
| 230 | the agent with the default lifetime, as if by |
| 231 | .Xr ssh-add 1 . |
| 232 | If this option is set to |
| 233 | .Dq ask , |
| 234 | .Nm ssh |
| 235 | will require confirmation using the |
| 236 | .Ev SSH_ASKPASS |
| 237 | program before adding a key (see |
| 238 | .Xr ssh-add 1 |
| 239 | for details). |
| 240 | If this option is set to |
| 241 | .Dq confirm , |
| 242 | each use of the key must be confirmed, as if the |
| 243 | .Fl c |
| 244 | option was specified to |
| 245 | .Xr ssh-add 1 . |
| 246 | If this option is set to |
| 247 | .Dq no , |
| 248 | no keys are added to the agent. |
| 249 | The argument must be |
| 250 | .Dq yes , |
| 251 | .Dq confirm , |
| 252 | .Dq ask , |
| 253 | or |
| 254 | .Dq no . |
| 255 | The default is |
| 256 | .Dq no . |
Damien Miller | 20a8f97 | 2003-05-18 20:50:30 +1000 | [diff] [blame] | 257 | .It Cm AddressFamily |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 258 | Specifies which address family to use when connecting. |
| 259 | Valid arguments are |
Damien Miller | 20a8f97 | 2003-05-18 20:50:30 +1000 | [diff] [blame] | 260 | .Dq any , |
| 261 | .Dq inet |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 262 | (use IPv4 only), or |
Damien Miller | 20a8f97 | 2003-05-18 20:50:30 +1000 | [diff] [blame] | 263 | .Dq inet6 |
Darren Tucker | 79a7acf | 2005-02-09 09:48:57 +1100 | [diff] [blame] | 264 | (use IPv6 only). |
sobrado@openbsd.org | c12f0fd | 2016-02-20 23:01:46 +0000 | [diff] [blame] | 265 | The default is |
| 266 | .Dq any . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 267 | .It Cm BatchMode |
| 268 | If set to |
| 269 | .Dq yes , |
| 270 | passphrase/password querying will be disabled. |
| 271 | This option is useful in scripts and other batch jobs where no user |
| 272 | is present to supply the password. |
| 273 | The argument must be |
| 274 | .Dq yes |
| 275 | or |
| 276 | .Dq no . |
| 277 | The default is |
| 278 | .Dq no . |
| 279 | .It Cm BindAddress |
Darren Tucker | 89f4d47 | 2005-07-14 17:06:21 +1000 | [diff] [blame] | 280 | Use the specified address on the local machine as the source address of |
Darren Tucker | 6c71d20 | 2005-07-14 17:06:50 +1000 | [diff] [blame] | 281 | the connection. |
| 282 | Only useful on systems with more than one address. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 283 | Note that this option does not work if |
| 284 | .Cm UsePrivilegedPort |
| 285 | is set to |
| 286 | .Dq yes . |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 287 | .It Cm CanonicalDomains |
Damien Miller | 607af34 | 2013-10-17 11:47:51 +1100 | [diff] [blame] | 288 | When |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 289 | .Cm CanonicalizeHostname |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 290 | is enabled, this option specifies the list of domain suffixes in which to |
| 291 | search for the specified destination host. |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 292 | .It Cm CanonicalizeFallbackLocal |
Damien Miller | 51682fa | 2013-10-17 11:48:31 +1100 | [diff] [blame] | 293 | Specifies whether to fail with an error when hostname canonicalization fails. |
Damien Miller | 607af34 | 2013-10-17 11:47:51 +1100 | [diff] [blame] | 294 | The default, |
Darren Tucker | b7e01c0 | 2014-01-19 22:36:13 +1100 | [diff] [blame] | 295 | .Dq yes , |
Damien Miller | 607af34 | 2013-10-17 11:47:51 +1100 | [diff] [blame] | 296 | will attempt to look up the unqualified hostname using the system resolver's |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 297 | search rules. |
| 298 | A value of |
Darren Tucker | b7e01c0 | 2014-01-19 22:36:13 +1100 | [diff] [blame] | 299 | .Dq no |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 300 | will cause |
| 301 | .Xr ssh 1 |
| 302 | to fail instantly if |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 303 | .Cm CanonicalizeHostname |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 304 | is enabled and the target hostname cannot be found in any of the domains |
| 305 | specified by |
| 306 | .Cm CanonicalDomains . |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 307 | .It Cm CanonicalizeHostname |
Damien Miller | 51682fa | 2013-10-17 11:48:31 +1100 | [diff] [blame] | 308 | Controls whether explicit hostname canonicalization is performed. |
Damien Miller | 607af34 | 2013-10-17 11:47:51 +1100 | [diff] [blame] | 309 | The default, |
| 310 | .Dq no , |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 311 | is not to perform any name rewriting and let the system resolver handle all |
| 312 | hostname lookups. |
| 313 | If set to |
| 314 | .Dq yes |
| 315 | then, for connections that do not use a |
| 316 | .Cm ProxyCommand , |
| 317 | .Xr ssh 1 |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 318 | will attempt to canonicalize the hostname specified on the command line |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 319 | using the |
| 320 | .Cm CanonicalDomains |
| 321 | suffixes and |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 322 | .Cm CanonicalizePermittedCNAMEs |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 323 | rules. |
| 324 | If |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 325 | .Cm CanonicalizeHostname |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 326 | is set to |
| 327 | .Dq always , |
Damien Miller | 51682fa | 2013-10-17 11:48:31 +1100 | [diff] [blame] | 328 | then canonicalization is applied to proxied connections too. |
Damien Miller | 13f97b2 | 2014-02-24 15:57:55 +1100 | [diff] [blame] | 329 | .Pp |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 330 | If this option is enabled, then the configuration files are processed |
| 331 | again using the new target name to pick up any new configuration in matching |
Damien Miller | 13f97b2 | 2014-02-24 15:57:55 +1100 | [diff] [blame] | 332 | .Cm Host |
djm@openbsd.org | 957fbce | 2014-10-08 22:20:25 +0000 | [diff] [blame] | 333 | and |
| 334 | .Cm Match |
Damien Miller | 13f97b2 | 2014-02-24 15:57:55 +1100 | [diff] [blame] | 335 | stanzas. |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 336 | .It Cm CanonicalizeMaxDots |
Damien Miller | 607af34 | 2013-10-17 11:47:51 +1100 | [diff] [blame] | 337 | Specifies the maximum number of dot characters in a hostname before |
Damien Miller | 51682fa | 2013-10-17 11:48:31 +1100 | [diff] [blame] | 338 | canonicalization is disabled. |
Damien Miller | 607af34 | 2013-10-17 11:47:51 +1100 | [diff] [blame] | 339 | The default, |
| 340 | .Dq 1 , |
| 341 | allows a single dot (i.e. hostname.subdomain). |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 342 | .It Cm CanonicalizePermittedCNAMEs |
Damien Miller | 607af34 | 2013-10-17 11:47:51 +1100 | [diff] [blame] | 343 | Specifies rules to determine whether CNAMEs should be followed when |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 344 | canonicalizing hostnames. |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 345 | The rules consist of one or more arguments of |
Damien Miller | 607af34 | 2013-10-17 11:47:51 +1100 | [diff] [blame] | 346 | .Ar source_domain_list : Ns Ar target_domain_list , |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 347 | where |
| 348 | .Ar source_domain_list |
Damien Miller | 51682fa | 2013-10-17 11:48:31 +1100 | [diff] [blame] | 349 | is a pattern-list of domains that may follow CNAMEs in canonicalization, |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 350 | and |
| 351 | .Ar target_domain_list |
Damien Miller | 607af34 | 2013-10-17 11:47:51 +1100 | [diff] [blame] | 352 | is a pattern-list of domains that they may resolve to. |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 353 | .Pp |
| 354 | For example, |
| 355 | .Dq *.a.example.com:*.b.example.com,*.c.example.com |
| 356 | will allow hostnames matching |
| 357 | .Dq *.a.example.com |
Damien Miller | 3850559 | 2013-10-17 11:48:13 +1100 | [diff] [blame] | 358 | to be canonicalized to names in the |
Damien Miller | 0faf747 | 2013-10-17 11:47:23 +1100 | [diff] [blame] | 359 | .Dq *.b.example.com |
| 360 | or |
| 361 | .Dq *.c.example.com |
| 362 | domains. |
djm@openbsd.org | 4e44a79 | 2015-09-24 06:15:11 +0000 | [diff] [blame] | 363 | .It Cm CertificateFile |
| 364 | Specifies a file from which the user's certificate is read. |
| 365 | A corresponding private key must be provided separately in order |
| 366 | to use this certificate either |
| 367 | from an |
| 368 | .Cm IdentityFile |
| 369 | directive or |
| 370 | .Fl i |
| 371 | flag to |
| 372 | .Xr ssh 1 , |
| 373 | via |
| 374 | .Xr ssh-agent 1 , |
| 375 | or via a |
| 376 | .Cm PKCS11Provider . |
| 377 | .Pp |
| 378 | The file name may use the tilde |
| 379 | syntax to refer to a user's home directory or one of the following |
| 380 | escape characters: |
| 381 | .Ql %d |
| 382 | (local user's home directory), |
| 383 | .Ql %u |
| 384 | (local user name), |
| 385 | .Ql %l |
| 386 | (local host name), |
| 387 | .Ql %h |
| 388 | (remote host name) or |
| 389 | .Ql %r |
| 390 | (remote user name). |
| 391 | .Pp |
| 392 | It is possible to have multiple certificate files specified in |
| 393 | configuration files; these certificates will be tried in sequence. |
| 394 | Multiple |
| 395 | .Cm CertificateFile |
| 396 | directives will add to the list of certificates used for |
| 397 | authentication. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 398 | .It Cm ChallengeResponseAuthentication |
Damien Miller | 1faa713 | 2006-03-15 11:55:31 +1100 | [diff] [blame] | 399 | Specifies whether to use challenge-response authentication. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 400 | The argument to this keyword must be |
| 401 | .Dq yes |
| 402 | or |
| 403 | .Dq no . |
| 404 | The default is |
| 405 | .Dq yes . |
| 406 | .It Cm CheckHostIP |
| 407 | If this flag is set to |
| 408 | .Dq yes , |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 409 | .Xr ssh 1 |
| 410 | will additionally check the host IP address in the |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 411 | .Pa known_hosts |
| 412 | file. |
djm@openbsd.org | 5e67859 | 2015-06-02 09:10:40 +0000 | [diff] [blame] | 413 | This allows ssh to detect if a host key changed due to DNS spoofing |
| 414 | and will add addresses of destination hosts to |
| 415 | .Pa ~/.ssh/known_hosts |
| 416 | in the process, regardless of the setting of |
| 417 | .Cm StrictHostKeyChecking . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 418 | If the option is set to |
| 419 | .Dq no , |
| 420 | the check will not be executed. |
| 421 | The default is |
| 422 | .Dq yes . |
| 423 | .It Cm Cipher |
| 424 | Specifies the cipher to use for encrypting the session |
| 425 | in protocol version 1. |
| 426 | Currently, |
| 427 | .Dq blowfish , |
| 428 | .Dq 3des , |
| 429 | and |
| 430 | .Dq des |
| 431 | are supported. |
| 432 | .Ar des |
| 433 | is only supported in the |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 434 | .Xr ssh 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 435 | client for interoperability with legacy protocol 1 implementations |
| 436 | that do not support the |
| 437 | .Ar 3des |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 438 | cipher. |
| 439 | Its use is strongly discouraged due to cryptographic weaknesses. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 440 | The default is |
| 441 | .Dq 3des . |
| 442 | .It Cm Ciphers |
| 443 | Specifies the ciphers allowed for protocol version 2 |
| 444 | in order of preference. |
| 445 | Multiple ciphers must be comma-separated. |
djm@openbsd.org | f9eca24 | 2015-07-30 00:01:34 +0000 | [diff] [blame] | 446 | If the specified value begins with a |
| 447 | .Sq + |
| 448 | character, then the specified ciphers will be appended to the default set |
| 449 | instead of replacing them. |
| 450 | .Pp |
Damien Miller | 0fde8ac | 2013-11-21 14:12:23 +1100 | [diff] [blame] | 451 | The supported ciphers are: |
| 452 | .Pp |
Damien Miller | c1621c8 | 2014-04-20 13:22:46 +1000 | [diff] [blame] | 453 | .Bl -item -compact -offset indent |
| 454 | .It |
| 455 | 3des-cbc |
| 456 | .It |
| 457 | aes128-cbc |
| 458 | .It |
| 459 | aes192-cbc |
| 460 | .It |
| 461 | aes256-cbc |
| 462 | .It |
| 463 | aes128-ctr |
| 464 | .It |
| 465 | aes192-ctr |
| 466 | .It |
| 467 | aes256-ctr |
| 468 | .It |
| 469 | aes128-gcm@openssh.com |
| 470 | .It |
| 471 | aes256-gcm@openssh.com |
| 472 | .It |
| 473 | arcfour |
| 474 | .It |
| 475 | arcfour128 |
| 476 | .It |
| 477 | arcfour256 |
| 478 | .It |
| 479 | blowfish-cbc |
| 480 | .It |
| 481 | cast128-cbc |
| 482 | .It |
| 483 | chacha20-poly1305@openssh.com |
| 484 | .El |
Damien Miller | 0fde8ac | 2013-11-21 14:12:23 +1100 | [diff] [blame] | 485 | .Pp |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 486 | The default is: |
Damien Miller | c1621c8 | 2014-04-20 13:22:46 +1000 | [diff] [blame] | 487 | .Bd -literal -offset indent |
jmc@openbsd.org | 1f8d3d6 | 2015-08-14 15:32:41 +0000 | [diff] [blame] | 488 | chacha20-poly1305@openssh.com, |
Damien Miller | c1621c8 | 2014-04-20 13:22:46 +1000 | [diff] [blame] | 489 | aes128-ctr,aes192-ctr,aes256-ctr, |
Damien Miller | 1d75abf | 2013-01-09 16:12:19 +1100 | [diff] [blame] | 490 | aes128-gcm@openssh.com,aes256-gcm@openssh.com, |
djm@openbsd.org | e4c918a | 2016-02-11 02:56:32 +0000 | [diff] [blame] | 491 | aes128-cbc,aes192-cbc,aes256-cbc,3des-cbc |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 492 | .Ed |
Damien Miller | 0fde8ac | 2013-11-21 14:12:23 +1100 | [diff] [blame] | 493 | .Pp |
| 494 | The list of available ciphers may also be obtained using the |
| 495 | .Fl Q |
| 496 | option of |
djm@openbsd.org | 8f6784f | 2014-12-22 09:05:17 +0000 | [diff] [blame] | 497 | .Xr ssh 1 |
| 498 | with an argument of |
| 499 | .Dq cipher . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 500 | .It Cm ClearAllForwardings |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 501 | Specifies that all local, remote, and dynamic port forwardings |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 502 | specified in the configuration files or on the command line be |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 503 | cleared. |
| 504 | This option is primarily useful when used from the |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 505 | .Xr ssh 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 506 | command line to clear port forwardings set in |
| 507 | configuration files, and is automatically set by |
| 508 | .Xr scp 1 |
| 509 | and |
| 510 | .Xr sftp 1 . |
| 511 | The argument must be |
| 512 | .Dq yes |
| 513 | or |
| 514 | .Dq no . |
| 515 | The default is |
| 516 | .Dq no . |
| 517 | .It Cm Compression |
| 518 | Specifies whether to use compression. |
| 519 | The argument must be |
| 520 | .Dq yes |
| 521 | or |
| 522 | .Dq no . |
| 523 | The default is |
| 524 | .Dq no . |
| 525 | .It Cm CompressionLevel |
| 526 | Specifies the compression level to use if compression is enabled. |
| 527 | The argument must be an integer from 1 (fast) to 9 (slow, best). |
| 528 | The default level is 6, which is good for most applications. |
| 529 | The meaning of the values is the same as in |
| 530 | .Xr gzip 1 . |
| 531 | Note that this option applies to protocol version 1 only. |
| 532 | .It Cm ConnectionAttempts |
| 533 | Specifies the number of tries (one per second) to make before exiting. |
| 534 | The argument must be an integer. |
| 535 | This may be useful in scripts if the connection sometimes fails. |
| 536 | The default is 1. |
Damien Miller | b78d5eb | 2003-05-16 11:39:04 +1000 | [diff] [blame] | 537 | .It Cm ConnectTimeout |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 538 | Specifies the timeout (in seconds) used when connecting to the |
| 539 | SSH server, instead of using the default system TCP timeout. |
Damien Miller | fbf486b | 2003-05-23 18:44:23 +1000 | [diff] [blame] | 540 | This value is used only when the target is down or really unreachable, |
| 541 | not when it refuses the connection. |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 542 | .It Cm ControlMaster |
| 543 | Enables the sharing of multiple sessions over a single network connection. |
| 544 | When set to |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 545 | .Dq yes , |
| 546 | .Xr ssh 1 |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 547 | will listen for connections on a control socket specified using the |
| 548 | .Cm ControlPath |
| 549 | argument. |
| 550 | Additional sessions can connect to this socket using the same |
| 551 | .Cm ControlPath |
| 552 | with |
| 553 | .Cm ControlMaster |
| 554 | set to |
| 555 | .Dq no |
Damien Miller | 2234bac | 2004-06-30 22:38:52 +1000 | [diff] [blame] | 556 | (the default). |
Damien Miller | 713de76 | 2005-11-05 15:13:49 +1100 | [diff] [blame] | 557 | These sessions will try to reuse the master instance's network connection |
Damien Miller | b3bfbb7 | 2005-11-05 15:11:48 +1100 | [diff] [blame] | 558 | rather than initiating new ones, but will fall back to connecting normally |
| 559 | if the control socket does not exist, or is not listening. |
| 560 | .Pp |
Damien Miller | 23f0770 | 2004-06-18 01:19:03 +1000 | [diff] [blame] | 561 | Setting this to |
| 562 | .Dq ask |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 563 | will cause ssh |
jmc@openbsd.org | 78de167 | 2015-03-30 18:28:37 +0000 | [diff] [blame] | 564 | to listen for control connections, but require confirmation using |
| 565 | .Xr ssh-askpass 1 . |
Damien Miller | dadfd4d | 2005-05-26 12:07:13 +1000 | [diff] [blame] | 566 | If the |
| 567 | .Cm ControlPath |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 568 | cannot be opened, |
| 569 | ssh will continue without connecting to a master instance. |
Damien Miller | d14b1e7 | 2005-06-16 13:19:41 +1000 | [diff] [blame] | 570 | .Pp |
Damien Miller | 1339002 | 2005-07-06 09:44:19 +1000 | [diff] [blame] | 571 | X11 and |
Damien Miller | fd94fba | 2005-07-06 09:44:59 +1000 | [diff] [blame] | 572 | .Xr ssh-agent 1 |
Damien Miller | 1339002 | 2005-07-06 09:44:19 +1000 | [diff] [blame] | 573 | forwarding is supported over these multiplexed connections, however the |
Darren Tucker | 6355187 | 2005-12-20 16:14:15 +1100 | [diff] [blame] | 574 | display and agent forwarded will be the one belonging to the master |
Damien Miller | fd94fba | 2005-07-06 09:44:59 +1000 | [diff] [blame] | 575 | connection i.e. it is not possible to forward multiple displays or agents. |
Damien Miller | 1339002 | 2005-07-06 09:44:19 +1000 | [diff] [blame] | 576 | .Pp |
Damien Miller | d14b1e7 | 2005-06-16 13:19:41 +1000 | [diff] [blame] | 577 | Two additional options allow for opportunistic multiplexing: try to use a |
| 578 | master connection but fall back to creating a new one if one does not already |
| 579 | exist. |
| 580 | These options are: |
| 581 | .Dq auto |
| 582 | and |
| 583 | .Dq autoask . |
| 584 | The latter requires confirmation like the |
| 585 | .Dq ask |
| 586 | option. |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 587 | .It Cm ControlPath |
Damien Miller | 6476cad | 2005-06-16 13:18:34 +1000 | [diff] [blame] | 588 | Specify the path to the control socket used for connection sharing as described |
| 589 | in the |
Damien Miller | 0e220db | 2004-06-15 10:34:08 +1000 | [diff] [blame] | 590 | .Cm ControlMaster |
Damien Miller | 8f74c8f | 2005-06-26 08:56:03 +1000 | [diff] [blame] | 591 | section above or the string |
| 592 | .Dq none |
| 593 | to disable connection sharing. |
Damien Miller | 6476cad | 2005-06-16 13:18:34 +1000 | [diff] [blame] | 594 | In the path, |
Damien Miller | dfc85fa | 2011-05-15 08:44:02 +1000 | [diff] [blame] | 595 | .Ql %L |
| 596 | will be substituted by the first component of the local host name, |
Damien Miller | 3ec54c7 | 2006-03-15 11:30:13 +1100 | [diff] [blame] | 597 | .Ql %l |
Damien Miller | dfc85fa | 2011-05-15 08:44:02 +1000 | [diff] [blame] | 598 | will be substituted by the local host name (including any domain name), |
Damien Miller | 6476cad | 2005-06-16 13:18:34 +1000 | [diff] [blame] | 599 | .Ql %h |
| 600 | will be substituted by the target host name, |
Damien Miller | 486dd2e | 2011-05-15 08:47:18 +1000 | [diff] [blame] | 601 | .Ql %n |
| 602 | will be substituted by the original target host name |
| 603 | specified on the command line, |
Damien Miller | 6476cad | 2005-06-16 13:18:34 +1000 | [diff] [blame] | 604 | .Ql %p |
Damien Miller | 5c86ebd | 2013-10-23 16:29:12 +1100 | [diff] [blame] | 605 | the destination port, |
Damien Miller | 6476cad | 2005-06-16 13:18:34 +1000 | [diff] [blame] | 606 | .Ql %r |
Damien Miller | 9c38643 | 2014-07-03 21:27:46 +1000 | [diff] [blame] | 607 | by the remote login username, |
Damien Miller | dfc85fa | 2011-05-15 08:44:02 +1000 | [diff] [blame] | 608 | .Ql %u |
djm@openbsd.org | 674b3b6 | 2015-09-11 03:47:28 +0000 | [diff] [blame] | 609 | by the username and |
| 610 | .Ql %i |
jmc@openbsd.org | 95923e0 | 2015-09-11 06:51:39 +0000 | [diff] [blame] | 611 | by the numeric user ID (uid) of the user running |
| 612 | .Xr ssh 1 , |
| 613 | and |
Damien Miller | 0f12341 | 2014-07-03 21:28:09 +1000 | [diff] [blame] | 614 | .Ql \&%C |
Damien Miller | 9c38643 | 2014-07-03 21:27:46 +1000 | [diff] [blame] | 615 | by a hash of the concatenation: %l%h%p%r. |
Damien Miller | d14b1e7 | 2005-06-16 13:19:41 +1000 | [diff] [blame] | 616 | It is recommended that any |
| 617 | .Cm ControlPath |
| 618 | used for opportunistic connection sharing include |
djm@openbsd.org | fc30256 | 2014-11-10 22:25:49 +0000 | [diff] [blame] | 619 | at least %h, %p, and %r (or alternatively %C) and be placed in a directory |
| 620 | that is not writable by other users. |
Damien Miller | d14b1e7 | 2005-06-16 13:19:41 +1000 | [diff] [blame] | 621 | This ensures that shared connections are uniquely identified. |
Damien Miller | e11e1ea | 2010-08-03 16:04:46 +1000 | [diff] [blame] | 622 | .It Cm ControlPersist |
| 623 | When used in conjunction with |
| 624 | .Cm ControlMaster , |
| 625 | specifies that the master connection should remain open |
| 626 | in the background (waiting for future client connections) |
| 627 | after the initial client connection has been closed. |
| 628 | If set to |
| 629 | .Dq no , |
| 630 | then the master connection will not be placed into the background, |
| 631 | and will close as soon as the initial client connection is closed. |
| 632 | If set to |
djm@openbsd.org | fc30256 | 2014-11-10 22:25:49 +0000 | [diff] [blame] | 633 | .Dq yes |
| 634 | or |
| 635 | .Dq 0 , |
Damien Miller | e11e1ea | 2010-08-03 16:04:46 +1000 | [diff] [blame] | 636 | then the master connection will remain in the background indefinitely |
| 637 | (until killed or closed via a mechanism such as the |
| 638 | .Xr ssh 1 |
| 639 | .Dq Fl O No exit |
| 640 | option). |
| 641 | If set to a time in seconds, or a time in any of the formats documented in |
| 642 | .Xr sshd_config 5 , |
| 643 | then the backgrounded master connection will automatically terminate |
| 644 | after it has remained idle (with no client connections) for the |
| 645 | specified time. |
Damien Miller | 2234bac | 2004-06-30 22:38:52 +1000 | [diff] [blame] | 646 | .It Cm DynamicForward |
Damien Miller | e9d001e | 2006-01-14 10:10:17 +1100 | [diff] [blame] | 647 | Specifies that a TCP port on the local machine be forwarded |
Damien Miller | 2234bac | 2004-06-30 22:38:52 +1000 | [diff] [blame] | 648 | over the secure channel, and the application |
| 649 | protocol is then used to determine where to connect to from the |
| 650 | remote machine. |
Darren Tucker | c8d6421 | 2005-10-03 18:13:42 +1000 | [diff] [blame] | 651 | .Pp |
| 652 | The argument must be |
| 653 | .Sm off |
| 654 | .Oo Ar bind_address : Oc Ar port . |
| 655 | .Sm on |
Damien Miller | 7fa9660 | 2010-08-05 13:03:13 +1000 | [diff] [blame] | 656 | IPv6 addresses can be specified by enclosing addresses in square brackets. |
Darren Tucker | c8d6421 | 2005-10-03 18:13:42 +1000 | [diff] [blame] | 657 | By default, the local port is bound in accordance with the |
| 658 | .Cm GatewayPorts |
| 659 | setting. |
| 660 | However, an explicit |
| 661 | .Ar bind_address |
| 662 | may be used to bind the connection to a specific address. |
| 663 | The |
| 664 | .Ar bind_address |
| 665 | of |
| 666 | .Dq localhost |
| 667 | indicates that the listening port be bound for local use only, while an |
| 668 | empty address or |
| 669 | .Sq * |
| 670 | indicates that the port should be available from all interfaces. |
| 671 | .Pp |
Damien Miller | 2234bac | 2004-06-30 22:38:52 +1000 | [diff] [blame] | 672 | Currently the SOCKS4 and SOCKS5 protocols are supported, and |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 673 | .Xr ssh 1 |
Damien Miller | 2234bac | 2004-06-30 22:38:52 +1000 | [diff] [blame] | 674 | will act as a SOCKS server. |
| 675 | Multiple forwardings may be specified, and |
| 676 | additional forwardings can be given on the command line. |
| 677 | Only the superuser can forward privileged ports. |
Darren Tucker | 674f71d | 2003-06-28 12:33:12 +1000 | [diff] [blame] | 678 | .It Cm EnableSSHKeysign |
| 679 | Setting this option to |
| 680 | .Dq yes |
| 681 | in the global client configuration file |
| 682 | .Pa /etc/ssh/ssh_config |
| 683 | enables the use of the helper program |
| 684 | .Xr ssh-keysign 8 |
| 685 | during |
| 686 | .Cm HostbasedAuthentication . |
| 687 | The argument must be |
| 688 | .Dq yes |
| 689 | or |
| 690 | .Dq no . |
| 691 | The default is |
| 692 | .Dq no . |
Darren Tucker | f132c67 | 2003-10-15 15:58:18 +1000 | [diff] [blame] | 693 | This option should be placed in the non-hostspecific section. |
Darren Tucker | 674f71d | 2003-06-28 12:33:12 +1000 | [diff] [blame] | 694 | See |
| 695 | .Xr ssh-keysign 8 |
| 696 | for more information. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 697 | .It Cm EscapeChar |
| 698 | Sets the escape character (default: |
| 699 | .Ql ~ ) . |
| 700 | The escape character can also |
| 701 | be set on the command line. |
| 702 | The argument should be a single character, |
| 703 | .Ql ^ |
| 704 | followed by a letter, or |
| 705 | .Dq none |
| 706 | to disable the escape |
| 707 | character entirely (making the connection transparent for binary |
| 708 | data). |
Darren Tucker | e7d4b19 | 2006-07-12 22:17:10 +1000 | [diff] [blame] | 709 | .It Cm ExitOnForwardFailure |
| 710 | Specifies whether |
| 711 | .Xr ssh 1 |
| 712 | should terminate the connection if it cannot set up all requested |
djm@openbsd.org | a954cdb | 2015-09-04 04:47:50 +0000 | [diff] [blame] | 713 | dynamic, tunnel, local, and remote port forwardings, (e.g.\& |
jmc@openbsd.org | 5245bc1 | 2015-09-04 06:40:45 +0000 | [diff] [blame] | 714 | if either end is unable to bind and listen on a specified port). |
djm@openbsd.org | a954cdb | 2015-09-04 04:47:50 +0000 | [diff] [blame] | 715 | Note that |
| 716 | .Cm ExitOnForwardFailure |
| 717 | does not apply to connections made over port forwardings and will not, |
| 718 | for example, cause |
| 719 | .Xr ssh 1 |
| 720 | to exit if TCP connections to the ultimate forwarding destination fail. |
Darren Tucker | e7d4b19 | 2006-07-12 22:17:10 +1000 | [diff] [blame] | 721 | The argument must be |
| 722 | .Dq yes |
| 723 | or |
| 724 | .Dq no . |
| 725 | The default is |
| 726 | .Dq no . |
djm@openbsd.org | b79efde | 2014-12-21 23:12:42 +0000 | [diff] [blame] | 727 | .It Cm FingerprintHash |
| 728 | Specifies the hash algorithm used when displaying key fingerprints. |
| 729 | Valid options are: |
| 730 | .Dq md5 |
| 731 | and |
| 732 | .Dq sha256 . |
djm@openbsd.org | b79efde | 2014-12-21 23:12:42 +0000 | [diff] [blame] | 733 | The default is |
| 734 | .Dq sha256 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 735 | .It Cm ForwardAgent |
| 736 | Specifies whether the connection to the authentication agent (if any) |
| 737 | will be forwarded to the remote machine. |
| 738 | The argument must be |
| 739 | .Dq yes |
| 740 | or |
| 741 | .Dq no . |
| 742 | The default is |
| 743 | .Dq no . |
Damien Miller | af65304 | 2002-09-04 16:40:37 +1000 | [diff] [blame] | 744 | .Pp |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 745 | Agent forwarding should be enabled with caution. |
| 746 | Users with the ability to bypass file permissions on the remote host |
| 747 | (for the agent's Unix-domain socket) |
| 748 | can access the local agent through the forwarded connection. |
| 749 | An attacker cannot obtain key material from the agent, |
Damien Miller | af65304 | 2002-09-04 16:40:37 +1000 | [diff] [blame] | 750 | however they can perform operations on the keys that enable them to |
| 751 | authenticate using the identities loaded into the agent. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 752 | .It Cm ForwardX11 |
| 753 | Specifies whether X11 connections will be automatically redirected |
| 754 | over the secure channel and |
| 755 | .Ev DISPLAY |
| 756 | set. |
| 757 | The argument must be |
| 758 | .Dq yes |
| 759 | or |
| 760 | .Dq no . |
| 761 | The default is |
| 762 | .Dq no . |
Damien Miller | af65304 | 2002-09-04 16:40:37 +1000 | [diff] [blame] | 763 | .Pp |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 764 | X11 forwarding should be enabled with caution. |
| 765 | Users with the ability to bypass file permissions on the remote host |
Darren Tucker | 0a118da | 2003-10-15 15:54:32 +1000 | [diff] [blame] | 766 | (for the user's X11 authorization database) |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 767 | can access the local X11 display through the forwarded connection. |
Darren Tucker | 0a118da | 2003-10-15 15:54:32 +1000 | [diff] [blame] | 768 | An attacker may then be able to perform activities such as keystroke monitoring |
| 769 | if the |
| 770 | .Cm ForwardX11Trusted |
| 771 | option is also enabled. |
Damien Miller | 1ab6a51 | 2010-06-26 10:02:24 +1000 | [diff] [blame] | 772 | .It Cm ForwardX11Timeout |
Damien Miller | cede1db | 2010-07-02 13:33:48 +1000 | [diff] [blame] | 773 | Specify a timeout for untrusted X11 forwarding |
| 774 | using the format described in the |
Damien Miller | fecfd11 | 2013-07-18 16:11:50 +1000 | [diff] [blame] | 775 | TIME FORMATS section of |
Damien Miller | 1ab6a51 | 2010-06-26 10:02:24 +1000 | [diff] [blame] | 776 | .Xr sshd_config 5 . |
| 777 | X11 connections received by |
| 778 | .Xr ssh 1 |
| 779 | after this time will be refused. |
| 780 | The default is to disable untrusted X11 forwarding after twenty minutes has |
| 781 | elapsed. |
Darren Tucker | 0a118da | 2003-10-15 15:54:32 +1000 | [diff] [blame] | 782 | .It Cm ForwardX11Trusted |
Darren Tucker | dcf6ec4 | 2004-05-13 13:03:56 +1000 | [diff] [blame] | 783 | If this option is set to |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 784 | .Dq yes , |
| 785 | remote X11 clients will have full access to the original X11 display. |
Damien Miller | 1717fd4 | 2005-03-01 21:17:31 +1100 | [diff] [blame] | 786 | .Pp |
Darren Tucker | 0a118da | 2003-10-15 15:54:32 +1000 | [diff] [blame] | 787 | If this option is set to |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 788 | .Dq no , |
| 789 | remote X11 clients will be considered untrusted and prevented |
Darren Tucker | 0a118da | 2003-10-15 15:54:32 +1000 | [diff] [blame] | 790 | from stealing or tampering with data belonging to trusted X11 |
| 791 | clients. |
Damien Miller | 1717fd4 | 2005-03-01 21:17:31 +1100 | [diff] [blame] | 792 | Furthermore, the |
| 793 | .Xr xauth 1 |
| 794 | token used for the session will be set to expire after 20 minutes. |
| 795 | Remote clients will be refused access after this time. |
Darren Tucker | 0a118da | 2003-10-15 15:54:32 +1000 | [diff] [blame] | 796 | .Pp |
| 797 | The default is |
| 798 | .Dq no . |
| 799 | .Pp |
| 800 | See the X11 SECURITY extension specification for full details on |
| 801 | the restrictions imposed on untrusted clients. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 802 | .It Cm GatewayPorts |
| 803 | Specifies whether remote hosts are allowed to connect to local |
| 804 | forwarded ports. |
| 805 | By default, |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 806 | .Xr ssh 1 |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 807 | binds local port forwardings to the loopback address. |
| 808 | This prevents other remote hosts from connecting to forwarded ports. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 809 | .Cm GatewayPorts |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 810 | can be used to specify that ssh |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 811 | should bind local port forwardings to the wildcard address, |
| 812 | thus allowing remote hosts to connect to forwarded ports. |
| 813 | The argument must be |
| 814 | .Dq yes |
| 815 | or |
| 816 | .Dq no . |
| 817 | The default is |
| 818 | .Dq no . |
| 819 | .It Cm GlobalKnownHostsFile |
Damien Miller | 295ee63 | 2011-05-29 21:42:31 +1000 | [diff] [blame] | 820 | Specifies one or more files to use for the global |
| 821 | host key database, separated by whitespace. |
| 822 | The default is |
| 823 | .Pa /etc/ssh/ssh_known_hosts , |
| 824 | .Pa /etc/ssh/ssh_known_hosts2 . |
Darren Tucker | 0efd155 | 2003-08-26 11:49:55 +1000 | [diff] [blame] | 825 | .It Cm GSSAPIAuthentication |
Damien Miller | baafb98 | 2003-12-17 16:32:23 +1100 | [diff] [blame] | 826 | Specifies whether user authentication based on GSSAPI is allowed. |
Damien Miller | c2b9827 | 2003-09-03 12:13:30 +1000 | [diff] [blame] | 827 | The default is |
Darren Tucker | a044f47 | 2003-10-15 15:52:03 +1000 | [diff] [blame] | 828 | .Dq no . |
Darren Tucker | 0efd155 | 2003-08-26 11:49:55 +1000 | [diff] [blame] | 829 | .It Cm GSSAPIDelegateCredentials |
| 830 | Forward (delegate) credentials to the server. |
| 831 | The default is |
| 832 | .Dq no . |
Damien Miller | e177615 | 2005-03-01 21:47:37 +1100 | [diff] [blame] | 833 | .It Cm HashKnownHosts |
| 834 | Indicates that |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 835 | .Xr ssh 1 |
Damien Miller | e177615 | 2005-03-01 21:47:37 +1100 | [diff] [blame] | 836 | should hash host names and addresses when they are added to |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 837 | .Pa ~/.ssh/known_hosts . |
Damien Miller | e177615 | 2005-03-01 21:47:37 +1100 | [diff] [blame] | 838 | These hashed names may be used normally by |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 839 | .Xr ssh 1 |
Damien Miller | e177615 | 2005-03-01 21:47:37 +1100 | [diff] [blame] | 840 | and |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 841 | .Xr sshd 8 , |
Damien Miller | e177615 | 2005-03-01 21:47:37 +1100 | [diff] [blame] | 842 | but they do not reveal identifying information should the file's contents |
| 843 | be disclosed. |
| 844 | The default is |
| 845 | .Dq no . |
Damien Miller | 858bb7d | 2006-08-05 11:34:51 +1000 | [diff] [blame] | 846 | Note that existing names and addresses in known hosts files |
| 847 | will not be converted automatically, |
| 848 | but may be manually hashed using |
Damien Miller | 4b42d7f | 2005-03-01 21:48:35 +1100 | [diff] [blame] | 849 | .Xr ssh-keygen 1 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 850 | .It Cm HostbasedAuthentication |
| 851 | Specifies whether to try rhosts based authentication with public key |
| 852 | authentication. |
| 853 | The argument must be |
| 854 | .Dq yes |
| 855 | or |
| 856 | .Dq no . |
| 857 | The default is |
| 858 | .Dq no . |
djm@openbsd.org | 46347ed | 2015-01-30 11:43:14 +0000 | [diff] [blame] | 859 | .It Cm HostbasedKeyTypes |
| 860 | Specifies the key types that will be used for hostbased authentication |
| 861 | as a comma-separated pattern list. |
djm@openbsd.org | f9eca24 | 2015-07-30 00:01:34 +0000 | [diff] [blame] | 862 | Alternately if the specified value begins with a |
| 863 | .Sq + |
| 864 | character, then the specified key types will be appended to the default set |
| 865 | instead of replacing them. |
markus@openbsd.org | 3a1638d | 2015-07-10 06:21:53 +0000 | [diff] [blame] | 866 | The default for this option is: |
| 867 | .Bd -literal -offset 3n |
| 868 | ecdsa-sha2-nistp256-cert-v01@openssh.com, |
| 869 | ecdsa-sha2-nistp384-cert-v01@openssh.com, |
| 870 | ecdsa-sha2-nistp521-cert-v01@openssh.com, |
| 871 | ssh-ed25519-cert-v01@openssh.com, |
| 872 | ssh-rsa-cert-v01@openssh.com, |
| 873 | ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, |
djm@openbsd.org | 3a13cb5 | 2016-02-17 08:57:34 +0000 | [diff] [blame] | 874 | ssh-ed25519,ssh-rsa |
markus@openbsd.org | 3a1638d | 2015-07-10 06:21:53 +0000 | [diff] [blame] | 875 | .Ed |
| 876 | .Pp |
djm@openbsd.org | 46347ed | 2015-01-30 11:43:14 +0000 | [diff] [blame] | 877 | The |
| 878 | .Fl Q |
| 879 | option of |
| 880 | .Xr ssh 1 |
| 881 | may be used to list supported key types. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 882 | .It Cm HostKeyAlgorithms |
jmc@openbsd.org | a685ae8 | 2016-02-17 07:38:19 +0000 | [diff] [blame] | 883 | Specifies the host key algorithms |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 884 | that the client wants to use in order of preference. |
djm@openbsd.org | f9eca24 | 2015-07-30 00:01:34 +0000 | [diff] [blame] | 885 | Alternately if the specified value begins with a |
| 886 | .Sq + |
| 887 | character, then the specified key types will be appended to the default set |
| 888 | instead of replacing them. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 889 | The default for this option is: |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 890 | .Bd -literal -offset 3n |
| 891 | ecdsa-sha2-nistp256-cert-v01@openssh.com, |
| 892 | ecdsa-sha2-nistp384-cert-v01@openssh.com, |
| 893 | ecdsa-sha2-nistp521-cert-v01@openssh.com, |
Damien Miller | 8ba0ead | 2013-12-18 17:46:27 +1100 | [diff] [blame] | 894 | ssh-ed25519-cert-v01@openssh.com, |
markus@openbsd.org | 3a1638d | 2015-07-10 06:21:53 +0000 | [diff] [blame] | 895 | ssh-rsa-cert-v01@openssh.com, |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 896 | ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, |
djm@openbsd.org | 3a13cb5 | 2016-02-17 08:57:34 +0000 | [diff] [blame] | 897 | ssh-ed25519,ssh-rsa |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 898 | .Ed |
Damien Miller | d925dcd | 2010-12-01 12:21:51 +1100 | [diff] [blame] | 899 | .Pp |
| 900 | If hostkeys are known for the destination host then this default is modified |
| 901 | to prefer their algorithms. |
djm@openbsd.org | 8f6784f | 2014-12-22 09:05:17 +0000 | [diff] [blame] | 902 | .Pp |
| 903 | The list of available key types may also be obtained using the |
| 904 | .Fl Q |
| 905 | option of |
| 906 | .Xr ssh 1 |
| 907 | with an argument of |
| 908 | .Dq key . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 909 | .It Cm HostKeyAlias |
| 910 | Specifies an alias that should be used instead of the |
| 911 | real host name when looking up or saving the host key |
| 912 | in the host key database files. |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 913 | This option is useful for tunneling SSH connections |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 914 | or for multiple servers running on a single host. |
| 915 | .It Cm HostName |
| 916 | Specifies the real host name to log into. |
| 917 | This can be used to specify nicknames or abbreviations for hosts. |
Damien Miller | d0244d4 | 2010-07-16 13:56:43 +1000 | [diff] [blame] | 918 | If the hostname contains the character sequence |
| 919 | .Ql %h , |
Damien Miller | 486dd2e | 2011-05-15 08:47:18 +1000 | [diff] [blame] | 920 | then this will be replaced with the host name specified on the command line |
Damien Miller | d0244d4 | 2010-07-16 13:56:43 +1000 | [diff] [blame] | 921 | (this is useful for manipulating unqualified names). |
Damien Miller | ef9f13b | 2014-07-03 21:26:21 +1000 | [diff] [blame] | 922 | The character sequence |
| 923 | .Ql %% |
| 924 | will be replaced by a single |
| 925 | .Ql % |
| 926 | character, which may be used when specifying IPv6 link-local addresses. |
| 927 | .Pp |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 928 | The default is the name given on the command line. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 929 | Numeric IP addresses are also permitted (both on the command line and in |
| 930 | .Cm HostName |
| 931 | specifications). |
Damien Miller | bd394c3 | 2004-03-08 23:12:36 +1100 | [diff] [blame] | 932 | .It Cm IdentitiesOnly |
| 933 | Specifies that |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 934 | .Xr ssh 1 |
djm@openbsd.org | 4e44a79 | 2015-09-24 06:15:11 +0000 | [diff] [blame] | 935 | should only use the authentication identity and certificate files explicitly |
| 936 | configured in the |
Damien Miller | 1a81258 | 2004-04-20 20:13:32 +1000 | [diff] [blame] | 937 | .Nm |
djm@openbsd.org | 4e44a79 | 2015-09-24 06:15:11 +0000 | [diff] [blame] | 938 | files |
| 939 | or passed on the |
| 940 | .Xr ssh 1 |
| 941 | command-line, |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 942 | even if |
| 943 | .Xr ssh-agent 1 |
Damien Miller | cb6b68b | 2012-12-03 09:49:52 +1100 | [diff] [blame] | 944 | or a |
| 945 | .Cm PKCS11Provider |
Damien Miller | bd394c3 | 2004-03-08 23:12:36 +1100 | [diff] [blame] | 946 | offers more identities. |
| 947 | The argument to this keyword must be |
| 948 | .Dq yes |
| 949 | or |
| 950 | .Dq no . |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 951 | This option is intended for situations where ssh-agent |
Damien Miller | bd394c3 | 2004-03-08 23:12:36 +1100 | [diff] [blame] | 952 | offers many different identities. |
| 953 | The default is |
| 954 | .Dq no . |
markus@openbsd.org | b02ad1c | 2016-05-04 12:21:53 +0000 | [diff] [blame] | 955 | .It Cm IdentityAgent |
| 956 | Specifies the |
| 957 | .Ux Ns -domain |
| 958 | socket used to communicate with the authentication agent. |
| 959 | .Pp |
| 960 | This option overrides the |
| 961 | .Dq SSH_AUTH_SOCK |
| 962 | environment variable and can be used to select a specific agent. |
| 963 | Setting the socket name to |
| 964 | .Dq none |
| 965 | disables the use of an authentication agent. |
| 966 | .Pp |
| 967 | The socket name may use the tilde |
| 968 | syntax to refer to a user's home directory or one of the following |
| 969 | escape characters: |
| 970 | .Ql %d |
| 971 | (local user's home directory), |
| 972 | .Ql %u |
| 973 | (local user name), |
| 974 | .Ql %l |
| 975 | (local host name), |
| 976 | .Ql %h |
| 977 | (remote host name) or |
| 978 | .Ql %r |
| 979 | (remote user name). |
Damien Miller | 957d4e4 | 2005-12-13 19:30:45 +1100 | [diff] [blame] | 980 | .It Cm IdentityFile |
sobrado@openbsd.org | f70b22b | 2014-08-30 15:33:50 +0000 | [diff] [blame] | 981 | Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 982 | identity is read. |
Damien Miller | 957d4e4 | 2005-12-13 19:30:45 +1100 | [diff] [blame] | 983 | The default is |
| 984 | .Pa ~/.ssh/identity |
| 985 | for protocol version 1, and |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 986 | .Pa ~/.ssh/id_dsa , |
Damien Miller | 8ba0ead | 2013-12-18 17:46:27 +1100 | [diff] [blame] | 987 | .Pa ~/.ssh/id_ecdsa , |
| 988 | .Pa ~/.ssh/id_ed25519 |
Damien Miller | 957d4e4 | 2005-12-13 19:30:45 +1100 | [diff] [blame] | 989 | and |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 990 | .Pa ~/.ssh/id_rsa |
Damien Miller | 957d4e4 | 2005-12-13 19:30:45 +1100 | [diff] [blame] | 991 | for protocol version 2. |
| 992 | Additionally, any identities represented by the authentication agent |
Damien Miller | 7f2b438 | 2013-07-18 16:10:29 +1000 | [diff] [blame] | 993 | will be used for authentication unless |
| 994 | .Cm IdentitiesOnly |
| 995 | is set. |
djm@openbsd.org | 4e44a79 | 2015-09-24 06:15:11 +0000 | [diff] [blame] | 996 | If no certificates have been explicitly specified by |
| 997 | .Cm CertificateFile , |
Damien Miller | 5059d8d | 2010-03-05 21:31:11 +1100 | [diff] [blame] | 998 | .Xr ssh 1 |
| 999 | will try to load certificate information from the filename obtained by |
| 1000 | appending |
| 1001 | .Pa -cert.pub |
| 1002 | to the path of a specified |
| 1003 | .Cm IdentityFile . |
Damien Miller | 6b1d53c | 2006-03-31 23:13:21 +1100 | [diff] [blame] | 1004 | .Pp |
Damien Miller | 957d4e4 | 2005-12-13 19:30:45 +1100 | [diff] [blame] | 1005 | The file name may use the tilde |
Damien Miller | c6437cf | 2006-03-31 23:14:41 +1100 | [diff] [blame] | 1006 | syntax to refer to a user's home directory or one of the following |
Damien Miller | 6b1d53c | 2006-03-31 23:13:21 +1100 | [diff] [blame] | 1007 | escape characters: |
| 1008 | .Ql %d |
| 1009 | (local user's home directory), |
| 1010 | .Ql %u |
| 1011 | (local user name), |
| 1012 | .Ql %l |
| 1013 | (local host name), |
| 1014 | .Ql %h |
| 1015 | (remote host name) or |
Damien Miller | dfc6183 | 2006-03-31 23:14:57 +1100 | [diff] [blame] | 1016 | .Ql %r |
Damien Miller | 6b1d53c | 2006-03-31 23:13:21 +1100 | [diff] [blame] | 1017 | (remote user name). |
| 1018 | .Pp |
Damien Miller | 957d4e4 | 2005-12-13 19:30:45 +1100 | [diff] [blame] | 1019 | It is possible to have |
| 1020 | multiple identity files specified in configuration files; all these |
| 1021 | identities will be tried in sequence. |
Damien Miller | 6029e07 | 2011-06-20 14:22:49 +1000 | [diff] [blame] | 1022 | Multiple |
| 1023 | .Cm IdentityFile |
| 1024 | directives will add to the list of identities tried (this behaviour |
| 1025 | differs from that of other configuration directives). |
Damien Miller | 7f2b438 | 2013-07-18 16:10:29 +1000 | [diff] [blame] | 1026 | .Pp |
| 1027 | .Cm IdentityFile |
| 1028 | may be used in conjunction with |
| 1029 | .Cm IdentitiesOnly |
| 1030 | to select which identities in an agent are offered during authentication. |
djm@openbsd.org | 4e44a79 | 2015-09-24 06:15:11 +0000 | [diff] [blame] | 1031 | .Cm IdentityFile |
| 1032 | may also be used in conjunction with |
| 1033 | .Cm CertificateFile |
| 1034 | in order to provide any certificate also needed for authentication with |
| 1035 | the identity. |
Darren Tucker | 63e0df2 | 2013-05-16 20:30:31 +1000 | [diff] [blame] | 1036 | .It Cm IgnoreUnknown |
| 1037 | Specifies a pattern-list of unknown options to be ignored if they are |
| 1038 | encountered in configuration parsing. |
| 1039 | This may be used to suppress errors if |
| 1040 | .Nm |
| 1041 | contains options that are unrecognised by |
| 1042 | .Xr ssh 1 . |
| 1043 | It is recommended that |
| 1044 | .Cm IgnoreUnknown |
| 1045 | be listed early in the configuration file as it will not be applied |
| 1046 | to unknown options that appear before it. |
djm@openbsd.org | dc7990b | 2016-04-15 00:30:19 +0000 | [diff] [blame] | 1047 | .It Cm Include |
| 1048 | Include the specified configuration file(s). |
jmc@openbsd.org | 6aaabc2 | 2016-04-17 14:34:46 +0000 | [diff] [blame] | 1049 | Multiple pathnames may be specified and each pathname may contain |
djm@openbsd.org | dc7990b | 2016-04-15 00:30:19 +0000 | [diff] [blame] | 1050 | .Xr glob 3 |
| 1051 | wildcards and, for user configurations, shell-like |
| 1052 | .Dq ~ |
| 1053 | references to user home directories. |
| 1054 | Files without absolute paths are assumed to be in |
| 1055 | .Pa ~/.ssh |
jmc@openbsd.org | 6aaabc2 | 2016-04-17 14:34:46 +0000 | [diff] [blame] | 1056 | if included in a user configuration file or |
djm@openbsd.org | dc7990b | 2016-04-15 00:30:19 +0000 | [diff] [blame] | 1057 | .Pa /etc/ssh |
| 1058 | if included from the system configuration file. |
| 1059 | .Cm Include |
| 1060 | directive may appear inside a |
| 1061 | .Cm Match |
| 1062 | or |
| 1063 | .Cm Host |
| 1064 | block |
| 1065 | to perform conditional inclusion. |
Damien Miller | 0dac6fb | 2010-11-20 15:19:38 +1100 | [diff] [blame] | 1066 | .It Cm IPQoS |
| 1067 | Specifies the IPv4 type-of-service or DSCP class for connections. |
| 1068 | Accepted values are |
| 1069 | .Dq af11 , |
| 1070 | .Dq af12 , |
| 1071 | .Dq af13 , |
Damien Miller | f6e758c | 2011-09-22 21:37:13 +1000 | [diff] [blame] | 1072 | .Dq af21 , |
Damien Miller | 0dac6fb | 2010-11-20 15:19:38 +1100 | [diff] [blame] | 1073 | .Dq af22 , |
| 1074 | .Dq af23 , |
| 1075 | .Dq af31 , |
| 1076 | .Dq af32 , |
| 1077 | .Dq af33 , |
| 1078 | .Dq af41 , |
| 1079 | .Dq af42 , |
| 1080 | .Dq af43 , |
| 1081 | .Dq cs0 , |
| 1082 | .Dq cs1 , |
| 1083 | .Dq cs2 , |
| 1084 | .Dq cs3 , |
| 1085 | .Dq cs4 , |
| 1086 | .Dq cs5 , |
| 1087 | .Dq cs6 , |
| 1088 | .Dq cs7 , |
| 1089 | .Dq ef , |
| 1090 | .Dq lowdelay , |
| 1091 | .Dq throughput , |
| 1092 | .Dq reliability , |
| 1093 | or a numeric value. |
Damien Miller | 928362d | 2010-12-26 14:26:45 +1100 | [diff] [blame] | 1094 | This option may take one or two arguments, separated by whitespace. |
Damien Miller | 0dac6fb | 2010-11-20 15:19:38 +1100 | [diff] [blame] | 1095 | If one argument is specified, it is used as the packet class unconditionally. |
| 1096 | If two values are specified, the first is automatically selected for |
| 1097 | interactive sessions and the second for non-interactive sessions. |
| 1098 | The default is |
| 1099 | .Dq lowdelay |
| 1100 | for interactive sessions and |
| 1101 | .Dq throughput |
| 1102 | for non-interactive sessions. |
Damien Miller | cfb606c | 2007-10-26 14:24:48 +1000 | [diff] [blame] | 1103 | .It Cm KbdInteractiveAuthentication |
| 1104 | Specifies whether to use keyboard-interactive authentication. |
| 1105 | The argument to this keyword must be |
| 1106 | .Dq yes |
| 1107 | or |
| 1108 | .Dq no . |
| 1109 | The default is |
| 1110 | .Dq yes . |
Darren Tucker | 636ca90 | 2004-11-05 20:22:00 +1100 | [diff] [blame] | 1111 | .It Cm KbdInteractiveDevices |
| 1112 | Specifies the list of methods to use in keyboard-interactive authentication. |
| 1113 | Multiple method names must be comma-separated. |
| 1114 | The default is to use the server specified list. |
Damien Miller | 9cfbaec | 2006-03-15 11:57:55 +1100 | [diff] [blame] | 1115 | The methods available vary depending on what the server supports. |
| 1116 | For an OpenSSH server, |
| 1117 | it may be zero or more of: |
| 1118 | .Dq bsdauth , |
| 1119 | .Dq pam , |
| 1120 | and |
| 1121 | .Dq skey . |
Damien Miller | d5f62bf | 2010-09-24 22:11:14 +1000 | [diff] [blame] | 1122 | .It Cm KexAlgorithms |
| 1123 | Specifies the available KEX (Key Exchange) algorithms. |
| 1124 | Multiple algorithms must be comma-separated. |
djm@openbsd.org | f9eca24 | 2015-07-30 00:01:34 +0000 | [diff] [blame] | 1125 | Alternately if the specified value begins with a |
| 1126 | .Sq + |
| 1127 | character, then the specified methods will be appended to the default set |
| 1128 | instead of replacing them. |
Damien Miller | 7fe2b1f | 2010-09-24 22:11:53 +1000 | [diff] [blame] | 1129 | The default is: |
| 1130 | .Bd -literal -offset indent |
Damien Miller | 0bd8f15 | 2013-11-04 08:55:43 +1100 | [diff] [blame] | 1131 | curve25519-sha256@libssh.org, |
Damien Miller | 7fe2b1f | 2010-09-24 22:11:53 +1000 | [diff] [blame] | 1132 | ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521, |
| 1133 | diffie-hellman-group-exchange-sha256, |
Damien Miller | c1621c8 | 2014-04-20 13:22:46 +1000 | [diff] [blame] | 1134 | diffie-hellman-group-exchange-sha1, |
djm@openbsd.org | bdfd29f | 2015-07-03 03:47:00 +0000 | [diff] [blame] | 1135 | diffie-hellman-group14-sha1 |
Damien Miller | 7fe2b1f | 2010-09-24 22:11:53 +1000 | [diff] [blame] | 1136 | .Ed |
djm@openbsd.org | 8f6784f | 2014-12-22 09:05:17 +0000 | [diff] [blame] | 1137 | .Pp |
| 1138 | The list of available key exchange algorithms may also be obtained using the |
| 1139 | .Fl Q |
| 1140 | option of |
| 1141 | .Xr ssh 1 |
| 1142 | with an argument of |
| 1143 | .Dq kex . |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1144 | .It Cm LocalCommand |
| 1145 | Specifies a command to execute on the local machine after successfully |
| 1146 | connecting to the server. |
| 1147 | The command string extends to the end of the line, and is executed with |
Darren Tucker | 63b31cb | 2007-12-02 23:09:30 +1100 | [diff] [blame] | 1148 | the user's shell. |
Darren Tucker | f6b01b7 | 2008-06-13 04:56:37 +1000 | [diff] [blame] | 1149 | The following escape character substitutions will be performed: |
| 1150 | .Ql %d |
| 1151 | (local user's home directory), |
| 1152 | .Ql %h |
| 1153 | (remote host name), |
| 1154 | .Ql %l |
| 1155 | (local host name), |
| 1156 | .Ql %n |
| 1157 | (host name as provided on the command line), |
| 1158 | .Ql %p |
| 1159 | (remote port), |
| 1160 | .Ql %r |
| 1161 | (remote user name) or |
| 1162 | .Ql %u |
Damien Miller | 9c38643 | 2014-07-03 21:27:46 +1000 | [diff] [blame] | 1163 | (local user name) or |
Damien Miller | 0f12341 | 2014-07-03 21:28:09 +1000 | [diff] [blame] | 1164 | .Ql \&%C |
Damien Miller | 9c38643 | 2014-07-03 21:27:46 +1000 | [diff] [blame] | 1165 | by a hash of the concatenation: %l%h%p%r. |
Darren Tucker | 78be8c5 | 2010-01-08 17:05:59 +1100 | [diff] [blame] | 1166 | .Pp |
| 1167 | The command is run synchronously and does not have access to the |
| 1168 | session of the |
| 1169 | .Xr ssh 1 |
| 1170 | that spawned it. |
| 1171 | It should not be used for interactive commands. |
| 1172 | .Pp |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1173 | This directive is ignored unless |
| 1174 | .Cm PermitLocalCommand |
| 1175 | has been enabled. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1176 | .It Cm LocalForward |
Damien Miller | e9d001e | 2006-01-14 10:10:17 +1100 | [diff] [blame] | 1177 | Specifies that a TCP port on the local machine be forwarded over |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1178 | the secure channel to the specified host and port from the remote machine. |
Darren Tucker | 5ede2ad | 2005-03-31 21:31:10 +1000 | [diff] [blame] | 1179 | The first argument must be |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 1180 | .Sm off |
Darren Tucker | 5ede2ad | 2005-03-31 21:31:10 +1000 | [diff] [blame] | 1181 | .Oo Ar bind_address : Oc Ar port |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 1182 | .Sm on |
Darren Tucker | 5ede2ad | 2005-03-31 21:31:10 +1000 | [diff] [blame] | 1183 | and the second argument must be |
| 1184 | .Ar host : Ns Ar hostport . |
Damien Miller | 7fa9660 | 2010-08-05 13:03:13 +1000 | [diff] [blame] | 1185 | IPv6 addresses can be specified by enclosing addresses in square brackets. |
Damien Miller | f8c5546 | 2005-03-02 12:03:05 +1100 | [diff] [blame] | 1186 | Multiple forwardings may be specified, and additional forwardings can be |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 1187 | given on the command line. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1188 | Only the superuser can forward privileged ports. |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 1189 | By default, the local port is bound in accordance with the |
| 1190 | .Cm GatewayPorts |
| 1191 | setting. |
| 1192 | However, an explicit |
| 1193 | .Ar bind_address |
| 1194 | may be used to bind the connection to a specific address. |
| 1195 | The |
| 1196 | .Ar bind_address |
| 1197 | of |
| 1198 | .Dq localhost |
Damien Miller | f8c5546 | 2005-03-02 12:03:05 +1100 | [diff] [blame] | 1199 | indicates that the listening port be bound for local use only, while an |
| 1200 | empty address or |
| 1201 | .Sq * |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 1202 | indicates that the port should be available from all interfaces. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1203 | .It Cm LogLevel |
| 1204 | Gives the verbosity level that is used when logging messages from |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1205 | .Xr ssh 1 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1206 | The possible values are: |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1207 | QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3. |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 1208 | The default is INFO. |
| 1209 | DEBUG and DEBUG1 are equivalent. |
| 1210 | DEBUG2 and DEBUG3 each specify higher levels of verbose output. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1211 | .It Cm MACs |
| 1212 | Specifies the MAC (message authentication code) algorithms |
| 1213 | in order of preference. |
jmc@openbsd.org | a685ae8 | 2016-02-17 07:38:19 +0000 | [diff] [blame] | 1214 | The MAC algorithm is used for data integrity protection. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1215 | Multiple algorithms must be comma-separated. |
djm@openbsd.org | f9eca24 | 2015-07-30 00:01:34 +0000 | [diff] [blame] | 1216 | If the specified value begins with a |
| 1217 | .Sq + |
| 1218 | character, then the specified algorithms will be appended to the default set |
| 1219 | instead of replacing them. |
| 1220 | .Pp |
Damien Miller | af43a7a | 2012-12-12 10:46:31 +1100 | [diff] [blame] | 1221 | The algorithms that contain |
| 1222 | .Dq -etm |
| 1223 | calculate the MAC after encryption (encrypt-then-mac). |
| 1224 | These are considered safer and their use recommended. |
djm@openbsd.org | f9eca24 | 2015-07-30 00:01:34 +0000 | [diff] [blame] | 1225 | .Pp |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1226 | The default is: |
Damien Miller | 5e7c30b | 2007-06-11 14:06:32 +1000 | [diff] [blame] | 1227 | .Bd -literal -offset indent |
Damien Miller | af43a7a | 2012-12-12 10:46:31 +1100 | [diff] [blame] | 1228 | umac-64-etm@openssh.com,umac-128-etm@openssh.com, |
| 1229 | hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com, |
djm@openbsd.org | e4c918a | 2016-02-11 02:56:32 +0000 | [diff] [blame] | 1230 | hmac-sha1-etm@openssh.com, |
Damien Miller | c1621c8 | 2014-04-20 13:22:46 +1000 | [diff] [blame] | 1231 | umac-64@openssh.com,umac-128@openssh.com, |
djm@openbsd.org | e4c918a | 2016-02-11 02:56:32 +0000 | [diff] [blame] | 1232 | hmac-sha2-256,hmac-sha2-512,hmac-sha1 |
Damien Miller | 5e7c30b | 2007-06-11 14:06:32 +1000 | [diff] [blame] | 1233 | .Ed |
djm@openbsd.org | 8f6784f | 2014-12-22 09:05:17 +0000 | [diff] [blame] | 1234 | .Pp |
| 1235 | The list of available MAC algorithms may also be obtained using the |
| 1236 | .Fl Q |
| 1237 | option of |
| 1238 | .Xr ssh 1 |
| 1239 | with an argument of |
| 1240 | .Dq mac . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1241 | .It Cm NoHostAuthenticationForLocalhost |
| 1242 | This option can be used if the home directory is shared across machines. |
| 1243 | In this case localhost will refer to a different machine on each of |
| 1244 | the machines and the user will get many warnings about changed host keys. |
| 1245 | However, this option disables host authentication for localhost. |
| 1246 | The argument to this keyword must be |
| 1247 | .Dq yes |
| 1248 | or |
| 1249 | .Dq no . |
| 1250 | The default is to check the host key for localhost. |
| 1251 | .It Cm NumberOfPasswordPrompts |
| 1252 | Specifies the number of password prompts before giving up. |
| 1253 | The argument to this keyword must be an integer. |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1254 | The default is 3. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1255 | .It Cm PasswordAuthentication |
| 1256 | Specifies whether to use password authentication. |
| 1257 | The argument to this keyword must be |
| 1258 | .Dq yes |
| 1259 | or |
| 1260 | .Dq no . |
| 1261 | The default is |
| 1262 | .Dq yes . |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1263 | .It Cm PermitLocalCommand |
| 1264 | Allow local command execution via the |
| 1265 | .Ic LocalCommand |
| 1266 | option or using the |
Damien Miller | 4b2319f | 2005-12-13 19:30:27 +1100 | [diff] [blame] | 1267 | .Ic !\& Ns Ar command |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1268 | escape sequence in |
| 1269 | .Xr ssh 1 . |
| 1270 | The argument must be |
| 1271 | .Dq yes |
| 1272 | or |
| 1273 | .Dq no . |
| 1274 | The default is |
| 1275 | .Dq no . |
Damien Miller | 7ea845e | 2010-02-12 09:21:02 +1100 | [diff] [blame] | 1276 | .It Cm PKCS11Provider |
| 1277 | Specifies which PKCS#11 provider to use. |
Damien Miller | 8e1ea4e | 2010-11-20 15:20:10 +1100 | [diff] [blame] | 1278 | The argument to this keyword is the PKCS#11 shared library |
Damien Miller | 7ea845e | 2010-02-12 09:21:02 +1100 | [diff] [blame] | 1279 | .Xr ssh 1 |
Damien Miller | a761844 | 2010-02-12 09:26:02 +1100 | [diff] [blame] | 1280 | should use to communicate with a PKCS#11 token providing the user's |
Damien Miller | 7ea845e | 2010-02-12 09:21:02 +1100 | [diff] [blame] | 1281 | private RSA key. |
Damien Miller | 957d4e4 | 2005-12-13 19:30:45 +1100 | [diff] [blame] | 1282 | .It Cm Port |
| 1283 | Specifies the port number to connect on the remote host. |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1284 | The default is 22. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1285 | .It Cm PreferredAuthentications |
jmc@openbsd.org | a685ae8 | 2016-02-17 07:38:19 +0000 | [diff] [blame] | 1286 | Specifies the order in which the client should try authentication methods. |
Darren Tucker | 1adc2bd | 2005-03-14 23:14:20 +1100 | [diff] [blame] | 1287 | This allows a client to prefer one method (e.g.\& |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1288 | .Cm keyboard-interactive ) |
Darren Tucker | 1adc2bd | 2005-03-14 23:14:20 +1100 | [diff] [blame] | 1289 | over another method (e.g.\& |
Damien Miller | 544378d | 2010-04-16 15:52:24 +1000 | [diff] [blame] | 1290 | .Cm password ) . |
| 1291 | The default is: |
| 1292 | .Bd -literal -offset indent |
| 1293 | gssapi-with-mic,hostbased,publickey, |
| 1294 | keyboard-interactive,password |
| 1295 | .Ed |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1296 | .It Cm Protocol |
| 1297 | Specifies the protocol versions |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1298 | .Xr ssh 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1299 | should support in order of preference. |
| 1300 | The possible values are |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1301 | .Sq 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1302 | and |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1303 | .Sq 2 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1304 | Multiple versions must be comma-separated. |
Darren Tucker | bad5076 | 2009-10-11 21:51:08 +1100 | [diff] [blame] | 1305 | When this option is set to |
Darren Tucker | 7a4a765 | 2009-10-11 21:51:40 +1100 | [diff] [blame] | 1306 | .Dq 2,1 |
Darren Tucker | bad5076 | 2009-10-11 21:51:08 +1100 | [diff] [blame] | 1307 | .Nm ssh |
| 1308 | will try version 2 and fall back to version 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1309 | if version 2 is not available. |
Darren Tucker | bad5076 | 2009-10-11 21:51:08 +1100 | [diff] [blame] | 1310 | The default is |
Darren Tucker | 7a4a765 | 2009-10-11 21:51:40 +1100 | [diff] [blame] | 1311 | .Sq 2 . |
djm@openbsd.org | e7901ef | 2016-02-16 05:11:04 +0000 | [diff] [blame] | 1312 | Protocol 1 suffers from a number of cryptographic weaknesses and should |
| 1313 | not be used. |
| 1314 | It is only offered to support legacy devices. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1315 | .It Cm ProxyCommand |
| 1316 | Specifies the command to use to connect to the server. |
| 1317 | The command |
Damien Miller | 079bac2 | 2014-07-09 13:06:25 +1000 | [diff] [blame] | 1318 | string extends to the end of the line, and is executed |
| 1319 | using the user's shell |
| 1320 | .Ql exec |
| 1321 | directive to avoid a lingering shell process. |
| 1322 | .Pp |
Damien Miller | c4eddee | 2010-04-18 08:07:43 +1000 | [diff] [blame] | 1323 | In the command string, any occurrence of |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1324 | .Ql %h |
| 1325 | will be substituted by the host name to |
Damien Miller | b1b1704 | 2010-04-16 15:54:19 +1000 | [diff] [blame] | 1326 | connect, |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1327 | .Ql %p |
Damien Miller | c4eddee | 2010-04-18 08:07:43 +1000 | [diff] [blame] | 1328 | by the port, and |
| 1329 | .Ql %r |
Damien Miller | b1b1704 | 2010-04-16 15:54:19 +1000 | [diff] [blame] | 1330 | by the remote user name. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1331 | The command can be basically anything, |
| 1332 | and should read from its standard input and write to its standard output. |
| 1333 | It should eventually connect an |
| 1334 | .Xr sshd 8 |
| 1335 | server running on some machine, or execute |
| 1336 | .Ic sshd -i |
| 1337 | somewhere. |
| 1338 | Host key management will be done using the |
| 1339 | HostName of the host being connected (defaulting to the name typed by |
| 1340 | the user). |
Damien Miller | 495dca3 | 2003-04-01 21:42:14 +1000 | [diff] [blame] | 1341 | Setting the command to |
| 1342 | .Dq none |
Damien Miller | 9f1e33a | 2003-02-24 11:57:32 +1100 | [diff] [blame] | 1343 | disables this option entirely. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1344 | Note that |
| 1345 | .Cm CheckHostIP |
| 1346 | is not available for connects with a proxy command. |
| 1347 | .Pp |
Damien Miller | ebcfedc | 2005-05-26 12:13:56 +1000 | [diff] [blame] | 1348 | This directive is useful in conjunction with |
| 1349 | .Xr nc 1 |
| 1350 | and its proxy support. |
Damien Miller | dfec294 | 2005-05-26 12:14:32 +1000 | [diff] [blame] | 1351 | For example, the following directive would connect via an HTTP proxy at |
Damien Miller | ebcfedc | 2005-05-26 12:13:56 +1000 | [diff] [blame] | 1352 | 192.0.2.0: |
| 1353 | .Bd -literal -offset 3n |
| 1354 | ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p |
| 1355 | .Ed |
Damien Miller | 1262b66 | 2013-08-21 02:44:24 +1000 | [diff] [blame] | 1356 | .It Cm ProxyUseFdpass |
Damien Miller | f2f6c31 | 2013-08-21 02:44:58 +1000 | [diff] [blame] | 1357 | Specifies that |
Damien Miller | 1262b66 | 2013-08-21 02:44:24 +1000 | [diff] [blame] | 1358 | .Cm ProxyCommand |
| 1359 | will pass a connected file descriptor back to |
Damien Miller | f2f6c31 | 2013-08-21 02:44:58 +1000 | [diff] [blame] | 1360 | .Xr ssh 1 |
Damien Miller | 1262b66 | 2013-08-21 02:44:24 +1000 | [diff] [blame] | 1361 | instead of continuing to execute and pass data. |
| 1362 | The default is |
| 1363 | .Dq no . |
markus@openbsd.org | 3a1638d | 2015-07-10 06:21:53 +0000 | [diff] [blame] | 1364 | .It Cm PubkeyAcceptedKeyTypes |
| 1365 | Specifies the key types that will be used for public key authentication |
| 1366 | as a comma-separated pattern list. |
djm@openbsd.org | f9eca24 | 2015-07-30 00:01:34 +0000 | [diff] [blame] | 1367 | Alternately if the specified value begins with a |
| 1368 | .Sq + |
| 1369 | character, then the key types after it will be appended to the default |
| 1370 | instead of replacing it. |
markus@openbsd.org | 3a1638d | 2015-07-10 06:21:53 +0000 | [diff] [blame] | 1371 | The default for this option is: |
| 1372 | .Bd -literal -offset 3n |
| 1373 | ecdsa-sha2-nistp256-cert-v01@openssh.com, |
| 1374 | ecdsa-sha2-nistp384-cert-v01@openssh.com, |
| 1375 | ecdsa-sha2-nistp521-cert-v01@openssh.com, |
| 1376 | ssh-ed25519-cert-v01@openssh.com, |
| 1377 | ssh-rsa-cert-v01@openssh.com, |
| 1378 | ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521, |
djm@openbsd.org | 3a13cb5 | 2016-02-17 08:57:34 +0000 | [diff] [blame] | 1379 | ssh-ed25519,ssh-rsa |
markus@openbsd.org | 3a1638d | 2015-07-10 06:21:53 +0000 | [diff] [blame] | 1380 | .Ed |
| 1381 | .Pp |
| 1382 | The |
| 1383 | .Fl Q |
| 1384 | option of |
| 1385 | .Xr ssh 1 |
| 1386 | may be used to list supported key types. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1387 | .It Cm PubkeyAuthentication |
| 1388 | Specifies whether to try public key authentication. |
| 1389 | The argument to this keyword must be |
| 1390 | .Dq yes |
| 1391 | or |
| 1392 | .Dq no . |
| 1393 | The default is |
| 1394 | .Dq yes . |
Darren Tucker | 62388b2 | 2006-01-20 11:31:47 +1100 | [diff] [blame] | 1395 | .It Cm RekeyLimit |
| 1396 | Specifies the maximum amount of data that may be transmitted before the |
Darren Tucker | c53c2af | 2013-05-16 20:28:16 +1000 | [diff] [blame] | 1397 | session key is renegotiated, optionally followed a maximum amount of |
| 1398 | time that may pass before the session key is renegotiated. |
| 1399 | The first argument is specified in bytes and may have a suffix of |
Damien Miller | ddfddf1 | 2006-01-31 21:39:03 +1100 | [diff] [blame] | 1400 | .Sq K , |
| 1401 | .Sq M , |
Darren Tucker | 62388b2 | 2006-01-20 11:31:47 +1100 | [diff] [blame] | 1402 | or |
Damien Miller | ddfddf1 | 2006-01-31 21:39:03 +1100 | [diff] [blame] | 1403 | .Sq G |
Darren Tucker | 62388b2 | 2006-01-20 11:31:47 +1100 | [diff] [blame] | 1404 | to indicate Kilobytes, Megabytes, or Gigabytes, respectively. |
| 1405 | The default is between |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1406 | .Sq 1G |
Darren Tucker | 62388b2 | 2006-01-20 11:31:47 +1100 | [diff] [blame] | 1407 | and |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1408 | .Sq 4G , |
Darren Tucker | 62388b2 | 2006-01-20 11:31:47 +1100 | [diff] [blame] | 1409 | depending on the cipher. |
Darren Tucker | c53c2af | 2013-05-16 20:28:16 +1000 | [diff] [blame] | 1410 | The optional second value is specified in seconds and may use any of the |
| 1411 | units documented in the |
Damien Miller | fecfd11 | 2013-07-18 16:11:50 +1000 | [diff] [blame] | 1412 | TIME FORMATS section of |
Darren Tucker | c53c2af | 2013-05-16 20:28:16 +1000 | [diff] [blame] | 1413 | .Xr sshd_config 5 . |
| 1414 | The default value for |
| 1415 | .Cm RekeyLimit |
| 1416 | is |
| 1417 | .Dq default none , |
| 1418 | which means that rekeying is performed after the cipher's default amount |
| 1419 | of data has been sent or received and no time based rekeying is done. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1420 | .It Cm RemoteForward |
Damien Miller | e9d001e | 2006-01-14 10:10:17 +1100 | [diff] [blame] | 1421 | Specifies that a TCP port on the remote machine be forwarded over |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1422 | the secure channel to the specified host and port from the local machine. |
Darren Tucker | 5ede2ad | 2005-03-31 21:31:10 +1000 | [diff] [blame] | 1423 | The first argument must be |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 1424 | .Sm off |
Darren Tucker | 5ede2ad | 2005-03-31 21:31:10 +1000 | [diff] [blame] | 1425 | .Oo Ar bind_address : Oc Ar port |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 1426 | .Sm on |
Darren Tucker | 5ede2ad | 2005-03-31 21:31:10 +1000 | [diff] [blame] | 1427 | and the second argument must be |
| 1428 | .Ar host : Ns Ar hostport . |
Damien Miller | 7fa9660 | 2010-08-05 13:03:13 +1000 | [diff] [blame] | 1429 | IPv6 addresses can be specified by enclosing addresses in square brackets. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1430 | Multiple forwardings may be specified, and additional |
| 1431 | forwardings can be given on the command line. |
Damien Miller | de7532e | 2008-11-03 19:24:45 +1100 | [diff] [blame] | 1432 | Privileged ports can be forwarded only when |
| 1433 | logging in as root on the remote machine. |
Damien Miller | e379e10 | 2009-02-14 16:34:39 +1100 | [diff] [blame] | 1434 | .Pp |
Damien Miller | 85c6d8a | 2009-02-14 16:34:21 +1100 | [diff] [blame] | 1435 | If the |
| 1436 | .Ar port |
| 1437 | argument is |
| 1438 | .Ql 0 , |
| 1439 | the listen port will be dynamically allocated on the server and reported |
| 1440 | to the client at run time. |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 1441 | .Pp |
| 1442 | If the |
| 1443 | .Ar bind_address |
| 1444 | is not specified, the default is to only bind to loopback addresses. |
| 1445 | If the |
| 1446 | .Ar bind_address |
| 1447 | is |
| 1448 | .Ql * |
| 1449 | or an empty string, then the forwarding is requested to listen on all |
| 1450 | interfaces. |
| 1451 | Specifying a remote |
| 1452 | .Ar bind_address |
Damien Miller | f8c5546 | 2005-03-02 12:03:05 +1100 | [diff] [blame] | 1453 | will only succeed if the server's |
| 1454 | .Cm GatewayPorts |
Damien Miller | f91ee4c | 2005-03-01 21:24:33 +1100 | [diff] [blame] | 1455 | option is enabled (see |
Damien Miller | f8c5546 | 2005-03-02 12:03:05 +1100 | [diff] [blame] | 1456 | .Xr sshd_config 5 ) . |
Damien Miller | 21771e2 | 2011-05-15 08:45:50 +1000 | [diff] [blame] | 1457 | .It Cm RequestTTY |
| 1458 | Specifies whether to request a pseudo-tty for the session. |
| 1459 | The argument may be one of: |
| 1460 | .Dq no |
| 1461 | (never request a TTY), |
| 1462 | .Dq yes |
| 1463 | (always request a TTY when standard input is a TTY), |
| 1464 | .Dq force |
| 1465 | (always request a TTY) or |
| 1466 | .Dq auto |
| 1467 | (request a TTY when opening a login session). |
| 1468 | This option mirrors the |
| 1469 | .Fl t |
| 1470 | and |
| 1471 | .Fl T |
| 1472 | flags for |
| 1473 | .Xr ssh 1 . |
djm@openbsd.org | 5e39a49 | 2014-12-04 02:24:32 +0000 | [diff] [blame] | 1474 | .It Cm RevokedHostKeys |
| 1475 | Specifies revoked host public keys. |
| 1476 | Keys listed in this file will be refused for host authentication. |
| 1477 | Note that if this file does not exist or is not readable, |
| 1478 | then host authentication will be refused for all hosts. |
| 1479 | Keys may be specified as a text file, listing one public key per line, or as |
| 1480 | an OpenSSH Key Revocation List (KRL) as generated by |
| 1481 | .Xr ssh-keygen 1 . |
| 1482 | For more information on KRLs, see the KEY REVOCATION LISTS section in |
| 1483 | .Xr ssh-keygen 1 . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1484 | .It Cm RhostsRSAAuthentication |
| 1485 | Specifies whether to try rhosts based authentication with RSA host |
| 1486 | authentication. |
| 1487 | The argument must be |
| 1488 | .Dq yes |
| 1489 | or |
| 1490 | .Dq no . |
| 1491 | The default is |
| 1492 | .Dq no . |
| 1493 | This option applies to protocol version 1 only and requires |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1494 | .Xr ssh 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1495 | to be setuid root. |
| 1496 | .It Cm RSAAuthentication |
| 1497 | Specifies whether to try RSA authentication. |
| 1498 | The argument to this keyword must be |
| 1499 | .Dq yes |
| 1500 | or |
| 1501 | .Dq no . |
| 1502 | RSA authentication will only be |
| 1503 | attempted if the identity file exists, or an authentication agent is |
| 1504 | running. |
| 1505 | The default is |
| 1506 | .Dq yes . |
| 1507 | Note that this option applies to protocol version 1 only. |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 1508 | .It Cm SendEnv |
| 1509 | Specifies what variables from the local |
| 1510 | .Xr environ 7 |
| 1511 | should be sent to the server. |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1512 | The server must also support it, and the server must be configured to |
Darren Tucker | 1e0c9bf | 2004-05-02 22:12:48 +1000 | [diff] [blame] | 1513 | accept these environment variables. |
dtucker@openbsd.org | 85b96ef | 2015-04-28 10:17:58 +0000 | [diff] [blame] | 1514 | Note that the |
| 1515 | .Ev TERM |
jmc@openbsd.org | c1d5bcf | 2015-04-28 13:47:38 +0000 | [diff] [blame] | 1516 | environment variable is always sent whenever a |
dtucker@openbsd.org | 85b96ef | 2015-04-28 10:17:58 +0000 | [diff] [blame] | 1517 | pseudo-terminal is requested as it is required by the protocol. |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 1518 | Refer to |
| 1519 | .Cm AcceptEnv |
| 1520 | in |
| 1521 | .Xr sshd_config 5 |
| 1522 | for how to configure the server. |
Damien Miller | 6def551 | 2006-03-15 11:54:05 +1100 | [diff] [blame] | 1523 | Variables are specified by name, which may contain wildcard characters. |
Darren Tucker | 1e0c9bf | 2004-05-02 22:12:48 +1000 | [diff] [blame] | 1524 | Multiple environment variables may be separated by whitespace or spread |
Darren Tucker | 46bc075 | 2004-05-02 22:11:30 +1000 | [diff] [blame] | 1525 | across multiple |
| 1526 | .Cm SendEnv |
| 1527 | directives. |
| 1528 | The default is not to send any environment variables. |
Damien Miller | f54a4b9 | 2006-03-15 11:54:36 +1100 | [diff] [blame] | 1529 | .Pp |
| 1530 | See |
| 1531 | .Sx PATTERNS |
| 1532 | for more information on patterns. |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 1533 | .It Cm ServerAliveCountMax |
Damien Miller | b797770 | 2006-01-03 18:47:31 +1100 | [diff] [blame] | 1534 | Sets the number of server alive messages (see below) which may be |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 1535 | sent without |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1536 | .Xr ssh 1 |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 1537 | receiving any messages back from the server. |
| 1538 | If this threshold is reached while server alive messages are being sent, |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1539 | ssh will disconnect from the server, terminating the session. |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 1540 | It is important to note that the use of server alive messages is very |
| 1541 | different from |
| 1542 | .Cm TCPKeepAlive |
| 1543 | (below). |
| 1544 | The server alive messages are sent through the encrypted channel |
| 1545 | and therefore will not be spoofable. |
| 1546 | The TCP keepalive option enabled by |
| 1547 | .Cm TCPKeepAlive |
| 1548 | is spoofable. |
| 1549 | The server alive mechanism is valuable when the client or |
| 1550 | server depend on knowing when a connection has become inactive. |
| 1551 | .Pp |
| 1552 | The default value is 3. |
| 1553 | If, for example, |
| 1554 | .Cm ServerAliveInterval |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1555 | (see below) is set to 15 and |
Damien Miller | 509b010 | 2003-12-17 16:33:10 +1100 | [diff] [blame] | 1556 | .Cm ServerAliveCountMax |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1557 | is left at the default, if the server becomes unresponsive, |
| 1558 | ssh will disconnect after approximately 45 seconds. |
Damien Miller | 957d4e4 | 2005-12-13 19:30:45 +1100 | [diff] [blame] | 1559 | .It Cm ServerAliveInterval |
| 1560 | Sets a timeout interval in seconds after which if no data has been received |
| 1561 | from the server, |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1562 | .Xr ssh 1 |
Damien Miller | 957d4e4 | 2005-12-13 19:30:45 +1100 | [diff] [blame] | 1563 | will send a message through the encrypted |
| 1564 | channel to request a response from the server. |
| 1565 | The default |
| 1566 | is 0, indicating that these messages will not be sent to the server. |
Damien Miller | 7acefbb | 2014-07-18 14:11:24 +1000 | [diff] [blame] | 1567 | .It Cm StreamLocalBindMask |
| 1568 | Sets the octal file creation mode mask |
| 1569 | .Pq umask |
| 1570 | used when creating a Unix-domain socket file for local or remote |
| 1571 | port forwarding. |
| 1572 | This option is only used for port forwarding to a Unix-domain socket file. |
| 1573 | .Pp |
| 1574 | The default value is 0177, which creates a Unix-domain socket file that is |
| 1575 | readable and writable only by the owner. |
| 1576 | Note that not all operating systems honor the file mode on Unix-domain |
| 1577 | socket files. |
| 1578 | .It Cm StreamLocalBindUnlink |
| 1579 | Specifies whether to remove an existing Unix-domain socket file for local |
| 1580 | or remote port forwarding before creating a new one. |
| 1581 | If the socket file already exists and |
| 1582 | .Cm StreamLocalBindUnlink |
| 1583 | is not enabled, |
| 1584 | .Nm ssh |
| 1585 | will be unable to forward the port to the Unix-domain socket file. |
| 1586 | This option is only used for port forwarding to a Unix-domain socket file. |
| 1587 | .Pp |
| 1588 | The argument must be |
| 1589 | .Dq yes |
| 1590 | or |
| 1591 | .Dq no . |
| 1592 | The default is |
| 1593 | .Dq no . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1594 | .It Cm StrictHostKeyChecking |
| 1595 | If this flag is set to |
| 1596 | .Dq yes , |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1597 | .Xr ssh 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1598 | will never automatically add host keys to the |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 1599 | .Pa ~/.ssh/known_hosts |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1600 | file, and refuses to connect to hosts whose host key has changed. |
| 1601 | This provides maximum protection against trojan horse attacks, |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1602 | though it can be annoying when the |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1603 | .Pa /etc/ssh/ssh_known_hosts |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1604 | file is poorly maintained or when connections to new hosts are |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1605 | frequently made. |
| 1606 | This option forces the user to manually |
| 1607 | add all new hosts. |
| 1608 | If this flag is set to |
| 1609 | .Dq no , |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1610 | ssh will automatically add new host keys to the |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1611 | user known hosts files. |
| 1612 | If this flag is set to |
| 1613 | .Dq ask , |
| 1614 | new host keys |
| 1615 | will be added to the user known host files only after the user |
| 1616 | has confirmed that is what they really want to do, and |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1617 | ssh will refuse to connect to hosts whose host key has changed. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1618 | The host keys of |
| 1619 | known hosts will be verified automatically in all cases. |
| 1620 | The argument must be |
| 1621 | .Dq yes , |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1622 | .Dq no , |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1623 | or |
| 1624 | .Dq ask . |
| 1625 | The default is |
| 1626 | .Dq ask . |
Damien Miller | 12c150e | 2003-12-17 16:31:10 +1100 | [diff] [blame] | 1627 | .It Cm TCPKeepAlive |
| 1628 | Specifies whether the system should send TCP keepalive messages to the |
| 1629 | other side. |
| 1630 | If they are sent, death of the connection or crash of one |
| 1631 | of the machines will be properly noticed. |
| 1632 | However, this means that |
| 1633 | connections will die if the route is down temporarily, and some people |
| 1634 | find it annoying. |
| 1635 | .Pp |
| 1636 | The default is |
| 1637 | .Dq yes |
| 1638 | (to send TCP keepalive messages), and the client will notice |
| 1639 | if the network goes down or the remote host dies. |
| 1640 | This is important in scripts, and many users want it too. |
| 1641 | .Pp |
| 1642 | To disable TCP keepalive messages, the value should be set to |
| 1643 | .Dq no . |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1644 | .It Cm Tunnel |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 1645 | Request |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1646 | .Xr tun 4 |
Damien Miller | 7746c39 | 2005-12-13 19:33:37 +1100 | [diff] [blame] | 1647 | device forwarding between the client and the server. |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1648 | The argument must be |
Damien Miller | 7b58e80 | 2005-12-13 19:33:19 +1100 | [diff] [blame] | 1649 | .Dq yes , |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 1650 | .Dq point-to-point |
| 1651 | (layer 3), |
| 1652 | .Dq ethernet |
| 1653 | (layer 2), |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1654 | or |
| 1655 | .Dq no . |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 1656 | Specifying |
| 1657 | .Dq yes |
| 1658 | requests the default tunnel mode, which is |
| 1659 | .Dq point-to-point . |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1660 | The default is |
| 1661 | .Dq no . |
| 1662 | .It Cm TunnelDevice |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 1663 | Specifies the |
Damien Miller | d27b947 | 2005-12-13 19:29:02 +1100 | [diff] [blame] | 1664 | .Xr tun 4 |
Damien Miller | 991dba4 | 2006-07-10 20:16:27 +1000 | [diff] [blame] | 1665 | devices to open on the client |
| 1666 | .Pq Ar local_tun |
| 1667 | and the server |
| 1668 | .Pq Ar remote_tun . |
| 1669 | .Pp |
| 1670 | The argument must be |
| 1671 | .Sm off |
| 1672 | .Ar local_tun Op : Ar remote_tun . |
| 1673 | .Sm on |
| 1674 | The devices may be specified by numerical ID or the keyword |
| 1675 | .Dq any , |
| 1676 | which uses the next available tunnel device. |
| 1677 | If |
| 1678 | .Ar remote_tun |
| 1679 | is not specified, it defaults to |
| 1680 | .Dq any . |
| 1681 | The default is |
| 1682 | .Dq any:any . |
djm@openbsd.org | 1d1092b | 2015-01-26 12:16:36 +0000 | [diff] [blame] | 1683 | .It Cm UpdateHostKeys |
djm@openbsd.org | 8d4f872 | 2015-01-26 03:04:45 +0000 | [diff] [blame] | 1684 | Specifies whether |
| 1685 | .Xr ssh 1 |
| 1686 | should accept notifications of additional hostkeys from the server sent |
| 1687 | after authentication has completed and add them to |
| 1688 | .Cm UserKnownHostsFile . |
| 1689 | The argument must be |
djm@openbsd.org | 523463a | 2015-02-16 22:13:32 +0000 | [diff] [blame] | 1690 | .Dq yes , |
djm@openbsd.org | 15ad750 | 2015-02-02 07:41:40 +0000 | [diff] [blame] | 1691 | .Dq no |
djm@openbsd.org | 523463a | 2015-02-16 22:13:32 +0000 | [diff] [blame] | 1692 | (the default) or |
| 1693 | .Dq ask . |
djm@openbsd.org | 8d4f872 | 2015-01-26 03:04:45 +0000 | [diff] [blame] | 1694 | Enabling this option allows learning alternate hostkeys for a server |
djm@openbsd.org | 1d1092b | 2015-01-26 12:16:36 +0000 | [diff] [blame] | 1695 | and supports graceful key rotation by allowing a server to send replacement |
| 1696 | public keys before old ones are removed. |
djm@openbsd.org | 8d4f872 | 2015-01-26 03:04:45 +0000 | [diff] [blame] | 1697 | Additional hostkeys are only accepted if the key used to authenticate the |
sobrado@openbsd.org | e3cbb06 | 2015-09-22 08:33:23 +0000 | [diff] [blame] | 1698 | host was already trusted or explicitly accepted by the user. |
djm@openbsd.org | 523463a | 2015-02-16 22:13:32 +0000 | [diff] [blame] | 1699 | If |
| 1700 | .Cm UpdateHostKeys |
| 1701 | is set to |
| 1702 | .Dq ask , |
| 1703 | then the user is asked to confirm the modifications to the known_hosts file. |
djm@openbsd.org | 44732de | 2015-02-20 22:17:21 +0000 | [diff] [blame] | 1704 | Confirmation is currently incompatible with |
| 1705 | .Cm ControlPersist , |
| 1706 | and will be disabled if it is enabled. |
djm@openbsd.org | 8d4f872 | 2015-01-26 03:04:45 +0000 | [diff] [blame] | 1707 | .Pp |
| 1708 | Presently, only |
| 1709 | .Xr sshd 8 |
| 1710 | from OpenSSH 6.8 and greater support the |
| 1711 | .Dq hostkeys@openssh.com |
| 1712 | protocol extension used to inform the client of all the server's hostkeys. |
Damien Miller | e8cd741 | 2005-12-24 14:55:47 +1100 | [diff] [blame] | 1713 | .It Cm UsePrivilegedPort |
| 1714 | Specifies whether to use a privileged port for outgoing connections. |
| 1715 | The argument must be |
| 1716 | .Dq yes |
| 1717 | or |
| 1718 | .Dq no . |
| 1719 | The default is |
| 1720 | .Dq no . |
| 1721 | If set to |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1722 | .Dq yes , |
| 1723 | .Xr ssh 1 |
Damien Miller | e8cd741 | 2005-12-24 14:55:47 +1100 | [diff] [blame] | 1724 | must be setuid root. |
| 1725 | Note that this option must be set to |
| 1726 | .Dq yes |
| 1727 | for |
| 1728 | .Cm RhostsRSAAuthentication |
| 1729 | with older servers. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1730 | .It Cm User |
| 1731 | Specifies the user to log in as. |
| 1732 | This can be useful when a different user name is used on different machines. |
| 1733 | This saves the trouble of |
| 1734 | having to remember to give the user name on the command line. |
| 1735 | .It Cm UserKnownHostsFile |
Damien Miller | 295ee63 | 2011-05-29 21:42:31 +1000 | [diff] [blame] | 1736 | Specifies one or more files to use for the user |
| 1737 | host key database, separated by whitespace. |
| 1738 | The default is |
| 1739 | .Pa ~/.ssh/known_hosts , |
| 1740 | .Pa ~/.ssh/known_hosts2 . |
Damien Miller | 37876e9 | 2003-05-15 10:19:46 +1000 | [diff] [blame] | 1741 | .It Cm VerifyHostKeyDNS |
| 1742 | Specifies whether to verify the remote key using DNS and SSHFP resource |
| 1743 | records. |
Damien Miller | 150b557 | 2003-11-17 21:19:29 +1100 | [diff] [blame] | 1744 | If this option is set to |
| 1745 | .Dq yes , |
Damien Miller | fe44847 | 2003-11-17 21:19:49 +1100 | [diff] [blame] | 1746 | the client will implicitly trust keys that match a secure fingerprint |
Damien Miller | 150b557 | 2003-11-17 21:19:29 +1100 | [diff] [blame] | 1747 | from DNS. |
| 1748 | Insecure fingerprints will be handled as if this option was set to |
| 1749 | .Dq ask . |
| 1750 | If this option is set to |
| 1751 | .Dq ask , |
| 1752 | information on fingerprint match will be displayed, but the user will still |
| 1753 | need to confirm new host keys according to the |
| 1754 | .Cm StrictHostKeyChecking |
| 1755 | option. |
| 1756 | The argument must be |
| 1757 | .Dq yes , |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1758 | .Dq no , |
Damien Miller | fe44847 | 2003-11-17 21:19:49 +1100 | [diff] [blame] | 1759 | or |
| 1760 | .Dq ask . |
Damien Miller | 37876e9 | 2003-05-15 10:19:46 +1000 | [diff] [blame] | 1761 | The default is |
| 1762 | .Dq no . |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1763 | .Pp |
Damien Miller | fecfd11 | 2013-07-18 16:11:50 +1000 | [diff] [blame] | 1764 | See also VERIFYING HOST KEYS in |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1765 | .Xr ssh 1 . |
Damien Miller | 1028824 | 2008-06-30 00:04:03 +1000 | [diff] [blame] | 1766 | .It Cm VisualHostKey |
| 1767 | If this flag is set to |
| 1768 | .Dq yes , |
| 1769 | an ASCII art representation of the remote host key fingerprint is |
djm@openbsd.org | b79efde | 2014-12-21 23:12:42 +0000 | [diff] [blame] | 1770 | printed in addition to the fingerprint string at login and |
Damien Miller | a414cd3 | 2008-11-03 19:25:21 +1100 | [diff] [blame] | 1771 | for unknown host keys. |
Damien Miller | 1028824 | 2008-06-30 00:04:03 +1000 | [diff] [blame] | 1772 | If this flag is set to |
| 1773 | .Dq no , |
Damien Miller | a414cd3 | 2008-11-03 19:25:21 +1100 | [diff] [blame] | 1774 | no fingerprint strings are printed at login and |
djm@openbsd.org | b79efde | 2014-12-21 23:12:42 +0000 | [diff] [blame] | 1775 | only the fingerprint string will be printed for unknown host keys. |
Damien Miller | 1028824 | 2008-06-30 00:04:03 +1000 | [diff] [blame] | 1776 | The default is |
| 1777 | .Dq no . |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1778 | .It Cm XAuthLocation |
Damien Miller | 05913ba | 2002-09-04 16:51:03 +1000 | [diff] [blame] | 1779 | Specifies the full pathname of the |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1780 | .Xr xauth 1 |
| 1781 | program. |
| 1782 | The default is |
| 1783 | .Pa /usr/X11R6/bin/xauth . |
| 1784 | .El |
Damien Miller | b5282c2 | 2006-03-15 11:59:08 +1100 | [diff] [blame] | 1785 | .Sh PATTERNS |
| 1786 | A |
| 1787 | .Em pattern |
| 1788 | consists of zero or more non-whitespace characters, |
| 1789 | .Sq * |
| 1790 | (a wildcard that matches zero or more characters), |
| 1791 | or |
| 1792 | .Sq ?\& |
| 1793 | (a wildcard that matches exactly one character). |
| 1794 | For example, to specify a set of declarations for any host in the |
| 1795 | .Dq .co.uk |
| 1796 | set of domains, |
| 1797 | the following pattern could be used: |
| 1798 | .Pp |
| 1799 | .Dl Host *.co.uk |
| 1800 | .Pp |
| 1801 | The following pattern |
| 1802 | would match any host in the 192.168.0.[0-9] network range: |
| 1803 | .Pp |
| 1804 | .Dl Host 192.168.0.? |
| 1805 | .Pp |
| 1806 | A |
| 1807 | .Em pattern-list |
| 1808 | is a comma-separated list of patterns. |
| 1809 | Patterns within pattern-lists may be negated |
| 1810 | by preceding them with an exclamation mark |
| 1811 | .Pq Sq !\& . |
| 1812 | For example, |
Damien Miller | 51682fa | 2013-10-17 11:48:31 +1100 | [diff] [blame] | 1813 | to allow a key to be used from anywhere within an organization |
Damien Miller | b5282c2 | 2006-03-15 11:59:08 +1100 | [diff] [blame] | 1814 | except from the |
| 1815 | .Dq dialup |
| 1816 | pool, |
| 1817 | the following entry (in authorized_keys) could be used: |
| 1818 | .Pp |
| 1819 | .Dl from=\&"!*.dialup.example.com,*.example.com\&" |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1820 | .Sh FILES |
| 1821 | .Bl -tag -width Ds |
Damien Miller | 167ea5d | 2005-05-26 12:04:02 +1000 | [diff] [blame] | 1822 | .It Pa ~/.ssh/config |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1823 | This is the per-user configuration file. |
| 1824 | The format of this file is described above. |
Damien Miller | 45ee2b9 | 2006-03-15 11:56:18 +1100 | [diff] [blame] | 1825 | This file is used by the SSH client. |
Damien Miller | c970cb9 | 2004-04-20 20:12:53 +1000 | [diff] [blame] | 1826 | Because of the potential for abuse, this file must have strict permissions: |
| 1827 | read/write for the user, and not accessible by others. |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1828 | .It Pa /etc/ssh/ssh_config |
| 1829 | Systemwide configuration file. |
| 1830 | This file provides defaults for those |
| 1831 | values that are not specified in the user's configuration file, and |
| 1832 | for those users who do not have a configuration file. |
| 1833 | This file must be world-readable. |
| 1834 | .El |
Damien Miller | f1ce505 | 2003-06-11 22:04:39 +1000 | [diff] [blame] | 1835 | .Sh SEE ALSO |
| 1836 | .Xr ssh 1 |
Ben Lindstrom | 9f04903 | 2002-06-21 00:59:05 +0000 | [diff] [blame] | 1837 | .Sh AUTHORS |
| 1838 | OpenSSH is a derivative of the original and free |
| 1839 | ssh 1.2.12 release by Tatu Ylonen. |
| 1840 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, |
| 1841 | Theo de Raadt and Dug Song |
| 1842 | removed many bugs, re-added newer features and |
| 1843 | created OpenSSH. |
| 1844 | Markus Friedl contributed the support for SSH |
| 1845 | protocol versions 1.5 and 2.0. |