blob: 591365f34cb0adc760697579752cdd883a9c10a4 [file] [log] [blame]
Ben Lindstrom9f049032002-06-21 00:59:05 +00001.\"
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.\"
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +000036.\" $OpenBSD: ssh_config.5,v 1.240 2016/10/15 19:56:25 jmc Exp $
37.Dd $Mdocdate: October 15 2016 $
Ben Lindstrom9f049032002-06-21 00:59:05 +000038.Dt SSH_CONFIG 5
39.Os
40.Sh NAME
41.Nm ssh_config
42.Nd OpenSSH SSH client configuration files
43.Sh SYNOPSIS
Darren Tuckerbf6b3282007-02-19 22:08:17 +110044.Nm ~/.ssh/config
45.Nm /etc/ssh/ssh_config
Ben Lindstrom9f049032002-06-21 00:59:05 +000046.Sh DESCRIPTION
Damien Miller45ee2b92006-03-15 11:56:18 +110047.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +000048obtains configuration data from the following sources in
49the following order:
Damien Miller5c853b52006-03-15 11:37:02 +110050.Pp
Ben Lindstrom479b4762002-08-20 19:04:51 +000051.Bl -enum -offset indent -compact
52.It
53command-line options
54.It
55user's configuration file
Damien Miller167ea5d2005-05-26 12:04:02 +100056.Pq Pa ~/.ssh/config
Ben Lindstrom479b4762002-08-20 19:04:51 +000057.It
58system-wide configuration file
59.Pq Pa /etc/ssh/ssh_config
60.El
Ben Lindstrom9f049032002-06-21 00:59:05 +000061.Pp
62For each parameter, the first obtained value
63will be used.
Darren Tucker43d8e282005-02-09 09:51:08 +110064The configuration files contain sections separated by
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +000065.Cm Host
Ben Lindstrom9f049032002-06-21 00:59:05 +000066specifications, and that section is only applied for hosts that
67match one of the patterns given in the specification.
djm@openbsd.org957fbce2014-10-08 22:20:25 +000068The matched host name is usually the one given on the command line
69(see the
70.Cm CanonicalizeHostname
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +000071option for exceptions).
Ben Lindstrom9f049032002-06-21 00:59:05 +000072.Pp
73Since the first obtained value for each parameter is used, more
74host-specific declarations should be given near the beginning of the
75file, and general defaults at the end.
76.Pp
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +000077The file contains keyword-argument pairs, one per line.
78Lines starting with
Ben Lindstrom9f049032002-06-21 00:59:05 +000079.Ql #
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +000080and empty lines are interpreted as comments.
81Arguments may optionally be enclosed in double quotes
82.Pq \&"
83in order to represent arguments containing spaces.
Ben Lindstrom9f049032002-06-21 00:59:05 +000084Configuration options may be separated by whitespace or
85optional whitespace and exactly one
86.Ql = ;
87the latter format is useful to avoid the need to quote whitespace
88when specifying configuration options using the
89.Nm ssh ,
Damien Miller4aea9742006-03-15 11:59:39 +110090.Nm scp ,
Ben Lindstrom9f049032002-06-21 00:59:05 +000091and
92.Nm sftp
93.Fl o
94option.
95.Pp
96The possible
97keywords and their meanings are as follows (note that
98keywords are case-insensitive and arguments are case-sensitive):
99.Bl -tag -width Ds
100.It Cm Host
101Restricts the following declarations (up to the next
102.Cm Host
Damien Miller194fd902013-10-15 12:13:05 +1100103or
104.Cm Match
Ben Lindstrom9f049032002-06-21 00:59:05 +0000105keyword) to be only for those hosts that match one of the patterns
106given after the keyword.
Damien Millerfa51b162008-11-03 19:17:33 +1100107If more than one pattern is provided, they should be separated by whitespace.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000108A single
Damien Miller208f1ed2006-03-15 11:56:03 +1100109.Ql *
Ben Lindstrom9f049032002-06-21 00:59:05 +0000110as a pattern can be used to provide global
111defaults for all hosts.
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000112The host is usually the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000113.Ar hostname
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000114argument given on the command line
115(see the
116.Cm CanonicalizeHostname
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000117keyword for exceptions).
Damien Millerf54a4b92006-03-15 11:54:36 +1100118.Pp
Damien Millerfe924212011-05-15 08:44:45 +1000119A pattern entry may be negated by prefixing it with an exclamation mark
120.Pq Sq !\& .
121If a negated entry is matched, then the
122.Cm Host
123entry is ignored, regardless of whether any other patterns on the line
124match.
125Negated matches are therefore useful to provide exceptions for wildcard
126matches.
127.Pp
Damien Millerf54a4b92006-03-15 11:54:36 +1100128See
129.Sx PATTERNS
130for more information on patterns.
Damien Millerd77b81f2013-10-17 11:39:00 +1100131.It Cm Match
Damien Miller194fd902013-10-15 12:13:05 +1100132Restricts the following declarations (up to the next
133.Cm Host
134or
135.Cm Match
136keyword) to be used only when the conditions following the
137.Cm Match
138keyword are satisfied.
sobrado@openbsd.orge3cbb062015-09-22 08:33:23 +0000139Match conditions are specified using one or more criteria
Damien Millercf31f382013-10-24 21:02:56 +1100140or the single token
141.Cm all
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000142which always matches.
143The available criteria keywords are:
144.Cm canonical ,
Damien Miller8a04be72013-10-23 16:29:40 +1100145.Cm exec ,
Damien Miller194fd902013-10-15 12:13:05 +1100146.Cm host ,
147.Cm originalhost ,
148.Cm user ,
149and
150.Cm localuser .
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000151The
152.Cm all
153criteria must appear alone or immediately after
jmc@openbsd.orgb1ba15f2014-10-09 06:21:31 +0000154.Cm canonical .
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000155Other criteria may be combined arbitrarily.
156All criteria but
157.Cm all
158and
159.Cm canonical
160require an argument.
161Criteria may be negated by prepending an exclamation mark
162.Pq Sq !\& .
Damien Miller194fd902013-10-15 12:13:05 +1100163.Pp
Damien Miller8e5a67f2013-10-23 16:30:25 +1100164The
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000165.Cm canonical
dtucker@openbsd.orgdd2cfeb2015-05-28 05:09:45 +0000166keyword matches only when the configuration file is being re-parsed
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000167after hostname canonicalization (see the
168.Cm CanonicalizeHostname
169option.)
170This may be useful to specify conditions that work with canonical host
171names only.
172The
Damien Miller8a04be72013-10-23 16:29:40 +1100173.Cm exec
Damien Miller8e5a67f2013-10-23 16:30:25 +1100174keyword executes the specified command under the user's shell.
Damien Miller194fd902013-10-15 12:13:05 +1100175If the command returns a zero exit status then the condition is considered true.
176Commands containing whitespace characters must be quoted.
jmc@openbsd.org80d1c962016-09-28 17:59:22 +0000177Arguments to
178.Cm exec
179accept the tokens described in the
180.Sx TOKENS
181section.
Damien Miller194fd902013-10-15 12:13:05 +1100182.Pp
183The other keywords' criteria must be single entries or comma-separated
184lists and may use the wildcard and negation operators described in the
185.Sx PATTERNS
186section.
187The criteria for the
188.Cm host
189keyword are matched against the target hostname, after any substitution
190by the
191.Cm Hostname
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000192or
193.Cm CanonicalizeHostname
194options.
Damien Miller194fd902013-10-15 12:13:05 +1100195The
196.Cm originalhost
197keyword matches against the hostname as it was specified on the command-line.
198The
199.Cm user
200keyword matches against the target username on the remote host.
201The
202.Cm localuser
203keyword matches against the name of the local user running
204.Xr ssh 1
205(this keyword may be useful in system-wide
206.Nm
207files).
jcs@openbsd.orgf361df42015-11-15 22:26:49 +0000208.It Cm AddKeysToAgent
209Specifies whether keys should be automatically added to a running
jmc@openbsd.orge41a0712015-11-15 23:58:04 +0000210.Xr ssh-agent 1 .
jcs@openbsd.orgf361df42015-11-15 22:26:49 +0000211If this option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000212.Cm yes
jcs@openbsd.orgf361df42015-11-15 22:26:49 +0000213and a key is loaded from a file, the key and its passphrase are added to
214the agent with the default lifetime, as if by
215.Xr ssh-add 1 .
216If this option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000217.Cm ask ,
218.Xr ssh 1
jcs@openbsd.orgf361df42015-11-15 22:26:49 +0000219will require confirmation using the
220.Ev SSH_ASKPASS
221program before adding a key (see
222.Xr ssh-add 1
223for details).
224If this option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000225.Cm confirm ,
jcs@openbsd.orgf361df42015-11-15 22:26:49 +0000226each use of the key must be confirmed, as if the
227.Fl c
228option was specified to
229.Xr ssh-add 1 .
230If this option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000231.Cm no ,
jcs@openbsd.orgf361df42015-11-15 22:26:49 +0000232no keys are added to the agent.
233The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000234.Cm yes ,
235.Cm confirm ,
236.Cm ask ,
jcs@openbsd.orgf361df42015-11-15 22:26:49 +0000237or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000238.Cm no
239(the default).
Damien Miller20a8f972003-05-18 20:50:30 +1000240.It Cm AddressFamily
Damien Millerfbf486b2003-05-23 18:44:23 +1000241Specifies which address family to use when connecting.
242Valid arguments are
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000243.Cm any
244(the default),
245.Cm inet
Damien Miller45ee2b92006-03-15 11:56:18 +1100246(use IPv4 only), or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000247.Cm inet6
Darren Tucker79a7acf2005-02-09 09:48:57 +1100248(use IPv6 only).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000249.It Cm BatchMode
250If set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000251.Cm yes ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000252passphrase/password querying will be disabled.
253This option is useful in scripts and other batch jobs where no user
254is present to supply the password.
255The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000256.Cm yes
Ben Lindstrom9f049032002-06-21 00:59:05 +0000257or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000258.Cm no
259(the default).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000260.It Cm BindAddress
Darren Tucker89f4d472005-07-14 17:06:21 +1000261Use the specified address on the local machine as the source address of
Darren Tucker6c71d202005-07-14 17:06:50 +1000262the connection.
263Only useful on systems with more than one address.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000264Note that this option does not work if
265.Cm UsePrivilegedPort
266is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000267.Cm yes .
Damien Miller0faf7472013-10-17 11:47:23 +1100268.It Cm CanonicalDomains
Damien Miller607af342013-10-17 11:47:51 +1100269When
Damien Miller38505592013-10-17 11:48:13 +1100270.Cm CanonicalizeHostname
Damien Miller0faf7472013-10-17 11:47:23 +1100271is enabled, this option specifies the list of domain suffixes in which to
272search for the specified destination host.
Damien Miller38505592013-10-17 11:48:13 +1100273.It Cm CanonicalizeFallbackLocal
Damien Miller51682fa2013-10-17 11:48:31 +1100274Specifies whether to fail with an error when hostname canonicalization fails.
Damien Miller607af342013-10-17 11:47:51 +1100275The default,
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000276.Cm yes ,
Damien Miller607af342013-10-17 11:47:51 +1100277will attempt to look up the unqualified hostname using the system resolver's
Damien Miller0faf7472013-10-17 11:47:23 +1100278search rules.
279A value of
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000280.Cm no
Damien Miller0faf7472013-10-17 11:47:23 +1100281will cause
282.Xr ssh 1
283to fail instantly if
Damien Miller38505592013-10-17 11:48:13 +1100284.Cm CanonicalizeHostname
Damien Miller0faf7472013-10-17 11:47:23 +1100285is enabled and the target hostname cannot be found in any of the domains
286specified by
287.Cm CanonicalDomains .
Damien Miller38505592013-10-17 11:48:13 +1100288.It Cm CanonicalizeHostname
Damien Miller51682fa2013-10-17 11:48:31 +1100289Controls whether explicit hostname canonicalization is performed.
Damien Miller607af342013-10-17 11:47:51 +1100290The default,
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000291.Cm no ,
Damien Miller0faf7472013-10-17 11:47:23 +1100292is not to perform any name rewriting and let the system resolver handle all
293hostname lookups.
294If set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000295.Cm yes
Damien Miller0faf7472013-10-17 11:47:23 +1100296then, for connections that do not use a
297.Cm ProxyCommand ,
298.Xr ssh 1
Damien Miller38505592013-10-17 11:48:13 +1100299will attempt to canonicalize the hostname specified on the command line
Damien Miller0faf7472013-10-17 11:47:23 +1100300using the
301.Cm CanonicalDomains
302suffixes and
Damien Miller38505592013-10-17 11:48:13 +1100303.Cm CanonicalizePermittedCNAMEs
Damien Miller0faf7472013-10-17 11:47:23 +1100304rules.
305If
Damien Miller38505592013-10-17 11:48:13 +1100306.Cm CanonicalizeHostname
Damien Miller0faf7472013-10-17 11:47:23 +1100307is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000308.Cm always ,
Damien Miller51682fa2013-10-17 11:48:31 +1100309then canonicalization is applied to proxied connections too.
Damien Miller13f97b22014-02-24 15:57:55 +1100310.Pp
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000311If this option is enabled, then the configuration files are processed
312again using the new target name to pick up any new configuration in matching
Damien Miller13f97b22014-02-24 15:57:55 +1100313.Cm Host
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000314and
315.Cm Match
Damien Miller13f97b22014-02-24 15:57:55 +1100316stanzas.
Damien Miller38505592013-10-17 11:48:13 +1100317.It Cm CanonicalizeMaxDots
Damien Miller607af342013-10-17 11:47:51 +1100318Specifies the maximum number of dot characters in a hostname before
Damien Miller51682fa2013-10-17 11:48:31 +1100319canonicalization is disabled.
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000320The default, 1,
Damien Miller607af342013-10-17 11:47:51 +1100321allows a single dot (i.e. hostname.subdomain).
Damien Miller38505592013-10-17 11:48:13 +1100322.It Cm CanonicalizePermittedCNAMEs
Damien Miller607af342013-10-17 11:47:51 +1100323Specifies rules to determine whether CNAMEs should be followed when
Damien Miller38505592013-10-17 11:48:13 +1100324canonicalizing hostnames.
Damien Miller0faf7472013-10-17 11:47:23 +1100325The rules consist of one or more arguments of
Damien Miller607af342013-10-17 11:47:51 +1100326.Ar source_domain_list : Ns Ar target_domain_list ,
Damien Miller0faf7472013-10-17 11:47:23 +1100327where
328.Ar source_domain_list
Damien Miller51682fa2013-10-17 11:48:31 +1100329is a pattern-list of domains that may follow CNAMEs in canonicalization,
Damien Miller0faf7472013-10-17 11:47:23 +1100330and
331.Ar target_domain_list
Damien Miller607af342013-10-17 11:47:51 +1100332is a pattern-list of domains that they may resolve to.
Damien Miller0faf7472013-10-17 11:47:23 +1100333.Pp
334For example,
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000335.Qq *.a.example.com:*.b.example.com,*.c.example.com
Damien Miller0faf7472013-10-17 11:47:23 +1100336will allow hostnames matching
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000337.Qq *.a.example.com
Damien Miller38505592013-10-17 11:48:13 +1100338to be canonicalized to names in the
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000339.Qq *.b.example.com
Damien Miller0faf7472013-10-17 11:47:23 +1100340or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000341.Qq *.c.example.com
Damien Miller0faf7472013-10-17 11:47:23 +1100342domains.
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000343.It Cm CertificateFile
344Specifies a file from which the user's certificate is read.
345A corresponding private key must be provided separately in order
346to use this certificate either
347from an
348.Cm IdentityFile
349directive or
350.Fl i
351flag to
352.Xr ssh 1 ,
353via
354.Xr ssh-agent 1 ,
355or via a
356.Cm PKCS11Provider .
357.Pp
jmc@openbsd.org80d1c962016-09-28 17:59:22 +0000358Arguments to
359.Cm CertificateFile
360may use the tilde syntax to refer to a user's home directory
361or the tokens described in the
362.Sx TOKENS
363section.
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000364.Pp
365It is possible to have multiple certificate files specified in
366configuration files; these certificates will be tried in sequence.
367Multiple
368.Cm CertificateFile
369directives will add to the list of certificates used for
370authentication.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000371.It Cm ChallengeResponseAuthentication
Damien Miller1faa7132006-03-15 11:55:31 +1100372Specifies whether to use challenge-response authentication.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000373The argument to this keyword must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000374.Cm yes
375(the default)
Ben Lindstrom9f049032002-06-21 00:59:05 +0000376or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000377.Cm no .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000378.It Cm CheckHostIP
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000379If set to
380.Cm yes
381(the default),
Damien Miller45ee2b92006-03-15 11:56:18 +1100382.Xr ssh 1
383will additionally check the host IP address in the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000384.Pa known_hosts
385file.
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000386This allows it to detect if a host key changed due to DNS spoofing
djm@openbsd.org5e678592015-06-02 09:10:40 +0000387and will add addresses of destination hosts to
388.Pa ~/.ssh/known_hosts
389in the process, regardless of the setting of
390.Cm StrictHostKeyChecking .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000391If the option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000392.Cm no ,
Ben Lindstrom9f049032002-06-21 00:59:05 +0000393the check will not be executed.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000394.It Cm Cipher
395Specifies the cipher to use for encrypting the session
396in protocol version 1.
397Currently,
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000398.Cm blowfish ,
399.Cm 3des
400(the default),
Ben Lindstrom9f049032002-06-21 00:59:05 +0000401and
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000402.Cm des
403are supported,
404though
405.Cm des
Ben Lindstrom9f049032002-06-21 00:59:05 +0000406is only supported in the
Damien Miller45ee2b92006-03-15 11:56:18 +1100407.Xr ssh 1
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000408client for interoperability with legacy protocol 1 implementations;
409its use is strongly discouraged due to cryptographic weaknesses.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000410.It Cm Ciphers
411Specifies the ciphers allowed for protocol version 2
412in order of preference.
413Multiple ciphers must be comma-separated.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +0000414If the specified value begins with a
415.Sq +
416character, then the specified ciphers will be appended to the default set
417instead of replacing them.
418.Pp
Damien Miller0fde8ac2013-11-21 14:12:23 +1100419The supported ciphers are:
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000420.Bd -literal -offset indent
Damien Millerc1621c82014-04-20 13:22:46 +10004213des-cbc
Damien Millerc1621c82014-04-20 13:22:46 +1000422aes128-cbc
Damien Millerc1621c82014-04-20 13:22:46 +1000423aes192-cbc
Damien Millerc1621c82014-04-20 13:22:46 +1000424aes256-cbc
Damien Millerc1621c82014-04-20 13:22:46 +1000425aes128-ctr
Damien Millerc1621c82014-04-20 13:22:46 +1000426aes192-ctr
Damien Millerc1621c82014-04-20 13:22:46 +1000427aes256-ctr
Damien Millerc1621c82014-04-20 13:22:46 +1000428aes128-gcm@openssh.com
Damien Millerc1621c82014-04-20 13:22:46 +1000429aes256-gcm@openssh.com
Damien Millerc1621c82014-04-20 13:22:46 +1000430arcfour
Damien Millerc1621c82014-04-20 13:22:46 +1000431arcfour128
Damien Millerc1621c82014-04-20 13:22:46 +1000432arcfour256
Damien Millerc1621c82014-04-20 13:22:46 +1000433blowfish-cbc
Damien Millerc1621c82014-04-20 13:22:46 +1000434cast128-cbc
Damien Millerc1621c82014-04-20 13:22:46 +1000435chacha20-poly1305@openssh.com
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000436.Ed
Damien Miller0fde8ac2013-11-21 14:12:23 +1100437.Pp
Damien Miller45ee2b92006-03-15 11:56:18 +1100438The default is:
Damien Millerc1621c82014-04-20 13:22:46 +1000439.Bd -literal -offset indent
jmc@openbsd.org1f8d3d62015-08-14 15:32:41 +0000440chacha20-poly1305@openssh.com,
Damien Millerc1621c82014-04-20 13:22:46 +1000441aes128-ctr,aes192-ctr,aes256-ctr,
Damien Miller1d75abf2013-01-09 16:12:19 +1100442aes128-gcm@openssh.com,aes256-gcm@openssh.com,
djm@openbsd.orgda953182016-09-05 14:02:42 +0000443aes128-cbc,aes192-cbc,aes256-cbc
Ben Lindstrom9f049032002-06-21 00:59:05 +0000444.Ed
Damien Miller0fde8ac2013-11-21 14:12:23 +1100445.Pp
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000446The list of available ciphers may also be obtained using
447.Qq ssh -Q cipher .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000448.It Cm ClearAllForwardings
Damien Miller45ee2b92006-03-15 11:56:18 +1100449Specifies that all local, remote, and dynamic port forwardings
Ben Lindstrom9f049032002-06-21 00:59:05 +0000450specified in the configuration files or on the command line be
Damien Miller495dca32003-04-01 21:42:14 +1000451cleared.
452This option is primarily useful when used from the
Damien Miller45ee2b92006-03-15 11:56:18 +1100453.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000454command line to clear port forwardings set in
455configuration files, and is automatically set by
456.Xr scp 1
457and
458.Xr sftp 1 .
459The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000460.Cm yes
Ben Lindstrom9f049032002-06-21 00:59:05 +0000461or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000462.Cm no
463(the default).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000464.It Cm Compression
465Specifies whether to use compression.
466The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000467.Cm yes
Ben Lindstrom9f049032002-06-21 00:59:05 +0000468or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000469.Cm no
470(the default).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000471.It Cm CompressionLevel
472Specifies the compression level to use if compression is enabled.
473The argument must be an integer from 1 (fast) to 9 (slow, best).
474The default level is 6, which is good for most applications.
475The meaning of the values is the same as in
476.Xr gzip 1 .
477Note that this option applies to protocol version 1 only.
478.It Cm ConnectionAttempts
479Specifies the number of tries (one per second) to make before exiting.
480The argument must be an integer.
481This may be useful in scripts if the connection sometimes fails.
482The default is 1.
Damien Millerb78d5eb2003-05-16 11:39:04 +1000483.It Cm ConnectTimeout
Damien Miller45ee2b92006-03-15 11:56:18 +1100484Specifies the timeout (in seconds) used when connecting to the
485SSH server, instead of using the default system TCP timeout.
Damien Millerfbf486b2003-05-23 18:44:23 +1000486This value is used only when the target is down or really unreachable,
487not when it refuses the connection.
Damien Miller0e220db2004-06-15 10:34:08 +1000488.It Cm ControlMaster
489Enables the sharing of multiple sessions over a single network connection.
490When set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000491.Cm yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +1100492.Xr ssh 1
Damien Miller0e220db2004-06-15 10:34:08 +1000493will listen for connections on a control socket specified using the
494.Cm ControlPath
495argument.
496Additional sessions can connect to this socket using the same
497.Cm ControlPath
498with
499.Cm ControlMaster
500set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000501.Cm no
Damien Miller2234bac2004-06-30 22:38:52 +1000502(the default).
Damien Miller713de762005-11-05 15:13:49 +1100503These sessions will try to reuse the master instance's network connection
Damien Millerb3bfbb72005-11-05 15:11:48 +1100504rather than initiating new ones, but will fall back to connecting normally
505if the control socket does not exist, or is not listening.
506.Pp
Damien Miller23f07702004-06-18 01:19:03 +1000507Setting this to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000508.Cm ask
509will cause
510.Xr ssh 1
jmc@openbsd.org78de1672015-03-30 18:28:37 +0000511to listen for control connections, but require confirmation using
512.Xr ssh-askpass 1 .
Damien Millerdadfd4d2005-05-26 12:07:13 +1000513If the
514.Cm ControlPath
Damien Miller45ee2b92006-03-15 11:56:18 +1100515cannot be opened,
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000516.Xr ssh 1
517will continue without connecting to a master instance.
Damien Millerd14b1e72005-06-16 13:19:41 +1000518.Pp
Damien Miller13390022005-07-06 09:44:19 +1000519X11 and
Damien Millerfd94fba2005-07-06 09:44:59 +1000520.Xr ssh-agent 1
Damien Miller13390022005-07-06 09:44:19 +1000521forwarding is supported over these multiplexed connections, however the
Darren Tucker63551872005-12-20 16:14:15 +1100522display and agent forwarded will be the one belonging to the master
Damien Millerfd94fba2005-07-06 09:44:59 +1000523connection i.e. it is not possible to forward multiple displays or agents.
Damien Miller13390022005-07-06 09:44:19 +1000524.Pp
Damien Millerd14b1e72005-06-16 13:19:41 +1000525Two additional options allow for opportunistic multiplexing: try to use a
526master connection but fall back to creating a new one if one does not already
527exist.
528These options are:
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000529.Cm auto
Damien Millerd14b1e72005-06-16 13:19:41 +1000530and
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000531.Cm autoask .
Damien Millerd14b1e72005-06-16 13:19:41 +1000532The latter requires confirmation like the
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000533.Cm ask
Damien Millerd14b1e72005-06-16 13:19:41 +1000534option.
Damien Miller0e220db2004-06-15 10:34:08 +1000535.It Cm ControlPath
Damien Miller6476cad2005-06-16 13:18:34 +1000536Specify the path to the control socket used for connection sharing as described
537in the
Damien Miller0e220db2004-06-15 10:34:08 +1000538.Cm ControlMaster
Damien Miller8f74c8f2005-06-26 08:56:03 +1000539section above or the string
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000540.Cm none
Damien Miller8f74c8f2005-06-26 08:56:03 +1000541to disable connection sharing.
jmc@openbsd.org80d1c962016-09-28 17:59:22 +0000542Arguments to
543.Cm ControlPath
544may use the tilde syntax to refer to a user's home directory
545or the tokens described in the
546.Sx TOKENS
547section.
Damien Millerd14b1e72005-06-16 13:19:41 +1000548It is recommended that any
549.Cm ControlPath
550used for opportunistic connection sharing include
djm@openbsd.orgfc302562014-11-10 22:25:49 +0000551at least %h, %p, and %r (or alternatively %C) and be placed in a directory
552that is not writable by other users.
Damien Millerd14b1e72005-06-16 13:19:41 +1000553This ensures that shared connections are uniquely identified.
Damien Millere11e1ea2010-08-03 16:04:46 +1000554.It Cm ControlPersist
555When used in conjunction with
556.Cm ControlMaster ,
557specifies that the master connection should remain open
558in the background (waiting for future client connections)
559after the initial client connection has been closed.
560If set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000561.Cm no ,
Damien Millere11e1ea2010-08-03 16:04:46 +1000562then the master connection will not be placed into the background,
563and will close as soon as the initial client connection is closed.
564If set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000565.Cm yes
566or 0,
Damien Millere11e1ea2010-08-03 16:04:46 +1000567then the master connection will remain in the background indefinitely
568(until killed or closed via a mechanism such as the
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000569.Qq ssh -O exit ) .
Damien Millere11e1ea2010-08-03 16:04:46 +1000570If set to a time in seconds, or a time in any of the formats documented in
571.Xr sshd_config 5 ,
572then the backgrounded master connection will automatically terminate
573after it has remained idle (with no client connections) for the
574specified time.
Damien Miller2234bac2004-06-30 22:38:52 +1000575.It Cm DynamicForward
Damien Millere9d001e2006-01-14 10:10:17 +1100576Specifies that a TCP port on the local machine be forwarded
Damien Miller2234bac2004-06-30 22:38:52 +1000577over the secure channel, and the application
578protocol is then used to determine where to connect to from the
579remote machine.
Darren Tuckerc8d64212005-10-03 18:13:42 +1000580.Pp
581The argument must be
582.Sm off
583.Oo Ar bind_address : Oc Ar port .
584.Sm on
Damien Miller7fa96602010-08-05 13:03:13 +1000585IPv6 addresses can be specified by enclosing addresses in square brackets.
Darren Tuckerc8d64212005-10-03 18:13:42 +1000586By default, the local port is bound in accordance with the
587.Cm GatewayPorts
588setting.
589However, an explicit
590.Ar bind_address
591may be used to bind the connection to a specific address.
592The
593.Ar bind_address
594of
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000595.Cm localhost
Darren Tuckerc8d64212005-10-03 18:13:42 +1000596indicates that the listening port be bound for local use only, while an
597empty address or
598.Sq *
599indicates that the port should be available from all interfaces.
600.Pp
Damien Miller2234bac2004-06-30 22:38:52 +1000601Currently the SOCKS4 and SOCKS5 protocols are supported, and
Damien Miller45ee2b92006-03-15 11:56:18 +1100602.Xr ssh 1
Damien Miller2234bac2004-06-30 22:38:52 +1000603will act as a SOCKS server.
604Multiple forwardings may be specified, and
605additional forwardings can be given on the command line.
606Only the superuser can forward privileged ports.
Darren Tucker674f71d2003-06-28 12:33:12 +1000607.It Cm EnableSSHKeysign
608Setting this option to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000609.Cm yes
Darren Tucker674f71d2003-06-28 12:33:12 +1000610in the global client configuration file
611.Pa /etc/ssh/ssh_config
612enables the use of the helper program
613.Xr ssh-keysign 8
614during
615.Cm HostbasedAuthentication .
616The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000617.Cm yes
Darren Tucker674f71d2003-06-28 12:33:12 +1000618or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000619.Cm no
620(the default).
Darren Tuckerf132c672003-10-15 15:58:18 +1000621This option should be placed in the non-hostspecific section.
Darren Tucker674f71d2003-06-28 12:33:12 +1000622See
623.Xr ssh-keysign 8
624for more information.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000625.It Cm EscapeChar
626Sets the escape character (default:
627.Ql ~ ) .
628The escape character can also
629be set on the command line.
630The argument should be a single character,
631.Ql ^
632followed by a letter, or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000633.Cm none
Ben Lindstrom9f049032002-06-21 00:59:05 +0000634to disable the escape
635character entirely (making the connection transparent for binary
636data).
Darren Tuckere7d4b192006-07-12 22:17:10 +1000637.It Cm ExitOnForwardFailure
638Specifies whether
639.Xr ssh 1
640should terminate the connection if it cannot set up all requested
djm@openbsd.orga954cdb2015-09-04 04:47:50 +0000641dynamic, tunnel, local, and remote port forwardings, (e.g.\&
jmc@openbsd.org5245bc12015-09-04 06:40:45 +0000642if either end is unable to bind and listen on a specified port).
djm@openbsd.orga954cdb2015-09-04 04:47:50 +0000643Note that
644.Cm ExitOnForwardFailure
645does not apply to connections made over port forwardings and will not,
646for example, cause
647.Xr ssh 1
648to exit if TCP connections to the ultimate forwarding destination fail.
Darren Tuckere7d4b192006-07-12 22:17:10 +1000649The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000650.Cm yes
Darren Tuckere7d4b192006-07-12 22:17:10 +1000651or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000652.Cm no
653(the default).
djm@openbsd.orgb79efde2014-12-21 23:12:42 +0000654.It Cm FingerprintHash
655Specifies the hash algorithm used when displaying key fingerprints.
656Valid options are:
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000657.Cm md5
djm@openbsd.orgb79efde2014-12-21 23:12:42 +0000658and
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000659.Cm sha256
660(the default).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000661.It Cm ForwardAgent
662Specifies whether the connection to the authentication agent (if any)
663will be forwarded to the remote machine.
664The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000665.Cm yes
Ben Lindstrom9f049032002-06-21 00:59:05 +0000666or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000667.Cm no
668(the default).
Damien Milleraf653042002-09-04 16:40:37 +1000669.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000670Agent forwarding should be enabled with caution.
671Users with the ability to bypass file permissions on the remote host
672(for the agent's Unix-domain socket)
673can access the local agent through the forwarded connection.
674An attacker cannot obtain key material from the agent,
Damien Milleraf653042002-09-04 16:40:37 +1000675however they can perform operations on the keys that enable them to
676authenticate using the identities loaded into the agent.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000677.It Cm ForwardX11
678Specifies whether X11 connections will be automatically redirected
679over the secure channel and
680.Ev DISPLAY
681set.
682The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000683.Cm yes
Ben Lindstrom9f049032002-06-21 00:59:05 +0000684or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000685.Cm no
686(the default).
Damien Milleraf653042002-09-04 16:40:37 +1000687.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000688X11 forwarding should be enabled with caution.
689Users with the ability to bypass file permissions on the remote host
Darren Tucker0a118da2003-10-15 15:54:32 +1000690(for the user's X11 authorization database)
Damien Miller495dca32003-04-01 21:42:14 +1000691can access the local X11 display through the forwarded connection.
Darren Tucker0a118da2003-10-15 15:54:32 +1000692An attacker may then be able to perform activities such as keystroke monitoring
693if the
694.Cm ForwardX11Trusted
695option is also enabled.
Damien Miller1ab6a512010-06-26 10:02:24 +1000696.It Cm ForwardX11Timeout
Damien Millercede1db2010-07-02 13:33:48 +1000697Specify a timeout for untrusted X11 forwarding
698using the format described in the
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000699.Sx TIME FORMATS
700section of
Damien Miller1ab6a512010-06-26 10:02:24 +1000701.Xr sshd_config 5 .
702X11 connections received by
703.Xr ssh 1
704after this time will be refused.
705The default is to disable untrusted X11 forwarding after twenty minutes has
706elapsed.
Darren Tucker0a118da2003-10-15 15:54:32 +1000707.It Cm ForwardX11Trusted
Darren Tuckerdcf6ec42004-05-13 13:03:56 +1000708If this option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000709.Cm yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +1100710remote X11 clients will have full access to the original X11 display.
Damien Miller1717fd42005-03-01 21:17:31 +1100711.Pp
Darren Tucker0a118da2003-10-15 15:54:32 +1000712If this option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000713.Cm no
714(the default),
Damien Miller45ee2b92006-03-15 11:56:18 +1100715remote X11 clients will be considered untrusted and prevented
Darren Tucker0a118da2003-10-15 15:54:32 +1000716from stealing or tampering with data belonging to trusted X11
717clients.
Damien Miller1717fd42005-03-01 21:17:31 +1100718Furthermore, the
719.Xr xauth 1
720token used for the session will be set to expire after 20 minutes.
721Remote clients will be refused access after this time.
Darren Tucker0a118da2003-10-15 15:54:32 +1000722.Pp
Darren Tucker0a118da2003-10-15 15:54:32 +1000723See the X11 SECURITY extension specification for full details on
724the restrictions imposed on untrusted clients.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000725.It Cm GatewayPorts
726Specifies whether remote hosts are allowed to connect to local
727forwarded ports.
728By default,
Damien Miller45ee2b92006-03-15 11:56:18 +1100729.Xr ssh 1
Damien Miller495dca32003-04-01 21:42:14 +1000730binds local port forwardings to the loopback address.
731This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000732.Cm GatewayPorts
Damien Miller45ee2b92006-03-15 11:56:18 +1100733can be used to specify that ssh
Ben Lindstrom9f049032002-06-21 00:59:05 +0000734should bind local port forwardings to the wildcard address,
735thus allowing remote hosts to connect to forwarded ports.
736The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000737.Cm yes
Ben Lindstrom9f049032002-06-21 00:59:05 +0000738or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000739.Cm no
740(the default).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000741.It Cm GlobalKnownHostsFile
Damien Miller295ee632011-05-29 21:42:31 +1000742Specifies one or more files to use for the global
743host key database, separated by whitespace.
744The default is
745.Pa /etc/ssh/ssh_known_hosts ,
746.Pa /etc/ssh/ssh_known_hosts2 .
Darren Tucker0efd1552003-08-26 11:49:55 +1000747.It Cm GSSAPIAuthentication
Damien Millerbaafb982003-12-17 16:32:23 +1100748Specifies whether user authentication based on GSSAPI is allowed.
Damien Millerc2b98272003-09-03 12:13:30 +1000749The default is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000750.Cm no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000751.It Cm GSSAPIDelegateCredentials
752Forward (delegate) credentials to the server.
753The default is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000754.Cm no .
Damien Millere1776152005-03-01 21:47:37 +1100755.It Cm HashKnownHosts
756Indicates that
Damien Miller45ee2b92006-03-15 11:56:18 +1100757.Xr ssh 1
Damien Millere1776152005-03-01 21:47:37 +1100758should hash host names and addresses when they are added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000759.Pa ~/.ssh/known_hosts .
Damien Millere1776152005-03-01 21:47:37 +1100760These hashed names may be used normally by
Damien Miller45ee2b92006-03-15 11:56:18 +1100761.Xr ssh 1
Damien Millere1776152005-03-01 21:47:37 +1100762and
Damien Miller45ee2b92006-03-15 11:56:18 +1100763.Xr sshd 8 ,
Damien Millere1776152005-03-01 21:47:37 +1100764but they do not reveal identifying information should the file's contents
765be disclosed.
766The default is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000767.Cm no .
Damien Miller858bb7d2006-08-05 11:34:51 +1000768Note that existing names and addresses in known hosts files
769will not be converted automatically,
770but may be manually hashed using
Damien Miller4b42d7f2005-03-01 21:48:35 +1100771.Xr ssh-keygen 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000772.It Cm HostbasedAuthentication
773Specifies whether to try rhosts based authentication with public key
774authentication.
775The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000776.Cm yes
Ben Lindstrom9f049032002-06-21 00:59:05 +0000777or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000778.Cm no
779(the default).
djm@openbsd.org46347ed2015-01-30 11:43:14 +0000780.It Cm HostbasedKeyTypes
781Specifies the key types that will be used for hostbased authentication
782as a comma-separated pattern list.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +0000783Alternately if the specified value begins with a
784.Sq +
785character, then the specified key types will be appended to the default set
786instead of replacing them.
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000787The default for this option is:
788.Bd -literal -offset 3n
789ecdsa-sha2-nistp256-cert-v01@openssh.com,
790ecdsa-sha2-nistp384-cert-v01@openssh.com,
791ecdsa-sha2-nistp521-cert-v01@openssh.com,
792ssh-ed25519-cert-v01@openssh.com,
793ssh-rsa-cert-v01@openssh.com,
794ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
djm@openbsd.org3a13cb52016-02-17 08:57:34 +0000795ssh-ed25519,ssh-rsa
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000796.Ed
797.Pp
djm@openbsd.org46347ed2015-01-30 11:43:14 +0000798The
799.Fl Q
800option of
801.Xr ssh 1
802may be used to list supported key types.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000803.It Cm HostKeyAlgorithms
jmc@openbsd.orga685ae82016-02-17 07:38:19 +0000804Specifies the host key algorithms
Ben Lindstrom9f049032002-06-21 00:59:05 +0000805that the client wants to use in order of preference.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +0000806Alternately if the specified value begins with a
807.Sq +
808character, then the specified key types will be appended to the default set
809instead of replacing them.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000810The default for this option is:
Damien Millereb8b60e2010-08-31 22:41:14 +1000811.Bd -literal -offset 3n
812ecdsa-sha2-nistp256-cert-v01@openssh.com,
813ecdsa-sha2-nistp384-cert-v01@openssh.com,
814ecdsa-sha2-nistp521-cert-v01@openssh.com,
Damien Miller8ba0ead2013-12-18 17:46:27 +1100815ssh-ed25519-cert-v01@openssh.com,
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000816ssh-rsa-cert-v01@openssh.com,
Damien Millereb8b60e2010-08-31 22:41:14 +1000817ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
djm@openbsd.org3a13cb52016-02-17 08:57:34 +0000818ssh-ed25519,ssh-rsa
Damien Millereb8b60e2010-08-31 22:41:14 +1000819.Ed
Damien Millerd925dcd2010-12-01 12:21:51 +1100820.Pp
821If hostkeys are known for the destination host then this default is modified
822to prefer their algorithms.
djm@openbsd.org8f6784f2014-12-22 09:05:17 +0000823.Pp
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000824The list of available key types may also be obtained using
825.Qq ssh -Q key .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000826.It Cm HostKeyAlias
827Specifies an alias that should be used instead of the
828real host name when looking up or saving the host key
829in the host key database files.
Damien Miller45ee2b92006-03-15 11:56:18 +1100830This option is useful for tunneling SSH connections
Ben Lindstrom9f049032002-06-21 00:59:05 +0000831or for multiple servers running on a single host.
832.It Cm HostName
833Specifies the real host name to log into.
834This can be used to specify nicknames or abbreviations for hosts.
jmc@openbsd.org80d1c962016-09-28 17:59:22 +0000835Arguments to
836.Cm HostName
837accept the tokens described in the
838.Sx TOKENS
839section.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000840Numeric IP addresses are also permitted (both on the command line and in
841.Cm HostName
842specifications).
jmc@openbsd.org80d1c962016-09-28 17:59:22 +0000843The default is the name given on the command line.
Damien Millerbd394c32004-03-08 23:12:36 +1100844.It Cm IdentitiesOnly
845Specifies that
Damien Miller45ee2b92006-03-15 11:56:18 +1100846.Xr ssh 1
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000847should only use the authentication identity and certificate files explicitly
848configured in the
Damien Miller1a812582004-04-20 20:13:32 +1000849.Nm
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000850files
851or passed on the
852.Xr ssh 1
853command-line,
Damien Miller45ee2b92006-03-15 11:56:18 +1100854even if
855.Xr ssh-agent 1
Damien Millercb6b68b2012-12-03 09:49:52 +1100856or a
857.Cm PKCS11Provider
Damien Millerbd394c32004-03-08 23:12:36 +1100858offers more identities.
859The argument to this keyword must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000860.Cm yes
Damien Millerbd394c32004-03-08 23:12:36 +1100861or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000862.Cm no
863(the default).
Damien Miller45ee2b92006-03-15 11:56:18 +1100864This option is intended for situations where ssh-agent
Damien Millerbd394c32004-03-08 23:12:36 +1100865offers many different identities.
markus@openbsd.orgb02ad1c2016-05-04 12:21:53 +0000866.It Cm IdentityAgent
867Specifies the
868.Ux Ns -domain
869socket used to communicate with the authentication agent.
870.Pp
871This option overrides the
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000872.Ev SSH_AUTH_SOCK
markus@openbsd.orgb02ad1c2016-05-04 12:21:53 +0000873environment variable and can be used to select a specific agent.
874Setting the socket name to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000875.Cm none
markus@openbsd.orgb02ad1c2016-05-04 12:21:53 +0000876disables the use of an authentication agent.
markus@openbsd.org1a75d142016-05-04 14:29:58 +0000877If the string
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000878.Qq SSH_AUTH_SOCK
markus@openbsd.org1a75d142016-05-04 14:29:58 +0000879is specified, the location of the socket will be read from the
880.Ev SSH_AUTH_SOCK
881environment variable.
markus@openbsd.orgb02ad1c2016-05-04 12:21:53 +0000882.Pp
jmc@openbsd.org80d1c962016-09-28 17:59:22 +0000883Arguments to
884.Cm IdentityAgent
885may use the tilde syntax to refer to a user's home directory
886or the tokens described in the
887.Sx TOKENS
888section.
Damien Miller957d4e42005-12-13 19:30:45 +1100889.It Cm IdentityFile
sobrado@openbsd.orgf70b22b2014-08-30 15:33:50 +0000890Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication
Damien Millereb8b60e2010-08-31 22:41:14 +1000891identity is read.
Damien Miller957d4e42005-12-13 19:30:45 +1100892The default is
893.Pa ~/.ssh/identity
894for protocol version 1, and
Damien Millereb8b60e2010-08-31 22:41:14 +1000895.Pa ~/.ssh/id_dsa ,
Damien Miller8ba0ead2013-12-18 17:46:27 +1100896.Pa ~/.ssh/id_ecdsa ,
897.Pa ~/.ssh/id_ed25519
Damien Miller957d4e42005-12-13 19:30:45 +1100898and
Damien Millereb8b60e2010-08-31 22:41:14 +1000899.Pa ~/.ssh/id_rsa
Damien Miller957d4e42005-12-13 19:30:45 +1100900for protocol version 2.
901Additionally, any identities represented by the authentication agent
Damien Miller7f2b4382013-07-18 16:10:29 +1000902will be used for authentication unless
903.Cm IdentitiesOnly
904is set.
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000905If no certificates have been explicitly specified by
906.Cm CertificateFile ,
Damien Miller5059d8d2010-03-05 21:31:11 +1100907.Xr ssh 1
908will try to load certificate information from the filename obtained by
909appending
910.Pa -cert.pub
911to the path of a specified
912.Cm IdentityFile .
Damien Miller6b1d53c2006-03-31 23:13:21 +1100913.Pp
jmc@openbsd.org80d1c962016-09-28 17:59:22 +0000914Arguments to
915.Cm IdentityFile
916may use the tilde syntax to refer to a user's home directory
917or the tokens described in the
918.Sx TOKENS
919section.
Damien Miller6b1d53c2006-03-31 23:13:21 +1100920.Pp
Damien Miller957d4e42005-12-13 19:30:45 +1100921It is possible to have
922multiple identity files specified in configuration files; all these
923identities will be tried in sequence.
Damien Miller6029e072011-06-20 14:22:49 +1000924Multiple
925.Cm IdentityFile
926directives will add to the list of identities tried (this behaviour
927differs from that of other configuration directives).
Damien Miller7f2b4382013-07-18 16:10:29 +1000928.Pp
929.Cm IdentityFile
930may be used in conjunction with
931.Cm IdentitiesOnly
932to select which identities in an agent are offered during authentication.
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000933.Cm IdentityFile
934may also be used in conjunction with
935.Cm CertificateFile
936in order to provide any certificate also needed for authentication with
937the identity.
Darren Tucker63e0df22013-05-16 20:30:31 +1000938.It Cm IgnoreUnknown
939Specifies a pattern-list of unknown options to be ignored if they are
940encountered in configuration parsing.
941This may be used to suppress errors if
942.Nm
943contains options that are unrecognised by
944.Xr ssh 1 .
945It is recommended that
946.Cm IgnoreUnknown
947be listed early in the configuration file as it will not be applied
948to unknown options that appear before it.
djm@openbsd.orgdc7990b2016-04-15 00:30:19 +0000949.It Cm Include
950Include the specified configuration file(s).
jmc@openbsd.org6aaabc22016-04-17 14:34:46 +0000951Multiple pathnames may be specified and each pathname may contain
djm@openbsd.orgdc7990b2016-04-15 00:30:19 +0000952.Xr glob 3
953wildcards and, for user configurations, shell-like
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000954.Sq ~
djm@openbsd.orgdc7990b2016-04-15 00:30:19 +0000955references to user home directories.
956Files without absolute paths are assumed to be in
957.Pa ~/.ssh
jmc@openbsd.org6aaabc22016-04-17 14:34:46 +0000958if included in a user configuration file or
djm@openbsd.orgdc7990b2016-04-15 00:30:19 +0000959.Pa /etc/ssh
960if included from the system configuration file.
961.Cm Include
962directive may appear inside a
963.Cm Match
964or
965.Cm Host
966block
967to perform conditional inclusion.
Damien Miller0dac6fb2010-11-20 15:19:38 +1100968.It Cm IPQoS
969Specifies the IPv4 type-of-service or DSCP class for connections.
970Accepted values are
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +0000971.Cm af11 ,
972.Cm af12 ,
973.Cm af13 ,
974.Cm af21 ,
975.Cm af22 ,
976.Cm af23 ,
977.Cm af31 ,
978.Cm af32 ,
979.Cm af33 ,
980.Cm af41 ,
981.Cm af42 ,
982.Cm af43 ,
983.Cm cs0 ,
984.Cm cs1 ,
985.Cm cs2 ,
986.Cm cs3 ,
987.Cm cs4 ,
988.Cm cs5 ,
989.Cm cs6 ,
990.Cm cs7 ,
991.Cm ef ,
992.Cm lowdelay ,
993.Cm throughput ,
994.Cm reliability ,
Damien Miller0dac6fb2010-11-20 15:19:38 +1100995or a numeric value.
Damien Miller928362d2010-12-26 14:26:45 +1100996This option may take one or two arguments, separated by whitespace.
Damien Miller0dac6fb2010-11-20 15:19:38 +1100997If one argument is specified, it is used as the packet class unconditionally.
998If two values are specified, the first is automatically selected for
999interactive sessions and the second for non-interactive sessions.
1000The default is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001001.Cm lowdelay
Damien Miller0dac6fb2010-11-20 15:19:38 +11001002for interactive sessions and
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001003.Cm throughput
Damien Miller0dac6fb2010-11-20 15:19:38 +11001004for non-interactive sessions.
Damien Millercfb606c2007-10-26 14:24:48 +10001005.It Cm KbdInteractiveAuthentication
1006Specifies whether to use keyboard-interactive authentication.
1007The argument to this keyword must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001008.Cm yes
1009(the default)
Damien Millercfb606c2007-10-26 14:24:48 +10001010or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001011.Cm no .
Darren Tucker636ca902004-11-05 20:22:00 +11001012.It Cm KbdInteractiveDevices
1013Specifies the list of methods to use in keyboard-interactive authentication.
1014Multiple method names must be comma-separated.
1015The default is to use the server specified list.
Damien Miller9cfbaec2006-03-15 11:57:55 +11001016The methods available vary depending on what the server supports.
1017For an OpenSSH server,
1018it may be zero or more of:
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001019.Cm bsdauth ,
1020.Cm pam ,
Damien Miller9cfbaec2006-03-15 11:57:55 +11001021and
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001022.Cm skey .
Damien Millerd5f62bf2010-09-24 22:11:14 +10001023.It Cm KexAlgorithms
1024Specifies the available KEX (Key Exchange) algorithms.
1025Multiple algorithms must be comma-separated.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001026Alternately if the specified value begins with a
1027.Sq +
1028character, then the specified methods will be appended to the default set
1029instead of replacing them.
Damien Miller7fe2b1f2010-09-24 22:11:53 +10001030The default is:
1031.Bd -literal -offset indent
djm@openbsd.org16277fc2016-09-22 17:55:13 +00001032curve25519-sha256,curve25519-sha256@libssh.org,
Damien Miller7fe2b1f2010-09-24 22:11:53 +10001033ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1034diffie-hellman-group-exchange-sha256,
Damien Millerc1621c82014-04-20 13:22:46 +10001035diffie-hellman-group-exchange-sha1,
djm@openbsd.orgbdfd29f2015-07-03 03:47:00 +00001036diffie-hellman-group14-sha1
Damien Miller7fe2b1f2010-09-24 22:11:53 +10001037.Ed
djm@openbsd.org8f6784f2014-12-22 09:05:17 +00001038.Pp
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001039The list of available key exchange algorithms may also be obtained using
1040.Qq ssh -Q kex .
Damien Millerd27b9472005-12-13 19:29:02 +11001041.It Cm LocalCommand
1042Specifies a command to execute on the local machine after successfully
1043connecting to the server.
1044The command string extends to the end of the line, and is executed with
Darren Tucker63b31cb2007-12-02 23:09:30 +11001045the user's shell.
jmc@openbsd.org80d1c962016-09-28 17:59:22 +00001046Arguments to
1047.Cm LocalCommand
1048accept the tokens described in the
1049.Sx TOKENS
1050section.
Darren Tucker78be8c52010-01-08 17:05:59 +11001051.Pp
1052The command is run synchronously and does not have access to the
1053session of the
1054.Xr ssh 1
1055that spawned it.
1056It should not be used for interactive commands.
1057.Pp
Damien Millerd27b9472005-12-13 19:29:02 +11001058This directive is ignored unless
1059.Cm PermitLocalCommand
1060has been enabled.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001061.It Cm LocalForward
Damien Millere9d001e2006-01-14 10:10:17 +11001062Specifies that a TCP port on the local machine be forwarded over
Ben Lindstrom9f049032002-06-21 00:59:05 +00001063the secure channel to the specified host and port from the remote machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001064The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +11001065.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001066.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +11001067.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001068and the second argument must be
1069.Ar host : Ns Ar hostport .
Damien Miller7fa96602010-08-05 13:03:13 +10001070IPv6 addresses can be specified by enclosing addresses in square brackets.
Damien Millerf8c55462005-03-02 12:03:05 +11001071Multiple forwardings may be specified, and additional forwardings can be
Damien Millerf91ee4c2005-03-01 21:24:33 +11001072given on the command line.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001073Only the superuser can forward privileged ports.
Damien Millerf91ee4c2005-03-01 21:24:33 +11001074By default, the local port is bound in accordance with the
1075.Cm GatewayPorts
1076setting.
1077However, an explicit
1078.Ar bind_address
1079may be used to bind the connection to a specific address.
1080The
1081.Ar bind_address
1082of
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001083.Cm localhost
Damien Millerf8c55462005-03-02 12:03:05 +11001084indicates that the listening port be bound for local use only, while an
1085empty address or
1086.Sq *
Damien Millerf91ee4c2005-03-01 21:24:33 +11001087indicates that the port should be available from all interfaces.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001088.It Cm LogLevel
1089Gives the verbosity level that is used when logging messages from
Damien Miller45ee2b92006-03-15 11:56:18 +11001090.Xr ssh 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001091The possible values are:
Damien Miller45ee2b92006-03-15 11:56:18 +11001092QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +10001093The default is INFO.
1094DEBUG and DEBUG1 are equivalent.
1095DEBUG2 and DEBUG3 each specify higher levels of verbose output.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001096.It Cm MACs
1097Specifies the MAC (message authentication code) algorithms
1098in order of preference.
jmc@openbsd.orga685ae82016-02-17 07:38:19 +00001099The MAC algorithm is used for data integrity protection.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001100Multiple algorithms must be comma-separated.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001101If the specified value begins with a
1102.Sq +
1103character, then the specified algorithms will be appended to the default set
1104instead of replacing them.
1105.Pp
Damien Milleraf43a7a2012-12-12 10:46:31 +11001106The algorithms that contain
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001107.Qq -etm
Damien Milleraf43a7a2012-12-12 10:46:31 +11001108calculate the MAC after encryption (encrypt-then-mac).
1109These are considered safer and their use recommended.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001110.Pp
Damien Miller45ee2b92006-03-15 11:56:18 +11001111The default is:
Damien Miller5e7c30b2007-06-11 14:06:32 +10001112.Bd -literal -offset indent
Damien Milleraf43a7a2012-12-12 10:46:31 +11001113umac-64-etm@openssh.com,umac-128-etm@openssh.com,
1114hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
djm@openbsd.orge4c918a2016-02-11 02:56:32 +00001115hmac-sha1-etm@openssh.com,
Damien Millerc1621c82014-04-20 13:22:46 +10001116umac-64@openssh.com,umac-128@openssh.com,
djm@openbsd.orge4c918a2016-02-11 02:56:32 +00001117hmac-sha2-256,hmac-sha2-512,hmac-sha1
Damien Miller5e7c30b2007-06-11 14:06:32 +10001118.Ed
djm@openbsd.org8f6784f2014-12-22 09:05:17 +00001119.Pp
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001120The list of available MAC algorithms may also be obtained using
1121.Qq ssh -Q mac .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001122.It Cm NoHostAuthenticationForLocalhost
1123This option can be used if the home directory is shared across machines.
1124In this case localhost will refer to a different machine on each of
1125the machines and the user will get many warnings about changed host keys.
1126However, this option disables host authentication for localhost.
1127The argument to this keyword must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001128.Cm yes
Ben Lindstrom9f049032002-06-21 00:59:05 +00001129or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001130.Cm no .
1131(the default).
Ben Lindstrom9f049032002-06-21 00:59:05 +00001132.It Cm NumberOfPasswordPrompts
1133Specifies the number of password prompts before giving up.
1134The argument to this keyword must be an integer.
Damien Miller45ee2b92006-03-15 11:56:18 +11001135The default is 3.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001136.It Cm PasswordAuthentication
1137Specifies whether to use password authentication.
1138The argument to this keyword must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001139.Cm yes
1140(the default)
Ben Lindstrom9f049032002-06-21 00:59:05 +00001141or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001142.Cm no .
Damien Millerd27b9472005-12-13 19:29:02 +11001143.It Cm PermitLocalCommand
1144Allow local command execution via the
1145.Ic LocalCommand
1146option or using the
Damien Miller4b2319f2005-12-13 19:30:27 +11001147.Ic !\& Ns Ar command
Damien Millerd27b9472005-12-13 19:29:02 +11001148escape sequence in
1149.Xr ssh 1 .
1150The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001151.Cm yes
Damien Millerd27b9472005-12-13 19:29:02 +11001152or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001153.Cm no
1154(the default).
Damien Miller7ea845e2010-02-12 09:21:02 +11001155.It Cm PKCS11Provider
1156Specifies which PKCS#11 provider to use.
Damien Miller8e1ea4e2010-11-20 15:20:10 +11001157The argument to this keyword is the PKCS#11 shared library
Damien Miller7ea845e2010-02-12 09:21:02 +11001158.Xr ssh 1
Damien Millera7618442010-02-12 09:26:02 +11001159should use to communicate with a PKCS#11 token providing the user's
Damien Miller7ea845e2010-02-12 09:21:02 +11001160private RSA key.
Damien Miller957d4e42005-12-13 19:30:45 +11001161.It Cm Port
1162Specifies the port number to connect on the remote host.
Damien Miller45ee2b92006-03-15 11:56:18 +11001163The default is 22.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001164.It Cm PreferredAuthentications
jmc@openbsd.orga685ae82016-02-17 07:38:19 +00001165Specifies the order in which the client should try authentication methods.
Darren Tucker1adc2bd2005-03-14 23:14:20 +11001166This allows a client to prefer one method (e.g.\&
Ben Lindstrom9f049032002-06-21 00:59:05 +00001167.Cm keyboard-interactive )
Darren Tucker1adc2bd2005-03-14 23:14:20 +11001168over another method (e.g.\&
Damien Miller544378d2010-04-16 15:52:24 +10001169.Cm password ) .
1170The default is:
1171.Bd -literal -offset indent
1172gssapi-with-mic,hostbased,publickey,
1173keyboard-interactive,password
1174.Ed
Ben Lindstrom9f049032002-06-21 00:59:05 +00001175.It Cm Protocol
1176Specifies the protocol versions
Damien Miller45ee2b92006-03-15 11:56:18 +11001177.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001178should support in order of preference.
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001179The possible values are 1 and 2.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001180Multiple versions must be comma-separated.
Darren Tuckerbad50762009-10-11 21:51:08 +11001181When this option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001182.Cm 2,1
Darren Tuckerbad50762009-10-11 21:51:08 +11001183.Nm ssh
1184will try version 2 and fall back to version 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001185if version 2 is not available.
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001186The default is version 2.
djm@openbsd.orge7901ef2016-02-16 05:11:04 +00001187Protocol 1 suffers from a number of cryptographic weaknesses and should
1188not be used.
1189It is only offered to support legacy devices.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001190.It Cm ProxyCommand
1191Specifies the command to use to connect to the server.
1192The command
Damien Miller079bac22014-07-09 13:06:25 +10001193string extends to the end of the line, and is executed
1194using the user's shell
1195.Ql exec
1196directive to avoid a lingering shell process.
1197.Pp
jmc@openbsd.org80d1c962016-09-28 17:59:22 +00001198Arguments to
1199.Cm ProxyCommand
1200accept the tokens described in the
1201.Sx TOKENS
1202section.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001203The command can be basically anything,
1204and should read from its standard input and write to its standard output.
1205It should eventually connect an
1206.Xr sshd 8
1207server running on some machine, or execute
1208.Ic sshd -i
1209somewhere.
1210Host key management will be done using the
1211HostName of the host being connected (defaulting to the name typed by
1212the user).
Damien Miller495dca32003-04-01 21:42:14 +10001213Setting the command to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001214.Cm none
Damien Miller9f1e33a2003-02-24 11:57:32 +11001215disables this option entirely.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001216Note that
1217.Cm CheckHostIP
1218is not available for connects with a proxy command.
1219.Pp
Damien Millerebcfedc2005-05-26 12:13:56 +10001220This directive is useful in conjunction with
1221.Xr nc 1
1222and its proxy support.
Damien Millerdfec2942005-05-26 12:14:32 +10001223For example, the following directive would connect via an HTTP proxy at
Damien Millerebcfedc2005-05-26 12:13:56 +10001224192.0.2.0:
1225.Bd -literal -offset 3n
1226ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
1227.Ed
djm@openbsd.orged877ef2016-07-15 00:24:30 +00001228.It Cm ProxyJump
1229Specifies one or more jump proxies as
1230.Xo
1231.Sm off
jmc@openbsd.orge4eb7d92016-07-16 06:57:55 +00001232.Op Ar user No @
djm@openbsd.orged877ef2016-07-15 00:24:30 +00001233.Ar host
jmc@openbsd.orge4eb7d92016-07-16 06:57:55 +00001234.Op : Ns Ar port
djm@openbsd.orged877ef2016-07-15 00:24:30 +00001235.Sm on
1236.Xc .
djm@openbsd.org286f5a72016-07-22 03:35:11 +00001237Multiple proxies may be separated by comma characters and will be visited
djm@openbsd.orgf00211e2016-07-22 07:00:46 +00001238sequentially.
djm@openbsd.orged877ef2016-07-15 00:24:30 +00001239Setting this option will cause
1240.Xr ssh 1
1241to connect to the target host by first making a
1242.Xr ssh 1
1243connection to the specified
1244.Cm ProxyJump
1245host and then establishing a
jmc@openbsd.orge4eb7d92016-07-16 06:57:55 +00001246TCP forwarding to the ultimate target from there.
djm@openbsd.orged877ef2016-07-15 00:24:30 +00001247.Pp
1248Note that this option will compete with the
1249.Cm ProxyCommand
1250option - whichever is specified first will prevent later instances of the
1251other from taking effect.
Damien Miller1262b662013-08-21 02:44:24 +10001252.It Cm ProxyUseFdpass
Damien Millerf2f6c312013-08-21 02:44:58 +10001253Specifies that
Damien Miller1262b662013-08-21 02:44:24 +10001254.Cm ProxyCommand
1255will pass a connected file descriptor back to
Damien Millerf2f6c312013-08-21 02:44:58 +10001256.Xr ssh 1
Damien Miller1262b662013-08-21 02:44:24 +10001257instead of continuing to execute and pass data.
1258The default is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001259.Cm no .
markus@openbsd.org3a1638d2015-07-10 06:21:53 +00001260.It Cm PubkeyAcceptedKeyTypes
1261Specifies the key types that will be used for public key authentication
1262as a comma-separated pattern list.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001263Alternately if the specified value begins with a
1264.Sq +
1265character, then the key types after it will be appended to the default
1266instead of replacing it.
markus@openbsd.org3a1638d2015-07-10 06:21:53 +00001267The default for this option is:
1268.Bd -literal -offset 3n
1269ecdsa-sha2-nistp256-cert-v01@openssh.com,
1270ecdsa-sha2-nistp384-cert-v01@openssh.com,
1271ecdsa-sha2-nistp521-cert-v01@openssh.com,
1272ssh-ed25519-cert-v01@openssh.com,
1273ssh-rsa-cert-v01@openssh.com,
1274ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
djm@openbsd.org3a13cb52016-02-17 08:57:34 +00001275ssh-ed25519,ssh-rsa
markus@openbsd.org3a1638d2015-07-10 06:21:53 +00001276.Ed
1277.Pp
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001278The list of available key types may also be obtained using
1279.Qq ssh -Q key .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001280.It Cm PubkeyAuthentication
1281Specifies whether to try public key authentication.
1282The argument to this keyword must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001283.Cm yes
1284(the default)
Ben Lindstrom9f049032002-06-21 00:59:05 +00001285or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001286.Cm no .
Darren Tucker62388b22006-01-20 11:31:47 +11001287.It Cm RekeyLimit
1288Specifies the maximum amount of data that may be transmitted before the
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001289session key is renegotiated, optionally followed a maximum amount of
1290time that may pass before the session key is renegotiated.
1291The first argument is specified in bytes and may have a suffix of
Damien Millerddfddf12006-01-31 21:39:03 +11001292.Sq K ,
1293.Sq M ,
Darren Tucker62388b22006-01-20 11:31:47 +11001294or
Damien Millerddfddf12006-01-31 21:39:03 +11001295.Sq G
Darren Tucker62388b22006-01-20 11:31:47 +11001296to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1297The default is between
Damien Miller45ee2b92006-03-15 11:56:18 +11001298.Sq 1G
Darren Tucker62388b22006-01-20 11:31:47 +11001299and
Damien Miller45ee2b92006-03-15 11:56:18 +11001300.Sq 4G ,
Darren Tucker62388b22006-01-20 11:31:47 +11001301depending on the cipher.
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001302The optional second value is specified in seconds and may use any of the
1303units documented in the
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001304.Sx TIME FORMATS
1305section of
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001306.Xr sshd_config 5 .
1307The default value for
1308.Cm RekeyLimit
1309is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001310.Cm default none ,
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001311which means that rekeying is performed after the cipher's default amount
1312of data has been sent or received and no time based rekeying is done.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001313.It Cm RemoteForward
Damien Millere9d001e2006-01-14 10:10:17 +11001314Specifies that a TCP port on the remote machine be forwarded over
Ben Lindstrom9f049032002-06-21 00:59:05 +00001315the secure channel to the specified host and port from the local machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001316The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +11001317.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001318.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +11001319.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001320and the second argument must be
1321.Ar host : Ns Ar hostport .
Damien Miller7fa96602010-08-05 13:03:13 +10001322IPv6 addresses can be specified by enclosing addresses in square brackets.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001323Multiple forwardings may be specified, and additional
1324forwardings can be given on the command line.
Damien Millerde7532e2008-11-03 19:24:45 +11001325Privileged ports can be forwarded only when
1326logging in as root on the remote machine.
Damien Millere379e102009-02-14 16:34:39 +11001327.Pp
Damien Miller85c6d8a2009-02-14 16:34:21 +11001328If the
1329.Ar port
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001330argument is 0,
Damien Miller85c6d8a2009-02-14 16:34:21 +11001331the listen port will be dynamically allocated on the server and reported
1332to the client at run time.
Damien Millerf91ee4c2005-03-01 21:24:33 +11001333.Pp
1334If the
1335.Ar bind_address
1336is not specified, the default is to only bind to loopback addresses.
1337If the
1338.Ar bind_address
1339is
1340.Ql *
1341or an empty string, then the forwarding is requested to listen on all
1342interfaces.
1343Specifying a remote
1344.Ar bind_address
Damien Millerf8c55462005-03-02 12:03:05 +11001345will only succeed if the server's
1346.Cm GatewayPorts
Damien Millerf91ee4c2005-03-01 21:24:33 +11001347option is enabled (see
Damien Millerf8c55462005-03-02 12:03:05 +11001348.Xr sshd_config 5 ) .
Damien Miller21771e22011-05-15 08:45:50 +10001349.It Cm RequestTTY
1350Specifies whether to request a pseudo-tty for the session.
1351The argument may be one of:
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001352.Cm no
Damien Miller21771e22011-05-15 08:45:50 +10001353(never request a TTY),
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001354.Cm yes
Damien Miller21771e22011-05-15 08:45:50 +10001355(always request a TTY when standard input is a TTY),
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001356.Cm force
Damien Miller21771e22011-05-15 08:45:50 +10001357(always request a TTY) or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001358.Cm auto
Damien Miller21771e22011-05-15 08:45:50 +10001359(request a TTY when opening a login session).
1360This option mirrors the
1361.Fl t
1362and
1363.Fl T
1364flags for
1365.Xr ssh 1 .
djm@openbsd.org5e39a492014-12-04 02:24:32 +00001366.It Cm RevokedHostKeys
1367Specifies revoked host public keys.
1368Keys listed in this file will be refused for host authentication.
1369Note that if this file does not exist or is not readable,
1370then host authentication will be refused for all hosts.
1371Keys may be specified as a text file, listing one public key per line, or as
1372an OpenSSH Key Revocation List (KRL) as generated by
1373.Xr ssh-keygen 1 .
1374For more information on KRLs, see the KEY REVOCATION LISTS section in
1375.Xr ssh-keygen 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001376.It Cm RhostsRSAAuthentication
1377Specifies whether to try rhosts based authentication with RSA host
1378authentication.
1379The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001380.Cm yes
Ben Lindstrom9f049032002-06-21 00:59:05 +00001381or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001382.Cm no
1383(the default).
Ben Lindstrom9f049032002-06-21 00:59:05 +00001384This option applies to protocol version 1 only and requires
Damien Miller45ee2b92006-03-15 11:56:18 +11001385.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001386to be setuid root.
1387.It Cm RSAAuthentication
1388Specifies whether to try RSA authentication.
1389The argument to this keyword must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001390.Cm yes
1391(the default)
Ben Lindstrom9f049032002-06-21 00:59:05 +00001392or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001393.Cm no .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001394RSA authentication will only be
1395attempted if the identity file exists, or an authentication agent is
1396running.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001397Note that this option applies to protocol version 1 only.
Darren Tucker46bc0752004-05-02 22:11:30 +10001398.It Cm SendEnv
1399Specifies what variables from the local
1400.Xr environ 7
1401should be sent to the server.
Damien Miller45ee2b92006-03-15 11:56:18 +11001402The server must also support it, and the server must be configured to
Darren Tucker1e0c9bf2004-05-02 22:12:48 +10001403accept these environment variables.
dtucker@openbsd.org85b96ef2015-04-28 10:17:58 +00001404Note that the
1405.Ev TERM
jmc@openbsd.orgc1d5bcf2015-04-28 13:47:38 +00001406environment variable is always sent whenever a
dtucker@openbsd.org85b96ef2015-04-28 10:17:58 +00001407pseudo-terminal is requested as it is required by the protocol.
Darren Tucker46bc0752004-05-02 22:11:30 +10001408Refer to
1409.Cm AcceptEnv
1410in
1411.Xr sshd_config 5
1412for how to configure the server.
Damien Miller6def5512006-03-15 11:54:05 +11001413Variables are specified by name, which may contain wildcard characters.
Darren Tucker1e0c9bf2004-05-02 22:12:48 +10001414Multiple environment variables may be separated by whitespace or spread
Darren Tucker46bc0752004-05-02 22:11:30 +10001415across multiple
1416.Cm SendEnv
1417directives.
1418The default is not to send any environment variables.
Damien Millerf54a4b92006-03-15 11:54:36 +11001419.Pp
1420See
1421.Sx PATTERNS
1422for more information on patterns.
Damien Miller509b0102003-12-17 16:33:10 +11001423.It Cm ServerAliveCountMax
Damien Millerb7977702006-01-03 18:47:31 +11001424Sets the number of server alive messages (see below) which may be
Damien Miller509b0102003-12-17 16:33:10 +11001425sent without
Damien Miller45ee2b92006-03-15 11:56:18 +11001426.Xr ssh 1
Damien Miller509b0102003-12-17 16:33:10 +11001427receiving any messages back from the server.
1428If this threshold is reached while server alive messages are being sent,
Damien Miller45ee2b92006-03-15 11:56:18 +11001429ssh will disconnect from the server, terminating the session.
Damien Miller509b0102003-12-17 16:33:10 +11001430It is important to note that the use of server alive messages is very
1431different from
1432.Cm TCPKeepAlive
1433(below).
1434The server alive messages are sent through the encrypted channel
1435and therefore will not be spoofable.
1436The TCP keepalive option enabled by
1437.Cm TCPKeepAlive
1438is spoofable.
1439The server alive mechanism is valuable when the client or
1440server depend on knowing when a connection has become inactive.
1441.Pp
1442The default value is 3.
1443If, for example,
1444.Cm ServerAliveInterval
Damien Miller45ee2b92006-03-15 11:56:18 +11001445(see below) is set to 15 and
Damien Miller509b0102003-12-17 16:33:10 +11001446.Cm ServerAliveCountMax
Damien Miller45ee2b92006-03-15 11:56:18 +11001447is left at the default, if the server becomes unresponsive,
1448ssh will disconnect after approximately 45 seconds.
Damien Miller957d4e42005-12-13 19:30:45 +11001449.It Cm ServerAliveInterval
1450Sets a timeout interval in seconds after which if no data has been received
1451from the server,
Damien Miller45ee2b92006-03-15 11:56:18 +11001452.Xr ssh 1
Damien Miller957d4e42005-12-13 19:30:45 +11001453will send a message through the encrypted
1454channel to request a response from the server.
1455The default
1456is 0, indicating that these messages will not be sent to the server.
Damien Miller7acefbb2014-07-18 14:11:24 +10001457.It Cm StreamLocalBindMask
1458Sets the octal file creation mode mask
1459.Pq umask
1460used when creating a Unix-domain socket file for local or remote
1461port forwarding.
1462This option is only used for port forwarding to a Unix-domain socket file.
1463.Pp
1464The default value is 0177, which creates a Unix-domain socket file that is
1465readable and writable only by the owner.
1466Note that not all operating systems honor the file mode on Unix-domain
1467socket files.
1468.It Cm StreamLocalBindUnlink
1469Specifies whether to remove an existing Unix-domain socket file for local
1470or remote port forwarding before creating a new one.
1471If the socket file already exists and
1472.Cm StreamLocalBindUnlink
1473is not enabled,
1474.Nm ssh
1475will be unable to forward the port to the Unix-domain socket file.
1476This option is only used for port forwarding to a Unix-domain socket file.
1477.Pp
1478The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001479.Cm yes
Damien Miller7acefbb2014-07-18 14:11:24 +10001480or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001481.Cm no
1482(the default).
Ben Lindstrom9f049032002-06-21 00:59:05 +00001483.It Cm StrictHostKeyChecking
1484If this flag is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001485.Cm yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001486.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001487will never automatically add host keys to the
Damien Miller167ea5d2005-05-26 12:04:02 +10001488.Pa ~/.ssh/known_hosts
Ben Lindstrom9f049032002-06-21 00:59:05 +00001489file, and refuses to connect to hosts whose host key has changed.
1490This provides maximum protection against trojan horse attacks,
Damien Miller45ee2b92006-03-15 11:56:18 +11001491though it can be annoying when the
Ben Lindstrom9f049032002-06-21 00:59:05 +00001492.Pa /etc/ssh/ssh_known_hosts
Damien Miller45ee2b92006-03-15 11:56:18 +11001493file is poorly maintained or when connections to new hosts are
Ben Lindstrom9f049032002-06-21 00:59:05 +00001494frequently made.
1495This option forces the user to manually
1496add all new hosts.
1497If this flag is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001498.Cm no ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001499ssh will automatically add new host keys to the
Ben Lindstrom9f049032002-06-21 00:59:05 +00001500user known hosts files.
1501If this flag is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001502.Cm ask
1503(the default),
Ben Lindstrom9f049032002-06-21 00:59:05 +00001504new host keys
1505will be added to the user known host files only after the user
1506has confirmed that is what they really want to do, and
Damien Miller45ee2b92006-03-15 11:56:18 +11001507ssh will refuse to connect to hosts whose host key has changed.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001508The host keys of
1509known hosts will be verified automatically in all cases.
Damien Miller12c150e2003-12-17 16:31:10 +11001510.It Cm TCPKeepAlive
1511Specifies whether the system should send TCP keepalive messages to the
1512other side.
1513If they are sent, death of the connection or crash of one
1514of the machines will be properly noticed.
1515However, this means that
1516connections will die if the route is down temporarily, and some people
1517find it annoying.
1518.Pp
1519The default is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001520.Cm yes
Damien Miller12c150e2003-12-17 16:31:10 +11001521(to send TCP keepalive messages), and the client will notice
1522if the network goes down or the remote host dies.
1523This is important in scripts, and many users want it too.
1524.Pp
1525To disable TCP keepalive messages, the value should be set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001526.Cm no .
Damien Millerd27b9472005-12-13 19:29:02 +11001527.It Cm Tunnel
Damien Miller991dba42006-07-10 20:16:27 +10001528Request
Damien Millerd27b9472005-12-13 19:29:02 +11001529.Xr tun 4
Damien Miller7746c392005-12-13 19:33:37 +11001530device forwarding between the client and the server.
Damien Millerd27b9472005-12-13 19:29:02 +11001531The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001532.Cm yes ,
1533.Cm point-to-point
Damien Miller991dba42006-07-10 20:16:27 +10001534(layer 3),
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001535.Cm ethernet
Damien Miller991dba42006-07-10 20:16:27 +10001536(layer 2),
Damien Millerd27b9472005-12-13 19:29:02 +11001537or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001538.Cm no
1539(the default).
Damien Miller991dba42006-07-10 20:16:27 +10001540Specifying
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001541.Cm yes
Damien Miller991dba42006-07-10 20:16:27 +10001542requests the default tunnel mode, which is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001543.Cm point-to-point .
Damien Millerd27b9472005-12-13 19:29:02 +11001544.It Cm TunnelDevice
Damien Miller991dba42006-07-10 20:16:27 +10001545Specifies the
Damien Millerd27b9472005-12-13 19:29:02 +11001546.Xr tun 4
Damien Miller991dba42006-07-10 20:16:27 +10001547devices to open on the client
1548.Pq Ar local_tun
1549and the server
1550.Pq Ar remote_tun .
1551.Pp
1552The argument must be
1553.Sm off
1554.Ar local_tun Op : Ar remote_tun .
1555.Sm on
1556The devices may be specified by numerical ID or the keyword
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001557.Cm any ,
Damien Miller991dba42006-07-10 20:16:27 +10001558which uses the next available tunnel device.
1559If
1560.Ar remote_tun
1561is not specified, it defaults to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001562.Cm any .
Damien Miller991dba42006-07-10 20:16:27 +10001563The default is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001564.Cm any:any .
djm@openbsd.org1d1092b2015-01-26 12:16:36 +00001565.It Cm UpdateHostKeys
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001566Specifies whether
1567.Xr ssh 1
1568should accept notifications of additional hostkeys from the server sent
1569after authentication has completed and add them to
1570.Cm UserKnownHostsFile .
1571The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001572.Cm yes ,
1573.Cm no
djm@openbsd.org523463a2015-02-16 22:13:32 +00001574(the default) or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001575.Cm ask .
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001576Enabling this option allows learning alternate hostkeys for a server
djm@openbsd.org1d1092b2015-01-26 12:16:36 +00001577and supports graceful key rotation by allowing a server to send replacement
1578public keys before old ones are removed.
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001579Additional hostkeys are only accepted if the key used to authenticate the
sobrado@openbsd.orge3cbb062015-09-22 08:33:23 +00001580host was already trusted or explicitly accepted by the user.
djm@openbsd.org523463a2015-02-16 22:13:32 +00001581If
1582.Cm UpdateHostKeys
1583is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001584.Cm ask ,
djm@openbsd.org523463a2015-02-16 22:13:32 +00001585then the user is asked to confirm the modifications to the known_hosts file.
djm@openbsd.org44732de2015-02-20 22:17:21 +00001586Confirmation is currently incompatible with
1587.Cm ControlPersist ,
1588and will be disabled if it is enabled.
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001589.Pp
1590Presently, only
1591.Xr sshd 8
1592from OpenSSH 6.8 and greater support the
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001593.Qq hostkeys@openssh.com
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001594protocol extension used to inform the client of all the server's hostkeys.
Damien Millere8cd7412005-12-24 14:55:47 +11001595.It Cm UsePrivilegedPort
1596Specifies whether to use a privileged port for outgoing connections.
1597The argument must be
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001598.Cm yes
Damien Millere8cd7412005-12-24 14:55:47 +11001599or
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001600.Cm no
1601(the default).
Damien Millere8cd7412005-12-24 14:55:47 +11001602If set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001603.Cm yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001604.Xr ssh 1
Damien Millere8cd7412005-12-24 14:55:47 +11001605must be setuid root.
1606Note that this option must be set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001607.Cm yes
Damien Millere8cd7412005-12-24 14:55:47 +11001608for
1609.Cm RhostsRSAAuthentication
1610with older servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001611.It Cm User
1612Specifies the user to log in as.
1613This can be useful when a different user name is used on different machines.
1614This saves the trouble of
1615having to remember to give the user name on the command line.
1616.It Cm UserKnownHostsFile
Damien Miller295ee632011-05-29 21:42:31 +10001617Specifies one or more files to use for the user
1618host key database, separated by whitespace.
1619The default is
1620.Pa ~/.ssh/known_hosts ,
1621.Pa ~/.ssh/known_hosts2 .
Damien Miller37876e92003-05-15 10:19:46 +10001622.It Cm VerifyHostKeyDNS
1623Specifies whether to verify the remote key using DNS and SSHFP resource
1624records.
Damien Miller150b5572003-11-17 21:19:29 +11001625If this option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001626.Cm yes ,
Damien Millerfe448472003-11-17 21:19:49 +11001627the client will implicitly trust keys that match a secure fingerprint
Damien Miller150b5572003-11-17 21:19:29 +11001628from DNS.
1629Insecure fingerprints will be handled as if this option was set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001630.Cm ask .
Damien Miller150b5572003-11-17 21:19:29 +11001631If this option is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001632.Cm ask ,
Damien Miller150b5572003-11-17 21:19:29 +11001633information on fingerprint match will be displayed, but the user will still
1634need to confirm new host keys according to the
1635.Cm StrictHostKeyChecking
1636option.
Damien Miller37876e92003-05-15 10:19:46 +10001637The default is
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001638.Cm no .
Damien Miller45ee2b92006-03-15 11:56:18 +11001639.Pp
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001640See also
1641.Sx VERIFYING HOST KEYS
1642in
Damien Miller45ee2b92006-03-15 11:56:18 +11001643.Xr ssh 1 .
Damien Miller10288242008-06-30 00:04:03 +10001644.It Cm VisualHostKey
1645If this flag is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001646.Cm yes ,
Damien Miller10288242008-06-30 00:04:03 +10001647an ASCII art representation of the remote host key fingerprint is
djm@openbsd.orgb79efde2014-12-21 23:12:42 +00001648printed in addition to the fingerprint string at login and
Damien Millera414cd32008-11-03 19:25:21 +11001649for unknown host keys.
Damien Miller10288242008-06-30 00:04:03 +10001650If this flag is set to
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001651.Cm no
1652(the default),
Damien Millera414cd32008-11-03 19:25:21 +11001653no fingerprint strings are printed at login and
djm@openbsd.orgb79efde2014-12-21 23:12:42 +00001654only the fingerprint string will be printed for unknown host keys.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001655.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +10001656Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +00001657.Xr xauth 1
1658program.
1659The default is
1660.Pa /usr/X11R6/bin/xauth .
1661.El
Damien Millerb5282c22006-03-15 11:59:08 +11001662.Sh PATTERNS
1663A
1664.Em pattern
1665consists of zero or more non-whitespace characters,
1666.Sq *
1667(a wildcard that matches zero or more characters),
1668or
1669.Sq ?\&
1670(a wildcard that matches exactly one character).
1671For example, to specify a set of declarations for any host in the
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001672.Qq .co.uk
Damien Millerb5282c22006-03-15 11:59:08 +11001673set of domains,
1674the following pattern could be used:
1675.Pp
1676.Dl Host *.co.uk
1677.Pp
1678The following pattern
1679would match any host in the 192.168.0.[0-9] network range:
1680.Pp
1681.Dl Host 192.168.0.?
1682.Pp
1683A
1684.Em pattern-list
1685is a comma-separated list of patterns.
1686Patterns within pattern-lists may be negated
1687by preceding them with an exclamation mark
1688.Pq Sq !\& .
1689For example,
Damien Miller51682fa2013-10-17 11:48:31 +11001690to allow a key to be used from anywhere within an organization
Damien Millerb5282c22006-03-15 11:59:08 +11001691except from the
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001692.Qq dialup
Damien Millerb5282c22006-03-15 11:59:08 +11001693pool,
1694the following entry (in authorized_keys) could be used:
1695.Pp
1696.Dl from=\&"!*.dialup.example.com,*.example.com\&"
jmc@openbsd.org80d1c962016-09-28 17:59:22 +00001697.Sh TOKENS
1698Arguments to some keywords can make use of tokens,
1699which are expanded at runtime:
1700.Pp
1701.Bl -tag -width XXXX -offset indent -compact
1702.It %%
1703A literal
1704.Sq % .
1705.It \&%C
1706Shorthand for %l%h%p%r.
1707.It %d
1708Local user's home directory.
1709.It %h
1710The remote hostname.
1711.It %i
1712The local user ID.
1713.It %L
1714The local hostname.
1715.It %l
1716The local hostname, including the domain name.
1717.It %n
1718The original remote hostname, as given on the command line.
1719.It %p
1720The remote port.
1721.It %r
1722The remote username.
1723.It %u
1724The local username.
1725.El
1726.Pp
1727.Cm Match exec
1728accepts the tokens %%, %h, %L, %l, %n, %p, %r, and %u.
1729.Pp
1730.Cm CertificateFile
1731accepts the tokens %%, %d, %h, %l, %r, and %u.
1732.Pp
1733.Cm ControlPath
1734accepts the tokens %%, %C, %h, %i, %L, %l, %n, %p, %r, and %u.
1735.Pp
1736.Cm HostName
1737accepts the tokens %% and %h.
1738.Pp
1739.Cm IdentityAgent
1740and
1741.Cm IdentityFile
1742accept the tokens %%, %d, %h, %l, %r, and %u.
1743.Pp
1744.Cm LocalCommand
1745accepts the tokens %%, %C, %d, %h, %l, %n, %p, %r, and %u.
1746.Pp
1747.Cm ProxyCommand
1748accepts the tokens %%, %h, %p, and %r.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001749.Sh FILES
1750.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +10001751.It Pa ~/.ssh/config
Ben Lindstrom9f049032002-06-21 00:59:05 +00001752This is the per-user configuration file.
1753The format of this file is described above.
Damien Miller45ee2b92006-03-15 11:56:18 +11001754This file is used by the SSH client.
Damien Millerc970cb92004-04-20 20:12:53 +10001755Because of the potential for abuse, this file must have strict permissions:
1756read/write for the user, and not accessible by others.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001757.It Pa /etc/ssh/ssh_config
1758Systemwide configuration file.
1759This file provides defaults for those
1760values that are not specified in the user's configuration file, and
1761for those users who do not have a configuration file.
1762This file must be world-readable.
1763.El
Damien Millerf1ce5052003-06-11 22:04:39 +10001764.Sh SEE ALSO
1765.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001766.Sh AUTHORS
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001767.An -nosplit
Ben Lindstrom9f049032002-06-21 00:59:05 +00001768OpenSSH is a derivative of the original and free
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001769ssh 1.2.12 release by
1770.An Tatu Ylonen .
1771.An Aaron Campbell , Bob Beck , Markus Friedl ,
1772.An Niels Provos , Theo de Raadt
1773and
1774.An Dug Song
Ben Lindstrom9f049032002-06-21 00:59:05 +00001775removed many bugs, re-added newer features and
1776created OpenSSH.
jmc@openbsd.orgfd2a8f12016-10-15 19:56:25 +00001777.An Markus Friedl
1778contributed the support for SSH protocol versions 1.5 and 2.0.