5 * Copyright (c) 1996-1999 Whistle Communications, Inc.
8 * Subject to the following obligations and disclaimer of warranty, use and
9 * redistribution of this software, in source or object code forms, with or
10 * without modifications are expressly permitted by Whistle Communications;
11 * provided, however, that:
12 * 1. Any and all reproductions of the source or object code must include the
13 * copyright notice above and the following disclaimer of warranties; and
14 * 2. No rights are granted, in any manner or form, to use Whistle
15 * Communications, Inc. trademarks, including the mark "WHISTLE
16 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17 * such appears in the above copyright notice or in the software.
19 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
37 * Author: Julian Elischer <julian@freebsd.org>
39 * $FreeBSD: src/sys/netgraph/ng_pppoe.c,v 1.23.2.17 2002/07/02 22:17:18 archie Exp $
40 * $DragonFly: src/sys/netgraph/pppoe/ng_pppoe.c,v 1.6 2004/09/16 03:43:09 dillon Exp $
41 * $Whistle: ng_pppoe.c,v 1.10 1999/11/01 09:24:52 julian Exp $
44 #define AAA printf("pppoe: %s\n", __FUNCTION__ );
45 #define BBB printf("-%d-", __LINE__ );
51 #include <sys/param.h>
52 #include <sys/systm.h>
53 #include <sys/kernel.h>
55 #include <sys/malloc.h>
56 #include <sys/errno.h>
57 #include <sys/sysctl.h>
58 #include <sys/syslog.h>
59 #include <net/ethernet.h>
61 #include <netgraph/ng_message.h>
62 #include <netgraph/netgraph.h>
65 #define SIGNOFF "session closed"
68 * This section contains the netgraph method declarations for the
69 * pppoe node. These methods define the netgraph pppoe 'type'.
72 static ng_constructor_t ng_pppoe_constructor;
73 static ng_rcvmsg_t ng_pppoe_rcvmsg;
74 static ng_shutdown_t ng_pppoe_rmnode;
75 static ng_newhook_t ng_pppoe_newhook;
76 static ng_connect_t ng_pppoe_connect;
77 static ng_rcvdata_t ng_pppoe_rcvdata;
78 static ng_disconnect_t ng_pppoe_disconnect;
80 /* Netgraph node type descriptor */
81 static struct ng_type typestruct = {
96 NETGRAPH_INIT(pppoe, &typestruct);
99 * States for the session state machine.
100 * These have no meaning if there is no hook attached yet.
103 PPPOE_SNONE=0, /* [both] Initial state */
104 PPPOE_LISTENING, /* [Daemon] Listening for discover initiation pkt */
105 PPPOE_SINIT, /* [Client] Sent discovery initiation */
106 PPPOE_PRIMED, /* [Server] Awaiting PADI from daemon */
107 PPPOE_SOFFER, /* [Server] Sent offer message (got PADI)*/
108 PPPOE_SREQ, /* [Client] Sent a Request */
109 PPPOE_NEWCONNECTED, /* [Server] Connection established, No data received */
110 PPPOE_CONNECTED, /* [Both] Connection established, Data received */
111 PPPOE_DEAD /* [Both] */
114 #define NUMTAGS 20 /* number of tags we are set up to work with */
117 * Information we store for each hook on each node for negotiating the
118 * session. The mbuf and cluster are freed once negotiation has completed.
119 * The whole negotiation block is then discarded.
123 struct mbuf *m; /* holds cluster with last sent packet */
124 union packet *pkt; /* points within the above cluster */
125 struct callout timeout_ch;
126 u_int timeout; /* 0,1,2,4,8,16 etc. seconds */
128 const struct pppoe_tag *tags[NUMTAGS];
132 struct datatag service;
133 struct datatag ac_name;
135 typedef struct sess_neg *negp;
138 * Session information that is needed after connection.
142 u_int16_t Session_ID;
144 char creator[NG_NODELEN + 1]; /* who to notify */
145 struct pppoe_full_hdr pkt_hdr; /* used when connected */
146 negp neg; /* used when negotiating */
147 /*struct sess_con *hash_next;*/ /* not yet used */
149 typedef struct sess_con *sessp;
152 * Information we store for each node
155 node_p node; /* back pointer to node */
156 hook_p ethernet_hook;
158 u_int packets_in; /* packets in from ethernet */
159 u_int packets_out; /* packets out towards ethernet */
161 /*struct sess_con *buckets[HASH_SIZE];*/ /* not yet used */
163 typedef struct PPPOE *priv_p;
165 struct ether_header eh_prototype =
166 {{0xff,0xff,0xff,0xff,0xff,0xff},
167 {0x00,0x00,0x00,0x00,0x00,0x00},
168 ETHERTYPE_PPPOE_DISC};
170 #define PPPOE_KEEPSTANDARD -1 /* never switch to nonstandard mode */
171 #define PPPOE_STANDARD 0 /* try standard mode (dangerous!) */
172 #define PPPOE_NONSTANDARD 1 /* just be in nonstandard mode */
173 static int pppoe_mode = PPPOE_KEEPSTANDARD;
176 ngpppoe_set_ethertype(SYSCTL_HANDLER_ARGS)
182 error = sysctl_handle_int(oidp, &val, sizeof(int), req);
183 if (error != 0 || req->newptr == NULL)
186 case PPPOE_NONSTANDARD:
187 pppoe_mode = PPPOE_NONSTANDARD;
188 eh_prototype.ether_type = ETHERTYPE_PPPOE_STUPID_DISC;
191 pppoe_mode = PPPOE_STANDARD;
192 eh_prototype.ether_type = ETHERTYPE_PPPOE_DISC;
194 case PPPOE_KEEPSTANDARD:
195 pppoe_mode = PPPOE_KEEPSTANDARD;
196 eh_prototype.ether_type = ETHERTYPE_PPPOE_DISC;
204 SYSCTL_PROC(_net_graph, OID_AUTO, nonstandard_pppoe, CTLTYPE_INT | CTLFLAG_RW,
205 0, sizeof(int), ngpppoe_set_ethertype, "I", "nonstandard ethertype");
208 char bytes[sizeof(void *)];
212 #define LEAVE(x) do { error = x; goto quit; } while(0)
213 static void pppoe_start(sessp sp);
214 static void sendpacket(sessp sp);
215 static void pppoe_ticker(void *arg);
216 static const struct pppoe_tag *scan_tags(sessp sp,
217 const struct pppoe_hdr* ph);
218 static int pppoe_send_event(sessp sp, enum cmd cmdid);
220 /*************************************************************************
221 * Some basic utilities from the Linux version with author's permission.*
222 * Author: Michal Ostrowski <mostrows@styx.uwaterloo.ca> *
223 ************************************************************************/
226 * Generate a new session id
227 * XXX find out the FreeBSD locking scheme.
230 get_new_sid(node_p node)
232 static int pppoe_sid = 10;
236 priv_p privp = node->private;
242 * Spec says 0xFFFF is reserved.
243 * Also don't use 0x0000
250 /* Check it isn't already in use */
251 LIST_FOREACH(hook, &node->hooks, hooks) {
252 /* don't check special hooks */
253 if ((hook->private == &privp->debug_hook)
254 || (hook->private == &privp->ethernet_hook))
257 if (sp->Session_ID == val)
266 * Return the location where the next tag can be put
268 static __inline const struct pppoe_tag*
269 next_tag(const struct pppoe_hdr* ph)
271 return (const struct pppoe_tag*)(((const char*)&ph->tag[0])
272 + ntohs(ph->length));
276 * Look for a tag of a specific type
277 * Don't trust any length the other end says.
278 * but assume we already sanity checked ph->length.
280 static const struct pppoe_tag*
281 get_tag(const struct pppoe_hdr* ph, u_int16_t idx)
283 const char *const end = (const char *)next_tag(ph);
285 const struct pppoe_tag *pt = &ph->tag[0];
287 * Keep processing tags while a tag header will still fit.
290 while((const char*)(pt + 1) <= end) {
292 * If the tag data would go past the end of the packet, abort.
294 ptn = (((const char *)(pt + 1)) + ntohs(pt->tag_len));
298 if(pt->tag_type == idx)
301 pt = (const struct pppoe_tag*)ptn;
306 /**************************************************************************
307 * inlines to initialise or add tags to a session's tag list,
308 **************************************************************************/
310 * Initialise the session's tag list
316 if(sp->neg == NULL) {
317 printf("pppoe: asked to init NULL neg pointer\n");
320 sp->neg->numtags = 0;
324 insert_tag(sessp sp, const struct pppoe_tag *tp)
330 if((neg = sp->neg) == NULL) {
331 printf("pppoe: asked to use NULL neg pointer\n");
334 if ((i = neg->numtags++) < NUMTAGS) {
337 printf("pppoe: asked to add too many tags to packet\n");
343 * Make up a packet, using the tags filled out for the session.
345 * Assume that the actual pppoe header and ethernet header
346 * are filled out externally to this routine.
347 * Also assume that neg->wh points to the correct
348 * location at the front of the buffer space.
351 make_packet(sessp sp) {
352 struct pppoe_full_hdr *wh = &sp->neg->pkt->pkt_header;
353 const struct pppoe_tag **tag;
357 u_int16_t length = 0;
360 if ((sp->neg == NULL) || (sp->neg->m == NULL)) {
361 printf("pppoe: make_packet called from wrong state\n");
363 dp = (char *)wh->ph.tag;
364 for (count = 0, tag = sp->neg->tags;
365 ((count < sp->neg->numtags) && (count < NUMTAGS));
367 tlen = ntohs((*tag)->tag_len) + sizeof(**tag);
368 if ((length + tlen) > (ETHER_MAX_LEN - 4 - sizeof(*wh))) {
369 printf("pppoe: tags too long\n");
370 sp->neg->numtags = count;
371 break; /* XXX chop off what's too long */
373 bcopy(*tag, (char *)dp, tlen);
377 wh->ph.length = htons(length);
378 sp->neg->m->m_len = length + sizeof(*wh);
379 sp->neg->m->m_pkthdr.len = length + sizeof(*wh);
382 /**************************************************************************
383 * Routine to match a service offered *
384 **************************************************************************/
386 * Find a hook that has a service string that matches that
387 * we are seeking. for now use a simple string.
388 * In the future we may need something like regexp().
389 * for testing allow a null string to match 1st found and a null service
390 * to match all requests. Also make '*' do the same.
393 #define NG_MATCH_EXACT 1
394 #define NG_MATCH_ANY 2
397 pppoe_match_svc(node_p node, const char *svc_name, int svc_len, int match)
401 priv_p privp = node->private;
402 hook_p allhook = NULL;
406 LIST_FOREACH(hook, &node->hooks, hooks) {
408 /* skip any hook that is debug or ethernet */
409 if ((hook->private == &privp->debug_hook)
410 || (hook->private == &privp->ethernet_hook))
414 /* Skip any sessions which are not in LISTEN mode. */
415 if ( sp->state != PPPOE_LISTENING)
420 /* Special case for a blank or "*" service name (wildcard) */
421 if (match == NG_MATCH_ANY && neg->service_len == 1 &&
422 neg->service.data[0] == '*') {
427 /* If the lengths don't match, that aint it. */
428 if (neg->service_len != svc_len)
431 /* An exact match? */
435 if (strncmp(svc_name, neg->service.data, svc_len) == 0)
438 return (hook ? hook : allhook);
440 /**************************************************************************
441 * Routine to find a particular session that matches an incoming packet *
442 **************************************************************************/
444 pppoe_findsession(node_p node, const struct pppoe_full_hdr *wh)
448 priv_p privp = node->private;
449 u_int16_t session = ntohs(wh->ph.sid);
452 * find matching peer/session combination.
455 LIST_FOREACH(hook, &node->hooks, hooks) {
456 /* don't check special hooks */
457 if ((hook->private == &privp->debug_hook)
458 || (hook->private == &privp->ethernet_hook)) {
462 if ( ( (sp->state == PPPOE_CONNECTED)
463 || (sp->state == PPPOE_NEWCONNECTED) )
464 && (sp->Session_ID == session)
465 && (bcmp(sp->pkt_hdr.eh.ether_dhost,
467 ETHER_ADDR_LEN)) == 0) {
475 pppoe_finduniq(node_p node, const struct pppoe_tag *tag)
478 priv_p privp = node->private;
482 bcopy(tag->tag_data, uniq.bytes, sizeof(void *));
483 /* cycle through all known hooks */
484 LIST_FOREACH(hook, &node->hooks, hooks) {
485 /* don't check special hooks */
486 if ((hook->private == &privp->debug_hook)
487 || (hook->private == &privp->ethernet_hook))
489 if (uniq.pointer == hook->private)
495 /**************************************************************************
496 * start of Netgraph entrypoints *
497 **************************************************************************/
500 * Allocate the private data structure and the generic node
501 * and link them together.
503 * ng_make_node_common() returns with a generic node struct
504 * with a single reference for us.. we transfer it to the
505 * private structure.. when we free the private struct we must
506 * unref the node so it gets freed too.
509 ng_pppoe_constructor(node_p *nodep)
515 /* Initialize private descriptor */
516 MALLOC(privdata, priv_p, sizeof(*privdata), M_NETGRAPH, M_NOWAIT);
517 if (privdata == NULL)
519 bzero(privdata, sizeof(*privdata));
521 /* Call the 'generic' (ie, superclass) node constructor */
522 if ((error = ng_make_node_common(&typestruct, nodep))) {
523 FREE(privdata, M_NETGRAPH);
527 /* Link structs together; this counts as our one reference to *nodep */
528 (*nodep)->private = privdata;
529 privdata->node = *nodep;
534 * Give our ok for a hook to be added...
535 * point the hook's private info to the hook structure.
537 * The following hook names are special:
538 * Ethernet: the hook that should be connected to a NIC.
539 * debug: copies of data sent out here (when I write the code).
540 * All other hook names need only be unique. (the framework checks this).
543 ng_pppoe_newhook(node_p node, hook_p hook, const char *name)
545 const priv_p privp = node->private;
549 if (strcmp(name, NG_PPPOE_HOOK_ETHERNET) == 0) {
550 privp->ethernet_hook = hook;
551 hook->private = &privp->ethernet_hook;
552 } else if (strcmp(name, NG_PPPOE_HOOK_DEBUG) == 0) {
553 privp->debug_hook = hook;
554 hook->private = &privp->debug_hook;
557 * Any other unique name is OK.
558 * The infrastructure has already checked that it's unique,
559 * so just allocate it and hook it in.
561 MALLOC(sp, sessp, sizeof(*sp), M_NETGRAPH, M_NOWAIT);
565 bzero(sp, sizeof(*sp));
574 * Get a netgraph control message.
575 * Check it is one we understand. If needed, send a response.
576 * We sometimes save the address for an async action later.
577 * Always free the message.
580 ng_pppoe_rcvmsg(node_p node,
581 struct ng_mesg *msg, const char *retaddr, struct ng_mesg **rptr)
583 priv_p privp = node->private;
584 struct ngpppoe_init_data *ourmsg = NULL;
585 struct ng_mesg *resp = NULL;
592 /* Deal with message according to cookie and command */
593 switch (msg->header.typecookie) {
594 case NGM_PPPOE_COOKIE:
595 switch (msg->header.cmd) {
596 case NGM_PPPOE_CONNECT:
597 case NGM_PPPOE_LISTEN:
598 case NGM_PPPOE_OFFER:
599 case NGM_PPPOE_SERVICE:
600 ourmsg = (struct ngpppoe_init_data *)msg->data;
601 if (( sizeof(*ourmsg) > msg->header.arglen)
602 || ((sizeof(*ourmsg) + ourmsg->data_len)
603 > msg->header.arglen)) {
604 printf("pppoe_rcvmsg: bad arg size");
607 if (ourmsg->data_len > PPPOE_SERVICE_NAME_SIZE) {
608 printf("pppoe: init data too long (%d)\n",
612 /* make sure strcmp will terminate safely */
613 ourmsg->hook[sizeof(ourmsg->hook) - 1] = '\0';
615 /* cycle through all known hooks */
616 LIST_FOREACH(hook, &node->hooks, hooks) {
618 && strcmp(hook->name, ourmsg->hook) == 0)
624 if ((hook->private == &privp->debug_hook)
625 || (hook->private == &privp->ethernet_hook)) {
630 if (msg->header.cmd == NGM_PPPOE_LISTEN) {
632 * Ensure we aren't already listening for this
635 if (pppoe_match_svc(node, ourmsg->data,
636 ourmsg->data_len, NG_MATCH_EXACT) != NULL) {
642 * PPPOE_SERVICE advertisments are set up
643 * on sessions that are in PRIMED state.
645 if (msg->header.cmd == NGM_PPPOE_SERVICE) {
648 if (sp->state |= PPPOE_SNONE) {
649 printf("pppoe: Session already active\n");
654 * set up prototype header
656 MALLOC(neg, negp, sizeof(*neg), M_NETGRAPH, M_NOWAIT);
659 printf("pppoe: Session out of memory\n");
662 bzero(neg, sizeof(*neg));
663 MGETHDR(neg->m, MB_DONTWAIT, MT_DATA);
665 printf("pppoe: Session out of mbufs\n");
666 FREE(neg, M_NETGRAPH);
669 neg->m->m_pkthdr.rcvif = NULL;
670 MCLGET(neg->m, MB_DONTWAIT);
671 if ((neg->m->m_flags & M_EXT) == 0) {
672 printf("pppoe: Session out of mcls\n");
674 FREE(neg, M_NETGRAPH);
678 callout_init(&neg->timeout_ch);
679 neg->m->m_len = sizeof(struct pppoe_full_hdr);
680 neg->pkt = mtod(neg->m, union packet*);
681 neg->pkt->pkt_header.eh = eh_prototype;
682 neg->pkt->pkt_header.ph.ver = 0x1;
683 neg->pkt->pkt_header.ph.type = 0x1;
684 neg->pkt->pkt_header.ph.sid = 0x0000;
687 strncpy(sp->creator, retaddr, NG_NODELEN);
688 sp->creator[NG_NODELEN] = '\0';
690 switch (msg->header.cmd) {
691 case NGM_PPPOE_GET_STATUS:
693 struct ngpppoestat *stats;
695 NG_MKRESPONSE(resp, msg, sizeof(*stats), M_NOWAIT);
699 stats = (struct ngpppoestat *) resp->data;
700 stats->packets_in = privp->packets_in;
701 stats->packets_out = privp->packets_out;
704 case NGM_PPPOE_CONNECT:
706 * Check the hook exists and is Uninitialised.
707 * Send a PADI request, and start the timeout logic.
708 * Store the originator of this message so we can send
709 * a success of fail message to them later.
710 * Move the session to SINIT
711 * Set up the session to the correct state and
714 neg->service.hdr.tag_type = PTT_SRV_NAME;
715 neg->service.hdr.tag_len =
716 htons((u_int16_t)ourmsg->data_len);
717 if (ourmsg->data_len) {
719 neg->service.data, ourmsg->data_len);
721 neg->service_len = ourmsg->data_len;
724 case NGM_PPPOE_LISTEN:
726 * Check the hook exists and is Uninitialised.
727 * Install the service matching string.
728 * Store the originator of this message so we can send
729 * a success of fail message to them later.
730 * Move the hook to 'LISTENING'
732 neg->service.hdr.tag_type = PTT_SRV_NAME;
733 neg->service.hdr.tag_len =
734 htons((u_int16_t)ourmsg->data_len);
736 if (ourmsg->data_len) {
738 neg->service.data, ourmsg->data_len);
740 neg->service_len = ourmsg->data_len;
741 neg->pkt->pkt_header.ph.code = PADT_CODE;
743 * wait for PADI packet coming from ethernet
745 sp->state = PPPOE_LISTENING;
747 case NGM_PPPOE_OFFER:
749 * Check the hook exists and is Uninitialised.
750 * Store the originator of this message so we can send
751 * a success of fail message to them later.
752 * Store the AC-Name given and go to PRIMED.
754 neg->ac_name.hdr.tag_type = PTT_AC_NAME;
755 neg->ac_name.hdr.tag_len =
756 htons((u_int16_t)ourmsg->data_len);
757 if (ourmsg->data_len) {
759 neg->ac_name.data, ourmsg->data_len);
761 neg->ac_name_len = ourmsg->data_len;
762 neg->pkt->pkt_header.ph.code = PADO_CODE;
764 * Wait for PADI packet coming from hook
766 sp->state = PPPOE_PRIMED;
768 case NGM_PPPOE_SERVICE:
770 * Check the session is primed.
771 * for now just allow ONE service to be advertised.
772 * If you do it twice you just overwrite.
774 if (sp->state != PPPOE_PRIMED) {
775 printf("pppoe: Session not primed\n");
779 neg->service.hdr.tag_type = PTT_SRV_NAME;
780 neg->service.hdr.tag_len =
781 htons((u_int16_t)ourmsg->data_len);
783 if (ourmsg->data_len)
784 bcopy(ourmsg->data, neg->service.data,
786 neg->service_len = ourmsg->data_len;
796 /* Take care of synchronous response, if any */
800 FREE(resp, M_NETGRAPH);
802 /* Free the message and return */
804 FREE(msg, M_NETGRAPH);
809 * Start a client into the first state. A separate function because
810 * it can be needed if the negotiation times out.
813 pppoe_start(sessp sp)
816 struct pppoe_tag hdr;
818 } __attribute ((packed)) uniqtag;
821 * kick the state machine into starting up
824 sp->state = PPPOE_SINIT;
825 /* reset the packet header to broadcast */
826 sp->neg->pkt->pkt_header.eh = eh_prototype;
827 sp->neg->pkt->pkt_header.ph.code = PADI_CODE;
828 uniqtag.hdr.tag_type = PTT_HOST_UNIQ;
829 uniqtag.hdr.tag_len = htons((u_int16_t)sizeof(uniqtag.data));
830 uniqtag.data.pointer = sp;
832 insert_tag(sp, &uniqtag.hdr);
833 insert_tag(sp, &sp->neg->service.hdr);
839 send_acname(sessp sp, const struct pppoe_tag *tag)
843 struct ngpppoe_sts *sts;
845 NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, NGM_PPPOE_ACNAME,
846 sizeof(struct ngpppoe_sts), M_NOWAIT);
850 sts = (struct ngpppoe_sts *)msg->data;
851 tlen = min(NG_HOOKLEN, ntohs(tag->tag_len));
852 strncpy(sts->hook, tag->tag_data, tlen);
853 sts->hook[tlen] = '\0';
854 error = ng_send_msg(sp->hook->node, msg, sp->creator, NULL);
860 send_sessionid(sessp sp)
865 NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, NGM_PPPOE_SESSIONID,
866 sizeof(u_int16_t), M_NOWAIT);
870 *(u_int16_t *)msg->data = sp->Session_ID;
871 error = ng_send_msg(sp->hook->node, msg, sp->creator, NULL);
877 * Receive data, and do something with it.
878 * The caller will never free m or meta, so
879 * if we use up this data or abort we must free BOTH of these.
882 ng_pppoe_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
884 node_p node = hook->node;
885 const priv_p privp = node->private;
886 sessp sp = hook->private;
887 const struct pppoe_full_hdr *wh;
888 const struct pppoe_hdr *ph;
893 const struct pppoe_tag *utag = NULL, *tag = NULL;
896 struct pppoe_tag hdr;
898 } __attribute ((packed)) uniqtag;
902 if (hook->private == &privp->debug_hook) {
904 * Data from the debug hook gets sent without modification
905 * straight to the ethernet.
907 NG_SEND_DATA( error, privp->ethernet_hook, m, meta);
908 privp->packets_out++;
909 } else if (hook->private == &privp->ethernet_hook) {
912 * Dig out various fields from the packet.
913 * use them to decide where to send it.
917 if( m->m_len < sizeof(*wh)) {
918 m = m_pullup(m, sizeof(*wh)); /* Checks length */
920 printf("couldn't m_pullup\n");
924 wh = mtod(m, struct pppoe_full_hdr *);
926 session = ntohs(wh->ph.sid);
927 length = ntohs(wh->ph.length);
929 switch(wh->eh.ether_type) {
930 case ETHERTYPE_PPPOE_STUPID_DISC:
931 if (pppoe_mode == PPPOE_STANDARD) {
932 pppoe_mode = PPPOE_NONSTANDARD;
933 eh_prototype.ether_type =
934 ETHERTYPE_PPPOE_STUPID_DISC;
936 "Switched to nonstandard PPPoE mode due to "
939 wh->eh.ether_shost, ":");
940 } else if (pppoe_mode == PPPOE_KEEPSTANDARD)
942 "Ignored nonstandard PPPoE packet "
945 wh->eh.ether_shost, ":");
947 case ETHERTYPE_PPPOE_DISC:
949 * We need to try to make sure that the tag area
950 * is contiguous, or we could wander off the end
951 * of a buffer and make a mess.
952 * (Linux wouldn't have this problem).
954 /*XXX fix this mess */
956 if (m->m_pkthdr.len <= MHLEN) {
957 if( m->m_len < m->m_pkthdr.len) {
958 m = m_pullup(m, m->m_pkthdr.len);
960 printf("couldn't m_pullup\n");
965 if (m->m_len != m->m_pkthdr.len) {
967 * It's not all in one piece.
968 * We need to do extra work.
970 printf("packet fragmented\n");
978 * Look for a hook with the required service
979 * and send the ENTIRE packet up there.
980 * It should come back to a new hook in
981 * PRIMED state. Look there for further
984 tag = get_tag(ph, PTT_SRV_NAME);
986 printf("no service tag\n");
989 sendhook = pppoe_match_svc(hook->node,
990 tag->tag_data, ntohs(tag->tag_len),
993 NG_SEND_DATA(error, sendhook, m, meta);
1001 * Use the host_uniq tag to find the
1002 * hook this is in response to.
1003 * Received #2, now send #3
1004 * For now simply accept the first we receive.
1006 utag = get_tag(ph, PTT_HOST_UNIQ);
1008 || (ntohs(utag->tag_len) != sizeof(sp))) {
1009 printf("no host unique field\n");
1013 sendhook = pppoe_finduniq(node, utag);
1014 if (sendhook == NULL) {
1015 printf("no matching session\n");
1020 * Check the session is in the right state.
1021 * It needs to be in PPPOE_SINIT.
1023 sp = sendhook->private;
1024 if (sp->state != PPPOE_SINIT) {
1025 printf("session in wrong state\n");
1029 callout_stop(&neg->timeout_ch);
1032 * This is the first time we hear
1033 * from the server, so note it's
1034 * unicast address, replacing the
1035 * broadcast address .
1037 bcopy(wh->eh.ether_shost,
1038 neg->pkt->pkt_header.eh.ether_dhost,
1041 neg->pkt->pkt_header.ph.code = PADR_CODE;
1043 insert_tag(sp, utag); /* Host Unique */
1044 if ((tag = get_tag(ph, PTT_AC_COOKIE)))
1045 insert_tag(sp, tag); /* return cookie */
1046 if ((tag = get_tag(ph, PTT_AC_NAME))) {
1047 insert_tag(sp, tag); /* return it */
1048 send_acname(sp, tag);
1050 insert_tag(sp, &neg->service.hdr); /* Service */
1053 sp->state = PPPOE_SREQ;
1060 * Use the ac_cookie tag to find the
1061 * hook this is in response to.
1063 utag = get_tag(ph, PTT_AC_COOKIE);
1065 || (ntohs(utag->tag_len) != sizeof(sp))) {
1069 sendhook = pppoe_finduniq(node, utag);
1070 if (sendhook == NULL) {
1075 * Check the session is in the right state.
1076 * It needs to be in PPPOE_SOFFER
1077 * or PPPOE_NEWCONNECTED. If the latter,
1078 * then this is a retry by the client.
1079 * so be nice, and resend.
1081 sp = sendhook->private;
1082 if (sp->state == PPPOE_NEWCONNECTED) {
1084 * Whoa! drop back to resend that
1086 * We should still have a copy of it.
1088 sp->state = PPPOE_SOFFER;
1090 if (sp->state != PPPOE_SOFFER) {
1091 LEAVE (ENETUNREACH);
1095 callout_stop(&neg->timeout_ch);
1096 neg->pkt->pkt_header.ph.code = PADS_CODE;
1097 if (sp->Session_ID == 0)
1098 neg->pkt->pkt_header.ph.sid =
1099 htons(sp->Session_ID
1100 = get_new_sid(node));
1104 * start working out the tags to respond with.
1107 insert_tag(sp, &neg->ac_name.hdr); /* AC_NAME */
1108 if ((tag = get_tag(ph, PTT_SRV_NAME)))
1109 insert_tag(sp, tag);/* return service */
1110 if ((tag = get_tag(ph, PTT_HOST_UNIQ)))
1111 insert_tag(sp, tag); /* return it */
1112 insert_tag(sp, utag); /* ac_cookie */
1115 sp->state = PPPOE_NEWCONNECTED;
1118 * Having sent the last Negotiation header,
1119 * Set up the stored packet header to
1120 * be correct for the actual session.
1121 * But keep the negotialtion stuff
1122 * around in case we need to resend this last
1123 * packet. We'll discard it when we move
1124 * from NEWCONNECTED to CONNECTED
1126 sp->pkt_hdr = neg->pkt->pkt_header;
1127 if (pppoe_mode == PPPOE_NONSTANDARD)
1128 sp->pkt_hdr.eh.ether_type
1129 = ETHERTYPE_PPPOE_STUPID_SESS;
1131 sp->pkt_hdr.eh.ether_type
1132 = ETHERTYPE_PPPOE_SESS;
1133 sp->pkt_hdr.ph.code = 0;
1134 pppoe_send_event(sp, NGM_PPPOE_SUCCESS);
1139 * Use the host_uniq tag to find the
1140 * hook this is in response to.
1141 * take the session ID and store it away.
1142 * Also make sure the pre-made header is
1143 * correct and set us into Session mode.
1145 utag = get_tag(ph, PTT_HOST_UNIQ);
1147 || (ntohs(utag->tag_len) != sizeof(sp))) {
1148 LEAVE (ENETUNREACH);
1151 sendhook = pppoe_finduniq(node, utag);
1152 if (sendhook == NULL) {
1157 * Check the session is in the right state.
1158 * It needs to be in PPPOE_SREQ.
1160 sp = sendhook->private;
1161 if (sp->state != PPPOE_SREQ) {
1165 callout_stop(&neg->timeout_ch);
1166 neg->pkt->pkt_header.ph.sid = wh->ph.sid;
1167 sp->Session_ID = ntohs(wh->ph.sid);
1170 sp->state = PPPOE_CONNECTED;
1172 * Now we have gone to Connected mode,
1173 * Free all resources needed for
1175 * Keep a copy of the header we will be using.
1177 sp->pkt_hdr = neg->pkt->pkt_header;
1178 if (pppoe_mode == PPPOE_NONSTANDARD)
1179 sp->pkt_hdr.eh.ether_type
1180 = ETHERTYPE_PPPOE_STUPID_SESS;
1182 sp->pkt_hdr.eh.ether_type
1183 = ETHERTYPE_PPPOE_SESS;
1184 sp->pkt_hdr.ph.code = 0;
1186 FREE(sp->neg, M_NETGRAPH);
1188 pppoe_send_event(sp, NGM_PPPOE_SUCCESS);
1192 * Send a 'close' message to the controlling
1193 * process (the one that set us up);
1194 * And then tear everything down.
1196 * Find matching peer/session combination.
1198 sendhook = pppoe_findsession(node, wh);
1199 NG_FREE_DATA(m, meta); /* no longer needed */
1200 if (sendhook == NULL) {
1203 /* send message to creator */
1206 ng_destroy_hook(sendhook);
1210 LEAVE(EPFNOSUPPORT);
1213 case ETHERTYPE_PPPOE_STUPID_SESS:
1214 case ETHERTYPE_PPPOE_SESS:
1216 * find matching peer/session combination.
1218 sendhook = pppoe_findsession(node, wh);
1219 if (sendhook == NULL) {
1220 LEAVE (ENETUNREACH);
1223 sp = sendhook->private;
1224 m_adj(m, sizeof(*wh));
1225 if (m->m_pkthdr.len < length) {
1226 /* Packet too short, dump it */
1230 /* Also need to trim excess at the end */
1231 if (m->m_pkthdr.len > length) {
1232 m_adj(m, -((int)(m->m_pkthdr.len - length)));
1234 if ( sp->state != PPPOE_CONNECTED) {
1235 if (sp->state == PPPOE_NEWCONNECTED) {
1236 sp->state = PPPOE_CONNECTED;
1238 * Now we have gone to Connected mode,
1239 * Free all resources needed for
1240 * negotiation. Be paranoid about
1241 * whether there may be a timeout.
1243 m_freem(sp->neg->m);
1244 callout_stop(&sp->neg->timeout_ch);
1245 FREE(sp->neg, M_NETGRAPH);
1248 LEAVE (ENETUNREACH);
1252 NG_SEND_DATA( error, sendhook, m, meta);
1255 LEAVE(EPFNOSUPPORT);
1259 * Not ethernet or debug hook..
1261 * The packet has come in on a normal hook.
1262 * We need to find out what kind of hook,
1263 * So we can decide how to handle it.
1264 * Check the hook's state.
1267 switch (sp->state) {
1268 case PPPOE_NEWCONNECTED:
1269 case PPPOE_CONNECTED: {
1270 static const u_char addrctrl[] = { 0xff, 0x03 };
1271 struct pppoe_full_hdr *wh;
1274 * Remove PPP address and control fields, if any.
1275 * For example, ng_ppp(4) always sends LCP packets
1276 * with address and control fields as required by
1277 * generic PPP. PPPoE is an exception to the rule.
1279 if (m->m_pkthdr.len >= 2) {
1280 if (m->m_len < 2 && !(m = m_pullup(m, 2)))
1282 if (bcmp(mtod(m, u_char *), addrctrl, 2) == 0)
1286 * Bang in a pre-made header, and set the length up
1287 * to be correct. Then send it to the ethernet driver.
1288 * But first correct the length.
1290 sp->pkt_hdr.ph.length = htons((short)(m->m_pkthdr.len));
1291 M_PREPEND(m, sizeof(*wh), MB_DONTWAIT);
1295 wh = mtod(m, struct pppoe_full_hdr *);
1296 bcopy(&sp->pkt_hdr, wh, sizeof(*wh));
1297 NG_SEND_DATA( error, privp->ethernet_hook, m, meta);
1298 privp->packets_out++;
1303 * A PADI packet is being returned by the application
1304 * that has set up this hook. This indicates that it
1305 * wants us to offer service.
1308 if (m->m_len < sizeof(*wh)) {
1309 m = m_pullup(m, sizeof(*wh));
1314 wh = mtod(m, struct pppoe_full_hdr *);
1316 session = ntohs(wh->ph.sid);
1317 length = ntohs(wh->ph.length);
1319 if ( code != PADI_CODE) {
1322 callout_stop(&neg->timeout_ch);
1325 * This is the first time we hear
1326 * from the client, so note it's
1327 * unicast address, replacing the
1328 * broadcast address.
1330 bcopy(wh->eh.ether_shost,
1331 neg->pkt->pkt_header.eh.ether_dhost,
1333 sp->state = PPPOE_SOFFER;
1335 neg->pkt->pkt_header.ph.code = PADO_CODE;
1338 * start working out the tags to respond with.
1340 uniqtag.hdr.tag_type = PTT_AC_COOKIE;
1341 uniqtag.hdr.tag_len = htons((u_int16_t)sizeof(sp));
1342 uniqtag.data.pointer = sp;
1344 insert_tag(sp, &neg->ac_name.hdr); /* AC_NAME */
1345 if ((tag = get_tag(ph, PTT_SRV_NAME)))
1346 insert_tag(sp, tag); /* return service */
1348 * If we have a NULL service request
1349 * and have an extra service defined in this hook,
1350 * then also add a tag for the extra service.
1351 * XXX this is a hack. eventually we should be able
1352 * to support advertising many services, not just one
1354 if (((tag == NULL) || (tag->tag_len == 0))
1355 && (neg->service.hdr.tag_len != 0)) {
1356 insert_tag(sp, &neg->service.hdr); /* SERVICE */
1358 if ((tag = get_tag(ph, PTT_HOST_UNIQ)))
1359 insert_tag(sp, tag); /* returned hostunique */
1360 insert_tag(sp, &uniqtag.hdr);
1367 * Packets coming from the hook make no sense
1368 * to sessions in these states. Throw them away.
1374 case PPPOE_LISTENING:
1381 NG_FREE_DATA(m, meta);
1386 * Do local shutdown processing..
1387 * If we are a persistant device, we might refuse to go away, and
1388 * we'd only remove our links and reset ourself.
1391 ng_pppoe_rmnode(node_p node)
1393 const priv_p privdata = node->private;
1396 node->flags |= NG_INVALID;
1399 node->private = NULL;
1400 ng_unref(privdata->node);
1401 FREE(privdata, M_NETGRAPH);
1406 * This is called once we've already connected a new hook to the other node.
1407 * It gives us a chance to balk at the last minute.
1410 ng_pppoe_connect(hook_p hook)
1412 /* be really amiable and just say "YUP that's OK by me! " */
1417 * Hook disconnection
1419 * Clean up all dangling links and information about the session/hook.
1420 * For this type, removal of the last link destroys the node
1423 ng_pppoe_disconnect(hook_p hook)
1425 node_p node = hook->node;
1426 priv_p privp = node->private;
1431 hooks = node->numhooks; /* this one already not counted */
1432 if (hook->private == &privp->debug_hook) {
1433 privp->debug_hook = NULL;
1434 } else if (hook->private == &privp->ethernet_hook) {
1435 privp->ethernet_hook = NULL;
1439 if (sp->state != PPPOE_SNONE ) {
1440 pppoe_send_event(sp, NGM_PPPOE_CLOSE);
1443 * According to the spec, if we are connected,
1444 * we should send a DISC packet if we are shutting down
1447 if ((privp->ethernet_hook)
1448 && ((sp->state == PPPOE_CONNECTED)
1449 || (sp->state == PPPOE_NEWCONNECTED))) {
1451 struct pppoe_full_hdr *wh;
1452 struct pppoe_tag *tag;
1453 int msglen = strlen(SIGNOFF);
1457 /* revert the stored header to DISC/PADT mode */
1459 wh->ph.code = PADT_CODE;
1460 if (pppoe_mode == PPPOE_NONSTANDARD)
1461 wh->eh.ether_type = ETHERTYPE_PPPOE_STUPID_DISC;
1463 wh->eh.ether_type = ETHERTYPE_PPPOE_DISC;
1465 /* generate a packet of that type */
1466 MGETHDR(m, MB_DONTWAIT, MT_DATA);
1468 printf("pppoe: Session out of mbufs\n");
1470 m->m_pkthdr.rcvif = NULL;
1471 m->m_pkthdr.len = m->m_len = sizeof(*wh);
1472 bcopy((caddr_t)wh, mtod(m, caddr_t),
1475 * Add a General error message and adjust
1478 wh = mtod(m, struct pppoe_full_hdr *);
1480 tag->tag_type = PTT_GEN_ERR;
1481 tag->tag_len = htons((u_int16_t)msglen);
1482 strncpy(tag->tag_data, SIGNOFF, msglen);
1483 m->m_pkthdr.len = (m->m_len += sizeof(*tag) +
1485 wh->ph.length = htons(sizeof(*tag) + msglen);
1486 NG_SEND_DATA(error, privp->ethernet_hook, m,
1491 * As long as we have somewhere to store the timeout handle,
1492 * we may have a timeout pending.. get rid of it.
1495 callout_stop(&sp->neg->timeout_ch);
1497 m_freem(sp->neg->m);
1498 FREE(sp->neg, M_NETGRAPH);
1500 FREE(sp, M_NETGRAPH);
1501 hook->private = NULL;
1502 /* work out how many session hooks there are */
1503 /* Node goes away on last session hook removal */
1504 if (privp->ethernet_hook) hooks -= 1;
1505 if (privp->debug_hook) hooks -= 1;
1507 if (node->numhooks == 0)
1513 * timeouts come here.
1516 pppoe_ticker(void *arg)
1520 sessp sp = hook->private;
1523 struct mbuf *m0 = NULL;
1524 priv_p privp = hook->node->private;
1525 meta_p dummy = NULL;
1530 * resend the last packet, using an exponential backoff.
1531 * After a period of time, stop growing the backoff,
1532 * and either leave it, or revert to the start.
1536 /* timeouts on these produce resends */
1537 m0 = m_copypacket(sp->neg->m, MB_DONTWAIT);
1538 NG_SEND_DATA( error, privp->ethernet_hook, m0, dummy);
1539 callout_reset(&neg->timeout_ch, neg->timeout * hz,
1540 pppoe_ticker, hook);
1541 if ((neg->timeout <<= 1) > PPPOE_TIMEOUT_LIMIT) {
1542 if (sp->state == PPPOE_SREQ) {
1543 /* revert to SINIT mode */
1546 neg->timeout = PPPOE_TIMEOUT_LIMIT;
1552 /* a timeout on these says "give up" */
1553 ng_destroy_hook(hook);
1556 /* timeouts have no meaning in other states */
1557 printf("pppoe: unexpected timeout\n");
1564 sendpacket(sessp sp)
1567 struct mbuf *m0 = NULL;
1568 hook_p hook = sp->hook;
1570 priv_p privp = hook->node->private;
1571 meta_p dummy = NULL;
1575 case PPPOE_LISTENING:
1578 case PPPOE_CONNECTED:
1579 printf("pppoe: sendpacket: unexpected state\n");
1582 case PPPOE_NEWCONNECTED:
1583 /* send the PADS without a timeout - we're now connected */
1584 m0 = m_copypacket(sp->neg->m, MB_DONTWAIT);
1585 NG_SEND_DATA( error, privp->ethernet_hook, m0, dummy);
1589 /* No packet to send, but set up the timeout */
1590 callout_reset(&neg->timeout_ch, PPPOE_OFFER_TIMEOUT * hz,
1591 pppoe_ticker, hook);
1596 * send the offer but if they don't respond
1597 * in PPPOE_OFFER_TIMEOUT seconds, forget about it.
1599 m0 = m_copypacket(sp->neg->m, MB_DONTWAIT);
1600 NG_SEND_DATA( error, privp->ethernet_hook, m0, dummy);
1601 callout_reset(&neg->timeout_ch, PPPOE_OFFER_TIMEOUT * hz,
1602 pppoe_ticker, hook);
1607 m0 = m_copypacket(sp->neg->m, MB_DONTWAIT);
1608 NG_SEND_DATA( error, privp->ethernet_hook, m0, dummy);
1609 callout_reset(&neg->timeout_ch, PPPOE_INITIAL_TIMEOUT * hz,
1610 pppoe_ticker, hook);
1611 neg->timeout = PPPOE_INITIAL_TIMEOUT * 2;
1616 printf("pppoe: timeout: bad state\n");
1618 /* return (error); */
1622 * Parse an incoming packet to see if any tags should be copied to the
1623 * output packet. Don't do any tags that have been handled in the main
1626 static const struct pppoe_tag*
1627 scan_tags(sessp sp, const struct pppoe_hdr* ph)
1629 const char *const end = (const char *)next_tag(ph);
1631 const struct pppoe_tag *pt = &ph->tag[0];
1633 * Keep processing tags while a tag header will still fit.
1636 while((const char*)(pt + 1) <= end) {
1638 * If the tag data would go past the end of the packet, abort.
1640 ptn = (((const char *)(pt + 1)) + ntohs(pt->tag_len));
1644 switch (pt->tag_type) {
1660 pt = (const struct pppoe_tag*)ptn;
1666 pppoe_send_event(sessp sp, enum cmd cmdid)
1669 struct ng_mesg *msg;
1670 struct ngpppoe_sts *sts;
1673 NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, cmdid,
1674 sizeof(struct ngpppoe_sts), M_NOWAIT);
1677 sts = (struct ngpppoe_sts *)msg->data;
1678 strncpy(sts->hook, sp->hook->name, NG_HOOKLEN + 1);
1679 error = ng_send_msg(sp->hook->node, msg, sp->creator, NULL);