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