usr.sbin/sliplogin/sliplogin.8

   1 .\"     $NetBSD: sliplogin.8,v 1.8 2002/02/02 01:51:20 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     from: @(#)sliplogin.8   8.2 (Berkeley) 1/5/94
  31 .\"
  32 .Dd January 5, 1994
  33 .Dt SLIPLOGIN 8
  34 .Os
  35 .Sh NAME
  36 .Nm sliplogin
  37 .Nd attach a serial line network interface
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Ar loginname
  41 .Sh DESCRIPTION
  42 .Nm
  43 is used to turn the terminal line on standard input into
  44 a Serial Line IP
  45 .Pq Tn SLIP
  46 link to a remote host.  To do this, the program
  47 searches the file
  48 .Pa /etc/sliphome/slip.hosts
  49 for an entry matching
  50 .Ar loginname
  51 (which defaults to the current login name if omitted).
  52 If a matching entry is found, the line is configured appropriately
  53 for slip (8-bit transparent i/o) and converted to
  54 .Tn SLIP
  55 line
  56 discipline.  Then a shell script is invoked to initialize the slip
  57 interface with the appropriate local and remote
  58 .Tn IP
  59 address,
  60 netmask, etc.
  61 .Pp
  62 The usual initialization script is
  63 .Pa /etc/sliphome/slip.login
  64 but, if particular hosts need special initialization, the file
  65 .Pa /etc/sliphome/slip.login. Ns Ar loginname
  66 will be executed instead if it exists.
  67 The script is invoked with the parameters
  68 .Bl -tag -width slipunit
  69 .It Em slipunit
  70 The unit number of the slip interface assigned to this line.  E.g.,
  71 .Sy 0
  72 for
  73 .Sy sl0 .
  74 .It Em speed
  75 The speed of the line.
  76 .It Em args
  77 The arguments from the
  78 .Pa /etc/sliphome/slip.hosts
  79 entry, in order starting with
  80 .Ar loginname .
  81 .El
  82 .Pp
  83 Only the super-user may attach a network interface.  The interface is
  84 automatically detached when the other end hangs up or the
  85 .Nm
  86 process dies.  If the kernel slip
  87 module has been configured for it, all routes through that interface will
  88 also disappear at the same time.  If there is other processing a site
  89 would like done on hangup, the file
  90 .Pa /etc/sliphome/slip.logout
  91 or
  92 .Pa /etc/sliphome/slip.logout. Ns Ar loginname
  93 is executed if it exists.  It is given the same arguments as the login script.
  94 .Ss Format of /etc/sliphome/slip.hosts
  95 Comments (lines starting with a `#') and blank lines are ignored.
  96 Other lines must start with a
  97 .Ar loginname
  98 but the remaining arguments can be whatever is appropriate for the
  99 .Pa  slip.login
 100 file that will be executed for that name.
 101 Arguments are separated by white space and follow normal
 102 .Xr sh 1
 103 quoting conventions (however,
 104 .Ar loginname
 105 cannot be quoted).
 106 Usually, lines have the form
 107 .Bd -literal -offset indent
 108 loginname local-address remote-address netmask opt-args
 109 .Ed
 110 .Pp
 111 where
 112 .Em local-address
 113 and
 114 .Em remote-address
 115 are the IP host names or addresses of the local and remote ends of the
 116 slip line and
 117 .Em netmask
 118 is the appropriate IP netmask.  These arguments are passed
 119 directly to
 120 .Xr ifconfig 8 .
 121 .Em opt-args
 122 are optional arguments used to configure the line.
 123 .Sh EXAMPLES
 124 The normal use of
 125 .Nm
 126 is to create a
 127 .Pa /etc/passwd
 128 entry for each legal, remote slip site with
 129 .Nm
 130 as the shell for that entry.  E.g.,
 131 .Bd -literal
 132 Sfoo:ikhuy6:2010:1:slip line to foo:/tmp:/usr/sbin/sliplogin
 133 .Ed
 134 .Pp
 135 (Our convention is to name the account used by remote host
 136 .Ar hostname
 137 as
 138 .Em Shostname . )
 139 Then an entry is added to
 140 .Pa slip.hosts
 141 that looks like:
 142 .Pp
 143 .Bd -literal -offset indent -compact
 144 Sfoo    `hostname`      foo     netmask
 145 .Ed
 146 .Pp
 147 where
 148 .Em `hostname`
 149 will be evaluated by
 150 .Xr sh 1
 151 to the local host name and
 152 .Em netmask
 153 is the local host IP netmask.
 154 .Pp
 155 Note that
 156 .Nm
 157 must be setuid to root and, while not a security hole, moral defectives
 158 can use it to place terminal lines in an unusable state and/or deny
 159 access to legitimate users of a remote slip line.  To prevent this,
 160 a site can create a group, say
 161 .Em slip ,
 162 that only the slip login accounts are put in then make sure that
 163 .Pa /usr/sbin/sliplogin
 164 is in group
 165 .Em slip
 166 and mode 4550 (setuid root, only group
 167 .Em slip
 168 can execute binary).
 169 .Sh DIAGNOSTICS
 170 .Nm
 171 logs various information to the system log daemon,
 172 .Xr syslogd 8 ,
 173 with a facility code of
 174 .Em daemon .
 175 The messages are listed here, grouped by severity level.
 176 .Pp
 177 .Sy Error Severity
 178 .Bl -tag -width Ds -compact
 179 .It Sy ioctl (TCGETS): Em reason
 180 A
 181 .Dv TCGETS
 182 .Fn ioctl
 183 to get the line parameters failed.
 184 .Pp
 185 .It Sy ioctl (TCSETS): Em reason
 186 A
 187 .Dv TCSETS
 188 .Fn ioctl
 189 to set the line parameters failed.
 190 .Pp
 191 .It Sy /etc/sliphome/slip.hosts: Em reason
 192 The
 193 .Pa /etc/sliphome/slip.hosts
 194 file could not be opened.
 195 .Pp
 196 .It Sy access denied for Em user
 197 No entry for
 198 .Em user
 199 was found in
 200 .Pa /etc/sliphome/slip.hosts .
 201 .El
 202 .Pp
 203 .Sy Notice Severity
 204 .Bl -tag -width Ds -compact
 205 .It Sy "attaching slip unit" Em unit Sy for Ar loginname
 206 .Tn SLIP
 207 unit
 208 .Em unit
 209 was successfully attached.
 210 .El
 211 .Sh SEE ALSO
 212 .Xr sl 4 ,
 213 .Xr slattach 8 ,
 214 .Xr syslogd 8
 215 .Sh HISTORY
 216 The
 217 .Nm
 218 command
 219 .Bt