SSHD(8) | System Manager's Manual | SSHD(8) |
sshd
—
sshd |
[-deiqtD46 ] [-b
bits] [-f
config_file] [-g
login_grace_time] [-h
host_key_file] [-k
key_gen_time] [-p
port] [-u
len] |
sshd
(SSH Daemon) is the daemon program for
ssh(1). Together these programs replace rlogin and rsh, and
provide secure encrypted communications between two untrusted hosts over an
insecure network. The programs are intended to be as easy to install and use
as possible.
sshd
is the daemon that listens for
connections from clients. It is normally started at boot from
/etc/rc. It forks a new daemon for each incoming
connection. The forked daemons handle key exchange, encryption,
authentication, command execution, and data exchange. This implementation of
sshd
supports both SSH protocol version 1 and 2
simultaneously. sshd
works as follows.
Whenever a client connects the daemon responds with its public host and server keys. The client compares the RSA host key against its own database to verify that it has not changed. The client then generates a 256 bit random number. It encrypts this random number using both the host key and the server key, and sends the encrypted number to the server. Both sides then use this random number as a session key which is used to encrypt all further communications in the session. The rest of the session is encrypted using a conventional cipher, currently Blowfish or 3DES, with 3DES being used by default. The client selects the encryption algorithm to use from those offered by the server.
Next, the server and the client enter an authentication dialog. The client tries to authenticate itself using .rhosts authentication, .rhosts authentication combined with RSA host authentication, RSA challenge-response authentication, or password based authentication.
Rhosts authentication is normally disabled because it is fundamentally insecure, but can be enabled in the server configuration file if desired. System security is not improved unless rshd(8), rlogind(8), and rexecd(8) are disabled (thus completely disabling rlogin(1) and rsh(1) into the machine).
The rest of the session is encrypted using a symmetric cipher, currently 128 bit AES, Blowfish, 3DES, CAST128, Arcfour, 192 bit AES, or 256 bit AES. The client selects the encryption algorithm to use from those offered by the server. Additionally, session integrity is provided through a cryptographic message authentication code (hmac-sha1 or hmac-md5).
Protocol version 2 provides a public key based user (PubkeyAuthentication) or client host (HostbasedAuthentication) authentication method, conventional password authentication and challenge response based methods.
Finally, the client either requests a shell or execution of a command. The sides then enter session mode. In this mode, either side may send data at any time, and such data is forwarded to/from the shell or command on the server side, and the user terminal in the client side.
When the user program terminates and all forwarded X11 and other connections have been closed, the server sends command exit status to the client, and both sides exit.
sshd
can be configured using command-line
options or a configuration file. Command-line options override values
specified in the configuration file.
sshd
rereads its configuration file when
it receives a hangup signal, SIGHUP
, by executing
itself with the name it was started as, i.e.,
/usr/sbin/sshd.
The options are as follows:
-b
bits-d
-e
sshd
will send the
output to the standard error instead of the system log.-f
configuration_filesshd
refuses to start if there is no configuration file.-g
login_grace_time-h
host_key_filesshd
is not run as root (as the normal host file
is normally not readable by anyone but root). It is possible to have
multiple host key files for the different protocol versions and host key
algorithms.-i
sshd
is being run from inetd.
sshd
is normally not run from inetd because it
needs to generate the server key before it can respond to the client, and
this may take tens of seconds. Clients would have to wait too long if the
key was regenerated every time. However, with small key sizes (e.g., 512)
using sshd
from inetd may be feasible.-k
key_gen_time-p
port-q
-t
sshd
reliably as configuration options may change.-u
lenutmp
structure that holds the remote host name. If
the resolved host name is longer than len, the
dotted decimal value will be used instead. This allows hosts with very
long host names that overflow this field to still be uniquely identified.
Specifying -u0
indicates that only dotted decimal
addresses should be put into the utmp file.
-u0
is also be used to prevent
sshd
from making DNS requests unless the
authentication mechanism or configuration requires it. Authentication
mechanisms that may require DNS include
RhostsAuthentication
,
RhostsRSAAuthentication
,
HostbasedAuthentication
and using a
from="pattern-list"
option in a key
file.-D
sshd
will not detach
and does not become a daemon. This allows easy monitoring of
sshd
.-4
sshd
to use IPv4 addresses only.-6
sshd
to use IPv6 addresses only.sshd
reads configuration data from
/etc/sshd_config (or the file specified with
-f
on the command line). The file contains
keyword-argument pairs, one per line. Lines starting with
‘#
’ and empty lines are interpreted as
comments.
The possible keywords and their meanings are as follows (note that keywords are case-insensitive and arguments are case-sensitive):
AFSTokenPassing
AllowGroups
*
’ and
‘
’? can be used as wildcards in the
patterns. Only group names are valid; a numerical group ID is not
recognized. By default login is allowed regardless of the group list.AllowTcpForwarding
AllowUsers
*
’ and
‘
’? can be used as wildcards in the
patterns. Only user names are valid; a numerical user ID is not
recognized. By default login is allowed regardless of the user name. If
the pattern takes the form USER@HOST then USER and HOST are separately
checked, restricting logins to particular users from particular
hosts.AuthorizedKeysFile
AuthorizedKeysFile
may contain
tokens of the form %T which are substituted during connection set-up. The
following tokens are defined: %% is replaced by a literal '%', %h is
replaced by the home directory of the user being authenticated and %u is
replaced by the username of that user. After expansion,
AuthorizedKeysFile
is taken to be an absolute path
or one relative to the user's home directory. The default is
“.ssh/authorized_keys”Banner
ChallengeResponseAuthentication
Ciphers
ClientAliveInterval
sshd
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. This option applies to protocol version 2 only.ClientAliveCountMax
sshd
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 KeepAlive
(below). The
client alive messages are sent through the encrypted channel and therefore
will not be spoofable. The TCP keepalive option enabled by
KeepAlive
is spoofable. The client alive mechanism
is valuable when the client or server depend on knowing when a connection
has become inactive.
The default value is 3. If
ClientAliveInterval
(above) is set to 15, and
ClientAliveCountMax
is left at the default,
unresponsive ssh clients will be disconnected after approximately 45
seconds.
DenyGroups
*
’ and
‘
’? can be used as wildcards in the
patterns. Only group names are valid; a numerical group ID is not
recognized. By default login is allowed regardless of the group list.DenyUsers
*
’ and
‘
’? can be used as wildcards in the
patterns. Only user names are valid; a numerical user ID is not
recognized. By default login is allowed regardless of the user name.GatewayPorts
sshd
binds remote port
forwardings to the loopback addresss. This prevents other remote hosts
from connecting to forwarded ports. GatewayPorts
can be used to specify that sshd
should bind
remote port forwardings to the wildcard address, thus allowing remote
hosts to connect to forwarded ports. The argument must be
“yes” or “no”. The default is
“no”.HostbasedAuthentication
RhostsRSAAuthentication
and applies to protocol
version 2 only. The default is “no”.HostKey
sshd
will refuse to use a file if
it is group/world-accessible. It is possible to have multiple host key
files. “rsa1” keys are used for version 1 and
“dsa” or “rsa” are used for version 2 of the
SSH protocol.IgnoreRhosts
RhostsAuthentication
,
RhostsRSAAuthentication
or
HostbasedAuthentication
.
/etc/hosts.equiv and /etc/shosts.equiv are still used. The default is “yes”.
IgnoreUserKnownHosts
sshd
should ignore the user's
$HOME/.ssh/known_hosts during
RhostsRSAAuthentication
or
HostbasedAuthentication
. The default is
“no”.KeepAlive
The default is “yes” (to send keepalives), and the server will notice if the network goes down or the client host reboots. This avoids infinitely hanging sessions.
To disable keepalives, the value should be set to “no” in both the server and the client configuration files.
KerberosAuthentication
PasswordAuthentication
is yes, the password
provided by the user will be validated through the Kerberos KDC. To use
this option, the server needs a Kerberos servtab which allows the
verification of the KDC's identity. Default is “yes”.KerberosOrLocalPasswd
KerberosTgtPassing
KerberosTicketCleanup
KeyRegenerationInterval
ListenAddress
sshd
should listen
on. The following forms may be used:
ListenAddress
host|IPv4_addr|IPv6_addrListenAddress
host|IPv4_addr:portListenAddress
[host|IPv6_addr]:portIf port is not specified,
sshd
will listen on the address and all prior
Port
options specified. The default is to listen
on all local addresses. Multiple ListenAddress
options are permitted. Additionally, any Port
options must precede this option for non port qualified addresses.
LoginGraceTime
LogLevel
sshd
. The possible values are: QUIET, FATAL,
ERROR, INFO, VERBOSE and DEBUG. The default is INFO. Logging with level
DEBUG violates the privacy of users and is not recommended.MACs
MaxStartups
sshd
daemon. Additional connections will be
dropped until authentication succeeds or the
LoginGraceTime
expires for a connection. The
default is 10.
Alternatively, random early drop can be enabled by specifying
the three colon separated values “start:rate:full” (e.g.,
"10:30:60"). sshd
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).
PAMAuthenticationViaKbdInt
PasswordAuthentication
is disabled. The default is
“no”.PasswordAuthentication
PermitEmptyPasswords
PermitRootLogin
If this option is set to “without-password” password authentication is disabled for root.
If this option is set to “forced-commands-only” root login with public key authentication will be allowed, but only if the command 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.
If this option is set to “no” root is not allowed to login.
PidFile
sshd
daemon. The default is
/var/run/sshd.pid.Port
sshd
listens on.
The default is 22. Multiple options of this type are permitted. See also
ListenAddress
.PrintLastLog
sshd
should print the date and
time when the user last logged in. The default is
“yes”.PrintMotd
sshd
should print
/etc/motd when a user logs in interactively. (On
some systems it is also printed by the shell,
/etc/profile, or equivalent.) The default is
“yes”.Protocol
sshd
should
support. The possible values are “1” and “2”.
Multiple versions must be comma-separated. The default is
“2,1”.PubkeyAuthentication
ReverseMappingCheck
sshd
should try to verify the
remote host name and check that the resolved host name for the remote IP
address maps back to the very same IP address. The default is
“no”.RhostsAuthentication
RhostsRSAAuthentication
should be used
instead, because it performs RSA-based host authentication in addition to
normal rhosts or /etc/hosts.equiv authentication. The default is
“no”. This option applies to protocol version 1 only.RhostsRSAAuthentication
RSAAuthentication
ServerKeyBits
StrictModes
sshd
should check file modes and
ownership of the user'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
“yes”.Subsystem
SyslogFacility
sshd
. The possible values are: DAEMON, USER, AUTH,
LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7. The
default is AUTH.UseLogin
X11Forwarding
will be disabled because login(1) does not know how to
handle xauth(1) cookies.X11DisplayOffset
sshd
's X11 forwarding. This prevents
sshd
from interfering with real X11 servers. The
default is 10.X11Forwarding
UseLogin
is enabled.XAuthLocation
sshd
command-line arguments and configuration file
options that specify time may be expressed using a sequence of the form:
time[qualifier], where
time is a positive integer value and
qualifier is one of the following:
Each member of the sequence is added together to calculate the total time value.
Time format examples:
sshd
does the
following:
AuthorizedKeysFile
may be used to specify
an alternative file.
Each line of the file contains one key (empty lines and lines
starting with a ‘#
’ are ignored as
comments). Each RSA public key consists of the following fields, separated
by spaces: options, bits, exponent, modulus, comment. Each protocol version
2 public key consists of: options, keytype, base64 encoded key, comment. The
options fields are optional; its presence is determined by whether the line
starts with a number or not (the option field never starts with a number).
The bits, exponent, modulus and comment fields give the RSA key for protocol
version 1; the comment field is not used for anything (but may be convenient
for the user to identify the key). For protocol version 2 the keytype is
“ssh-dss” or “ssh-rsa”.
Note that lines in this file are usually several hundred bytes long (because of the size of the RSA key modulus). You don't want to type them in; instead, copy the identity.pub, id_dsa.pub or the id_rsa.pub file and edit it.
The options (if present) consist of comma-separated option specifications. No spaces are permitted, except within double quotes. The following option specifications are supported (note that option keywords are case-insensitive):
from="pattern-list"
*
’ and
‘
’? serve as wildcards). The list
may also contain patterns negated by prefixing them with
‘
’!; if the canonical host name
matches a negated pattern, the key is not accepted. The purpose of this
option is to optionally increase security: RSA authentication by itself
does not trust the network or name servers or anything (but the key);
however, if somebody somehow steals the key, the key permits an intruder
to log in from anywhere in the world. This additional option makes using a
stolen key more difficult (name servers and/or routers would have to be
compromised in addition to just the key).command="command"
no-pty
. A quote may be
included in the command by quoting it with a backslash. This option might
be useful to restrict certain RSA keys to perform just a specific
operation. An example might be a key that permits remote backups but
nothing else. Note that the client may specify TCP/IP and/or X11
forwarding unless they are explicitly prohibited. Note that this option
applies to shell, command or subsystem execution.environment="NAME=value"
UseLogin
is enabled.no-port-forwarding
command
option.no-X11-forwarding
no-agent-forwarding
no-pty
permitopen="host:port"
``ssh -L''
port forwarding such that
it may only connect to the specified host and port. IPv6 addresses can be
specified with an alternative syntax: host/port.
Multiple permitopen
options may be applied
separated by commas. No pattern matching is performed on the specified
hostnames, they must be literal domains or addresses.from="*.niksula.hut.fi,!pc.niksula.hut.fi" 1024 35 23...2334 ylo@niksula
command="dump /home",no-pty,no-port-forwarding 1024 33 23...2323 backup.hut.fi
permitopen="10.2.1.55:80",permitopen="10.2.1.56:25" 1024 33 23...2323
Each line in these files contains the following fields: hostnames, bits, exponent, modulus, comment. The fields are separated by spaces.
Hostnames is a comma-separated list of patterns ('*' and '?' act
as wildcards); each pattern in turn is matched against the canonical host
name (when authenticating a client) or against the user-supplied name (when
authenticating a server). A pattern may also be preceded by
‘’! to indicate negation: if the host
name matches a negated pattern, it is not accepted (by that line) even if it
matched another pattern on the line.
Bits, exponent, and modulus are taken directly from the RSA host key; they can be obtained, e.g., from /etc/ssh_host_key.pub. The optional comment field continues to the end of the line, and is not used.
Lines starting with ‘#
’ and
empty lines are ignored as comments.
When performing host authentication, authentication is accepted if any matching line has the proper key. It is thus permissible (but not recommended) to have several lines or different host keys for the same names. This will inevitably happen when short forms of host names from different domains are put in the file. It is possible that the files contain conflicting information; authentication is accepted if valid information can be found from either file.
Note that the lines in these files are typically hundreds of characters long, and you definitely don't want to type in the host keys by hand. Rather, generate them by a script or by taking /etc/ssh_host_key.pub and adding the host names at the front.
closenet,...,130.233.208.41 1024 37 159...93 closenet.hut.fi cvs.openbsd.org,199.185.137.3 ssh-rsa AAAA1234.....=
sshd
. This file
should be writable by root only, but it is recommended (though not
necessary) that it be world-readable.sshd
does not start if this file
is group/world-accessible.sshd
listening for
connections (if there are several daemons running concurrently for
different ports, this contains the pid of the one started last). The
content of this file is not sensitive; it can be world-readable.sshd
refuses to let anyone
except root log in. The contents of the file are displayed to anyone
trying to log in, and non-root connections are refused. The file should be
world-readable.If is also possible to use netgroups in the file. Either host or user name may be of the form +@groupname to specify all hosts or all users in the group.
-
’.
If the client host/user is successfully matched in this file, login is automatically permitted provided the client and server user names are the same. Additionally, successful RSA host authentication is normally required. This file must be writable only by root; it is recommended that it be world-readable.
Warning: It is almost never a good idea to use user names in hosts.equiv. Beware that it really means that the named user(s) can log in as anybody, which includes bin, daemon, adm, and other accounts that own critical binaries and directories. Using a user name practically grants the user root access. The only valid use for user names that I can think of is in negative entries.
Note that this warning also applies to rsh/rlogin.
#
’), and assignment lines of the
form name=value. The file should be writable only by the user; it need not
be readable by anyone else.DISPLAY
in environment). This must call
xauth(1) in that case.
The primary purpose of this file is to run any initialization routines which may be needed before the user's home directory becomes accessible; AFS is a particular example of such an environment.
This file will probably contain some initialization code followed by something similar to:
if read proto cookie; then echo add $DISPLAY $proto $cookie | xauth -q - fi
If this file does not exist, /etc/sshrc is run, and if that does not exist either, xauth is used to store the cookie.
This file should be writable only by the user, and need not be readable by anyone else.
T. Ylonen, T. Kivinen, M. Saarinen, T. Rinne, and S. Lehtinen, SSH Protocol Architecture, draft-ietf-secsh-architecture-09.txt, July 2001, work in progress material.
M. Friedl, N. Provos, and W. A. Simpson, Diffie-Hellman Group Exchange for the SSH Transport Layer Protocol, draft-ietf-secsh-dh-group-exchange-01.txt, April 2001, work in progress material.
September 25, 1999 | BSD |