blob: fcd5380665f25fc00c1d397b8f87a9ee33d854bd [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.orga685ae82016-02-17 07:38:19 +000036.\" $OpenBSD: ssh_config.5,v 1.226 2016/02/17 07:38:19 jmc Exp $
37.Dd $Mdocdate: February 17 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
Ben Lindstrom9f049032002-06-21 00:59:05 +000065.Dq Host
66specifications, 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
71option 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
77The configuration file has the following format:
78.Pp
79Empty lines and lines starting with
80.Ql #
81are comments.
Ben Lindstrom9f049032002-06-21 00:59:05 +000082Otherwise a line is of the format
83.Dq keyword arguments .
84Configuration 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.
Damien Miller306d1182006-03-15 12:05:59 +110095Arguments may optionally be enclosed in double quotes
96.Pq \&"
97in order to represent arguments containing spaces.
Ben Lindstrom9f049032002-06-21 00:59:05 +000098.Pp
99The possible
100keywords and their meanings are as follows (note that
101keywords are case-insensitive and arguments are case-sensitive):
102.Bl -tag -width Ds
103.It Cm Host
104Restricts the following declarations (up to the next
105.Cm Host
Damien Miller194fd902013-10-15 12:13:05 +1100106or
107.Cm Match
Ben Lindstrom9f049032002-06-21 00:59:05 +0000108keyword) to be only for those hosts that match one of the patterns
109given after the keyword.
Damien Millerfa51b162008-11-03 19:17:33 +1100110If more than one pattern is provided, they should be separated by whitespace.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000111A single
Damien Miller208f1ed2006-03-15 11:56:03 +1100112.Ql *
Ben Lindstrom9f049032002-06-21 00:59:05 +0000113as a pattern can be used to provide global
114defaults for all hosts.
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000115The host is usually the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000116.Ar hostname
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000117argument given on the command line
118(see the
119.Cm CanonicalizeHostname
120option for exceptions.)
Damien Millerf54a4b92006-03-15 11:54:36 +1100121.Pp
Damien Millerfe924212011-05-15 08:44:45 +1000122A pattern entry may be negated by prefixing it with an exclamation mark
123.Pq Sq !\& .
124If a negated entry is matched, then the
125.Cm Host
126entry is ignored, regardless of whether any other patterns on the line
127match.
128Negated matches are therefore useful to provide exceptions for wildcard
129matches.
130.Pp
Damien Millerf54a4b92006-03-15 11:54:36 +1100131See
132.Sx PATTERNS
133for more information on patterns.
Damien Millerd77b81f2013-10-17 11:39:00 +1100134.It Cm Match
Damien Miller194fd902013-10-15 12:13:05 +1100135Restricts the following declarations (up to the next
136.Cm Host
137or
138.Cm Match
139keyword) to be used only when the conditions following the
140.Cm Match
141keyword are satisfied.
sobrado@openbsd.orge3cbb062015-09-22 08:33:23 +0000142Match conditions are specified using one or more criteria
Damien Millercf31f382013-10-24 21:02:56 +1100143or the single token
144.Cm all
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000145which always matches.
146The available criteria keywords are:
147.Cm canonical ,
Damien Miller8a04be72013-10-23 16:29:40 +1100148.Cm exec ,
Damien Miller194fd902013-10-15 12:13:05 +1100149.Cm host ,
150.Cm originalhost ,
151.Cm user ,
152and
153.Cm localuser .
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000154The
155.Cm all
156criteria must appear alone or immediately after
jmc@openbsd.orgb1ba15f2014-10-09 06:21:31 +0000157.Cm canonical .
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000158Other criteria may be combined arbitrarily.
159All criteria but
160.Cm all
161and
162.Cm canonical
163require an argument.
164Criteria may be negated by prepending an exclamation mark
165.Pq Sq !\& .
Damien Miller194fd902013-10-15 12:13:05 +1100166.Pp
Damien Miller8e5a67f2013-10-23 16:30:25 +1100167The
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000168.Cm canonical
dtucker@openbsd.orgdd2cfeb2015-05-28 05:09:45 +0000169keyword matches only when the configuration file is being re-parsed
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000170after hostname canonicalization (see the
171.Cm CanonicalizeHostname
172option.)
173This may be useful to specify conditions that work with canonical host
174names only.
175The
Damien Miller8a04be72013-10-23 16:29:40 +1100176.Cm exec
Damien Miller8e5a67f2013-10-23 16:30:25 +1100177keyword executes the specified command under the user's shell.
Damien Miller194fd902013-10-15 12:13:05 +1100178If the command returns a zero exit status then the condition is considered true.
179Commands containing whitespace characters must be quoted.
Damien Miller5c86ebd2013-10-23 16:29:12 +1100180The following character sequences in the command will be expanded prior to
181execution:
182.Ql %L
183will be substituted by the first component of the local host name,
184.Ql %l
185will be substituted by the local host name (including any domain name),
186.Ql %h
187will be substituted by the target host name,
188.Ql %n
189will be substituted by the original target host name
Damien Miller8a04be72013-10-23 16:29:40 +1100190specified on the command-line,
Damien Miller5c86ebd2013-10-23 16:29:12 +1100191.Ql %p
192the destination port,
193.Ql %r
194by the remote login username, and
195.Ql %u
196by the username of the user running
197.Xr ssh 1 .
Damien Miller194fd902013-10-15 12:13:05 +1100198.Pp
199The other keywords' criteria must be single entries or comma-separated
200lists and may use the wildcard and negation operators described in the
201.Sx PATTERNS
202section.
203The criteria for the
204.Cm host
205keyword are matched against the target hostname, after any substitution
206by the
207.Cm Hostname
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000208or
209.Cm CanonicalizeHostname
210options.
Damien Miller194fd902013-10-15 12:13:05 +1100211The
212.Cm originalhost
213keyword matches against the hostname as it was specified on the command-line.
214The
215.Cm user
216keyword matches against the target username on the remote host.
217The
218.Cm localuser
219keyword matches against the name of the local user running
220.Xr ssh 1
221(this keyword may be useful in system-wide
222.Nm
223files).
jcs@openbsd.orgf361df42015-11-15 22:26:49 +0000224.It Cm AddKeysToAgent
225Specifies whether keys should be automatically added to a running
jmc@openbsd.orge41a0712015-11-15 23:58:04 +0000226.Xr ssh-agent 1 .
jcs@openbsd.orgf361df42015-11-15 22:26:49 +0000227If this option is set to
228.Dq yes
229and a key is loaded from a file, the key and its passphrase are added to
230the agent with the default lifetime, as if by
231.Xr ssh-add 1 .
232If this option is set to
233.Dq ask ,
234.Nm ssh
235will require confirmation using the
236.Ev SSH_ASKPASS
237program before adding a key (see
238.Xr ssh-add 1
239for details).
240If this option is set to
241.Dq confirm ,
242each use of the key must be confirmed, as if the
243.Fl c
244option was specified to
245.Xr ssh-add 1 .
246If this option is set to
247.Dq no ,
248no keys are added to the agent.
249The argument must be
250.Dq yes ,
251.Dq confirm ,
252.Dq ask ,
253or
254.Dq no .
255The default is
256.Dq no .
Damien Miller20a8f972003-05-18 20:50:30 +1000257.It Cm AddressFamily
Damien Millerfbf486b2003-05-23 18:44:23 +1000258Specifies which address family to use when connecting.
259Valid arguments are
Damien Miller20a8f972003-05-18 20:50:30 +1000260.Dq any ,
261.Dq inet
Damien Miller45ee2b92006-03-15 11:56:18 +1100262(use IPv4 only), or
Damien Miller20a8f972003-05-18 20:50:30 +1000263.Dq inet6
Darren Tucker79a7acf2005-02-09 09:48:57 +1100264(use IPv6 only).
Ben Lindstrom9f049032002-06-21 00:59:05 +0000265.It Cm BatchMode
266If set to
267.Dq yes ,
268passphrase/password querying will be disabled.
269This option is useful in scripts and other batch jobs where no user
270is present to supply the password.
271The argument must be
272.Dq yes
273or
274.Dq no .
275The default is
276.Dq no .
277.It Cm BindAddress
Darren Tucker89f4d472005-07-14 17:06:21 +1000278Use the specified address on the local machine as the source address of
Darren Tucker6c71d202005-07-14 17:06:50 +1000279the connection.
280Only useful on systems with more than one address.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000281Note that this option does not work if
282.Cm UsePrivilegedPort
283is set to
284.Dq yes .
Damien Miller0faf7472013-10-17 11:47:23 +1100285.It Cm CanonicalDomains
Damien Miller607af342013-10-17 11:47:51 +1100286When
Damien Miller38505592013-10-17 11:48:13 +1100287.Cm CanonicalizeHostname
Damien Miller0faf7472013-10-17 11:47:23 +1100288is enabled, this option specifies the list of domain suffixes in which to
289search for the specified destination host.
Damien Miller38505592013-10-17 11:48:13 +1100290.It Cm CanonicalizeFallbackLocal
Damien Miller51682fa2013-10-17 11:48:31 +1100291Specifies whether to fail with an error when hostname canonicalization fails.
Damien Miller607af342013-10-17 11:47:51 +1100292The default,
Darren Tuckerb7e01c02014-01-19 22:36:13 +1100293.Dq yes ,
Damien Miller607af342013-10-17 11:47:51 +1100294will attempt to look up the unqualified hostname using the system resolver's
Damien Miller0faf7472013-10-17 11:47:23 +1100295search rules.
296A value of
Darren Tuckerb7e01c02014-01-19 22:36:13 +1100297.Dq no
Damien Miller0faf7472013-10-17 11:47:23 +1100298will cause
299.Xr ssh 1
300to fail instantly if
Damien Miller38505592013-10-17 11:48:13 +1100301.Cm CanonicalizeHostname
Damien Miller0faf7472013-10-17 11:47:23 +1100302is enabled and the target hostname cannot be found in any of the domains
303specified by
304.Cm CanonicalDomains .
Damien Miller38505592013-10-17 11:48:13 +1100305.It Cm CanonicalizeHostname
Damien Miller51682fa2013-10-17 11:48:31 +1100306Controls whether explicit hostname canonicalization is performed.
Damien Miller607af342013-10-17 11:47:51 +1100307The default,
308.Dq no ,
Damien Miller0faf7472013-10-17 11:47:23 +1100309is not to perform any name rewriting and let the system resolver handle all
310hostname lookups.
311If set to
312.Dq yes
313then, for connections that do not use a
314.Cm ProxyCommand ,
315.Xr ssh 1
Damien Miller38505592013-10-17 11:48:13 +1100316will attempt to canonicalize the hostname specified on the command line
Damien Miller0faf7472013-10-17 11:47:23 +1100317using the
318.Cm CanonicalDomains
319suffixes and
Damien Miller38505592013-10-17 11:48:13 +1100320.Cm CanonicalizePermittedCNAMEs
Damien Miller0faf7472013-10-17 11:47:23 +1100321rules.
322If
Damien Miller38505592013-10-17 11:48:13 +1100323.Cm CanonicalizeHostname
Damien Miller0faf7472013-10-17 11:47:23 +1100324is set to
325.Dq always ,
Damien Miller51682fa2013-10-17 11:48:31 +1100326then canonicalization is applied to proxied connections too.
Damien Miller13f97b22014-02-24 15:57:55 +1100327.Pp
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000328If this option is enabled, then the configuration files are processed
329again using the new target name to pick up any new configuration in matching
Damien Miller13f97b22014-02-24 15:57:55 +1100330.Cm Host
djm@openbsd.org957fbce2014-10-08 22:20:25 +0000331and
332.Cm Match
Damien Miller13f97b22014-02-24 15:57:55 +1100333stanzas.
Damien Miller38505592013-10-17 11:48:13 +1100334.It Cm CanonicalizeMaxDots
Damien Miller607af342013-10-17 11:47:51 +1100335Specifies the maximum number of dot characters in a hostname before
Damien Miller51682fa2013-10-17 11:48:31 +1100336canonicalization is disabled.
Damien Miller607af342013-10-17 11:47:51 +1100337The default,
338.Dq 1 ,
339allows a single dot (i.e. hostname.subdomain).
Damien Miller38505592013-10-17 11:48:13 +1100340.It Cm CanonicalizePermittedCNAMEs
Damien Miller607af342013-10-17 11:47:51 +1100341Specifies rules to determine whether CNAMEs should be followed when
Damien Miller38505592013-10-17 11:48:13 +1100342canonicalizing hostnames.
Damien Miller0faf7472013-10-17 11:47:23 +1100343The rules consist of one or more arguments of
Damien Miller607af342013-10-17 11:47:51 +1100344.Ar source_domain_list : Ns Ar target_domain_list ,
Damien Miller0faf7472013-10-17 11:47:23 +1100345where
346.Ar source_domain_list
Damien Miller51682fa2013-10-17 11:48:31 +1100347is a pattern-list of domains that may follow CNAMEs in canonicalization,
Damien Miller0faf7472013-10-17 11:47:23 +1100348and
349.Ar target_domain_list
Damien Miller607af342013-10-17 11:47:51 +1100350is a pattern-list of domains that they may resolve to.
Damien Miller0faf7472013-10-17 11:47:23 +1100351.Pp
352For example,
353.Dq *.a.example.com:*.b.example.com,*.c.example.com
354will allow hostnames matching
355.Dq *.a.example.com
Damien Miller38505592013-10-17 11:48:13 +1100356to be canonicalized to names in the
Damien Miller0faf7472013-10-17 11:47:23 +1100357.Dq *.b.example.com
358or
359.Dq *.c.example.com
360domains.
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000361.It Cm CertificateFile
362Specifies a file from which the user's certificate is read.
363A corresponding private key must be provided separately in order
364to use this certificate either
365from an
366.Cm IdentityFile
367directive or
368.Fl i
369flag to
370.Xr ssh 1 ,
371via
372.Xr ssh-agent 1 ,
373or via a
374.Cm PKCS11Provider .
375.Pp
376The file name may use the tilde
377syntax to refer to a user's home directory or one of the following
378escape characters:
379.Ql %d
380(local user's home directory),
381.Ql %u
382(local user name),
383.Ql %l
384(local host name),
385.Ql %h
386(remote host name) or
387.Ql %r
388(remote user name).
389.Pp
390It is possible to have multiple certificate files specified in
391configuration files; these certificates will be tried in sequence.
392Multiple
393.Cm CertificateFile
394directives will add to the list of certificates used for
395authentication.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000396.It Cm ChallengeResponseAuthentication
Damien Miller1faa7132006-03-15 11:55:31 +1100397Specifies whether to use challenge-response authentication.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000398The argument to this keyword must be
399.Dq yes
400or
401.Dq no .
402The default is
403.Dq yes .
404.It Cm CheckHostIP
405If this flag is set to
406.Dq yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +1100407.Xr ssh 1
408will additionally check the host IP address in the
Ben Lindstrom9f049032002-06-21 00:59:05 +0000409.Pa known_hosts
410file.
djm@openbsd.org5e678592015-06-02 09:10:40 +0000411This allows ssh to detect if a host key changed due to DNS spoofing
412and will add addresses of destination hosts to
413.Pa ~/.ssh/known_hosts
414in the process, regardless of the setting of
415.Cm StrictHostKeyChecking .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000416If the option is set to
417.Dq no ,
418the check will not be executed.
419The default is
420.Dq yes .
421.It Cm Cipher
422Specifies the cipher to use for encrypting the session
423in protocol version 1.
424Currently,
425.Dq blowfish ,
426.Dq 3des ,
427and
428.Dq des
429are supported.
430.Ar des
431is only supported in the
Damien Miller45ee2b92006-03-15 11:56:18 +1100432.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000433client for interoperability with legacy protocol 1 implementations
434that do not support the
435.Ar 3des
Damien Miller495dca32003-04-01 21:42:14 +1000436cipher.
437Its use is strongly discouraged due to cryptographic weaknesses.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000438The default is
439.Dq 3des .
440.It Cm Ciphers
441Specifies the ciphers allowed for protocol version 2
442in order of preference.
443Multiple ciphers must be comma-separated.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +0000444If the specified value begins with a
445.Sq +
446character, then the specified ciphers will be appended to the default set
447instead of replacing them.
448.Pp
Damien Miller0fde8ac2013-11-21 14:12:23 +1100449The supported ciphers are:
450.Pp
Damien Millerc1621c82014-04-20 13:22:46 +1000451.Bl -item -compact -offset indent
452.It
4533des-cbc
454.It
455aes128-cbc
456.It
457aes192-cbc
458.It
459aes256-cbc
460.It
461aes128-ctr
462.It
463aes192-ctr
464.It
465aes256-ctr
466.It
467aes128-gcm@openssh.com
468.It
469aes256-gcm@openssh.com
470.It
471arcfour
472.It
473arcfour128
474.It
475arcfour256
476.It
477blowfish-cbc
478.It
479cast128-cbc
480.It
481chacha20-poly1305@openssh.com
482.El
Damien Miller0fde8ac2013-11-21 14:12:23 +1100483.Pp
Damien Miller45ee2b92006-03-15 11:56:18 +1100484The default is:
Damien Millerc1621c82014-04-20 13:22:46 +1000485.Bd -literal -offset indent
jmc@openbsd.org1f8d3d62015-08-14 15:32:41 +0000486chacha20-poly1305@openssh.com,
Damien Millerc1621c82014-04-20 13:22:46 +1000487aes128-ctr,aes192-ctr,aes256-ctr,
Damien Miller1d75abf2013-01-09 16:12:19 +1100488aes128-gcm@openssh.com,aes256-gcm@openssh.com,
djm@openbsd.orge4c918a2016-02-11 02:56:32 +0000489aes128-cbc,aes192-cbc,aes256-cbc,3des-cbc
Ben Lindstrom9f049032002-06-21 00:59:05 +0000490.Ed
Damien Miller0fde8ac2013-11-21 14:12:23 +1100491.Pp
492The list of available ciphers may also be obtained using the
493.Fl Q
494option of
djm@openbsd.org8f6784f2014-12-22 09:05:17 +0000495.Xr ssh 1
496with an argument of
497.Dq cipher .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000498.It Cm ClearAllForwardings
Damien Miller45ee2b92006-03-15 11:56:18 +1100499Specifies that all local, remote, and dynamic port forwardings
Ben Lindstrom9f049032002-06-21 00:59:05 +0000500specified in the configuration files or on the command line be
Damien Miller495dca32003-04-01 21:42:14 +1000501cleared.
502This option is primarily useful when used from the
Damien Miller45ee2b92006-03-15 11:56:18 +1100503.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000504command line to clear port forwardings set in
505configuration files, and is automatically set by
506.Xr scp 1
507and
508.Xr sftp 1 .
509The argument must be
510.Dq yes
511or
512.Dq no .
513The default is
514.Dq no .
515.It Cm Compression
516Specifies whether to use compression.
517The argument must be
518.Dq yes
519or
520.Dq no .
521The default is
522.Dq no .
523.It Cm CompressionLevel
524Specifies the compression level to use if compression is enabled.
525The argument must be an integer from 1 (fast) to 9 (slow, best).
526The default level is 6, which is good for most applications.
527The meaning of the values is the same as in
528.Xr gzip 1 .
529Note that this option applies to protocol version 1 only.
530.It Cm ConnectionAttempts
531Specifies the number of tries (one per second) to make before exiting.
532The argument must be an integer.
533This may be useful in scripts if the connection sometimes fails.
534The default is 1.
Damien Millerb78d5eb2003-05-16 11:39:04 +1000535.It Cm ConnectTimeout
Damien Miller45ee2b92006-03-15 11:56:18 +1100536Specifies the timeout (in seconds) used when connecting to the
537SSH server, instead of using the default system TCP timeout.
Damien Millerfbf486b2003-05-23 18:44:23 +1000538This value is used only when the target is down or really unreachable,
539not when it refuses the connection.
Damien Miller0e220db2004-06-15 10:34:08 +1000540.It Cm ControlMaster
541Enables the sharing of multiple sessions over a single network connection.
542When set to
Damien Miller45ee2b92006-03-15 11:56:18 +1100543.Dq yes ,
544.Xr ssh 1
Damien Miller0e220db2004-06-15 10:34:08 +1000545will listen for connections on a control socket specified using the
546.Cm ControlPath
547argument.
548Additional sessions can connect to this socket using the same
549.Cm ControlPath
550with
551.Cm ControlMaster
552set to
553.Dq no
Damien Miller2234bac2004-06-30 22:38:52 +1000554(the default).
Damien Miller713de762005-11-05 15:13:49 +1100555These sessions will try to reuse the master instance's network connection
Damien Millerb3bfbb72005-11-05 15:11:48 +1100556rather than initiating new ones, but will fall back to connecting normally
557if the control socket does not exist, or is not listening.
558.Pp
Damien Miller23f07702004-06-18 01:19:03 +1000559Setting this to
560.Dq ask
Damien Miller45ee2b92006-03-15 11:56:18 +1100561will cause ssh
jmc@openbsd.org78de1672015-03-30 18:28:37 +0000562to listen for control connections, but require confirmation using
563.Xr ssh-askpass 1 .
Damien Millerdadfd4d2005-05-26 12:07:13 +1000564If the
565.Cm ControlPath
Damien Miller45ee2b92006-03-15 11:56:18 +1100566cannot be opened,
567ssh will continue without connecting to a master instance.
Damien Millerd14b1e72005-06-16 13:19:41 +1000568.Pp
Damien Miller13390022005-07-06 09:44:19 +1000569X11 and
Damien Millerfd94fba2005-07-06 09:44:59 +1000570.Xr ssh-agent 1
Damien Miller13390022005-07-06 09:44:19 +1000571forwarding is supported over these multiplexed connections, however the
Darren Tucker63551872005-12-20 16:14:15 +1100572display and agent forwarded will be the one belonging to the master
Damien Millerfd94fba2005-07-06 09:44:59 +1000573connection i.e. it is not possible to forward multiple displays or agents.
Damien Miller13390022005-07-06 09:44:19 +1000574.Pp
Damien Millerd14b1e72005-06-16 13:19:41 +1000575Two additional options allow for opportunistic multiplexing: try to use a
576master connection but fall back to creating a new one if one does not already
577exist.
578These options are:
579.Dq auto
580and
581.Dq autoask .
582The latter requires confirmation like the
583.Dq ask
584option.
Damien Miller0e220db2004-06-15 10:34:08 +1000585.It Cm ControlPath
Damien Miller6476cad2005-06-16 13:18:34 +1000586Specify the path to the control socket used for connection sharing as described
587in the
Damien Miller0e220db2004-06-15 10:34:08 +1000588.Cm ControlMaster
Damien Miller8f74c8f2005-06-26 08:56:03 +1000589section above or the string
590.Dq none
591to disable connection sharing.
Damien Miller6476cad2005-06-16 13:18:34 +1000592In the path,
Damien Millerdfc85fa2011-05-15 08:44:02 +1000593.Ql %L
594will be substituted by the first component of the local host name,
Damien Miller3ec54c72006-03-15 11:30:13 +1100595.Ql %l
Damien Millerdfc85fa2011-05-15 08:44:02 +1000596will be substituted by the local host name (including any domain name),
Damien Miller6476cad2005-06-16 13:18:34 +1000597.Ql %h
598will be substituted by the target host name,
Damien Miller486dd2e2011-05-15 08:47:18 +1000599.Ql %n
600will be substituted by the original target host name
601specified on the command line,
Damien Miller6476cad2005-06-16 13:18:34 +1000602.Ql %p
Damien Miller5c86ebd2013-10-23 16:29:12 +1100603the destination port,
Damien Miller6476cad2005-06-16 13:18:34 +1000604.Ql %r
Damien Miller9c386432014-07-03 21:27:46 +1000605by the remote login username,
Damien Millerdfc85fa2011-05-15 08:44:02 +1000606.Ql %u
djm@openbsd.org674b3b62015-09-11 03:47:28 +0000607by the username and
608.Ql %i
jmc@openbsd.org95923e02015-09-11 06:51:39 +0000609by the numeric user ID (uid) of the user running
610.Xr ssh 1 ,
611and
Damien Miller0f123412014-07-03 21:28:09 +1000612.Ql \&%C
Damien Miller9c386432014-07-03 21:27:46 +1000613by a hash of the concatenation: %l%h%p%r.
Damien Millerd14b1e72005-06-16 13:19:41 +1000614It is recommended that any
615.Cm ControlPath
616used for opportunistic connection sharing include
djm@openbsd.orgfc302562014-11-10 22:25:49 +0000617at least %h, %p, and %r (or alternatively %C) and be placed in a directory
618that is not writable by other users.
Damien Millerd14b1e72005-06-16 13:19:41 +1000619This ensures that shared connections are uniquely identified.
Damien Millere11e1ea2010-08-03 16:04:46 +1000620.It Cm ControlPersist
621When used in conjunction with
622.Cm ControlMaster ,
623specifies that the master connection should remain open
624in the background (waiting for future client connections)
625after the initial client connection has been closed.
626If set to
627.Dq no ,
628then the master connection will not be placed into the background,
629and will close as soon as the initial client connection is closed.
630If set to
djm@openbsd.orgfc302562014-11-10 22:25:49 +0000631.Dq yes
632or
633.Dq 0 ,
Damien Millere11e1ea2010-08-03 16:04:46 +1000634then the master connection will remain in the background indefinitely
635(until killed or closed via a mechanism such as the
636.Xr ssh 1
637.Dq Fl O No exit
638option).
639If set to a time in seconds, or a time in any of the formats documented in
640.Xr sshd_config 5 ,
641then the backgrounded master connection will automatically terminate
642after it has remained idle (with no client connections) for the
643specified time.
Damien Miller2234bac2004-06-30 22:38:52 +1000644.It Cm DynamicForward
Damien Millere9d001e2006-01-14 10:10:17 +1100645Specifies that a TCP port on the local machine be forwarded
Damien Miller2234bac2004-06-30 22:38:52 +1000646over the secure channel, and the application
647protocol is then used to determine where to connect to from the
648remote machine.
Darren Tuckerc8d64212005-10-03 18:13:42 +1000649.Pp
650The argument must be
651.Sm off
652.Oo Ar bind_address : Oc Ar port .
653.Sm on
Damien Miller7fa96602010-08-05 13:03:13 +1000654IPv6 addresses can be specified by enclosing addresses in square brackets.
Darren Tuckerc8d64212005-10-03 18:13:42 +1000655By default, the local port is bound in accordance with the
656.Cm GatewayPorts
657setting.
658However, an explicit
659.Ar bind_address
660may be used to bind the connection to a specific address.
661The
662.Ar bind_address
663of
664.Dq localhost
665indicates that the listening port be bound for local use only, while an
666empty address or
667.Sq *
668indicates that the port should be available from all interfaces.
669.Pp
Damien Miller2234bac2004-06-30 22:38:52 +1000670Currently the SOCKS4 and SOCKS5 protocols are supported, and
Damien Miller45ee2b92006-03-15 11:56:18 +1100671.Xr ssh 1
Damien Miller2234bac2004-06-30 22:38:52 +1000672will act as a SOCKS server.
673Multiple forwardings may be specified, and
674additional forwardings can be given on the command line.
675Only the superuser can forward privileged ports.
Darren Tucker674f71d2003-06-28 12:33:12 +1000676.It Cm EnableSSHKeysign
677Setting this option to
678.Dq yes
679in the global client configuration file
680.Pa /etc/ssh/ssh_config
681enables the use of the helper program
682.Xr ssh-keysign 8
683during
684.Cm HostbasedAuthentication .
685The argument must be
686.Dq yes
687or
688.Dq no .
689The default is
690.Dq no .
Darren Tuckerf132c672003-10-15 15:58:18 +1000691This option should be placed in the non-hostspecific section.
Darren Tucker674f71d2003-06-28 12:33:12 +1000692See
693.Xr ssh-keysign 8
694for more information.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000695.It Cm EscapeChar
696Sets the escape character (default:
697.Ql ~ ) .
698The escape character can also
699be set on the command line.
700The argument should be a single character,
701.Ql ^
702followed by a letter, or
703.Dq none
704to disable the escape
705character entirely (making the connection transparent for binary
706data).
Darren Tuckere7d4b192006-07-12 22:17:10 +1000707.It Cm ExitOnForwardFailure
708Specifies whether
709.Xr ssh 1
710should terminate the connection if it cannot set up all requested
djm@openbsd.orga954cdb2015-09-04 04:47:50 +0000711dynamic, tunnel, local, and remote port forwardings, (e.g.\&
jmc@openbsd.org5245bc12015-09-04 06:40:45 +0000712if either end is unable to bind and listen on a specified port).
djm@openbsd.orga954cdb2015-09-04 04:47:50 +0000713Note that
714.Cm ExitOnForwardFailure
715does not apply to connections made over port forwardings and will not,
716for example, cause
717.Xr ssh 1
718to exit if TCP connections to the ultimate forwarding destination fail.
Darren Tuckere7d4b192006-07-12 22:17:10 +1000719The argument must be
720.Dq yes
721or
722.Dq no .
723The default is
724.Dq no .
djm@openbsd.orgb79efde2014-12-21 23:12:42 +0000725.It Cm FingerprintHash
726Specifies the hash algorithm used when displaying key fingerprints.
727Valid options are:
728.Dq md5
729and
730.Dq sha256 .
djm@openbsd.orgb79efde2014-12-21 23:12:42 +0000731The default is
732.Dq sha256 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000733.It Cm ForwardAgent
734Specifies whether the connection to the authentication agent (if any)
735will be forwarded to the remote machine.
736The argument must be
737.Dq yes
738or
739.Dq no .
740The default is
741.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000742.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000743Agent forwarding should be enabled with caution.
744Users with the ability to bypass file permissions on the remote host
745(for the agent's Unix-domain socket)
746can access the local agent through the forwarded connection.
747An attacker cannot obtain key material from the agent,
Damien Milleraf653042002-09-04 16:40:37 +1000748however they can perform operations on the keys that enable them to
749authenticate using the identities loaded into the agent.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000750.It Cm ForwardX11
751Specifies whether X11 connections will be automatically redirected
752over the secure channel and
753.Ev DISPLAY
754set.
755The argument must be
756.Dq yes
757or
758.Dq no .
759The default is
760.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000761.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000762X11 forwarding should be enabled with caution.
763Users with the ability to bypass file permissions on the remote host
Darren Tucker0a118da2003-10-15 15:54:32 +1000764(for the user's X11 authorization database)
Damien Miller495dca32003-04-01 21:42:14 +1000765can access the local X11 display through the forwarded connection.
Darren Tucker0a118da2003-10-15 15:54:32 +1000766An attacker may then be able to perform activities such as keystroke monitoring
767if the
768.Cm ForwardX11Trusted
769option is also enabled.
Damien Miller1ab6a512010-06-26 10:02:24 +1000770.It Cm ForwardX11Timeout
Damien Millercede1db2010-07-02 13:33:48 +1000771Specify a timeout for untrusted X11 forwarding
772using the format described in the
Damien Millerfecfd112013-07-18 16:11:50 +1000773TIME FORMATS section of
Damien Miller1ab6a512010-06-26 10:02:24 +1000774.Xr sshd_config 5 .
775X11 connections received by
776.Xr ssh 1
777after this time will be refused.
778The default is to disable untrusted X11 forwarding after twenty minutes has
779elapsed.
Darren Tucker0a118da2003-10-15 15:54:32 +1000780.It Cm ForwardX11Trusted
Darren Tuckerdcf6ec42004-05-13 13:03:56 +1000781If this option is set to
Damien Miller45ee2b92006-03-15 11:56:18 +1100782.Dq yes ,
783remote X11 clients will have full access to the original X11 display.
Damien Miller1717fd42005-03-01 21:17:31 +1100784.Pp
Darren Tucker0a118da2003-10-15 15:54:32 +1000785If this option is set to
Damien Miller45ee2b92006-03-15 11:56:18 +1100786.Dq no ,
787remote X11 clients will be considered untrusted and prevented
Darren Tucker0a118da2003-10-15 15:54:32 +1000788from stealing or tampering with data belonging to trusted X11
789clients.
Damien Miller1717fd42005-03-01 21:17:31 +1100790Furthermore, the
791.Xr xauth 1
792token used for the session will be set to expire after 20 minutes.
793Remote clients will be refused access after this time.
Darren Tucker0a118da2003-10-15 15:54:32 +1000794.Pp
795The default is
796.Dq no .
797.Pp
798See the X11 SECURITY extension specification for full details on
799the restrictions imposed on untrusted clients.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000800.It Cm GatewayPorts
801Specifies whether remote hosts are allowed to connect to local
802forwarded ports.
803By default,
Damien Miller45ee2b92006-03-15 11:56:18 +1100804.Xr ssh 1
Damien Miller495dca32003-04-01 21:42:14 +1000805binds local port forwardings to the loopback address.
806This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000807.Cm GatewayPorts
Damien Miller45ee2b92006-03-15 11:56:18 +1100808can be used to specify that ssh
Ben Lindstrom9f049032002-06-21 00:59:05 +0000809should bind local port forwardings to the wildcard address,
810thus allowing remote hosts to connect to forwarded ports.
811The argument must be
812.Dq yes
813or
814.Dq no .
815The default is
816.Dq no .
817.It Cm GlobalKnownHostsFile
Damien Miller295ee632011-05-29 21:42:31 +1000818Specifies one or more files to use for the global
819host key database, separated by whitespace.
820The default is
821.Pa /etc/ssh/ssh_known_hosts ,
822.Pa /etc/ssh/ssh_known_hosts2 .
Darren Tucker0efd1552003-08-26 11:49:55 +1000823.It Cm GSSAPIAuthentication
Damien Millerbaafb982003-12-17 16:32:23 +1100824Specifies whether user authentication based on GSSAPI is allowed.
Damien Millerc2b98272003-09-03 12:13:30 +1000825The default is
Darren Tuckera044f472003-10-15 15:52:03 +1000826.Dq no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000827.It Cm GSSAPIDelegateCredentials
828Forward (delegate) credentials to the server.
829The default is
830.Dq no .
Damien Millere1776152005-03-01 21:47:37 +1100831.It Cm HashKnownHosts
832Indicates that
Damien Miller45ee2b92006-03-15 11:56:18 +1100833.Xr ssh 1
Damien Millere1776152005-03-01 21:47:37 +1100834should hash host names and addresses when they are added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000835.Pa ~/.ssh/known_hosts .
Damien Millere1776152005-03-01 21:47:37 +1100836These hashed names may be used normally by
Damien Miller45ee2b92006-03-15 11:56:18 +1100837.Xr ssh 1
Damien Millere1776152005-03-01 21:47:37 +1100838and
Damien Miller45ee2b92006-03-15 11:56:18 +1100839.Xr sshd 8 ,
Damien Millere1776152005-03-01 21:47:37 +1100840but they do not reveal identifying information should the file's contents
841be disclosed.
842The default is
843.Dq no .
Damien Miller858bb7d2006-08-05 11:34:51 +1000844Note that existing names and addresses in known hosts files
845will not be converted automatically,
846but may be manually hashed using
Damien Miller4b42d7f2005-03-01 21:48:35 +1100847.Xr ssh-keygen 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000848.It Cm HostbasedAuthentication
849Specifies whether to try rhosts based authentication with public key
850authentication.
851The argument must be
852.Dq yes
853or
854.Dq no .
855The default is
856.Dq no .
djm@openbsd.org46347ed2015-01-30 11:43:14 +0000857.It Cm HostbasedKeyTypes
858Specifies the key types that will be used for hostbased authentication
859as a comma-separated pattern list.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +0000860Alternately if the specified value begins with a
861.Sq +
862character, then the specified key types will be appended to the default set
863instead of replacing them.
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000864The default for this option is:
865.Bd -literal -offset 3n
866ecdsa-sha2-nistp256-cert-v01@openssh.com,
867ecdsa-sha2-nistp384-cert-v01@openssh.com,
868ecdsa-sha2-nistp521-cert-v01@openssh.com,
869ssh-ed25519-cert-v01@openssh.com,
870ssh-rsa-cert-v01@openssh.com,
871ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
djm@openbsd.orge4c918a2016-02-11 02:56:32 +0000872ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000873.Ed
874.Pp
djm@openbsd.org46347ed2015-01-30 11:43:14 +0000875The
876.Fl Q
877option of
878.Xr ssh 1
879may be used to list supported key types.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000880.It Cm HostKeyAlgorithms
jmc@openbsd.orga685ae82016-02-17 07:38:19 +0000881Specifies the host key algorithms
Ben Lindstrom9f049032002-06-21 00:59:05 +0000882that the client wants to use in order of preference.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +0000883Alternately if the specified value begins with a
884.Sq +
885character, then the specified key types will be appended to the default set
886instead of replacing them.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000887The default for this option is:
Damien Millereb8b60e2010-08-31 22:41:14 +1000888.Bd -literal -offset 3n
889ecdsa-sha2-nistp256-cert-v01@openssh.com,
890ecdsa-sha2-nistp384-cert-v01@openssh.com,
891ecdsa-sha2-nistp521-cert-v01@openssh.com,
Damien Miller8ba0ead2013-12-18 17:46:27 +1100892ssh-ed25519-cert-v01@openssh.com,
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000893ssh-rsa-cert-v01@openssh.com,
Damien Millereb8b60e2010-08-31 22:41:14 +1000894ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
djm@openbsd.orge4c918a2016-02-11 02:56:32 +0000895ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa
Damien Millereb8b60e2010-08-31 22:41:14 +1000896.Ed
Damien Millerd925dcd2010-12-01 12:21:51 +1100897.Pp
898If hostkeys are known for the destination host then this default is modified
899to prefer their algorithms.
djm@openbsd.org8f6784f2014-12-22 09:05:17 +0000900.Pp
901The list of available key types may also be obtained using the
902.Fl Q
903option of
904.Xr ssh 1
905with an argument of
906.Dq key .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000907.It Cm HostKeyAlias
908Specifies an alias that should be used instead of the
909real host name when looking up or saving the host key
910in the host key database files.
Damien Miller45ee2b92006-03-15 11:56:18 +1100911This option is useful for tunneling SSH connections
Ben Lindstrom9f049032002-06-21 00:59:05 +0000912or for multiple servers running on a single host.
913.It Cm HostName
914Specifies the real host name to log into.
915This can be used to specify nicknames or abbreviations for hosts.
Damien Millerd0244d42010-07-16 13:56:43 +1000916If the hostname contains the character sequence
917.Ql %h ,
Damien Miller486dd2e2011-05-15 08:47:18 +1000918then this will be replaced with the host name specified on the command line
Damien Millerd0244d42010-07-16 13:56:43 +1000919(this is useful for manipulating unqualified names).
Damien Milleref9f13b2014-07-03 21:26:21 +1000920The character sequence
921.Ql %%
922will be replaced by a single
923.Ql %
924character, which may be used when specifying IPv6 link-local addresses.
925.Pp
Damien Miller45ee2b92006-03-15 11:56:18 +1100926The default is the name given on the command line.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000927Numeric IP addresses are also permitted (both on the command line and in
928.Cm HostName
929specifications).
Damien Millerbd394c32004-03-08 23:12:36 +1100930.It Cm IdentitiesOnly
931Specifies that
Damien Miller45ee2b92006-03-15 11:56:18 +1100932.Xr ssh 1
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000933should only use the authentication identity and certificate files explicitly
934configured in the
Damien Miller1a812582004-04-20 20:13:32 +1000935.Nm
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000936files
937or passed on the
938.Xr ssh 1
939command-line,
Damien Miller45ee2b92006-03-15 11:56:18 +1100940even if
941.Xr ssh-agent 1
Damien Millercb6b68b2012-12-03 09:49:52 +1100942or a
943.Cm PKCS11Provider
Damien Millerbd394c32004-03-08 23:12:36 +1100944offers more identities.
945The argument to this keyword must be
946.Dq yes
947or
948.Dq no .
Damien Miller45ee2b92006-03-15 11:56:18 +1100949This option is intended for situations where ssh-agent
Damien Millerbd394c32004-03-08 23:12:36 +1100950offers many different identities.
951The default is
952.Dq no .
Damien Miller957d4e42005-12-13 19:30:45 +1100953.It Cm IdentityFile
sobrado@openbsd.orgf70b22b2014-08-30 15:33:50 +0000954Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication
Damien Millereb8b60e2010-08-31 22:41:14 +1000955identity is read.
Damien Miller957d4e42005-12-13 19:30:45 +1100956The default is
957.Pa ~/.ssh/identity
958for protocol version 1, and
Damien Millereb8b60e2010-08-31 22:41:14 +1000959.Pa ~/.ssh/id_dsa ,
Damien Miller8ba0ead2013-12-18 17:46:27 +1100960.Pa ~/.ssh/id_ecdsa ,
961.Pa ~/.ssh/id_ed25519
Damien Miller957d4e42005-12-13 19:30:45 +1100962and
Damien Millereb8b60e2010-08-31 22:41:14 +1000963.Pa ~/.ssh/id_rsa
Damien Miller957d4e42005-12-13 19:30:45 +1100964for protocol version 2.
965Additionally, any identities represented by the authentication agent
Damien Miller7f2b4382013-07-18 16:10:29 +1000966will be used for authentication unless
967.Cm IdentitiesOnly
968is set.
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000969If no certificates have been explicitly specified by
970.Cm CertificateFile ,
Damien Miller5059d8d2010-03-05 21:31:11 +1100971.Xr ssh 1
972will try to load certificate information from the filename obtained by
973appending
974.Pa -cert.pub
975to the path of a specified
976.Cm IdentityFile .
Damien Miller6b1d53c2006-03-31 23:13:21 +1100977.Pp
Damien Miller957d4e42005-12-13 19:30:45 +1100978The file name may use the tilde
Damien Millerc6437cf2006-03-31 23:14:41 +1100979syntax to refer to a user's home directory or one of the following
Damien Miller6b1d53c2006-03-31 23:13:21 +1100980escape characters:
981.Ql %d
982(local user's home directory),
983.Ql %u
984(local user name),
985.Ql %l
986(local host name),
987.Ql %h
988(remote host name) or
Damien Millerdfc61832006-03-31 23:14:57 +1100989.Ql %r
Damien Miller6b1d53c2006-03-31 23:13:21 +1100990(remote user name).
991.Pp
Damien Miller957d4e42005-12-13 19:30:45 +1100992It is possible to have
993multiple identity files specified in configuration files; all these
994identities will be tried in sequence.
Damien Miller6029e072011-06-20 14:22:49 +1000995Multiple
996.Cm IdentityFile
997directives will add to the list of identities tried (this behaviour
998differs from that of other configuration directives).
Damien Miller7f2b4382013-07-18 16:10:29 +1000999.Pp
1000.Cm IdentityFile
1001may be used in conjunction with
1002.Cm IdentitiesOnly
1003to select which identities in an agent are offered during authentication.
djm@openbsd.org4e44a792015-09-24 06:15:11 +00001004.Cm IdentityFile
1005may also be used in conjunction with
1006.Cm CertificateFile
1007in order to provide any certificate also needed for authentication with
1008the identity.
Darren Tucker63e0df22013-05-16 20:30:31 +10001009.It Cm IgnoreUnknown
1010Specifies a pattern-list of unknown options to be ignored if they are
1011encountered in configuration parsing.
1012This may be used to suppress errors if
1013.Nm
1014contains options that are unrecognised by
1015.Xr ssh 1 .
1016It is recommended that
1017.Cm IgnoreUnknown
1018be listed early in the configuration file as it will not be applied
1019to unknown options that appear before it.
Damien Miller0dac6fb2010-11-20 15:19:38 +11001020.It Cm IPQoS
1021Specifies the IPv4 type-of-service or DSCP class for connections.
1022Accepted values are
1023.Dq af11 ,
1024.Dq af12 ,
1025.Dq af13 ,
Damien Millerf6e758c2011-09-22 21:37:13 +10001026.Dq af21 ,
Damien Miller0dac6fb2010-11-20 15:19:38 +11001027.Dq af22 ,
1028.Dq af23 ,
1029.Dq af31 ,
1030.Dq af32 ,
1031.Dq af33 ,
1032.Dq af41 ,
1033.Dq af42 ,
1034.Dq af43 ,
1035.Dq cs0 ,
1036.Dq cs1 ,
1037.Dq cs2 ,
1038.Dq cs3 ,
1039.Dq cs4 ,
1040.Dq cs5 ,
1041.Dq cs6 ,
1042.Dq cs7 ,
1043.Dq ef ,
1044.Dq lowdelay ,
1045.Dq throughput ,
1046.Dq reliability ,
1047or a numeric value.
Damien Miller928362d2010-12-26 14:26:45 +11001048This option may take one or two arguments, separated by whitespace.
Damien Miller0dac6fb2010-11-20 15:19:38 +11001049If one argument is specified, it is used as the packet class unconditionally.
1050If two values are specified, the first is automatically selected for
1051interactive sessions and the second for non-interactive sessions.
1052The default is
1053.Dq lowdelay
1054for interactive sessions and
1055.Dq throughput
1056for non-interactive sessions.
Damien Millercfb606c2007-10-26 14:24:48 +10001057.It Cm KbdInteractiveAuthentication
1058Specifies whether to use keyboard-interactive authentication.
1059The argument to this keyword must be
1060.Dq yes
1061or
1062.Dq no .
1063The default is
1064.Dq yes .
Darren Tucker636ca902004-11-05 20:22:00 +11001065.It Cm KbdInteractiveDevices
1066Specifies the list of methods to use in keyboard-interactive authentication.
1067Multiple method names must be comma-separated.
1068The default is to use the server specified list.
Damien Miller9cfbaec2006-03-15 11:57:55 +11001069The methods available vary depending on what the server supports.
1070For an OpenSSH server,
1071it may be zero or more of:
1072.Dq bsdauth ,
1073.Dq pam ,
1074and
1075.Dq skey .
Damien Millerd5f62bf2010-09-24 22:11:14 +10001076.It Cm KexAlgorithms
1077Specifies the available KEX (Key Exchange) algorithms.
1078Multiple algorithms must be comma-separated.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001079Alternately if the specified value begins with a
1080.Sq +
1081character, then the specified methods will be appended to the default set
1082instead of replacing them.
Damien Miller7fe2b1f2010-09-24 22:11:53 +10001083The default is:
1084.Bd -literal -offset indent
Damien Miller0bd8f152013-11-04 08:55:43 +11001085curve25519-sha256@libssh.org,
Damien Miller7fe2b1f2010-09-24 22:11:53 +10001086ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1087diffie-hellman-group-exchange-sha256,
Damien Millerc1621c82014-04-20 13:22:46 +10001088diffie-hellman-group-exchange-sha1,
djm@openbsd.orgbdfd29f2015-07-03 03:47:00 +00001089diffie-hellman-group14-sha1
Damien Miller7fe2b1f2010-09-24 22:11:53 +10001090.Ed
djm@openbsd.org8f6784f2014-12-22 09:05:17 +00001091.Pp
1092The list of available key exchange algorithms may also be obtained using the
1093.Fl Q
1094option of
1095.Xr ssh 1
1096with an argument of
1097.Dq kex .
Damien Millerd27b9472005-12-13 19:29:02 +11001098.It Cm LocalCommand
1099Specifies a command to execute on the local machine after successfully
1100connecting to the server.
1101The command string extends to the end of the line, and is executed with
Darren Tucker63b31cb2007-12-02 23:09:30 +11001102the user's shell.
Darren Tuckerf6b01b72008-06-13 04:56:37 +10001103The following escape character substitutions will be performed:
1104.Ql %d
1105(local user's home directory),
1106.Ql %h
1107(remote host name),
1108.Ql %l
1109(local host name),
1110.Ql %n
1111(host name as provided on the command line),
1112.Ql %p
1113(remote port),
1114.Ql %r
1115(remote user name) or
1116.Ql %u
Damien Miller9c386432014-07-03 21:27:46 +10001117(local user name) or
Damien Miller0f123412014-07-03 21:28:09 +10001118.Ql \&%C
Damien Miller9c386432014-07-03 21:27:46 +10001119by a hash of the concatenation: %l%h%p%r.
Darren Tucker78be8c52010-01-08 17:05:59 +11001120.Pp
1121The command is run synchronously and does not have access to the
1122session of the
1123.Xr ssh 1
1124that spawned it.
1125It should not be used for interactive commands.
1126.Pp
Damien Millerd27b9472005-12-13 19:29:02 +11001127This directive is ignored unless
1128.Cm PermitLocalCommand
1129has been enabled.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001130.It Cm LocalForward
Damien Millere9d001e2006-01-14 10:10:17 +11001131Specifies that a TCP port on the local machine be forwarded over
Ben Lindstrom9f049032002-06-21 00:59:05 +00001132the secure channel to the specified host and port from the remote machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001133The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +11001134.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001135.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +11001136.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001137and the second argument must be
1138.Ar host : Ns Ar hostport .
Damien Miller7fa96602010-08-05 13:03:13 +10001139IPv6 addresses can be specified by enclosing addresses in square brackets.
Damien Millerf8c55462005-03-02 12:03:05 +11001140Multiple forwardings may be specified, and additional forwardings can be
Damien Millerf91ee4c2005-03-01 21:24:33 +11001141given on the command line.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001142Only the superuser can forward privileged ports.
Damien Millerf91ee4c2005-03-01 21:24:33 +11001143By default, the local port is bound in accordance with the
1144.Cm GatewayPorts
1145setting.
1146However, an explicit
1147.Ar bind_address
1148may be used to bind the connection to a specific address.
1149The
1150.Ar bind_address
1151of
1152.Dq localhost
Damien Millerf8c55462005-03-02 12:03:05 +11001153indicates that the listening port be bound for local use only, while an
1154empty address or
1155.Sq *
Damien Millerf91ee4c2005-03-01 21:24:33 +11001156indicates that the port should be available from all interfaces.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001157.It Cm LogLevel
1158Gives the verbosity level that is used when logging messages from
Damien Miller45ee2b92006-03-15 11:56:18 +11001159.Xr ssh 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001160The possible values are:
Damien Miller45ee2b92006-03-15 11:56:18 +11001161QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +10001162The default is INFO.
1163DEBUG and DEBUG1 are equivalent.
1164DEBUG2 and DEBUG3 each specify higher levels of verbose output.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001165.It Cm MACs
1166Specifies the MAC (message authentication code) algorithms
1167in order of preference.
jmc@openbsd.orga685ae82016-02-17 07:38:19 +00001168The MAC algorithm is used for data integrity protection.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001169Multiple algorithms must be comma-separated.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001170If the specified value begins with a
1171.Sq +
1172character, then the specified algorithms will be appended to the default set
1173instead of replacing them.
1174.Pp
Damien Milleraf43a7a2012-12-12 10:46:31 +11001175The algorithms that contain
1176.Dq -etm
1177calculate the MAC after encryption (encrypt-then-mac).
1178These are considered safer and their use recommended.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001179.Pp
Damien Miller45ee2b92006-03-15 11:56:18 +11001180The default is:
Damien Miller5e7c30b2007-06-11 14:06:32 +10001181.Bd -literal -offset indent
Damien Milleraf43a7a2012-12-12 10:46:31 +11001182umac-64-etm@openssh.com,umac-128-etm@openssh.com,
1183hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
djm@openbsd.orge4c918a2016-02-11 02:56:32 +00001184hmac-sha1-etm@openssh.com,
Damien Millerc1621c82014-04-20 13:22:46 +10001185umac-64@openssh.com,umac-128@openssh.com,
djm@openbsd.orge4c918a2016-02-11 02:56:32 +00001186hmac-sha2-256,hmac-sha2-512,hmac-sha1
Damien Miller5e7c30b2007-06-11 14:06:32 +10001187.Ed
djm@openbsd.org8f6784f2014-12-22 09:05:17 +00001188.Pp
1189The list of available MAC algorithms may also be obtained using the
1190.Fl Q
1191option of
1192.Xr ssh 1
1193with an argument of
1194.Dq mac .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001195.It Cm NoHostAuthenticationForLocalhost
1196This option can be used if the home directory is shared across machines.
1197In this case localhost will refer to a different machine on each of
1198the machines and the user will get many warnings about changed host keys.
1199However, this option disables host authentication for localhost.
1200The argument to this keyword must be
1201.Dq yes
1202or
1203.Dq no .
1204The default is to check the host key for localhost.
1205.It Cm NumberOfPasswordPrompts
1206Specifies the number of password prompts before giving up.
1207The argument to this keyword must be an integer.
Damien Miller45ee2b92006-03-15 11:56:18 +11001208The default is 3.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001209.It Cm PasswordAuthentication
1210Specifies whether to use password authentication.
1211The argument to this keyword must be
1212.Dq yes
1213or
1214.Dq no .
1215The default is
1216.Dq yes .
Damien Millerd27b9472005-12-13 19:29:02 +11001217.It Cm PermitLocalCommand
1218Allow local command execution via the
1219.Ic LocalCommand
1220option or using the
Damien Miller4b2319f2005-12-13 19:30:27 +11001221.Ic !\& Ns Ar command
Damien Millerd27b9472005-12-13 19:29:02 +11001222escape sequence in
1223.Xr ssh 1 .
1224The argument must be
1225.Dq yes
1226or
1227.Dq no .
1228The default is
1229.Dq no .
Damien Miller7ea845e2010-02-12 09:21:02 +11001230.It Cm PKCS11Provider
1231Specifies which PKCS#11 provider to use.
Damien Miller8e1ea4e2010-11-20 15:20:10 +11001232The argument to this keyword is the PKCS#11 shared library
Damien Miller7ea845e2010-02-12 09:21:02 +11001233.Xr ssh 1
Damien Millera7618442010-02-12 09:26:02 +11001234should use to communicate with a PKCS#11 token providing the user's
Damien Miller7ea845e2010-02-12 09:21:02 +11001235private RSA key.
Damien Miller957d4e42005-12-13 19:30:45 +11001236.It Cm Port
1237Specifies the port number to connect on the remote host.
Damien Miller45ee2b92006-03-15 11:56:18 +11001238The default is 22.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001239.It Cm PreferredAuthentications
jmc@openbsd.orga685ae82016-02-17 07:38:19 +00001240Specifies the order in which the client should try authentication methods.
Darren Tucker1adc2bd2005-03-14 23:14:20 +11001241This allows a client to prefer one method (e.g.\&
Ben Lindstrom9f049032002-06-21 00:59:05 +00001242.Cm keyboard-interactive )
Darren Tucker1adc2bd2005-03-14 23:14:20 +11001243over another method (e.g.\&
Damien Miller544378d2010-04-16 15:52:24 +10001244.Cm password ) .
1245The default is:
1246.Bd -literal -offset indent
1247gssapi-with-mic,hostbased,publickey,
1248keyboard-interactive,password
1249.Ed
Ben Lindstrom9f049032002-06-21 00:59:05 +00001250.It Cm Protocol
1251Specifies the protocol versions
Damien Miller45ee2b92006-03-15 11:56:18 +11001252.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001253should support in order of preference.
1254The possible values are
Damien Miller45ee2b92006-03-15 11:56:18 +11001255.Sq 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001256and
Damien Miller45ee2b92006-03-15 11:56:18 +11001257.Sq 2 .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001258Multiple versions must be comma-separated.
Darren Tuckerbad50762009-10-11 21:51:08 +11001259When this option is set to
Darren Tucker7a4a7652009-10-11 21:51:40 +11001260.Dq 2,1
Darren Tuckerbad50762009-10-11 21:51:08 +11001261.Nm ssh
1262will try version 2 and fall back to version 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001263if version 2 is not available.
Darren Tuckerbad50762009-10-11 21:51:08 +11001264The default is
Darren Tucker7a4a7652009-10-11 21:51:40 +11001265.Sq 2 .
djm@openbsd.orge7901ef2016-02-16 05:11:04 +00001266Protocol 1 suffers from a number of cryptographic weaknesses and should
1267not be used.
1268It is only offered to support legacy devices.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001269.It Cm ProxyCommand
1270Specifies the command to use to connect to the server.
1271The command
Damien Miller079bac22014-07-09 13:06:25 +10001272string extends to the end of the line, and is executed
1273using the user's shell
1274.Ql exec
1275directive to avoid a lingering shell process.
1276.Pp
Damien Millerc4eddee2010-04-18 08:07:43 +10001277In the command string, any occurrence of
Ben Lindstrom9f049032002-06-21 00:59:05 +00001278.Ql %h
1279will be substituted by the host name to
Damien Millerb1b17042010-04-16 15:54:19 +10001280connect,
Ben Lindstrom9f049032002-06-21 00:59:05 +00001281.Ql %p
Damien Millerc4eddee2010-04-18 08:07:43 +10001282by the port, and
1283.Ql %r
Damien Millerb1b17042010-04-16 15:54:19 +10001284by the remote user name.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001285The command can be basically anything,
1286and should read from its standard input and write to its standard output.
1287It should eventually connect an
1288.Xr sshd 8
1289server running on some machine, or execute
1290.Ic sshd -i
1291somewhere.
1292Host key management will be done using the
1293HostName of the host being connected (defaulting to the name typed by
1294the user).
Damien Miller495dca32003-04-01 21:42:14 +10001295Setting the command to
1296.Dq none
Damien Miller9f1e33a2003-02-24 11:57:32 +11001297disables this option entirely.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001298Note that
1299.Cm CheckHostIP
1300is not available for connects with a proxy command.
1301.Pp
Damien Millerebcfedc2005-05-26 12:13:56 +10001302This directive is useful in conjunction with
1303.Xr nc 1
1304and its proxy support.
Damien Millerdfec2942005-05-26 12:14:32 +10001305For example, the following directive would connect via an HTTP proxy at
Damien Millerebcfedc2005-05-26 12:13:56 +10001306192.0.2.0:
1307.Bd -literal -offset 3n
1308ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
1309.Ed
Damien Miller1262b662013-08-21 02:44:24 +10001310.It Cm ProxyUseFdpass
Damien Millerf2f6c312013-08-21 02:44:58 +10001311Specifies that
Damien Miller1262b662013-08-21 02:44:24 +10001312.Cm ProxyCommand
1313will pass a connected file descriptor back to
Damien Millerf2f6c312013-08-21 02:44:58 +10001314.Xr ssh 1
Damien Miller1262b662013-08-21 02:44:24 +10001315instead of continuing to execute and pass data.
1316The default is
1317.Dq no .
markus@openbsd.org3a1638d2015-07-10 06:21:53 +00001318.It Cm PubkeyAcceptedKeyTypes
1319Specifies the key types that will be used for public key authentication
1320as a comma-separated pattern list.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001321Alternately if the specified value begins with a
1322.Sq +
1323character, then the key types after it will be appended to the default
1324instead of replacing it.
markus@openbsd.org3a1638d2015-07-10 06:21:53 +00001325The default for this option is:
1326.Bd -literal -offset 3n
1327ecdsa-sha2-nistp256-cert-v01@openssh.com,
1328ecdsa-sha2-nistp384-cert-v01@openssh.com,
1329ecdsa-sha2-nistp521-cert-v01@openssh.com,
1330ssh-ed25519-cert-v01@openssh.com,
1331ssh-rsa-cert-v01@openssh.com,
1332ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
djm@openbsd.orge4c918a2016-02-11 02:56:32 +00001333ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa
markus@openbsd.org3a1638d2015-07-10 06:21:53 +00001334.Ed
1335.Pp
1336The
1337.Fl Q
1338option of
1339.Xr ssh 1
1340may be used to list supported key types.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001341.It Cm PubkeyAuthentication
1342Specifies whether to try public key authentication.
1343The argument to this keyword must be
1344.Dq yes
1345or
1346.Dq no .
1347The default is
1348.Dq yes .
Darren Tucker62388b22006-01-20 11:31:47 +11001349.It Cm RekeyLimit
1350Specifies the maximum amount of data that may be transmitted before the
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001351session key is renegotiated, optionally followed a maximum amount of
1352time that may pass before the session key is renegotiated.
1353The first argument is specified in bytes and may have a suffix of
Damien Millerddfddf12006-01-31 21:39:03 +11001354.Sq K ,
1355.Sq M ,
Darren Tucker62388b22006-01-20 11:31:47 +11001356or
Damien Millerddfddf12006-01-31 21:39:03 +11001357.Sq G
Darren Tucker62388b22006-01-20 11:31:47 +11001358to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1359The default is between
Damien Miller45ee2b92006-03-15 11:56:18 +11001360.Sq 1G
Darren Tucker62388b22006-01-20 11:31:47 +11001361and
Damien Miller45ee2b92006-03-15 11:56:18 +11001362.Sq 4G ,
Darren Tucker62388b22006-01-20 11:31:47 +11001363depending on the cipher.
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001364The optional second value is specified in seconds and may use any of the
1365units documented in the
Damien Millerfecfd112013-07-18 16:11:50 +10001366TIME FORMATS section of
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001367.Xr sshd_config 5 .
1368The default value for
1369.Cm RekeyLimit
1370is
1371.Dq default none ,
1372which means that rekeying is performed after the cipher's default amount
1373of data has been sent or received and no time based rekeying is done.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001374.It Cm RemoteForward
Damien Millere9d001e2006-01-14 10:10:17 +11001375Specifies that a TCP port on the remote machine be forwarded over
Ben Lindstrom9f049032002-06-21 00:59:05 +00001376the secure channel to the specified host and port from the local machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001377The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +11001378.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001379.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +11001380.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001381and the second argument must be
1382.Ar host : Ns Ar hostport .
Damien Miller7fa96602010-08-05 13:03:13 +10001383IPv6 addresses can be specified by enclosing addresses in square brackets.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001384Multiple forwardings may be specified, and additional
1385forwardings can be given on the command line.
Damien Millerde7532e2008-11-03 19:24:45 +11001386Privileged ports can be forwarded only when
1387logging in as root on the remote machine.
Damien Millere379e102009-02-14 16:34:39 +11001388.Pp
Damien Miller85c6d8a2009-02-14 16:34:21 +11001389If the
1390.Ar port
1391argument is
1392.Ql 0 ,
1393the listen port will be dynamically allocated on the server and reported
1394to the client at run time.
Damien Millerf91ee4c2005-03-01 21:24:33 +11001395.Pp
1396If the
1397.Ar bind_address
1398is not specified, the default is to only bind to loopback addresses.
1399If the
1400.Ar bind_address
1401is
1402.Ql *
1403or an empty string, then the forwarding is requested to listen on all
1404interfaces.
1405Specifying a remote
1406.Ar bind_address
Damien Millerf8c55462005-03-02 12:03:05 +11001407will only succeed if the server's
1408.Cm GatewayPorts
Damien Millerf91ee4c2005-03-01 21:24:33 +11001409option is enabled (see
Damien Millerf8c55462005-03-02 12:03:05 +11001410.Xr sshd_config 5 ) .
Damien Miller21771e22011-05-15 08:45:50 +10001411.It Cm RequestTTY
1412Specifies whether to request a pseudo-tty for the session.
1413The argument may be one of:
1414.Dq no
1415(never request a TTY),
1416.Dq yes
1417(always request a TTY when standard input is a TTY),
1418.Dq force
1419(always request a TTY) or
1420.Dq auto
1421(request a TTY when opening a login session).
1422This option mirrors the
1423.Fl t
1424and
1425.Fl T
1426flags for
1427.Xr ssh 1 .
djm@openbsd.org5e39a492014-12-04 02:24:32 +00001428.It Cm RevokedHostKeys
1429Specifies revoked host public keys.
1430Keys listed in this file will be refused for host authentication.
1431Note that if this file does not exist or is not readable,
1432then host authentication will be refused for all hosts.
1433Keys may be specified as a text file, listing one public key per line, or as
1434an OpenSSH Key Revocation List (KRL) as generated by
1435.Xr ssh-keygen 1 .
1436For more information on KRLs, see the KEY REVOCATION LISTS section in
1437.Xr ssh-keygen 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001438.It Cm RhostsRSAAuthentication
1439Specifies whether to try rhosts based authentication with RSA host
1440authentication.
1441The argument must be
1442.Dq yes
1443or
1444.Dq no .
1445The default is
1446.Dq no .
1447This option applies to protocol version 1 only and requires
Damien Miller45ee2b92006-03-15 11:56:18 +11001448.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001449to be setuid root.
1450.It Cm RSAAuthentication
1451Specifies whether to try RSA authentication.
1452The argument to this keyword must be
1453.Dq yes
1454or
1455.Dq no .
1456RSA authentication will only be
1457attempted if the identity file exists, or an authentication agent is
1458running.
1459The default is
1460.Dq yes .
1461Note that this option applies to protocol version 1 only.
Darren Tucker46bc0752004-05-02 22:11:30 +10001462.It Cm SendEnv
1463Specifies what variables from the local
1464.Xr environ 7
1465should be sent to the server.
Damien Miller45ee2b92006-03-15 11:56:18 +11001466The server must also support it, and the server must be configured to
Darren Tucker1e0c9bf2004-05-02 22:12:48 +10001467accept these environment variables.
dtucker@openbsd.org85b96ef2015-04-28 10:17:58 +00001468Note that the
1469.Ev TERM
jmc@openbsd.orgc1d5bcf2015-04-28 13:47:38 +00001470environment variable is always sent whenever a
dtucker@openbsd.org85b96ef2015-04-28 10:17:58 +00001471pseudo-terminal is requested as it is required by the protocol.
Darren Tucker46bc0752004-05-02 22:11:30 +10001472Refer to
1473.Cm AcceptEnv
1474in
1475.Xr sshd_config 5
1476for how to configure the server.
Damien Miller6def5512006-03-15 11:54:05 +11001477Variables are specified by name, which may contain wildcard characters.
Darren Tucker1e0c9bf2004-05-02 22:12:48 +10001478Multiple environment variables may be separated by whitespace or spread
Darren Tucker46bc0752004-05-02 22:11:30 +10001479across multiple
1480.Cm SendEnv
1481directives.
1482The default is not to send any environment variables.
Damien Millerf54a4b92006-03-15 11:54:36 +11001483.Pp
1484See
1485.Sx PATTERNS
1486for more information on patterns.
Damien Miller509b0102003-12-17 16:33:10 +11001487.It Cm ServerAliveCountMax
Damien Millerb7977702006-01-03 18:47:31 +11001488Sets the number of server alive messages (see below) which may be
Damien Miller509b0102003-12-17 16:33:10 +11001489sent without
Damien Miller45ee2b92006-03-15 11:56:18 +11001490.Xr ssh 1
Damien Miller509b0102003-12-17 16:33:10 +11001491receiving any messages back from the server.
1492If this threshold is reached while server alive messages are being sent,
Damien Miller45ee2b92006-03-15 11:56:18 +11001493ssh will disconnect from the server, terminating the session.
Damien Miller509b0102003-12-17 16:33:10 +11001494It is important to note that the use of server alive messages is very
1495different from
1496.Cm TCPKeepAlive
1497(below).
1498The server alive messages are sent through the encrypted channel
1499and therefore will not be spoofable.
1500The TCP keepalive option enabled by
1501.Cm TCPKeepAlive
1502is spoofable.
1503The server alive mechanism is valuable when the client or
1504server depend on knowing when a connection has become inactive.
1505.Pp
1506The default value is 3.
1507If, for example,
1508.Cm ServerAliveInterval
Damien Miller45ee2b92006-03-15 11:56:18 +11001509(see below) is set to 15 and
Damien Miller509b0102003-12-17 16:33:10 +11001510.Cm ServerAliveCountMax
Damien Miller45ee2b92006-03-15 11:56:18 +11001511is left at the default, if the server becomes unresponsive,
1512ssh will disconnect after approximately 45 seconds.
Damien Miller957d4e42005-12-13 19:30:45 +11001513.It Cm ServerAliveInterval
1514Sets a timeout interval in seconds after which if no data has been received
1515from the server,
Damien Miller45ee2b92006-03-15 11:56:18 +11001516.Xr ssh 1
Damien Miller957d4e42005-12-13 19:30:45 +11001517will send a message through the encrypted
1518channel to request a response from the server.
1519The default
1520is 0, indicating that these messages will not be sent to the server.
Damien Miller7acefbb2014-07-18 14:11:24 +10001521.It Cm StreamLocalBindMask
1522Sets the octal file creation mode mask
1523.Pq umask
1524used when creating a Unix-domain socket file for local or remote
1525port forwarding.
1526This option is only used for port forwarding to a Unix-domain socket file.
1527.Pp
1528The default value is 0177, which creates a Unix-domain socket file that is
1529readable and writable only by the owner.
1530Note that not all operating systems honor the file mode on Unix-domain
1531socket files.
1532.It Cm StreamLocalBindUnlink
1533Specifies whether to remove an existing Unix-domain socket file for local
1534or remote port forwarding before creating a new one.
1535If the socket file already exists and
1536.Cm StreamLocalBindUnlink
1537is not enabled,
1538.Nm ssh
1539will be unable to forward the port to the Unix-domain socket file.
1540This option is only used for port forwarding to a Unix-domain socket file.
1541.Pp
1542The argument must be
1543.Dq yes
1544or
1545.Dq no .
1546The default is
1547.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001548.It Cm StrictHostKeyChecking
1549If this flag is set to
1550.Dq yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001551.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001552will never automatically add host keys to the
Damien Miller167ea5d2005-05-26 12:04:02 +10001553.Pa ~/.ssh/known_hosts
Ben Lindstrom9f049032002-06-21 00:59:05 +00001554file, and refuses to connect to hosts whose host key has changed.
1555This provides maximum protection against trojan horse attacks,
Damien Miller45ee2b92006-03-15 11:56:18 +11001556though it can be annoying when the
Ben Lindstrom9f049032002-06-21 00:59:05 +00001557.Pa /etc/ssh/ssh_known_hosts
Damien Miller45ee2b92006-03-15 11:56:18 +11001558file is poorly maintained or when connections to new hosts are
Ben Lindstrom9f049032002-06-21 00:59:05 +00001559frequently made.
1560This option forces the user to manually
1561add all new hosts.
1562If this flag is set to
1563.Dq no ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001564ssh will automatically add new host keys to the
Ben Lindstrom9f049032002-06-21 00:59:05 +00001565user known hosts files.
1566If this flag is set to
1567.Dq ask ,
1568new host keys
1569will be added to the user known host files only after the user
1570has confirmed that is what they really want to do, and
Damien Miller45ee2b92006-03-15 11:56:18 +11001571ssh will refuse to connect to hosts whose host key has changed.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001572The host keys of
1573known hosts will be verified automatically in all cases.
1574The argument must be
1575.Dq yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001576.Dq no ,
Ben Lindstrom9f049032002-06-21 00:59:05 +00001577or
1578.Dq ask .
1579The default is
1580.Dq ask .
Damien Miller12c150e2003-12-17 16:31:10 +11001581.It Cm TCPKeepAlive
1582Specifies whether the system should send TCP keepalive messages to the
1583other side.
1584If they are sent, death of the connection or crash of one
1585of the machines will be properly noticed.
1586However, this means that
1587connections will die if the route is down temporarily, and some people
1588find it annoying.
1589.Pp
1590The default is
1591.Dq yes
1592(to send TCP keepalive messages), and the client will notice
1593if the network goes down or the remote host dies.
1594This is important in scripts, and many users want it too.
1595.Pp
1596To disable TCP keepalive messages, the value should be set to
1597.Dq no .
Damien Millerd27b9472005-12-13 19:29:02 +11001598.It Cm Tunnel
Damien Miller991dba42006-07-10 20:16:27 +10001599Request
Damien Millerd27b9472005-12-13 19:29:02 +11001600.Xr tun 4
Damien Miller7746c392005-12-13 19:33:37 +11001601device forwarding between the client and the server.
Damien Millerd27b9472005-12-13 19:29:02 +11001602The argument must be
Damien Miller7b58e802005-12-13 19:33:19 +11001603.Dq yes ,
Damien Miller991dba42006-07-10 20:16:27 +10001604.Dq point-to-point
1605(layer 3),
1606.Dq ethernet
1607(layer 2),
Damien Millerd27b9472005-12-13 19:29:02 +11001608or
1609.Dq no .
Damien Miller991dba42006-07-10 20:16:27 +10001610Specifying
1611.Dq yes
1612requests the default tunnel mode, which is
1613.Dq point-to-point .
Damien Millerd27b9472005-12-13 19:29:02 +11001614The default is
1615.Dq no .
1616.It Cm TunnelDevice
Damien Miller991dba42006-07-10 20:16:27 +10001617Specifies the
Damien Millerd27b9472005-12-13 19:29:02 +11001618.Xr tun 4
Damien Miller991dba42006-07-10 20:16:27 +10001619devices to open on the client
1620.Pq Ar local_tun
1621and the server
1622.Pq Ar remote_tun .
1623.Pp
1624The argument must be
1625.Sm off
1626.Ar local_tun Op : Ar remote_tun .
1627.Sm on
1628The devices may be specified by numerical ID or the keyword
1629.Dq any ,
1630which uses the next available tunnel device.
1631If
1632.Ar remote_tun
1633is not specified, it defaults to
1634.Dq any .
1635The default is
1636.Dq any:any .
djm@openbsd.org1d1092b2015-01-26 12:16:36 +00001637.It Cm UpdateHostKeys
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001638Specifies whether
1639.Xr ssh 1
1640should accept notifications of additional hostkeys from the server sent
1641after authentication has completed and add them to
1642.Cm UserKnownHostsFile .
1643The argument must be
djm@openbsd.org523463a2015-02-16 22:13:32 +00001644.Dq yes ,
djm@openbsd.org15ad7502015-02-02 07:41:40 +00001645.Dq no
djm@openbsd.org523463a2015-02-16 22:13:32 +00001646(the default) or
1647.Dq ask .
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001648Enabling this option allows learning alternate hostkeys for a server
djm@openbsd.org1d1092b2015-01-26 12:16:36 +00001649and supports graceful key rotation by allowing a server to send replacement
1650public keys before old ones are removed.
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001651Additional hostkeys are only accepted if the key used to authenticate the
sobrado@openbsd.orge3cbb062015-09-22 08:33:23 +00001652host was already trusted or explicitly accepted by the user.
djm@openbsd.org523463a2015-02-16 22:13:32 +00001653If
1654.Cm UpdateHostKeys
1655is set to
1656.Dq ask ,
1657then the user is asked to confirm the modifications to the known_hosts file.
djm@openbsd.org44732de2015-02-20 22:17:21 +00001658Confirmation is currently incompatible with
1659.Cm ControlPersist ,
1660and will be disabled if it is enabled.
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001661.Pp
1662Presently, only
1663.Xr sshd 8
1664from OpenSSH 6.8 and greater support the
1665.Dq hostkeys@openssh.com
1666protocol extension used to inform the client of all the server's hostkeys.
Damien Millere8cd7412005-12-24 14:55:47 +11001667.It Cm UsePrivilegedPort
1668Specifies whether to use a privileged port for outgoing connections.
1669The argument must be
1670.Dq yes
1671or
1672.Dq no .
1673The default is
1674.Dq no .
1675If set to
Damien Miller45ee2b92006-03-15 11:56:18 +11001676.Dq yes ,
1677.Xr ssh 1
Damien Millere8cd7412005-12-24 14:55:47 +11001678must be setuid root.
1679Note that this option must be set to
1680.Dq yes
1681for
1682.Cm RhostsRSAAuthentication
1683with older servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001684.It Cm User
1685Specifies the user to log in as.
1686This can be useful when a different user name is used on different machines.
1687This saves the trouble of
1688having to remember to give the user name on the command line.
1689.It Cm UserKnownHostsFile
Damien Miller295ee632011-05-29 21:42:31 +10001690Specifies one or more files to use for the user
1691host key database, separated by whitespace.
1692The default is
1693.Pa ~/.ssh/known_hosts ,
1694.Pa ~/.ssh/known_hosts2 .
Damien Miller37876e92003-05-15 10:19:46 +10001695.It Cm VerifyHostKeyDNS
1696Specifies whether to verify the remote key using DNS and SSHFP resource
1697records.
Damien Miller150b5572003-11-17 21:19:29 +11001698If this option is set to
1699.Dq yes ,
Damien Millerfe448472003-11-17 21:19:49 +11001700the client will implicitly trust keys that match a secure fingerprint
Damien Miller150b5572003-11-17 21:19:29 +11001701from DNS.
1702Insecure fingerprints will be handled as if this option was set to
1703.Dq ask .
1704If this option is set to
1705.Dq ask ,
1706information on fingerprint match will be displayed, but the user will still
1707need to confirm new host keys according to the
1708.Cm StrictHostKeyChecking
1709option.
1710The argument must be
1711.Dq yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001712.Dq no ,
Damien Millerfe448472003-11-17 21:19:49 +11001713or
1714.Dq ask .
Damien Miller37876e92003-05-15 10:19:46 +10001715The default is
1716.Dq no .
Damien Miller45ee2b92006-03-15 11:56:18 +11001717.Pp
Damien Millerfecfd112013-07-18 16:11:50 +10001718See also VERIFYING HOST KEYS in
Damien Miller45ee2b92006-03-15 11:56:18 +11001719.Xr ssh 1 .
Damien Miller10288242008-06-30 00:04:03 +10001720.It Cm VisualHostKey
1721If this flag is set to
1722.Dq yes ,
1723an ASCII art representation of the remote host key fingerprint is
djm@openbsd.orgb79efde2014-12-21 23:12:42 +00001724printed in addition to the fingerprint string at login and
Damien Millera414cd32008-11-03 19:25:21 +11001725for unknown host keys.
Damien Miller10288242008-06-30 00:04:03 +10001726If this flag is set to
1727.Dq no ,
Damien Millera414cd32008-11-03 19:25:21 +11001728no fingerprint strings are printed at login and
djm@openbsd.orgb79efde2014-12-21 23:12:42 +00001729only the fingerprint string will be printed for unknown host keys.
Damien Miller10288242008-06-30 00:04:03 +10001730The default is
1731.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001732.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +10001733Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +00001734.Xr xauth 1
1735program.
1736The default is
1737.Pa /usr/X11R6/bin/xauth .
1738.El
Damien Millerb5282c22006-03-15 11:59:08 +11001739.Sh PATTERNS
1740A
1741.Em pattern
1742consists of zero or more non-whitespace characters,
1743.Sq *
1744(a wildcard that matches zero or more characters),
1745or
1746.Sq ?\&
1747(a wildcard that matches exactly one character).
1748For example, to specify a set of declarations for any host in the
1749.Dq .co.uk
1750set of domains,
1751the following pattern could be used:
1752.Pp
1753.Dl Host *.co.uk
1754.Pp
1755The following pattern
1756would match any host in the 192.168.0.[0-9] network range:
1757.Pp
1758.Dl Host 192.168.0.?
1759.Pp
1760A
1761.Em pattern-list
1762is a comma-separated list of patterns.
1763Patterns within pattern-lists may be negated
1764by preceding them with an exclamation mark
1765.Pq Sq !\& .
1766For example,
Damien Miller51682fa2013-10-17 11:48:31 +11001767to allow a key to be used from anywhere within an organization
Damien Millerb5282c22006-03-15 11:59:08 +11001768except from the
1769.Dq dialup
1770pool,
1771the following entry (in authorized_keys) could be used:
1772.Pp
1773.Dl from=\&"!*.dialup.example.com,*.example.com\&"
Ben Lindstrom9f049032002-06-21 00:59:05 +00001774.Sh FILES
1775.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +10001776.It Pa ~/.ssh/config
Ben Lindstrom9f049032002-06-21 00:59:05 +00001777This is the per-user configuration file.
1778The format of this file is described above.
Damien Miller45ee2b92006-03-15 11:56:18 +11001779This file is used by the SSH client.
Damien Millerc970cb92004-04-20 20:12:53 +10001780Because of the potential for abuse, this file must have strict permissions:
1781read/write for the user, and not accessible by others.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001782.It Pa /etc/ssh/ssh_config
1783Systemwide configuration file.
1784This file provides defaults for those
1785values that are not specified in the user's configuration file, and
1786for those users who do not have a configuration file.
1787This file must be world-readable.
1788.El
Damien Millerf1ce5052003-06-11 22:04:39 +10001789.Sh SEE ALSO
1790.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001791.Sh AUTHORS
1792OpenSSH is a derivative of the original and free
1793ssh 1.2.12 release by Tatu Ylonen.
1794Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1795Theo de Raadt and Dug Song
1796removed many bugs, re-added newer features and
1797created OpenSSH.
1798Markus Friedl contributed the support for SSH
1799protocol versions 1.5 and 2.0.