xref: /freebsd/sys/netgraph/ng_pppoe.c (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1 /*
2  * ng_pppoe.c
3  */
4 
5 /*-
6  * Copyright (c) 1996-1999 Whistle Communications, Inc.
7  * All rights reserved.
8  *
9  * Subject to the following obligations and disclaimer of warranty, use and
10  * redistribution of this software, in source or object code forms, with or
11  * without modifications are expressly permitted by Whistle Communications;
12  * provided, however, that:
13  * 1. Any and all reproductions of the source or object code must include the
14  *    copyright notice above and the following disclaimer of warranties; and
15  * 2. No rights are granted, in any manner or form, to use Whistle
16  *    Communications, Inc. trademarks, including the mark "WHISTLE
17  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
18  *    such appears in the above copyright notice or in the software.
19  *
20  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
21  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
22  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
23  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
25  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
26  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
27  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
28  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
29  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
30  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
31  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
32  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
36  * OF SUCH DAMAGE.
37  *
38  * Author: Julian Elischer <julian@freebsd.org>
39  *
40  * $FreeBSD$
41  * $Whistle: ng_pppoe.c,v 1.10 1999/11/01 09:24:52 julian Exp $
42  */
43 
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/ktr.h>
48 #include <sys/mbuf.h>
49 #include <sys/malloc.h>
50 #include <sys/errno.h>
51 #include <sys/syslog.h>
52 #include <net/ethernet.h>
53 
54 #include <netgraph/ng_message.h>
55 #include <netgraph/netgraph.h>
56 #include <netgraph/ng_parse.h>
57 #include <netgraph/ng_pppoe.h>
58 #include <netgraph/ng_ether.h>
59 
60 #ifdef NG_SEPARATE_MALLOC
61 MALLOC_DEFINE(M_NETGRAPH_PPPOE, "netgraph_pppoe", "netgraph pppoe node");
62 #else
63 #define M_NETGRAPH_PPPOE M_NETGRAPH
64 #endif
65 
66 #define SIGNOFF "session closed"
67 #define OFFSETOF(s, e) ((char *)&((s *)0)->e - (char *)((s *)0))
68 
69 /*
70  * This section contains the netgraph method declarations for the
71  * pppoe node. These methods define the netgraph pppoe 'type'.
72  */
73 
74 static ng_constructor_t	ng_pppoe_constructor;
75 static ng_rcvmsg_t	ng_pppoe_rcvmsg;
76 static ng_shutdown_t	ng_pppoe_shutdown;
77 static ng_newhook_t	ng_pppoe_newhook;
78 static ng_connect_t	ng_pppoe_connect;
79 static ng_rcvdata_t	ng_pppoe_rcvdata;
80 static ng_rcvdata_t	ng_pppoe_rcvdata_ether;
81 static ng_rcvdata_t	ng_pppoe_rcvdata_debug;
82 static ng_disconnect_t	ng_pppoe_disconnect;
83 
84 /* Parse type for struct ngpppoe_init_data */
85 static const struct ng_parse_struct_field ngpppoe_init_data_type_fields[]
86 	= NG_PPPOE_INIT_DATA_TYPE_INFO;
87 static const struct ng_parse_type ngpppoe_init_data_state_type = {
88 	&ng_parse_struct_type,
89 	&ngpppoe_init_data_type_fields
90 };
91 
92 /* Parse type for struct ngpppoe_sts */
93 static const struct ng_parse_struct_field ng_pppoe_sts_type_fields[]
94 	= NG_PPPOE_STS_TYPE_INFO;
95 static const struct ng_parse_type ng_pppoe_sts_state_type = {
96 	&ng_parse_struct_type,
97 	&ng_pppoe_sts_type_fields
98 };
99 
100 /* List of commands and how to convert arguments to/from ASCII */
101 static const struct ng_cmdlist ng_pppoe_cmds[] = {
102 	{
103 	  NGM_PPPOE_COOKIE,
104 	  NGM_PPPOE_CONNECT,
105 	  "pppoe_connect",
106 	  &ngpppoe_init_data_state_type,
107 	  NULL
108 	},
109 	{
110 	  NGM_PPPOE_COOKIE,
111 	  NGM_PPPOE_LISTEN,
112 	  "pppoe_listen",
113 	  &ngpppoe_init_data_state_type,
114 	  NULL
115 	},
116 	{
117 	  NGM_PPPOE_COOKIE,
118 	  NGM_PPPOE_OFFER,
119 	  "pppoe_offer",
120 	  &ngpppoe_init_data_state_type,
121 	  NULL
122 	},
123 	{
124 	  NGM_PPPOE_COOKIE,
125 	  NGM_PPPOE_SERVICE,
126 	  "pppoe_service",
127 	  &ngpppoe_init_data_state_type,
128 	  NULL
129 	},
130 	{
131 	  NGM_PPPOE_COOKIE,
132 	  NGM_PPPOE_SUCCESS,
133 	  "pppoe_success",
134 	  &ng_pppoe_sts_state_type,
135 	  NULL
136 	},
137 	{
138 	  NGM_PPPOE_COOKIE,
139 	  NGM_PPPOE_FAIL,
140 	  "pppoe_fail",
141 	  &ng_pppoe_sts_state_type,
142 	  NULL
143 	},
144 	{
145 	  NGM_PPPOE_COOKIE,
146 	  NGM_PPPOE_CLOSE,
147 	  "pppoe_close",
148 	  &ng_pppoe_sts_state_type,
149 	  NULL
150 	},
151 	{
152 	  NGM_PPPOE_COOKIE,
153 	  NGM_PPPOE_SETMODE,
154 	  "pppoe_setmode",
155 	  &ng_parse_string_type,
156 	  NULL
157 	},
158 	{
159 	  NGM_PPPOE_COOKIE,
160 	  NGM_PPPOE_GETMODE,
161 	  "pppoe_getmode",
162 	  NULL,
163 	  &ng_parse_string_type
164 	},
165 	{
166 	  NGM_PPPOE_COOKIE,
167 	  NGM_PPPOE_SETENADDR,
168 	  "setenaddr",
169 	  &ng_parse_enaddr_type,
170 	  NULL
171 	},
172 	{ 0 }
173 };
174 
175 /* Netgraph node type descriptor */
176 static struct ng_type typestruct = {
177 	.version =	NG_ABI_VERSION,
178 	.name =		NG_PPPOE_NODE_TYPE,
179 	.constructor =	ng_pppoe_constructor,
180 	.rcvmsg =	ng_pppoe_rcvmsg,
181 	.shutdown =	ng_pppoe_shutdown,
182 	.newhook =	ng_pppoe_newhook,
183 	.connect =	ng_pppoe_connect,
184 	.rcvdata =	ng_pppoe_rcvdata,
185 	.disconnect =	ng_pppoe_disconnect,
186 	.cmdlist =	ng_pppoe_cmds,
187 };
188 NETGRAPH_INIT(pppoe, &typestruct);
189 
190 /*
191  * States for the session state machine.
192  * These have no meaning if there is no hook attached yet.
193  */
194 enum state {
195     PPPOE_SNONE=0,	/* [both] Initial state */
196     PPPOE_LISTENING,	/* [Daemon] Listening for discover initiation pkt */
197     PPPOE_SINIT,	/* [Client] Sent discovery initiation */
198     PPPOE_PRIMED,	/* [Server] Awaiting PADI from daemon */
199     PPPOE_SOFFER,	/* [Server] Sent offer message  (got PADI)*/
200     PPPOE_SREQ,		/* [Client] Sent a Request */
201     PPPOE_NEWCONNECTED,	/* [Server] Connection established, No data received */
202     PPPOE_CONNECTED,	/* [Both] Connection established, Data received */
203     PPPOE_DEAD		/* [Both] */
204 };
205 
206 #define NUMTAGS 20 /* number of tags we are set up to work with */
207 
208 /*
209  * Information we store for each hook on each node for negotiating the
210  * session. The mbuf and cluster are freed once negotiation has completed.
211  * The whole negotiation block is then discarded.
212  */
213 
214 struct sess_neg {
215 	struct mbuf 		*m; /* holds cluster with last sent packet */
216 	union	packet		*pkt; /* points within the above cluster */
217 	struct callout		handle;   /* see timeout(9) */
218 	u_int			timeout; /* 0,1,2,4,8,16 etc. seconds */
219 	u_int			numtags;
220 	const struct pppoe_tag	*tags[NUMTAGS];
221 	u_int			service_len;
222 	u_int			ac_name_len;
223 
224 	struct datatag		service;
225 	struct datatag		ac_name;
226 };
227 typedef struct sess_neg *negp;
228 
229 /*
230  * Session information that is needed after connection.
231  */
232 struct sess_con {
233 	hook_p  		hook;
234 	uint16_t		Session_ID;
235 	enum state		state;
236 	ng_ID_t			creator;	/* who to notify */
237 	struct pppoe_full_hdr	pkt_hdr;	/* used when connected */
238 	negp			neg;		/* used when negotiating */
239 };
240 typedef struct sess_con *sessp;
241 
242 /*
243  * Information we store for each node
244  */
245 struct PPPoE {
246 	node_p		node;		/* back pointer to node */
247 	hook_p  	ethernet_hook;
248 	hook_p  	debug_hook;
249 	u_int   	packets_in;	/* packets in from ethernet */
250 	u_int   	packets_out;	/* packets out towards ethernet */
251 	uint32_t	flags;
252 #define	COMPAT_3COM	0x00000001
253 #define	COMPAT_DLINK	0x00000002
254 	struct ether_header	eh;
255 };
256 typedef struct PPPoE *priv_p;
257 
258 union uniq {
259 	char bytes[sizeof(void *)];
260 	void *pointer;
261 };
262 
263 #define	LEAVE(x) do { error = x; goto quit; } while(0)
264 static void	pppoe_start(sessp sp);
265 static void	pppoe_ticker(node_p node, hook_p hook, void *arg1, int arg2);
266 static const	struct pppoe_tag *scan_tags(sessp sp,
267 			const struct pppoe_hdr* ph);
268 static	int	pppoe_send_event(sessp sp, enum cmd cmdid);
269 
270 /*************************************************************************
271  * Some basic utilities  from the Linux version with author's permission.*
272  * Author:	Michal Ostrowski <mostrows@styx.uwaterloo.ca>		 *
273  ************************************************************************/
274 
275 /*
276  * Generate a new session id
277  * XXX find out the FreeBSD locking scheme.
278  */
279 static uint16_t
280 get_new_sid(node_p node)
281 {
282 	static int pppoe_sid = 10;
283 	hook_p	hook;
284 	uint16_t val;
285 
286 restart:
287 	val = pppoe_sid++;
288 	/*
289 	 * Spec says 0xFFFF is reserved.
290 	 * Also don't use 0x0000
291 	 */
292 	if (val == 0xffff) {
293 		pppoe_sid = 20;
294 		goto restart;
295 	}
296 
297 	/* Check it isn't already in use. */
298 	LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
299 		sessp sp = NG_HOOK_PRIVATE(hook);
300 
301 		/* Skip any nonsession hook. */
302 		if (sp == NULL)
303 			continue;
304 		if (sp->Session_ID == val)
305 			goto restart;
306 	}
307 
308 	CTR2(KTR_NET, "%20s: new sid %d", __func__, val);
309 
310 	return (val);
311 }
312 
313 
314 /*
315  * Return the location where the next tag can be put
316  */
317 static __inline const struct pppoe_tag*
318 next_tag(const struct pppoe_hdr* ph)
319 {
320 	return (const struct pppoe_tag*)(((const char*)&ph->tag[0])
321 	    + ntohs(ph->length));
322 }
323 
324 /*
325  * Look for a tag of a specific type.
326  * Don't trust any length the other end says,
327  * but assume we already sanity checked ph->length.
328  */
329 static const struct pppoe_tag*
330 get_tag(const struct pppoe_hdr* ph, uint16_t idx)
331 {
332 	const char *const end = (const char *)next_tag(ph);
333 	const struct pppoe_tag *pt = &ph->tag[0];
334 	const char *ptn;
335 
336 	/*
337 	 * Keep processing tags while a tag header will still fit.
338 	 */
339 	while((const char*)(pt + 1) <= end) {
340 		/*
341 		 * If the tag data would go past the end of the packet, abort.
342 		 */
343 		ptn = (((const char *)(pt + 1)) + ntohs(pt->tag_len));
344 		if (ptn > end) {
345 			CTR2(KTR_NET, "%20s: invalid length for tag %d",
346 			    __func__, idx);
347 			return (NULL);
348 		}
349 		if (pt->tag_type == idx) {
350 			CTR2(KTR_NET, "%20s: found tag %d", __func__, idx);
351 			return (pt);
352 		}
353 
354 		pt = (const struct pppoe_tag*)ptn;
355 	}
356 
357 	CTR2(KTR_NET, "%20s: not found tag %d", __func__, idx);
358 	return (NULL);
359 }
360 
361 /**************************************************************************
362  * Inlines to initialise or add tags to a session's tag list.
363  **************************************************************************/
364 /*
365  * Initialise the session's tag list.
366  */
367 static void
368 init_tags(sessp sp)
369 {
370 	KASSERT(sp->neg != NULL, ("%s: no neg", __func__));
371 	sp->neg->numtags = 0;
372 }
373 
374 static void
375 insert_tag(sessp sp, const struct pppoe_tag *tp)
376 {
377 	negp neg = sp->neg;
378 	int i;
379 
380 	KASSERT(neg != NULL, ("%s: no neg", __func__));
381 	if ((i = neg->numtags++) < NUMTAGS) {
382 		neg->tags[i] = tp;
383 	} else {
384 		log(LOG_NOTICE, "ng_pppoe: asked to add too many tags to "
385 		    "packet\n");
386 		neg->numtags--;
387 	}
388 }
389 
390 /*
391  * Make up a packet, using the tags filled out for the session.
392  *
393  * Assume that the actual pppoe header and ethernet header
394  * are filled out externally to this routine.
395  * Also assume that neg->wh points to the correct
396  * location at the front of the buffer space.
397  */
398 static void
399 make_packet(sessp sp) {
400 	struct pppoe_full_hdr *wh = &sp->neg->pkt->pkt_header;
401 	const struct pppoe_tag **tag;
402 	char *dp;
403 	int count;
404 	int tlen;
405 	uint16_t length = 0;
406 
407 	KASSERT((sp->neg != NULL) && (sp->neg->m != NULL),
408 	    ("%s: called from wrong state", __func__));
409 	CTR2(KTR_NET, "%20s: called %d", __func__, sp->Session_ID);
410 
411 	dp = (char *)wh->ph.tag;
412 	for (count = 0, tag = sp->neg->tags;
413 	    ((count < sp->neg->numtags) && (count < NUMTAGS));
414 	    tag++, count++) {
415 		tlen = ntohs((*tag)->tag_len) + sizeof(**tag);
416 		if ((length + tlen) > (ETHER_MAX_LEN - 4 - sizeof(*wh))) {
417 			log(LOG_NOTICE, "ng_pppoe: tags too long\n");
418 			sp->neg->numtags = count;
419 			break;	/* XXX chop off what's too long */
420 		}
421 		bcopy(*tag, (char *)dp, tlen);
422 		length += tlen;
423 		dp += tlen;
424 	}
425  	wh->ph.length = htons(length);
426 	sp->neg->m->m_len = length + sizeof(*wh);
427 	sp->neg->m->m_pkthdr.len = length + sizeof(*wh);
428 }
429 
430 /**************************************************************************
431  * Routines to match a service.						  *
432  **************************************************************************/
433 
434 /*
435  * Find a hook that has a service string that matches that
436  * we are seeking. For now use a simple string.
437  * In the future we may need something like regexp().
438  *
439  * Null string is a wildcard (ANY service), according to RFC2516.
440  * And historical FreeBSD wildcard is also "*".
441  */
442 
443 static hook_p
444 pppoe_match_svc(node_p node, const struct pppoe_tag *tag)
445 {
446 	hook_p hook;
447 
448 	LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
449 		sessp sp = NG_HOOK_PRIVATE(hook);
450 		negp neg;
451 
452 		/* Skip any nonsession hook. */
453 		if (sp == NULL)
454 			continue;
455 
456 		/* Skip any sessions which are not in LISTEN mode. */
457 		if (sp->state != PPPOE_LISTENING)
458 			continue;
459 
460 		neg = sp->neg;
461 
462 		/* Empty Service-Name matches any service. */
463 		if (neg->service_len == 0)
464 			break;
465 
466 		/* Special case for a blank or "*" service name (wildcard). */
467 		if (neg->service_len == 1 && neg->service.data[0] == '*')
468 			break;
469 
470 		/* If the lengths don't match, that aint it. */
471 		if (neg->service_len != ntohs(tag->tag_len))
472 			continue;
473 
474 		if (strncmp(tag->tag_data, neg->service.data,
475 		    ntohs(tag->tag_len)) == 0)
476 			break;
477 	}
478 	CTR3(KTR_NET, "%20s: matched %p for %s", __func__, hook, tag->tag_data);
479 
480 	return (hook);
481 }
482 
483 /*
484  * Broadcast the PADI packet in m0 to all listening hooks.
485  * This routine is called when a PADI with empty Service-Name
486  * tag is received. Client should receive PADOs with all
487  * available services.
488  */
489 static int
490 pppoe_broadcast_padi(node_p node, struct mbuf *m0)
491 {
492 	hook_p hook;
493 	int error = 0;
494 
495 	LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
496 		sessp sp = NG_HOOK_PRIVATE(hook);
497 		struct mbuf *m;
498 
499 		/*
500 		 * Go through all listening hooks and
501 		 * broadcast the PADI packet up there
502 		 */
503 		if (sp == NULL)
504 			continue;
505 
506 		if (sp->state != PPPOE_LISTENING)
507 			continue;
508 
509 		m = m_dup(m0, M_DONTWAIT);
510 		if (m == NULL)
511 			return (ENOMEM);
512 		NG_SEND_DATA_ONLY(error, hook, m);
513 		if (error)
514 			return (error);
515 	}
516 
517 	return (0);
518 }
519 
520 /*
521  * Find a hook, which name equals to given service.
522  */
523 static hook_p
524 pppoe_find_svc(node_p node, const char *svc_name, int svc_len)
525 {
526 	hook_p	hook;
527 
528 	LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
529 		sessp sp = NG_HOOK_PRIVATE(hook);
530 		negp neg;
531 
532 		/* Skip any nonsession hook. */
533 		if (sp == NULL)
534 			continue;
535 
536 		/* Skip any sessions which are not in LISTEN mode. */
537 		if (sp->state != PPPOE_LISTENING)
538 			continue;
539 
540 		neg = sp->neg;
541 
542 		if (neg->service_len == svc_len &&
543 		    strncmp(svc_name, neg->service.data, svc_len) == 0)
544 			return (hook);
545 	}
546 
547 	return (NULL);
548 }
549 
550 /**************************************************************************
551  * Routine to find a particular session that matches an incoming packet.  *
552  **************************************************************************/
553 static hook_p
554 pppoe_findsession(node_p node, const struct pppoe_full_hdr *wh)
555 {
556 	hook_p	hook = NULL;
557 	uint16_t session = ntohs(wh->ph.sid);
558 
559 	/*
560 	 * Find matching peer/session combination.
561 	 */
562 	LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
563 		sessp	sp = NG_HOOK_PRIVATE(hook);
564 
565 		/* Skip any nonsession hook. */
566 		if (sp == NULL)
567 			continue;
568 		if (sp->Session_ID == session &&
569 		    (sp->state == PPPOE_CONNECTED ||
570 		     sp->state == PPPOE_NEWCONNECTED) &&
571 		    bcmp(sp->pkt_hdr.eh.ether_dhost,
572 		     wh->eh.ether_shost, ETHER_ADDR_LEN) == 0) {
573 			break;
574 		}
575 	}
576 	CTR3(KTR_NET, "%20s: matched %p for %d", __func__, hook, session);
577 
578 	return (hook);
579 }
580 
581 static hook_p
582 pppoe_finduniq(node_p node, const struct pppoe_tag *tag)
583 {
584 	hook_p	hook = NULL;
585 	union uniq uniq;
586 
587 	bcopy(tag->tag_data, uniq.bytes, sizeof(void *));
588 	/* Cycle through all known hooks. */
589 	LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
590 		/* Skip any nonsession hook. */
591 		if (NG_HOOK_PRIVATE(hook) == NULL)
592 			continue;
593 		if (uniq.pointer == NG_HOOK_PRIVATE(hook))
594 			break;
595 	}
596 	CTR3(KTR_NET, "%20s: matched %p for %p", __func__, hook, uniq.pointer);
597 
598 	return (hook);
599 }
600 
601 /**************************************************************************
602  * Start of Netgraph entrypoints.					  *
603  **************************************************************************/
604 
605 /*
606  * Allocate the private data structure and link it with node.
607  */
608 static int
609 ng_pppoe_constructor(node_p node)
610 {
611 	priv_p privp;
612 
613 	/* Initialize private descriptor. */
614 	privp = malloc(sizeof(*privp), M_NETGRAPH_PPPOE, M_NOWAIT | M_ZERO);
615 	if (privp == NULL)
616 		return (ENOMEM);
617 
618 	/* Link structs together; this counts as our one reference to *node. */
619 	NG_NODE_SET_PRIVATE(node, privp);
620 	privp->node = node;
621 
622 	/* Initialize to standard mode. */
623 	memset(&privp->eh.ether_dhost, 0xff, ETHER_ADDR_LEN);
624 	privp->eh.ether_type = ETHERTYPE_PPPOE_DISC;
625 
626 	CTR3(KTR_NET, "%20s: created node [%x] (%p)",
627 	    __func__, node->nd_ID, node);
628 
629 	return (0);
630 }
631 
632 /*
633  * Give our ok for a hook to be added...
634  * point the hook's private info to the hook structure.
635  *
636  * The following hook names are special:
637  *  "ethernet":  the hook that should be connected to a NIC.
638  *  "debug":	copies of data sent out here  (when I write the code).
639  * All other hook names need only be unique. (the framework checks this).
640  */
641 static int
642 ng_pppoe_newhook(node_p node, hook_p hook, const char *name)
643 {
644 	const priv_p privp = NG_NODE_PRIVATE(node);
645 	sessp sp;
646 
647 	if (strcmp(name, NG_PPPOE_HOOK_ETHERNET) == 0) {
648 		privp->ethernet_hook = hook;
649 		NG_HOOK_SET_RCVDATA(hook, ng_pppoe_rcvdata_ether);
650 	} else if (strcmp(name, NG_PPPOE_HOOK_DEBUG) == 0) {
651 		privp->debug_hook = hook;
652 		NG_HOOK_SET_RCVDATA(hook, ng_pppoe_rcvdata_debug);
653 	} else {
654 		/*
655 		 * Any other unique name is OK.
656 		 * The infrastructure has already checked that it's unique,
657 		 * so just allocate it and hook it in.
658 		 */
659 		sp = malloc(sizeof(*sp), M_NETGRAPH_PPPOE, M_NOWAIT | M_ZERO);
660 		if (sp == NULL)
661 			return (ENOMEM);
662 
663 		NG_HOOK_SET_PRIVATE(hook, sp);
664 		sp->hook = hook;
665 	}
666 	CTR5(KTR_NET, "%20s: node [%x] (%p) connected hook %s (%p)",
667 	    __func__, node->nd_ID, node, name, hook);
668 
669 	return(0);
670 }
671 
672 /*
673  * Hook has been added successfully. Request the MAC address of
674  * the underlying Ethernet node.
675  */
676 static int
677 ng_pppoe_connect(hook_p hook)
678 {
679 	const priv_p privp = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
680 	struct ng_mesg *msg;
681 	int error;
682 
683 	if (hook != privp->ethernet_hook)
684 		return (0);
685 
686 	/*
687 	 * If this is Ethernet hook, then request MAC address
688 	 * from our downstream.
689 	 */
690 	NG_MKMESSAGE(msg, NGM_ETHER_COOKIE, NGM_ETHER_GET_ENADDR, 0, M_NOWAIT);
691 	if (msg == NULL)
692 		return (ENOBUFS);
693 
694 	/*
695 	 * Our hook and peer hook have HK_INVALID flag set,
696 	 * so we can't use NG_SEND_MSG_HOOK() macro here.
697 	 */
698 	NG_SEND_MSG_ID(error, privp->node, msg,
699 	    NG_NODE_ID(NG_PEER_NODE(privp->ethernet_hook)),
700 	    NG_NODE_ID(privp->node));
701 
702 	return (error);
703 }
704 /*
705  * Get a netgraph control message.
706  * Check it is one we understand. If needed, send a response.
707  * We sometimes save the address for an async action later.
708  * Always free the message.
709  */
710 static int
711 ng_pppoe_rcvmsg(node_p node, item_p item, hook_p lasthook)
712 {
713 	priv_p privp = NG_NODE_PRIVATE(node);
714 	struct ngpppoe_init_data *ourmsg = NULL;
715 	struct ng_mesg *resp = NULL;
716 	int error = 0;
717 	hook_p hook = NULL;
718 	sessp sp = NULL;
719 	negp neg = NULL;
720 	struct ng_mesg *msg;
721 
722 	NGI_GET_MSG(item, msg);
723 	CTR5(KTR_NET, "%20s: node [%x] (%p) got message %d with cookie %d",
724 	    __func__, node->nd_ID, node, msg->header.cmd,
725 	    msg->header.typecookie);
726 
727 	/* Deal with message according to cookie and command. */
728 	switch (msg->header.typecookie) {
729 	case NGM_PPPOE_COOKIE:
730 		switch (msg->header.cmd) {
731 		case NGM_PPPOE_CONNECT:
732 		case NGM_PPPOE_LISTEN:
733 		case NGM_PPPOE_OFFER:
734 		case NGM_PPPOE_SERVICE:
735 			ourmsg = (struct ngpppoe_init_data *)msg->data;
736 			if (msg->header.arglen < sizeof(*ourmsg)) {
737 				log(LOG_ERR, "ng_pppoe[%x]: init data too "
738 				    "small\n", node->nd_ID);
739 				LEAVE(EMSGSIZE);
740 			}
741 			if (msg->header.arglen - sizeof(*ourmsg) >
742 			    PPPOE_SERVICE_NAME_SIZE) {
743 				log(LOG_ERR, "ng_pppoe[%x]: service name "
744 				    "too big\n", node->nd_ID);
745 				LEAVE(EMSGSIZE);
746 			}
747 			if (msg->header.arglen - sizeof(*ourmsg) <
748 			    ourmsg->data_len) {
749 				log(LOG_ERR, "ng_pppoe[%x]: init data has bad "
750 				    "length, %d should be %zd\n", node->nd_ID,
751 				    ourmsg->data_len,
752 				    msg->header.arglen - sizeof (*ourmsg));
753 				LEAVE(EMSGSIZE);
754 			}
755 
756 			/* Make sure strcmp will terminate safely. */
757 			ourmsg->hook[sizeof(ourmsg->hook) - 1] = '\0';
758 
759 			/* Cycle through all known hooks. */
760 			LIST_FOREACH(hook, &node->nd_hooks, hk_hooks) {
761 				if (NG_HOOK_NAME(hook) &&
762 				    strcmp(NG_HOOK_NAME(hook), ourmsg->hook) ==
763 				    0)
764 					break;
765 			}
766 			if (hook == NULL)
767 				LEAVE(ENOENT);
768 
769 			sp = NG_HOOK_PRIVATE(hook);
770 
771 			if (sp == NULL)
772 				LEAVE(EINVAL);
773 
774 			if (msg->header.cmd == NGM_PPPOE_LISTEN) {
775 				/*
776 				 * Ensure we aren't already listening for this
777 				 * service.
778 				 */
779 				if (pppoe_find_svc(node, ourmsg->data,
780 				    ourmsg->data_len) != NULL)
781 					LEAVE(EEXIST);
782 			}
783 
784 			/*
785 			 * PPPOE_SERVICE advertisments are set up
786 			 * on sessions that are in PRIMED state.
787 			 */
788 			if (msg->header.cmd == NGM_PPPOE_SERVICE)
789 				break;
790 
791 			if (sp->state != PPPOE_SNONE) {
792 				log(LOG_NOTICE, "ng_pppoe[%x]: Session already "
793 				    "active\n", node->nd_ID);
794 				LEAVE(EISCONN);
795 			}
796 
797 			/*
798 			 * Set up prototype header.
799 			 */
800 			neg = malloc(sizeof(*neg), M_NETGRAPH_PPPOE,
801 			    M_NOWAIT | M_ZERO);
802 
803 			if (neg == NULL)
804 				LEAVE(ENOMEM);
805 
806 			neg->m = m_getcl(M_DONTWAIT, MT_DATA, M_PKTHDR);
807 			if (neg->m == NULL) {
808 				free(neg, M_NETGRAPH_PPPOE);
809 				LEAVE(ENOBUFS);
810 			}
811 			neg->m->m_pkthdr.rcvif = NULL;
812 			sp->neg = neg;
813 			ng_callout_init(&neg->handle);
814 			neg->m->m_len = sizeof(struct pppoe_full_hdr);
815 			neg->pkt = mtod(neg->m, union packet*);
816 			memcpy((void *)&neg->pkt->pkt_header.eh,
817 			    &privp->eh, sizeof(struct ether_header));
818 			neg->pkt->pkt_header.ph.ver = 0x1;
819 			neg->pkt->pkt_header.ph.type = 0x1;
820 			neg->pkt->pkt_header.ph.sid = 0x0000;
821 			neg->timeout = 0;
822 
823 			sp->creator = NGI_RETADDR(item);
824 		}
825 		switch (msg->header.cmd) {
826 		case NGM_PPPOE_GET_STATUS:
827 		    {
828 			struct ngpppoestat *stats;
829 
830 			NG_MKRESPONSE(resp, msg, sizeof(*stats), M_NOWAIT);
831 			if (!resp)
832 				LEAVE(ENOMEM);
833 
834 			stats = (struct ngpppoestat *) resp->data;
835 			stats->packets_in = privp->packets_in;
836 			stats->packets_out = privp->packets_out;
837 			break;
838 		    }
839 		case NGM_PPPOE_CONNECT:
840 		    {
841 			/*
842 			 * Check the hook exists and is Uninitialised.
843 			 * Send a PADI request, and start the timeout logic.
844 			 * Store the originator of this message so we can send
845 			 * a success of fail message to them later.
846 			 * Move the session to SINIT.
847 			 * Set up the session to the correct state and
848 			 * start it.
849 			 */
850 			int	i, acnlen = 0, acnsep = 0, srvlen;
851 			for (i = 0; i < ourmsg->data_len; i++) {
852 				if (ourmsg->data[i] == '\\') {
853 					acnlen = i;
854 					acnsep = 1;
855 					break;
856 				}
857 			}
858 			srvlen = ourmsg->data_len - acnlen - acnsep;
859 
860 			bcopy(ourmsg->data, neg->ac_name.data, acnlen);
861 			neg->ac_name_len = acnlen;
862 
863 			neg->service.hdr.tag_type = PTT_SRV_NAME;
864 			neg->service.hdr.tag_len = htons((uint16_t)srvlen);
865 			bcopy(ourmsg->data + acnlen + acnsep,
866 			    neg->service.data, srvlen);
867 			neg->service_len = srvlen;
868 			pppoe_start(sp);
869 			break;
870 		    }
871 		case NGM_PPPOE_LISTEN:
872 			/*
873 			 * Check the hook exists and is Uninitialised.
874 			 * Install the service matching string.
875 			 * Store the originator of this message so we can send
876 			 * a success of fail message to them later.
877 			 * Move the hook to 'LISTENING'
878 			 */
879 			neg->service.hdr.tag_type = PTT_SRV_NAME;
880 			neg->service.hdr.tag_len =
881 			    htons((uint16_t)ourmsg->data_len);
882 
883 			if (ourmsg->data_len)
884 				bcopy(ourmsg->data, neg->service.data,
885 				    ourmsg->data_len);
886 			neg->service_len = ourmsg->data_len;
887 			neg->pkt->pkt_header.ph.code = PADT_CODE;
888 			/*
889 			 * Wait for PADI packet coming from Ethernet.
890 			 */
891 			sp->state = PPPOE_LISTENING;
892 			break;
893 		case NGM_PPPOE_OFFER:
894 			/*
895 			 * Check the hook exists and is Uninitialised.
896 			 * Store the originator of this message so we can send
897 			 * a success of fail message to them later.
898 			 * Store the AC-Name given and go to PRIMED.
899 			 */
900 			neg->ac_name.hdr.tag_type = PTT_AC_NAME;
901 			neg->ac_name.hdr.tag_len =
902 			    htons((uint16_t)ourmsg->data_len);
903 			if (ourmsg->data_len)
904 				bcopy(ourmsg->data, neg->ac_name.data,
905 				    ourmsg->data_len);
906 			neg->ac_name_len = ourmsg->data_len;
907 			neg->pkt->pkt_header.ph.code = PADO_CODE;
908 			/*
909 			 * Wait for PADI packet coming from hook.
910 			 */
911 			sp->state = PPPOE_PRIMED;
912 			break;
913 		case NGM_PPPOE_SERVICE:
914 			/*
915 			 * Check the session is primed.
916 			 * for now just allow ONE service to be advertised.
917 			 * If you do it twice you just overwrite.
918 			 */
919 			if (sp->state != PPPOE_PRIMED) {
920 				log(LOG_NOTICE, "ng_pppoe[%x]: session not "
921 				    "primed\n", node->nd_ID);
922 				LEAVE(EISCONN);
923 			}
924 			neg = sp->neg;
925 			neg->service.hdr.tag_type = PTT_SRV_NAME;
926 			neg->service.hdr.tag_len =
927 			    htons((uint16_t)ourmsg->data_len);
928 
929 			if (ourmsg->data_len)
930 				bcopy(ourmsg->data, neg->service.data,
931 				    ourmsg->data_len);
932 			neg->service_len = ourmsg->data_len;
933 			break;
934 		case NGM_PPPOE_SETMODE:
935 		    {
936 			char *s;
937 			size_t len;
938 
939 			if (msg->header.arglen == 0)
940 				LEAVE(EINVAL);
941 
942 			s = (char *)msg->data;
943 			len = msg->header.arglen - 1;
944 
945 			/* Search for matching mode string. */
946 			if (len == strlen(NG_PPPOE_STANDARD) &&
947 			    (strncmp(NG_PPPOE_STANDARD, s, len) == 0)) {
948 				privp->flags = 0;
949 				privp->eh.ether_type = ETHERTYPE_PPPOE_DISC;
950 				break;
951 			}
952 			if (len == strlen(NG_PPPOE_3COM) &&
953 			    (strncmp(NG_PPPOE_3COM, s, len) == 0)) {
954 				privp->flags |= COMPAT_3COM;
955 				privp->eh.ether_type =
956 				    ETHERTYPE_PPPOE_3COM_DISC;
957 				break;
958 			}
959 			if (len == strlen(NG_PPPOE_DLINK) &&
960 			    (strncmp(NG_PPPOE_DLINK, s, len) == 0)) {
961 				privp->flags |= COMPAT_DLINK;
962 				break;
963 			}
964 			error = EINVAL;
965 			break;
966 		    }
967 		case NGM_PPPOE_GETMODE:
968 		    {
969 			char *s;
970 			size_t len = 0;
971 
972 			if (privp->flags == 0)
973 				len += strlen(NG_PPPOE_STANDARD) + 1;
974 			if (privp->flags & COMPAT_3COM)
975 				len += strlen(NG_PPPOE_3COM) + 1;
976 			if (privp->flags & COMPAT_DLINK)
977 				len += strlen(NG_PPPOE_DLINK) + 1;
978 
979 			NG_MKRESPONSE(resp, msg, len, M_NOWAIT);
980 			if (resp == NULL)
981 				LEAVE(ENOMEM);
982 
983 			s = (char *)resp->data;
984 			if (privp->flags == 0) {
985 				len = strlen(NG_PPPOE_STANDARD);
986 				strlcpy(s, NG_PPPOE_STANDARD, len + 1);
987 				break;
988 			}
989 			if (privp->flags & COMPAT_3COM) {
990 				len = strlen(NG_PPPOE_3COM);
991 				strlcpy(s, NG_PPPOE_3COM, len + 1);
992 				s += len;
993 			}
994 			if (privp->flags & COMPAT_DLINK) {
995 				if (s != resp->data)
996 					*s++ = '|';
997 				len = strlen(NG_PPPOE_DLINK);
998 				strlcpy(s, NG_PPPOE_DLINK, len + 1);
999 			}
1000 			break;
1001 		    }
1002 		case NGM_PPPOE_SETENADDR:
1003 			if (msg->header.arglen != ETHER_ADDR_LEN)
1004 				LEAVE(EINVAL);
1005 			bcopy(msg->data, &privp->eh.ether_shost,
1006 			    ETHER_ADDR_LEN);
1007 			break;
1008 		default:
1009 			LEAVE(EINVAL);
1010 		}
1011 		break;
1012 	case NGM_ETHER_COOKIE:
1013 		if (!(msg->header.flags & NGF_RESP))
1014 			LEAVE(EINVAL);
1015 		switch (msg->header.cmd) {
1016 		case NGM_ETHER_GET_ENADDR:
1017 			if (msg->header.arglen != ETHER_ADDR_LEN)
1018 				LEAVE(EINVAL);
1019 			bcopy(msg->data, &privp->eh.ether_shost,
1020 			    ETHER_ADDR_LEN);
1021 			break;
1022 		default:
1023 			LEAVE(EINVAL);
1024 		}
1025 		break;
1026 	default:
1027 		LEAVE(EINVAL);
1028 	}
1029 
1030 	/* Take care of synchronous response, if any. */
1031 quit:
1032 	CTR2(KTR_NET, "%20s: returning %d", __func__, error);
1033 	NG_RESPOND_MSG(error, node, item, resp);
1034 	/* Free the message and return. */
1035 	NG_FREE_MSG(msg);
1036 	return(error);
1037 }
1038 
1039 /*
1040  * Start a client into the first state. A separate function because
1041  * it can be needed if the negotiation times out.
1042  */
1043 static void
1044 pppoe_start(sessp sp)
1045 {
1046 	hook_p	hook = sp->hook;
1047 	node_p	node = NG_HOOK_NODE(hook);
1048 	priv_p	privp = NG_NODE_PRIVATE(node);
1049 	negp	neg = sp->neg;
1050 	struct {
1051 		struct pppoe_tag hdr;
1052 		union	uniq	data;
1053 	} __packed uniqtag;
1054 	struct  mbuf *m0;
1055 	int	error;
1056 
1057 	/*
1058 	 * Kick the state machine into starting up.
1059 	 */
1060 	CTR2(KTR_NET, "%20s: called %d", __func__, sp->Session_ID);
1061 	sp->state = PPPOE_SINIT;
1062 	/*
1063 	 * Reset the packet header to broadcast. Since we are
1064 	 * in a client mode use configured ethertype.
1065 	 */
1066 	memcpy((void *)&neg->pkt->pkt_header.eh, &privp->eh,
1067 	    sizeof(struct ether_header));
1068 	neg->pkt->pkt_header.ph.code = PADI_CODE;
1069 	uniqtag.hdr.tag_type = PTT_HOST_UNIQ;
1070 	uniqtag.hdr.tag_len = htons((u_int16_t)sizeof(uniqtag.data));
1071 	uniqtag.data.pointer = sp;
1072 	init_tags(sp);
1073 	insert_tag(sp, &uniqtag.hdr);
1074 	insert_tag(sp, &neg->service.hdr);
1075 	make_packet(sp);
1076 	/*
1077 	 * Send packet and prepare to retransmit it after timeout.
1078 	 */
1079 	ng_callout(&neg->handle, node, hook, PPPOE_INITIAL_TIMEOUT * hz,
1080 	    pppoe_ticker, NULL, 0);
1081 	neg->timeout = PPPOE_INITIAL_TIMEOUT * 2;
1082 	m0 = m_copypacket(neg->m, M_DONTWAIT);
1083 	NG_SEND_DATA_ONLY(error, privp->ethernet_hook, m0);
1084 }
1085 
1086 static int
1087 send_acname(sessp sp, const struct pppoe_tag *tag)
1088 {
1089 	int error, tlen;
1090 	struct ng_mesg *msg;
1091 	struct ngpppoe_sts *sts;
1092 
1093 	CTR2(KTR_NET, "%20s: called %d", __func__, sp->Session_ID);
1094 
1095 	NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, NGM_PPPOE_ACNAME,
1096 	    sizeof(struct ngpppoe_sts), M_NOWAIT);
1097 	if (msg == NULL)
1098 		return (ENOMEM);
1099 
1100 	sts = (struct ngpppoe_sts *)msg->data;
1101 	tlen = min(NG_HOOKSIZ - 1, ntohs(tag->tag_len));
1102 	strncpy(sts->hook, tag->tag_data, tlen);
1103 	sts->hook[tlen] = '\0';
1104 	NG_SEND_MSG_ID(error, NG_HOOK_NODE(sp->hook), msg, sp->creator, 0);
1105 
1106 	return (error);
1107 }
1108 
1109 static int
1110 send_sessionid(sessp sp)
1111 {
1112 	int error;
1113 	struct ng_mesg *msg;
1114 
1115 	CTR2(KTR_NET, "%20s: called %d", __func__, sp->Session_ID);
1116 
1117 	NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, NGM_PPPOE_SESSIONID,
1118 	    sizeof(uint16_t), M_NOWAIT);
1119 	if (msg == NULL)
1120 		return (ENOMEM);
1121 
1122 	*(uint16_t *)msg->data = sp->Session_ID;
1123 	NG_SEND_MSG_ID(error, NG_HOOK_NODE(sp->hook), msg, sp->creator, 0);
1124 
1125 	return (error);
1126 }
1127 
1128 /*
1129  * Receive data from session hook and do something with it.
1130  */
1131 static int
1132 ng_pppoe_rcvdata(hook_p hook, item_p item)
1133 {
1134 	node_p			node = NG_HOOK_NODE(hook);
1135 	const priv_p		privp = NG_NODE_PRIVATE(node);
1136 	sessp			sp = NG_HOOK_PRIVATE(hook);
1137 	struct pppoe_full_hdr	*wh;
1138 	struct mbuf		*m;
1139 	int			error;
1140 
1141 	CTR6(KTR_NET, "%20s: node [%x] (%p) received %p on \"%s\" (%p)",
1142 	    __func__, node->nd_ID, node, item, hook->hk_name, hook);
1143 
1144 	NGI_GET_M(item, m);
1145 	switch (sp->state) {
1146 	case	PPPOE_NEWCONNECTED:
1147 	case	PPPOE_CONNECTED: {
1148 		static const u_char addrctrl[] = { 0xff, 0x03 };
1149 
1150 		/*
1151 		 * Remove PPP address and control fields, if any.
1152 		 * For example, ng_ppp(4) always sends LCP packets
1153 		 * with address and control fields as required by
1154 		 * generic PPP. PPPoE is an exception to the rule.
1155 		 */
1156 		if (m->m_pkthdr.len >= 2) {
1157 			if (m->m_len < 2 && !(m = m_pullup(m, 2)))
1158 				LEAVE(ENOBUFS);
1159 			if (bcmp(mtod(m, u_char *), addrctrl, 2) == 0)
1160 				m_adj(m, 2);
1161 		}
1162 		/*
1163 		 * Bang in a pre-made header, and set the length up
1164 		 * to be correct. Then send it to the ethernet driver.
1165 		 */
1166 		M_PREPEND(m, sizeof(*wh), M_DONTWAIT);
1167 		if (m == NULL)
1168 			LEAVE(ENOBUFS);
1169 
1170 		wh = mtod(m, struct pppoe_full_hdr *);
1171 		bcopy(&sp->pkt_hdr, wh, sizeof(*wh));
1172 		wh->ph.length = htons(m->m_pkthdr.len - sizeof(*wh));
1173 		NG_FWD_NEW_DATA(error, item, privp->ethernet_hook, m);
1174 		privp->packets_out++;
1175 		break;
1176 		}
1177 	case	PPPOE_PRIMED: {
1178 		struct {
1179 			struct pppoe_tag hdr;
1180 			union	uniq	data;
1181 		} __packed 	uniqtag;
1182 		const struct pppoe_tag	*tag;
1183 		struct mbuf 	*m0;
1184 		const struct pppoe_hdr	*ph;
1185 		negp		neg = sp->neg;
1186 	        uint16_t	session;
1187 		uint16_t	length;
1188 		uint8_t		code;
1189 
1190 		/*
1191 		 * A PADI packet is being returned by the application
1192 		 * that has set up this hook. This indicates that it
1193 		 * wants us to offer service.
1194 		 */
1195 		if (m->m_len < sizeof(*wh)) {
1196 			m = m_pullup(m, sizeof(*wh));
1197 			if (m == NULL)
1198 				LEAVE(ENOBUFS);
1199 		}
1200 		wh = mtod(m, struct pppoe_full_hdr *);
1201 		ph = &wh->ph;
1202 		session = ntohs(wh->ph.sid);
1203 		length = ntohs(wh->ph.length);
1204 		code = wh->ph.code;
1205 		/* Use peers mode in session. */
1206 		neg->pkt->pkt_header.eh.ether_type = wh->eh.ether_type;
1207 		if (code != PADI_CODE)
1208 			LEAVE(EINVAL);
1209 		ng_uncallout(&neg->handle, node);
1210 
1211 		/*
1212 		 * This is the first time we hear
1213 		 * from the client, so note it's
1214 		 * unicast address, replacing the
1215 		 * broadcast address.
1216 		 */
1217 		bcopy(wh->eh.ether_shost,
1218 			neg->pkt->pkt_header.eh.ether_dhost,
1219 			ETHER_ADDR_LEN);
1220 		sp->state = PPPOE_SOFFER;
1221 		neg->timeout = 0;
1222 		neg->pkt->pkt_header.ph.code = PADO_CODE;
1223 
1224 		/*
1225 		 * Start working out the tags to respond with.
1226 		 */
1227 		uniqtag.hdr.tag_type = PTT_AC_COOKIE;
1228 		uniqtag.hdr.tag_len = htons((u_int16_t)sizeof(sp));
1229 		uniqtag.data.pointer = sp;
1230 		init_tags(sp);
1231 		insert_tag(sp, &neg->ac_name.hdr); /* AC_NAME */
1232 		if ((tag = get_tag(ph, PTT_SRV_NAME)))
1233 			insert_tag(sp, tag);	  /* return service */
1234 		/*
1235 		 * If we have a NULL service request
1236 		 * and have an extra service defined in this hook,
1237 		 * then also add a tag for the extra service.
1238 		 * XXX this is a hack. eventually we should be able
1239 		 * to support advertising many services, not just one
1240 		 */
1241 		if (((tag == NULL) || (tag->tag_len == 0)) &&
1242 		    (neg->service.hdr.tag_len != 0)) {
1243 			insert_tag(sp, &neg->service.hdr); /* SERVICE */
1244 		}
1245 		if ((tag = get_tag(ph, PTT_HOST_UNIQ)))
1246 			insert_tag(sp, tag); /* returned hostunique */
1247 		insert_tag(sp, &uniqtag.hdr);
1248 		scan_tags(sp, ph);
1249 		make_packet(sp);
1250 		/*
1251 		 * Send the offer but if they don't respond
1252 		 * in PPPOE_OFFER_TIMEOUT seconds, forget about it.
1253 		 */
1254 		ng_callout(&neg->handle, node, hook, PPPOE_OFFER_TIMEOUT * hz,
1255 		    pppoe_ticker, NULL, 0);
1256 		m0 = m_copypacket(sp->neg->m, M_DONTWAIT);
1257 		NG_FWD_NEW_DATA(error, item, privp->ethernet_hook, m0);
1258 		privp->packets_out++;
1259 		break;
1260 		}
1261 
1262 	/*
1263 	 * Packets coming from the hook make no sense
1264 	 * to sessions in the rest of states. Throw them away.
1265 	 */
1266 	default:
1267 		LEAVE(ENETUNREACH);
1268 	}
1269 quit:
1270 	if (item)
1271 		NG_FREE_ITEM(item);
1272 	NG_FREE_M(m);
1273 	return (error);
1274 }
1275 
1276 /*
1277  * Receive data from ether and do something with it.
1278  */
1279 static int
1280 ng_pppoe_rcvdata_ether(hook_p hook, item_p item)
1281 {
1282 	node_p			node = NG_HOOK_NODE(hook);
1283 	const priv_p		privp = NG_NODE_PRIVATE(node);
1284 	sessp			sp = NG_HOOK_PRIVATE(hook);
1285 	const struct pppoe_tag	*utag = NULL, *tag = NULL;
1286 	const struct pppoe_full_hdr *wh;
1287 	const struct pppoe_hdr	*ph;
1288 	negp			neg = NULL;
1289 	struct mbuf		*m;
1290 	hook_p 			sendhook;
1291 	int			error = 0;
1292 	uint16_t		session;
1293 	uint16_t		length;
1294 	uint8_t			code;
1295 	struct	mbuf 		*m0;
1296 
1297 	CTR6(KTR_NET, "%20s: node [%x] (%p) received %p on \"%s\" (%p)",
1298 	    __func__, node->nd_ID, node, item, hook->hk_name, hook);
1299 
1300 	NGI_GET_M(item, m);
1301 	/*
1302 	 * Dig out various fields from the packet.
1303 	 * Use them to decide where to send it.
1304 	 */
1305 	privp->packets_in++;
1306 	if( m->m_len < sizeof(*wh)) {
1307 		m = m_pullup(m, sizeof(*wh)); /* Checks length */
1308 		if (m == NULL) {
1309 			log(LOG_NOTICE, "ng_pppoe[%x]: couldn't "
1310 			    "m_pullup(wh)\n", node->nd_ID);
1311 			LEAVE(ENOBUFS);
1312 		}
1313 	}
1314 	wh = mtod(m, struct pppoe_full_hdr *);
1315 	length = ntohs(wh->ph.length);
1316 	switch(wh->eh.ether_type) {
1317 	case	ETHERTYPE_PPPOE_3COM_DISC: /* fall through */
1318 	case	ETHERTYPE_PPPOE_DISC:
1319 		/*
1320 		 * We need to try to make sure that the tag area
1321 		 * is contiguous, or we could wander off the end
1322 		 * of a buffer and make a mess.
1323 		 * (Linux wouldn't have this problem).
1324 		 */
1325 		if (m->m_pkthdr.len <= MHLEN) {
1326 			if( m->m_len < m->m_pkthdr.len) {
1327 				m = m_pullup(m, m->m_pkthdr.len);
1328 				if (m == NULL) {
1329 					log(LOG_NOTICE, "ng_pppoe[%x]: "
1330 					    "couldn't m_pullup(pkthdr)\n",
1331 					    node->nd_ID);
1332 					LEAVE(ENOBUFS);
1333 				}
1334 			}
1335 		}
1336 		if (m->m_len != m->m_pkthdr.len) {
1337 			/*
1338 			 * It's not all in one piece.
1339 			 * We need to do extra work.
1340 			 * Put it into a cluster.
1341 			 */
1342 			struct mbuf *n;
1343 			n = m_dup(m, M_DONTWAIT);
1344 			m_freem(m);
1345 			m = n;
1346 			if (m) {
1347 				/* just check we got a cluster */
1348 				if (m->m_len != m->m_pkthdr.len) {
1349 					m_freem(m);
1350 					m = NULL;
1351 				}
1352 			}
1353 			if (m == NULL) {
1354 				log(LOG_NOTICE, "ng_pppoe[%x]: packet "
1355 				    "fragmented\n", node->nd_ID);
1356 				LEAVE(EMSGSIZE);
1357 			}
1358 		}
1359 		wh = mtod(m, struct pppoe_full_hdr *);
1360 		length = ntohs(wh->ph.length);
1361 		ph = &wh->ph;
1362 		session = ntohs(wh->ph.sid);
1363 		code = wh->ph.code;
1364 
1365 		switch(code) {
1366 		case	PADI_CODE:
1367 			/*
1368 			 * We are a server:
1369 			 * Look for a hook with the required service and send
1370 			 * the ENTIRE packet up there. It should come back to
1371 			 * a new hook in PRIMED state. Look there for further
1372 			 * processing.
1373 			 */
1374 			tag = get_tag(ph, PTT_SRV_NAME);
1375 			if (tag == NULL) {
1376 				CTR1(KTR_NET, "%20s: PADI w/o Service-Name",
1377 				    __func__);
1378 				LEAVE(ENETUNREACH);
1379 			}
1380 
1381 			/*
1382 			 * First, try to match Service-Name against our
1383 			 * listening hooks. If no success and we are in D-Link
1384 			 * compat mode and Service-Name is empty, then we
1385 			 * broadcast the PADI to all listening hooks.
1386 			 */
1387 			sendhook = pppoe_match_svc(node, tag);
1388 			if (sendhook != NULL)
1389 				NG_FWD_NEW_DATA(error, item, sendhook, m);
1390 			else if (privp->flags & COMPAT_DLINK &&
1391 				 ntohs(tag->tag_len) == 0)
1392 				error = pppoe_broadcast_padi(node, m);
1393 			else
1394 				error = ENETUNREACH;
1395 			break;
1396 		case	PADO_CODE:
1397 			/*
1398 			 * We are a client:
1399 			 * Use the host_uniq tag to find the hook this is in
1400 			 * response to. Received #2, now send #3
1401 			 * For now simply accept the first we receive.
1402 			 */
1403 			utag = get_tag(ph, PTT_HOST_UNIQ);
1404 			if ((utag == NULL) ||
1405 			    (ntohs(utag->tag_len) != sizeof(sp))) {
1406 				log(LOG_NOTICE, "ng_pppoe[%x]: no host "
1407 				    "unique field\n", node->nd_ID);
1408 				LEAVE(ENETUNREACH);
1409 			}
1410 
1411 			sendhook = pppoe_finduniq(node, utag);
1412 			if (sendhook == NULL) {
1413 				log(LOG_NOTICE, "ng_pppoe[%x]: no "
1414 				    "matching session\n", node->nd_ID);
1415 				LEAVE(ENETUNREACH);
1416 			}
1417 
1418 			/*
1419 			 * Check the session is in the right state.
1420 			 * It needs to be in PPPOE_SINIT.
1421 			 */
1422 			sp = NG_HOOK_PRIVATE(sendhook);
1423 			if (sp->state == PPPOE_SREQ ||
1424 			    sp->state == PPPOE_CONNECTED) {
1425 				break;	/* Multiple PADO is OK. */
1426 			}
1427 			if (sp->state != PPPOE_SINIT) {
1428 				log(LOG_NOTICE, "ng_pppoe[%x]: session "
1429 				    "in wrong state\n", node->nd_ID);
1430 				LEAVE(ENETUNREACH);
1431 			}
1432 			neg = sp->neg;
1433 			/* If requested specific AC-name, check it. */
1434 			if (neg->ac_name_len) {
1435 				tag = get_tag(ph, PTT_AC_NAME);
1436 				if (!tag) {
1437 					/* No PTT_AC_NAME in PADO */
1438 					break;
1439 				}
1440 				if (neg->ac_name_len != htons(tag->tag_len) ||
1441 				    strncmp(neg->ac_name.data, tag->tag_data,
1442 				    neg->ac_name_len) != 0) {
1443 					break;
1444 				}
1445 			}
1446 			sp->state = PPPOE_SREQ;
1447 			ng_uncallout(&neg->handle, node);
1448 
1449 			/*
1450 			 * This is the first time we hear
1451 			 * from the server, so note it's
1452 			 * unicast address, replacing the
1453 			 * broadcast address .
1454 			 */
1455 			bcopy(wh->eh.ether_shost,
1456 				neg->pkt->pkt_header.eh.ether_dhost,
1457 				ETHER_ADDR_LEN);
1458 			neg->timeout = 0;
1459 			neg->pkt->pkt_header.ph.code = PADR_CODE;
1460 			init_tags(sp);
1461 			insert_tag(sp, utag);      	/* Host Unique */
1462 			if ((tag = get_tag(ph, PTT_AC_COOKIE)))
1463 				insert_tag(sp, tag); 	/* return cookie */
1464 			if ((tag = get_tag(ph, PTT_AC_NAME))) {
1465 				insert_tag(sp, tag); 	/* return it */
1466 				send_acname(sp, tag);
1467 			}
1468 			insert_tag(sp, &neg->service.hdr); /* Service */
1469 			scan_tags(sp, ph);
1470 			make_packet(sp);
1471 			sp->state = PPPOE_SREQ;
1472 			ng_callout(&neg->handle, node, sp->hook,
1473 			    PPPOE_INITIAL_TIMEOUT * hz,
1474 			    pppoe_ticker, NULL, 0);
1475 			neg->timeout = PPPOE_INITIAL_TIMEOUT * 2;
1476 			m0 = m_copypacket(neg->m, M_DONTWAIT);
1477 			NG_FWD_NEW_DATA(error, item, privp->ethernet_hook, m0);
1478 			break;
1479 		case	PADR_CODE:
1480 			/*
1481 			 * We are a server:
1482 			 * Use the ac_cookie tag to find the
1483 			 * hook this is in response to.
1484 			 */
1485 			utag = get_tag(ph, PTT_AC_COOKIE);
1486 			if ((utag == NULL) ||
1487 			    (ntohs(utag->tag_len) != sizeof(sp))) {
1488 				LEAVE(ENETUNREACH);
1489 			}
1490 
1491 			sendhook = pppoe_finduniq(node, utag);
1492 			if (sendhook == NULL)
1493 				LEAVE(ENETUNREACH);
1494 
1495 			/*
1496 			 * Check the session is in the right state.
1497 			 * It needs to be in PPPOE_SOFFER or PPPOE_NEWCONNECTED.
1498 			 * If the latter, then this is a retry by the client,
1499 			 * so be nice, and resend.
1500 			 */
1501 			sp = NG_HOOK_PRIVATE(sendhook);
1502 			if (sp->state == PPPOE_NEWCONNECTED) {
1503 				/*
1504 				 * Whoa! drop back to resend that PADS packet.
1505 				 * We should still have a copy of it.
1506 				 */
1507 				sp->state = PPPOE_SOFFER;
1508 			}
1509 			if (sp->state != PPPOE_SOFFER)
1510 				LEAVE (ENETUNREACH);
1511 			neg = sp->neg;
1512 			ng_uncallout(&neg->handle, node);
1513 			neg->pkt->pkt_header.ph.code = PADS_CODE;
1514 			if (sp->Session_ID == 0)
1515 				neg->pkt->pkt_header.ph.sid =
1516 				    htons(sp->Session_ID
1517 					= get_new_sid(node));
1518 			send_sessionid(sp);
1519 			neg->timeout = 0;
1520 			/*
1521 			 * start working out the tags to respond with.
1522 			 */
1523 			init_tags(sp);
1524 			insert_tag(sp, &neg->ac_name.hdr); /* AC_NAME */
1525 			if ((tag = get_tag(ph, PTT_SRV_NAME)))
1526 				insert_tag(sp, tag);/* return service */
1527 			if ((tag = get_tag(ph, PTT_HOST_UNIQ)))
1528 				insert_tag(sp, tag); /* return it */
1529 			insert_tag(sp, utag);	/* ac_cookie */
1530 			scan_tags(sp, ph);
1531 			make_packet(sp);
1532 			sp->state = PPPOE_NEWCONNECTED;
1533 
1534 			/* Send the PADS without a timeout - we're now connected. */
1535 			m0 = m_copypacket(sp->neg->m, M_DONTWAIT);
1536 			NG_FWD_NEW_DATA(error, item, privp->ethernet_hook, m0);
1537 
1538 			/*
1539 			 * Having sent the last Negotiation header,
1540 			 * Set up the stored packet header to be correct for
1541 			 * the actual session. But keep the negotialtion stuff
1542 			 * around in case we need to resend this last packet.
1543 			 * We'll discard it when we move from NEWCONNECTED
1544 			 * to CONNECTED
1545 			 */
1546 			sp->pkt_hdr = neg->pkt->pkt_header;
1547 			/* Configure ethertype depending on what
1548 			 * ethertype was used at discovery phase */
1549 			if (sp->pkt_hdr.eh.ether_type ==
1550 			    ETHERTYPE_PPPOE_3COM_DISC)
1551 				sp->pkt_hdr.eh.ether_type
1552 					= ETHERTYPE_PPPOE_3COM_SESS;
1553 			else
1554 				sp->pkt_hdr.eh.ether_type
1555 					= ETHERTYPE_PPPOE_SESS;
1556 			sp->pkt_hdr.ph.code = 0;
1557 			pppoe_send_event(sp, NGM_PPPOE_SUCCESS);
1558 			break;
1559 		case	PADS_CODE:
1560 			/*
1561 			 * We are a client:
1562 			 * Use the host_uniq tag to find the hook this is in
1563 			 * response to. Take the session ID and store it away.
1564 			 * Also make sure the pre-made header is correct and
1565 			 * set us into Session mode.
1566 			 */
1567 			utag = get_tag(ph, PTT_HOST_UNIQ);
1568 			if ((utag == NULL) ||
1569 			    (ntohs(utag->tag_len) != sizeof(sp))) {
1570 				LEAVE (ENETUNREACH);
1571 			}
1572 			sendhook = pppoe_finduniq(node, utag);
1573 			if (sendhook == NULL)
1574 				LEAVE(ENETUNREACH);
1575 
1576 			/*
1577 			 * Check the session is in the right state.
1578 			 * It needs to be in PPPOE_SREQ.
1579 			 */
1580 			sp = NG_HOOK_PRIVATE(sendhook);
1581 			if (sp->state != PPPOE_SREQ)
1582 				LEAVE(ENETUNREACH);
1583 			neg = sp->neg;
1584 			ng_uncallout(&neg->handle, node);
1585 			neg->pkt->pkt_header.ph.sid = wh->ph.sid;
1586 			sp->Session_ID = ntohs(wh->ph.sid);
1587 			send_sessionid(sp);
1588 			neg->timeout = 0;
1589 			sp->state = PPPOE_CONNECTED;
1590 			/*
1591 			 * Now we have gone to Connected mode,
1592 			 * Free all resources needed for negotiation.
1593 			 * Keep a copy of the header we will be using.
1594 			 */
1595 			sp->pkt_hdr = neg->pkt->pkt_header;
1596 			if (privp->flags & COMPAT_3COM)
1597 				sp->pkt_hdr.eh.ether_type
1598 					= ETHERTYPE_PPPOE_3COM_SESS;
1599 			else
1600 				sp->pkt_hdr.eh.ether_type
1601 					= ETHERTYPE_PPPOE_SESS;
1602 			sp->pkt_hdr.ph.code = 0;
1603 			m_freem(neg->m);
1604 			free(sp->neg, M_NETGRAPH_PPPOE);
1605 			sp->neg = NULL;
1606 			pppoe_send_event(sp, NGM_PPPOE_SUCCESS);
1607 			break;
1608 		case	PADT_CODE:
1609 			/*
1610 			 * Find matching peer/session combination.
1611 			 */
1612 			sendhook = pppoe_findsession(node, wh);
1613 			if (sendhook == NULL)
1614 				LEAVE(ENETUNREACH);
1615 			/* Disconnect that hook. */
1616 			ng_rmhook_self(sendhook);
1617 			break;
1618 		default:
1619 			LEAVE(EPFNOSUPPORT);
1620 		}
1621 		break;
1622 	case	ETHERTYPE_PPPOE_3COM_SESS:
1623 	case	ETHERTYPE_PPPOE_SESS:
1624 		/*
1625 		 * Find matching peer/session combination.
1626 		 */
1627 		sendhook = pppoe_findsession(node, wh);
1628 		if (sendhook == NULL)
1629 			LEAVE (ENETUNREACH);
1630 		sp = NG_HOOK_PRIVATE(sendhook);
1631 		m_adj(m, sizeof(*wh));
1632 
1633 		/* If packet too short, dump it. */
1634 		if (m->m_pkthdr.len < length)
1635 			LEAVE(EMSGSIZE);
1636 		/* Also need to trim excess at the end */
1637 		if (m->m_pkthdr.len > length) {
1638 			m_adj(m, -((int)(m->m_pkthdr.len - length)));
1639 		}
1640 		if ( sp->state != PPPOE_CONNECTED) {
1641 			if (sp->state == PPPOE_NEWCONNECTED) {
1642 				sp->state = PPPOE_CONNECTED;
1643 				/*
1644 				 * Now we have gone to Connected mode,
1645 				 * Free all resources needed for negotiation.
1646 				 * Be paranoid about whether there may be
1647 				 * a timeout.
1648 				 */
1649 				m_freem(sp->neg->m);
1650 				ng_uncallout(&sp->neg->handle, node);
1651 				free(sp->neg, M_NETGRAPH_PPPOE);
1652 				sp->neg = NULL;
1653 			} else {
1654 				LEAVE (ENETUNREACH);
1655 			}
1656 		}
1657 		NG_FWD_NEW_DATA(error, item, sendhook, m);
1658 		break;
1659 	default:
1660 		LEAVE(EPFNOSUPPORT);
1661 	}
1662 quit:
1663 	if (item)
1664 		NG_FREE_ITEM(item);
1665 	NG_FREE_M(m);
1666 	return (error);
1667 }
1668 
1669 /*
1670  * Receive data from debug hook and bypass it to ether.
1671  */
1672 static int
1673 ng_pppoe_rcvdata_debug(hook_p hook, item_p item)
1674 {
1675 	node_p		node = NG_HOOK_NODE(hook);
1676 	const priv_p	privp = NG_NODE_PRIVATE(node);
1677 	int		error;
1678 
1679 	CTR6(KTR_NET, "%20s: node [%x] (%p) received %p on \"%s\" (%p)",
1680 	    __func__, node->nd_ID, node, item, hook->hk_name, hook);
1681 
1682 	NG_FWD_ITEM_HOOK(error, item, privp->ethernet_hook);
1683 	privp->packets_out++;
1684 	return (error);
1685 }
1686 
1687 /*
1688  * Do local shutdown processing..
1689  * If we are a persistant device, we might refuse to go away, and
1690  * we'd only remove our links and reset ourself.
1691  */
1692 static int
1693 ng_pppoe_shutdown(node_p node)
1694 {
1695 	const priv_p privdata = NG_NODE_PRIVATE(node);
1696 
1697 	NG_NODE_SET_PRIVATE(node, NULL);
1698 	NG_NODE_UNREF(privdata->node);
1699 	free(privdata, M_NETGRAPH_PPPOE);
1700 	return (0);
1701 }
1702 
1703 /*
1704  * Hook disconnection
1705  *
1706  * Clean up all dangling links and information about the session/hook.
1707  * For this type, removal of the last link destroys the node.
1708  */
1709 static int
1710 ng_pppoe_disconnect(hook_p hook)
1711 {
1712 	node_p node = NG_HOOK_NODE(hook);
1713 	priv_p privp = NG_NODE_PRIVATE(node);
1714 	sessp	sp;
1715 
1716 	if (hook == privp->debug_hook) {
1717 		privp->debug_hook = NULL;
1718 	} else if (hook == privp->ethernet_hook) {
1719 		privp->ethernet_hook = NULL;
1720 		if (NG_NODE_IS_VALID(node))
1721 			ng_rmnode_self(node);
1722 	} else {
1723 		sp = NG_HOOK_PRIVATE(hook);
1724 		if (sp->state != PPPOE_SNONE ) {
1725 			pppoe_send_event(sp, NGM_PPPOE_CLOSE);
1726 		}
1727 		/*
1728 		 * According to the spec, if we are connected,
1729 		 * we should send a DISC packet if we are shutting down
1730 		 * a session.
1731 		 */
1732 		if ((privp->ethernet_hook)
1733 		&& ((sp->state == PPPOE_CONNECTED)
1734 		 || (sp->state == PPPOE_NEWCONNECTED))) {
1735 			struct mbuf *m;
1736 
1737 			/* Generate a packet of that type. */
1738 			MGETHDR(m, M_DONTWAIT, MT_DATA);
1739 			if (m == NULL)
1740 				log(LOG_NOTICE, "ng_pppoe[%x]: session out of "
1741 				    "mbufs\n", node->nd_ID);
1742 			else {
1743 				struct pppoe_full_hdr *wh;
1744 				struct pppoe_tag *tag;
1745 				int	msglen = strlen(SIGNOFF);
1746 				int	error = 0;
1747 
1748 				m->m_pkthdr.rcvif = NULL;
1749 				m->m_pkthdr.len = m->m_len = sizeof(*wh);
1750 				wh = mtod(m, struct pppoe_full_hdr *);
1751 				bcopy(&sp->pkt_hdr, wh, sizeof(*wh));
1752 
1753 				/* Revert the stored header to DISC/PADT mode. */
1754 				wh->ph.code = PADT_CODE;
1755 				/*
1756 				 * Configure ethertype depending on what
1757 				 * was used during sessions stage.
1758 				 */
1759 				if (wh->eh.ether_type ==
1760 				    ETHERTYPE_PPPOE_3COM_SESS)
1761 					wh->eh.ether_type = ETHERTYPE_PPPOE_3COM_DISC;
1762 				else
1763 					wh->eh.ether_type = ETHERTYPE_PPPOE_DISC;
1764 				/*
1765 				 * Add a General error message and adjust
1766 				 * sizes.
1767 				 */
1768 				tag = wh->ph.tag;
1769 				tag->tag_type = PTT_GEN_ERR;
1770 				tag->tag_len = htons((u_int16_t)msglen);
1771 				strncpy(tag->tag_data, SIGNOFF, msglen);
1772 				m->m_pkthdr.len = (m->m_len += sizeof(*tag) +
1773 				    msglen);
1774 				wh->ph.length = htons(sizeof(*tag) + msglen);
1775 				NG_SEND_DATA_ONLY(error,
1776 					privp->ethernet_hook, m);
1777 			}
1778 		}
1779 		/*
1780 		 * As long as we have somewhere to store the timeout handle,
1781 		 * we may have a timeout pending.. get rid of it.
1782 		 */
1783 		if (sp->neg) {
1784 			ng_uncallout(&sp->neg->handle, node);
1785 			if (sp->neg->m)
1786 				m_freem(sp->neg->m);
1787 			free(sp->neg, M_NETGRAPH_PPPOE);
1788 		}
1789 		free(sp, M_NETGRAPH_PPPOE);
1790 		NG_HOOK_SET_PRIVATE(hook, NULL);
1791 	}
1792 	if ((NG_NODE_NUMHOOKS(node) == 0) &&
1793 	    (NG_NODE_IS_VALID(node)))
1794 		ng_rmnode_self(node);
1795 	return (0);
1796 }
1797 
1798 /*
1799  * Timeouts come here.
1800  */
1801 static void
1802 pppoe_ticker(node_p node, hook_p hook, void *arg1, int arg2)
1803 {
1804 	priv_p privp = NG_NODE_PRIVATE(NG_HOOK_NODE(hook));
1805 	sessp	sp = NG_HOOK_PRIVATE(hook);
1806 	negp	neg = sp->neg;
1807 	struct mbuf *m0 = NULL;
1808 	int	error = 0;
1809 
1810 	CTR6(KTR_NET, "%20s: node [%x] (%p) hook \"%s\" (%p) session %d",
1811 	    __func__, node->nd_ID, node, hook->hk_name, hook, sp->Session_ID);
1812 	switch(sp->state) {
1813 		/*
1814 		 * Resend the last packet, using an exponential backoff.
1815 		 * After a period of time, stop growing the backoff,
1816 		 * And either leave it, or revert to the start.
1817 		 */
1818 	case	PPPOE_SINIT:
1819 	case	PPPOE_SREQ:
1820 		/* Timeouts on these produce resends. */
1821 		m0 = m_copypacket(sp->neg->m, M_DONTWAIT);
1822 		NG_SEND_DATA_ONLY( error, privp->ethernet_hook, m0);
1823 		ng_callout(&neg->handle, node, hook, neg->timeout * hz,
1824 		    pppoe_ticker, NULL, 0);
1825 		if ((neg->timeout <<= 1) > PPPOE_TIMEOUT_LIMIT) {
1826 			if (sp->state == PPPOE_SREQ) {
1827 				/* Revert to SINIT mode. */
1828 				pppoe_start(sp);
1829 			} else {
1830 				neg->timeout = PPPOE_TIMEOUT_LIMIT;
1831 			}
1832 		}
1833 		break;
1834 	case	PPPOE_PRIMED:
1835 	case	PPPOE_SOFFER:
1836 		/* A timeout on these says "give up" */
1837 		ng_rmhook_self(hook);
1838 		break;
1839 	default:
1840 		/* Timeouts have no meaning in other states. */
1841 		log(LOG_NOTICE, "ng_pppoe[%x]: unexpected timeout\n",
1842 		    node->nd_ID);
1843 	}
1844 }
1845 
1846 /*
1847  * Parse an incoming packet to see if any tags should be copied to the
1848  * output packet. Don't do any tags that have been handled in the main
1849  * state machine.
1850  */
1851 static const struct pppoe_tag*
1852 scan_tags(sessp	sp, const struct pppoe_hdr* ph)
1853 {
1854 	const char *const end = (const char *)next_tag(ph);
1855 	const char *ptn;
1856 	const struct pppoe_tag *pt = &ph->tag[0];
1857 
1858 	/*
1859 	 * Keep processing tags while a tag header will still fit.
1860 	 */
1861 	CTR2(KTR_NET, "%20s: called %d", __func__, sp->Session_ID);
1862 
1863 	while((const char*)(pt + 1) <= end) {
1864 		/*
1865 		 * If the tag data would go past the end of the packet, abort.
1866 		 */
1867 		ptn = (((const char *)(pt + 1)) + ntohs(pt->tag_len));
1868 		if(ptn > end)
1869 			return NULL;
1870 
1871 		switch (pt->tag_type) {
1872 		case	PTT_RELAY_SID:
1873 			insert_tag(sp, pt);
1874 			break;
1875 		case	PTT_EOL:
1876 			return NULL;
1877 		case	PTT_SRV_NAME:
1878 		case	PTT_AC_NAME:
1879 		case	PTT_HOST_UNIQ:
1880 		case	PTT_AC_COOKIE:
1881 		case	PTT_VENDOR:
1882 		case	PTT_SRV_ERR:
1883 		case	PTT_SYS_ERR:
1884 		case	PTT_GEN_ERR:
1885 			break;
1886 		}
1887 		pt = (const struct pppoe_tag*)ptn;
1888 	}
1889 	return NULL;
1890 }
1891 
1892 static	int
1893 pppoe_send_event(sessp sp, enum cmd cmdid)
1894 {
1895 	int error;
1896 	struct ng_mesg *msg;
1897 	struct ngpppoe_sts *sts;
1898 
1899 	CTR2(KTR_NET, "%20s: called %d", __func__, sp->Session_ID);
1900 
1901 	NG_MKMESSAGE(msg, NGM_PPPOE_COOKIE, cmdid,
1902 			sizeof(struct ngpppoe_sts), M_NOWAIT);
1903 	if (msg == NULL)
1904 		return (ENOMEM);
1905 	sts = (struct ngpppoe_sts *)msg->data;
1906 	strncpy(sts->hook, NG_HOOK_NAME(sp->hook), NG_HOOKSIZ);
1907 	NG_SEND_MSG_ID(error, NG_HOOK_NODE(sp->hook), msg, sp->creator, 0);
1908 	return (error);
1909 }
1910