BSD 4_3_Net_2 release

[unix-history] / usr / src / libexec / rshd / rshd.8

diff --git a/usr/src/libexec/rshd/rshd.8 b/usr/src/libexec/rshd/rshd.8
index f5d66ad..1e175e2 100644 (file)
--- a/usr/src/libexec/rshd/rshd.8
+++ b/usr/src/libexec/rshd/rshd.8
@@ -1,107 +1,147 @@
-.\" Copyright (c) 1983, 1989 The Regents of the University of California.
+.\" Copyright (c) 1983, 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" %sccs.include.redist.man%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)rshd.8      6.10 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH RSHD 8 ""
-.UC 5
-.SH NAME
-rshd \- remote shell server
-.SH SYNOPSIS
-.B rshd [-aln]
-.SH DESCRIPTION
-.I Rshd
+.\"     @(#)rshd.8     6.11 (Berkeley) 4/20/91
+.\"
+.Dd April 20, 1991
+.Dt RSHD 8
+.Os BSD 4.2
+.Sh NAME
+.Nm rshd
+.Nd remote shell server
+.Sh SYNOPSIS
+.Nm rshd
+.Op Fl aln
+.Sh DESCRIPTION
+The
+.Nm rshd
+server

 is the server for the 
 is the server for the 

-.IR rcmd (3)
+.Xr rcmd 3

 routine and, consequently, for the
 routine and, consequently, for the

-.IR rsh (1)
+.Xr rsh 1

 program.  The server provides remote execution facilities
 with authentication based on privileged port numbers from trusted hosts.
 program.  The server provides remote execution facilities
 with authentication based on privileged port numbers from trusted hosts.

-.PP
-.I Rshd
+.Pp
+The
+.Nm rshd
+server

 listens for service requests at the port indicated in
 the ``cmd'' service specification; see
 listens for service requests at the port indicated in
 the ``cmd'' service specification; see

-.IR services (5).
+.Xr services 5 .

 When a service request is received the following protocol
 is initiated:
 When a service request is received the following protocol
 is initiated:

-.IP 1)
+.Bl -enum
+.It

 The server checks the client's source port.
 If the port is not in the range 512-1023, the server
 aborts the connection.
 The server checks the client's source port.
 If the port is not in the range 512-1023, the server
 aborts the connection.

-.IP 2)
+.It

 The server reads characters from the socket up
 to a null (`\e0') byte.  The resultant string is
 The server reads characters from the socket up
 to a null (`\e0') byte.  The resultant string is

-interpreted as an ASCII number, base 10.
-.IP 3)
+interpreted as an
+.Tn ASCII
+number, base 10.
+.It

 If the number received in step 2 is non-zero,
 it is interpreted as the port number of a secondary
 stream to be used for the 
 If the number received in step 2 is non-zero,
 it is interpreted as the port number of a secondary
 stream to be used for the 

-.BR stderr .
+.Em stderr .

 A second connection is then created to the specified
 port on the client's machine.  The source port of this
 second connection is also in the range 512-1023.
 A second connection is then created to the specified
 port on the client's machine.  The source port of this
 second connection is also in the range 512-1023.

-.IP 4)
+.It

 The server checks the client's source address
 and requests the corresponding host name (see
 The server checks the client's source address
 and requests the corresponding host name (see

-.IR gethostbyaddr (3),
-.IR hosts (5)
+.Xr gethostbyaddr 3 ,
+.Xr hosts 5

 and
 and

-.IR named (8)).
+.Xr named 8 ) .

 If the hostname cannot be determined,
 the dot-notation representation of the host address is used.
 If the hostname is in the same domain as the server (according to
 the last two components of the domain name),
 or if the
 If the hostname cannot be determined,
 the dot-notation representation of the host address is used.
 If the hostname is in the same domain as the server (according to
 the last two components of the domain name),
 or if the

-.B \-a
+.Fl a

 option is given,
 the addresses for the hostname are requested,
 verifying that the name and address correspond.
 If address verification fails, the connection is aborted
 with the message, ``Host address mismatch.''
 option is given,
 the addresses for the hostname are requested,
 verifying that the name and address correspond.
 If address verification fails, the connection is aborted
 with the message, ``Host address mismatch.''

-.IP 5)
+.It

 A null terminated user name of at most 16 characters
 is retrieved on the initial socket.  This user name
 is interpreted as the user identity on the
 A null terminated user name of at most 16 characters
 is retrieved on the initial socket.  This user name
 is interpreted as the user identity on the

-.BR client 's
+.Em client Ns 's

 machine.
 machine.

-.IP 6)
+.It

 A null terminated user name of at most 16 characters
 is retrieved on the initial socket.  This user name
 is interpreted as a user identity to use on the
 A null terminated user name of at most 16 characters
 is retrieved on the initial socket.  This user name
 is interpreted as a user identity to use on the

-.BR server 's
+.Sy server Ns 's

 machine.
 machine.

-.IP 7)
+.It

 A null terminated command to be passed to a
 shell is retrieved on the initial socket.  The length of
 the command is limited by the upper bound on the size of
 the system's argument list.  
 A null terminated command to be passed to a
 shell is retrieved on the initial socket.  The length of
 the command is limited by the upper bound on the size of
 the system's argument list.  

-.IP 8)
-.I Rshd
+.It
+.Nm Rshd

 then validates the user using
 then validates the user using

-.IR ruserok (3),
-which uses the file ``/etc/hosts.equiv'' and the ``.rhosts''
+.Xr ruserok 3 ,
+which uses the file
+.Pa /etc/hosts.equiv
+and the
+.Pa .rhosts

 file found in the user's home directory.  The
 file found in the user's home directory.  The

-.B \-l
+.Fl l

 option prevents
 option prevents

-.IR ruserok (3)
+.Xr ruserok 3

 from doing any validation based on the user's ``.rhosts'' file,
 unless the user is the superuser.
 from doing any validation based on the user's ``.rhosts'' file,
 unless the user is the superuser.

-.IP 9)
+.It

 A null byte is returned on the initial socket
 and the command line is passed to the normal login
 shell of the user.  The
 shell inherits the network connections established
 by
 A null byte is returned on the initial socket
 and the command line is passed to the normal login
 shell of the user.  The
 shell inherits the network connections established
 by

-.IR rshd .
-.PP
+.Nm rshd .
+.Pp

 Transport-level keepalive messages are enabled unless the
 Transport-level keepalive messages are enabled unless the

-.B \-n
+.Fl n

 option is present.
 The use of keepalive messages allows sessions to be timed out
 if the client crashes or becomes unreachable.
 option is present.
 The use of keepalive messages allows sessions to be timed out
 if the client crashes or becomes unreachable.

-.SH DIAGNOSTICS
+.El
+.Sh DIAGNOSTICS

 Except for the last one listed below,
 all diagnostic messages
 are returned on the initial socket,
 Except for the last one listed below,
 all diagnostic messages
 are returned on the initial socket,


@@ -109,62 +149,48 @@ after which any network connections are closed.
 An error is indicated by a leading byte with a value of
 1 (0 is returned in step 9 above upon successful completion
 of all the steps prior to the execution of the login shell).
 An error is indicated by a leading byte with a value of
 1 (0 is returned in step 9 above upon successful completion
 of all the steps prior to the execution of the login shell).

-.PP
-.B ``locuser too long''
-.br
+.Bl -tag -width indent
+.It Sy Locuser too long.

 The name of the user on the client's machine is
 longer than 16 characters.
 The name of the user on the client's machine is
 longer than 16 characters.

-.PP
-.B ``remuser too long''
-.br
+.It Sy Ruser too long.

 The name of the user on the remote machine is
 longer than 16 characters.
 The name of the user on the remote machine is
 longer than 16 characters.

-.PP
-.B ``command too long ''
-.br
+.It Sy Command too long  .

 The command line passed exceeds the size of the argument
 list (as configured into the system).
 The command line passed exceeds the size of the argument
 list (as configured into the system).

-.PP
-.B ``Login incorrect.''
-.br
+.It Sy Login incorrect.

 No password file entry for the user name existed.
 No password file entry for the user name existed.

-.PP
-.B ``No remote directory.''
-.br
+.It Sy Remote directory.

 The 
 The 

-.I chdir
+.Xr chdir

 command to the home directory failed.
 command to the home directory failed.

-.PP
-.B ``Permission denied.''
-.br
+.It Sy Permission denied.

 The authentication procedure described above failed.
 The authentication procedure described above failed.

-.PP
-.B ``Can't make pipe.''
-.br
+.It Sy Can't make pipe.

 The pipe needed for the 
 The pipe needed for the 

-.BR stderr ,
+.Em stderr ,

 wasn't created.
 wasn't created.

-.PP
-.B ``Can't fork; try again.''
-.br
+.It Sy Can't fork; try again. 

 A
 A

-.I fork
+.Xr fork

 by the server failed.
 by the server failed.

-.PP
-.B ``<shellname>: ...''
-.br
+.It Sy <shellname>: ...

 The user's login shell could not be started.  This message is returned
 on the connection associated with the
 The user's login shell could not be started.  This message is returned
 on the connection associated with the

-.BR stderr ,
+.Em stderr ,

 and is not preceded by a flag byte.
 and is not preceded by a flag byte.

-.SH SEE ALSO
-rsh(1), rcmd(3), ruserok(3)
-.SH BUGS
+.El
+.Sh SEE ALSO
+.Xr rsh 1 ,
+.Xr rcmd 3 ,
+.Xr ruserok 3
+.Sh BUGS

 The authentication procedure used here assumes the integrity
 of each client machine and the connecting medium.  This is
 insecure, but is useful in an ``open'' environment.
 The authentication procedure used here assumes the integrity
 of each client machine and the connecting medium.  This is
 insecure, but is useful in an ``open'' environment.

-.PP
+.Pp

 A facility to allow all data exchanges to be encrypted should be
 present.
 A facility to allow all data exchanges to be encrypted should be
 present.

-.PP
+.Pp

 A more extensible protocol (such as Telnet) should be used.
 A more extensible protocol (such as Telnet) should be used.