File: sshd_config.html

package info (click to toggle)
libconfig-model-openssh-perl 2.9.9.1-1
links: PTS, VCS
area: main
in suites: forky, sid, trixie
size: 640 kB
sloc: perl: 4,596; makefile: 12
file content (1665 lines) | stat: -rw-r--r-- 63,416 bytes
parent folder | download | duplicates (3)
<!-- Creator     : groff version 1.22.4 -->
<!-- CreationDate: Tue Mar 12 14:47:44 2019 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
       h1      { text-align: center }
</style>
<title></title>
</head>
<body>

<hr>


<p>SSHD_CONFIG(5) BSD File Formats Manual
SSHD_CONFIG(5)</p>

<p style="margin-top: 1em"><b>NAME</b></p>

<p style="margin-left:6%;"><b>sshd_config</b> &mdash;
OpenSSH SSH daemon configuration file</p>

<p style="margin-top: 1em"><b>DESCRIPTION</b></p>

<p style="margin-left:6%;">sshd(8) reads configuration data
from <i>/etc/ssh/sshd_config</i> (or the file specified with
<b>-f</b> on the command line). The file contains
keyword-argument pairs, one per line. For each keyword, the
first obtained value will be used. Lines starting with
&rsquo;#&rsquo; and empty lines are interpreted as comments.
Arguments may optionally be enclosed in double quotes
(&quot;) in order to represent arguments containing
spaces.</p>

<p style="margin-left:6%; margin-top: 1em">Note that the
Debian <b>openssh-server</b> package sets several options as
standard in <i>/etc/ssh/sshd_config</i> which are not the
default in sshd(8):</p>

<p style="margin-top: 1em"><b>&bull;</b></p>


<p style="margin-left:19%;"><b>ChallengeResponseAuthentication</b>
no</p>

<p><b>&bull;</b></p>

<p style="margin-left:19%;"><b>X11Forwarding</b> yes</p>

<p><b>&bull;</b></p>

<p style="margin-left:19%;"><b>PrintMotd</b> no</p>

<p><b>&bull;</b></p>

<p style="margin-left:19%;"><b>AcceptEnv</b> LANG LC_*</p>

<p><b>&bull;</b></p>

<p style="margin-left:19%;"><b>Subsystem</b> sftp
/usr/lib/openssh/sftp-server</p>

<p><b>&bull;</b></p>

<p style="margin-left:19%;"><b>UsePAM</b> yes</p>

<p style="margin-left:6%; margin-top: 1em">The possible
keywords and their meanings are as follows (note that
keywords are case-insensitive and arguments are
case-sensitive):</p>

<p style="margin-top: 1em"><b>AcceptEnv</b></p>

<p style="margin-left:17%;">Specifies what environment
variables sent by the client will be copied into the
session&rsquo;s environ(7). See <b>SendEnv</b> and
<b>SetEnv</b> in ssh_config(5) for how to configure the
client. The TERM environment variable is always accepted
whenever the client requests a pseudo-terminal as it is
required by the protocol. Variables are specified by name,
which may contain the wildcard characters &rsquo;*&rsquo;
and &rsquo;?&rsquo;. Multiple environment variables may be
separated by whitespace or spread across multiple
<b>AcceptEnv</b> directives. Be warned that some environment
variables could be used to bypass restricted user
environments. For this reason, care should be taken in the
use of this directive. The default is not to accept any
environment variables.</p>

<p style="margin-top: 1em"><b>AddressFamily</b></p>

<p style="margin-left:17%;">Specifies which address family
should be used by sshd(8). Valid arguments are <b>any</b>
(the default), <b>inet</b> (use IPv4 only), or <b>inet6</b>
(use IPv6 only).</p>

<p style="margin-top: 1em"><b>AllowAgentForwarding</b></p>

<p style="margin-left:17%;">Specifies whether ssh-agent(1)
forwarding is permitted. The default is <b>yes</b>. Note
that disabling agent forwarding does not improve security
unless users are also denied shell access, as they can
always install their own forwarders.</p>

<p style="margin-top: 1em"><b>AllowGroups</b></p>

<p style="margin-left:17%;">This keyword can be followed by
a list of group name patterns, separated by spaces. If
specified, login is allowed only for users whose primary
group or supplementary group list matches one of the
patterns. Only group names are valid; a numerical group ID
is not recognized. By default, login is allowed for all
groups. The allow/deny directives are processed in the
following order: <b>DenyUsers</b>, <b>AllowUsers</b>,
<b>DenyGroups</b>, and finally <b>AllowGroups</b>.</p>

<p style="margin-left:17%; margin-top: 1em">See PATTERNS in
ssh_config(5) for more information on patterns.</p>


<p style="margin-top: 1em"><b>AllowStreamLocalForwarding</b></p>

<p style="margin-left:17%;">Specifies whether StreamLocal
(Unix-domain socket) forwarding is permitted. The available
options are <b>yes</b> (the default) or <b>all</b> to allow
StreamLocal forwarding, <b>no</b> to prevent all StreamLocal
forwarding, <b>local</b> to allow local (from the
perspective of ssh(1)) forwarding only or <b>remote</b> to
allow remote forwarding only. Note that disabling
StreamLocal forwarding does not improve security unless
users are also denied shell access, as they can always
install their own forwarders.</p>

<p style="margin-top: 1em"><b>AllowTcpForwarding</b></p>

<p style="margin-left:17%;">Specifies whether TCP
forwarding is permitted. The available options are
<b>yes</b> (the default) or <b>all</b> to allow TCP
forwarding, <b>no</b> to prevent all TCP forwarding,
<b>local</b> to allow local (from the perspective of ssh(1))
forwarding only or <b>remote</b> to allow remote forwarding
only. Note that disabling TCP forwarding does not improve
security unless users are also denied shell access, as they
can always install their own forwarders.</p>

<p style="margin-top: 1em"><b>AllowUsers</b></p>

<p style="margin-left:17%;">This keyword can be followed by
a list of user name patterns, separated by spaces. If
specified, login is allowed only for user names that match
one of the patterns. Only user names are valid; a numerical
user ID is not recognized. By default, login is allowed for
all users. If the pattern takes the form USER@HOST then USER
and HOST are separately checked, restricting logins to
particular users from particular hosts. HOST criteria may
additionally contain addresses to match in CIDR
address/masklen format. The allow/deny directives are
processed in the following order: <b>DenyUsers</b>,
<b>AllowUsers</b>, <b>DenyGroups</b>, and finally
<b>AllowGroups</b>.</p>

<p style="margin-left:17%; margin-top: 1em">See PATTERNS in
ssh_config(5) for more information on patterns.</p>


<p style="margin-top: 1em"><b>AuthenticationMethods</b></p>

<p style="margin-left:17%;">Specifies the authentication
methods that must be successfully completed for a user to be
granted access. This option must be followed by one or more
lists of comma-separated authentication method names, or by
the single string <b>any</b> to indicate the default
behaviour of accepting any single authentication method. If
the default is overridden, then successful authentication
requires completion of every method in at least one of these
lists.</p>

<p style="margin-left:17%; margin-top: 1em">For example,
&quot;publickey,password
publickey,keyboard-interactive&quot; would require the user
to complete public key authentication, followed by either
password or keyboard interactive authentication. Only
methods that are next in one or more lists are offered at
each stage, so for this example it would not be possible to
attempt password or keyboard-interactive authentication
before public key.</p>

<p style="margin-left:17%; margin-top: 1em">For keyboard
interactive authentication it is also possible to restrict
authentication to a specific device by appending a colon
followed by the device identifier <b>bsdauth</b> or
<b>pam</b>. depending on the server configuration. For
example, &quot;keyboard-interactive:bsdauth&quot; would
restrict keyboard interactive authentication to the
<b>bsdauth</b> device.</p>

<p style="margin-left:17%; margin-top: 1em">If the
publickey method is listed more than once, sshd(8) verifies
that keys that have been used successfully are not reused
for subsequent authentications. For example,
&quot;publickey,publickey&quot; requires successful
authentication using two different public keys.</p>

<p style="margin-left:17%; margin-top: 1em">Note that each
authentication method listed should also be explicitly
enabled in the configuration.</p>

<p style="margin-left:17%; margin-top: 1em">The available
authentication methods are: &quot;gssapi-with-mic&quot;,
&quot;hostbased&quot;, &quot;keyboard-interactive&quot;,
&quot;none&quot; (used for access to password-less accounts
when <b>PermitEmptyPasswords</b> is enabled),
&quot;password&quot; and &quot;publickey&quot;.</p>


<p style="margin-top: 1em"><b>AuthorizedKeysCommand</b></p>

<p style="margin-left:17%;">Specifies a program to be used
to look up the user&rsquo;s public keys. The program must be
owned by root, not writable by group or others and specified
by an absolute path. Arguments to
<b>AuthorizedKeysCommand</b> accept the tokens described in
the <i>TOKENS</i> section. If no arguments are specified
then the username of the target user is used.</p>

<p style="margin-left:17%; margin-top: 1em">The program
should produce on standard output zero or more lines of
authorized_keys output (see <i>AUTHORIZED_KEYS</i> in
sshd(8)). If a key supplied by <b>AuthorizedKeysCommand</b>
does not successfully authenticate and authorize the user
then public key authentication continues using the usual
<b>AuthorizedKeysFile</b> files. By default, no
<b>AuthorizedKeysCommand</b> is run.</p>


<p style="margin-top: 1em"><b>AuthorizedKeysCommandUser</b></p>

<p style="margin-left:17%;">Specifies the user under whose
account the <b>AuthorizedKeysCommand</b> is run. It is
recommended to use a dedicated user that has no other role
on the host than running authorized keys commands. If
<b>AuthorizedKeysCommand</b> is specified but
<b>AuthorizedKeysCommandUser</b> is not, then sshd(8) will
refuse to start.</p>

<p style="margin-top: 1em"><b>AuthorizedKeysFile</b></p>

<p style="margin-left:17%;">Specifies the file that
contains the public keys used for user authentication. The
format is described in the <i>AUTHORIZED_KEYS FILE
FORMAT</i> section of sshd(8). Arguments to
<b>AuthorizedKeysFile</b> accept the tokens described in the
<i>TOKENS</i> section. After expansion,
<b>AuthorizedKeysFile</b> is taken to be an absolute path or
one relative to the user&rsquo;s home directory. Multiple
files may be listed, separated by whitespace. Alternately
this option may be set to <b>none</b> to skip checking for
user keys in files. The default is
&quot;.ssh/authorized_keys .ssh/authorized_keys2&quot;.</p>


<p style="margin-top: 1em"><b>AuthorizedPrincipalsCommand</b></p>

<p style="margin-left:17%;">Specifies a program to be used
to generate the list of allowed certificate principals as
per <b>AuthorizedPrincipalsFile</b>. The program must be
owned by root, not writable by group or others and specified
by an absolute path. Arguments to
<b>AuthorizedPrincipalsCommand</b> accept the tokens
described in the <i>TOKENS</i> section. If no arguments are
specified then the username of the target user is used.</p>

<p style="margin-left:17%; margin-top: 1em">The program
should produce on standard output zero or more lines of
<b>AuthorizedPrincipalsFile</b> output. If either
<b>AuthorizedPrincipalsCommand</b> or
<b>AuthorizedPrincipalsFile</b> is specified, then
certificates offered by the client for authentication must
contain a principal that is listed. By default, no
<b>AuthorizedPrincipalsCommand</b> is run.</p>


<p style="margin-top: 1em"><b>AuthorizedPrincipalsCommandUser</b></p>

<p style="margin-left:17%;">Specifies the user under whose
account the <b>AuthorizedPrincipalsCommand</b> is run. It is
recommended to use a dedicated user that has no other role
on the host than running authorized principals commands. If
<b>AuthorizedPrincipalsCommand</b> is specified but
<b>AuthorizedPrincipalsCommandUser</b> is not, then sshd(8)
will refuse to start.</p>


<p style="margin-top: 1em"><b>AuthorizedPrincipalsFile</b></p>

<p style="margin-left:17%;">Specifies a file that lists
principal names that are accepted for certificate
authentication. When using certificates signed by a key
listed in <b>TrustedUserCAKeys</b>, this file lists names,
one of which must appear in the certificate for it to be
accepted for authentication. Names are listed one per line
preceded by key options (as described in <i>AUTHORIZED_KEYS
FILE FORMAT</i> in sshd(8)). Empty lines and comments
starting with &rsquo;#&rsquo; are ignored.</p>

<p style="margin-left:17%; margin-top: 1em">Arguments to
<b>AuthorizedPrincipalsFile</b> accept the tokens described
in the <i>TOKENS</i> section. After expansion,
<b>AuthorizedPrincipalsFile</b> is taken to be an absolute
path or one relative to the user&rsquo;s home directory. The
default is <b>none</b>, i.e. not to use a principals file
&ndash; in this case, the username of the user must appear
in a certificate&rsquo;s principals list for it to be
accepted.</p>

<p style="margin-left:17%; margin-top: 1em">Note that
<b>AuthorizedPrincipalsFile</b> is only used when
authentication proceeds using a CA listed in
<b>TrustedUserCAKeys</b> and is not consulted for
certification authorities trusted via
<i>~/.ssh/authorized_keys</i>, though the <b>principals=</b>
key option offers a similar facility (see sshd(8) for
details).</p>

<p style="margin-top: 1em"><b>Banner</b></p>

<p style="margin-left:17%; margin-top: 1em">The contents of
the specified file are sent to the remote user before
authentication is allowed. If the argument is <b>none</b>
then no banner is displayed. By default, no banner is
displayed.</p>


<p style="margin-top: 1em"><b>CASignatureAlgorithms</b></p>

<p style="margin-left:17%;">Specifies which algorithms are
allowed for signing of certificates by certificate
authorities (CAs). The default is:</p>


<p style="margin-left:24%; margin-top: 1em">ecdsa-sha2-nistp256.ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
<br>
ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa</p>

<p style="margin-left:17%; margin-top: 1em">Certificates
signed using other algorithms will not be accepted for
public key or host-based authentication.</p>


<p style="margin-top: 1em"><b>ChallengeResponseAuthentication</b></p>

<p style="margin-left:17%;">Specifies whether
challenge-response authentication is allowed (e.g. via PAM).
The default is <b>yes</b>.</p>

<p style="margin-top: 1em"><b>ChrootDirectory</b></p>

<p style="margin-left:17%;">Specifies the pathname of a
directory to chroot(2) to after authentication. At session
startup sshd(8) checks that all components of the pathname
are root-owned directories which are not writable by any
other user or group. After the chroot, sshd(8) changes the
working directory to the user&rsquo;s home directory.
Arguments to <b>ChrootDirectory</b> accept the tokens
described in the <i>TOKENS</i> section.</p>

<p style="margin-left:17%; margin-top: 1em">The
<b>ChrootDirectory</b> must contain the necessary files and
directories to support the user&rsquo;s session. For an
interactive session this requires at least a shell,
typically sh(1), and basic <i>/dev</i> nodes such as
null(4), zero(4), stdin(4), stdout(4), stderr(4), and tty(4)
devices. For file transfer sessions using SFTP no additional
configuration of the environment is necessary if the
in-process sftp-server is used, though sessions which use
logging may require <i>/dev/log</i> inside the chroot
directory on some operating systems (see sftp-server(8) for
details).</p>

<p style="margin-left:17%; margin-top: 1em">For safety, it
is very important that the directory hierarchy be prevented
from modification by other processes on the system
(especially those outside the jail). Misconfiguration can
lead to unsafe environments which sshd(8) cannot detect.</p>

<p style="margin-left:17%; margin-top: 1em">The default is
<b>none</b>, indicating not to chroot(2).</p>

<p style="margin-top: 1em"><b>Ciphers</b></p>

<p style="margin-left:17%;">Specifies the ciphers allowed.
Multiple ciphers must be comma-separated. If the specified
value begins with a &rsquo;+&rsquo; character, then the
specified ciphers will be appended to the default set
instead of replacing them. If the specified value begins
with a &rsquo;-&rsquo; character, then the specified ciphers
(including wildcards) will be removed from the default set
instead of replacing them.</p>

<p style="margin-left:17%; margin-top: 1em">The supported
ciphers are:</p>

<p style="margin-left:24%; margin-top: 1em">3des-cbc <br>
aes128-cbc <br>
aes192-cbc <br>
aes256-cbc <br>
aes128-ctr <br>
aes192-ctr <br>
aes256-ctr <br>
aes128-gcm@openssh.com <br>
aes256-gcm@openssh.com <br>
chacha20-poly1305@openssh.com</p>

<p style="margin-left:17%; margin-top: 1em">The default
is:</p>


<p style="margin-left:24%; margin-top: 1em">chacha20-poly1305@openssh.com,
<br>
aes128-ctr,aes192-ctr,aes256-ctr, <br>
aes128-gcm@openssh.com,aes256-gcm@openssh.com</p>

<p style="margin-left:17%; margin-top: 1em">The list of
available ciphers may also be obtained using &quot;ssh -Q
cipher&quot;.</p>

<p style="margin-top: 1em"><b>ClientAliveCountMax</b></p>

<p style="margin-left:17%;">Sets the number of client alive
messages which may be sent without sshd(8) receiving any
messages back from the client. If this threshold is reached
while client alive messages are being sent, sshd will
disconnect the client, terminating the session. It is
important to note that the use of client alive messages is
very different from <b>TCPKeepAlive</b>. The client alive
messages are sent through the encrypted channel and
therefore will not be spoofable. The TCP keepalive option
enabled by <b>TCPKeepAlive</b> is spoofable. The client
alive mechanism is valuable when the client or server depend
on knowing when a connection has become inactive.</p>

<p style="margin-left:17%; margin-top: 1em">The default
value is 3. If <b>ClientAliveInterval</b> is set to 15, and
<b>ClientAliveCountMax</b> is left at the default,
unresponsive SSH clients will be disconnected after
approximately 45 seconds.</p>

<p style="margin-top: 1em"><b>ClientAliveInterval</b></p>

<p style="margin-left:17%;">Sets a timeout interval in
seconds after which if no data has been received from the
client, sshd(8) will send a message through the encrypted
channel to request a response from the client. The default
is 0, indicating that these messages will not be sent to the
client.</p>

<p style="margin-top: 1em"><b>Compression</b></p>

<p style="margin-left:17%;">Specifies whether compression
is enabled after the user has authenticated successfully.
The argument must be <b>yes</b>, <b>delayed</b> (a legacy
synonym for <b>yes</b>) or <b>no</b>. The default is
<b>yes</b>.</p>

<p style="margin-top: 1em"><b>DebianBanner</b></p>

<p style="margin-left:17%;">Specifies whether the
distribution-specified extra version suffix is included
during initial protocol handshake. The default is
<b>yes</b>.</p>

<p style="margin-top: 1em"><b>DenyGroups</b></p>

<p style="margin-left:17%;">This keyword can be followed by
a list of group name patterns, separated by spaces. Login is
disallowed for users whose primary group or supplementary
group list matches one of the patterns. Only group names are
valid; a numerical group ID is not recognized. By default,
login is allowed for all groups. The allow/deny directives
are processed in the following order: <b>DenyUsers</b>,
<b>AllowUsers</b>, <b>DenyGroups</b>, and finally
<b>AllowGroups</b>.</p>

<p style="margin-left:17%; margin-top: 1em">See PATTERNS in
ssh_config(5) for more information on patterns.</p>

<p style="margin-top: 1em"><b>DenyUsers</b></p>

<p style="margin-left:17%;">This keyword can be followed by
a list of user name patterns, separated by spaces. Login is
disallowed for user names that match one of the patterns.
Only user names are valid; a numerical user ID is not
recognized. By default, login is allowed for all users. If
the pattern takes the form USER@HOST then USER and HOST are
separately checked, restricting logins to particular users
from particular hosts. HOST criteria may additionally
contain addresses to match in CIDR address/masklen format.
The allow/deny directives are processed in the following
order: <b>DenyUsers</b>, <b>AllowUsers</b>,
<b>DenyGroups</b>, and finally <b>AllowGroups</b>.</p>

<p style="margin-left:17%; margin-top: 1em">See PATTERNS in
ssh_config(5) for more information on patterns.</p>

<p style="margin-top: 1em"><b>DisableForwarding</b></p>

<p style="margin-left:17%;">Disables all forwarding
features, including X11, ssh-agent(1), TCP and StreamLocal.
This option overrides all other forwarding-related options
and may simplify restricted configurations.</p>

<p style="margin-top: 1em"><b>ExposeAuthInfo</b></p>

<p style="margin-left:17%;">Writes a temporary file
containing a list of authentication methods and public
credentials (e.g. keys) used to authenticate the user. The
location of the file is exposed to the user session through
the SSH_USER_AUTH environment variable. The default is
<b>no</b>.</p>

<p style="margin-top: 1em"><b>FingerprintHash</b></p>

<p style="margin-left:17%;">Specifies the hash algorithm
used when logging key fingerprints. Valid options are:
<b>md5</b> and <b>sha256</b>. The default is
<b>sha256</b>.</p>

<p style="margin-top: 1em"><b>ForceCommand</b></p>

<p style="margin-left:17%;">Forces the execution of the
command specified by <b>ForceCommand</b>, ignoring any
command supplied by the client and <i>~/.ssh/rc</i> if
present. The command is invoked by using the user&rsquo;s
login shell with the -c option. This applies to shell,
command, or subsystem execution. It is most useful inside a
<b>Match</b> block. The command originally supplied by the
client is available in the SSH_ORIGINAL_COMMAND environment
variable. Specifying a command of <b>internal-sftp</b> will
force the use of an in-process SFTP server that requires no
support files when used with <b>ChrootDirectory</b>. The
default is <b>none</b>.</p>

<p style="margin-top: 1em"><b>GatewayPorts</b></p>

<p style="margin-left:17%;">Specifies whether remote hosts
are allowed to connect to ports forwarded for the client. By
default, sshd(8) binds remote port forwardings to the
loopback address. This prevents other remote hosts from
connecting to forwarded ports. <b>GatewayPorts</b> can be
used to specify that sshd should allow remote port
forwardings to bind to non-loopback addresses, thus allowing
other hosts to connect. The argument may be <b>no</b> to
force remote port forwardings to be available to the local
host only, <b>yes</b> to force remote port forwardings to
bind to the wildcard address, or <b>clientspecified</b> to
allow the client to select the address to which the
forwarding is bound. The default is <b>no</b>.</p>

<p style="margin-top: 1em"><b>GSSAPIAuthentication</b></p>

<p style="margin-left:17%;">Specifies whether user
authentication based on GSSAPI is allowed. The default is
<b>no</b>.</p>

<p style="margin-top: 1em"><b>GSSAPIKeyExchange</b></p>

<p style="margin-left:17%;">Specifies whether key exchange
based on GSSAPI is allowed. GSSAPI key exchange
doesn&rsquo;t rely on ssh keys to verify host identity. The
default is <b>no</b>.</p>


<p style="margin-top: 1em"><b>GSSAPICleanupCredentials</b></p>

<p style="margin-left:17%;">Specifies whether to
automatically destroy the user&rsquo;s credentials cache on
logout. The default is <b>yes</b>.</p>


<p style="margin-top: 1em"><b>GSSAPIStrictAcceptorCheck</b></p>

<p style="margin-left:17%;">Determines whether to be strict
about the identity of the GSSAPI acceptor a client
authenticates against. If set to <b>yes</b> then the client
must authenticate against the host service on the current
hostname. If set to <b>no</b> then the client may
authenticate against any service key stored in the
machine&rsquo;s default store. This facility is provided to
assist with operation on multi homed machines. The default
is <b>yes</b>.</p>


<p style="margin-top: 1em"><b>GSSAPIStoreCredentialsOnRekey</b></p>

<p style="margin-left:17%;">Controls whether the
user&rsquo;s GSSAPI credentials should be updated following
a successful connection rekeying. This option can be used to
accepted renewed or updated credentials from a compatible
client. The default is <b>no</b>.</p>


<p style="margin-top: 1em"><b>HostbasedAcceptedKeyTypes</b></p>

<p style="margin-left:17%;">Specifies the key types that
will be accepted for hostbased authentication as a list of
comma-separated patterns. Alternately if the specified value
begins with a &rsquo;+&rsquo; character, then the specified
key types will be appended to the default set instead of
replacing them. If the specified value begins with a
&rsquo;-&rsquo; character, then the specified key types
(including wildcards) will be removed from the default set
instead of replacing them. The default for this option
is:</p>


<p style="margin-left:21%; margin-top: 1em">ecdsa-sha2-nistp256-cert-v01@openssh.com,
<br>
ecdsa-sha2-nistp384-cert-v01@openssh.com, <br>
ecdsa-sha2-nistp521-cert-v01@openssh.com, <br>
ssh-ed25519-cert-v01@openssh.com, <br>

rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com,
<br>
ssh-rsa-cert-v01@openssh.com, <br>

ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
<br>
ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa</p>

<p style="margin-left:17%; margin-top: 1em">The list of
available key types may also be obtained using &quot;ssh -Q
key&quot;.</p>


<p style="margin-top: 1em"><b>HostbasedAuthentication</b></p>

<p style="margin-left:17%;">Specifies whether rhosts or
/etc/hosts.equiv authentication together with successful
public key client host authentication is allowed (host-based
authentication). The default is <b>no</b>.</p>


<p style="margin-top: 1em"><b>HostbasedUsesNameFromPacketOnly</b></p>

<p style="margin-left:17%;">Specifies whether or not the
server will attempt to perform a reverse name lookup when
matching the name in the <i>~/.shosts</i>, <i>~/.rhosts</i>,
and <i>/etc/hosts.equiv</i> files during
<b>HostbasedAuthentication</b>. A setting of <b>yes</b>
means that sshd(8) uses the name supplied by the client
rather than attempting to resolve the name from the TCP
connection itself. The default is <b>no</b>.</p>

<p style="margin-top: 1em"><b>HostCertificate</b></p>

<p style="margin-left:17%;">Specifies a file containing a
public host certificate. The certificate&rsquo;s public key
must match a private host key already specified by
<b>HostKey</b>. The default behaviour of sshd(8) is not to
load any certificates.</p>

<p style="margin-top: 1em"><b>HostKey</b></p>

<p style="margin-left:17%;">Specifies a file containing a
private host key used by SSH. The defaults are
<i>/etc/ssh/ssh_host_ecdsa_key</i>,
<i>/etc/ssh/ssh_host_ed25519_key</i> and
<i>/etc/ssh/ssh_host_rsa_key</i>.</p>

<p style="margin-left:17%; margin-top: 1em">Note that
sshd(8) will refuse to use a file if it is
group/world-accessible and that the <b>HostKeyAlgorithms</b>
option restricts which of the keys are actually used by
sshd(8).</p>

<p style="margin-left:17%; margin-top: 1em">It is possible
to have multiple host key files. It is also possible to
specify public host key files instead. In this case
operations on the private key will be delegated to an
ssh-agent(1).</p>

<p style="margin-top: 1em"><b>HostKeyAgent</b></p>

<p style="margin-left:17%;">Identifies the UNIX-domain
socket used to communicate with an agent that has access to
the private host keys. If the string
&quot;SSH_AUTH_SOCK&quot; is specified, the location of the
socket will be read from the SSH_AUTH_SOCK environment
variable.</p>

<p style="margin-top: 1em"><b>HostKeyAlgorithms</b></p>

<p style="margin-left:17%;">Specifies the host key
algorithms that the server offers. The default for this
option is:</p>


<p style="margin-left:21%; margin-top: 1em">ecdsa-sha2-nistp256-cert-v01@openssh.com,
<br>
ecdsa-sha2-nistp384-cert-v01@openssh.com, <br>
ecdsa-sha2-nistp521-cert-v01@openssh.com, <br>
ssh-ed25519-cert-v01@openssh.com, <br>

rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com,
<br>
ssh-rsa-cert-v01@openssh.com, <br>

ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
<br>
ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa</p>

<p style="margin-left:17%; margin-top: 1em">The list of
available key types may also be obtained using &quot;ssh -Q
key&quot;.</p>

<p style="margin-top: 1em"><b>IgnoreRhosts</b></p>

<p style="margin-left:17%;">Specifies that <i>.rhosts</i>
and <i>.shosts</i> files will not be used in
<b>HostbasedAuthentication</b>.</p>


<p style="margin-left:17%; margin-top: 1em"><i>/etc/hosts.equiv</i>
and <i>/etc/ssh/shosts.equiv</i> are still used. The default
is <b>yes</b>.</p>

<p style="margin-top: 1em"><b>IgnoreUserKnownHosts</b></p>

<p style="margin-left:17%;">Specifies whether sshd(8)
should ignore the user&rsquo;s <i>~/.ssh/known_hosts</i>
during <b>HostbasedAuthentication</b> and use only the
system-wide known hosts file <i>/etc/ssh/known_hosts</i>.
The default is <b>no</b>.</p>

<p style="margin-top: 1em"><b>IPQoS</b></p>

<p style="margin-left:17%; margin-top: 1em">Specifies the
IPv4 type-of-service or DSCP class for the connection.
Accepted values are <b>af11</b>, <b>af12</b>, <b>af13</b>,
<b>af21</b>, <b>af22</b>, <b>af23</b>, <b>af31</b>,
<b>af32</b>, <b>af33</b>, <b>af41</b>, <b>af42</b>,
<b>af43</b>, <b>cs0</b>, <b>cs1</b>, <b>cs2</b>, <b>cs3</b>,
<b>cs4</b>, <b>cs5</b>, <b>cs6</b>, <b>cs7</b>, <b>ef</b>,
<b>lowdelay</b>, <b>throughput</b>, <b>reliability</b>, a
numeric value, or <b>none</b> to use the operating system
default. 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 <b>af21</b> (Low-Latency Data) for
interactive sessions and <b>cs1</b> (Lower Effort) for
non-interactive sessions.</p>


<p style="margin-top: 1em"><b>KbdInteractiveAuthentication</b></p>

<p style="margin-left:17%;">Specifies whether to allow
keyboard-interactive authentication. The argument to this
keyword must be <b>yes</b> or <b>no</b>. The default is to
use whatever value <b>ChallengeResponseAuthentication</b> is
set to (by default <b>yes</b>).</p>


<p style="margin-top: 1em"><b>KerberosAuthentication</b></p>

<p style="margin-left:17%;">Specifies whether the password
provided by the user for <b>PasswordAuthentication</b> will
be validated through the Kerberos KDC. To use this option,
the server needs a Kerberos servtab which allows the
verification of the KDC&rsquo;s identity. The default is
<b>no</b>.</p>

<p style="margin-top: 1em"><b>KerberosGetAFSToken</b></p>

<p style="margin-left:17%;">If AFS is active and the user
has a Kerberos 5 TGT, attempt to acquire an AFS token before
accessing the user&rsquo;s home directory. The default is
<b>no</b>.</p>


<p style="margin-top: 1em"><b>KerberosOrLocalPasswd</b></p>

<p style="margin-left:17%;">If password authentication
through Kerberos fails then the password will be validated
via any additional local mechanism such as
<i>/etc/passwd</i>. The default is <b>yes</b>.</p>


<p style="margin-top: 1em"><b>KerberosTicketCleanup</b></p>

<p style="margin-left:17%;">Specifies whether to
automatically destroy the user&rsquo;s ticket cache file on
logout. The default is <b>yes</b>.</p>

<p style="margin-top: 1em"><b>KexAlgorithms</b></p>

<p style="margin-left:17%;">Specifies the available KEX
(Key Exchange) algorithms. Multiple algorithms must be
comma-separated. Alternately if the specified value begins
with a &rsquo;+&rsquo; character, then the specified methods
will be appended to the default set instead of replacing
them. If the specified value begins with a &rsquo;-&rsquo;
character, then the specified methods (including wildcards)
will be removed from the default set instead of replacing
them. The supported algorithms are:</p>


<p style="margin-left:24%; margin-top: 1em">curve25519-sha256
<br>
curve25519-sha256@libssh.org <br>
diffie-hellman-group1-sha1 <br>
diffie-hellman-group14-sha1 <br>
diffie-hellman-group14-sha256 <br>
diffie-hellman-group16-sha512 <br>
diffie-hellman-group18-sha512 <br>
diffie-hellman-group-exchange-sha1 <br>
diffie-hellman-group-exchange-sha256 <br>
ecdh-sha2-nistp256 <br>
ecdh-sha2-nistp384 <br>
ecdh-sha2-nistp521</p>

<p style="margin-left:17%; margin-top: 1em">The default
is:</p>


<p style="margin-left:24%; margin-top: 1em">curve25519-sha256,curve25519-sha256@libssh.org,
<br>
ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,
<br>
diffie-hellman-group-exchange-sha256, <br>

diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,
<br>

diffie-hellman-group14-sha256,diffie-hellman-group14-sha1</p>

<p style="margin-left:17%; margin-top: 1em">The list of
available key exchange algorithms may also be obtained using
&quot;ssh -Q kex&quot;.</p>

<p style="margin-top: 1em"><b>ListenAddress</b></p>

<p style="margin-left:17%;">Specifies the local addresses
sshd(8) should listen on. The following forms may be
used:</p>


<p style="margin-left:24%; margin-top: 1em"><b>ListenAddress</b>
<i>hostname</i>|<i>address</i> [<b>rdomain</b>
<i>domain</i>] <b><br>
ListenAddress</b> <i>hostname</i>:<i>port</i>
[<b>rdomain</b> <i>domain</i>] <b><br>
ListenAddress</b> <i>IPv4_address</i>:<i>port</i>
[<b>rdomain</b> <i>domain</i>] <b><br>
ListenAddress</b> [</p>

<p><i>hostname</i>|<i>address</i> ]:<i>port</i>
[<b>rdomain</b> <i>domain</i>]</p>

<p style="margin-left:17%; margin-top: 1em">The optional
<b>rdomain</b> qualifier requests sshd(8) listen in an
explicit routing domain. If <i>port</i> is not specified,
sshd will listen on the address and all <b>Port</b> options
specified. The default is to listen on all local addresses
on the current default routing domain. Multiple
<b>ListenAddress</b> options are permitted. For more
information on routing domains, see rdomain(4).</p>

<p style="margin-top: 1em"><b>LoginGraceTime</b></p>

<p style="margin-left:17%;">The server disconnects after
this time if the user has not successfully logged in. If the
value is 0, there is no time limit. The default is 120
seconds.</p>

<p style="margin-top: 1em"><b>LogLevel</b></p>

<p style="margin-left:17%;">Gives the verbosity level that
is used when logging messages from sshd(8). The possible
values are: QUIET, FATAL, ERROR, INFO, VERBOSE, DEBUG,
DEBUG1, DEBUG2, and DEBUG3. The default is INFO. DEBUG and
DEBUG1 are equivalent. DEBUG2 and DEBUG3 each specify higher
levels of debugging output. Logging with a DEBUG level
violates the privacy of users and is not recommended.</p>

<p style="margin-top: 1em"><b>MACs</b></p>

<p style="margin-left:17%; margin-top: 1em">Specifies the
available MAC (message authentication code) algorithms. The
MAC algorithm is used for data integrity protection.
Multiple algorithms must be comma-separated. If the
specified value begins with a &rsquo;+&rsquo; character,
then the specified algorithms will be appended to the
default set instead of replacing them. If the specified
value begins with a &rsquo;-&rsquo; character, then the
specified algorithms (including wildcards) will be removed
from the default set instead of replacing them.</p>

<p style="margin-left:17%; margin-top: 1em">The algorithms
that contain &quot;-etm&quot; calculate the MAC after
encryption (encrypt-then-mac). These are considered safer
and their use recommended. The supported MACs are:</p>

<p style="margin-left:24%; margin-top: 1em">hmac-md5 <br>
hmac-md5-96 <br>
hmac-sha1 <br>
hmac-sha1-96 <br>
hmac-sha2-256 <br>
hmac-sha2-512 <br>
umac-64@openssh.com <br>
umac-128@openssh.com <br>
hmac-md5-etm@openssh.com <br>
hmac-md5-96-etm@openssh.com <br>
hmac-sha1-etm@openssh.com <br>
hmac-sha1-96-etm@openssh.com <br>
hmac-sha2-256-etm@openssh.com <br>
hmac-sha2-512-etm@openssh.com <br>
umac-64-etm@openssh.com <br>
umac-128-etm@openssh.com</p>

<p style="margin-left:17%; margin-top: 1em">The default
is:</p>


<p style="margin-left:24%; margin-top: 1em">umac-64-etm@openssh.com,umac-128-etm@openssh.com,
<br>

hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,
<br>
hmac-sha1-etm@openssh.com, <br>
umac-64@openssh.com,umac-128@openssh.com, <br>
hmac-sha2-256,hmac-sha2-512,hmac-sha1</p>

<p style="margin-left:17%; margin-top: 1em">The list of
available MAC algorithms may also be obtained using
&quot;ssh -Q mac&quot;.</p>

<p style="margin-top: 1em"><b>Match</b></p>

<p style="margin-left:17%; margin-top: 1em">Introduces a
conditional block. If all of the criteria on the
<b>Match</b> line are satisfied, the keywords on the
following lines override those set in the global section of
the config file, until either another <b>Match</b> line or
the end of the file. If a keyword appears in multiple
<b>Match</b> blocks that are satisfied, only the first
instance of the keyword is applied.</p>

<p style="margin-left:17%; margin-top: 1em">The arguments
to <b>Match</b> are one or more criteria-pattern pairs or
the single token <b>All</b> which matches all criteria. The
available criteria are <b>User</b>, <b>Group</b>,
<b>Host</b>, <b>LocalAddress</b>, <b>LocalPort</b>,
<b>RDomain</b>, and <b>Address</b> (with <b>RDomain</b>
representing the rdomain(4) on which the connection was
received.)</p>

<p style="margin-left:17%; margin-top: 1em">The match
patterns may consist of single entries or comma-separated
lists and may use the wildcard and negation operators
described in the <i>PATTERNS</i> section of
ssh_config(5).</p>

<p style="margin-left:17%; margin-top: 1em">The patterns in
an <b>Address</b> criteria may additionally contain
addresses to match in CIDR address/masklen format, such as
192.0.2.0/24 or 2001:db8::/32. Note that the mask length
provided must be consistent with the address - it is an
error to specify a mask length that is too long for the
address or one with bits set in this host portion of the
address. For example, 192.0.2.0/33 and 192.0.2.0/8,
respectively.</p>

<p style="margin-left:17%; margin-top: 1em">Only a subset
of keywords may be used on the lines following a
<b>Match</b> keyword. Available keywords are
<b>AcceptEnv</b>, <b>AllowAgentForwarding</b>,
<b>AllowGroups</b>, <b>AllowStreamLocalForwarding</b>,
<b>AllowTcpForwarding</b>, <b>AllowUsers</b>,
<b>AuthenticationMethods</b>, <b>AuthorizedKeysCommand</b>,
<b>AuthorizedKeysCommandUser</b>, <b>AuthorizedKeysFile</b>,
<b>AuthorizedPrincipalsCommand</b>,
<b>AuthorizedPrincipalsCommandUser</b>,
<b>AuthorizedPrincipalsFile</b>, <b>Banner</b>,
<b>ChrootDirectory</b>, <b>ClientAliveCountMax</b>,
<b>ClientAliveInterval</b>, <b>DenyGroups</b>,
<b>DenyUsers</b>, <b>ForceCommand</b>, <b>GatewayPorts</b>,
<b>GSSAPIAuthentication</b>,
<b>HostbasedAcceptedKeyTypes</b>,
<b>HostbasedAuthentication</b>,
<b>HostbasedUsesNameFromPacketOnly</b>, <b>IPQoS</b>,
<b>KbdInteractiveAuthentication</b>,
<b>KerberosAuthentication</b>, <b>LogLevel</b>,
<b>MaxAuthTries</b>, <b>MaxSessions</b>,
<b>PasswordAuthentication</b>, <b>PermitEmptyPasswords</b>,
<b>PermitListen</b>, <b>PermitOpen</b>,
<b>PermitRootLogin</b>, <b>PermitTTY</b>,
<b>PermitTunnel</b>, <b>PermitUserRC</b>,
<b>PubkeyAcceptedKeyTypes</b>, <b>PubkeyAuthentication</b>,
<b>RekeyLimit</b>, <b>RevokedKeys</b>, <b>RDomain</b>,
<b>SetEnv</b>, <b>StreamLocalBindMask</b>,
<b>StreamLocalBindUnlink</b>, <b>TrustedUserCAKeys</b>,
<b>X11DisplayOffset</b>, <b>X11Forwarding</b> and
<b>X11UseLocalHost</b>.</p>

<p style="margin-top: 1em"><b>MaxAuthTries</b></p>

<p style="margin-left:17%;">Specifies the maximum number of
authentication attempts permitted per connection. Once the
number of failures reaches half this value, additional
failures are logged. The default is 6.</p>

<p style="margin-top: 1em"><b>MaxSessions</b></p>

<p style="margin-left:17%;">Specifies the maximum number of
open shell, login or subsystem (e.g. sftp) sessions
permitted per network connection. Multiple sessions may be
established by clients that support connection multiplexing.
Setting <b>MaxSessions</b> to 1 will effectively disable
session multiplexing, whereas setting it to 0 will prevent
all shell, login and subsystem sessions while still
permitting forwarding. The default is 10.</p>

<p style="margin-top: 1em"><b>MaxStartups</b></p>

<p style="margin-left:17%;">Specifies the maximum number of
concurrent unauthenticated connections to the SSH daemon.
Additional connections will be dropped until authentication
succeeds or the <b>LoginGraceTime</b> expires for a
connection. The default is 10:30:100.</p>

<p style="margin-left:17%; margin-top: 1em">Alternatively,
random early drop can be enabled by specifying the three
colon separated values start:rate:full (e.g.
&quot;10:30:60&quot;). sshd(8) will refuse connection
attempts with a probability of rate/100 (30%) if there are
currently start (10) unauthenticated connections. The
probability increases linearly and all connection attempts
are refused if the number of unauthenticated connections
reaches full (60).</p>


<p style="margin-top: 1em"><b>PasswordAuthentication</b></p>

<p style="margin-left:17%;">Specifies whether password
authentication is allowed. The default is <b>yes</b>.</p>

<p style="margin-top: 1em"><b>PermitEmptyPasswords</b></p>

<p style="margin-left:17%;">When password authentication is
allowed, it specifies whether the server allows login to
accounts with empty password strings. The default is
<b>no</b>.</p>

<p style="margin-top: 1em"><b>PermitListen</b></p>

<p style="margin-left:17%;">Specifies the addresses/ports
on which a remote TCP port forwarding may listen. The listen
specification must be one of the following forms:</p>


<p style="margin-left:24%; margin-top: 1em"><b>PermitListen</b>
<i>port</i> <b><br>
PermitListen</b> <i>host</i>:<i>port</i></p>

<p style="margin-left:17%; margin-top: 1em">Multiple
permissions may be specified by separating them with
whitespace. An argument of <b>any</b> can be used to remove
all restrictions and permit any listen requests. An argument
of <b>none</b> can be used to prohibit all listen requests.
The host name may contain wildcards as described in the
PATTERNS section in ssh_config(5). The wildcard
&rsquo;*&rsquo; can also be used in place of a port number
to allow all ports. By default all port forwarding listen
requests are permitted. Note that the <b>GatewayPorts</b>
option may further restrict which addresses may be listened
on. Note also that ssh(1) will request a listen host of
&ldquo;localhost&rdquo; if no listen host was specifically
requested, and this this name is treated differently to
explicit localhost addresses of &ldquo;127.0.0.1&rdquo; and
&ldquo;::1&rdquo;.</p>

<p style="margin-top: 1em"><b>PermitOpen</b></p>

<p style="margin-left:17%;">Specifies the destinations to
which TCP port forwarding is permitted. The forwarding
specification must be one of the following forms:</p>


<p style="margin-left:24%; margin-top: 1em"><b>PermitOpen</b>
<i>host</i>:<i>port</i> <b><br>
PermitOpen</b> <i>IPv4_addr</i>:<i>port</i> <b><br>
PermitOpen</b> <i>[IPv6_addr]</i>:<i>port</i></p>

<p style="margin-left:17%; margin-top: 1em">Multiple
forwards may be specified by separating them with
whitespace. An argument of <b>any</b> can be used to remove
all restrictions and permit any forwarding requests. An
argument of <b>none</b> can be used to prohibit all
forwarding requests. The wildcard &rsquo;*&rsquo; can be
used for host or port to allow all hosts or ports,
respectively. By default all port forwarding requests are
permitted.</p>

<p style="margin-top: 1em"><b>PermitRootLogin</b></p>

<p style="margin-left:17%;">Specifies whether root can log
in using ssh(1). The argument must be <b>yes</b>,
<b>prohibit-password</b>, <b>forced-commands-only</b>, or
<b>no</b>. The default is <b>prohibit-password</b>.</p>

<p style="margin-left:17%; margin-top: 1em">If this option
is set to <b>prohibit-password</b> (or its deprecated alias,
<b>without-password</b>), password and keyboard-interactive
authentication are disabled for root.</p>

<p style="margin-left:17%; margin-top: 1em">If this option
is set to <b>forced-commands-only</b>, root login with
public key authentication will be allowed, but only if the
<i>command</i> option has been specified (which may be
useful for taking remote backups even if root login is
normally not allowed). All other authentication methods are
disabled for root.</p>

<p style="margin-left:17%; margin-top: 1em">If this option
is set to <b>no</b>, root is not allowed to log in.</p>

<p style="margin-top: 1em"><b>PermitTTY</b></p>

<p style="margin-left:17%;">Specifies whether pty(4)
allocation is permitted. The default is <b>yes</b>.</p>

<p style="margin-top: 1em"><b>PermitTunnel</b></p>

<p style="margin-left:17%;">Specifies whether tun(4) device
forwarding is allowed. The argument must be <b>yes</b>,
<b>point-to-point</b> (layer 3), <b>ethernet</b> (layer 2),
or <b>no</b>. Specifying <b>yes</b> permits both
<b>point-to-point</b> and <b>ethernet</b>. The default is
<b>no</b>.</p>

<p style="margin-left:17%; margin-top: 1em">Independent of
this setting, the permissions of the selected tun(4) device
must allow access to the user.</p>


<p style="margin-top: 1em"><b>PermitUserEnvironment</b></p>

<p style="margin-left:17%;">Specifies whether
<i>~/.ssh/environment</i> and <b>environment=</b> options in
<i>~/.ssh/authorized_keys</i> are processed by sshd(8).
Valid options are <b>yes</b>, <b>no</b> or a pattern-list
specifying which environment variable names to accept (for
example &quot;LANG,LC_*&quot;). The default is <b>no</b>.
Enabling environment processing may enable users to bypass
access restrictions in some configurations using mechanisms
such as LD_PRELOAD.</p>

<p style="margin-top: 1em"><b>PermitUserRC</b></p>

<p style="margin-left:17%;">Specifies whether any
<i>~/.ssh/rc</i> file is executed. The default is
<b>yes</b>.</p>

<p style="margin-top: 1em"><b>PidFile</b></p>

<p style="margin-left:17%;">Specifies the file that
contains the process ID of the SSH daemon, or <b>none</b> to
not write one. The default is <i>/run/sshd.pid</i>.</p>

<p style="margin-top: 1em"><b>Port</b></p>

<p style="margin-left:17%; margin-top: 1em">Specifies the
port number that sshd(8) listens on. The default is 22.
Multiple options of this type are permitted. See also
<b>ListenAddress</b>.</p>

<p style="margin-top: 1em"><b>PrintLastLog</b></p>

<p style="margin-left:17%;">Specifies whether sshd(8)
should print the date and time of the last user login when a
user logs in interactively. The default is <b>yes</b>.</p>

<p style="margin-top: 1em"><b>PrintMotd</b></p>

<p style="margin-left:17%;">Specifies whether sshd(8)
should print <i>/etc/motd</i> when a user logs in
interactively. (On some systems it is also printed by the
shell, <i>/etc/profile</i>, or equivalent.) The default is
<b>yes</b>.</p>


<p style="margin-top: 1em"><b>PubkeyAcceptedKeyTypes</b></p>

<p style="margin-left:17%;">Specifies the key types that
will be accepted for public key authentication as a list of
comma-separated patterns. Alternately if the specified value
begins with a &rsquo;+&rsquo; character, then the specified
key types will be appended to the default set instead of
replacing them. If the specified value begins with a
&rsquo;-&rsquo; character, then the specified key types
(including wildcards) will be removed from the default set
instead of replacing them. The default for this option
is:</p>


<p style="margin-left:21%; margin-top: 1em">ecdsa-sha2-nistp256-cert-v01@openssh.com,
<br>
ecdsa-sha2-nistp384-cert-v01@openssh.com, <br>
ecdsa-sha2-nistp521-cert-v01@openssh.com, <br>
ssh-ed25519-cert-v01@openssh.com, <br>

rsa-sha2-512-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com,
<br>
ssh-rsa-cert-v01@openssh.com, <br>

ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,
<br>
ssh-ed25519,rsa-sha2-512,rsa-sha2-256,ssh-rsa</p>

<p style="margin-left:17%; margin-top: 1em">The list of
available key types may also be obtained using &quot;ssh -Q
key&quot;.</p>

<p style="margin-top: 1em"><b>PubkeyAuthentication</b></p>

<p style="margin-left:17%;">Specifies whether public key
authentication is allowed. The default is <b>yes</b>.</p>

<p style="margin-top: 1em"><b>RekeyLimit</b></p>

<p style="margin-left:17%;">Specifies the maximum amount of
data that may be transmitted before the 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 &rsquo;K&rsquo;, &rsquo;M&rsquo;, or &rsquo;G&rsquo; to
indicate Kilobytes, Megabytes, or Gigabytes, respectively.
The default is between &rsquo;1G&rsquo; and
&rsquo;4G&rsquo;, depending on the cipher. The optional
second value is specified in seconds and may use any of the
units documented in the <i>TIME FORMATS</i> section. The
default value for <b>RekeyLimit</b> is <b>default none</b>,
which means that rekeying is performed after the
cipher&rsquo;s default amount of data has been sent or
received and no time based rekeying is done.</p>

<p style="margin-top: 1em"><b>RevokedKeys</b></p>

<p style="margin-left:17%;">Specifies revoked public keys
file, or <b>none</b> to not use one. Keys listed in this
file will be refused for public key authentication. Note
that if this file is not readable, then public key
authentication will be refused for all users. Keys may be
specified as a text file, listing one public key per line,
or as an OpenSSH Key Revocation List (KRL) as generated by
ssh-keygen(1). For more information on KRLs, see the KEY
REVOCATION LISTS section in ssh-keygen(1).</p>

<p style="margin-top: 1em"><b>RDomain</b></p>

<p style="margin-left:17%;">Specifies an explicit routing
domain that is applied after authentication has completed.
The user session, as well and any forwarded or listening IP
sockets, will be bound to this rdomain(4). If the routing
domain is set to <b>%D</b>, then the domain in which the
incoming connection was received will be applied.</p>

<p style="margin-top: 1em"><b>SetEnv</b></p>

<p style="margin-left:17%; margin-top: 1em">Specifies one
or more environment variables to set in child sessions
started by sshd(8) as &ldquo;NAME=VALUE&rdquo;. The
environment value may be quoted (e.g. if it contains
whitespace characters). Environment variables set by
<b>SetEnv</b> override the default environment and any
variables specified by the user via <b>AcceptEnv</b> or
<b>PermitUserEnvironment</b>.</p>

<p style="margin-top: 1em"><b>StreamLocalBindMask</b></p>

<p style="margin-left:17%;">Sets the octal file creation
mode mask (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.</p>

<p style="margin-left:17%; margin-top: 1em">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.</p>


<p style="margin-top: 1em"><b>StreamLocalBindUnlink</b></p>

<p style="margin-left:17%;">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 <b>StreamLocalBindUnlink</b> is not
enabled, <b>sshd</b> 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.</p>

<p style="margin-left:17%; margin-top: 1em">The argument
must be <b>yes</b> or <b>no</b>. The default is
<b>no</b>.</p>

<p style="margin-top: 1em"><b>StrictModes</b></p>

<p style="margin-left:17%;">Specifies whether sshd(8)
should check file modes and ownership of the user&rsquo;s
files and home directory before accepting login. This is
normally desirable because novices sometimes accidentally
leave their directory or files world-writable. The default
is <b>yes</b>. Note that this does not apply to
<b>ChrootDirectory</b>, whose permissions and ownership are
checked unconditionally.</p>

<p style="margin-top: 1em"><b>Subsystem</b></p>

<p style="margin-left:17%;">Configures an external
subsystem (e.g. file transfer daemon). Arguments should be a
subsystem name and a command (with optional arguments) to
execute upon subsystem request.</p>

<p style="margin-left:17%; margin-top: 1em">The command
<b>sftp-server</b> implements the SFTP file transfer
subsystem.</p>

<p style="margin-left:17%; margin-top: 1em">Alternately the
name <b>internal-sftp</b> implements an in-process SFTP
server. This may simplify configurations using
<b>ChrootDirectory</b> to force a different filesystem root
on clients.</p>

<p style="margin-left:17%; margin-top: 1em">By default no
subsystems are defined.</p>

<p style="margin-top: 1em"><b>SyslogFacility</b></p>

<p style="margin-left:17%;">Gives the facility code that is
used when logging messages from sshd(8). The possible values
are: DAEMON, USER, AUTH, LOCAL0, LOCAL1, LOCAL2, LOCAL3,
LOCAL4, LOCAL5, LOCAL6, LOCAL7. The default is AUTH.</p>

<p style="margin-top: 1em"><b>TCPKeepAlive</b></p>

<p style="margin-left:17%;">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. On the other hand, if TCP
keepalives are not sent, sessions may hang indefinitely on
the server, leaving &quot;ghost&quot; users and consuming
server resources.</p>

<p style="margin-left:17%; margin-top: 1em">The default is
<b>yes</b> (to send TCP keepalive messages), and the server
will notice if the network goes down or the client host
crashes. This avoids infinitely hanging sessions.</p>

<p style="margin-left:17%; margin-top: 1em">To disable TCP
keepalive messages, the value should be set to
<b>no</b>.</p>

<p style="margin-left:17%; margin-top: 1em">This option was
formerly called <b>KeepAlive</b>.</p>

<p style="margin-top: 1em"><b>TrustedUserCAKeys</b></p>

<p style="margin-left:17%;">Specifies a file containing
public keys of certificate authorities that are trusted to
sign user certificates for authentication, or <b>none</b> to
not use one. Keys are listed one per line; empty lines and
comments starting with &rsquo;#&rsquo; are allowed. If a
certificate is presented for authentication and has its
signing CA key listed in this file, then it may be used for
authentication for any user listed in the
certificate&rsquo;s principals list. Note that certificates
that lack a list of principals will not be permitted for
authentication using <b>TrustedUserCAKeys</b>. For more
details on certificates, see the CERTIFICATES section in
ssh-keygen(1).</p>

<p style="margin-top: 1em"><b>UseDNS</b></p>

<p style="margin-left:17%; margin-top: 1em">Specifies
whether sshd(8) should look up the remote host name, and to
check that the resolved host name for the remote IP address
maps back to the very same IP address.</p>

<p style="margin-left:17%; margin-top: 1em">If this option
is set to <b>no</b> (the default) then only addresses and
not host names may be used in <i>~/.ssh/authorized_keys</i>
<b>from</b> and <b>sshd_config Match Host</b>
directives.</p>

<p style="margin-top: 1em"><b>UsePAM</b></p>

<p style="margin-left:17%; margin-top: 1em">Enables the
Pluggable Authentication Module interface. If set to
<b>yes</b> this will enable PAM authentication using
<b>ChallengeResponseAuthentication</b> and
<b>PasswordAuthentication</b> in addition to PAM account and
session module processing for all authentication types.</p>

<p style="margin-left:17%; margin-top: 1em">Because PAM
challenge-response authentication usually serves an
equivalent role to password authentication, you should
disable either <b>PasswordAuthentication</b> or
<b>ChallengeResponseAuthentication.</b></p>

<p style="margin-left:17%; margin-top: 1em">If
<b>UsePAM</b> is enabled, you will not be able to run
sshd(8) as a non-root user. The default is <b>no</b>.</p>

<p style="margin-top: 1em"><b>VersionAddendum</b></p>

<p style="margin-left:17%;">Optionally specifies additional
text to append to the SSH protocol banner sent by the server
upon connection. The default is <b>none</b>.</p>

<p style="margin-top: 1em"><b>X11DisplayOffset</b></p>

<p style="margin-left:17%;">Specifies the first display
number available for sshd(8)&rsquo;s X11 forwarding. This
prevents sshd from interfering with real X11 servers. The
default is 10.</p>

<p style="margin-top: 1em"><b>X11Forwarding</b></p>

<p style="margin-left:17%;">Specifies whether X11
forwarding is permitted. The argument must be <b>yes</b> or
<b>no</b>. The default is <b>no</b>.</p>

<p style="margin-left:17%; margin-top: 1em">When X11
forwarding is enabled, there may be additional exposure to
the server and to client displays if the sshd(8) proxy
display is configured to listen on the wildcard address (see
<b>X11UseLocalhost</b>), though this is not the default.
Additionally, the authentication spoofing and authentication
data verification and substitution occur on the client side.
The security risk of using X11 forwarding is that the
client&rsquo;s X11 display server may be exposed to attack
when the SSH client requests forwarding (see the warnings
for <b>ForwardX11</b> in ssh_config(5)). A system
administrator may have a stance in which they want to
protect clients that may expose themselves to attack by
unwittingly requesting X11 forwarding, which can warrant a
<b>no</b> setting.</p>

<p style="margin-left:17%; margin-top: 1em">Note that
disabling X11 forwarding does not prevent users from
forwarding X11 traffic, as users can always install their
own forwarders.</p>

<p style="margin-top: 1em"><b>X11UseLocalhost</b></p>

<p style="margin-left:17%;">Specifies whether sshd(8)
should bind the X11 forwarding server to the loopback
address or to the wildcard address. By default, sshd binds
the forwarding server to the loopback address and sets the
hostname part of the DISPLAY environment variable to
<b>localhost</b>. This prevents remote hosts from connecting
to the proxy display. However, some older X11 clients may
not function with this configuration. <b>X11UseLocalhost</b>
may be set to <b>no</b> to specify that the forwarding
server should be bound to the wildcard address. The argument
must be <b>yes</b> or <b>no</b>. The default is
<b>yes</b>.</p>

<p style="margin-top: 1em"><b>XAuthLocation</b></p>

<p style="margin-left:17%;">Specifies the full pathname of
the xauth(1) program, or <b>none</b> to not use one. The
default is <i>/usr/bin/xauth</i>.</p>

<p style="margin-top: 1em"><b>TIME FORMATS</b></p>

<p style="margin-left:6%;">sshd(8) command-line arguments
and configuration file options that specify time may be
expressed using a sequence of the form:
<i>time</i>[<i>qualifier</i>], where <i>time</i> is a
positive integer value and <i>qualifier</i> is one of the
following:</p>

<p style="margin-top: 1em">&lang; <b>none</b>&rang;</p>

<p style="margin-left:24%;">seconds</p>

<p><b>s</b> | <b>S</b></p>

<p style="margin-left:24%; margin-top: 1em">seconds</p>

<p><b>m</b> | <b>M</b></p>

<p style="margin-left:24%; margin-top: 1em">minutes</p>

<p><b>h</b> | <b>H</b></p>

<p style="margin-left:24%; margin-top: 1em">hours</p>

<p><b>d</b> | <b>D</b></p>

<p style="margin-left:24%; margin-top: 1em">days</p>

<p><b>w</b> | <b>W</b></p>

<p style="margin-left:24%; margin-top: 1em">weeks</p>

<p style="margin-left:6%; margin-top: 1em">Each member of
the sequence is added together to calculate the total time
value.</p>

<p style="margin-left:6%; margin-top: 1em">Time format
examples:</p>

<p style="margin-top: 1em">600</p>

<p style="margin-left:24%; margin-top: 1em">600 seconds (10
minutes)</p>

<p>10m</p>

<p style="margin-left:24%; margin-top: 1em">10 minutes</p>

<p>1h30m</p>

<p style="margin-left:24%; margin-top: 1em">1 hour 30
minutes (90 minutes)</p>

<p style="margin-top: 1em"><b>TOKENS</b></p>

<p style="margin-left:6%;">Arguments to some keywords can
make use of tokens, which are expanded at runtime:</p>

<p style="margin-top: 1em">%%</p>

<p style="margin-left:22%; margin-top: 1em">A literal
&rsquo;%&rsquo;.</p>

<p>%D</p>

<p style="margin-left:22%; margin-top: 1em">The routing
domain in which the incoming connection was received.</p>

<p>%F</p>

<p style="margin-left:22%; margin-top: 1em">The fingerprint
of the CA key.</p>

<p>%f</p>

<p style="margin-left:22%; margin-top: 1em">The fingerprint
of the key or certificate.</p>

<p>%h</p>

<p style="margin-left:22%; margin-top: 1em">The home
directory of the user.</p>

<p>%i</p>

<p style="margin-left:22%; margin-top: 1em">The key ID in
the certificate.</p>

<p>%K</p>

<p style="margin-left:22%; margin-top: 1em">The
base64-encoded CA key.</p>

<p>%k</p>

<p style="margin-left:22%; margin-top: 1em">The
base64-encoded key or certificate for authentication.</p>

<p>%s</p>

<p style="margin-left:22%; margin-top: 1em">The serial
number of the certificate.</p>

<p>%T</p>

<p style="margin-left:22%; margin-top: 1em">The type of the
CA key.</p>

<p>%t</p>

<p style="margin-left:22%; margin-top: 1em">The key or
certificate type.</p>

<p>%U</p>

<p style="margin-left:22%; margin-top: 1em">The numeric
user ID of the target user.</p>

<p>%u</p>

<p style="margin-left:22%; margin-top: 1em">The
username.</p>


<p style="margin-left:6%; margin-top: 1em"><b>AuthorizedKeysCommand</b>
accepts the tokens %%, %f, %h, %k, %t, %U, and %u.</p>


<p style="margin-left:6%; margin-top: 1em"><b>AuthorizedKeysFile</b>
accepts the tokens %%, %h, %U, and %u.</p>


<p style="margin-left:6%; margin-top: 1em"><b>AuthorizedPrincipalsCommand</b>
accepts the tokens %%, %F, %f, %h, %i, %K, %k, %s, %T, %t,
%U, and %u.</p>


<p style="margin-left:6%; margin-top: 1em"><b>AuthorizedPrincipalsFile</b>
accepts the tokens %%, %h, %U, and %u.</p>


<p style="margin-left:6%; margin-top: 1em"><b>ChrootDirectory</b>
accepts the tokens %%, %h, %U, and %u.</p>


<p style="margin-left:6%; margin-top: 1em"><b>RoutingDomain</b>
accepts the token %D.</p>

<p style="margin-top: 1em"><b>FILES</b> <br>
/etc/ssh/sshd_config</p>

<p style="margin-left:17%;">Contains configuration data for
sshd(8). This file should be writable by root only, but it
is recommended (though not necessary) that it be
world-readable.</p>

<p style="margin-top: 1em"><b>SEE ALSO</b></p>

<p style="margin-left:6%;">sftp-server(8), sshd(8)</p>

<p style="margin-top: 1em"><b>AUTHORS</b></p>

<p style="margin-left:6%;">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. Niels Provos
and Markus Friedl contributed support for privilege
separation.</p>

<p style="margin-left:6%; margin-top: 1em">BSD
September&nbsp;20, 2018 BSD</p>
<hr>
</body>
</html>