2002-06-23 14:01:54 +00:00
|
|
|
.\"
|
|
|
|
.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
|
|
|
|
.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
|
|
|
|
.\" All rights reserved
|
|
|
|
.\"
|
|
|
|
.\" As far as I am concerned, the code I have written for this software
|
|
|
|
.\" can be used freely for any purpose. Any derived versions of this
|
|
|
|
.\" software must be clearly marked as such, and if the derived work is
|
|
|
|
.\" incompatible with the protocol description in the RFC file, it must be
|
|
|
|
.\" called by a name other than "ssh" or "Secure Shell".
|
|
|
|
.\"
|
|
|
|
.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
|
|
|
|
.\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
|
|
|
|
.\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
|
|
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
|
|
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
|
|
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
|
|
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
|
|
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
|
|
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
.\"
|
2015-01-05 16:09:55 +00:00
|
|
|
.\" $OpenBSD: ssh_config.5,v 1.191 2014/07/15 15:54:14 millert Exp $
|
|
|
|
.Dd $Mdocdate: July 15 2014 $
|
2002-06-23 14:01:54 +00:00
|
|
|
.Dt SSH_CONFIG 5
|
|
|
|
.Os
|
|
|
|
.Sh NAME
|
|
|
|
.Nm ssh_config
|
|
|
|
.Nd OpenSSH SSH client configuration files
|
|
|
|
.Sh SYNOPSIS
|
2008-07-23 09:15:38 +00:00
|
|
|
.Nm ~/.ssh/config
|
|
|
|
.Nm /etc/ssh/ssh_config
|
2002-06-23 14:01:54 +00:00
|
|
|
.Sh DESCRIPTION
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2002-06-23 14:01:54 +00:00
|
|
|
obtains configuration data from the following sources in
|
|
|
|
the following order:
|
2006-09-30 13:29:51 +00:00
|
|
|
.Pp
|
2002-10-29 09:43:00 +00:00
|
|
|
.Bl -enum -offset indent -compact
|
|
|
|
.It
|
|
|
|
command-line options
|
|
|
|
.It
|
|
|
|
user's configuration file
|
2005-09-03 06:59:33 +00:00
|
|
|
.Pq Pa ~/.ssh/config
|
2002-10-29 09:43:00 +00:00
|
|
|
.It
|
|
|
|
system-wide configuration file
|
|
|
|
.Pq Pa /etc/ssh/ssh_config
|
|
|
|
.El
|
2002-06-23 14:01:54 +00:00
|
|
|
.Pp
|
|
|
|
For each parameter, the first obtained value
|
|
|
|
will be used.
|
2005-06-05 15:40:50 +00:00
|
|
|
The configuration files contain sections separated by
|
2002-06-23 14:01:54 +00:00
|
|
|
.Dq Host
|
|
|
|
specifications, and that section is only applied for hosts that
|
|
|
|
match one of the patterns given in the specification.
|
|
|
|
The matched host name is the one given on the command line.
|
|
|
|
.Pp
|
|
|
|
Since the first obtained value for each parameter is used, more
|
|
|
|
host-specific declarations should be given near the beginning of the
|
|
|
|
file, and general defaults at the end.
|
|
|
|
.Pp
|
|
|
|
The configuration file has the following format:
|
|
|
|
.Pp
|
|
|
|
Empty lines and lines starting with
|
|
|
|
.Ql #
|
|
|
|
are comments.
|
|
|
|
Otherwise a line is of the format
|
|
|
|
.Dq keyword arguments .
|
|
|
|
Configuration options may be separated by whitespace or
|
|
|
|
optional whitespace and exactly one
|
|
|
|
.Ql = ;
|
|
|
|
the latter format is useful to avoid the need to quote whitespace
|
|
|
|
when specifying configuration options using the
|
|
|
|
.Nm ssh ,
|
2006-09-30 13:29:51 +00:00
|
|
|
.Nm scp ,
|
2002-06-23 14:01:54 +00:00
|
|
|
and
|
|
|
|
.Nm sftp
|
|
|
|
.Fl o
|
|
|
|
option.
|
2006-09-30 13:29:51 +00:00
|
|
|
Arguments may optionally be enclosed in double quotes
|
|
|
|
.Pq \&"
|
|
|
|
in order to represent arguments containing spaces.
|
2002-06-23 14:01:54 +00:00
|
|
|
.Pp
|
|
|
|
The possible
|
|
|
|
keywords and their meanings are as follows (note that
|
|
|
|
keywords are case-insensitive and arguments are case-sensitive):
|
|
|
|
.Bl -tag -width Ds
|
|
|
|
.It Cm Host
|
|
|
|
Restricts the following declarations (up to the next
|
|
|
|
.Cm Host
|
2014-01-30 10:56:49 +00:00
|
|
|
or
|
|
|
|
.Cm Match
|
2002-06-23 14:01:54 +00:00
|
|
|
keyword) to be only for those hosts that match one of the patterns
|
|
|
|
given after the keyword.
|
2009-02-24 18:49:27 +00:00
|
|
|
If more than one pattern is provided, they should be separated by whitespace.
|
2002-06-23 14:01:54 +00:00
|
|
|
A single
|
2006-09-30 13:29:51 +00:00
|
|
|
.Ql *
|
2002-06-23 14:01:54 +00:00
|
|
|
as a pattern can be used to provide global
|
|
|
|
defaults for all hosts.
|
|
|
|
The host is the
|
|
|
|
.Ar hostname
|
2006-09-30 13:29:51 +00:00
|
|
|
argument given on the command line (i.e. the name is not converted to
|
2002-06-23 14:01:54 +00:00
|
|
|
a canonicalized host name before matching).
|
2006-09-30 13:29:51 +00:00
|
|
|
.Pp
|
2011-09-28 08:14:41 +00:00
|
|
|
A pattern entry may be negated by prefixing it with an exclamation mark
|
|
|
|
.Pq Sq !\& .
|
|
|
|
If a negated entry is matched, then the
|
|
|
|
.Cm Host
|
|
|
|
entry is ignored, regardless of whether any other patterns on the line
|
|
|
|
match.
|
|
|
|
Negated matches are therefore useful to provide exceptions for wildcard
|
|
|
|
matches.
|
|
|
|
.Pp
|
2006-09-30 13:29:51 +00:00
|
|
|
See
|
|
|
|
.Sx PATTERNS
|
|
|
|
for more information on patterns.
|
2014-01-30 10:56:49 +00:00
|
|
|
.It Cm Match
|
|
|
|
Restricts the following declarations (up to the next
|
|
|
|
.Cm Host
|
|
|
|
or
|
|
|
|
.Cm Match
|
|
|
|
keyword) to be used only when the conditions following the
|
|
|
|
.Cm Match
|
|
|
|
keyword are satisfied.
|
|
|
|
Match conditions are specified using one or more keyword/criteria pairs
|
|
|
|
or the single token
|
|
|
|
.Cm all
|
|
|
|
which matches all criteria.
|
|
|
|
The available keywords are:
|
|
|
|
.Cm exec ,
|
|
|
|
.Cm host ,
|
|
|
|
.Cm originalhost ,
|
|
|
|
.Cm user ,
|
|
|
|
and
|
|
|
|
.Cm localuser .
|
|
|
|
.Pp
|
|
|
|
The
|
|
|
|
.Cm exec
|
|
|
|
keyword executes the specified command under the user's shell.
|
|
|
|
If the command returns a zero exit status then the condition is considered true.
|
|
|
|
Commands containing whitespace characters must be quoted.
|
|
|
|
The following character sequences in the command will be expanded prior to
|
|
|
|
execution:
|
|
|
|
.Ql %L
|
|
|
|
will be substituted by the first component of the local host name,
|
|
|
|
.Ql %l
|
|
|
|
will be substituted by the local host name (including any domain name),
|
|
|
|
.Ql %h
|
|
|
|
will be substituted by the target host name,
|
|
|
|
.Ql %n
|
|
|
|
will be substituted by the original target host name
|
|
|
|
specified on the command-line,
|
|
|
|
.Ql %p
|
|
|
|
the destination port,
|
|
|
|
.Ql %r
|
|
|
|
by the remote login username, and
|
|
|
|
.Ql %u
|
|
|
|
by the username of the user running
|
|
|
|
.Xr ssh 1 .
|
|
|
|
.Pp
|
|
|
|
The other keywords' criteria must be single entries or comma-separated
|
|
|
|
lists and may use the wildcard and negation operators described in the
|
|
|
|
.Sx PATTERNS
|
|
|
|
section.
|
|
|
|
The criteria for the
|
|
|
|
.Cm host
|
|
|
|
keyword are matched against the target hostname, after any substitution
|
|
|
|
by the
|
|
|
|
.Cm Hostname
|
|
|
|
option.
|
|
|
|
The
|
|
|
|
.Cm originalhost
|
|
|
|
keyword matches against the hostname as it was specified on the command-line.
|
|
|
|
The
|
|
|
|
.Cm user
|
|
|
|
keyword matches against the target username on the remote host.
|
|
|
|
The
|
|
|
|
.Cm localuser
|
|
|
|
keyword matches against the name of the local user running
|
|
|
|
.Xr ssh 1
|
|
|
|
(this keyword may be useful in system-wide
|
|
|
|
.Nm
|
|
|
|
files).
|
2004-01-07 11:10:17 +00:00
|
|
|
.It Cm AddressFamily
|
|
|
|
Specifies which address family to use when connecting.
|
|
|
|
Valid arguments are
|
|
|
|
.Dq any ,
|
|
|
|
.Dq inet
|
2006-09-30 13:29:51 +00:00
|
|
|
(use IPv4 only), or
|
2004-01-07 11:10:17 +00:00
|
|
|
.Dq inet6
|
2005-06-05 15:40:50 +00:00
|
|
|
(use IPv6 only).
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm BatchMode
|
|
|
|
If set to
|
|
|
|
.Dq yes ,
|
|
|
|
passphrase/password querying will be disabled.
|
|
|
|
This option is useful in scripts and other batch jobs where no user
|
|
|
|
is present to supply the password.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
.It Cm BindAddress
|
2005-09-03 06:59:33 +00:00
|
|
|
Use the specified address on the local machine as the source address of
|
|
|
|
the connection.
|
|
|
|
Only useful on systems with more than one address.
|
2002-06-23 14:01:54 +00:00
|
|
|
Note that this option does not work if
|
|
|
|
.Cm UsePrivilegedPort
|
|
|
|
is set to
|
|
|
|
.Dq yes .
|
2014-01-30 10:56:49 +00:00
|
|
|
.It Cm CanonicalDomains
|
|
|
|
When
|
|
|
|
.Cm CanonicalizeHostname
|
|
|
|
is enabled, this option specifies the list of domain suffixes in which to
|
|
|
|
search for the specified destination host.
|
|
|
|
.It Cm CanonicalizeFallbackLocal
|
|
|
|
Specifies whether to fail with an error when hostname canonicalization fails.
|
|
|
|
The default,
|
|
|
|
.Dq yes ,
|
|
|
|
will attempt to look up the unqualified hostname using the system resolver's
|
|
|
|
search rules.
|
|
|
|
A value of
|
|
|
|
.Dq no
|
|
|
|
will cause
|
|
|
|
.Xr ssh 1
|
|
|
|
to fail instantly if
|
|
|
|
.Cm CanonicalizeHostname
|
|
|
|
is enabled and the target hostname cannot be found in any of the domains
|
|
|
|
specified by
|
|
|
|
.Cm CanonicalDomains .
|
|
|
|
.It Cm CanonicalizeHostname
|
|
|
|
Controls whether explicit hostname canonicalization is performed.
|
|
|
|
The default,
|
|
|
|
.Dq no ,
|
|
|
|
is not to perform any name rewriting and let the system resolver handle all
|
|
|
|
hostname lookups.
|
|
|
|
If set to
|
|
|
|
.Dq yes
|
|
|
|
then, for connections that do not use a
|
|
|
|
.Cm ProxyCommand ,
|
|
|
|
.Xr ssh 1
|
|
|
|
will attempt to canonicalize the hostname specified on the command line
|
|
|
|
using the
|
|
|
|
.Cm CanonicalDomains
|
|
|
|
suffixes and
|
|
|
|
.Cm CanonicalizePermittedCNAMEs
|
|
|
|
rules.
|
|
|
|
If
|
|
|
|
.Cm CanonicalizeHostname
|
|
|
|
is set to
|
|
|
|
.Dq always ,
|
|
|
|
then canonicalization is applied to proxied connections too.
|
2014-03-22 15:23:38 +00:00
|
|
|
.Pp
|
|
|
|
If this option is enabled and canonicalisation results in the target hostname
|
|
|
|
changing, then the configuration files are processed again using the new
|
|
|
|
target name to pick up any new configuration in matching
|
|
|
|
.Cm Host
|
|
|
|
stanzas.
|
2014-01-30 10:56:49 +00:00
|
|
|
.It Cm CanonicalizeMaxDots
|
|
|
|
Specifies the maximum number of dot characters in a hostname before
|
|
|
|
canonicalization is disabled.
|
|
|
|
The default,
|
|
|
|
.Dq 1 ,
|
|
|
|
allows a single dot (i.e. hostname.subdomain).
|
|
|
|
.It Cm CanonicalizePermittedCNAMEs
|
|
|
|
Specifies rules to determine whether CNAMEs should be followed when
|
|
|
|
canonicalizing hostnames.
|
|
|
|
The rules consist of one or more arguments of
|
|
|
|
.Ar source_domain_list : Ns Ar target_domain_list ,
|
|
|
|
where
|
|
|
|
.Ar source_domain_list
|
|
|
|
is a pattern-list of domains that may follow CNAMEs in canonicalization,
|
|
|
|
and
|
|
|
|
.Ar target_domain_list
|
|
|
|
is a pattern-list of domains that they may resolve to.
|
|
|
|
.Pp
|
|
|
|
For example,
|
|
|
|
.Dq *.a.example.com:*.b.example.com,*.c.example.com
|
|
|
|
will allow hostnames matching
|
|
|
|
.Dq *.a.example.com
|
|
|
|
to be canonicalized to names in the
|
|
|
|
.Dq *.b.example.com
|
|
|
|
or
|
|
|
|
.Dq *.c.example.com
|
|
|
|
domains.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm ChallengeResponseAuthentication
|
2006-09-30 13:29:51 +00:00
|
|
|
Specifies whether to use challenge-response authentication.
|
2002-06-23 14:01:54 +00:00
|
|
|
The argument to this keyword must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq yes .
|
|
|
|
.It Cm CheckHostIP
|
|
|
|
If this flag is set to
|
|
|
|
.Dq yes ,
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
|
|
|
will additionally check the host IP address in the
|
2002-06-23 14:01:54 +00:00
|
|
|
.Pa known_hosts
|
|
|
|
file.
|
|
|
|
This allows ssh to detect if a host key changed due to DNS spoofing.
|
|
|
|
If the option is set to
|
|
|
|
.Dq no ,
|
|
|
|
the check will not be executed.
|
|
|
|
The default is
|
|
|
|
.Dq yes .
|
|
|
|
.It Cm Cipher
|
|
|
|
Specifies the cipher to use for encrypting the session
|
|
|
|
in protocol version 1.
|
|
|
|
Currently,
|
|
|
|
.Dq blowfish ,
|
|
|
|
.Dq 3des ,
|
|
|
|
and
|
|
|
|
.Dq des
|
|
|
|
are supported.
|
|
|
|
.Ar des
|
|
|
|
is only supported in the
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2002-06-23 14:01:54 +00:00
|
|
|
client for interoperability with legacy protocol 1 implementations
|
|
|
|
that do not support the
|
|
|
|
.Ar 3des
|
2003-04-23 16:53:02 +00:00
|
|
|
cipher.
|
|
|
|
Its use is strongly discouraged due to cryptographic weaknesses.
|
2002-06-23 14:01:54 +00:00
|
|
|
The default is
|
|
|
|
.Dq 3des .
|
|
|
|
.It Cm Ciphers
|
|
|
|
Specifies the ciphers allowed for protocol version 2
|
|
|
|
in order of preference.
|
|
|
|
Multiple ciphers must be comma-separated.
|
2014-01-30 10:56:49 +00:00
|
|
|
The supported ciphers are:
|
|
|
|
.Pp
|
2015-01-05 16:09:55 +00:00
|
|
|
.Bl -item -compact -offset indent
|
|
|
|
.It
|
|
|
|
3des-cbc
|
|
|
|
.It
|
|
|
|
aes128-cbc
|
|
|
|
.It
|
|
|
|
aes192-cbc
|
|
|
|
.It
|
|
|
|
aes256-cbc
|
|
|
|
.It
|
|
|
|
aes128-ctr
|
|
|
|
.It
|
|
|
|
aes192-ctr
|
|
|
|
.It
|
|
|
|
aes256-ctr
|
|
|
|
.It
|
|
|
|
aes128-gcm@openssh.com
|
|
|
|
.It
|
|
|
|
aes256-gcm@openssh.com
|
|
|
|
.It
|
|
|
|
arcfour
|
|
|
|
.It
|
|
|
|
arcfour128
|
|
|
|
.It
|
|
|
|
arcfour256
|
|
|
|
.It
|
|
|
|
blowfish-cbc
|
|
|
|
.It
|
|
|
|
cast128-cbc
|
|
|
|
.It
|
|
|
|
chacha20-poly1305@openssh.com
|
|
|
|
.El
|
2014-01-30 10:56:49 +00:00
|
|
|
.Pp
|
2006-09-30 13:29:51 +00:00
|
|
|
The default is:
|
2015-01-05 16:09:55 +00:00
|
|
|
.Bd -literal -offset indent
|
|
|
|
aes128-ctr,aes192-ctr,aes256-ctr,
|
2013-03-22 11:19:48 +00:00
|
|
|
aes128-gcm@openssh.com,aes256-gcm@openssh.com,
|
2014-01-30 10:56:49 +00:00
|
|
|
chacha20-poly1305@openssh.com,
|
2015-01-05 16:09:55 +00:00
|
|
|
arcfour256,arcfour128,
|
|
|
|
aes128-cbc,3des-cbc,blowfish-cbc,cast128-cbc,
|
|
|
|
aes192-cbc,aes256-cbc,arcfour
|
2002-06-23 14:01:54 +00:00
|
|
|
.Ed
|
2014-01-30 10:56:49 +00:00
|
|
|
.Pp
|
|
|
|
The list of available ciphers may also be obtained using the
|
|
|
|
.Fl Q
|
|
|
|
option of
|
|
|
|
.Xr ssh 1 .
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm ClearAllForwardings
|
2006-09-30 13:29:51 +00:00
|
|
|
Specifies that all local, remote, and dynamic port forwardings
|
2002-06-23 14:01:54 +00:00
|
|
|
specified in the configuration files or on the command line be
|
2003-04-23 16:53:02 +00:00
|
|
|
cleared.
|
|
|
|
This option is primarily useful when used from the
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2002-06-23 14:01:54 +00:00
|
|
|
command line to clear port forwardings set in
|
|
|
|
configuration files, and is automatically set by
|
|
|
|
.Xr scp 1
|
|
|
|
and
|
|
|
|
.Xr sftp 1 .
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
.It Cm Compression
|
|
|
|
Specifies whether to use compression.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
.It Cm CompressionLevel
|
|
|
|
Specifies the compression level to use if compression is enabled.
|
|
|
|
The argument must be an integer from 1 (fast) to 9 (slow, best).
|
|
|
|
The default level is 6, which is good for most applications.
|
|
|
|
The meaning of the values is the same as in
|
|
|
|
.Xr gzip 1 .
|
|
|
|
Note that this option applies to protocol version 1 only.
|
|
|
|
.It Cm ConnectionAttempts
|
|
|
|
Specifies the number of tries (one per second) to make before exiting.
|
|
|
|
The argument must be an integer.
|
|
|
|
This may be useful in scripts if the connection sometimes fails.
|
|
|
|
The default is 1.
|
2004-01-07 11:10:17 +00:00
|
|
|
.It Cm ConnectTimeout
|
2006-09-30 13:29:51 +00:00
|
|
|
Specifies the timeout (in seconds) used when connecting to the
|
|
|
|
SSH server, instead of using the default system TCP timeout.
|
2004-01-07 11:10:17 +00:00
|
|
|
This value is used only when the target is down or really unreachable,
|
|
|
|
not when it refuses the connection.
|
2004-10-28 16:03:53 +00:00
|
|
|
.It Cm ControlMaster
|
|
|
|
Enables the sharing of multiple sessions over a single network connection.
|
|
|
|
When set to
|
2006-09-30 13:29:51 +00:00
|
|
|
.Dq yes ,
|
|
|
|
.Xr ssh 1
|
2004-10-28 16:03:53 +00:00
|
|
|
will listen for connections on a control socket specified using the
|
|
|
|
.Cm ControlPath
|
|
|
|
argument.
|
|
|
|
Additional sessions can connect to this socket using the same
|
|
|
|
.Cm ControlPath
|
|
|
|
with
|
|
|
|
.Cm ControlMaster
|
|
|
|
set to
|
|
|
|
.Dq no
|
|
|
|
(the default).
|
2006-03-22 19:46:12 +00:00
|
|
|
These sessions will try to reuse the master instance's network connection
|
|
|
|
rather than initiating new ones, but will fall back to connecting normally
|
|
|
|
if the control socket does not exist, or is not listening.
|
|
|
|
.Pp
|
2004-10-28 16:03:53 +00:00
|
|
|
Setting this to
|
|
|
|
.Dq ask
|
2006-09-30 13:29:51 +00:00
|
|
|
will cause ssh
|
2004-10-28 16:03:53 +00:00
|
|
|
to listen for control connections, but require confirmation using the
|
|
|
|
.Ev SSH_ASKPASS
|
|
|
|
program before they are accepted (see
|
|
|
|
.Xr ssh-add 1
|
|
|
|
for details).
|
2005-09-03 06:59:33 +00:00
|
|
|
If the
|
|
|
|
.Cm ControlPath
|
2006-09-30 13:29:51 +00:00
|
|
|
cannot be opened,
|
|
|
|
ssh will continue without connecting to a master instance.
|
2005-09-03 06:59:33 +00:00
|
|
|
.Pp
|
|
|
|
X11 and
|
|
|
|
.Xr ssh-agent 1
|
|
|
|
forwarding is supported over these multiplexed connections, however the
|
2006-03-22 19:46:12 +00:00
|
|
|
display and agent forwarded will be the one belonging to the master
|
2005-09-03 06:59:33 +00:00
|
|
|
connection i.e. it is not possible to forward multiple displays or agents.
|
|
|
|
.Pp
|
|
|
|
Two additional options allow for opportunistic multiplexing: try to use a
|
|
|
|
master connection but fall back to creating a new one if one does not already
|
|
|
|
exist.
|
|
|
|
These options are:
|
|
|
|
.Dq auto
|
|
|
|
and
|
|
|
|
.Dq autoask .
|
|
|
|
The latter requires confirmation like the
|
|
|
|
.Dq ask
|
|
|
|
option.
|
2004-10-28 16:03:53 +00:00
|
|
|
.It Cm ControlPath
|
2005-09-03 06:59:33 +00:00
|
|
|
Specify the path to the control socket used for connection sharing as described
|
|
|
|
in the
|
2004-10-28 16:03:53 +00:00
|
|
|
.Cm ControlMaster
|
2005-09-03 06:59:33 +00:00
|
|
|
section above or the string
|
|
|
|
.Dq none
|
|
|
|
to disable connection sharing.
|
|
|
|
In the path,
|
2011-09-28 08:14:41 +00:00
|
|
|
.Ql %L
|
|
|
|
will be substituted by the first component of the local host name,
|
2006-09-30 13:29:51 +00:00
|
|
|
.Ql %l
|
2011-09-28 08:14:41 +00:00
|
|
|
will be substituted by the local host name (including any domain name),
|
2005-09-03 06:59:33 +00:00
|
|
|
.Ql %h
|
|
|
|
will be substituted by the target host name,
|
2011-09-28 08:14:41 +00:00
|
|
|
.Ql %n
|
|
|
|
will be substituted by the original target host name
|
|
|
|
specified on the command line,
|
2005-09-03 06:59:33 +00:00
|
|
|
.Ql %p
|
2014-01-30 10:56:49 +00:00
|
|
|
the destination port,
|
2005-09-03 06:59:33 +00:00
|
|
|
.Ql %r
|
2015-01-05 16:09:55 +00:00
|
|
|
by the remote login username,
|
2011-09-28 08:14:41 +00:00
|
|
|
.Ql %u
|
|
|
|
by the username of the user running
|
2015-01-05 16:09:55 +00:00
|
|
|
.Xr ssh 1 , and
|
|
|
|
.Ql \&%C
|
|
|
|
by a hash of the concatenation: %l%h%p%r.
|
2005-09-03 06:59:33 +00:00
|
|
|
It is recommended that any
|
|
|
|
.Cm ControlPath
|
|
|
|
used for opportunistic connection sharing include
|
2015-01-05 16:09:55 +00:00
|
|
|
at least %h, %p, and %r (or alternatively %C).
|
2005-09-03 06:59:33 +00:00
|
|
|
This ensures that shared connections are uniquely identified.
|
2010-11-08 10:45:44 +00:00
|
|
|
.It Cm ControlPersist
|
|
|
|
When used in conjunction with
|
|
|
|
.Cm ControlMaster ,
|
|
|
|
specifies that the master connection should remain open
|
|
|
|
in the background (waiting for future client connections)
|
|
|
|
after the initial client connection has been closed.
|
|
|
|
If set to
|
|
|
|
.Dq no ,
|
|
|
|
then the master connection will not be placed into the background,
|
|
|
|
and will close as soon as the initial client connection is closed.
|
|
|
|
If set to
|
|
|
|
.Dq yes ,
|
|
|
|
then the master connection will remain in the background indefinitely
|
|
|
|
(until killed or closed via a mechanism such as the
|
|
|
|
.Xr ssh 1
|
|
|
|
.Dq Fl O No exit
|
|
|
|
option).
|
|
|
|
If set to a time in seconds, or a time in any of the formats documented in
|
|
|
|
.Xr sshd_config 5 ,
|
|
|
|
then the backgrounded master connection will automatically terminate
|
|
|
|
after it has remained idle (with no client connections) for the
|
|
|
|
specified time.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm DynamicForward
|
2006-03-22 19:46:12 +00:00
|
|
|
Specifies that a TCP port on the local machine be forwarded
|
2002-06-23 14:01:54 +00:00
|
|
|
over the secure channel, and the application
|
|
|
|
protocol is then used to determine where to connect to from the
|
2003-04-23 16:53:02 +00:00
|
|
|
remote machine.
|
2006-03-22 19:46:12 +00:00
|
|
|
.Pp
|
|
|
|
The argument must be
|
|
|
|
.Sm off
|
|
|
|
.Oo Ar bind_address : Oc Ar port .
|
|
|
|
.Sm on
|
2010-11-08 10:45:44 +00:00
|
|
|
IPv6 addresses can be specified by enclosing addresses in square brackets.
|
2006-03-22 19:46:12 +00:00
|
|
|
By default, the local port is bound in accordance with the
|
|
|
|
.Cm GatewayPorts
|
|
|
|
setting.
|
|
|
|
However, an explicit
|
|
|
|
.Ar bind_address
|
|
|
|
may be used to bind the connection to a specific address.
|
|
|
|
The
|
|
|
|
.Ar bind_address
|
|
|
|
of
|
|
|
|
.Dq localhost
|
|
|
|
indicates that the listening port be bound for local use only, while an
|
|
|
|
empty address or
|
|
|
|
.Sq *
|
|
|
|
indicates that the port should be available from all interfaces.
|
|
|
|
.Pp
|
2004-01-07 11:10:17 +00:00
|
|
|
Currently the SOCKS4 and SOCKS5 protocols are supported, and
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2004-01-07 11:10:17 +00:00
|
|
|
will act as a SOCKS server.
|
2002-06-23 14:01:54 +00:00
|
|
|
Multiple forwardings may be specified, and
|
2003-04-23 16:53:02 +00:00
|
|
|
additional forwardings can be given on the command line.
|
|
|
|
Only the superuser can forward privileged ports.
|
2004-01-07 11:10:17 +00:00
|
|
|
.It Cm EnableSSHKeysign
|
|
|
|
Setting this option to
|
|
|
|
.Dq yes
|
|
|
|
in the global client configuration file
|
|
|
|
.Pa /etc/ssh/ssh_config
|
|
|
|
enables the use of the helper program
|
|
|
|
.Xr ssh-keysign 8
|
|
|
|
during
|
|
|
|
.Cm HostbasedAuthentication .
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2004-02-26 10:38:49 +00:00
|
|
|
This option should be placed in the non-hostspecific section.
|
2004-01-07 11:10:17 +00:00
|
|
|
See
|
|
|
|
.Xr ssh-keysign 8
|
|
|
|
for more information.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm EscapeChar
|
|
|
|
Sets the escape character (default:
|
|
|
|
.Ql ~ ) .
|
|
|
|
The escape character can also
|
|
|
|
be set on the command line.
|
|
|
|
The argument should be a single character,
|
|
|
|
.Ql ^
|
|
|
|
followed by a letter, or
|
|
|
|
.Dq none
|
|
|
|
to disable the escape
|
|
|
|
character entirely (making the connection transparent for binary
|
|
|
|
data).
|
2006-09-30 13:29:51 +00:00
|
|
|
.It Cm ExitOnForwardFailure
|
|
|
|
Specifies whether
|
|
|
|
.Xr ssh 1
|
|
|
|
should terminate the connection if it cannot set up all requested
|
2008-07-23 09:23:42 +00:00
|
|
|
dynamic, tunnel, local, and remote port forwardings.
|
2006-09-30 13:29:51 +00:00
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm ForwardAgent
|
|
|
|
Specifies whether the connection to the authentication agent (if any)
|
|
|
|
will be forwarded to the remote machine.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2002-10-29 09:43:00 +00:00
|
|
|
.Pp
|
2003-04-23 16:53:02 +00:00
|
|
|
Agent forwarding should be enabled with caution.
|
|
|
|
Users with the ability to bypass file permissions on the remote host
|
|
|
|
(for the agent's Unix-domain socket)
|
|
|
|
can access the local agent through the forwarded connection.
|
|
|
|
An attacker cannot obtain key material from the agent,
|
2002-10-29 09:43:00 +00:00
|
|
|
however they can perform operations on the keys that enable them to
|
|
|
|
authenticate using the identities loaded into the agent.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm ForwardX11
|
|
|
|
Specifies whether X11 connections will be automatically redirected
|
|
|
|
over the secure channel and
|
|
|
|
.Ev DISPLAY
|
|
|
|
set.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2002-10-29 09:43:00 +00:00
|
|
|
.Pp
|
2003-04-23 16:53:02 +00:00
|
|
|
X11 forwarding should be enabled with caution.
|
|
|
|
Users with the ability to bypass file permissions on the remote host
|
2004-02-26 10:38:49 +00:00
|
|
|
(for the user's X11 authorization database)
|
2003-04-23 16:53:02 +00:00
|
|
|
can access the local X11 display through the forwarded connection.
|
2004-02-26 10:38:49 +00:00
|
|
|
An attacker may then be able to perform activities such as keystroke monitoring
|
|
|
|
if the
|
|
|
|
.Cm ForwardX11Trusted
|
|
|
|
option is also enabled.
|
2010-11-08 10:45:44 +00:00
|
|
|
.It Cm ForwardX11Timeout
|
|
|
|
Specify a timeout for untrusted X11 forwarding
|
|
|
|
using the format described in the
|
2013-09-18 17:27:38 +00:00
|
|
|
TIME FORMATS section of
|
2010-11-08 10:45:44 +00:00
|
|
|
.Xr sshd_config 5 .
|
|
|
|
X11 connections received by
|
|
|
|
.Xr ssh 1
|
|
|
|
after this time will be refused.
|
|
|
|
The default is to disable untrusted X11 forwarding after twenty minutes has
|
|
|
|
elapsed.
|
2004-02-26 10:38:49 +00:00
|
|
|
.It Cm ForwardX11Trusted
|
2004-10-28 16:03:53 +00:00
|
|
|
If this option is set to
|
2006-09-30 13:29:51 +00:00
|
|
|
.Dq yes ,
|
|
|
|
remote X11 clients will have full access to the original X11 display.
|
2005-06-05 15:40:50 +00:00
|
|
|
.Pp
|
2004-02-26 10:38:49 +00:00
|
|
|
If this option is set to
|
2006-09-30 13:29:51 +00:00
|
|
|
.Dq no ,
|
|
|
|
remote X11 clients will be considered untrusted and prevented
|
2004-02-26 10:38:49 +00:00
|
|
|
from stealing or tampering with data belonging to trusted X11
|
|
|
|
clients.
|
2005-06-05 15:40:50 +00:00
|
|
|
Furthermore, the
|
|
|
|
.Xr xauth 1
|
|
|
|
token used for the session will be set to expire after 20 minutes.
|
|
|
|
Remote clients will be refused access after this time.
|
2004-02-26 10:38:49 +00:00
|
|
|
.Pp
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
.Pp
|
|
|
|
See the X11 SECURITY extension specification for full details on
|
|
|
|
the restrictions imposed on untrusted clients.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm GatewayPorts
|
|
|
|
Specifies whether remote hosts are allowed to connect to local
|
|
|
|
forwarded ports.
|
|
|
|
By default,
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2003-04-23 16:53:02 +00:00
|
|
|
binds local port forwardings to the loopback address.
|
|
|
|
This prevents other remote hosts from connecting to forwarded ports.
|
2002-06-23 14:01:54 +00:00
|
|
|
.Cm GatewayPorts
|
2006-09-30 13:29:51 +00:00
|
|
|
can be used to specify that ssh
|
2002-06-23 14:01:54 +00:00
|
|
|
should bind local port forwardings to the wildcard address,
|
|
|
|
thus allowing remote hosts to connect to forwarded ports.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
.It Cm GlobalKnownHostsFile
|
2011-09-28 08:14:41 +00:00
|
|
|
Specifies one or more files to use for the global
|
|
|
|
host key database, separated by whitespace.
|
|
|
|
The default is
|
|
|
|
.Pa /etc/ssh/ssh_known_hosts ,
|
|
|
|
.Pa /etc/ssh/ssh_known_hosts2 .
|
2004-01-07 11:10:17 +00:00
|
|
|
.It Cm GSSAPIAuthentication
|
2004-02-26 10:38:49 +00:00
|
|
|
Specifies whether user authentication based on GSSAPI is allowed.
|
2004-01-07 11:10:17 +00:00
|
|
|
The default is
|
2004-02-26 10:38:49 +00:00
|
|
|
.Dq no .
|
2004-01-07 11:10:17 +00:00
|
|
|
Note that this option applies to protocol version 2 only.
|
|
|
|
.It Cm GSSAPIDelegateCredentials
|
|
|
|
Forward (delegate) credentials to the server.
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
Note that this option applies to protocol version 2 only.
|
2005-06-05 15:40:50 +00:00
|
|
|
.It Cm HashKnownHosts
|
|
|
|
Indicates that
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2005-06-05 15:40:50 +00:00
|
|
|
should hash host names and addresses when they are added to
|
2005-09-03 06:59:33 +00:00
|
|
|
.Pa ~/.ssh/known_hosts .
|
2005-06-05 15:40:50 +00:00
|
|
|
These hashed names may be used normally by
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2005-06-05 15:40:50 +00:00
|
|
|
and
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr sshd 8 ,
|
2005-06-05 15:40:50 +00:00
|
|
|
but they do not reveal identifying information should the file's contents
|
|
|
|
be disclosed.
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2006-09-30 13:29:51 +00:00
|
|
|
Note that existing names and addresses in known hosts files
|
|
|
|
will not be converted automatically,
|
|
|
|
but may be manually hashed using
|
2005-06-05 15:40:50 +00:00
|
|
|
.Xr ssh-keygen 1 .
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm HostbasedAuthentication
|
|
|
|
Specifies whether to try rhosts based authentication with public key
|
|
|
|
authentication.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
This option applies to protocol version 2 only and
|
|
|
|
is similar to
|
|
|
|
.Cm RhostsRSAAuthentication .
|
|
|
|
.It Cm HostKeyAlgorithms
|
|
|
|
Specifies the protocol version 2 host key algorithms
|
|
|
|
that the client wants to use in order of preference.
|
|
|
|
The default for this option is:
|
2011-02-17 11:47:40 +00:00
|
|
|
.Bd -literal -offset 3n
|
|
|
|
ecdsa-sha2-nistp256-cert-v01@openssh.com,
|
|
|
|
ecdsa-sha2-nistp384-cert-v01@openssh.com,
|
|
|
|
ecdsa-sha2-nistp521-cert-v01@openssh.com,
|
2014-01-30 10:56:49 +00:00
|
|
|
ssh-ed25519-cert-v01@openssh.com,
|
2011-02-17 11:47:40 +00:00
|
|
|
ssh-rsa-cert-v01@openssh.com,ssh-dss-cert-v01@openssh.com,
|
|
|
|
ssh-rsa-cert-v00@openssh.com,ssh-dss-cert-v00@openssh.com,
|
|
|
|
ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
|
2014-01-30 10:56:49 +00:00
|
|
|
ssh-ed25519,ssh-rsa,ssh-dss
|
2011-02-17 11:47:40 +00:00
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
If hostkeys are known for the destination host then this default is modified
|
|
|
|
to prefer their algorithms.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm HostKeyAlias
|
|
|
|
Specifies an alias that should be used instead of the
|
|
|
|
real host name when looking up or saving the host key
|
|
|
|
in the host key database files.
|
2006-09-30 13:29:51 +00:00
|
|
|
This option is useful for tunneling SSH connections
|
2002-06-23 14:01:54 +00:00
|
|
|
or for multiple servers running on a single host.
|
|
|
|
.It Cm HostName
|
|
|
|
Specifies the real host name to log into.
|
|
|
|
This can be used to specify nicknames or abbreviations for hosts.
|
2010-11-08 10:45:44 +00:00
|
|
|
If the hostname contains the character sequence
|
|
|
|
.Ql %h ,
|
2011-09-28 08:14:41 +00:00
|
|
|
then this will be replaced with the host name specified on the command line
|
2010-11-08 10:45:44 +00:00
|
|
|
(this is useful for manipulating unqualified names).
|
2015-01-05 16:09:55 +00:00
|
|
|
The character sequence
|
|
|
|
.Ql %%
|
|
|
|
will be replaced by a single
|
|
|
|
.Ql %
|
|
|
|
character, which may be used when specifying IPv6 link-local addresses.
|
|
|
|
.Pp
|
2006-09-30 13:29:51 +00:00
|
|
|
The default is the name given on the command line.
|
2002-06-23 14:01:54 +00:00
|
|
|
Numeric IP addresses are also permitted (both on the command line and in
|
|
|
|
.Cm HostName
|
|
|
|
specifications).
|
2004-04-20 09:35:04 +00:00
|
|
|
.It Cm IdentitiesOnly
|
|
|
|
Specifies that
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2004-04-20 09:35:04 +00:00
|
|
|
should only use the authentication identity files configured in the
|
2004-10-28 16:03:53 +00:00
|
|
|
.Nm
|
2004-04-20 09:35:04 +00:00
|
|
|
files,
|
2006-09-30 13:29:51 +00:00
|
|
|
even if
|
|
|
|
.Xr ssh-agent 1
|
2013-03-22 11:19:48 +00:00
|
|
|
or a
|
|
|
|
.Cm PKCS11Provider
|
2004-04-20 09:35:04 +00:00
|
|
|
offers more identities.
|
|
|
|
The argument to this keyword must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
2006-09-30 13:29:51 +00:00
|
|
|
This option is intended for situations where ssh-agent
|
2004-04-20 09:35:04 +00:00
|
|
|
offers many different identities.
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2006-03-22 19:46:12 +00:00
|
|
|
.It Cm IdentityFile
|
2014-01-30 10:56:49 +00:00
|
|
|
Specifies a file from which the user's DSA, ECDSA, ED25519 or RSA authentication
|
2011-02-17 11:47:40 +00:00
|
|
|
identity is read.
|
2006-03-22 19:46:12 +00:00
|
|
|
The default is
|
|
|
|
.Pa ~/.ssh/identity
|
|
|
|
for protocol version 1, and
|
2011-02-17 11:47:40 +00:00
|
|
|
.Pa ~/.ssh/id_dsa ,
|
2014-01-30 10:56:49 +00:00
|
|
|
.Pa ~/.ssh/id_ecdsa ,
|
|
|
|
.Pa ~/.ssh/id_ed25519
|
2006-03-22 19:46:12 +00:00
|
|
|
and
|
2011-02-17 11:47:40 +00:00
|
|
|
.Pa ~/.ssh/id_rsa
|
2006-03-22 19:46:12 +00:00
|
|
|
for protocol version 2.
|
|
|
|
Additionally, any identities represented by the authentication agent
|
2013-09-18 17:27:38 +00:00
|
|
|
will be used for authentication unless
|
|
|
|
.Cm IdentitiesOnly
|
|
|
|
is set.
|
2010-03-08 11:19:52 +00:00
|
|
|
.Xr ssh 1
|
|
|
|
will try to load certificate information from the filename obtained by
|
|
|
|
appending
|
|
|
|
.Pa -cert.pub
|
|
|
|
to the path of a specified
|
|
|
|
.Cm IdentityFile .
|
2006-09-30 13:29:51 +00:00
|
|
|
.Pp
|
2006-03-22 19:46:12 +00:00
|
|
|
The file name may use the tilde
|
2006-09-30 13:29:51 +00:00
|
|
|
syntax to refer to a user's home directory or one of the following
|
|
|
|
escape characters:
|
|
|
|
.Ql %d
|
|
|
|
(local user's home directory),
|
|
|
|
.Ql %u
|
|
|
|
(local user name),
|
|
|
|
.Ql %l
|
|
|
|
(local host name),
|
|
|
|
.Ql %h
|
|
|
|
(remote host name) or
|
|
|
|
.Ql %r
|
|
|
|
(remote user name).
|
|
|
|
.Pp
|
2006-03-22 19:46:12 +00:00
|
|
|
It is possible to have
|
|
|
|
multiple identity files specified in configuration files; all these
|
|
|
|
identities will be tried in sequence.
|
2011-09-28 08:14:41 +00:00
|
|
|
Multiple
|
|
|
|
.Cm IdentityFile
|
|
|
|
directives will add to the list of identities tried (this behaviour
|
|
|
|
differs from that of other configuration directives).
|
2013-09-18 17:27:38 +00:00
|
|
|
.Pp
|
|
|
|
.Cm IdentityFile
|
|
|
|
may be used in conjunction with
|
|
|
|
.Cm IdentitiesOnly
|
|
|
|
to select which identities in an agent are offered during authentication.
|
|
|
|
.It Cm IgnoreUnknown
|
|
|
|
Specifies a pattern-list of unknown options to be ignored if they are
|
|
|
|
encountered in configuration parsing.
|
|
|
|
This may be used to suppress errors if
|
|
|
|
.Nm
|
|
|
|
contains options that are unrecognised by
|
|
|
|
.Xr ssh 1 .
|
|
|
|
It is recommended that
|
|
|
|
.Cm IgnoreUnknown
|
|
|
|
be listed early in the configuration file as it will not be applied
|
|
|
|
to unknown options that appear before it.
|
2011-02-17 11:47:40 +00:00
|
|
|
.It Cm IPQoS
|
|
|
|
Specifies the IPv4 type-of-service or DSCP class for connections.
|
|
|
|
Accepted values are
|
|
|
|
.Dq af11 ,
|
|
|
|
.Dq af12 ,
|
|
|
|
.Dq af13 ,
|
2012-08-29 15:46:01 +00:00
|
|
|
.Dq af21 ,
|
2011-02-17 11:47:40 +00:00
|
|
|
.Dq af22 ,
|
|
|
|
.Dq af23 ,
|
|
|
|
.Dq af31 ,
|
|
|
|
.Dq af32 ,
|
|
|
|
.Dq af33 ,
|
|
|
|
.Dq af41 ,
|
|
|
|
.Dq af42 ,
|
|
|
|
.Dq af43 ,
|
|
|
|
.Dq cs0 ,
|
|
|
|
.Dq cs1 ,
|
|
|
|
.Dq cs2 ,
|
|
|
|
.Dq cs3 ,
|
|
|
|
.Dq cs4 ,
|
|
|
|
.Dq cs5 ,
|
|
|
|
.Dq cs6 ,
|
|
|
|
.Dq cs7 ,
|
|
|
|
.Dq ef ,
|
|
|
|
.Dq lowdelay ,
|
|
|
|
.Dq throughput ,
|
|
|
|
.Dq reliability ,
|
|
|
|
or a numeric value.
|
|
|
|
This option may take one or two arguments, separated by whitespace.
|
|
|
|
If one argument is specified, it is used as the packet class unconditionally.
|
|
|
|
If two values are specified, the first is automatically selected for
|
|
|
|
interactive sessions and the second for non-interactive sessions.
|
|
|
|
The default is
|
|
|
|
.Dq lowdelay
|
|
|
|
for interactive sessions and
|
|
|
|
.Dq throughput
|
|
|
|
for non-interactive sessions.
|
2008-07-23 09:28:49 +00:00
|
|
|
.It Cm KbdInteractiveAuthentication
|
|
|
|
Specifies whether to use keyboard-interactive authentication.
|
|
|
|
The argument to this keyword must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq yes .
|
2005-06-05 15:40:50 +00:00
|
|
|
.It Cm KbdInteractiveDevices
|
|
|
|
Specifies the list of methods to use in keyboard-interactive authentication.
|
|
|
|
Multiple method names must be comma-separated.
|
|
|
|
The default is to use the server specified list.
|
2006-09-30 13:29:51 +00:00
|
|
|
The methods available vary depending on what the server supports.
|
|
|
|
For an OpenSSH server,
|
|
|
|
it may be zero or more of:
|
|
|
|
.Dq bsdauth ,
|
|
|
|
.Dq pam ,
|
|
|
|
and
|
|
|
|
.Dq skey .
|
2011-02-17 11:47:40 +00:00
|
|
|
.It Cm KexAlgorithms
|
|
|
|
Specifies the available KEX (Key Exchange) algorithms.
|
|
|
|
Multiple algorithms must be comma-separated.
|
|
|
|
The default is:
|
|
|
|
.Bd -literal -offset indent
|
2014-01-30 10:56:49 +00:00
|
|
|
curve25519-sha256@libssh.org,
|
2011-02-17 11:47:40 +00:00
|
|
|
ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
|
|
|
|
diffie-hellman-group-exchange-sha256,
|
|
|
|
diffie-hellman-group14-sha1,
|
2015-01-05 16:09:55 +00:00
|
|
|
diffie-hellman-group-exchange-sha1,
|
2011-02-17 11:47:40 +00:00
|
|
|
diffie-hellman-group1-sha1
|
|
|
|
.Ed
|
2006-03-22 19:46:12 +00:00
|
|
|
.It Cm LocalCommand
|
|
|
|
Specifies a command to execute on the local machine after successfully
|
|
|
|
connecting to the server.
|
|
|
|
The command string extends to the end of the line, and is executed with
|
2008-07-23 09:28:49 +00:00
|
|
|
the user's shell.
|
2008-07-23 09:33:08 +00:00
|
|
|
The following escape character substitutions will be performed:
|
|
|
|
.Ql %d
|
|
|
|
(local user's home directory),
|
|
|
|
.Ql %h
|
|
|
|
(remote host name),
|
|
|
|
.Ql %l
|
|
|
|
(local host name),
|
|
|
|
.Ql %n
|
|
|
|
(host name as provided on the command line),
|
|
|
|
.Ql %p
|
|
|
|
(remote port),
|
|
|
|
.Ql %r
|
|
|
|
(remote user name) or
|
|
|
|
.Ql %u
|
2015-01-05 16:09:55 +00:00
|
|
|
(local user name) or
|
|
|
|
.Ql \&%C
|
|
|
|
by a hash of the concatenation: %l%h%p%r.
|
2010-03-08 11:19:52 +00:00
|
|
|
.Pp
|
|
|
|
The command is run synchronously and does not have access to the
|
|
|
|
session of the
|
|
|
|
.Xr ssh 1
|
|
|
|
that spawned it.
|
|
|
|
It should not be used for interactive commands.
|
|
|
|
.Pp
|
2006-03-22 19:46:12 +00:00
|
|
|
This directive is ignored unless
|
|
|
|
.Cm PermitLocalCommand
|
|
|
|
has been enabled.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm LocalForward
|
2006-03-22 19:46:12 +00:00
|
|
|
Specifies that a TCP port on the local machine be forwarded over
|
2002-06-23 14:01:54 +00:00
|
|
|
the secure channel to the specified host and port from the remote machine.
|
2005-06-05 15:41:57 +00:00
|
|
|
The first argument must be
|
2005-06-05 15:40:50 +00:00
|
|
|
.Sm off
|
2005-06-05 15:41:57 +00:00
|
|
|
.Oo Ar bind_address : Oc Ar port
|
2005-06-05 15:40:50 +00:00
|
|
|
.Sm on
|
2005-06-05 15:41:57 +00:00
|
|
|
and the second argument must be
|
|
|
|
.Ar host : Ns Ar hostport .
|
2010-11-08 10:45:44 +00:00
|
|
|
IPv6 addresses can be specified by enclosing addresses in square brackets.
|
2005-06-05 15:40:50 +00:00
|
|
|
Multiple forwardings may be specified, and additional forwardings can be
|
|
|
|
given on the command line.
|
2002-06-23 14:01:54 +00:00
|
|
|
Only the superuser can forward privileged ports.
|
2005-06-05 15:40:50 +00:00
|
|
|
By default, the local port is bound in accordance with the
|
|
|
|
.Cm GatewayPorts
|
|
|
|
setting.
|
|
|
|
However, an explicit
|
|
|
|
.Ar bind_address
|
|
|
|
may be used to bind the connection to a specific address.
|
|
|
|
The
|
|
|
|
.Ar bind_address
|
|
|
|
of
|
|
|
|
.Dq localhost
|
|
|
|
indicates that the listening port be bound for local use only, while an
|
|
|
|
empty address or
|
|
|
|
.Sq *
|
|
|
|
indicates that the port should be available from all interfaces.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm LogLevel
|
|
|
|
Gives the verbosity level that is used when logging messages from
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1 .
|
2002-06-23 14:01:54 +00:00
|
|
|
The possible values are:
|
2006-09-30 13:29:51 +00:00
|
|
|
QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG, DEBUG1, DEBUG2, and DEBUG3.
|
2003-04-23 16:53:02 +00:00
|
|
|
The default is INFO.
|
|
|
|
DEBUG and DEBUG1 are equivalent.
|
|
|
|
DEBUG2 and DEBUG3 each specify higher levels of verbose output.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm MACs
|
|
|
|
Specifies the MAC (message authentication code) algorithms
|
|
|
|
in order of preference.
|
|
|
|
The MAC algorithm is used in protocol version 2
|
|
|
|
for data integrity protection.
|
|
|
|
Multiple algorithms must be comma-separated.
|
2013-03-22 11:19:48 +00:00
|
|
|
The algorithms that contain
|
|
|
|
.Dq -etm
|
|
|
|
calculate the MAC after encryption (encrypt-then-mac).
|
|
|
|
These are considered safer and their use recommended.
|
2006-09-30 13:29:51 +00:00
|
|
|
The default is:
|
2008-07-23 09:23:42 +00:00
|
|
|
.Bd -literal -offset indent
|
2013-03-22 11:19:48 +00:00
|
|
|
umac-64-etm@openssh.com,umac-128-etm@openssh.com,
|
|
|
|
hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
|
2015-01-05 16:09:55 +00:00
|
|
|
umac-64@openssh.com,umac-128@openssh.com,
|
|
|
|
hmac-sha2-256,hmac-sha2-512,
|
|
|
|
hmac-md5-etm@openssh.com,hmac-sha1-etm@openssh.com,
|
|
|
|
hmac-ripemd160-etm@openssh.com,
|
|
|
|
hmac-sha1-96-etm@openssh.com,hmac-md5-96-etm@openssh.com,
|
|
|
|
hmac-md5,hmac-sha1,hmac-ripemd160,
|
2012-08-29 15:55:54 +00:00
|
|
|
hmac-sha1-96,hmac-md5-96
|
2008-07-23 09:23:42 +00:00
|
|
|
.Ed
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm NoHostAuthenticationForLocalhost
|
|
|
|
This option can be used if the home directory is shared across machines.
|
|
|
|
In this case localhost will refer to a different machine on each of
|
|
|
|
the machines and the user will get many warnings about changed host keys.
|
|
|
|
However, this option disables host authentication for localhost.
|
|
|
|
The argument to this keyword must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is to check the host key for localhost.
|
|
|
|
.It Cm NumberOfPasswordPrompts
|
|
|
|
Specifies the number of password prompts before giving up.
|
|
|
|
The argument to this keyword must be an integer.
|
2006-09-30 13:29:51 +00:00
|
|
|
The default is 3.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm PasswordAuthentication
|
|
|
|
Specifies whether to use password authentication.
|
|
|
|
The argument to this keyword must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq yes .
|
2006-03-22 19:46:12 +00:00
|
|
|
.It Cm PermitLocalCommand
|
|
|
|
Allow local command execution via the
|
|
|
|
.Ic LocalCommand
|
|
|
|
option or using the
|
|
|
|
.Ic !\& Ns Ar command
|
|
|
|
escape sequence in
|
|
|
|
.Xr ssh 1 .
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2010-03-08 11:19:52 +00:00
|
|
|
.It Cm PKCS11Provider
|
|
|
|
Specifies which PKCS#11 provider to use.
|
2011-02-17 11:47:40 +00:00
|
|
|
The argument to this keyword is the PKCS#11 shared library
|
2010-03-08 11:19:52 +00:00
|
|
|
.Xr ssh 1
|
|
|
|
should use to communicate with a PKCS#11 token providing the user's
|
|
|
|
private RSA key.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm Port
|
|
|
|
Specifies the port number to connect on the remote host.
|
2006-09-30 13:29:51 +00:00
|
|
|
The default is 22.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm PreferredAuthentications
|
|
|
|
Specifies the order in which the client should try protocol 2
|
2004-01-07 11:10:17 +00:00
|
|
|
authentication methods.
|
2005-06-05 15:41:57 +00:00
|
|
|
This allows a client to prefer one method (e.g.\&
|
2002-06-23 14:01:54 +00:00
|
|
|
.Cm keyboard-interactive )
|
2005-06-05 15:41:57 +00:00
|
|
|
over another method (e.g.\&
|
2010-11-08 10:45:44 +00:00
|
|
|
.Cm password ) .
|
|
|
|
The default is:
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
gssapi-with-mic,hostbased,publickey,
|
|
|
|
keyboard-interactive,password
|
|
|
|
.Ed
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm Protocol
|
|
|
|
Specifies the protocol versions
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2002-06-23 14:01:54 +00:00
|
|
|
should support in order of preference.
|
|
|
|
The possible values are
|
2006-09-30 13:29:51 +00:00
|
|
|
.Sq 1
|
2002-06-23 14:01:54 +00:00
|
|
|
and
|
2006-09-30 13:29:51 +00:00
|
|
|
.Sq 2 .
|
2002-06-23 14:01:54 +00:00
|
|
|
Multiple versions must be comma-separated.
|
2010-03-08 11:19:52 +00:00
|
|
|
When this option is set to
|
|
|
|
.Dq 2,1
|
|
|
|
.Nm ssh
|
|
|
|
will try version 2 and fall back to version 1
|
2002-06-23 14:01:54 +00:00
|
|
|
if version 2 is not available.
|
2010-03-08 11:19:52 +00:00
|
|
|
The default is
|
|
|
|
.Sq 2 .
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm ProxyCommand
|
|
|
|
Specifies the command to use to connect to the server.
|
|
|
|
The command
|
2015-01-05 16:09:55 +00:00
|
|
|
string extends to the end of the line, and is executed
|
|
|
|
using the user's shell
|
|
|
|
.Ql exec
|
|
|
|
directive to avoid a lingering shell process.
|
|
|
|
.Pp
|
2010-11-08 10:45:44 +00:00
|
|
|
In the command string, any occurrence of
|
2002-06-23 14:01:54 +00:00
|
|
|
.Ql %h
|
|
|
|
will be substituted by the host name to
|
2010-11-08 10:45:44 +00:00
|
|
|
connect,
|
2002-06-23 14:01:54 +00:00
|
|
|
.Ql %p
|
2010-11-08 10:45:44 +00:00
|
|
|
by the port, and
|
|
|
|
.Ql %r
|
|
|
|
by the remote user name.
|
2002-06-23 14:01:54 +00:00
|
|
|
The command can be basically anything,
|
|
|
|
and should read from its standard input and write to its standard output.
|
|
|
|
It should eventually connect an
|
|
|
|
.Xr sshd 8
|
|
|
|
server running on some machine, or execute
|
|
|
|
.Ic sshd -i
|
|
|
|
somewhere.
|
|
|
|
Host key management will be done using the
|
|
|
|
HostName of the host being connected (defaulting to the name typed by
|
|
|
|
the user).
|
2003-04-23 16:53:02 +00:00
|
|
|
Setting the command to
|
|
|
|
.Dq none
|
|
|
|
disables this option entirely.
|
2002-06-23 14:01:54 +00:00
|
|
|
Note that
|
|
|
|
.Cm CheckHostIP
|
|
|
|
is not available for connects with a proxy command.
|
|
|
|
.Pp
|
2005-09-03 06:59:33 +00:00
|
|
|
This directive is useful in conjunction with
|
|
|
|
.Xr nc 1
|
|
|
|
and its proxy support.
|
|
|
|
For example, the following directive would connect via an HTTP proxy at
|
|
|
|
192.0.2.0:
|
|
|
|
.Bd -literal -offset 3n
|
|
|
|
ProxyCommand /usr/bin/nc -X connect -x 192.0.2.0:8080 %h %p
|
|
|
|
.Ed
|
2014-01-30 10:56:49 +00:00
|
|
|
.It Cm ProxyUseFdpass
|
|
|
|
Specifies that
|
|
|
|
.Cm ProxyCommand
|
|
|
|
will pass a connected file descriptor back to
|
|
|
|
.Xr ssh 1
|
|
|
|
instead of continuing to execute and pass data.
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm PubkeyAuthentication
|
|
|
|
Specifies whether to try public key authentication.
|
|
|
|
The argument to this keyword must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq yes .
|
|
|
|
This option applies to protocol version 2 only.
|
2006-03-22 19:46:12 +00:00
|
|
|
.It Cm RekeyLimit
|
|
|
|
Specifies the maximum amount of data that may be transmitted before the
|
2013-09-18 17:27:38 +00:00
|
|
|
session key is renegotiated, optionally followed a maximum amount of
|
|
|
|
time that may pass before the session key is renegotiated.
|
|
|
|
The first argument is specified in bytes and may have a suffix of
|
2006-03-22 19:46:12 +00:00
|
|
|
.Sq K ,
|
|
|
|
.Sq M ,
|
|
|
|
or
|
|
|
|
.Sq G
|
|
|
|
to indicate Kilobytes, Megabytes, or Gigabytes, respectively.
|
|
|
|
The default is between
|
2006-09-30 13:29:51 +00:00
|
|
|
.Sq 1G
|
2006-03-22 19:46:12 +00:00
|
|
|
and
|
2006-09-30 13:29:51 +00:00
|
|
|
.Sq 4G ,
|
2006-03-22 19:46:12 +00:00
|
|
|
depending on the cipher.
|
2013-09-18 17:27:38 +00:00
|
|
|
The optional second value is specified in seconds and may use any of the
|
|
|
|
units documented in the
|
|
|
|
TIME FORMATS section of
|
|
|
|
.Xr sshd_config 5 .
|
|
|
|
The default value for
|
|
|
|
.Cm RekeyLimit
|
|
|
|
is
|
|
|
|
.Dq default none ,
|
|
|
|
which means that rekeying is performed after the cipher's default amount
|
|
|
|
of data has been sent or received and no time based rekeying is done.
|
2006-03-22 19:46:12 +00:00
|
|
|
This option applies to protocol version 2 only.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm RemoteForward
|
2006-03-22 19:46:12 +00:00
|
|
|
Specifies that a TCP port on the remote machine be forwarded over
|
2002-06-23 14:01:54 +00:00
|
|
|
the secure channel to the specified host and port from the local machine.
|
2005-06-05 15:41:57 +00:00
|
|
|
The first argument must be
|
2005-06-05 15:40:50 +00:00
|
|
|
.Sm off
|
2005-06-05 15:41:57 +00:00
|
|
|
.Oo Ar bind_address : Oc Ar port
|
2005-06-05 15:40:50 +00:00
|
|
|
.Sm on
|
2005-06-05 15:41:57 +00:00
|
|
|
and the second argument must be
|
|
|
|
.Ar host : Ns Ar hostport .
|
2010-11-08 10:45:44 +00:00
|
|
|
IPv6 addresses can be specified by enclosing addresses in square brackets.
|
2002-06-23 14:01:54 +00:00
|
|
|
Multiple forwardings may be specified, and additional
|
|
|
|
forwardings can be given on the command line.
|
2009-02-24 18:49:27 +00:00
|
|
|
Privileged ports can be forwarded only when
|
|
|
|
logging in as root on the remote machine.
|
|
|
|
.Pp
|
|
|
|
If the
|
|
|
|
.Ar port
|
|
|
|
argument is
|
|
|
|
.Ql 0 ,
|
|
|
|
the listen port will be dynamically allocated on the server and reported
|
|
|
|
to the client at run time.
|
2005-06-05 15:40:50 +00:00
|
|
|
.Pp
|
|
|
|
If the
|
|
|
|
.Ar bind_address
|
|
|
|
is not specified, the default is to only bind to loopback addresses.
|
|
|
|
If the
|
|
|
|
.Ar bind_address
|
|
|
|
is
|
|
|
|
.Ql *
|
|
|
|
or an empty string, then the forwarding is requested to listen on all
|
|
|
|
interfaces.
|
|
|
|
Specifying a remote
|
|
|
|
.Ar bind_address
|
|
|
|
will only succeed if the server's
|
|
|
|
.Cm GatewayPorts
|
|
|
|
option is enabled (see
|
|
|
|
.Xr sshd_config 5 ) .
|
2011-09-28 08:14:41 +00:00
|
|
|
.It Cm RequestTTY
|
|
|
|
Specifies whether to request a pseudo-tty for the session.
|
|
|
|
The argument may be one of:
|
|
|
|
.Dq no
|
|
|
|
(never request a TTY),
|
|
|
|
.Dq yes
|
|
|
|
(always request a TTY when standard input is a TTY),
|
|
|
|
.Dq force
|
|
|
|
(always request a TTY) or
|
|
|
|
.Dq auto
|
|
|
|
(request a TTY when opening a login session).
|
|
|
|
This option mirrors the
|
|
|
|
.Fl t
|
|
|
|
and
|
|
|
|
.Fl T
|
|
|
|
flags for
|
|
|
|
.Xr ssh 1 .
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm RhostsRSAAuthentication
|
|
|
|
Specifies whether to try rhosts based authentication with RSA host
|
|
|
|
authentication.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
This option applies to protocol version 1 only and requires
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2002-06-23 14:01:54 +00:00
|
|
|
to be setuid root.
|
|
|
|
.It Cm RSAAuthentication
|
|
|
|
Specifies whether to try RSA authentication.
|
|
|
|
The argument to this keyword must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
RSA authentication will only be
|
|
|
|
attempted if the identity file exists, or an authentication agent is
|
|
|
|
running.
|
|
|
|
The default is
|
|
|
|
.Dq yes .
|
|
|
|
Note that this option applies to protocol version 1 only.
|
2004-10-28 16:03:53 +00:00
|
|
|
.It Cm SendEnv
|
|
|
|
Specifies what variables from the local
|
|
|
|
.Xr environ 7
|
|
|
|
should be sent to the server.
|
2006-09-30 13:29:51 +00:00
|
|
|
Note that environment passing is only supported for protocol 2.
|
|
|
|
The server must also support it, and the server must be configured to
|
2004-10-28 16:03:53 +00:00
|
|
|
accept these environment variables.
|
|
|
|
Refer to
|
|
|
|
.Cm AcceptEnv
|
|
|
|
in
|
|
|
|
.Xr sshd_config 5
|
|
|
|
for how to configure the server.
|
2006-09-30 13:29:51 +00:00
|
|
|
Variables are specified by name, which may contain wildcard characters.
|
2004-10-28 16:03:53 +00:00
|
|
|
Multiple environment variables may be separated by whitespace or spread
|
|
|
|
across multiple
|
|
|
|
.Cm SendEnv
|
|
|
|
directives.
|
|
|
|
The default is not to send any environment variables.
|
2006-09-30 13:29:51 +00:00
|
|
|
.Pp
|
|
|
|
See
|
|
|
|
.Sx PATTERNS
|
|
|
|
for more information on patterns.
|
2004-02-26 10:38:49 +00:00
|
|
|
.It Cm ServerAliveCountMax
|
2006-03-22 19:46:12 +00:00
|
|
|
Sets the number of server alive messages (see below) which may be
|
2004-02-26 10:38:49 +00:00
|
|
|
sent without
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2004-02-26 10:38:49 +00:00
|
|
|
receiving any messages back from the server.
|
|
|
|
If this threshold is reached while server alive messages are being sent,
|
2006-09-30 13:29:51 +00:00
|
|
|
ssh will disconnect from the server, terminating the session.
|
2004-02-26 10:38:49 +00:00
|
|
|
It is important to note that the use of server alive messages is very
|
|
|
|
different from
|
|
|
|
.Cm TCPKeepAlive
|
|
|
|
(below).
|
|
|
|
The server alive messages are sent through the encrypted channel
|
|
|
|
and therefore will not be spoofable.
|
|
|
|
The TCP keepalive option enabled by
|
|
|
|
.Cm TCPKeepAlive
|
|
|
|
is spoofable.
|
|
|
|
The server alive mechanism is valuable when the client or
|
|
|
|
server depend on knowing when a connection has become inactive.
|
|
|
|
.Pp
|
|
|
|
The default value is 3.
|
|
|
|
If, for example,
|
|
|
|
.Cm ServerAliveInterval
|
2006-09-30 13:29:51 +00:00
|
|
|
(see below) is set to 15 and
|
2004-02-26 10:38:49 +00:00
|
|
|
.Cm ServerAliveCountMax
|
2006-09-30 13:29:51 +00:00
|
|
|
is left at the default, if the server becomes unresponsive,
|
|
|
|
ssh will disconnect after approximately 45 seconds.
|
|
|
|
This option applies to protocol version 2 only.
|
2006-03-22 19:46:12 +00:00
|
|
|
.It Cm ServerAliveInterval
|
|
|
|
Sets a timeout interval in seconds after which if no data has been received
|
|
|
|
from the server,
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2006-03-22 19:46:12 +00:00
|
|
|
will send a message through the encrypted
|
|
|
|
channel to request a response from the server.
|
|
|
|
The default
|
|
|
|
is 0, indicating that these messages will not be sent to the server.
|
|
|
|
This option applies to protocol version 2 only.
|
2015-01-05 16:09:55 +00:00
|
|
|
.It Cm StreamLocalBindMask
|
|
|
|
Sets the octal file creation mode mask
|
|
|
|
.Pq umask
|
|
|
|
used when creating a Unix-domain socket file for local or remote
|
|
|
|
port forwarding.
|
|
|
|
This option is only used for port forwarding to a Unix-domain socket file.
|
|
|
|
.Pp
|
|
|
|
The default value is 0177, which creates a Unix-domain socket file that is
|
|
|
|
readable and writable only by the owner.
|
|
|
|
Note that not all operating systems honor the file mode on Unix-domain
|
|
|
|
socket files.
|
|
|
|
.It Cm StreamLocalBindUnlink
|
|
|
|
Specifies whether to remove an existing Unix-domain socket file for local
|
|
|
|
or remote port forwarding before creating a new one.
|
|
|
|
If the socket file already exists and
|
|
|
|
.Cm StreamLocalBindUnlink
|
|
|
|
is not enabled,
|
|
|
|
.Nm ssh
|
|
|
|
will be unable to forward the port to the Unix-domain socket file.
|
|
|
|
This option is only used for port forwarding to a Unix-domain socket file.
|
|
|
|
.Pp
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm StrictHostKeyChecking
|
|
|
|
If this flag is set to
|
|
|
|
.Dq yes ,
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1
|
2002-06-23 14:01:54 +00:00
|
|
|
will never automatically add host keys to the
|
2005-09-03 06:59:33 +00:00
|
|
|
.Pa ~/.ssh/known_hosts
|
2002-06-23 14:01:54 +00:00
|
|
|
file, and refuses to connect to hosts whose host key has changed.
|
|
|
|
This provides maximum protection against trojan horse attacks,
|
2006-09-30 13:29:51 +00:00
|
|
|
though it can be annoying when the
|
2002-06-23 14:01:54 +00:00
|
|
|
.Pa /etc/ssh/ssh_known_hosts
|
2006-09-30 13:29:51 +00:00
|
|
|
file is poorly maintained or when connections to new hosts are
|
2002-06-23 14:01:54 +00:00
|
|
|
frequently made.
|
|
|
|
This option forces the user to manually
|
|
|
|
add all new hosts.
|
|
|
|
If this flag is set to
|
|
|
|
.Dq no ,
|
2006-09-30 13:29:51 +00:00
|
|
|
ssh will automatically add new host keys to the
|
2002-06-23 14:01:54 +00:00
|
|
|
user known hosts files.
|
|
|
|
If this flag is set to
|
|
|
|
.Dq ask ,
|
|
|
|
new host keys
|
|
|
|
will be added to the user known host files only after the user
|
|
|
|
has confirmed that is what they really want to do, and
|
2006-09-30 13:29:51 +00:00
|
|
|
ssh will refuse to connect to hosts whose host key has changed.
|
2002-06-23 14:01:54 +00:00
|
|
|
The host keys of
|
|
|
|
known hosts will be verified automatically in all cases.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes ,
|
2006-09-30 13:29:51 +00:00
|
|
|
.Dq no ,
|
2002-06-23 14:01:54 +00:00
|
|
|
or
|
|
|
|
.Dq ask .
|
|
|
|
The default is
|
|
|
|
.Dq ask .
|
2004-02-26 10:38:49 +00:00
|
|
|
.It Cm TCPKeepAlive
|
|
|
|
Specifies whether the system should send TCP keepalive messages to the
|
|
|
|
other side.
|
|
|
|
If they are sent, death of the connection or crash of one
|
|
|
|
of the machines will be properly noticed.
|
|
|
|
However, this means that
|
|
|
|
connections will die if the route is down temporarily, and some people
|
|
|
|
find it annoying.
|
|
|
|
.Pp
|
|
|
|
The default is
|
|
|
|
.Dq yes
|
|
|
|
(to send TCP keepalive messages), and the client will notice
|
|
|
|
if the network goes down or the remote host dies.
|
|
|
|
This is important in scripts, and many users want it too.
|
|
|
|
.Pp
|
|
|
|
To disable TCP keepalive messages, the value should be set to
|
|
|
|
.Dq no .
|
2006-03-22 19:46:12 +00:00
|
|
|
.It Cm Tunnel
|
2006-09-30 13:29:51 +00:00
|
|
|
Request
|
2006-03-22 19:46:12 +00:00
|
|
|
.Xr tun 4
|
|
|
|
device forwarding between the client and the server.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes ,
|
2006-09-30 13:29:51 +00:00
|
|
|
.Dq point-to-point
|
|
|
|
(layer 3),
|
2006-03-22 19:46:12 +00:00
|
|
|
.Dq ethernet
|
2006-09-30 13:29:51 +00:00
|
|
|
(layer 2),
|
2006-03-22 19:46:12 +00:00
|
|
|
or
|
|
|
|
.Dq no .
|
2006-09-30 13:29:51 +00:00
|
|
|
Specifying
|
|
|
|
.Dq yes
|
|
|
|
requests the default tunnel mode, which is
|
|
|
|
.Dq point-to-point .
|
2006-03-22 19:46:12 +00:00
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
.It Cm TunnelDevice
|
2006-09-30 13:29:51 +00:00
|
|
|
Specifies the
|
2006-03-22 19:46:12 +00:00
|
|
|
.Xr tun 4
|
2006-09-30 13:29:51 +00:00
|
|
|
devices to open on the client
|
|
|
|
.Pq Ar local_tun
|
|
|
|
and the server
|
|
|
|
.Pq Ar remote_tun .
|
|
|
|
.Pp
|
|
|
|
The argument must be
|
|
|
|
.Sm off
|
|
|
|
.Ar local_tun Op : Ar remote_tun .
|
|
|
|
.Sm on
|
|
|
|
The devices may be specified by numerical ID or the keyword
|
|
|
|
.Dq any ,
|
|
|
|
which uses the next available tunnel device.
|
|
|
|
If
|
|
|
|
.Ar remote_tun
|
|
|
|
is not specified, it defaults to
|
|
|
|
.Dq any .
|
|
|
|
The default is
|
|
|
|
.Dq any:any .
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm UsePrivilegedPort
|
|
|
|
Specifies whether to use a privileged port for outgoing connections.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes
|
|
|
|
or
|
|
|
|
.Dq no .
|
|
|
|
The default is
|
|
|
|
.Dq no .
|
2002-10-29 09:43:00 +00:00
|
|
|
If set to
|
2006-09-30 13:29:51 +00:00
|
|
|
.Dq yes ,
|
|
|
|
.Xr ssh 1
|
2002-10-29 09:43:00 +00:00
|
|
|
must be setuid root.
|
2002-06-23 14:01:54 +00:00
|
|
|
Note that this option must be set to
|
|
|
|
.Dq yes
|
2004-01-07 11:10:17 +00:00
|
|
|
for
|
2002-06-23 14:01:54 +00:00
|
|
|
.Cm RhostsRSAAuthentication
|
2004-01-07 11:10:17 +00:00
|
|
|
with older servers.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm User
|
|
|
|
Specifies the user to log in as.
|
|
|
|
This can be useful when a different user name is used on different machines.
|
|
|
|
This saves the trouble of
|
|
|
|
having to remember to give the user name on the command line.
|
|
|
|
.It Cm UserKnownHostsFile
|
2011-09-28 08:14:41 +00:00
|
|
|
Specifies one or more files to use for the user
|
|
|
|
host key database, separated by whitespace.
|
|
|
|
The default is
|
|
|
|
.Pa ~/.ssh/known_hosts ,
|
|
|
|
.Pa ~/.ssh/known_hosts2 .
|
2004-01-07 11:10:17 +00:00
|
|
|
.It Cm VerifyHostKeyDNS
|
|
|
|
Specifies whether to verify the remote key using DNS and SSHFP resource
|
|
|
|
records.
|
2004-02-26 10:38:49 +00:00
|
|
|
If this option is set to
|
|
|
|
.Dq yes ,
|
|
|
|
the client will implicitly trust keys that match a secure fingerprint
|
|
|
|
from DNS.
|
|
|
|
Insecure fingerprints will be handled as if this option was set to
|
|
|
|
.Dq ask .
|
|
|
|
If this option is set to
|
|
|
|
.Dq ask ,
|
|
|
|
information on fingerprint match will be displayed, but the user will still
|
|
|
|
need to confirm new host keys according to the
|
|
|
|
.Cm StrictHostKeyChecking
|
|
|
|
option.
|
|
|
|
The argument must be
|
|
|
|
.Dq yes ,
|
2006-09-30 13:29:51 +00:00
|
|
|
.Dq no ,
|
2004-02-26 10:38:49 +00:00
|
|
|
or
|
|
|
|
.Dq ask .
|
2004-01-07 11:10:17 +00:00
|
|
|
The default is
|
|
|
|
.Dq no .
|
|
|
|
Note that this option applies to protocol version 2 only.
|
2006-09-30 13:29:51 +00:00
|
|
|
.Pp
|
2013-09-18 17:27:38 +00:00
|
|
|
See also VERIFYING HOST KEYS in
|
2006-09-30 13:29:51 +00:00
|
|
|
.Xr ssh 1 .
|
2008-07-23 09:33:08 +00:00
|
|
|
.It Cm VisualHostKey
|
|
|
|
If this flag is set to
|
|
|
|
.Dq yes ,
|
|
|
|
an ASCII art representation of the remote host key fingerprint is
|
2009-02-24 18:49:27 +00:00
|
|
|
printed in addition to the hex fingerprint string at login and
|
|
|
|
for unknown host keys.
|
2008-07-23 09:33:08 +00:00
|
|
|
If this flag is set to
|
|
|
|
.Dq no ,
|
2009-02-24 18:49:27 +00:00
|
|
|
no fingerprint strings are printed at login and
|
|
|
|
only the hex fingerprint string will be printed for unknown host keys.
|
2008-07-23 09:33:08 +00:00
|
|
|
The default is
|
|
|
|
.Dq no .
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Cm XAuthLocation
|
2002-10-29 09:43:00 +00:00
|
|
|
Specifies the full pathname of the
|
2002-06-23 14:01:54 +00:00
|
|
|
.Xr xauth 1
|
|
|
|
program.
|
|
|
|
The default is
|
|
|
|
.Pa /usr/X11R6/bin/xauth .
|
|
|
|
.El
|
2006-09-30 13:29:51 +00:00
|
|
|
.Sh PATTERNS
|
|
|
|
A
|
|
|
|
.Em pattern
|
|
|
|
consists of zero or more non-whitespace characters,
|
|
|
|
.Sq *
|
|
|
|
(a wildcard that matches zero or more characters),
|
|
|
|
or
|
|
|
|
.Sq ?\&
|
|
|
|
(a wildcard that matches exactly one character).
|
|
|
|
For example, to specify a set of declarations for any host in the
|
|
|
|
.Dq .co.uk
|
|
|
|
set of domains,
|
|
|
|
the following pattern could be used:
|
|
|
|
.Pp
|
|
|
|
.Dl Host *.co.uk
|
|
|
|
.Pp
|
|
|
|
The following pattern
|
|
|
|
would match any host in the 192.168.0.[0-9] network range:
|
|
|
|
.Pp
|
|
|
|
.Dl Host 192.168.0.?
|
|
|
|
.Pp
|
|
|
|
A
|
|
|
|
.Em pattern-list
|
|
|
|
is a comma-separated list of patterns.
|
|
|
|
Patterns within pattern-lists may be negated
|
|
|
|
by preceding them with an exclamation mark
|
|
|
|
.Pq Sq !\& .
|
|
|
|
For example,
|
2014-01-30 10:56:49 +00:00
|
|
|
to allow a key to be used from anywhere within an organization
|
2006-09-30 13:29:51 +00:00
|
|
|
except from the
|
|
|
|
.Dq dialup
|
|
|
|
pool,
|
|
|
|
the following entry (in authorized_keys) could be used:
|
|
|
|
.Pp
|
|
|
|
.Dl from=\&"!*.dialup.example.com,*.example.com\&"
|
2002-06-23 14:01:54 +00:00
|
|
|
.Sh FILES
|
|
|
|
.Bl -tag -width Ds
|
2005-09-03 06:59:33 +00:00
|
|
|
.It Pa ~/.ssh/config
|
2002-06-23 14:01:54 +00:00
|
|
|
This is the per-user configuration file.
|
|
|
|
The format of this file is described above.
|
2006-09-30 13:29:51 +00:00
|
|
|
This file is used by the SSH client.
|
2004-10-28 16:03:53 +00:00
|
|
|
Because of the potential for abuse, this file must have strict permissions:
|
|
|
|
read/write for the user, and not accessible by others.
|
2002-06-23 14:01:54 +00:00
|
|
|
.It Pa /etc/ssh/ssh_config
|
|
|
|
Systemwide configuration file.
|
|
|
|
This file provides defaults for those
|
|
|
|
values that are not specified in the user's configuration file, and
|
|
|
|
for those users who do not have a configuration file.
|
|
|
|
This file must be world-readable.
|
|
|
|
.El
|
2004-01-07 11:10:17 +00:00
|
|
|
.Sh SEE ALSO
|
|
|
|
.Xr ssh 1
|
2002-06-23 14:01:54 +00:00
|
|
|
.Sh AUTHORS
|
|
|
|
OpenSSH is a derivative of the original and free
|
|
|
|
ssh 1.2.12 release by Tatu Ylonen.
|
|
|
|
Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
|
|
|
|
Theo de Raadt and Dug Song
|
|
|
|
removed many bugs, re-added newer features and
|
|
|
|
created OpenSSH.
|
|
|
|
Markus Friedl contributed the support for SSH
|
|
|
|
protocol versions 1.5 and 2.0.
|