share/man/man4/sppp.4

   1 .\"
   2 .\" Copyright (c) 1997, 2001 Joerg Wunsch
   3 .\"
   4 .\" 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 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd May 25, 2008
  29 .Dt SPPP 4
  30 .Os
  31 .Sh NAME
  32 .Nm sppp
  33 .Nd point to point protocol network layer for synchronous lines
  34 .Sh SYNOPSIS
  35 .Cd "device sppp"
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 network layer implements the state machine and the Link Control
  40 Protocol (LCP) of the
  41 .Em point to point protocol (PPP)
  42 as described in RFC 1661.
  43 Note that this layer does not provide
  44 network interfaces of its own, it is rather intended to be layered on
  45 top of drivers providing a synchronous point-to-point connection that
  46 wish to run a PPP stack over it.
  47 The corresponding network interfaces
  48 have to be provided by these hardware drivers.
  49 .Pp
  50 The
  51 .Nm
  52 layer provides three basic modes of operation.
  53 The default mode,
  54 with no special flags to be set, is to create the PPP connection
  55 (administrative
  56 .Em Open
  57 event to the LCP layer) as soon as the interface is taken up with the
  58 .Xr ifconfig 8
  59 command.
  60 Taking the interface down again will terminate the LCP layer
  61 and thus all other layers on top.
  62 The link will also terminate itself as
  63 soon as no Network Control Protocol (NCP) is open anymore, indicating
  64 that the lower layers are no longer needed.
  65 .Pp
  66 Setting the link-level flag
  67 .Em link0
  68 with
  69 .Xr ifconfig 8
  70 will cause the respective network interface to go into
  71 .Em passive
  72 mode.
  73 This means, the administrative
  74 .Em Open
  75 event to the LCP layer will be delayed until after the lower layers
  76 signals an
  77 .Em Up
  78 event (rise of
  79 .Dq carrier ) .
  80 This can be used by lower layers to support
  81 a dialin connection where the physical layer is not available
  82 immediately at startup, but only after some external event arrives.
  83 Receipt of a
  84 .Em Down
  85 event from the lower layer will not take the interface completely down
  86 in this case.
  87 .Pp
  88 Finally, setting the flag
  89 .Em link1
  90 will cause the interface to operate in
  91 .Em dial-on-demand
  92 mode.
  93 This is also only useful if the lower layer supports the notion
  94 of a carrier.
  95 Upon configuring the
  96 respective interface, it will delay the administrative
  97 .Em Open
  98 event to the LCP layer until either an outbound network packet
  99 arrives, or until the lower layer signals an
 100 .Em Up
 101 event, indicating an inbound connection.
 102 As with passive mode, receipt
 103 of a
 104 .Em Down
 105 event (loss of carrier) will not automatically take the interface down,
 106 thus it remains available for further connections.
 107 .Pp
 108 The
 109 .Nm
 110 layer supports the
 111 .Em debug
 112 interface flag that can be set with
 113 .Xr ifconfig 8 .
 114 If this flag is set, the various control protocol packets being
 115 exchanged as well as the option negotiation between both ends of the
 116 link will be logged at level
 117 .Dv LOG_DEBUG .
 118 This can be helpful to examine configuration problems during the first
 119 attempts to set up a new configuration.
 120 Without this flag being set,
 121 only the major phase transitions will be logged at level
 122 .Dv LOG_INFO .
 123 .Pp
 124 It is possible to leave the local interface IP address open for
 125 negotiation by setting it to 0.0.0.0.
 126 This requires that the remote
 127 peer can correctly supply a value for it based on the identity of the
 128 caller, or on the remote address supplied by this side.
 129 Due to the
 130 way the IPCP option negotiation works, this address is being supplied
 131 late during the negotiation, which might cause the remote peer to make
 132 wrong assumptions.
 133 .Pp
 134 In a similar spirit the remote address can be set to the magical
 135 value
 136 .Li 0.0.0. Ns Em *
 137 which means that we do not care what address the remote
 138 side will use, as long as it is not 0.0.0.0.
 139 This is useful if your ISP has several dial-in
 140 servers.
 141 You can of course
 142 .Nm route Cm add Ar something_or_other 0.0.0. Ns Em *
 143 and it will do exactly what you would want it to.
 144 .Pp
 145 The PAP and CHAP authentication protocols as described in RFC 1334,
 146 and RFC 1994 resp., are also implemented.
 147 Their parameters are being
 148 controlled by the
 149 .Xr spppcontrol 8
 150 utility.
 151 .Pp
 152 VJ header compression is implemented, and enabled by default.
 153 It can be
 154 disabled using
 155 .Xr spppcontrol 8 .
 156 .Sh DIAGNOSTICS
 157 .Bl -diag
 158 .It <ifname><ifnum>: <proto> illegal <event> in state <statename>
 159 An event happened that should not happen for the current state
 160 the respective control protocol is in.
 161 See RFC 1661 for a description
 162 of the state automaton.
 163 .It <ifname><ifnum>: loopback
 164 The state automaton detected a line loopback (that is, it was talking
 165 with itself).
 166 The interface will be temporarily disabled.
 167 .It <ifname><ifnum>: up
 168 The LCP layer is running again, after a line loopback had previously
 169 been detected.
 170 .It <ifname><ifnum>: down
 171 The keepalive facility detected the line being unresponsive.
 172 Keepalive must be explicitly requested by the lower layers in order to
 173 take place.
 174 .El
 175 .Sh SEE ALSO
 176 .Xr inet 4 ,
 177 .Xr intro 4 ,
 178 .Xr ppp 4 ,
 179 .Xr ifconfig 8 ,
 180 .Xr spppcontrol 8
 181 .Rs
 182 .%A W. Simpson, Editor
 183 .%T "The Point-to-Point Protocol (PPP)"
 184 .%O RFC 1661
 185 .Re
 186 .Rs
 187 .%A G. McGregor
 188 .%T "The PPP Internet Protocol Control Protocol (IPCP)"
 189 .%O RFC 1332
 190 .Re
 191 .Rs
 192 .%A B. Lloyd
 193 .%A W. Simpson
 194 .%T "PPP Authentication Protocols"
 195 .%O RFC 1334
 196 .Re
 197 .Rs
 198 .%A W. Simpson
 199 .%T "PPP Challenge Handshake Authentication Protocol (CHAP)"
 200 .%O RFC 1994
 201 .Re
 202 .Sh AUTHORS
 203 .An -nosplit
 204 The original implementation of
 205 .Nm
 206 was written in 1994 at Cronyx Ltd., Moscow by
 207 .An Serge Vakulenko Aq vak@cronyx.ru .
 208 .An J\(:org Wunsch
 209 .Aq joerg_wunsch@uriah.heep.sax.de
 210 rewrote a large part in 1997 in order
 211 to fully implement the state machine as described in RFC 1661, so it
 212 could also be used for dialup lines.
 213 He also wrote this man page.
 214 Serge later on wrote a basic implementation for PAP and CHAP, which
 215 served as the base for the current implementation, done again by
 216 .An J\(:org Wunsch .
 217 .Sh BUGS
 218 Many.
 219 .Pp
 220 Currently, only the
 221 .Em IPCP
 222 control protocol and
 223 .Xr ip 4
 224 network protocol is supported.
 225 More NCPs should be implemented, as well as other control protocols
 226 for authentication and link quality reporting.
 227 .Pp
 228 Negotiation loop avoidance is not fully implemented.
 229 If the negotiation
 230 does not converge, this can cause an endless loop.
 231 .Pp
 232 The various parameters that should be adjustable per RFC 1661 are
 233 currently hard-coded into the kernel, and should be made accessible
 234 through
 235 .Xr spppcontrol 8 .
 236 .Pp
 237 .Em Passive
 238 mode has not been tested extensively.
 239 .Pp
 240 Link-level compression protocols should be supported.