libexec/rshd/rshd.8

   1 .\" Copyright (c) 1983, 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)rshd.8      8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt RSHD 8
  37 .Os BSD 4.2
  38 .Sh NAME
  39 .Nm rshd
  40 .Nd remote shell server
  41 .Sh SYNOPSIS
  42 .Nm rshd
  43 .Op Fl alnDL
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 server
  48 is the server for the
  49 .Xr rcmd 3
  50 routine and, consequently, for the
  51 .Xr rsh 1
  52 program.  The server provides remote execution facilities
  53 with authentication based on privileged port numbers from trusted hosts.
  54 .Pp
  55 The
  56 .Nm
  57 server
  58 listens for service requests at the port indicated in
  59 the
  60 .Dq cmd
  61 service specification; see
  62 .Xr services 5 .
  63 When a service request is received the following protocol
  64 is initiated:
  65 .Bl -enum
  66 .It
  67 The server checks the client's source port.
  68 If the port is not in the range 512-1023, the server
  69 aborts the connection.
  70 .It
  71 The server reads characters from the socket up
  72 to a
  73 .Tn NUL
  74 (`\e0') byte.  The resultant string is
  75 interpreted as an
  76 .Tn ASCII
  77 number, base 10.
  78 .It
  79 If the number received in step 2 is non-zero,
  80 it is interpreted as the port number of a secondary
  81 stream to be used for the
  82 .Em stderr .
  83 A second connection is then created to the specified
  84 port on the client's machine.  The source port of this
  85 second connection is also in the range 512-1023.
  86 .It
  87 The server checks the client's source address
  88 and requests the corresponding host name (see
  89 .Xr gethostbyaddr 3 ,
  90 .Xr hosts 5
  91 and
  92 .Xr named 8 ) .
  93 If the hostname cannot be determined or the hostname and address do
  94 not match after verification,
  95 the dot-notation representation of the host address is used.
  96 .It
  97 A null terminated user name of at most 16 characters
  98 is retrieved on the initial socket.  This user name
  99 is interpreted as the user identity on the
 100 .Em client Ns 's
 101 machine.
 102 .It
 103 A null terminated user name of at most 16 characters
 104 is retrieved on the initial socket.  This user name
 105 is interpreted as a user identity to use on the
 106 .Em server Ns 's
 107 machine.
 108 .It
 109 A null terminated command to be passed to a
 110 shell is retrieved on the initial socket.  The length of
 111 the command is limited by the upper bound on the size of
 112 the system's argument list.
 113 .It
 114 .Nm Rshd
 115 then validates the user using
 116 .Xr ruserok 3 ,
 117 which uses the file
 118 .Pa /etc/hosts.equiv
 119 and the
 120 .Pa .rhosts
 121 file found in the user's home directory.  The
 122 .Fl l
 123 option prevents
 124 .Xr ruserok 3
 125 from doing any validation based on the user's
 126 .Pa .rhosts
 127 file,
 128 unless the user is the superuser.
 129 .It
 130 If the file
 131 .Pa /var/run/nologin
 132 exists and the user is not the superuser,
 133 the connection is closed.
 134 The name of the nologin file may be overridden
 135 using the nologin capability in
 136 .Pa /etc/login.conf
 137 according to the local user's login class,
 138 which may also be used to restrict
 139 .Xr rsh 1
 140 access by
 141 login time (times.allow and times.deny capabilities)
 142 and remote host (hosts.allow and hosts.deny capabilities).
 143 .It
 144 A
 145 .Tn NUL
 146 byte is returned on the initial socket
 147 and the command line is passed to the normal login
 148 shell of the user.  The
 149 shell inherits the network connections established
 150 by
 151 .Nm Ns .
 152 .El
 153 .Pp
 154 Transport-level keepalive messages are enabled unless the
 155 .Fl n
 156 option is present.
 157 The use of keepalive messages allows sessions to be timed out
 158 if the client crashes or becomes unreachable.
 159 .Pp
 160 The
 161 .Fl D
 162 option sets the TCP_NODELAY socket option which improves
 163 performance of small back-to-back
 164 writes at the expense of additional network traffic.
 165 .Pp
 166 The
 167 .Fl L
 168 option causes all successful accesses to be logged to
 169 .Xr syslogd 8
 170 as
 171 .Li auth.info
 172 messages.
 173 .Sh DIAGNOSTICS
 174 Except for the last one listed below,
 175 all diagnostic messages
 176 are returned on the initial socket,
 177 after which any network connections are closed.
 178 An error is indicated by a leading byte with a value of
 179 1 (0 is returned in step 10 above upon successful completion
 180 of all the steps prior to the execution of the login shell).
 181 .Bl -tag -width indent
 182 .It Sy Locuser too long.
 183 The name of the user on the client's machine is
 184 longer than 16 characters.
 185 .It Sy Ruser too long.
 186 The name of the user on the remote machine is
 187 longer than 16 characters.
 188 .It Sy Command too long.
 189 The command line passed exceeds the size of the argument
 190 list (as configured into the system).
 191 .It Sy Login incorrect.
 192 No password file entry for the user name existed
 193 or the authentication procedure described above failed.
 194 .It Sy Remote directory.
 195 The
 196 .Xr chdir 2
 197 function to the home directory failed.
 198 .It Sy Logins not available right now.
 199 .Xr Rsh 1
 200 was attempted outside the allowed hours defined in
 201 .Pa /etc/login.conf
 202 for the local user's login class.
 203 .It Sy Can't make pipe.
 204 The pipe needed for the
 205 .Em stderr ,
 206 wasn't created.
 207 .It Sy Can't fork; try again.
 208 A
 209 .Xr fork 2
 210 by the server failed.
 211 .It Sy <shellname>: ...
 212 The user's login shell could not be started.  This message is returned
 213 on the connection associated with the
 214 .Em stderr ,
 215 and is not preceded by a flag byte.
 216 .El
 217 .Sh SEE ALSO
 218 .Xr rlogin 1 ,
 219 .Xr rsh 1 ,
 220 .Xr gethostbyaddr 3 ,
 221 .Xr rcmd 3 ,
 222 .Xr ruserok 3 ,
 223 .Xr auth.conf 5 ,
 224 .Xr hosts.equiv 5 ,
 225 .Xr hosts 5 ,
 226 .Xr login.conf 5 ,
 227 .Xr nologin 5 ,
 228 .Xr services 5 ,
 229 .Xr named 8 ,
 230 .Xr rlogind 8 ,
 231 .Xr syslogd 8 .
 232 .Sh FILES
 233 .Bl -tag -width /etc/hosts -compact
 234 .It Pa /etc/hosts
 235 .It Pa /etc/hosts.equiv
 236 .It Pa /etc/login.conf
 237 .Sm off
 238 .It Pa Ev $HOME /.rhosts
 239 .Sm on
 240 .It Pa /var/run/nologin
 241 .El
 242 .Sh BUGS
 243 The authentication procedure used here assumes the integrity
 244 of each client machine and the connecting medium.  This is
 245 insecure, but is useful in an
 246 .Dq open
 247 environment.
 248 .Pp
 249 A facility to allow all data exchanges to be encrypted should be
 250 present.
 251 .Pp
 252 A more extensible protocol (such as Telnet) should be used.
 253 .Sh HISTORY
 254 IPv6 support was added by WIDE/KAME project.