1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
2 .\" All rights reserved.
4 .\" Subject to the following obligations and disclaimer of warranty, use and
5 .\" redistribution of this software, in source or object code forms, with or
6 .\" without modifications are expressly permitted by Whistle Communications;
7 .\" provided, however, that:
8 .\" 1. Any and all reproductions of the source or object code must include the
9 .\" copyright notice above and the following disclaimer of warranties; and
10 .\" 2. No rights are granted, in any manner or form, to use Whistle
11 .\" Communications, Inc. trademarks, including the mark "WHISTLE
12 .\" COMMUNICATIONS" on advertising, endorsements, or otherwise except as
13 .\" such appears in the above copyright notice or in the software.
15 .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
17 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
18 .\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
20 .\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
21 .\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
22 .\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
23 .\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
24 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
25 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
26 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
27 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
33 .\" Author: Archie Cobbs <archie@FreeBSD.org>
36 .\" $Whistle: ng_pppoe.8,v 1.1 1999/01/25 23:46:27 archie Exp $
43 .Nd RFC 2516 PPPoE protocol netgraph node type
46 .In netgraph/ng_pppoe.h
50 node type performs the PPPoE protocol.
51 It is used in conjunction with the
53 extensions to the Ethernet framework to divert and inject Ethernet packets
54 to and from a PPP agent (which is not specified).
57 .Dv NGM_PPPOE_GET_STATUS
58 control message can be used at any time to query the current status
60 The only statistics presently available are the
61 total packet counts for input and output.
62 This node does not yet support
67 This node type supports the following hooks:
69 .Bl -tag -width [unspecified]
71 The hook that should normally be connected to an Ethernet node.
75 Any other name is assumed to be a session hook that will be connected to
76 a PPP client agent, or a PPP server agent.
79 This node type supports the generic control messages, plus the following:
81 .It Dv NGM_PPPOE_GET_STATUS
82 This command returns status information in a
83 .Dv "struct ngpppoestat" :
84 .Bd -literal -offset 4n
86 u_int packets_in; /* packets in from Ethernet */
87 u_int packets_out; /* packets out towards Ethernet */
90 .It Dv NGM_TEXT_STATUS
91 This generic message returns is a human-readable version of the node status.
93 .It Dv NGM_PPPOE_CONNECT
94 Tell a nominated newly created hook that it's session should enter
95 the state machine in a manner to become a client.
96 It must be newly created and
97 a service name can be given as an argument.
98 It is legal to specify a zero length service name.
99 This is common on some DSL setups.
100 A session request packet will be broadcast on the Ethernet.
101 This command uses the
102 .Dv ngpppoe_init_data
103 structure shown below.
104 .It Dv NGM_PPPOE_LISTEN
105 Tell a nominated newly created hook that it's session should enter
106 the state machine in a manner to become a server listener.
108 given is the name of the service to listen on behalf of
109 a zero length service length will match all requests for service.
110 A matching service request
111 packet will be passed unmodified back to the process responsible
112 for starting the service.
113 It can then examine it and pass it on to
114 the session that is started to answer the request.
115 This command uses the
116 .Dv ngpppoe_init_data
117 structure shown below.
118 .It Dv NGM_PPPOE_OFFER
119 Tell a nominated newly created hook that it's session should enter
120 the state machine in a manner to become a server.
121 The argument given is the name of the service to offer.
122 A zero length service
124 The State machine will progress to a state where it will await
125 a request packet to be forwarded to it from the startup server,
126 which in turn probably received it from a LISTEN mode hook ( see above).
128 that information that is required for the session that is embedded in
129 the original session request packet, is made available to the state machine
130 that eventually answers the request.
131 When the Session request packet is
132 received, the session negotiation will proceed.
133 This command uses the
134 .Dv ngpppoe_init_data
135 structure shown below.
138 The three commands above use a common data structure:
139 .Bd -literal -offset 4n
140 struct ngpppoe_init_data {
141 char hook[NG_HOOKSIZ]; /* hook to monitor on */
142 u_int16_t data_len; /* service name length */
143 char data[0]; /* init data goes here */
147 .It Dv NGM_PPPOE_SUCCESS
148 This command is sent to the node that started this session with one of the
149 above messages, and reports a state change.
150 This message reports successful Session negotiation.
151 It uses the structure shown below, and
152 reports back the hook name corresponding to the successful session.
153 .It Dv NGM_NGM_PPPOE_FAIL
154 This command is sent to the node that started this session with one of the
155 above messages, and reports a state change.
156 This message reports failed Session negotiation.
157 It uses the structure shown below, and
158 reports back the hook name corresponding to the failed session.
159 The hook will probably have been removed immediately after sending this message
160 .It Dv NGM_NGM_PPPOE_CLOSE
161 This command is sent to the node that started this session with one of the
162 above messages, and reports a state change.
163 This message reports a request to close a session.
164 It uses the structure shown below, and
165 reports back the hook name corresponding to the closed session.
166 The hook will probably have been removed immediately after sending this
168 At present this message is not yet used and a 'failed' message
169 will be received at closure instead.
170 .It Dv NGM_PPPOE_ACNAME
171 This command is sent to the node that started this session with one of the
172 above messages, and reports the Access Concentrator Name.
175 The four commands above use a common data structure:
176 .Bd -literal -offset 4n
178 char hook[NG_HOOKSIZ]; /* hook associated with event session */
182 .It Dv NGM_PPPOE_GETMODE
185 node can operate in two different modes:
186 standard mode described in RFC 2516, and in a non-standard mode compatible
187 with equipment from 3Com.
190 is a client node, it initiates a session using the configured mode.
193 supports both modes simultaneously.
194 This message returns the currently configured mode as a string.
196 form of this message is
197 .Qq Li pppoe_getmode .
198 .It Dv NGM_PPPOE_SETMODE
199 Configure node to the specified mode.
200 The string argument is required.
202 form of this message is
203 .Qq Li pppoe_setmode .
204 For example, the following command will configure the node to initiate
205 the next session in the proprietary 3Com mode:
207 .Dl ngctl msg fxp0:orphans pppoe_setmode "3Com"
210 This node shuts down upon receipt of a
212 control message, when all session have been disconnected or when the
214 hook is disconnected.
217 .Va net.graph.nonstandard_pppoe
218 is a deprecated way to set
222 .Dv NGM_PPPOE_SETMODE
223 or an appropriate option in your client software instead.
225 The following code uses
229 node and connect it to both a socket node and an Ethernet node.
230 It can handle the case of when a
232 node is already attached to the Ethernet.
233 It then starts a client session.
240 #include <sysexits.h>
244 #include <sys/types.h>
245 #include <sys/socket.h>
246 #include <sys/select.h>
247 #include <net/ethernet.h>
249 #include <netgraph.h>
250 #include <netgraph/ng_ether.h>
251 #include <netgraph/ng_pppoe.h>
252 #include <netgraph/ng_socket.h>
253 static int setup(char *ethername, char *service, char *sessname,
260 setup("xl0", NULL, "fred", &fd1, &fd2);
265 setup(char *ethername, char *service, char *sessname,
268 struct ngm_connect ngc; /* connect */
269 struct ngm_mkpeer mkp; /* mkpeer */
270 /******** nodeinfo stuff **********/
271 u_char rbuf[2 * 1024];
272 struct ng_mesg *const resp = (struct ng_mesg *) rbuf;
273 struct hooklist *const hlist
274 = (struct hooklist *) resp->data;
275 struct nodeinfo *const ninfo = &hlist->nodeinfo;
276 int ch, no_hooks = 0;
277 struct linkinfo *link;
278 struct nodeinfo *peer;
279 /****message to connect PPPoE session*****/
281 struct ngpppoe_init_data idata;
284 /********tracking our little graph ********/
286 char source_ID[NG_NODESIZ];
287 char pppoe_node_name[100];
291 * Create the data and control sockets
293 if (NgMkSockNode(NULL, cfd, dfd) < 0) {
297 * find the ether node of the name requested by asking it for
298 * it's inquiry information.
300 if (strlen(ethername) > 16)
302 sprintf(path, "%s:", ethername);
303 if (NgSendMsg(*cfd, path, NGM_GENERIC_COOKIE,
304 NGM_LISTHOOKS, NULL, 0) < 0) {
308 * the command was accepted so it exists. Await the reply (It's
309 * almost certainly already waiting).
311 if (NgRecvMsg(*cfd, resp, sizeof(rbuf), NULL) < 0) {
315 * The following is available about the node:
316 * ninfo->name (string)
317 * ninfo->type (string)
318 * ninfo->id (u_int32_t)
319 * ninfo->hooks (u_int32_t) (count of hooks)
320 * check it is the correct type. and get it's ID for use
323 if (strncmp(ninfo->type, NG_ETHER_NODE_TYPE,
324 strlen(NG_ETHER_NODE_TYPE)) != 0) {
327 sprintf(source_ID, "[%08x]:", ninfo->id);
330 * look for a hook already attached.
332 for (k = 0; k < ninfo->hooks; k++) {
334 * The following are available about each hook.
335 * link->ourhook (string)
336 * link->peerhook (string)
337 * peer->name (string)
338 * peer->type (string)
339 * peer->id (u_int32_t)
340 * peer->hooks (u_int32_t)
342 link = &hlist->link[k];
343 peer = &hlist->link[k].nodeinfo;
345 /* Ignore debug hooks */
346 if (strcmp("debug", link->ourhook) == 0)
349 /* If the orphans hook is attached, use that */
350 if (strcmp(NG_ETHER_HOOK_ORPHAN,
351 link->ourhook) == 0) {
354 /* the other option is the 'divert' hook */
355 if (strcmp("NG_ETHER_HOOK_DIVERT",
356 link->ourhook) == 0) {
362 * See if we found a hook there.
364 if (k < ninfo->hooks) {
365 if (strcmp(peer->type, NG_PPPOE_NODE_TYPE) == 0) {
367 * If it's a type PPPoE, we skip making one
368 * ourself, but we continue, using
371 sprintf(pppoe_node_name, "[%08x]:", peer->id);
374 * There is already someone hogging the data,
375 * return an error. Some day we'll try
383 * Try make a node of type PPPoE against node "ID"
384 * On hook NG_ETHER_HOOK_ORPHAN.
386 snprintf(mkp.type, sizeof(mkp.type),
387 "%s", NG_PPPOE_NODE_TYPE);
388 snprintf(mkp.ourhook, sizeof(mkp.ourhook),
389 "%s", NG_ETHER_HOOK_ORPHAN);
390 snprintf(mkp.peerhook, sizeof(mkp.peerhook),
391 "%s", NG_PPPOE_HOOK_ETHERNET);
393 if (NgSendMsg(*cfd, source_ID, NGM_GENERIC_COOKIE,
394 NGM_MKPEER, &mkp, sizeof(mkp)) < 0) {
398 * Work out a name for the new node.
400 sprintf(pppoe_node_name, "%s:%s",
401 source_ID, NG_ETHER_HOOK_ORPHAN);
404 * We now have a PPPoE node attached to the Ethernet
405 * card. The Ethernet is addressed as ethername: The PPPoE
406 * node is addressed as pppoe_node_name: attach to it.
407 * Connect socket node to specified node Use the same hook
408 * name on both ends of the link.
410 snprintf(ngc.path, sizeof(ngc.path), "%s", pppoe_node_name);
411 snprintf(ngc.ourhook, sizeof(ngc.ourhook), "%s", sessname);
412 snprintf(ngc.peerhook, sizeof(ngc.peerhook), "%s", sessname);
414 if (NgSendMsg(*cfd, ".:", NGM_GENERIC_COOKIE,
415 NGM_CONNECT, &ngc, sizeof(ngc)) < 0) {
421 * In some cases we are speaking to 3Com hardware, so
422 * configure node to non-standard mode.
424 if (NgSendMsg(*cfd, ngc.path, NGM_PPPOE_COOKIE,
425 NGM_PPPOE_SETMODE, NG_PPPOE_NONSTANDARD,
426 strlen(NG_PPPOE_NONSTANDARD) + 1) == -1) {
432 * Send it a message telling it to start up.
434 bzero(&message, sizeof(message));
435 snprintf(message.idata.hook, sizeof(message.idata.hook),
437 if (service == NULL) {
438 message.idata.data_len = 0;
440 snprintf(message.idata.data,
441 sizeof(message.idata.data), "%s", service);
442 message.idata.data_len = strlen(service);
444 /* Tell session/hook to start up as a client */
445 if (NgSendMsg(*cfd, ngc.path,
446 NGM_PPPOE_COOKIE, NGM_PPPOE_CONNECT, &message.idata,
447 sizeof(message.idata) + message.idata.data_len) < 0) {
467 .%T "A Method for transmitting PPP over Ethernet (PPPoE)"
473 node type was implemented in
476 .An Julian Elischer Aq julian@FreeBSD.org