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>
40 * $Whistle: ng_pppoe.c,v 1.10 1999/11/01 09:24:52 julian Exp $
43 #define AAA printf("pppoe: %s\n", __func__ );
44 #define BBB printf("-%d-", __LINE__ );
50 #include <sys/param.h>
51 #include <sys/systm.h>
52 #include <sys/kernel.h>
54 #include <sys/malloc.h>
55 #include <sys/errno.h>
56 #include <sys/sysctl.h>
57 #include <net/ethernet.h>
59 #include <netgraph/ng_message.h>
60 #include <netgraph/netgraph.h>
61 #include <netgraph/ng_parse.h>
62 #include <netgraph/ng_pppoe.h>
64 #ifdef NG_SEPARATE_MALLOC
65 MALLOC_DEFINE(M_NETGRAPH_PPPOE, "netgraph_pppoe", "netgraph pppoe node");
67 #define M_NETGRAPH_PPPOE M_NETGRAPH
70 #define SIGNOFF "session closed"
71 #define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0))
74 * This section contains the netgraph method declarations for the
75 * pppoe node. These methods define the netgraph pppoe 'type'.
78 static ng_constructor_t ng_pppoe_constructor;
79 static ng_rcvmsg_t ng_pppoe_rcvmsg;
80 static ng_shutdown_t ng_pppoe_shutdown;
81 static ng_newhook_t ng_pppoe_newhook;
82 static ng_connect_t ng_pppoe_connect;
83 static ng_rcvdata_t ng_pppoe_rcvdata;
84 static ng_disconnect_t ng_pppoe_disconnect;
86 /* Parse type for struct ngpppoe_init_data */
87 static const struct ng_parse_struct_field ngpppoe_init_data_type_fields[]
88 = NG_PPPOE_INIT_DATA_TYPE_INFO;
89 static const struct ng_parse_type ngpppoe_init_data_state_type = {
90 &ng_parse_struct_type,
91 &ngpppoe_init_data_type_fields
94 /* Parse type for struct ngpppoe_sts */
95 static const struct ng_parse_struct_field ng_pppoe_sts_type_fields[]
96 = NG_PPPOE_STS_TYPE_INFO;
97 static const struct ng_parse_type ng_pppoe_sts_state_type = {
98 &ng_parse_struct_type,
99 &ng_pppoe_sts_type_fields
102 /* List of commands and how to convert arguments to/from ASCII */
103 static const struct ng_cmdlist ng_pppoe_cmds[] = {
108 &ngpppoe_init_data_state_type,
115 &ngpppoe_init_data_state_type,
122 &ngpppoe_init_data_state_type,
129 &ngpppoe_init_data_state_type,
136 &ng_pppoe_sts_state_type,
143 &ng_pppoe_sts_state_type,
150 &ng_pppoe_sts_state_type,
156 /* Netgraph node type descriptor */
157 static struct ng_type typestruct = {
161 ng_pppoe_constructor,
171 NETGRAPH_INIT(pppoe, &typestruct);
172 /* Depend on ng_ether so we can use the Ethernet parse type */
173 MODULE_DEPEND(ng_pppoe, ng_ether, 1, 1, 1);
176 * States for the session state machine.
177 * These have no meaning if there is no hook attached yet.
180 PPPOE_SNONE=0, /* [both] Initial state */
181 PPPOE_LISTENING, /* [Daemon] Listening for discover initiation pkt */
182 PPPOE_SINIT, /* [Client] Sent discovery initiation */
183 PPPOE_PRIMED, /* [Server] Awaiting PADI from daemon */
184 PPPOE_SOFFER, /* [Server] Sent offer message (got PADI)*/
185 PPPOE_SREQ, /* [Client] Sent a Request */
186 PPPOE_NEWCONNECTED, /* [Server] Connection established, No data received */
187 PPPOE_CONNECTED, /* [Both] Connection established, Data received */
188 PPPOE_DEAD /* [Both] */
191 #define NUMTAGS 20 /* number of tags we are set up to work with */
194 * Information we store for each hook on each node for negotiating the
195 * session. The mbuf and cluster are freed once negotiation has completed.
196 * The whole negotiation block is then discarded.
200 struct mbuf *m; /* holds cluster with last sent packet */
201 union packet *pkt; /* points within the above cluster */
202 struct callout_handle timeout_handle; /* see timeout(9) */
203 u_int timeout; /* 0,1,2,4,8,16 etc. seconds */
205 const struct pppoe_tag *tags[NUMTAGS];
209 struct datatag service;
210 struct datatag ac_name;
212 typedef struct sess_neg *negp;
215 * Session information that is needed after connection.
219 u_int16_t Session_ID;
221 ng_ID_t creator; /* who to notify */
222 struct pppoe_full_hdr pkt_hdr; /* used when connected */
223 negp neg; /* used when negotiating */
224 /*struct sess_con *hash_next;*/ /* not yet used */
226 typedef struct sess_con *sessp;
229 * Information we store for each node
232 node_p node; /* back pointer to node */
233 hook_p ethernet_hook;
235 u_int packets_in; /* packets in from ethernet */
236 u_int packets_out; /* packets out towards ethernet */
238 /*struct sess_con *buckets[HASH_SIZE];*/ /* not yet used */
240 typedef struct PPPOE *priv_p;
242 struct ether_header eh_prototype =
243 {{0xff,0xff,0xff,0xff,0xff,0xff},
244 {0x00,0x00,0x00,0x00,0x00,0x00},
245 ETHERTYPE_PPPOE_DISC};
247 static int nonstandard;
249 ngpppoe_set_ethertype(SYSCTL_HANDLER_ARGS)
255 error = sysctl_handle_int(oidp, &val, sizeof(int), req);
256 if (error != 0 || req->newptr == NULL)
260 eh_prototype.ether_type = ETHERTYPE_PPPOE_STUPID_DISC;
263 eh_prototype.ether_type = ETHERTYPE_PPPOE_DISC;
268 SYSCTL_PROC(_net_graph, OID_AUTO, nonstandard_pppoe, CTLTYPE_INT | CTLFLAG_RW,
269 0, sizeof(int), ngpppoe_set_ethertype, "I", "select normal or stupid ISP");
272 char bytes[sizeof(void *)];
276 #define LEAVE(x) do { error = x; goto quit; } while(0)
277 static void pppoe_start(sessp sp);
278 static void sendpacket(sessp sp);
279 static void pppoe_ticker(void *arg);
280 static const struct pppoe_tag *scan_tags(sessp sp,
281 const struct pppoe_hdr* ph);
282 static int pppoe_send_event(sessp sp, enum cmd cmdid);
284 /*************************************************************************
285 * Some basic utilities from the Linux version with author's permission.*
286 * Author: Michal Ostrowski <mostrows@styx.uwaterloo.ca> *
287 ************************************************************************/
290 * Generate a new session id
291 * XXX find out the FreeBSD locking scheme.
294 get_new_sid(node_p node)
296 static int pppoe_sid = 10;
300 priv_p privp = NG_NODE_PRIVATE(node);
306 * Spec says 0xFFFF is reserved.
307 * Also don't use 0x0000
314 /* Check it isn't already in use */
315 LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
316 /* don't check special hooks */
317 if ((NG_HOOK_PRIVATE(hook) == &privp->debug_hook)
318 || (NG_HOOK_PRIVATE(hook) == &privp->ethernet_hook))
320 sp = NG_HOOK_PRIVATE(hook);
321 if (sp->Session_ID == val)
330 * Return the location where the next tag can be put
332 static __inline const struct pppoe_tag*
333 next_tag(const struct pppoe_hdr* ph)
335 return (const struct pppoe_tag*)(((const char*)&ph->tag[0])
336 + ntohs(ph->length));
340 * Look for a tag of a specific type
341 * Don't trust any length the other end says.
342 * but assume we already sanity checked ph->length.
344 static const struct pppoe_tag*
345 get_tag(const struct pppoe_hdr* ph, u_int16_t idx)
347 const char *const end = (const char *)next_tag(ph);
349 const struct pppoe_tag *pt = &ph->tag[0];
351 * Keep processing tags while a tag header will still fit.
354 while((const char*)(pt + 1) <= end) {
356 * If the tag data would go past the end of the packet, abort.
358 ptn = (((const char *)(pt + 1)) + ntohs(pt->tag_len));
362 if(pt->tag_type == idx)
365 pt = (const struct pppoe_tag*)ptn;
370 /**************************************************************************
371 * inlines to initialise or add tags to a session's tag list,
372 **************************************************************************/
374 * Initialise the session's tag list
380 if(sp->neg == NULL) {
381 printf("pppoe: asked to init NULL neg pointer\n");
384 sp->neg->numtags = 0;
388 insert_tag(sessp sp, const struct pppoe_tag *tp)
394 if((neg = sp->neg) == NULL) {
395 printf("pppoe: asked to use NULL neg pointer\n");
398 if ((i = neg->numtags++) < NUMTAGS) {
401 printf("pppoe: asked to add too many tags to packet\n");
407 * Make up a packet, using the tags filled out for the session.
409 * Assume that the actual pppoe header and ethernet header
410 * are filled out externally to this routine.
411 * Also assume that neg->wh points to the correct
412 * location at the front of the buffer space.
415 make_packet(sessp sp) {
416 struct pppoe_full_hdr *wh = &sp->neg->pkt->pkt_header;
417 const struct pppoe_tag **tag;
421 u_int16_t length = 0;
424 if ((sp->neg == NULL) || (sp->neg->m == NULL)) {
425 printf("pppoe: make_packet called from wrong state\n");
427 dp = (char *)wh->ph.tag;
428 for (count = 0, tag = sp->neg->tags;
429 ((count < sp->neg->numtags) && (count < NUMTAGS));
431 tlen = ntohs((*tag)->tag_len) + sizeof(**tag);
432 if ((length + tlen) > (ETHER_MAX_LEN - 4 - sizeof(*wh))) {
433 printf("pppoe: tags too long\n");
434 sp->neg->numtags = count;
435 break; /* XXX chop off what's too long */
437 bcopy(*tag, (char *)dp, tlen);
441 wh->ph.length = htons(length);
442 sp->neg->m->m_len = length + sizeof(*wh);
443 sp->neg->m->m_pkthdr.len = length + sizeof(*wh);
446 /**************************************************************************
447 * Routine to match a service offered *
448 **************************************************************************/
450 * Find a hook that has a service string that matches that
451 * we are seeking. for now use a simple string.
452 * In the future we may need something like regexp().
453 * for testing allow a null string to match 1st found and a null service
454 * to match all requests. Also make '*' do the same.
457 #define NG_MATCH_EXACT 1
458 #define NG_MATCH_ANY 2
461 pppoe_match_svc(node_p node, const char *svc_name, int svc_len, int match)
465 priv_p privp = NG_NODE_PRIVATE(node);
466 hook_p allhook = NULL;
470 LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
472 /* skip any hook that is debug or ethernet */
473 if ((NG_HOOK_PRIVATE(hook) == &privp->debug_hook)
474 || (NG_HOOK_PRIVATE(hook) == &privp->ethernet_hook))
476 sp = NG_HOOK_PRIVATE(hook);
478 /* Skip any sessions which are not in LISTEN mode. */
479 if ( sp->state != PPPOE_LISTENING)
484 /* Special case for a blank or "*" service name (wildcard) */
485 if (match == NG_MATCH_ANY && neg->service_len == 1 &&
486 neg->service.data[0] == '*') {
491 /* If the lengths don't match, that aint it. */
492 if (neg->service_len != svc_len)
495 /* An exact match? */
499 if (strncmp(svc_name, neg->service.data, svc_len) == 0)
502 return (hook ? hook : allhook);
504 /**************************************************************************
505 * Routine to find a particular session that matches an incoming packet *
506 **************************************************************************/
508 pppoe_findsession(node_p node, const struct pppoe_full_hdr *wh)
512 priv_p privp = NG_NODE_PRIVATE(node);
513 u_int16_t session = ntohs(wh->ph.sid);
516 * find matching peer/session combination.
519 LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
520 /* don't check special hooks */
521 if ((NG_HOOK_PRIVATE(hook) == &privp->debug_hook)
522 || (NG_HOOK_PRIVATE(hook) == &privp->ethernet_hook)) {
525 sp = NG_HOOK_PRIVATE(hook);
526 if ( ( (sp->state == PPPOE_CONNECTED)
527 || (sp->state == PPPOE_NEWCONNECTED) )
528 && (sp->Session_ID == session)
529 && (bcmp(sp->pkt_hdr.eh.ether_dhost,
531 ETHER_ADDR_LEN)) == 0) {
539 pppoe_finduniq(node_p node, const struct pppoe_tag *tag)
542 priv_p privp = NG_NODE_PRIVATE(node);
546 bcopy(tag->tag_data, uniq.bytes, sizeof(void *));
547 /* cycle through all known hooks */
548 LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
549 /* don't check special hooks */
550 if ((NG_HOOK_PRIVATE(hook) == &privp->debug_hook)
551 || (NG_HOOK_PRIVATE(hook) == &privp->ethernet_hook))
553 if (uniq.pointer == NG_HOOK_PRIVATE(hook))
559 /**************************************************************************
560 * start of Netgraph entrypoints *
561 **************************************************************************/
564 * Allocate the private data structure and the generic node
565 * and link them together.
567 * ng_make_node_common() returns with a generic node struct
568 * with a single reference for us.. we transfer it to the
569 * private structure.. when we free the private struct we must
570 * unref the node so it gets freed too.
573 ng_pppoe_constructor(node_p node)
578 /* Initialize private descriptor */
579 MALLOC(privdata, priv_p, sizeof(*privdata), M_NETGRAPH_PPPOE,
581 if (privdata == NULL)
584 /* Link structs together; this counts as our one reference to *nodep */
585 NG_NODE_SET_PRIVATE(node, privdata);
586 privdata->node = node;
591 * Give our ok for a hook to be added...
592 * point the hook's private info to the hook structure.
594 * The following hook names are special:
595 * Ethernet: the hook that should be connected to a NIC.
596 * debug: copies of data sent out here (when I write the code).
597 * All other hook names need only be unique. (the framework checks this).
600 ng_pppoe_newhook(node_p node, hook_p hook, const char *name)
602 const priv_p privp = NG_NODE_PRIVATE(node);
606 if (strcmp(name, NG_PPPOE_HOOK_ETHERNET) == 0) {
607 privp->ethernet_hook = hook;
608 NG_HOOK_SET_PRIVATE(hook, &privp->ethernet_hook);
609 } else if (strcmp(name, NG_PPPOE_HOOK_DEBUG) == 0) {
610 privp->debug_hook = hook;
611 NG_HOOK_SET_PRIVATE(hook, &privp->debug_hook);
614 * Any other unique name is OK.
615 * The infrastructure has already checked that it's unique,
616 * so just allocate it and hook it in.
618 MALLOC(sp, sessp, sizeof(*sp), M_NETGRAPH_PPPOE, M_NOWAIT | M_ZERO);
623 NG_HOOK_SET_PRIVATE(hook, sp);
630 * Get a netgraph control message.
631 * Check it is one we understand. If needed, send a response.
632 * We sometimes save the address for an async action later.
633 * Always free the message.
636 ng_pppoe_rcvmsg(node_p node, item_p item, hook_p lasthook)
638 priv_p privp = NG_NODE_PRIVATE(node);
639 struct ngpppoe_init_data *ourmsg = NULL;
640 struct ng_mesg *resp = NULL;
648 NGI_GET_MSG(item, msg);
649 /* Deal with message according to cookie and command */
650 switch (msg->header.typecookie) {
651 case NGM_PPPOE_COOKIE:
652 switch (msg->header.cmd) {
653 case NGM_PPPOE_CONNECT:
654 case NGM_PPPOE_LISTEN:
655 case NGM_PPPOE_OFFER:
656 case NGM_PPPOE_SERVICE:
657 ourmsg = (struct ngpppoe_init_data *)msg->data;
658 if (msg->header.arglen < sizeof(*ourmsg)) {
659 printf("pppoe: init data too small\n");
662 if (msg->header.arglen - sizeof(*ourmsg) >
663 PPPOE_SERVICE_NAME_SIZE) {
664 printf("pppoe_rcvmsg: service name too big");
667 if (msg->header.arglen - sizeof(*ourmsg) <
669 printf("pppoe: init data has bad length,"
670 " %d should be %d\n", ourmsg->data_len,
671 msg->header.arglen - sizeof (*ourmsg));
675 /* make sure strcmp will terminate safely */
676 ourmsg->hook[sizeof(ourmsg->hook) - 1] = '\0';
678 /* cycle through all known hooks */
679 LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
680 if (NG_HOOK_NAME(hook)
681 && strcmp(NG_HOOK_NAME(hook), ourmsg->hook) == 0)
687 if ((NG_HOOK_PRIVATE(hook) == &privp->debug_hook)
688 || (NG_HOOK_PRIVATE(hook) == &privp->ethernet_hook)) {
691 sp = NG_HOOK_PRIVATE(hook);
693 if (msg->header.cmd == NGM_PPPOE_LISTEN) {
695 * Ensure we aren't already listening for this
698 if (pppoe_match_svc(node, ourmsg->data,
699 ourmsg->data_len, NG_MATCH_EXACT) != NULL) {
705 * PPPOE_SERVICE advertisments are set up
706 * on sessions that are in PRIMED state.
708 if (msg->header.cmd == NGM_PPPOE_SERVICE) {
711 if (sp->state |= PPPOE_SNONE) {
712 printf("pppoe: Session already active\n");
717 * set up prototype header
719 MALLOC(neg, negp, sizeof(*neg), M_NETGRAPH_PPPOE,
723 printf("pppoe: Session out of memory\n");
726 MGETHDR(neg->m, M_DONTWAIT, MT_DATA);
728 printf("pppoe: Session out of mbufs\n");
729 FREE(neg, M_NETGRAPH_PPPOE);
732 neg->m->m_pkthdr.rcvif = NULL;
733 MCLGET(neg->m, M_DONTWAIT);
734 if ((neg->m->m_flags & M_EXT) == 0) {
735 printf("pppoe: Session out of mcls\n");
737 FREE(neg, M_NETGRAPH_PPPOE);
741 callout_handle_init( &neg->timeout_handle);
742 neg->m->m_len = sizeof(struct pppoe_full_hdr);
743 neg->pkt = mtod(neg->m, union packet*);
744 neg->pkt->pkt_header.eh = eh_prototype;
745 neg->pkt->pkt_header.ph.ver = 0x1;
746 neg->pkt->pkt_header.ph.type = 0x1;
747 neg->pkt->pkt_header.ph.sid = 0x0000;
750 sp->creator = NGI_RETADDR(item);
752 switch (msg->header.cmd) {
753 case NGM_PPPOE_GET_STATUS:
755 struct ngpppoestat *stats;
757 NG_MKRESPONSE(resp, msg, sizeof(*stats), M_NOWAIT);
761 stats = (struct ngpppoestat *) resp->data;
762 stats->packets_in = privp->packets_in;
763 stats->packets_out = privp->packets_out;
766 case NGM_PPPOE_CONNECT:
768 * Check the hook exists and is Uninitialised.
769 * Send a PADI request, and start the timeout logic.
770 * Store the originator of this message so we can send
771 * a success of fail message to them later.
772 * Move the session to SINIT
773 * Set up the session to the correct state and
776 neg->service.hdr.tag_type = PTT_SRV_NAME;
777 neg->service.hdr.tag_len =
778 htons((u_int16_t)ourmsg->data_len);
779 if (ourmsg->data_len)
780 bcopy(ourmsg->data, neg->service.data,
782 neg->service_len = ourmsg->data_len;
785 case NGM_PPPOE_LISTEN:
787 * Check the hook exists and is Uninitialised.
788 * Install the service matching string.
789 * Store the originator of this message so we can send
790 * a success of fail message to them later.
791 * Move the hook to 'LISTENING'
793 neg->service.hdr.tag_type = PTT_SRV_NAME;
794 neg->service.hdr.tag_len =
795 htons((u_int16_t)ourmsg->data_len);
797 if (ourmsg->data_len)
798 bcopy(ourmsg->data, neg->service.data,
800 neg->service_len = ourmsg->data_len;
801 neg->pkt->pkt_header.ph.code = PADT_CODE;
803 * wait for PADI packet coming from ethernet
805 sp->state = PPPOE_LISTENING;
807 case NGM_PPPOE_OFFER:
809 * Check the hook exists and is Uninitialised.
810 * Store the originator of this message so we can send
811 * a success of fail message to them later.
812 * Store the AC-Name given and go to PRIMED.
814 neg->ac_name.hdr.tag_type = PTT_AC_NAME;
815 neg->ac_name.hdr.tag_len =
816 htons((u_int16_t)ourmsg->data_len);
817 if (ourmsg->data_len)
818 bcopy(ourmsg->data, neg->ac_name.data,
820 neg->ac_name_len = ourmsg->data_len;
821 neg->pkt->pkt_header.ph.code = PADO_CODE;
823 * Wait for PADI packet coming from hook
825 sp->state = PPPOE_PRIMED;
827 case NGM_PPPOE_SERVICE:
829 * Check the session is primed.
830 * for now just allow ONE service to be advertised.
831 * If you do it twice you just overwrite.
833 if (sp->state != PPPOE_PRIMED) {
834 printf("pppoe: Session not primed\n");
838 neg->service.hdr.tag_type = PTT_SRV_NAME;
839 neg->service.hdr.tag_len =
840 htons((u_int16_t)ourmsg->data_len);
842 if (ourmsg->data_len)
843 bcopy(ourmsg->data, neg->service.data,
845 neg->service_len = ourmsg->data_len;
855 /* Take care of synchronous response, if any */
857 NG_RESPOND_MSG(error, node, item, resp);
858 /* Free the message and return */
864 * Start a client into the first state. A separate function because
865 * it can be needed if the negotiation times out.
868 pppoe_start(sessp sp)
871 struct pppoe_tag hdr;
873 } __attribute ((packed)) uniqtag;
876 * kick the state machine into starting up
879 sp->state = PPPOE_SINIT;
880 /* reset the packet header to broadcast */
881 sp->neg->pkt->pkt_header.eh = eh_prototype;
882 sp->neg->pkt->pkt_header.ph.code = PADI_CODE;
883 uniqtag.hdr.tag_type = PTT_HOST_UNIQ;
884 uniqtag.hdr.tag_len = htons((u_int16_t)sizeof(uniqtag.data));
885 uniqtag.data.pointer = sp;
887 insert_tag(sp, &uniqtag.hdr);
888 insert_tag(sp, &sp->neg->service.hdr);
894 send_acname(sessp sp, const struct pppoe_tag *tag)
898 struct ngpppoe_sts *sts;
900 NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, NGM_PPPOE_ACNAME,
901 sizeof(struct ngpppoe_sts), M_NOWAIT);
905 sts = (struct ngpppoe_sts *)msg->data;
906 tlen = min(NG_HOOKLEN, ntohs(tag->tag_len));
907 strncpy(sts->hook, tag->tag_data, tlen);
908 sts->hook[tlen] = '\0';
909 NG_SEND_MSG_ID(error, NG_HOOK_NODE(sp->hook), msg, sp->creator, NULL);
915 send_sessionid(sessp sp)
920 NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, NGM_PPPOE_SESSIONID,
921 sizeof(u_int16_t), M_NOWAIT);
925 *(u_int16_t *)msg->data = sp->Session_ID;
926 NG_SEND_MSG_ID(error, NG_HOOK_NODE(sp->hook), msg, sp->creator, NULL);
932 * Receive data, and do something with it.
933 * The caller will never free m or meta, so
934 * if we use up this data or abort we must free BOTH of these.
937 ng_pppoe_rcvdata(hook_p hook, item_p item)
939 node_p node = NG_HOOK_NODE(hook);
940 const priv_p privp = NG_NODE_PRIVATE(node);
941 sessp sp = NG_HOOK_PRIVATE(hook);
942 const struct pppoe_full_hdr *wh;
943 const struct pppoe_hdr *ph;
948 const struct pppoe_tag *utag = NULL, *tag = NULL;
951 struct pppoe_tag hdr;
953 } __attribute ((packed)) uniqtag;
959 if (NG_HOOK_PRIVATE(hook) == &privp->debug_hook) {
961 * Data from the debug hook gets sent without modification
962 * straight to the ethernet.
964 NG_FWD_ITEM_HOOK( error, item, privp->ethernet_hook);
965 privp->packets_out++;
966 } else if (NG_HOOK_PRIVATE(hook) == &privp->ethernet_hook) {
969 * Dig out various fields from the packet.
970 * use them to decide where to send it.
974 if( m->m_len < sizeof(*wh)) {
975 m = m_pullup(m, sizeof(*wh)); /* Checks length */
977 printf("couldn't m_pullup\n");
981 wh = mtod(m, struct pppoe_full_hdr *);
982 length = ntohs(wh->ph.length);
983 switch(wh->eh.ether_type) {
984 case ETHERTYPE_PPPOE_STUPID_DISC:
986 eh_prototype.ether_type = ETHERTYPE_PPPOE_STUPID_DISC;
988 case ETHERTYPE_PPPOE_DISC:
990 * We need to try to make sure that the tag area
991 * is contiguous, or we could wander off the end
992 * of a buffer and make a mess.
993 * (Linux wouldn't have this problem).
995 if (m->m_pkthdr.len <= MHLEN) {
996 if( m->m_len < m->m_pkthdr.len) {
997 m = m_pullup(m, m->m_pkthdr.len);
999 printf("couldn't m_pullup\n");
1004 if (m->m_len != m->m_pkthdr.len) {
1006 * It's not all in one piece.
1007 * We need to do extra work.
1008 * Put it into a cluster.
1011 n = m_dup(m, M_DONTWAIT);
1015 /* just check we got a cluster */
1016 if (m->m_len != m->m_pkthdr.len) {
1022 printf("packet fragmented\n");
1026 wh = mtod(m, struct pppoe_full_hdr *);
1027 length = ntohs(wh->ph.length);
1029 session = ntohs(wh->ph.sid);
1036 * Look for a hook with the required service
1037 * and send the ENTIRE packet up there.
1038 * It should come back to a new hook in
1039 * PRIMED state. Look there for further
1042 tag = get_tag(ph, PTT_SRV_NAME);
1044 printf("no service tag\n");
1047 sendhook = pppoe_match_svc(NG_HOOK_NODE(hook),
1048 tag->tag_data, ntohs(tag->tag_len),
1051 NG_FWD_NEW_DATA(error, item,
1060 * Use the host_uniq tag to find the
1061 * hook this is in response to.
1062 * Received #2, now send #3
1063 * For now simply accept the first we receive.
1065 utag = get_tag(ph, PTT_HOST_UNIQ);
1067 || (ntohs(utag->tag_len) != sizeof(sp))) {
1068 printf("no host unique field\n");
1072 sendhook = pppoe_finduniq(node, utag);
1073 if (sendhook == NULL) {
1074 printf("no matching session\n");
1079 * Check the session is in the right state.
1080 * It needs to be in PPPOE_SINIT.
1082 sp = NG_HOOK_PRIVATE(sendhook);
1083 if (sp->state != PPPOE_SINIT) {
1084 printf("session in wrong state\n");
1088 untimeout(pppoe_ticker, sendhook,
1089 neg->timeout_handle);
1092 * This is the first time we hear
1093 * from the server, so note it's
1094 * unicast address, replacing the
1095 * broadcast address .
1097 bcopy(wh->eh.ether_shost,
1098 neg->pkt->pkt_header.eh.ether_dhost,
1101 neg->pkt->pkt_header.ph.code = PADR_CODE;
1103 insert_tag(sp, utag); /* Host Unique */
1104 if ((tag = get_tag(ph, PTT_AC_COOKIE)))
1105 insert_tag(sp, tag); /* return cookie */
1106 if ((tag = get_tag(ph, PTT_AC_NAME))) {
1107 insert_tag(sp, tag); /* return it */
1108 send_acname(sp, tag);
1110 insert_tag(sp, &neg->service.hdr); /* Service */
1113 sp->state = PPPOE_SREQ;
1120 * Use the ac_cookie tag to find the
1121 * hook this is in response to.
1123 utag = get_tag(ph, PTT_AC_COOKIE);
1125 || (ntohs(utag->tag_len) != sizeof(sp))) {
1129 sendhook = pppoe_finduniq(node, utag);
1130 if (sendhook == NULL) {
1135 * Check the session is in the right state.
1136 * It needs to be in PPPOE_SOFFER
1137 * or PPPOE_NEWCONNECTED. If the latter,
1138 * then this is a retry by the client.
1139 * so be nice, and resend.
1141 sp = NG_HOOK_PRIVATE(sendhook);
1142 if (sp->state == PPPOE_NEWCONNECTED) {
1144 * Whoa! drop back to resend that
1146 * We should still have a copy of it.
1148 sp->state = PPPOE_SOFFER;
1150 if (sp->state != PPPOE_SOFFER) {
1151 LEAVE (ENETUNREACH);
1155 untimeout(pppoe_ticker, sendhook,
1156 neg->timeout_handle);
1157 neg->pkt->pkt_header.ph.code = PADS_CODE;
1158 if (sp->Session_ID == 0)
1159 neg->pkt->pkt_header.ph.sid =
1160 htons(sp->Session_ID
1161 = get_new_sid(node));
1165 * start working out the tags to respond with.
1168 insert_tag(sp, &neg->ac_name.hdr); /* AC_NAME */
1169 if ((tag = get_tag(ph, PTT_SRV_NAME)))
1170 insert_tag(sp, tag);/* return service */
1171 if ((tag = get_tag(ph, PTT_HOST_UNIQ)))
1172 insert_tag(sp, tag); /* return it */
1173 insert_tag(sp, utag); /* ac_cookie */
1176 sp->state = PPPOE_NEWCONNECTED;
1179 * Having sent the last Negotiation header,
1180 * Set up the stored packet header to
1181 * be correct for the actual session.
1182 * But keep the negotialtion stuff
1183 * around in case we need to resend this last
1184 * packet. We'll discard it when we move
1185 * from NEWCONNECTED to CONNECTED
1187 sp->pkt_hdr = neg->pkt->pkt_header;
1189 sp->pkt_hdr.eh.ether_type
1190 = ETHERTYPE_PPPOE_STUPID_SESS;
1192 sp->pkt_hdr.eh.ether_type
1193 = ETHERTYPE_PPPOE_SESS;
1194 sp->pkt_hdr.ph.code = 0;
1195 pppoe_send_event(sp, NGM_PPPOE_SUCCESS);
1200 * Use the host_uniq tag to find the
1201 * hook this is in response to.
1202 * take the session ID and store it away.
1203 * Also make sure the pre-made header is
1204 * correct and set us into Session mode.
1206 utag = get_tag(ph, PTT_HOST_UNIQ);
1208 || (ntohs(utag->tag_len) != sizeof(sp))) {
1209 LEAVE (ENETUNREACH);
1212 sendhook = pppoe_finduniq(node, utag);
1213 if (sendhook == NULL) {
1218 * Check the session is in the right state.
1219 * It needs to be in PPPOE_SREQ.
1221 sp = NG_HOOK_PRIVATE(sendhook);
1222 if (sp->state != PPPOE_SREQ) {
1226 untimeout(pppoe_ticker, sendhook,
1227 neg->timeout_handle);
1228 neg->pkt->pkt_header.ph.sid = wh->ph.sid;
1229 sp->Session_ID = ntohs(wh->ph.sid);
1232 sp->state = PPPOE_CONNECTED;
1234 * Now we have gone to Connected mode,
1235 * Free all resources needed for
1237 * Keep a copy of the header we will be using.
1239 sp->pkt_hdr = neg->pkt->pkt_header;
1241 sp->pkt_hdr.eh.ether_type
1242 = ETHERTYPE_PPPOE_STUPID_SESS;
1244 sp->pkt_hdr.eh.ether_type
1245 = ETHERTYPE_PPPOE_SESS;
1246 sp->pkt_hdr.ph.code = 0;
1248 FREE(sp->neg, M_NETGRAPH_PPPOE);
1250 pppoe_send_event(sp, NGM_PPPOE_SUCCESS);
1254 * Send a 'close' message to the controlling
1255 * process (the one that set us up);
1256 * And then tear everything down.
1258 * Find matching peer/session combination.
1260 sendhook = pppoe_findsession(node, wh);
1261 if (sendhook == NULL) {
1264 /* send message to creator */
1267 ng_rmhook_self(sendhook);
1271 LEAVE(EPFNOSUPPORT);
1274 case ETHERTYPE_PPPOE_STUPID_SESS:
1275 case ETHERTYPE_PPPOE_SESS:
1277 * find matching peer/session combination.
1279 sendhook = pppoe_findsession(node, wh);
1280 if (sendhook == NULL) {
1281 LEAVE (ENETUNREACH);
1284 sp = NG_HOOK_PRIVATE(sendhook);
1285 m_adj(m, sizeof(*wh));
1286 if (m->m_pkthdr.len < length) {
1287 /* Packet too short, dump it */
1291 /* Also need to trim excess at the end */
1292 if (m->m_pkthdr.len > length) {
1293 m_adj(m, -((int)(m->m_pkthdr.len - length)));
1295 if ( sp->state != PPPOE_CONNECTED) {
1296 if (sp->state == PPPOE_NEWCONNECTED) {
1297 sp->state = PPPOE_CONNECTED;
1299 * Now we have gone to Connected mode,
1300 * Free all resources needed for
1301 * negotiation. Be paranoid about
1302 * whether there may be a timeout.
1304 m_freem(sp->neg->m);
1305 untimeout(pppoe_ticker, sendhook,
1306 sp->neg->timeout_handle);
1307 FREE(sp->neg, M_NETGRAPH_PPPOE);
1310 LEAVE (ENETUNREACH);
1314 NG_FWD_NEW_DATA( error, item, sendhook, m);
1317 LEAVE(EPFNOSUPPORT);
1321 * Not ethernet or debug hook..
1323 * The packet has come in on a normal hook.
1324 * We need to find out what kind of hook,
1325 * So we can decide how to handle it.
1326 * Check the hook's state.
1328 sp = NG_HOOK_PRIVATE(hook);
1329 switch (sp->state) {
1330 case PPPOE_NEWCONNECTED:
1331 case PPPOE_CONNECTED: {
1332 static const u_char addrctrl[] = { 0xff, 0x03 };
1333 struct pppoe_full_hdr *wh;
1336 * Remove PPP address and control fields, if any.
1337 * For example, ng_ppp(4) always sends LCP packets
1338 * with address and control fields as required by
1339 * generic PPP. PPPoE is an exception to the rule.
1341 if (m->m_pkthdr.len >= 2) {
1342 if (m->m_len < 2 && !(m = m_pullup(m, 2)))
1344 if (bcmp(mtod(m, u_char *), addrctrl, 2) == 0)
1348 * Bang in a pre-made header, and set the length up
1349 * to be correct. Then send it to the ethernet driver.
1350 * But first correct the length.
1352 sp->pkt_hdr.ph.length = htons((short)(m->m_pkthdr.len));
1353 M_PREPEND(m, sizeof(*wh), M_DONTWAIT);
1357 wh = mtod(m, struct pppoe_full_hdr *);
1358 bcopy(&sp->pkt_hdr, wh, sizeof(*wh));
1359 NG_FWD_NEW_DATA( error, item, privp->ethernet_hook, m);
1360 privp->packets_out++;
1365 * A PADI packet is being returned by the application
1366 * that has set up this hook. This indicates that it
1367 * wants us to offer service.
1370 if (m->m_len < sizeof(*wh)) {
1371 m = m_pullup(m, sizeof(*wh));
1376 wh = mtod(m, struct pppoe_full_hdr *);
1378 session = ntohs(wh->ph.sid);
1379 length = ntohs(wh->ph.length);
1381 if ( code != PADI_CODE) {
1384 untimeout(pppoe_ticker, hook,
1385 neg->timeout_handle);
1388 * This is the first time we hear
1389 * from the client, so note it's
1390 * unicast address, replacing the
1391 * broadcast address.
1393 bcopy(wh->eh.ether_shost,
1394 neg->pkt->pkt_header.eh.ether_dhost,
1396 sp->state = PPPOE_SOFFER;
1398 neg->pkt->pkt_header.ph.code = PADO_CODE;
1401 * start working out the tags to respond with.
1403 uniqtag.hdr.tag_type = PTT_AC_COOKIE;
1404 uniqtag.hdr.tag_len = htons((u_int16_t)sizeof(sp));
1405 uniqtag.data.pointer = sp;
1407 insert_tag(sp, &neg->ac_name.hdr); /* AC_NAME */
1408 if ((tag = get_tag(ph, PTT_SRV_NAME)))
1409 insert_tag(sp, tag); /* return service */
1411 * If we have a NULL service request
1412 * and have an extra service defined in this hook,
1413 * then also add a tag for the extra service.
1414 * XXX this is a hack. eventually we should be able
1415 * to support advertising many services, not just one
1417 if (((tag == NULL) || (tag->tag_len == 0))
1418 && (neg->service.hdr.tag_len != 0)) {
1419 insert_tag(sp, &neg->service.hdr); /* SERVICE */
1421 if ((tag = get_tag(ph, PTT_HOST_UNIQ)))
1422 insert_tag(sp, tag); /* returned hostunique */
1423 insert_tag(sp, &uniqtag.hdr);
1430 * Packets coming from the hook make no sense
1431 * to sessions in these states. Throw them away.
1437 case PPPOE_LISTENING:
1451 * Do local shutdown processing..
1452 * If we are a persistant device, we might refuse to go away, and
1453 * we'd only remove our links and reset ourself.
1456 ng_pppoe_shutdown(node_p node)
1458 const priv_p privdata = NG_NODE_PRIVATE(node);
1461 NG_NODE_SET_PRIVATE(node, NULL);
1462 NG_NODE_UNREF(privdata->node);
1463 FREE(privdata, M_NETGRAPH_PPPOE);
1468 * This is called once we've already connected a new hook to the other node.
1469 * It gives us a chance to balk at the last minute.
1472 ng_pppoe_connect(hook_p hook)
1474 /* be really amiable and just say "YUP that's OK by me! " */
1479 * Hook disconnection
1481 * Clean up all dangling links and information about the session/hook.
1482 * For this type, removal of the last link destroys the node
1485 ng_pppoe_disconnect(hook_p hook)
1487 node_p node = NG_HOOK_NODE(hook);
1488 priv_p privp = NG_NODE_PRIVATE(node);
1493 hooks = NG_NODE_NUMHOOKS(node); /* this one already not counted */
1494 if (NG_HOOK_PRIVATE(hook) == &privp->debug_hook) {
1495 privp->debug_hook = NULL;
1496 } else if (NG_HOOK_PRIVATE(hook) == &privp->ethernet_hook) {
1497 privp->ethernet_hook = NULL;
1498 if (NG_NODE_IS_VALID(node))
1499 ng_rmnode_self(node);
1501 sp = NG_HOOK_PRIVATE(hook);
1502 if (sp->state != PPPOE_SNONE ) {
1503 pppoe_send_event(sp, NGM_PPPOE_CLOSE);
1506 * According to the spec, if we are connected,
1507 * we should send a DISC packet if we are shutting down
1510 if ((privp->ethernet_hook)
1511 && ((sp->state == PPPOE_CONNECTED)
1512 || (sp->state == PPPOE_NEWCONNECTED))) {
1514 struct pppoe_full_hdr *wh;
1515 struct pppoe_tag *tag;
1516 int msglen = strlen(SIGNOFF);
1519 /* revert the stored header to DISC/PADT mode */
1521 wh->ph.code = PADT_CODE;
1523 wh->eh.ether_type = ETHERTYPE_PPPOE_STUPID_DISC;
1525 wh->eh.ether_type = ETHERTYPE_PPPOE_DISC;
1527 /* generate a packet of that type */
1528 MGETHDR(m, M_DONTWAIT, MT_DATA);
1530 printf("pppoe: Session out of mbufs\n");
1532 m->m_pkthdr.rcvif = NULL;
1533 m->m_pkthdr.len = m->m_len = sizeof(*wh);
1534 bcopy((caddr_t)wh, mtod(m, caddr_t),
1537 * Add a General error message and adjust
1540 wh = mtod(m, struct pppoe_full_hdr *);
1542 tag->tag_type = PTT_GEN_ERR;
1543 tag->tag_len = htons((u_int16_t)msglen);
1544 strncpy(tag->tag_data, SIGNOFF, msglen);
1545 m->m_pkthdr.len = (m->m_len += sizeof(*tag) +
1547 wh->ph.length = htons(sizeof(*tag) + msglen);
1548 NG_SEND_DATA_ONLY(error,
1549 privp->ethernet_hook, m);
1553 * As long as we have somewhere to store the timeout handle,
1554 * we may have a timeout pending.. get rid of it.
1557 untimeout(pppoe_ticker, hook, sp->neg->timeout_handle);
1559 m_freem(sp->neg->m);
1560 FREE(sp->neg, M_NETGRAPH_PPPOE);
1562 FREE(sp, M_NETGRAPH_PPPOE);
1563 NG_HOOK_SET_PRIVATE(hook, NULL);
1564 /* work out how many session hooks there are */
1565 /* Node goes away on last session hook removal */
1566 if (privp->ethernet_hook) hooks -= 1;
1567 if (privp->debug_hook) hooks -= 1;
1569 if ((NG_NODE_NUMHOOKS(node) == 0)
1570 && (NG_NODE_IS_VALID(node)))
1571 ng_rmnode_self(node);
1576 * timeouts come here.
1579 pppoe_ticker(void *arg)
1583 sessp sp = NG_HOOK_PRIVATE(hook);
1586 struct mbuf *m0 = NULL;
1587 priv_p privp = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
1592 * resend the last packet, using an exponential backoff.
1593 * After a period of time, stop growing the backoff,
1594 * and either leave it, or revert to the start.
1598 /* timeouts on these produce resends */
1599 m0 = m_copypacket(sp->neg->m, M_DONTWAIT);
1600 NG_SEND_DATA_ONLY( error, privp->ethernet_hook, m0);
1601 neg->timeout_handle = timeout(pppoe_ticker,
1602 hook, neg->timeout * hz);
1603 if ((neg->timeout <<= 1) > PPPOE_TIMEOUT_LIMIT) {
1604 if (sp->state == PPPOE_SREQ) {
1605 /* revert to SINIT mode */
1608 neg->timeout = PPPOE_TIMEOUT_LIMIT;
1614 /* a timeout on these says "give up" */
1615 ng_rmhook_self(hook);
1618 /* timeouts have no meaning in other states */
1619 printf("pppoe: unexpected timeout\n");
1626 sendpacket(sessp sp)
1629 struct mbuf *m0 = NULL;
1630 hook_p hook = sp->hook;
1632 priv_p privp = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
1636 case PPPOE_LISTENING:
1639 case PPPOE_CONNECTED:
1640 printf("pppoe: sendpacket: unexpected state\n");
1643 case PPPOE_NEWCONNECTED:
1644 /* send the PADS without a timeout - we're now connected */
1645 m0 = m_copypacket(sp->neg->m, M_DONTWAIT);
1646 NG_SEND_DATA_ONLY( error, privp->ethernet_hook, m0);
1650 /* No packet to send, but set up the timeout */
1651 neg->timeout_handle = timeout(pppoe_ticker,
1652 hook, PPPOE_OFFER_TIMEOUT * hz);
1657 * send the offer but if they don't respond
1658 * in PPPOE_OFFER_TIMEOUT seconds, forget about it.
1660 m0 = m_copypacket(sp->neg->m, M_DONTWAIT);
1661 NG_SEND_DATA_ONLY( error, privp->ethernet_hook, m0);
1662 neg->timeout_handle = timeout(pppoe_ticker,
1663 hook, PPPOE_OFFER_TIMEOUT * hz);
1668 m0 = m_copypacket(sp->neg->m, M_DONTWAIT);
1669 NG_SEND_DATA_ONLY( error, privp->ethernet_hook, m0);
1670 neg->timeout_handle = timeout(pppoe_ticker, hook,
1671 (hz * PPPOE_INITIAL_TIMEOUT));
1672 neg->timeout = PPPOE_INITIAL_TIMEOUT * 2;
1677 printf("pppoe: timeout: bad state\n");
1679 /* return (error); */
1683 * Parse an incoming packet to see if any tags should be copied to the
1684 * output packet. Don't do any tags that have been handled in the main
1687 static const struct pppoe_tag*
1688 scan_tags(sessp sp, const struct pppoe_hdr* ph)
1690 const char *const end = (const char *)next_tag(ph);
1692 const struct pppoe_tag *pt = &ph->tag[0];
1694 * Keep processing tags while a tag header will still fit.
1697 while((const char*)(pt + 1) <= end) {
1699 * If the tag data would go past the end of the packet, abort.
1701 ptn = (((const char *)(pt + 1)) + ntohs(pt->tag_len));
1705 switch (pt->tag_type) {
1721 pt = (const struct pppoe_tag*)ptn;
1727 pppoe_send_event(sessp sp, enum cmd cmdid)
1730 struct ng_mesg *msg;
1731 struct ngpppoe_sts *sts;
1734 NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, cmdid,
1735 sizeof(struct ngpppoe_sts), M_NOWAIT);
1738 sts = (struct ngpppoe_sts *)msg->data;
1739 strncpy(sts->hook, NG_HOOK_NAME(sp->hook), NG_HOOKLEN + 1);
1740 NG_SEND_MSG_ID(error, NG_HOOK_NODE(sp->hook), msg, sp->creator, NULL);