BSD 4_3_Net_2 release

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

diff --git a/usr/src/libexec/rlogind/rlogind.8 b/usr/src/libexec/rlogind/rlogind.8
index 52df677..710d70e 100644 (file)
--- a/usr/src/libexec/rlogind/rlogind.8
+++ b/usr/src/libexec/rlogind/rlogind.8
@@ -1,118 +1,168 @@
-.\" Copyright (c) 1983 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.
 .\"

-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not be used to endorse or promote products derived
-.\" from this software without specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-.\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.

 .\"
 .\"

-.\"    @(#)rlogind.8   6.6 (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 RLOGIND 8 ""
-.UC 5
-.SH NAME
-rlogind \- remote login server
-.SH SYNOPSIS
-.B /etc/rlogind
-[
-.B \-dl
-]
-.SH DESCRIPTION
-.I Rlogind
+.\"     @(#)rlogind.8  6.12 (Berkeley) 3/16/91
+.\"
+.Dd March 16, 1991
+.Dt RLOGIND 8
+.Os BSD 4.2
+.Sh NAME
+.Nm rlogind
+.Nd remote login server
+.Sh SYNOPSIS
+.Nm rlogind
+.Op Fl aln
+.Sh DESCRIPTION
+.Nm Rlogind

 is the server for the 
 is the server for the 

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

 program.  The server provides a remote login facility
 with authentication based on privileged port numbers from trusted hosts.
 program.  The server provides a remote login facility
 with authentication based on privileged port numbers from trusted hosts.

-.PP
-.I Rlogind
+.Pp
+Options supported by
+.Nm rlogind :
+.Bl -tag -width Ds
+.It Fl a
+Ask hostname for verification.
+.It Fl l
+Prevent any authentication based on the user's
+.Dq Pa .rhosts
+file, unless the user is logging in as the superuser.
+.It Fl n
+Disable keep-alive messages.
+.El
+.Pp
+.Nm Rlogind

 listens for service requests at the port indicated in
 the ``login'' service specification; see
 listens for service requests at the port indicated in
 the ``login'' 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.
 The server checks the client's source port.

-If the port is not in the range 0-1023, the server
+If the port is not in the range 512-1023, the server

 aborts the connection.
 aborts the connection.

-.IP 2)
+.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 cannot be determined,
 the dot-notation representation of the host address is used.

-.PP
+If the hostname is in the same domain as the server (according to
+the last two components of the domain name),
+or if the
+.Fl a
+option is given,
+the addresses for the hostname are requested,
+verifying that the name and address correspond.
+Normal authentication is bypassed if the address verification fails.
+.El
+.Pp

 Once the source port and address have been checked, 
 Once the source port and address have been checked, 

-.I rlogind
-allocates a pseudo terminal (see 
-.IR pty (4)),
+.Nm rlogind
+proceeds with the authentication process described in
+.Xr rshd 8 .
+It then allocates a pseudo terminal (see 
+.Xr pty 4 ) ,

 and manipulates file descriptors so that the slave
 half of the pseudo terminal becomes the 
 and manipulates file descriptors so that the slave
 half of the pseudo terminal becomes the 

-.B stdin ,
-.B stdout ,
+.Em stdin ,
+.Em stdout ,

 and
 and

-.B stderr 
+.Em stderr

 for a login process.
 The login process is an instance of the
 for a login process.
 The login process is an instance of the

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

 program, invoked with the
 program, invoked with the

-.B \-r
-option.  The login process then proceeds with the authentication
-process as described in
-.IR rshd (8),
-but if automatic authentication fails, it reprompts the user
-to login as one finds on a standard terminal line.  The
-.I -l
-option prevents any authentication based on the user's
-``.rhosts'' file, unless the user is the superuser.
-.PP
+.Fl f
+option if authentication has succeeded.
+If automatic authentication fails, the user is
+prompted to log in as if on a standard terminal line.
+.Pp

 The parent of the login process manipulates the master side of
 The parent of the login process manipulates the master side of

-the pseduo terminal, operating as an intermediary
+the pseudo terminal, operating as an intermediary

 between the login process and the client instance of the
 between the login process and the client instance of the

-.I rlogin
+.Xr rlogin

 program.  In normal operation, the packet protocol described
 in
 program.  In normal operation, the packet protocol described
 in

-.IR pty (4)
-is invoked to provide ^S/^Q type facilities and propagate
+.Xr pty 4
+is invoked to provide
+.Ql ^S/^Q
+type facilities and propagate

 interrupt signals to the remote programs.  The login process
 propagates the client terminal's baud rate and terminal type,
 interrupt signals to the remote programs.  The login process
 propagates the client terminal's baud rate and terminal type,

-as found in the environment variable, ``TERM''; see
-.IR environ (7).
+as found in the environment variable,
+.Ql Ev TERM ;
+see
+.Xr environ 7 .

 The screen or window size of the terminal is requested from the client,
 and window size changes from the client are propagated to the pseudo terminal.
 The screen or window size of the terminal is requested from the client,
 and window size changes from the client are propagated to the pseudo terminal.

-.SH DIAGNOSTICS
-All diagnostic messages are returned on the connection
-associated with the
-.BR stderr ,
+.Pp
+Transport-level keepalive messages are enabled unless the
+.Fl n
+option is present.
+The use of keepalive messages allows sessions to be timed out
+if the client crashes or becomes unreachable.
+.Sh DIAGNOSTICS
+All initial diagnostic messages are indicated
+by a leading byte with a value of 1,

 after which any network connections are closed.
 after which any network connections are closed.

-An error is indicated by a leading byte with a value of 1.
-.PP
-.B ``Try again.''
-.br
+If there are no errors before
+.Xr login
+is invoked, a null byte is returned as in indication of success.
+.Bl -tag -width Ds
+.It Sy Try again.

 A
 A

-.I fork
+.Xr fork

 by the server failed.
 by the server failed.

-.PP
-.B ``/bin/sh: ...''
-.br
-The user's login shell could not be started.
-.SH "SEE ALSO"
-ruserok(3), rshd(8)
-.SH BUGS
+.El
+.Sh SEE ALSO
+.Xr login 1 ,
+.Xr ruserok 3 ,
+.Xr rshd 8
+.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 should be used.
 A more extensible protocol should be used.

+.Sh HISTORY
+The
+.Nm
+command appeared in
+.Bx 4.2 .