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
187 node can operate in two different modes:
188 standard mode described in RFC 2516, and in a non-standard mode compatible
189 with equipment from 3Com.
192 is a client node, it initiates a session using the configured mode.
195 supports both modes simultaneously.
196 This message returns the currently configured mode as a string.
198 form of this message is
199 .Qq Li pppoe_getmode .
200 .It Dv NGM_PPPOE_SETMODE
201 Configure node to the specified mode.
202 The string argument is required.
204 form of this message is
205 .Qq Li pppoe_setmode .
206 For example, the following command will configure the node to initiate
207 the next session in the proprietary 3Com mode:
209 .Dl ngctl msg fxp0:orphans pppoe_setmode "3Com"
212 This node shuts down upon receipt of a
214 control message, when all session have been disconnected or when the
216 hook is disconnected.
218 The following code uses
222 node and connect it to both a socket node and an Ethernet node.
223 It can handle the case of when a
225 node is already attached to the Ethernet.
226 It then starts a client session.
233 #include <sysexits.h>
237 #include <sys/types.h>
238 #include <sys/socket.h>
239 #include <sys/select.h>
240 #include <net/ethernet.h>
242 #include <netgraph.h>
243 #include <netgraph/ng_ether.h>
244 #include <netgraph/ng_pppoe.h>
245 #include <netgraph/ng_socket.h>
246 static int setup(char *ethername, char *service, char *sessname,
253 setup("xl0", NULL, "fred", &fd1, &fd2);
258 setup(char *ethername, char *service, char *sessname,
261 struct ngm_connect ngc; /* connect */
262 struct ngm_mkpeer mkp; /* mkpeer */
263 /******** nodeinfo stuff **********/
264 u_char rbuf[2 * 1024];
265 struct ng_mesg *const resp = (struct ng_mesg *) rbuf;
266 struct hooklist *const hlist
267 = (struct hooklist *) resp->data;
268 struct nodeinfo *const ninfo = &hlist->nodeinfo;
269 int ch, no_hooks = 0;
270 struct linkinfo *link;
271 struct nodeinfo *peer;
272 /****message to connect PPPoE session*****/
274 struct ngpppoe_init_data idata;
277 /********tracking our little graph ********/
279 char source_ID[NG_NODESIZ];
280 char pppoe_node_name[100];
284 * Create the data and control sockets
286 if (NgMkSockNode(NULL, cfd, dfd) < 0) {
290 * find the ether node of the name requested by asking it for
291 * it's inquiry information.
293 if (strlen(ethername) > 16)
295 sprintf(path, "%s:", ethername);
296 if (NgSendMsg(*cfd, path, NGM_GENERIC_COOKIE,
297 NGM_LISTHOOKS, NULL, 0) < 0) {
301 * the command was accepted so it exists. Await the reply (It's
302 * almost certainly already waiting).
304 if (NgRecvMsg(*cfd, resp, sizeof(rbuf), NULL) < 0) {
308 * The following is available about the node:
309 * ninfo->name (string)
310 * ninfo->type (string)
311 * ninfo->id (u_int32_t)
312 * ninfo->hooks (u_int32_t) (count of hooks)
313 * check it is the correct type. and get it's ID for use
316 if (strncmp(ninfo->type, NG_ETHER_NODE_TYPE,
317 strlen(NG_ETHER_NODE_TYPE)) != 0) {
320 sprintf(source_ID, "[%08x]:", ninfo->id);
323 * look for a hook already attached.
325 for (k = 0; k < ninfo->hooks; k++) {
327 * The following are available about each hook.
328 * link->ourhook (string)
329 * link->peerhook (string)
330 * peer->name (string)
331 * peer->type (string)
332 * peer->id (u_int32_t)
333 * peer->hooks (u_int32_t)
335 link = &hlist->link[k];
336 peer = &hlist->link[k].nodeinfo;
338 /* Ignore debug hooks */
339 if (strcmp("debug", link->ourhook) == 0)
342 /* If the orphans hook is attached, use that */
343 if (strcmp(NG_ETHER_HOOK_ORPHAN,
344 link->ourhook) == 0) {
347 /* the other option is the 'divert' hook */
348 if (strcmp("NG_ETHER_HOOK_DIVERT",
349 link->ourhook) == 0) {
355 * See if we found a hook there.
357 if (k < ninfo->hooks) {
358 if (strcmp(peer->type, NG_PPPOE_NODE_TYPE) == 0) {
360 * If it's a type PPPoE, we skip making one
361 * ourself, but we continue, using
364 sprintf(pppoe_node_name, "[%08x]:", peer->id);
367 * There is already someone hogging the data,
368 * return an error. Some day we'll try
376 * Try make a node of type PPPoE against node "ID"
377 * On hook NG_ETHER_HOOK_ORPHAN.
379 snprintf(mkp.type, sizeof(mkp.type),
380 "%s", NG_PPPOE_NODE_TYPE);
381 snprintf(mkp.ourhook, sizeof(mkp.ourhook),
382 "%s", NG_ETHER_HOOK_ORPHAN);
383 snprintf(mkp.peerhook, sizeof(mkp.peerhook),
384 "%s", NG_PPPOE_HOOK_ETHERNET);
386 if (NgSendMsg(*cfd, source_ID, NGM_GENERIC_COOKIE,
387 NGM_MKPEER, &mkp, sizeof(mkp)) < 0) {
391 * Work out a name for the new node.
393 sprintf(pppoe_node_name, "%s:%s",
394 source_ID, NG_ETHER_HOOK_ORPHAN);
397 * We now have a PPPoE node attached to the Ethernet
398 * card. The Ethernet is addressed as ethername: The PPPoE
399 * node is addressed as pppoe_node_name: attach to it.
400 * Connect socket node to specified node Use the same hook
401 * name on both ends of the link.
403 snprintf(ngc.path, sizeof(ngc.path), "%s", pppoe_node_name);
404 snprintf(ngc.ourhook, sizeof(ngc.ourhook), "%s", sessname);
405 snprintf(ngc.peerhook, sizeof(ngc.peerhook), "%s", sessname);
407 if (NgSendMsg(*cfd, ".:", NGM_GENERIC_COOKIE,
408 NGM_CONNECT, &ngc, sizeof(ngc)) < 0) {
414 * In some cases we are speaking to 3Com hardware, so
415 * configure node to non-standard mode.
417 if (NgSendMsg(*cfd, ngc.path, NGM_PPPOE_COOKIE,
418 NGM_PPPOE_SETMODE, NG_PPPOE_NONSTANDARD,
419 strlen(NG_PPPOE_NONSTANDARD) + 1) == -1) {
425 * Send it a message telling it to start up.
427 bzero(&message, sizeof(message));
428 snprintf(message.idata.hook, sizeof(message.idata.hook),
430 if (service == NULL) {
431 message.idata.data_len = 0;
433 snprintf(message.idata.data,
434 sizeof(message.idata.data), "%s", service);
435 message.idata.data_len = strlen(service);
437 /* Tell session/hook to start up as a client */
438 if (NgSendMsg(*cfd, ngc.path,
439 NGM_PPPOE_COOKIE, NGM_PPPOE_CONNECT, &message.idata,
440 sizeof(message.idata) + message.idata.data_len) < 0) {
460 .%T "A Method for transmitting PPP over Ethernet (PPPoE)"
466 node type was implemented in
469 .An Julian Elischer Aq julian@FreeBSD.org