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
48 .In netgraph/ng_pppoe.h
52 node type performs the PPPoE protocol.
53 It is used in conjunction with the
55 extensions to the Ethernet framework to divert and inject Ethernet packets
56 to and from a PPP agent (which is not specified).
59 .Dv NGM_PPPOE_GET_STATUS
60 control message can be used at any time to query the current status
62 The only statistics presently available are the
63 total packet counts for input and output.
64 This node does not yet support
69 This node type supports the following hooks:
71 .Bl -tag -width [unspecified]
73 The hook that should normally be connected to an Ethernet node.
77 Any other name is assumed to be a session hook that will be connected to
78 a PPP client agent, or a PPP server agent.
81 This node type supports the generic control messages, plus the following:
83 .It Dv NGM_PPPOE_GET_STATUS
84 This command returns status information in a
85 .Dv "struct ngpppoestat" :
86 .Bd -literal -offset 4n
88 u_int packets_in; /* packets in from Ethernet */
89 u_int packets_out; /* packets out towards Ethernet */
92 .It Dv NGM_TEXT_STATUS
93 This generic message returns is a human-readable version of the node status.
95 .It Dv NGM_PPPOE_CONNECT
96 Tell a nominated newly created hook that its session should enter
97 the state machine in a manner to become a client.
98 It must be newly created and
99 a service name can be given as an argument.
100 It is legal to specify a zero length service name.
101 This is common on some DSL setups.
102 A session request packet will be broadcast on the Ethernet.
103 This command uses the
104 .Dv ngpppoe_init_data
105 structure shown below.
106 .It Dv NGM_PPPOE_LISTEN
107 Tell a nominated newly created hook that its session should enter
108 the state machine in a manner to become a server listener.
110 given is the name of the service to listen on behalf of
111 a zero length service length will match all requests for service.
112 A matching service request
113 packet will be passed unmodified back to the process responsible
114 for starting the service.
115 It can then examine it and pass it on to
116 the session that is started to answer the request.
117 This command uses the
118 .Dv ngpppoe_init_data
119 structure shown below.
120 .It Dv NGM_PPPOE_OFFER
121 Tell a nominated newly created hook that its session should enter
122 the state machine in a manner to become a server.
123 The argument given is the name of the service to offer.
124 A zero length service
126 The State machine will progress to a state where it will await
127 a request packet to be forwarded to it from the startup server,
128 which in turn probably received it from a LISTEN mode hook ( see above).
130 that information that is required for the session that is embedded in
131 the original session request packet, is made available to the state machine
132 that eventually answers the request.
133 When the Session request packet is
134 received, the session negotiation will proceed.
135 This command uses the
136 .Dv ngpppoe_init_data
137 structure shown below.
140 The three commands above use a common data structure:
141 .Bd -literal -offset 4n
142 struct ngpppoe_init_data {
143 char hook[NG_HOOKSIZ]; /* hook to monitor on */
144 u_int16_t data_len; /* service name length */
145 char data[0]; /* init data goes here */
149 .It Dv NGM_PPPOE_SUCCESS
150 This command is sent to the node that started this session with one of the
151 above messages, and reports a state change.
152 This message reports successful Session negotiation.
153 It uses the structure shown below, and
154 reports back the hook name corresponding to the successful session.
155 .It Dv NGM_NGM_PPPOE_FAIL
156 This command is sent to the node that started this session with one of the
157 above messages, and reports a state change.
158 This message reports failed Session negotiation.
159 It uses the structure shown below, and
160 reports back the hook name corresponding to the failed session.
161 The hook will probably have been removed immediately after sending this message
162 .It Dv NGM_NGM_PPPOE_CLOSE
163 This command is sent to the node that started this session with one of the
164 above messages, and reports a state change.
165 This message reports a request to close a session.
166 It uses the structure shown below, and
167 reports back the hook name corresponding to the closed session.
168 The hook will probably have been removed immediately after sending this
170 At present this message is not yet used and a 'failed' message
171 will be received at closure instead.
172 .It Dv NGM_PPPOE_ACNAME
173 This command is sent to the node that started this session with one of the
174 above messages, and reports the Access Concentrator Name.
177 The four commands above use a common data structure:
178 .Bd -literal -offset 4n
180 char hook[NG_HOOKSIZ]; /* hook associated with event session */
184 .It Dv NGM_PPPOE_GETMODE
185 This command returns the current compatibility mode of the node
188 form of this message is
189 .Qq Li pppoe_getmode .
190 The following keywords are can be returned:
193 The node operates according to RFC 2516.
197 is a PPPoE client, it initiates a session encapsulating packets into
198 incorrect 3Com ethertypes.
199 This compatibility option does not affect server mode.
202 supports both modes simultaneously, depending on the ethertype, the
203 client used when connecting.
207 is a PPPoE server serving only specific Service-Name(s), it will respond
208 to a PADI requests with empty Service-Name tag, returning all available
209 Service-Name(s) on node.
210 This option is necessary for compatibility with D-Link DI-614+ and DI-624+
211 SOHO routers as clients, when serving only specific Service-Name.
212 This compatibility option does not affect client mode.
215 .It Dv NGM_PPPOE_SETMODE
216 Configure node to the specified mode.
217 The string argument is required.
218 This command understands same keywords, that are returned by
219 .Dv NGM_PPPOE_GETMODE
222 form of this message is
223 .Qq Li pppoe_setmode .
224 For example, the following command will configure the node to initiate
225 the next session in the proprietary 3Com mode:
227 .Bd -literal -offset indent
228 ngctl msg fxp0:orphans pppoe_setmode '"3Com"'
232 This node shuts down upon receipt of a
234 control message, when all session have been disconnected or when the
236 hook is disconnected.
238 The following code uses
242 node and connect it to both a socket node and an Ethernet node.
243 It can handle the case of when a
245 node is already attached to the Ethernet.
246 It then starts a client session.
253 #include <sysexits.h>
257 #include <sys/types.h>
258 #include <sys/socket.h>
259 #include <sys/select.h>
260 #include <net/ethernet.h>
262 #include <netgraph.h>
263 #include <netgraph/ng_ether.h>
264 #include <netgraph/ng_pppoe.h>
265 #include <netgraph/ng_socket.h>
266 static int setup(char *ethername, char *service, char *sessname,
273 setup("xl0", NULL, "fred", &fd1, &fd2);
278 setup(char *ethername, char *service, char *sessname,
281 struct ngm_connect ngc; /* connect */
282 struct ngm_mkpeer mkp; /* mkpeer */
283 /******** nodeinfo stuff **********/
284 u_char rbuf[2 * 1024];
285 struct ng_mesg *const resp = (struct ng_mesg *) rbuf;
286 struct hooklist *const hlist
287 = (struct hooklist *) resp->data;
288 struct nodeinfo *const ninfo = &hlist->nodeinfo;
289 int ch, no_hooks = 0;
290 struct linkinfo *link;
291 struct nodeinfo *peer;
292 /****message to connect PPPoE session*****/
294 struct ngpppoe_init_data idata;
297 /********tracking our little graph ********/
299 char source_ID[NG_NODESIZ];
300 char pppoe_node_name[100];
304 * Create the data and control sockets
306 if (NgMkSockNode(NULL, cfd, dfd) < 0) {
310 * find the ether node of the name requested by asking it for
311 * it's inquiry information.
313 if (strlen(ethername) > 16)
315 sprintf(path, "%s:", ethername);
316 if (NgSendMsg(*cfd, path, NGM_GENERIC_COOKIE,
317 NGM_LISTHOOKS, NULL, 0) < 0) {
321 * the command was accepted so it exists. Await the reply (It's
322 * almost certainly already waiting).
324 if (NgRecvMsg(*cfd, resp, sizeof(rbuf), NULL) < 0) {
328 * The following is available about the node:
329 * ninfo->name (string)
330 * ninfo->type (string)
331 * ninfo->id (u_int32_t)
332 * ninfo->hooks (u_int32_t) (count of hooks)
333 * check it is the correct type. and get it's ID for use
336 if (strncmp(ninfo->type, NG_ETHER_NODE_TYPE,
337 strlen(NG_ETHER_NODE_TYPE)) != 0) {
340 sprintf(source_ID, "[%08x]:", ninfo->id);
343 * look for a hook already attached.
345 for (k = 0; k < ninfo->hooks; k++) {
347 * The following are available about each hook.
348 * link->ourhook (string)
349 * link->peerhook (string)
350 * peer->name (string)
351 * peer->type (string)
352 * peer->id (u_int32_t)
353 * peer->hooks (u_int32_t)
355 link = &hlist->link[k];
356 peer = &hlist->link[k].nodeinfo;
358 /* Ignore debug hooks */
359 if (strcmp("debug", link->ourhook) == 0)
362 /* If the orphans hook is attached, use that */
363 if (strcmp(NG_ETHER_HOOK_ORPHAN,
364 link->ourhook) == 0) {
367 /* the other option is the 'divert' hook */
368 if (strcmp("NG_ETHER_HOOK_DIVERT",
369 link->ourhook) == 0) {
375 * See if we found a hook there.
377 if (k < ninfo->hooks) {
378 if (strcmp(peer->type, NG_PPPOE_NODE_TYPE) == 0) {
380 * If it's a type PPPoE, we skip making one
381 * ourself, but we continue, using
384 sprintf(pppoe_node_name, "[%08x]:", peer->id);
387 * There is already someone hogging the data,
388 * return an error. Some day we'll try
396 * Try make a node of type PPPoE against node "ID"
397 * On hook NG_ETHER_HOOK_ORPHAN.
399 snprintf(mkp.type, sizeof(mkp.type),
400 "%s", NG_PPPOE_NODE_TYPE);
401 snprintf(mkp.ourhook, sizeof(mkp.ourhook),
402 "%s", NG_ETHER_HOOK_ORPHAN);
403 snprintf(mkp.peerhook, sizeof(mkp.peerhook),
404 "%s", NG_PPPOE_HOOK_ETHERNET);
406 if (NgSendMsg(*cfd, source_ID, NGM_GENERIC_COOKIE,
407 NGM_MKPEER, &mkp, sizeof(mkp)) < 0) {
411 * Work out a name for the new node.
413 sprintf(pppoe_node_name, "%s:%s",
414 source_ID, NG_ETHER_HOOK_ORPHAN);
417 * We now have a PPPoE node attached to the Ethernet
418 * card. The Ethernet is addressed as ethername: The PPPoE
419 * node is addressed as pppoe_node_name: attach to it.
420 * Connect socket node to specified node Use the same hook
421 * name on both ends of the link.
423 snprintf(ngc.path, sizeof(ngc.path), "%s", pppoe_node_name);
424 snprintf(ngc.ourhook, sizeof(ngc.ourhook), "%s", sessname);
425 snprintf(ngc.peerhook, sizeof(ngc.peerhook), "%s", sessname);
427 if (NgSendMsg(*cfd, ".:", NGM_GENERIC_COOKIE,
428 NGM_CONNECT, &ngc, sizeof(ngc)) < 0) {
434 * In some cases we are speaking to 3Com hardware, so
435 * configure node to non-standard mode.
437 if (NgSendMsg(*cfd, ngc.path, NGM_PPPOE_COOKIE,
438 NGM_PPPOE_SETMODE, NG_PPPOE_NONSTANDARD,
439 strlen(NG_PPPOE_NONSTANDARD) + 1) == -1) {
445 * Send it a message telling it to start up.
447 bzero(&message, sizeof(message));
448 snprintf(message.idata.hook, sizeof(message.idata.hook),
450 if (service == NULL) {
451 message.idata.data_len = 0;
453 snprintf(message.idata.data,
454 sizeof(message.idata.data), "%s", service);
455 message.idata.data_len = strlen(service);
457 /* Tell session/hook to start up as a client */
458 if (NgSendMsg(*cfd, ngc.path,
459 NGM_PPPOE_COOKIE, NGM_PPPOE_CONNECT, &message.idata,
460 sizeof(message.idata) + message.idata.data_len) < 0) {
480 .%T "A Method for transmitting PPP over Ethernet (PPPoE)"
486 node type was implemented in
489 .An Julian Elischer Aq julian@FreeBSD.org