summaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
authorReyk Floeter <reyk@cvs.openbsd.org>2006-05-17 03:29:56 +0000
committerReyk Floeter <reyk@cvs.openbsd.org>2006-05-17 03:29:56 +0000
commita807f14a489dbde079bbf3334b1fc6935ef23a3f (patch)
tree5ba13f8d4e0d4ae31bdad5d61443daac642024b9 /share/man
parent1f1fdb3d9dccd95363baefa04b041bcfd621c85e (diff)
implement support for sppp(4) in ifconfig. have a look at the updated
manual pages pppoe(4) and sppp(4) for examples. the spppcontrol(8) utility is not required anymore and will probably be removed in the near future. ok deraadt@
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/pppoe.416
-rw-r--r--share/man/man4/sppp.467
2 files changed, 68 insertions, 15 deletions
diff --git a/share/man/man4/pppoe.4 b/share/man/man4/pppoe.4
index 8ba8faba84e..1d2a734cbd8 100644
--- a/share/man/man4/pppoe.4
+++ b/share/man/man4/pppoe.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: pppoe.4,v 1.7 2005/10/06 15:30:50 jmc Exp $
+.\" $OpenBSD: pppoe.4,v 1.8 2006/05/17 03:29:55 reyk Exp $
.\" $NetBSD: pppoe.4,v 1.26 2003/10/02 07:06:36 wiz Exp $
.\"
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
@@ -93,7 +93,7 @@ As noted above it must be marked UP, but need not have an IP address.
Configure authentication.
The PPP session needs to identify the client to the peer.
For more details on the available options see
-.Xr spppcontrol 8 .
+.Xr ifconfig 8 .
.El
.Pp
This all is typically accomplished using an
@@ -104,13 +104,9 @@ A typical
.Pa /etc/hostname.pppoe0
file looks like this:
.Bd -literal -offset indent
-pppoedev ne0
-!/sbin/ifconfig ne0 up
-!/usr/sbin/spppcontrol \e$if myauthproto=pap myauthname=testcaller \e
- myauthkey=donttell
-!/sbin/ifconfig \e$if inet 0.0.0.0 0.0.0.1 netmask 0xffffffff
+inet 0.0.0.0 255.255.255.255 0.0.0.1 pppoedev ne0 \e
+ authproto pap authname testcaller authkey donttell up
!/sbin/route add default 0.0.0.1
-up
.Ed
.Pp
Since this is a PPP interface, the addresses assigned to the interface
@@ -238,7 +234,7 @@ for more information on MTU, MSS, and NAT.
.Xr ifconfig 8 ,
.Xr ppp 8 ,
.Xr pppoe 8 ,
-.Xr spppcontrol 8
+.Xr sppp 4
.Rs
.%R RFC 2516
.%T A Method for Transmitting PPP Over Ethernet (PPPoE)
@@ -253,7 +249,7 @@ device first appeared in
This implementation is client side only.
.Pp
It is important to specify
-.Dq Li netmask 0xffffffff
+.Dq Li netmask 255.255.255.255
to
.Xr ifconfig 8 .
If the netmask is unspecified, it will be set to 8 when 0.0.0.0 is
diff --git a/share/man/man4/sppp.4 b/share/man/man4/sppp.4
index f9bb6562ea8..3cd97b8c211 100644
--- a/share/man/man4/sppp.4
+++ b/share/man/man4/sppp.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sppp.4,v 1.9 2003/05/05 13:51:58 jmc Exp $
+.\" $OpenBSD: sppp.4,v 1.10 2006/05/17 03:29:55 reyk Exp $
.\"
.\" Copyright (c) 1997 Joerg Wunsch
.\"
@@ -137,7 +137,7 @@ and it will do exactly what you would want it to.
The PAP and CHAP authentication protocols as described in RFC 1334,
and RFC 1994 resp., are also implemented.
Their parameters are being controlled by the
-.Xr spppcontrol 8
+.Xr ifconfig 8
utility.
.Sh DIAGNOSTICS
.Bl -diag
@@ -157,11 +157,54 @@ The keepalive facility detected the line being unresponsive.
Keepalive must be explicitly requested by the lower layers in order to
take place.
.El
+.Sh EXAMPLES
+Display the settings for pppoe0.
+The interface is currently in the
+.Em establish
+phase and tries to connect to the remote peer,
+other possible PPP phases are
+.Em dead ,
+.Em authenticate ,
+.Em network ,
+or
+.Em terminate .
+Both ends of the connection use the CHAP protocol, the local client
+tells the remote peer the system name
+.Ql uriah ,
+and the peer is expected to authenticate by the name
+.Ql ifb-gw .
+Once the initial CHAP handshake was successful, no further CHAP
+challenges will be transmitted.
+There are supposedly some known CHAP secrets for both ends of the link
+which are not displayed.
+.Bd -literal -offset indent
+$ ifconfig pppoe0
+pppoe0: flags=8851<UP,POINTOPOINT,RUNNING,SIMPLEX,MULTICAST> mtu 1492
+ dev: em0 state: PADI sent
+ sid: 0x0 PADI retries: 0 PADR retries: 0
+ sppp: phase establish authproto chap authname "uriah" \e
+ peerproto chap peername "ifb-gw" norechallenge
+ groups: pppoe
+ inet 0.0.0.0 --> 0.0.0.1 netmask 0xffffffff
+.Ed
+.Pp
+A possible call to
+.Xr ifconfig 8
+that could have been used to bring the interface into the state shown
+by the previous example:
+.Bd -literal -offset indent
+# ifconfig pppoe0 0.0.0.0 0.0.0.1 netmask 0xffffffff \e
+ pppoedev em0 \e
+ authproto chap authname uriah authkey "some secret" \e
+ peerproto chap peername "ifb-gw" peerkey "another" \e
+ peerflag norechallenge \e
+ up
+.Ed
.Sh SEE ALSO
.Xr inet 4 ,
.Xr ifconfig 8 ,
.Xr ppp 8 ,
-.Xr spppcontrol 8
+.Xr pppoe 4
.Rs
.%A W. Simpson, Editor
.%T "The Point-to-Point Protocol (PPP)"
@@ -193,11 +236,25 @@ was written in 1994 at Cronyx Ltd., Moscow by
rewrote a large part in 1997 in order
to fully implement the state machine as described in RFC 1661, so it
could also be used for dialup lines.
-He also wrote this man page.
+He also wrote the initial version of this man page.
Serge later on wrote a basic implementation for PAP and CHAP, which
served as the base for the current implementation, done again by
.ie t J\(:org Wunsch.
.el Joerg Wunsch.
+.Pp
+.ie t Reyk Fl\(:oter
+.el Reyk Floeter
+implemented
+.Nm
+support for
+.Xr ifconfig 8
+in
+.Ox 4.0
+in order to remove the original
+.Ql spppcontrol
+utility, which has been previously used to configure and display the
+.Nm
+settings.
.Sh BUGS
Many.
.Pp
@@ -213,7 +270,7 @@ If the negotiation doesn't converge, this can cause an endless loop.
The various parameters that should be adjustable per RFC 1661 are
currently hard-coded into the kernel, and should be made accessible
through
-.Xr spppcontrol 8 .
+.Xr ifconfig 8 .
.Pp
.Em Passive
mode has not been tested extensively.