blob: 2ede53ff4d771a382ef619494511b2463a9440ba [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.orge41a0712015-11-15 23:58:04 +000036.\" $OpenBSD: ssh_config.5,v 1.223 2015/11/15 23:58:04 jmc Exp $
jcs@openbsd.orgf361df42015-11-15 22:26:49 +000037.Dd $Mdocdate: November 15 2015 $
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,
Damien Millerc1621c82014-04-20 13:22:46 +1000489arcfour256,arcfour128,
490aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,
491aes192-cbc,aes256-cbc,arcfour
Ben Lindstrom9f049032002-06-21 00:59:05 +0000492.Ed
Damien Miller0fde8ac2013-11-21 14:12:23 +1100493.Pp
494The list of available ciphers may also be obtained using the
495.Fl Q
496option of
djm@openbsd.org8f6784f2014-12-22 09:05:17 +0000497.Xr ssh 1
498with an argument of
499.Dq cipher .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000500.It Cm ClearAllForwardings
Damien Miller45ee2b92006-03-15 11:56:18 +1100501Specifies that all local, remote, and dynamic port forwardings
Ben Lindstrom9f049032002-06-21 00:59:05 +0000502specified in the configuration files or on the command line be
Damien Miller495dca32003-04-01 21:42:14 +1000503cleared.
504This option is primarily useful when used from the
Damien Miller45ee2b92006-03-15 11:56:18 +1100505.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +0000506command line to clear port forwardings set in
507configuration files, and is automatically set by
508.Xr scp 1
509and
510.Xr sftp 1 .
511The argument must be
512.Dq yes
513or
514.Dq no .
515The default is
516.Dq no .
517.It Cm Compression
518Specifies whether to use compression.
519The argument must be
520.Dq yes
521or
522.Dq no .
523The default is
524.Dq no .
525.It Cm CompressionLevel
526Specifies the compression level to use if compression is enabled.
527The argument must be an integer from 1 (fast) to 9 (slow, best).
528The default level is 6, which is good for most applications.
529The meaning of the values is the same as in
530.Xr gzip 1 .
531Note that this option applies to protocol version 1 only.
532.It Cm ConnectionAttempts
533Specifies the number of tries (one per second) to make before exiting.
534The argument must be an integer.
535This may be useful in scripts if the connection sometimes fails.
536The default is 1.
Damien Millerb78d5eb2003-05-16 11:39:04 +1000537.It Cm ConnectTimeout
Damien Miller45ee2b92006-03-15 11:56:18 +1100538Specifies the timeout (in seconds) used when connecting to the
539SSH server, instead of using the default system TCP timeout.
Damien Millerfbf486b2003-05-23 18:44:23 +1000540This value is used only when the target is down or really unreachable,
541not when it refuses the connection.
Damien Miller0e220db2004-06-15 10:34:08 +1000542.It Cm ControlMaster
543Enables the sharing of multiple sessions over a single network connection.
544When set to
Damien Miller45ee2b92006-03-15 11:56:18 +1100545.Dq yes ,
546.Xr ssh 1
Damien Miller0e220db2004-06-15 10:34:08 +1000547will listen for connections on a control socket specified using the
548.Cm ControlPath
549argument.
550Additional sessions can connect to this socket using the same
551.Cm ControlPath
552with
553.Cm ControlMaster
554set to
555.Dq no
Damien Miller2234bac2004-06-30 22:38:52 +1000556(the default).
Damien Miller713de762005-11-05 15:13:49 +1100557These sessions will try to reuse the master instance's network connection
Damien Millerb3bfbb72005-11-05 15:11:48 +1100558rather than initiating new ones, but will fall back to connecting normally
559if the control socket does not exist, or is not listening.
560.Pp
Damien Miller23f07702004-06-18 01:19:03 +1000561Setting this to
562.Dq ask
Damien Miller45ee2b92006-03-15 11:56:18 +1100563will cause ssh
jmc@openbsd.org78de1672015-03-30 18:28:37 +0000564to listen for control connections, but require confirmation using
565.Xr ssh-askpass 1 .
Damien Millerdadfd4d2005-05-26 12:07:13 +1000566If the
567.Cm ControlPath
Damien Miller45ee2b92006-03-15 11:56:18 +1100568cannot be opened,
569ssh will continue without connecting to a master instance.
Damien Millerd14b1e72005-06-16 13:19:41 +1000570.Pp
Damien Miller13390022005-07-06 09:44:19 +1000571X11 and
Damien Millerfd94fba2005-07-06 09:44:59 +1000572.Xr ssh-agent 1
Damien Miller13390022005-07-06 09:44:19 +1000573forwarding is supported over these multiplexed connections, however the
Darren Tucker63551872005-12-20 16:14:15 +1100574display and agent forwarded will be the one belonging to the master
Damien Millerfd94fba2005-07-06 09:44:59 +1000575connection i.e. it is not possible to forward multiple displays or agents.
Damien Miller13390022005-07-06 09:44:19 +1000576.Pp
Damien Millerd14b1e72005-06-16 13:19:41 +1000577Two additional options allow for opportunistic multiplexing: try to use a
578master connection but fall back to creating a new one if one does not already
579exist.
580These options are:
581.Dq auto
582and
583.Dq autoask .
584The latter requires confirmation like the
585.Dq ask
586option.
Damien Miller0e220db2004-06-15 10:34:08 +1000587.It Cm ControlPath
Damien Miller6476cad2005-06-16 13:18:34 +1000588Specify the path to the control socket used for connection sharing as described
589in the
Damien Miller0e220db2004-06-15 10:34:08 +1000590.Cm ControlMaster
Damien Miller8f74c8f2005-06-26 08:56:03 +1000591section above or the string
592.Dq none
593to disable connection sharing.
Damien Miller6476cad2005-06-16 13:18:34 +1000594In the path,
Damien Millerdfc85fa2011-05-15 08:44:02 +1000595.Ql %L
596will be substituted by the first component of the local host name,
Damien Miller3ec54c72006-03-15 11:30:13 +1100597.Ql %l
Damien Millerdfc85fa2011-05-15 08:44:02 +1000598will be substituted by the local host name (including any domain name),
Damien Miller6476cad2005-06-16 13:18:34 +1000599.Ql %h
600will be substituted by the target host name,
Damien Miller486dd2e2011-05-15 08:47:18 +1000601.Ql %n
602will be substituted by the original target host name
603specified on the command line,
Damien Miller6476cad2005-06-16 13:18:34 +1000604.Ql %p
Damien Miller5c86ebd2013-10-23 16:29:12 +1100605the destination port,
Damien Miller6476cad2005-06-16 13:18:34 +1000606.Ql %r
Damien Miller9c386432014-07-03 21:27:46 +1000607by the remote login username,
Damien Millerdfc85fa2011-05-15 08:44:02 +1000608.Ql %u
djm@openbsd.org674b3b62015-09-11 03:47:28 +0000609by the username and
610.Ql %i
jmc@openbsd.org95923e02015-09-11 06:51:39 +0000611by the numeric user ID (uid) of the user running
612.Xr ssh 1 ,
613and
Damien Miller0f123412014-07-03 21:28:09 +1000614.Ql \&%C
Damien Miller9c386432014-07-03 21:27:46 +1000615by a hash of the concatenation: %l%h%p%r.
Damien Millerd14b1e72005-06-16 13:19:41 +1000616It is recommended that any
617.Cm ControlPath
618used for opportunistic connection sharing include
djm@openbsd.orgfc302562014-11-10 22:25:49 +0000619at least %h, %p, and %r (or alternatively %C) and be placed in a directory
620that is not writable by other users.
Damien Millerd14b1e72005-06-16 13:19:41 +1000621This ensures that shared connections are uniquely identified.
Damien Millere11e1ea2010-08-03 16:04:46 +1000622.It Cm ControlPersist
623When used in conjunction with
624.Cm ControlMaster ,
625specifies that the master connection should remain open
626in the background (waiting for future client connections)
627after the initial client connection has been closed.
628If set to
629.Dq no ,
630then the master connection will not be placed into the background,
631and will close as soon as the initial client connection is closed.
632If set to
djm@openbsd.orgfc302562014-11-10 22:25:49 +0000633.Dq yes
634or
635.Dq 0 ,
Damien Millere11e1ea2010-08-03 16:04:46 +1000636then the master connection will remain in the background indefinitely
637(until killed or closed via a mechanism such as the
638.Xr ssh 1
639.Dq Fl O No exit
640option).
641If set to a time in seconds, or a time in any of the formats documented in
642.Xr sshd_config 5 ,
643then the backgrounded master connection will automatically terminate
644after it has remained idle (with no client connections) for the
645specified time.
Damien Miller2234bac2004-06-30 22:38:52 +1000646.It Cm DynamicForward
Damien Millere9d001e2006-01-14 10:10:17 +1100647Specifies that a TCP port on the local machine be forwarded
Damien Miller2234bac2004-06-30 22:38:52 +1000648over the secure channel, and the application
649protocol is then used to determine where to connect to from the
650remote machine.
Darren Tuckerc8d64212005-10-03 18:13:42 +1000651.Pp
652The argument must be
653.Sm off
654.Oo Ar bind_address : Oc Ar port .
655.Sm on
Damien Miller7fa96602010-08-05 13:03:13 +1000656IPv6 addresses can be specified by enclosing addresses in square brackets.
Darren Tuckerc8d64212005-10-03 18:13:42 +1000657By default, the local port is bound in accordance with the
658.Cm GatewayPorts
659setting.
660However, an explicit
661.Ar bind_address
662may be used to bind the connection to a specific address.
663The
664.Ar bind_address
665of
666.Dq localhost
667indicates that the listening port be bound for local use only, while an
668empty address or
669.Sq *
670indicates that the port should be available from all interfaces.
671.Pp
Damien Miller2234bac2004-06-30 22:38:52 +1000672Currently the SOCKS4 and SOCKS5 protocols are supported, and
Damien Miller45ee2b92006-03-15 11:56:18 +1100673.Xr ssh 1
Damien Miller2234bac2004-06-30 22:38:52 +1000674will act as a SOCKS server.
675Multiple forwardings may be specified, and
676additional forwardings can be given on the command line.
677Only the superuser can forward privileged ports.
Darren Tucker674f71d2003-06-28 12:33:12 +1000678.It Cm EnableSSHKeysign
679Setting this option to
680.Dq yes
681in the global client configuration file
682.Pa /etc/ssh/ssh_config
683enables the use of the helper program
684.Xr ssh-keysign 8
685during
686.Cm HostbasedAuthentication .
687The argument must be
688.Dq yes
689or
690.Dq no .
691The default is
692.Dq no .
Darren Tuckerf132c672003-10-15 15:58:18 +1000693This option should be placed in the non-hostspecific section.
Darren Tucker674f71d2003-06-28 12:33:12 +1000694See
695.Xr ssh-keysign 8
696for more information.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000697.It Cm EscapeChar
698Sets the escape character (default:
699.Ql ~ ) .
700The escape character can also
701be set on the command line.
702The argument should be a single character,
703.Ql ^
704followed by a letter, or
705.Dq none
706to disable the escape
707character entirely (making the connection transparent for binary
708data).
Darren Tuckere7d4b192006-07-12 22:17:10 +1000709.It Cm ExitOnForwardFailure
710Specifies whether
711.Xr ssh 1
712should terminate the connection if it cannot set up all requested
djm@openbsd.orga954cdb2015-09-04 04:47:50 +0000713dynamic, tunnel, local, and remote port forwardings, (e.g.\&
jmc@openbsd.org5245bc12015-09-04 06:40:45 +0000714if either end is unable to bind and listen on a specified port).
djm@openbsd.orga954cdb2015-09-04 04:47:50 +0000715Note that
716.Cm ExitOnForwardFailure
717does not apply to connections made over port forwardings and will not,
718for example, cause
719.Xr ssh 1
720to exit if TCP connections to the ultimate forwarding destination fail.
Darren Tuckere7d4b192006-07-12 22:17:10 +1000721The argument must be
722.Dq yes
723or
724.Dq no .
725The default is
726.Dq no .
djm@openbsd.orgb79efde2014-12-21 23:12:42 +0000727.It Cm FingerprintHash
728Specifies the hash algorithm used when displaying key fingerprints.
729Valid options are:
730.Dq md5
731and
732.Dq sha256 .
djm@openbsd.orgb79efde2014-12-21 23:12:42 +0000733The default is
734.Dq sha256 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000735.It Cm ForwardAgent
736Specifies whether the connection to the authentication agent (if any)
737will be forwarded to the remote machine.
738The argument must be
739.Dq yes
740or
741.Dq no .
742The default is
743.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000744.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000745Agent forwarding should be enabled with caution.
746Users with the ability to bypass file permissions on the remote host
747(for the agent's Unix-domain socket)
748can access the local agent through the forwarded connection.
749An attacker cannot obtain key material from the agent,
Damien Milleraf653042002-09-04 16:40:37 +1000750however they can perform operations on the keys that enable them to
751authenticate using the identities loaded into the agent.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000752.It Cm ForwardX11
753Specifies whether X11 connections will be automatically redirected
754over the secure channel and
755.Ev DISPLAY
756set.
757The argument must be
758.Dq yes
759or
760.Dq no .
761The default is
762.Dq no .
Damien Milleraf653042002-09-04 16:40:37 +1000763.Pp
Damien Miller495dca32003-04-01 21:42:14 +1000764X11 forwarding should be enabled with caution.
765Users with the ability to bypass file permissions on the remote host
Darren Tucker0a118da2003-10-15 15:54:32 +1000766(for the user's X11 authorization database)
Damien Miller495dca32003-04-01 21:42:14 +1000767can access the local X11 display through the forwarded connection.
Darren Tucker0a118da2003-10-15 15:54:32 +1000768An attacker may then be able to perform activities such as keystroke monitoring
769if the
770.Cm ForwardX11Trusted
771option is also enabled.
Damien Miller1ab6a512010-06-26 10:02:24 +1000772.It Cm ForwardX11Timeout
Damien Millercede1db2010-07-02 13:33:48 +1000773Specify a timeout for untrusted X11 forwarding
774using the format described in the
Damien Millerfecfd112013-07-18 16:11:50 +1000775TIME FORMATS section of
Damien Miller1ab6a512010-06-26 10:02:24 +1000776.Xr sshd_config 5 .
777X11 connections received by
778.Xr ssh 1
779after this time will be refused.
780The default is to disable untrusted X11 forwarding after twenty minutes has
781elapsed.
Darren Tucker0a118da2003-10-15 15:54:32 +1000782.It Cm ForwardX11Trusted
Darren Tuckerdcf6ec42004-05-13 13:03:56 +1000783If this option is set to
Damien Miller45ee2b92006-03-15 11:56:18 +1100784.Dq yes ,
785remote X11 clients will have full access to the original X11 display.
Damien Miller1717fd42005-03-01 21:17:31 +1100786.Pp
Darren Tucker0a118da2003-10-15 15:54:32 +1000787If this option is set to
Damien Miller45ee2b92006-03-15 11:56:18 +1100788.Dq no ,
789remote X11 clients will be considered untrusted and prevented
Darren Tucker0a118da2003-10-15 15:54:32 +1000790from stealing or tampering with data belonging to trusted X11
791clients.
Damien Miller1717fd42005-03-01 21:17:31 +1100792Furthermore, the
793.Xr xauth 1
794token used for the session will be set to expire after 20 minutes.
795Remote clients will be refused access after this time.
Darren Tucker0a118da2003-10-15 15:54:32 +1000796.Pp
797The default is
798.Dq no .
799.Pp
800See the X11 SECURITY extension specification for full details on
801the restrictions imposed on untrusted clients.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000802.It Cm GatewayPorts
803Specifies whether remote hosts are allowed to connect to local
804forwarded ports.
805By default,
Damien Miller45ee2b92006-03-15 11:56:18 +1100806.Xr ssh 1
Damien Miller495dca32003-04-01 21:42:14 +1000807binds local port forwardings to the loopback address.
808This prevents other remote hosts from connecting to forwarded ports.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000809.Cm GatewayPorts
Damien Miller45ee2b92006-03-15 11:56:18 +1100810can be used to specify that ssh
Ben Lindstrom9f049032002-06-21 00:59:05 +0000811should bind local port forwardings to the wildcard address,
812thus allowing remote hosts to connect to forwarded ports.
813The argument must be
814.Dq yes
815or
816.Dq no .
817The default is
818.Dq no .
819.It Cm GlobalKnownHostsFile
Damien Miller295ee632011-05-29 21:42:31 +1000820Specifies one or more files to use for the global
821host key database, separated by whitespace.
822The default is
823.Pa /etc/ssh/ssh_known_hosts ,
824.Pa /etc/ssh/ssh_known_hosts2 .
Darren Tucker0efd1552003-08-26 11:49:55 +1000825.It Cm GSSAPIAuthentication
Damien Millerbaafb982003-12-17 16:32:23 +1100826Specifies whether user authentication based on GSSAPI is allowed.
Damien Millerc2b98272003-09-03 12:13:30 +1000827The default is
Darren Tuckera044f472003-10-15 15:52:03 +1000828.Dq no .
Darren Tucker0efd1552003-08-26 11:49:55 +1000829Note that this option applies to protocol version 2 only.
830.It Cm GSSAPIDelegateCredentials
831Forward (delegate) credentials to the server.
832The default is
833.Dq no .
834Note that this option applies to protocol version 2 only.
Damien Millere1776152005-03-01 21:47:37 +1100835.It Cm HashKnownHosts
836Indicates that
Damien Miller45ee2b92006-03-15 11:56:18 +1100837.Xr ssh 1
Damien Millere1776152005-03-01 21:47:37 +1100838should hash host names and addresses when they are added to
Damien Miller167ea5d2005-05-26 12:04:02 +1000839.Pa ~/.ssh/known_hosts .
Damien Millere1776152005-03-01 21:47:37 +1100840These hashed names may be used normally by
Damien Miller45ee2b92006-03-15 11:56:18 +1100841.Xr ssh 1
Damien Millere1776152005-03-01 21:47:37 +1100842and
Damien Miller45ee2b92006-03-15 11:56:18 +1100843.Xr sshd 8 ,
Damien Millere1776152005-03-01 21:47:37 +1100844but they do not reveal identifying information should the file's contents
845be disclosed.
846The default is
847.Dq no .
Damien Miller858bb7d2006-08-05 11:34:51 +1000848Note that existing names and addresses in known hosts files
849will not be converted automatically,
850but may be manually hashed using
Damien Miller4b42d7f2005-03-01 21:48:35 +1100851.Xr ssh-keygen 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000852.It Cm HostbasedAuthentication
853Specifies whether to try rhosts based authentication with public key
854authentication.
855The argument must be
856.Dq yes
857or
858.Dq no .
859The default is
860.Dq no .
861This option applies to protocol version 2 only and
862is similar to
863.Cm RhostsRSAAuthentication .
djm@openbsd.org46347ed2015-01-30 11:43:14 +0000864.It Cm HostbasedKeyTypes
865Specifies the key types that will be used for hostbased authentication
866as a comma-separated pattern list.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +0000867Alternately if the specified value begins with a
868.Sq +
869character, then the specified key types will be appended to the default set
870instead of replacing them.
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000871The default for this option is:
872.Bd -literal -offset 3n
873ecdsa-sha2-nistp256-cert-v01@openssh.com,
874ecdsa-sha2-nistp384-cert-v01@openssh.com,
875ecdsa-sha2-nistp521-cert-v01@openssh.com,
876ssh-ed25519-cert-v01@openssh.com,
877ssh-rsa-cert-v01@openssh.com,
878ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
879ssh-ed25519,ssh-rsa
880.Ed
881.Pp
djm@openbsd.org46347ed2015-01-30 11:43:14 +0000882The
883.Fl Q
884option of
885.Xr ssh 1
886may be used to list supported key types.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000887.It Cm HostKeyAlgorithms
888Specifies the protocol version 2 host key algorithms
889that the client wants to use in order of preference.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +0000890Alternately if the specified value begins with a
891.Sq +
892character, then the specified key types will be appended to the default set
893instead of replacing them.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000894The default for this option is:
Damien Millereb8b60e2010-08-31 22:41:14 +1000895.Bd -literal -offset 3n
896ecdsa-sha2-nistp256-cert-v01@openssh.com,
897ecdsa-sha2-nistp384-cert-v01@openssh.com,
898ecdsa-sha2-nistp521-cert-v01@openssh.com,
Damien Miller8ba0ead2013-12-18 17:46:27 +1100899ssh-ed25519-cert-v01@openssh.com,
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000900ssh-rsa-cert-v01@openssh.com,
Damien Millereb8b60e2010-08-31 22:41:14 +1000901ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
markus@openbsd.org3a1638d2015-07-10 06:21:53 +0000902ssh-ed25519,ssh-rsa
Damien Millereb8b60e2010-08-31 22:41:14 +1000903.Ed
Damien Millerd925dcd2010-12-01 12:21:51 +1100904.Pp
905If hostkeys are known for the destination host then this default is modified
906to prefer their algorithms.
djm@openbsd.org8f6784f2014-12-22 09:05:17 +0000907.Pp
908The list of available key types may also be obtained using the
909.Fl Q
910option of
911.Xr ssh 1
912with an argument of
913.Dq key .
Ben Lindstrom9f049032002-06-21 00:59:05 +0000914.It Cm HostKeyAlias
915Specifies an alias that should be used instead of the
916real host name when looking up or saving the host key
917in the host key database files.
Damien Miller45ee2b92006-03-15 11:56:18 +1100918This option is useful for tunneling SSH connections
Ben Lindstrom9f049032002-06-21 00:59:05 +0000919or for multiple servers running on a single host.
920.It Cm HostName
921Specifies the real host name to log into.
922This can be used to specify nicknames or abbreviations for hosts.
Damien Millerd0244d42010-07-16 13:56:43 +1000923If the hostname contains the character sequence
924.Ql %h ,
Damien Miller486dd2e2011-05-15 08:47:18 +1000925then this will be replaced with the host name specified on the command line
Damien Millerd0244d42010-07-16 13:56:43 +1000926(this is useful for manipulating unqualified names).
Damien Milleref9f13b2014-07-03 21:26:21 +1000927The character sequence
928.Ql %%
929will be replaced by a single
930.Ql %
931character, which may be used when specifying IPv6 link-local addresses.
932.Pp
Damien Miller45ee2b92006-03-15 11:56:18 +1100933The default is the name given on the command line.
Ben Lindstrom9f049032002-06-21 00:59:05 +0000934Numeric IP addresses are also permitted (both on the command line and in
935.Cm HostName
936specifications).
Damien Millerbd394c32004-03-08 23:12:36 +1100937.It Cm IdentitiesOnly
938Specifies that
Damien Miller45ee2b92006-03-15 11:56:18 +1100939.Xr ssh 1
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000940should only use the authentication identity and certificate files explicitly
941configured in the
Damien Miller1a812582004-04-20 20:13:32 +1000942.Nm
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000943files
944or passed on the
945.Xr ssh 1
946command-line,
Damien Miller45ee2b92006-03-15 11:56:18 +1100947even if
948.Xr ssh-agent 1
Damien Millercb6b68b2012-12-03 09:49:52 +1100949or a
950.Cm PKCS11Provider
Damien Millerbd394c32004-03-08 23:12:36 +1100951offers more identities.
952The argument to this keyword must be
953.Dq yes
954or
955.Dq no .
Damien Miller45ee2b92006-03-15 11:56:18 +1100956This option is intended for situations where ssh-agent
Damien Millerbd394c32004-03-08 23:12:36 +1100957offers many different identities.
958The default is
959.Dq no .
Damien Miller957d4e42005-12-13 19:30:45 +1100960.It Cm IdentityFile
sobrado@openbsd.orgf70b22b2014-08-30 15:33:50 +0000961Specifies a file from which the user's DSA, ECDSA, Ed25519 or RSA authentication
Damien Millereb8b60e2010-08-31 22:41:14 +1000962identity is read.
Damien Miller957d4e42005-12-13 19:30:45 +1100963The default is
964.Pa ~/.ssh/identity
965for protocol version 1, and
Damien Millereb8b60e2010-08-31 22:41:14 +1000966.Pa ~/.ssh/id_dsa ,
Damien Miller8ba0ead2013-12-18 17:46:27 +1100967.Pa ~/.ssh/id_ecdsa ,
968.Pa ~/.ssh/id_ed25519
Damien Miller957d4e42005-12-13 19:30:45 +1100969and
Damien Millereb8b60e2010-08-31 22:41:14 +1000970.Pa ~/.ssh/id_rsa
Damien Miller957d4e42005-12-13 19:30:45 +1100971for protocol version 2.
972Additionally, any identities represented by the authentication agent
Damien Miller7f2b4382013-07-18 16:10:29 +1000973will be used for authentication unless
974.Cm IdentitiesOnly
975is set.
djm@openbsd.org4e44a792015-09-24 06:15:11 +0000976If no certificates have been explicitly specified by
977.Cm CertificateFile ,
Damien Miller5059d8d2010-03-05 21:31:11 +1100978.Xr ssh 1
979will try to load certificate information from the filename obtained by
980appending
981.Pa -cert.pub
982to the path of a specified
983.Cm IdentityFile .
Damien Miller6b1d53c2006-03-31 23:13:21 +1100984.Pp
Damien Miller957d4e42005-12-13 19:30:45 +1100985The file name may use the tilde
Damien Millerc6437cf2006-03-31 23:14:41 +1100986syntax to refer to a user's home directory or one of the following
Damien Miller6b1d53c2006-03-31 23:13:21 +1100987escape characters:
988.Ql %d
989(local user's home directory),
990.Ql %u
991(local user name),
992.Ql %l
993(local host name),
994.Ql %h
995(remote host name) or
Damien Millerdfc61832006-03-31 23:14:57 +1100996.Ql %r
Damien Miller6b1d53c2006-03-31 23:13:21 +1100997(remote user name).
998.Pp
Damien Miller957d4e42005-12-13 19:30:45 +1100999It is possible to have
1000multiple identity files specified in configuration files; all these
1001identities will be tried in sequence.
Damien Miller6029e072011-06-20 14:22:49 +10001002Multiple
1003.Cm IdentityFile
1004directives will add to the list of identities tried (this behaviour
1005differs from that of other configuration directives).
Damien Miller7f2b4382013-07-18 16:10:29 +10001006.Pp
1007.Cm IdentityFile
1008may be used in conjunction with
1009.Cm IdentitiesOnly
1010to select which identities in an agent are offered during authentication.
djm@openbsd.org4e44a792015-09-24 06:15:11 +00001011.Cm IdentityFile
1012may also be used in conjunction with
1013.Cm CertificateFile
1014in order to provide any certificate also needed for authentication with
1015the identity.
Darren Tucker63e0df22013-05-16 20:30:31 +10001016.It Cm IgnoreUnknown
1017Specifies a pattern-list of unknown options to be ignored if they are
1018encountered in configuration parsing.
1019This may be used to suppress errors if
1020.Nm
1021contains options that are unrecognised by
1022.Xr ssh 1 .
1023It is recommended that
1024.Cm IgnoreUnknown
1025be listed early in the configuration file as it will not be applied
1026to unknown options that appear before it.
Damien Miller0dac6fb2010-11-20 15:19:38 +11001027.It Cm IPQoS
1028Specifies the IPv4 type-of-service or DSCP class for connections.
1029Accepted values are
1030.Dq af11 ,
1031.Dq af12 ,
1032.Dq af13 ,
Damien Millerf6e758c2011-09-22 21:37:13 +10001033.Dq af21 ,
Damien Miller0dac6fb2010-11-20 15:19:38 +11001034.Dq af22 ,
1035.Dq af23 ,
1036.Dq af31 ,
1037.Dq af32 ,
1038.Dq af33 ,
1039.Dq af41 ,
1040.Dq af42 ,
1041.Dq af43 ,
1042.Dq cs0 ,
1043.Dq cs1 ,
1044.Dq cs2 ,
1045.Dq cs3 ,
1046.Dq cs4 ,
1047.Dq cs5 ,
1048.Dq cs6 ,
1049.Dq cs7 ,
1050.Dq ef ,
1051.Dq lowdelay ,
1052.Dq throughput ,
1053.Dq reliability ,
1054or a numeric value.
Damien Miller928362d2010-12-26 14:26:45 +11001055This option may take one or two arguments, separated by whitespace.
Damien Miller0dac6fb2010-11-20 15:19:38 +11001056If one argument is specified, it is used as the packet class unconditionally.
1057If two values are specified, the first is automatically selected for
1058interactive sessions and the second for non-interactive sessions.
1059The default is
1060.Dq lowdelay
1061for interactive sessions and
1062.Dq throughput
1063for non-interactive sessions.
Damien Millercfb606c2007-10-26 14:24:48 +10001064.It Cm KbdInteractiveAuthentication
1065Specifies whether to use keyboard-interactive authentication.
1066The argument to this keyword must be
1067.Dq yes
1068or
1069.Dq no .
1070The default is
1071.Dq yes .
Darren Tucker636ca902004-11-05 20:22:00 +11001072.It Cm KbdInteractiveDevices
1073Specifies the list of methods to use in keyboard-interactive authentication.
1074Multiple method names must be comma-separated.
1075The default is to use the server specified list.
Damien Miller9cfbaec2006-03-15 11:57:55 +11001076The methods available vary depending on what the server supports.
1077For an OpenSSH server,
1078it may be zero or more of:
1079.Dq bsdauth ,
1080.Dq pam ,
1081and
1082.Dq skey .
Damien Millerd5f62bf2010-09-24 22:11:14 +10001083.It Cm KexAlgorithms
1084Specifies the available KEX (Key Exchange) algorithms.
1085Multiple algorithms must be comma-separated.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001086Alternately if the specified value begins with a
1087.Sq +
1088character, then the specified methods will be appended to the default set
1089instead of replacing them.
Damien Miller7fe2b1f2010-09-24 22:11:53 +10001090The default is:
1091.Bd -literal -offset indent
Damien Miller0bd8f152013-11-04 08:55:43 +11001092curve25519-sha256@libssh.org,
Damien Miller7fe2b1f2010-09-24 22:11:53 +10001093ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
1094diffie-hellman-group-exchange-sha256,
Damien Millerc1621c82014-04-20 13:22:46 +10001095diffie-hellman-group-exchange-sha1,
djm@openbsd.orgbdfd29f2015-07-03 03:47:00 +00001096diffie-hellman-group14-sha1
Damien Miller7fe2b1f2010-09-24 22:11:53 +10001097.Ed
djm@openbsd.org8f6784f2014-12-22 09:05:17 +00001098.Pp
1099The list of available key exchange algorithms may also be obtained using the
1100.Fl Q
1101option of
1102.Xr ssh 1
1103with an argument of
1104.Dq kex .
Damien Millerd27b9472005-12-13 19:29:02 +11001105.It Cm LocalCommand
1106Specifies a command to execute on the local machine after successfully
1107connecting to the server.
1108The command string extends to the end of the line, and is executed with
Darren Tucker63b31cb2007-12-02 23:09:30 +11001109the user's shell.
Darren Tuckerf6b01b72008-06-13 04:56:37 +10001110The following escape character substitutions will be performed:
1111.Ql %d
1112(local user's home directory),
1113.Ql %h
1114(remote host name),
1115.Ql %l
1116(local host name),
1117.Ql %n
1118(host name as provided on the command line),
1119.Ql %p
1120(remote port),
1121.Ql %r
1122(remote user name) or
1123.Ql %u
Damien Miller9c386432014-07-03 21:27:46 +10001124(local user name) or
Damien Miller0f123412014-07-03 21:28:09 +10001125.Ql \&%C
Damien Miller9c386432014-07-03 21:27:46 +10001126by a hash of the concatenation: %l%h%p%r.
Darren Tucker78be8c52010-01-08 17:05:59 +11001127.Pp
1128The command is run synchronously and does not have access to the
1129session of the
1130.Xr ssh 1
1131that spawned it.
1132It should not be used for interactive commands.
1133.Pp
Damien Millerd27b9472005-12-13 19:29:02 +11001134This directive is ignored unless
1135.Cm PermitLocalCommand
1136has been enabled.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001137.It Cm LocalForward
Damien Millere9d001e2006-01-14 10:10:17 +11001138Specifies that a TCP port on the local machine be forwarded over
Ben Lindstrom9f049032002-06-21 00:59:05 +00001139the secure channel to the specified host and port from the remote machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001140The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +11001141.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001142.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +11001143.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001144and the second argument must be
1145.Ar host : Ns Ar hostport .
Damien Miller7fa96602010-08-05 13:03:13 +10001146IPv6 addresses can be specified by enclosing addresses in square brackets.
Damien Millerf8c55462005-03-02 12:03:05 +11001147Multiple forwardings may be specified, and additional forwardings can be
Damien Millerf91ee4c2005-03-01 21:24:33 +11001148given on the command line.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001149Only the superuser can forward privileged ports.
Damien Millerf91ee4c2005-03-01 21:24:33 +11001150By default, the local port is bound in accordance with the
1151.Cm GatewayPorts
1152setting.
1153However, an explicit
1154.Ar bind_address
1155may be used to bind the connection to a specific address.
1156The
1157.Ar bind_address
1158of
1159.Dq localhost
Damien Millerf8c55462005-03-02 12:03:05 +11001160indicates that the listening port be bound for local use only, while an
1161empty address or
1162.Sq *
Damien Millerf91ee4c2005-03-01 21:24:33 +11001163indicates that the port should be available from all interfaces.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001164.It Cm LogLevel
1165Gives the verbosity level that is used when logging messages from
Damien Miller45ee2b92006-03-15 11:56:18 +11001166.Xr ssh 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001167The possible values are:
Damien Miller45ee2b92006-03-15 11:56:18 +11001168QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
Damien Miller495dca32003-04-01 21:42:14 +10001169The default is INFO.
1170DEBUG and DEBUG1 are equivalent.
1171DEBUG2 and DEBUG3 each specify higher levels of verbose output.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001172.It Cm MACs
1173Specifies the MAC (message authentication code) algorithms
1174in order of preference.
1175The MAC algorithm is used in protocol version 2
1176for data integrity protection.
1177Multiple algorithms must be comma-separated.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001178If the specified value begins with a
1179.Sq +
1180character, then the specified algorithms will be appended to the default set
1181instead of replacing them.
1182.Pp
Damien Milleraf43a7a2012-12-12 10:46:31 +11001183The algorithms that contain
1184.Dq -etm
1185calculate the MAC after encryption (encrypt-then-mac).
1186These are considered safer and their use recommended.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001187.Pp
Damien Miller45ee2b92006-03-15 11:56:18 +11001188The default is:
Damien Miller5e7c30b2007-06-11 14:06:32 +10001189.Bd -literal -offset indent
Damien Milleraf43a7a2012-12-12 10:46:31 +11001190umac-64-etm@openssh.com,umac-128-etm@openssh.com,
1191hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
Damien Millerc1621c82014-04-20 13:22:46 +10001192umac-64@openssh.com,umac-128@openssh.com,
1193hmac-sha2-256,hmac-sha2-512,
1194hmac-md5-etm@openssh.com,hmac-sha1-etm@openssh.com,
1195hmac-ripemd160-etm@openssh.com,
1196hmac-sha1-96-etm@openssh.com,hmac-md5-96-etm@openssh.com,
1197hmac-md5,hmac-sha1,hmac-ripemd160,
Darren Tuckerecbf14a2012-07-02 18:53:37 +10001198hmac-sha1-96,hmac-md5-96
Damien Miller5e7c30b2007-06-11 14:06:32 +10001199.Ed
djm@openbsd.org8f6784f2014-12-22 09:05:17 +00001200.Pp
1201The list of available MAC algorithms may also be obtained using the
1202.Fl Q
1203option of
1204.Xr ssh 1
1205with an argument of
1206.Dq mac .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001207.It Cm NoHostAuthenticationForLocalhost
1208This option can be used if the home directory is shared across machines.
1209In this case localhost will refer to a different machine on each of
1210the machines and the user will get many warnings about changed host keys.
1211However, this option disables host authentication for localhost.
1212The argument to this keyword must be
1213.Dq yes
1214or
1215.Dq no .
1216The default is to check the host key for localhost.
1217.It Cm NumberOfPasswordPrompts
1218Specifies the number of password prompts before giving up.
1219The argument to this keyword must be an integer.
Damien Miller45ee2b92006-03-15 11:56:18 +11001220The default is 3.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001221.It Cm PasswordAuthentication
1222Specifies whether to use password authentication.
1223The argument to this keyword must be
1224.Dq yes
1225or
1226.Dq no .
1227The default is
1228.Dq yes .
Damien Millerd27b9472005-12-13 19:29:02 +11001229.It Cm PermitLocalCommand
1230Allow local command execution via the
1231.Ic LocalCommand
1232option or using the
Damien Miller4b2319f2005-12-13 19:30:27 +11001233.Ic !\& Ns Ar command
Damien Millerd27b9472005-12-13 19:29:02 +11001234escape sequence in
1235.Xr ssh 1 .
1236The argument must be
1237.Dq yes
1238or
1239.Dq no .
1240The default is
1241.Dq no .
Damien Miller7ea845e2010-02-12 09:21:02 +11001242.It Cm PKCS11Provider
1243Specifies which PKCS#11 provider to use.
Damien Miller8e1ea4e2010-11-20 15:20:10 +11001244The argument to this keyword is the PKCS#11 shared library
Damien Miller7ea845e2010-02-12 09:21:02 +11001245.Xr ssh 1
Damien Millera7618442010-02-12 09:26:02 +11001246should use to communicate with a PKCS#11 token providing the user's
Damien Miller7ea845e2010-02-12 09:21:02 +11001247private RSA key.
Damien Miller957d4e42005-12-13 19:30:45 +11001248.It Cm Port
1249Specifies the port number to connect on the remote host.
Damien Miller45ee2b92006-03-15 11:56:18 +11001250The default is 22.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001251.It Cm PreferredAuthentications
1252Specifies the order in which the client should try protocol 2
Damien Millerfbf486b2003-05-23 18:44:23 +10001253authentication methods.
Darren Tucker1adc2bd2005-03-14 23:14:20 +11001254This allows a client to prefer one method (e.g.\&
Ben Lindstrom9f049032002-06-21 00:59:05 +00001255.Cm keyboard-interactive )
Darren Tucker1adc2bd2005-03-14 23:14:20 +11001256over another method (e.g.\&
Damien Miller544378d2010-04-16 15:52:24 +10001257.Cm password ) .
1258The default is:
1259.Bd -literal -offset indent
1260gssapi-with-mic,hostbased,publickey,
1261keyboard-interactive,password
1262.Ed
Ben Lindstrom9f049032002-06-21 00:59:05 +00001263.It Cm Protocol
1264Specifies the protocol versions
Damien Miller45ee2b92006-03-15 11:56:18 +11001265.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001266should support in order of preference.
1267The possible values are
Damien Miller45ee2b92006-03-15 11:56:18 +11001268.Sq 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001269and
Damien Miller45ee2b92006-03-15 11:56:18 +11001270.Sq 2 .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001271Multiple versions must be comma-separated.
Darren Tuckerbad50762009-10-11 21:51:08 +11001272When this option is set to
Darren Tucker7a4a7652009-10-11 21:51:40 +11001273.Dq 2,1
Darren Tuckerbad50762009-10-11 21:51:08 +11001274.Nm ssh
1275will try version 2 and fall back to version 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001276if version 2 is not available.
Darren Tuckerbad50762009-10-11 21:51:08 +11001277The default is
Darren Tucker7a4a7652009-10-11 21:51:40 +11001278.Sq 2 .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001279.It Cm ProxyCommand
1280Specifies the command to use to connect to the server.
1281The command
Damien Miller079bac22014-07-09 13:06:25 +10001282string extends to the end of the line, and is executed
1283using the user's shell
1284.Ql exec
1285directive to avoid a lingering shell process.
1286.Pp
Damien Millerc4eddee2010-04-18 08:07:43 +10001287In the command string, any occurrence of
Ben Lindstrom9f049032002-06-21 00:59:05 +00001288.Ql %h
1289will be substituted by the host name to
Damien Millerb1b17042010-04-16 15:54:19 +10001290connect,
Ben Lindstrom9f049032002-06-21 00:59:05 +00001291.Ql %p
Damien Millerc4eddee2010-04-18 08:07:43 +10001292by the port, and
1293.Ql %r
Damien Millerb1b17042010-04-16 15:54:19 +10001294by the remote user name.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001295The command can be basically anything,
1296and should read from its standard input and write to its standard output.
1297It should eventually connect an
1298.Xr sshd 8
1299server running on some machine, or execute
1300.Ic sshd -i
1301somewhere.
1302Host key management will be done using the
1303HostName of the host being connected (defaulting to the name typed by
1304the user).
Damien Miller495dca32003-04-01 21:42:14 +10001305Setting the command to
1306.Dq none
Damien Miller9f1e33a2003-02-24 11:57:32 +11001307disables this option entirely.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001308Note that
1309.Cm CheckHostIP
1310is not available for connects with a proxy command.
1311.Pp
Damien Millerebcfedc2005-05-26 12:13:56 +10001312This directive is useful in conjunction with
1313.Xr nc 1
1314and its proxy support.
Damien Millerdfec2942005-05-26 12:14:32 +10001315For example, the following directive would connect via an HTTP proxy at
Damien Millerebcfedc2005-05-26 12:13:56 +10001316192.0.2.0:
1317.Bd -literal -offset 3n
1318ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
1319.Ed
Damien Miller1262b662013-08-21 02:44:24 +10001320.It Cm ProxyUseFdpass
Damien Millerf2f6c312013-08-21 02:44:58 +10001321Specifies that
Damien Miller1262b662013-08-21 02:44:24 +10001322.Cm ProxyCommand
1323will pass a connected file descriptor back to
Damien Millerf2f6c312013-08-21 02:44:58 +10001324.Xr ssh 1
Damien Miller1262b662013-08-21 02:44:24 +10001325instead of continuing to execute and pass data.
1326The default is
1327.Dq no .
markus@openbsd.org3a1638d2015-07-10 06:21:53 +00001328.It Cm PubkeyAcceptedKeyTypes
1329Specifies the key types that will be used for public key authentication
1330as a comma-separated pattern list.
djm@openbsd.orgf9eca242015-07-30 00:01:34 +00001331Alternately if the specified value begins with a
1332.Sq +
1333character, then the key types after it will be appended to the default
1334instead of replacing it.
markus@openbsd.org3a1638d2015-07-10 06:21:53 +00001335The default for this option is:
1336.Bd -literal -offset 3n
1337ecdsa-sha2-nistp256-cert-v01@openssh.com,
1338ecdsa-sha2-nistp384-cert-v01@openssh.com,
1339ecdsa-sha2-nistp521-cert-v01@openssh.com,
1340ssh-ed25519-cert-v01@openssh.com,
1341ssh-rsa-cert-v01@openssh.com,
1342ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
1343ssh-ed25519,ssh-rsa
1344.Ed
1345.Pp
1346The
1347.Fl Q
1348option of
1349.Xr ssh 1
1350may be used to list supported key types.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001351.It Cm PubkeyAuthentication
1352Specifies whether to try public key authentication.
1353The argument to this keyword must be
1354.Dq yes
1355or
1356.Dq no .
1357The default is
1358.Dq yes .
1359This option applies to protocol version 2 only.
Darren Tucker62388b22006-01-20 11:31:47 +11001360.It Cm RekeyLimit
1361Specifies the maximum amount of data that may be transmitted before the
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001362session key is renegotiated, optionally followed a maximum amount of
1363time that may pass before the session key is renegotiated.
1364The first argument is specified in bytes and may have a suffix of
Damien Millerddfddf12006-01-31 21:39:03 +11001365.Sq K ,
1366.Sq M ,
Darren Tucker62388b22006-01-20 11:31:47 +11001367or
Damien Millerddfddf12006-01-31 21:39:03 +11001368.Sq G
Darren Tucker62388b22006-01-20 11:31:47 +11001369to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
1370The default is between
Damien Miller45ee2b92006-03-15 11:56:18 +11001371.Sq 1G
Darren Tucker62388b22006-01-20 11:31:47 +11001372and
Damien Miller45ee2b92006-03-15 11:56:18 +11001373.Sq 4G ,
Darren Tucker62388b22006-01-20 11:31:47 +11001374depending on the cipher.
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001375The optional second value is specified in seconds and may use any of the
1376units documented in the
Damien Millerfecfd112013-07-18 16:11:50 +10001377TIME FORMATS section of
Darren Tuckerc53c2af2013-05-16 20:28:16 +10001378.Xr sshd_config 5 .
1379The default value for
1380.Cm RekeyLimit
1381is
1382.Dq default none ,
1383which means that rekeying is performed after the cipher's default amount
1384of data has been sent or received and no time based rekeying is done.
Damien Millerddfddf12006-01-31 21:39:03 +11001385This option applies to protocol version 2 only.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001386.It Cm RemoteForward
Damien Millere9d001e2006-01-14 10:10:17 +11001387Specifies that a TCP port on the remote machine be forwarded over
Ben Lindstrom9f049032002-06-21 00:59:05 +00001388the secure channel to the specified host and port from the local machine.
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001389The first argument must be
Damien Millerf91ee4c2005-03-01 21:24:33 +11001390.Sm off
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001391.Oo Ar bind_address : Oc Ar port
Damien Millerf91ee4c2005-03-01 21:24:33 +11001392.Sm on
Darren Tucker5ede2ad2005-03-31 21:31:10 +10001393and the second argument must be
1394.Ar host : Ns Ar hostport .
Damien Miller7fa96602010-08-05 13:03:13 +10001395IPv6 addresses can be specified by enclosing addresses in square brackets.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001396Multiple forwardings may be specified, and additional
1397forwardings can be given on the command line.
Damien Millerde7532e2008-11-03 19:24:45 +11001398Privileged ports can be forwarded only when
1399logging in as root on the remote machine.
Damien Millere379e102009-02-14 16:34:39 +11001400.Pp
Damien Miller85c6d8a2009-02-14 16:34:21 +11001401If the
1402.Ar port
1403argument is
1404.Ql 0 ,
1405the listen port will be dynamically allocated on the server and reported
1406to the client at run time.
Damien Millerf91ee4c2005-03-01 21:24:33 +11001407.Pp
1408If the
1409.Ar bind_address
1410is not specified, the default is to only bind to loopback addresses.
1411If the
1412.Ar bind_address
1413is
1414.Ql *
1415or an empty string, then the forwarding is requested to listen on all
1416interfaces.
1417Specifying a remote
1418.Ar bind_address
Damien Millerf8c55462005-03-02 12:03:05 +11001419will only succeed if the server's
1420.Cm GatewayPorts
Damien Millerf91ee4c2005-03-01 21:24:33 +11001421option is enabled (see
Damien Millerf8c55462005-03-02 12:03:05 +11001422.Xr sshd_config 5 ) .
Damien Miller21771e22011-05-15 08:45:50 +10001423.It Cm RequestTTY
1424Specifies whether to request a pseudo-tty for the session.
1425The argument may be one of:
1426.Dq no
1427(never request a TTY),
1428.Dq yes
1429(always request a TTY when standard input is a TTY),
1430.Dq force
1431(always request a TTY) or
1432.Dq auto
1433(request a TTY when opening a login session).
1434This option mirrors the
1435.Fl t
1436and
1437.Fl T
1438flags for
1439.Xr ssh 1 .
djm@openbsd.org5e39a492014-12-04 02:24:32 +00001440.It Cm RevokedHostKeys
1441Specifies revoked host public keys.
1442Keys listed in this file will be refused for host authentication.
1443Note that if this file does not exist or is not readable,
1444then host authentication will be refused for all hosts.
1445Keys may be specified as a text file, listing one public key per line, or as
1446an OpenSSH Key Revocation List (KRL) as generated by
1447.Xr ssh-keygen 1 .
1448For more information on KRLs, see the KEY REVOCATION LISTS section in
1449.Xr ssh-keygen 1 .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001450.It Cm RhostsRSAAuthentication
1451Specifies whether to try rhosts based authentication with RSA host
1452authentication.
1453The argument must be
1454.Dq yes
1455or
1456.Dq no .
1457The default is
1458.Dq no .
1459This option applies to protocol version 1 only and requires
Damien Miller45ee2b92006-03-15 11:56:18 +11001460.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001461to be setuid root.
1462.It Cm RSAAuthentication
1463Specifies whether to try RSA authentication.
1464The argument to this keyword must be
1465.Dq yes
1466or
1467.Dq no .
1468RSA authentication will only be
1469attempted if the identity file exists, or an authentication agent is
1470running.
1471The default is
1472.Dq yes .
1473Note that this option applies to protocol version 1 only.
Darren Tucker46bc0752004-05-02 22:11:30 +10001474.It Cm SendEnv
1475Specifies what variables from the local
1476.Xr environ 7
1477should be sent to the server.
Damien Miller45ee2b92006-03-15 11:56:18 +11001478Note that environment passing is only supported for protocol 2.
1479The server must also support it, and the server must be configured to
Darren Tucker1e0c9bf2004-05-02 22:12:48 +10001480accept these environment variables.
dtucker@openbsd.org85b96ef2015-04-28 10:17:58 +00001481Note that the
1482.Ev TERM
jmc@openbsd.orgc1d5bcf2015-04-28 13:47:38 +00001483environment variable is always sent whenever a
dtucker@openbsd.org85b96ef2015-04-28 10:17:58 +00001484pseudo-terminal is requested as it is required by the protocol.
Darren Tucker46bc0752004-05-02 22:11:30 +10001485Refer to
1486.Cm AcceptEnv
1487in
1488.Xr sshd_config 5
1489for how to configure the server.
Damien Miller6def5512006-03-15 11:54:05 +11001490Variables are specified by name, which may contain wildcard characters.
Darren Tucker1e0c9bf2004-05-02 22:12:48 +10001491Multiple environment variables may be separated by whitespace or spread
Darren Tucker46bc0752004-05-02 22:11:30 +10001492across multiple
1493.Cm SendEnv
1494directives.
1495The default is not to send any environment variables.
Damien Millerf54a4b92006-03-15 11:54:36 +11001496.Pp
1497See
1498.Sx PATTERNS
1499for more information on patterns.
Damien Miller509b0102003-12-17 16:33:10 +11001500.It Cm ServerAliveCountMax
Damien Millerb7977702006-01-03 18:47:31 +11001501Sets the number of server alive messages (see below) which may be
Damien Miller509b0102003-12-17 16:33:10 +11001502sent without
Damien Miller45ee2b92006-03-15 11:56:18 +11001503.Xr ssh 1
Damien Miller509b0102003-12-17 16:33:10 +11001504receiving any messages back from the server.
1505If this threshold is reached while server alive messages are being sent,
Damien Miller45ee2b92006-03-15 11:56:18 +11001506ssh will disconnect from the server, terminating the session.
Damien Miller509b0102003-12-17 16:33:10 +11001507It is important to note that the use of server alive messages is very
1508different from
1509.Cm TCPKeepAlive
1510(below).
1511The server alive messages are sent through the encrypted channel
1512and therefore will not be spoofable.
1513The TCP keepalive option enabled by
1514.Cm TCPKeepAlive
1515is spoofable.
1516The server alive mechanism is valuable when the client or
1517server depend on knowing when a connection has become inactive.
1518.Pp
1519The default value is 3.
1520If, for example,
1521.Cm ServerAliveInterval
Damien Miller45ee2b92006-03-15 11:56:18 +11001522(see below) is set to 15 and
Damien Miller509b0102003-12-17 16:33:10 +11001523.Cm ServerAliveCountMax
Damien Miller45ee2b92006-03-15 11:56:18 +11001524is left at the default, if the server becomes unresponsive,
1525ssh will disconnect after approximately 45 seconds.
Damien Millercc3e8ba2006-03-15 12:06:55 +11001526This option applies to protocol version 2 only.
Damien Miller957d4e42005-12-13 19:30:45 +11001527.It Cm ServerAliveInterval
1528Sets a timeout interval in seconds after which if no data has been received
1529from the server,
Damien Miller45ee2b92006-03-15 11:56:18 +11001530.Xr ssh 1
Damien Miller957d4e42005-12-13 19:30:45 +11001531will send a message through the encrypted
1532channel to request a response from the server.
1533The default
1534is 0, indicating that these messages will not be sent to the server.
1535This option applies to protocol version 2 only.
Damien Miller7acefbb2014-07-18 14:11:24 +10001536.It Cm StreamLocalBindMask
1537Sets the octal file creation mode mask
1538.Pq umask
1539used when creating a Unix-domain socket file for local or remote
1540port forwarding.
1541This option is only used for port forwarding to a Unix-domain socket file.
1542.Pp
1543The default value is 0177, which creates a Unix-domain socket file that is
1544readable and writable only by the owner.
1545Note that not all operating systems honor the file mode on Unix-domain
1546socket files.
1547.It Cm StreamLocalBindUnlink
1548Specifies whether to remove an existing Unix-domain socket file for local
1549or remote port forwarding before creating a new one.
1550If the socket file already exists and
1551.Cm StreamLocalBindUnlink
1552is not enabled,
1553.Nm ssh
1554will be unable to forward the port to the Unix-domain socket file.
1555This option is only used for port forwarding to a Unix-domain socket file.
1556.Pp
1557The argument must be
1558.Dq yes
1559or
1560.Dq no .
1561The default is
1562.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001563.It Cm StrictHostKeyChecking
1564If this flag is set to
1565.Dq yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001566.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001567will never automatically add host keys to the
Damien Miller167ea5d2005-05-26 12:04:02 +10001568.Pa ~/.ssh/known_hosts
Ben Lindstrom9f049032002-06-21 00:59:05 +00001569file, and refuses to connect to hosts whose host key has changed.
1570This provides maximum protection against trojan horse attacks,
Damien Miller45ee2b92006-03-15 11:56:18 +11001571though it can be annoying when the
Ben Lindstrom9f049032002-06-21 00:59:05 +00001572.Pa /etc/ssh/ssh_known_hosts
Damien Miller45ee2b92006-03-15 11:56:18 +11001573file is poorly maintained or when connections to new hosts are
Ben Lindstrom9f049032002-06-21 00:59:05 +00001574frequently made.
1575This option forces the user to manually
1576add all new hosts.
1577If this flag is set to
1578.Dq no ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001579ssh will automatically add new host keys to the
Ben Lindstrom9f049032002-06-21 00:59:05 +00001580user known hosts files.
1581If this flag is set to
1582.Dq ask ,
1583new host keys
1584will be added to the user known host files only after the user
1585has confirmed that is what they really want to do, and
Damien Miller45ee2b92006-03-15 11:56:18 +11001586ssh will refuse to connect to hosts whose host key has changed.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001587The host keys of
1588known hosts will be verified automatically in all cases.
1589The argument must be
1590.Dq yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001591.Dq no ,
Ben Lindstrom9f049032002-06-21 00:59:05 +00001592or
1593.Dq ask .
1594The default is
1595.Dq ask .
Damien Miller12c150e2003-12-17 16:31:10 +11001596.It Cm TCPKeepAlive
1597Specifies whether the system should send TCP keepalive messages to the
1598other side.
1599If they are sent, death of the connection or crash of one
1600of the machines will be properly noticed.
1601However, this means that
1602connections will die if the route is down temporarily, and some people
1603find it annoying.
1604.Pp
1605The default is
1606.Dq yes
1607(to send TCP keepalive messages), and the client will notice
1608if the network goes down or the remote host dies.
1609This is important in scripts, and many users want it too.
1610.Pp
1611To disable TCP keepalive messages, the value should be set to
1612.Dq no .
Damien Millerd27b9472005-12-13 19:29:02 +11001613.It Cm Tunnel
Damien Miller991dba42006-07-10 20:16:27 +10001614Request
Damien Millerd27b9472005-12-13 19:29:02 +11001615.Xr tun 4
Damien Miller7746c392005-12-13 19:33:37 +11001616device forwarding between the client and the server.
Damien Millerd27b9472005-12-13 19:29:02 +11001617The argument must be
Damien Miller7b58e802005-12-13 19:33:19 +11001618.Dq yes ,
Damien Miller991dba42006-07-10 20:16:27 +10001619.Dq point-to-point
1620(layer 3),
1621.Dq ethernet
1622(layer 2),
Damien Millerd27b9472005-12-13 19:29:02 +11001623or
1624.Dq no .
Damien Miller991dba42006-07-10 20:16:27 +10001625Specifying
1626.Dq yes
1627requests the default tunnel mode, which is
1628.Dq point-to-point .
Damien Millerd27b9472005-12-13 19:29:02 +11001629The default is
1630.Dq no .
1631.It Cm TunnelDevice
Damien Miller991dba42006-07-10 20:16:27 +10001632Specifies the
Damien Millerd27b9472005-12-13 19:29:02 +11001633.Xr tun 4
Damien Miller991dba42006-07-10 20:16:27 +10001634devices to open on the client
1635.Pq Ar local_tun
1636and the server
1637.Pq Ar remote_tun .
1638.Pp
1639The argument must be
1640.Sm off
1641.Ar local_tun Op : Ar remote_tun .
1642.Sm on
1643The devices may be specified by numerical ID or the keyword
1644.Dq any ,
1645which uses the next available tunnel device.
1646If
1647.Ar remote_tun
1648is not specified, it defaults to
1649.Dq any .
1650The default is
1651.Dq any:any .
djm@openbsd.org1d1092b2015-01-26 12:16:36 +00001652.It Cm UpdateHostKeys
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001653Specifies whether
1654.Xr ssh 1
1655should accept notifications of additional hostkeys from the server sent
1656after authentication has completed and add them to
1657.Cm UserKnownHostsFile .
1658The argument must be
djm@openbsd.org523463a2015-02-16 22:13:32 +00001659.Dq yes ,
djm@openbsd.org15ad7502015-02-02 07:41:40 +00001660.Dq no
djm@openbsd.org523463a2015-02-16 22:13:32 +00001661(the default) or
1662.Dq ask .
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001663Enabling this option allows learning alternate hostkeys for a server
djm@openbsd.org1d1092b2015-01-26 12:16:36 +00001664and supports graceful key rotation by allowing a server to send replacement
1665public keys before old ones are removed.
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001666Additional hostkeys are only accepted if the key used to authenticate the
sobrado@openbsd.orge3cbb062015-09-22 08:33:23 +00001667host was already trusted or explicitly accepted by the user.
djm@openbsd.org523463a2015-02-16 22:13:32 +00001668If
1669.Cm UpdateHostKeys
1670is set to
1671.Dq ask ,
1672then the user is asked to confirm the modifications to the known_hosts file.
djm@openbsd.org44732de2015-02-20 22:17:21 +00001673Confirmation is currently incompatible with
1674.Cm ControlPersist ,
1675and will be disabled if it is enabled.
djm@openbsd.org8d4f8722015-01-26 03:04:45 +00001676.Pp
1677Presently, only
1678.Xr sshd 8
1679from OpenSSH 6.8 and greater support the
1680.Dq hostkeys@openssh.com
1681protocol extension used to inform the client of all the server's hostkeys.
Damien Millere8cd7412005-12-24 14:55:47 +11001682.It Cm UsePrivilegedPort
1683Specifies whether to use a privileged port for outgoing connections.
1684The argument must be
1685.Dq yes
1686or
1687.Dq no .
1688The default is
1689.Dq no .
1690If set to
Damien Miller45ee2b92006-03-15 11:56:18 +11001691.Dq yes ,
1692.Xr ssh 1
Damien Millere8cd7412005-12-24 14:55:47 +11001693must be setuid root.
1694Note that this option must be set to
1695.Dq yes
1696for
1697.Cm RhostsRSAAuthentication
1698with older servers.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001699.It Cm User
1700Specifies the user to log in as.
1701This can be useful when a different user name is used on different machines.
1702This saves the trouble of
1703having to remember to give the user name on the command line.
1704.It Cm UserKnownHostsFile
Damien Miller295ee632011-05-29 21:42:31 +10001705Specifies one or more files to use for the user
1706host key database, separated by whitespace.
1707The default is
1708.Pa ~/.ssh/known_hosts ,
1709.Pa ~/.ssh/known_hosts2 .
Damien Miller37876e92003-05-15 10:19:46 +10001710.It Cm VerifyHostKeyDNS
1711Specifies whether to verify the remote key using DNS and SSHFP resource
1712records.
Damien Miller150b5572003-11-17 21:19:29 +11001713If this option is set to
1714.Dq yes ,
Damien Millerfe448472003-11-17 21:19:49 +11001715the client will implicitly trust keys that match a secure fingerprint
Damien Miller150b5572003-11-17 21:19:29 +11001716from DNS.
1717Insecure fingerprints will be handled as if this option was set to
1718.Dq ask .
1719If this option is set to
1720.Dq ask ,
1721information on fingerprint match will be displayed, but the user will still
1722need to confirm new host keys according to the
1723.Cm StrictHostKeyChecking
1724option.
1725The argument must be
1726.Dq yes ,
Damien Miller45ee2b92006-03-15 11:56:18 +11001727.Dq no ,
Damien Millerfe448472003-11-17 21:19:49 +11001728or
1729.Dq ask .
Damien Miller37876e92003-05-15 10:19:46 +10001730The default is
1731.Dq no .
Damien Millereacbb4f2003-06-02 19:10:41 +10001732Note that this option applies to protocol version 2 only.
Damien Miller45ee2b92006-03-15 11:56:18 +11001733.Pp
Damien Millerfecfd112013-07-18 16:11:50 +10001734See also VERIFYING HOST KEYS in
Damien Miller45ee2b92006-03-15 11:56:18 +11001735.Xr ssh 1 .
Damien Miller10288242008-06-30 00:04:03 +10001736.It Cm VisualHostKey
1737If this flag is set to
1738.Dq yes ,
1739an ASCII art representation of the remote host key fingerprint is
djm@openbsd.orgb79efde2014-12-21 23:12:42 +00001740printed in addition to the fingerprint string at login and
Damien Millera414cd32008-11-03 19:25:21 +11001741for unknown host keys.
Damien Miller10288242008-06-30 00:04:03 +10001742If this flag is set to
1743.Dq no ,
Damien Millera414cd32008-11-03 19:25:21 +11001744no fingerprint strings are printed at login and
djm@openbsd.orgb79efde2014-12-21 23:12:42 +00001745only the fingerprint string will be printed for unknown host keys.
Damien Miller10288242008-06-30 00:04:03 +10001746The default is
1747.Dq no .
Ben Lindstrom9f049032002-06-21 00:59:05 +00001748.It Cm XAuthLocation
Damien Miller05913ba2002-09-04 16:51:03 +10001749Specifies the full pathname of the
Ben Lindstrom9f049032002-06-21 00:59:05 +00001750.Xr xauth 1
1751program.
1752The default is
1753.Pa /usr/X11R6/bin/xauth .
1754.El
Damien Millerb5282c22006-03-15 11:59:08 +11001755.Sh PATTERNS
1756A
1757.Em pattern
1758consists of zero or more non-whitespace characters,
1759.Sq *
1760(a wildcard that matches zero or more characters),
1761or
1762.Sq ?\&
1763(a wildcard that matches exactly one character).
1764For example, to specify a set of declarations for any host in the
1765.Dq .co.uk
1766set of domains,
1767the following pattern could be used:
1768.Pp
1769.Dl Host *.co.uk
1770.Pp
1771The following pattern
1772would match any host in the 192.168.0.[0-9] network range:
1773.Pp
1774.Dl Host 192.168.0.?
1775.Pp
1776A
1777.Em pattern-list
1778is a comma-separated list of patterns.
1779Patterns within pattern-lists may be negated
1780by preceding them with an exclamation mark
1781.Pq Sq !\& .
1782For example,
Damien Miller51682fa2013-10-17 11:48:31 +11001783to allow a key to be used from anywhere within an organization
Damien Millerb5282c22006-03-15 11:59:08 +11001784except from the
1785.Dq dialup
1786pool,
1787the following entry (in authorized_keys) could be used:
1788.Pp
1789.Dl from=\&"!*.dialup.example.com,*.example.com\&"
Ben Lindstrom9f049032002-06-21 00:59:05 +00001790.Sh FILES
1791.Bl -tag -width Ds
Damien Miller167ea5d2005-05-26 12:04:02 +10001792.It Pa ~/.ssh/config
Ben Lindstrom9f049032002-06-21 00:59:05 +00001793This is the per-user configuration file.
1794The format of this file is described above.
Damien Miller45ee2b92006-03-15 11:56:18 +11001795This file is used by the SSH client.
Damien Millerc970cb92004-04-20 20:12:53 +10001796Because of the potential for abuse, this file must have strict permissions:
1797read/write for the user, and not accessible by others.
Ben Lindstrom9f049032002-06-21 00:59:05 +00001798.It Pa /etc/ssh/ssh_config
1799Systemwide configuration file.
1800This file provides defaults for those
1801values that are not specified in the user's configuration file, and
1802for those users who do not have a configuration file.
1803This file must be world-readable.
1804.El
Damien Millerf1ce5052003-06-11 22:04:39 +10001805.Sh SEE ALSO
1806.Xr ssh 1
Ben Lindstrom9f049032002-06-21 00:59:05 +00001807.Sh AUTHORS
1808OpenSSH is a derivative of the original and free
1809ssh 1.2.12 release by Tatu Ylonen.
1810Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1811Theo de Raadt and Dug Song
1812removed many bugs, re-added newer features and
1813created OpenSSH.
1814Markus Friedl contributed the support for SSH
1815protocol versions 1.5 and 2.0.