6 * Copyright (c) 1996-1999 Whistle Communications, Inc.
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.
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
38 * Author: Julian Elischer <julian@freebsd.org>
40 * $FreeBSD: src/sys/netgraph/ng_pppoe.c,v 1.94 2008/03/03 19:36:03 mav Exp $
41 * $DragonFly: src/sys/netgraph7/ng_pppoe.c,v 1.2 2008/06/26 23:05:35 dillon Exp $
42 * $Whistle: ng_pppoe.c,v 1.10 1999/11/01 09:24:52 julian Exp $
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/kernel.h>
50 #include <sys/malloc.h>
51 #include <sys/errno.h>
52 #include <sys/syslog.h>
53 #include <net/ethernet.h>
55 #include "ng_message.h"
61 #ifdef NG_SEPARATE_MALLOC
62 MALLOC_DEFINE(M_NETGRAPH_PPPOE
, "netgraph_pppoe", "netgraph pppoe node");
64 #define M_NETGRAPH_PPPOE M_NETGRAPH
67 #define SIGNOFF "session closed"
70 * This section contains the netgraph method declarations for the
71 * pppoe node. These methods define the netgraph pppoe 'type'.
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
;
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
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
100 /* List of commands and how to convert arguments to/from ASCII */
101 static const struct ng_cmdlist ng_pppoe_cmds
[] = {
106 &ngpppoe_init_data_state_type
,
113 &ngpppoe_init_data_state_type
,
120 &ngpppoe_init_data_state_type
,
127 &ngpppoe_init_data_state_type
,
134 &ng_pppoe_sts_state_type
,
141 &ng_pppoe_sts_state_type
,
148 &ng_pppoe_sts_state_type
,
155 &ng_parse_string_type
,
163 &ng_parse_string_type
169 &ng_parse_enaddr_type
,
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
,
188 NETGRAPH_INIT(pppoe
, &typestruct
);
191 * States for the session state machine.
192 * These have no meaning if there is no hook attached yet.
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] */
206 #define NUMTAGS 20 /* number of tags we are set up to work with */
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.
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 */
220 const struct pppoe_tag
*tags
[NUMTAGS
];
224 struct datatag service
;
225 struct datatag ac_name
;
227 typedef struct sess_neg
*negp
;
230 * Session information that is needed after connection.
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 LIST_ENTRY(sess_con
) sessions
;
241 typedef struct sess_con
*sessp
;
243 #define SESSHASHSIZE 0x0100
244 #define SESSHASH(x) (((x) ^ ((x) >> 8)) & (SESSHASHSIZE - 1))
246 struct sess_hash_entry
{
248 LIST_HEAD(hhead
, sess_con
) head
;
252 * Information we store for each node
255 node_p node
; /* back pointer to node */
256 hook_p ethernet_hook
;
258 u_int packets_in
; /* packets in from ethernet */
259 u_int packets_out
; /* packets out towards ethernet */
261 #define COMPAT_3COM 0x00000001
262 #define COMPAT_DLINK 0x00000002
263 struct ether_header eh
;
264 LIST_HEAD(, sess_con
) listeners
;
265 struct sess_hash_entry sesshash
[SESSHASHSIZE
];
267 typedef struct PPPoE
*priv_p
;
270 char bytes
[sizeof(void *)];
274 #define LEAVE(x) do { error = x; goto quit; } while(0)
275 static void pppoe_start(sessp sp
);
276 static void pppoe_ticker(node_p node
, hook_p hook
, void *arg1
, int arg2
);
277 static const struct pppoe_tag
*scan_tags(sessp sp
,
278 const struct pppoe_hdr
* ph
);
279 static int pppoe_send_event(sessp sp
, enum cmd cmdid
);
281 /*************************************************************************
282 * Some basic utilities from the Linux version with author's permission.*
283 * Author: Michal Ostrowski <mostrows@styx.uwaterloo.ca> *
284 ************************************************************************/
289 * Return the location where the next tag can be put
291 static __inline
const struct pppoe_tag
*
292 next_tag(const struct pppoe_hdr
* ph
)
294 return (const struct pppoe_tag
*)(((const char*)&ph
->tag
[0])
295 + ntohs(ph
->length
));
299 * Look for a tag of a specific type.
300 * Don't trust any length the other end says,
301 * but assume we already sanity checked ph->length.
303 static const struct pppoe_tag
*
304 get_tag(const struct pppoe_hdr
* ph
, uint16_t idx
)
306 const char *const end
= (const char *)next_tag(ph
);
307 const struct pppoe_tag
*pt
= &ph
->tag
[0];
311 * Keep processing tags while a tag header will still fit.
313 while((const char*)(pt
+ 1) <= end
) {
315 * If the tag data would go past the end of the packet, abort.
317 ptn
= (((const char *)(pt
+ 1)) + ntohs(pt
->tag_len
));
319 CTR2(KTR_NET
, "%20s: invalid length for tag %d",
323 if (pt
->tag_type
== idx
) {
324 CTR2(KTR_NET
, "%20s: found tag %d", __func__
, idx
);
328 pt
= (const struct pppoe_tag
*)ptn
;
331 CTR2(KTR_NET
, "%20s: not found tag %d", __func__
, idx
);
335 /**************************************************************************
336 * Inlines to initialise or add tags to a session's tag list.
337 **************************************************************************/
339 * Initialise the session's tag list.
344 KASSERT(sp
->neg
!= NULL
, ("%s: no neg", __func__
));
345 sp
->neg
->numtags
= 0;
349 insert_tag(sessp sp
, const struct pppoe_tag
*tp
)
354 KASSERT(neg
!= NULL
, ("%s: no neg", __func__
));
355 if ((i
= neg
->numtags
++) < NUMTAGS
) {
358 log(LOG_NOTICE
, "ng_pppoe: asked to add too many tags to "
365 * Make up a packet, using the tags filled out for the session.
367 * Assume that the actual pppoe header and ethernet header
368 * are filled out externally to this routine.
369 * Also assume that neg->wh points to the correct
370 * location at the front of the buffer space.
373 make_packet(sessp sp
) {
374 struct pppoe_full_hdr
*wh
= &sp
->neg
->pkt
->pkt_header
;
375 const struct pppoe_tag
**tag
;
381 KASSERT((sp
->neg
!= NULL
) && (sp
->neg
->m
!= NULL
),
382 ("%s: called from wrong state", __func__
));
383 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
385 dp
= (char *)wh
->ph
.tag
;
386 for (count
= 0, tag
= sp
->neg
->tags
;
387 ((count
< sp
->neg
->numtags
) && (count
< NUMTAGS
));
389 tlen
= ntohs((*tag
)->tag_len
) + sizeof(**tag
);
390 if ((length
+ tlen
) > (ETHER_MAX_LEN
- 4 - sizeof(*wh
))) {
391 log(LOG_NOTICE
, "ng_pppoe: tags too long\n");
392 sp
->neg
->numtags
= count
;
393 break; /* XXX chop off what's too long */
395 bcopy(*tag
, (char *)dp
, tlen
);
399 wh
->ph
.length
= htons(length
);
400 sp
->neg
->m
->m_len
= length
+ sizeof(*wh
);
401 sp
->neg
->m
->m_pkthdr
.len
= length
+ sizeof(*wh
);
404 /**************************************************************************
405 * Routines to match a service. *
406 **************************************************************************/
409 * Find a hook that has a service string that matches that
410 * we are seeking. For now use a simple string.
411 * In the future we may need something like regexp().
413 * Null string is a wildcard (ANY service), according to RFC2516.
414 * And historical FreeBSD wildcard is also "*".
418 pppoe_match_svc(node_p node
, const struct pppoe_tag
*tag
)
420 const priv_p privp
= NG_NODE_PRIVATE(node
);
423 LIST_FOREACH(sp
, &privp
->listeners
, sessions
) {
426 /* Empty Service-Name matches any service. */
427 if (neg
->service_len
== 0)
430 /* Special case for a blank or "*" service name (wildcard). */
431 if (neg
->service_len
== 1 && neg
->service
.data
[0] == '*')
434 /* If the lengths don't match, that aint it. */
435 if (neg
->service_len
!= ntohs(tag
->tag_len
))
438 if (strncmp(tag
->tag_data
, neg
->service
.data
,
439 ntohs(tag
->tag_len
)) == 0)
442 CTR3(KTR_NET
, "%20s: matched %p for %s", __func__
,
443 sp
?sp
->hook
:NULL
, tag
->tag_data
);
445 return (sp
?sp
->hook
:NULL
);
449 * Broadcast the PADI packet in m0 to all listening hooks.
450 * This routine is called when a PADI with empty Service-Name
451 * tag is received. Client should receive PADOs with all
452 * available services.
455 pppoe_broadcast_padi(node_p node
, struct mbuf
*m0
)
457 const priv_p privp
= NG_NODE_PRIVATE(node
);
461 LIST_FOREACH(sp
, &privp
->listeners
, sessions
) {
464 m
= m_dup(m0
, MB_DONTWAIT
);
467 NG_SEND_DATA_ONLY(error
, sp
->hook
, m
);
476 * Find a hook, which name equals to given service.
479 pppoe_find_svc(node_p node
, const char *svc_name
, int svc_len
)
481 const priv_p privp
= NG_NODE_PRIVATE(node
);
484 LIST_FOREACH(sp
, &privp
->listeners
, sessions
) {
487 if (neg
->service_len
== svc_len
&&
488 strncmp(svc_name
, neg
->service
.data
, svc_len
) == 0)
495 /**************************************************************************
496 * Routines to find a particular session that matches an incoming packet. *
497 **************************************************************************/
498 /* Find free session and add to hash. */
500 pppoe_getnewsession(sessp sp
)
502 const priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(sp
->hook
));
503 static uint16_t pppoe_sid
= 1;
508 /* Atomicity is not needed here as value will be checked. */
510 /* Spec says 0xFFFF is reserved, also don't use 0x0000. */
511 if (val
== 0xffff || val
== 0x0000)
514 /* Check it isn't already in use. */
515 hash
= SESSHASH(val
);
516 mtx_lock(&privp
->sesshash
[hash
].mtx
);
517 LIST_FOREACH(tsp
, &privp
->sesshash
[hash
].head
, sessions
) {
518 if (tsp
->Session_ID
== val
)
522 sp
->Session_ID
= val
;
523 LIST_INSERT_HEAD(&privp
->sesshash
[hash
].head
, sp
, sessions
);
525 mtx_unlock(&privp
->sesshash
[hash
].mtx
);
529 CTR2(KTR_NET
, "%20s: new sid %d", __func__
, val
);
534 /* Add specified session to hash. */
536 pppoe_addsession(sessp sp
)
538 const priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(sp
->hook
));
539 uint16_t hash
= SESSHASH(sp
->Session_ID
);
541 mtx_lock(&privp
->sesshash
[hash
].mtx
);
542 LIST_INSERT_HEAD(&privp
->sesshash
[hash
].head
, sp
, sessions
);
543 mtx_unlock(&privp
->sesshash
[hash
].mtx
);
546 /* Delete specified session from hash. */
548 pppoe_delsession(sessp sp
)
550 const priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(sp
->hook
));
551 uint16_t hash
= SESSHASH(sp
->Session_ID
);
553 mtx_lock(&privp
->sesshash
[hash
].mtx
);
554 LIST_REMOVE(sp
, sessions
);
555 mtx_unlock(&privp
->sesshash
[hash
].mtx
);
558 /* Find matching peer/session combination. */
560 pppoe_findsession(priv_p privp
, const struct pppoe_full_hdr
*wh
)
562 uint16_t session
= ntohs(wh
->ph
.sid
);
563 uint16_t hash
= SESSHASH(session
);
566 mtx_lock(&privp
->sesshash
[hash
].mtx
);
567 LIST_FOREACH(sp
, &privp
->sesshash
[hash
].head
, sessions
) {
568 if (sp
->Session_ID
== session
&&
569 bcmp(sp
->pkt_hdr
.eh
.ether_dhost
,
570 wh
->eh
.ether_shost
, ETHER_ADDR_LEN
) == 0) {
574 mtx_unlock(&privp
->sesshash
[hash
].mtx
);
575 CTR3(KTR_NET
, "%20s: matched %p for %d", __func__
, sp
?sp
->hook
:NULL
,
582 pppoe_finduniq(node_p node
, const struct pppoe_tag
*tag
)
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
)
593 if (uniq
.pointer
== NG_HOOK_PRIVATE(hook
))
596 CTR3(KTR_NET
, "%20s: matched %p for %p", __func__
, hook
, uniq
.pointer
);
601 /**************************************************************************
602 * Start of Netgraph entrypoints. *
603 **************************************************************************/
606 * Allocate the private data structure and link it with node.
609 ng_pppoe_constructor(node_p node
)
614 /* Initialize private descriptor. */
615 privp
= kmalloc(sizeof(*privp
), M_NETGRAPH_PPPOE
, M_WAITOK
| M_NULLOK
| M_ZERO
);
619 /* Link structs together; this counts as our one reference to *node. */
620 NG_NODE_SET_PRIVATE(node
, privp
);
623 /* Initialize to standard mode. */
624 memset(&privp
->eh
.ether_dhost
, 0xff, ETHER_ADDR_LEN
);
625 privp
->eh
.ether_type
= ETHERTYPE_PPPOE_DISC
;
627 LIST_INIT(&privp
->listeners
);
628 for (i
= 0; i
< SESSHASHSIZE
; i
++) {
629 mtx_init(&privp
->sesshash
[i
].mtx
, "PPPoE hash mutex", NULL
, MTX_DEF
);
630 LIST_INIT(&privp
->sesshash
[i
].head
);
633 CTR3(KTR_NET
, "%20s: created node [%x] (%p)",
634 __func__
, node
->nd_ID
, node
);
640 * Give our ok for a hook to be added...
641 * point the hook's private info to the hook structure.
643 * The following hook names are special:
644 * "ethernet": the hook that should be connected to a NIC.
645 * "debug": copies of data sent out here (when I write the code).
646 * All other hook names need only be unique. (the framework checks this).
649 ng_pppoe_newhook(node_p node
, hook_p hook
, const char *name
)
651 const priv_p privp
= NG_NODE_PRIVATE(node
);
654 if (strcmp(name
, NG_PPPOE_HOOK_ETHERNET
) == 0) {
655 privp
->ethernet_hook
= hook
;
656 NG_HOOK_SET_RCVDATA(hook
, ng_pppoe_rcvdata_ether
);
657 } else if (strcmp(name
, NG_PPPOE_HOOK_DEBUG
) == 0) {
658 privp
->debug_hook
= hook
;
659 NG_HOOK_SET_RCVDATA(hook
, ng_pppoe_rcvdata_debug
);
662 * Any other unique name is OK.
663 * The infrastructure has already checked that it's unique,
664 * so just allocate it and hook it in.
666 sp
= kmalloc(sizeof(*sp
), M_NETGRAPH_PPPOE
, M_WAITOK
| M_NULLOK
| M_ZERO
);
670 NG_HOOK_SET_PRIVATE(hook
, sp
);
673 CTR5(KTR_NET
, "%20s: node [%x] (%p) connected hook %s (%p)",
674 __func__
, node
->nd_ID
, node
, name
, hook
);
680 * Hook has been added successfully. Request the MAC address of
681 * the underlying Ethernet node.
684 ng_pppoe_connect(hook_p hook
)
686 const priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(hook
));
690 if (hook
!= privp
->ethernet_hook
)
694 * If this is Ethernet hook, then request MAC address
695 * from our downstream.
697 NG_MKMESSAGE(msg
, NGM_ETHER_COOKIE
, NGM_ETHER_GET_ENADDR
, 0, M_WAITOK
| M_NULLOK
);
702 * Our hook and peer hook have HK_INVALID flag set,
703 * so we can't use NG_SEND_MSG_HOOK() macro here.
705 NG_SEND_MSG_ID(error
, privp
->node
, msg
,
706 NG_NODE_ID(NG_PEER_NODE(privp
->ethernet_hook
)),
707 NG_NODE_ID(privp
->node
));
712 * Get a netgraph control message.
713 * Check it is one we understand. If needed, send a response.
714 * We sometimes save the address for an async action later.
715 * Always free the message.
718 ng_pppoe_rcvmsg(node_p node
, item_p item
, hook_p lasthook
)
720 priv_p privp
= NG_NODE_PRIVATE(node
);
721 struct ngpppoe_init_data
*ourmsg
= NULL
;
722 struct ng_mesg
*resp
= NULL
;
729 NGI_GET_MSG(item
, msg
);
730 CTR5(KTR_NET
, "%20s: node [%x] (%p) got message %d with cookie %d",
731 __func__
, node
->nd_ID
, node
, msg
->header
.cmd
,
732 msg
->header
.typecookie
);
734 /* Deal with message according to cookie and command. */
735 switch (msg
->header
.typecookie
) {
736 case NGM_PPPOE_COOKIE
:
737 switch (msg
->header
.cmd
) {
738 case NGM_PPPOE_CONNECT
:
739 case NGM_PPPOE_LISTEN
:
740 case NGM_PPPOE_OFFER
:
741 case NGM_PPPOE_SERVICE
:
742 ourmsg
= (struct ngpppoe_init_data
*)msg
->data
;
743 if (msg
->header
.arglen
< sizeof(*ourmsg
)) {
744 log(LOG_ERR
, "ng_pppoe[%x]: init data too "
745 "small\n", node
->nd_ID
);
748 if (msg
->header
.arglen
- sizeof(*ourmsg
) >
749 PPPOE_SERVICE_NAME_SIZE
) {
750 log(LOG_ERR
, "ng_pppoe[%x]: service name "
751 "too big\n", node
->nd_ID
);
754 if (msg
->header
.arglen
- sizeof(*ourmsg
) <
756 log(LOG_ERR
, "ng_pppoe[%x]: init data has bad "
757 "length, %d should be %zd\n", node
->nd_ID
,
759 msg
->header
.arglen
- sizeof (*ourmsg
));
763 /* Make sure strcmp will terminate safely. */
764 ourmsg
->hook
[sizeof(ourmsg
->hook
) - 1] = '\0';
766 /* Find hook by name. */
767 hook
= ng_findhook(node
, ourmsg
->hook
);
771 sp
= NG_HOOK_PRIVATE(hook
);
775 if (msg
->header
.cmd
== NGM_PPPOE_LISTEN
) {
777 * Ensure we aren't already listening for this
780 if (pppoe_find_svc(node
, ourmsg
->data
,
781 ourmsg
->data_len
) != NULL
)
786 * PPPOE_SERVICE advertisments are set up
787 * on sessions that are in PRIMED state.
789 if (msg
->header
.cmd
== NGM_PPPOE_SERVICE
)
792 if (sp
->state
!= PPPOE_SNONE
) {
793 log(LOG_NOTICE
, "ng_pppoe[%x]: Session already "
794 "active\n", node
->nd_ID
);
799 * Set up prototype header.
801 neg
= kmalloc(sizeof(*neg
), M_NETGRAPH_PPPOE
,
802 M_WAITOK
| M_NULLOK
| M_ZERO
);
807 neg
->m
= m_getcl(MB_DONTWAIT
, MT_DATA
, M_PKTHDR
);
808 if (neg
->m
== NULL
) {
809 kfree(neg
, M_NETGRAPH_PPPOE
);
812 neg
->m
->m_pkthdr
.rcvif
= NULL
;
814 ng_callout_init(&neg
->handle
);
815 neg
->m
->m_len
= sizeof(struct pppoe_full_hdr
);
816 neg
->pkt
= mtod(neg
->m
, union packet
*);
817 memcpy((void *)&neg
->pkt
->pkt_header
.eh
,
818 &privp
->eh
, sizeof(struct ether_header
));
819 neg
->pkt
->pkt_header
.ph
.ver
= 0x1;
820 neg
->pkt
->pkt_header
.ph
.type
= 0x1;
821 neg
->pkt
->pkt_header
.ph
.sid
= 0x0000;
824 sp
->creator
= NGI_RETADDR(item
);
826 switch (msg
->header
.cmd
) {
827 case NGM_PPPOE_GET_STATUS
:
829 struct ngpppoestat
*stats
;
831 NG_MKRESPONSE(resp
, msg
, sizeof(*stats
), M_WAITOK
| M_NULLOK
);
835 stats
= (struct ngpppoestat
*) resp
->data
;
836 stats
->packets_in
= privp
->packets_in
;
837 stats
->packets_out
= privp
->packets_out
;
840 case NGM_PPPOE_CONNECT
:
843 * Check the hook exists and is Uninitialised.
844 * Send a PADI request, and start the timeout logic.
845 * Store the originator of this message so we can send
846 * a success of fail message to them later.
847 * Move the session to SINIT.
848 * Set up the session to the correct state and
851 int i
, acnlen
= 0, acnsep
= 0, srvlen
;
852 for (i
= 0; i
< ourmsg
->data_len
; i
++) {
853 if (ourmsg
->data
[i
] == '\\') {
859 srvlen
= ourmsg
->data_len
- acnlen
- acnsep
;
861 bcopy(ourmsg
->data
, neg
->ac_name
.data
, acnlen
);
862 neg
->ac_name_len
= acnlen
;
864 neg
->service
.hdr
.tag_type
= PTT_SRV_NAME
;
865 neg
->service
.hdr
.tag_len
= htons((uint16_t)srvlen
);
866 bcopy(ourmsg
->data
+ acnlen
+ acnsep
,
867 neg
->service
.data
, srvlen
);
868 neg
->service_len
= srvlen
;
872 case NGM_PPPOE_LISTEN
:
874 * Check the hook exists and is Uninitialised.
875 * Install the service matching string.
876 * Store the originator of this message so we can send
877 * a success of fail message to them later.
878 * Move the hook to 'LISTENING'
880 neg
->service
.hdr
.tag_type
= PTT_SRV_NAME
;
881 neg
->service
.hdr
.tag_len
=
882 htons((uint16_t)ourmsg
->data_len
);
884 if (ourmsg
->data_len
)
885 bcopy(ourmsg
->data
, neg
->service
.data
,
887 neg
->service_len
= ourmsg
->data_len
;
888 neg
->pkt
->pkt_header
.ph
.code
= PADT_CODE
;
890 * Wait for PADI packet coming from Ethernet.
892 sp
->state
= PPPOE_LISTENING
;
893 LIST_INSERT_HEAD(&privp
->listeners
, sp
, sessions
);
895 case NGM_PPPOE_OFFER
:
897 * Check the hook exists and is Uninitialised.
898 * Store the originator of this message so we can send
899 * a success of fail message to them later.
900 * Store the AC-Name given and go to PRIMED.
902 neg
->ac_name
.hdr
.tag_type
= PTT_AC_NAME
;
903 neg
->ac_name
.hdr
.tag_len
=
904 htons((uint16_t)ourmsg
->data_len
);
905 if (ourmsg
->data_len
)
906 bcopy(ourmsg
->data
, neg
->ac_name
.data
,
908 neg
->ac_name_len
= ourmsg
->data_len
;
909 neg
->pkt
->pkt_header
.ph
.code
= PADO_CODE
;
911 * Wait for PADI packet coming from hook.
913 sp
->state
= PPPOE_PRIMED
;
915 case NGM_PPPOE_SERVICE
:
917 * Check the session is primed.
918 * for now just allow ONE service to be advertised.
919 * If you do it twice you just overwrite.
921 if (sp
->state
!= PPPOE_PRIMED
) {
922 log(LOG_NOTICE
, "ng_pppoe[%x]: session not "
923 "primed\n", node
->nd_ID
);
927 neg
->service
.hdr
.tag_type
= PTT_SRV_NAME
;
928 neg
->service
.hdr
.tag_len
=
929 htons((uint16_t)ourmsg
->data_len
);
931 if (ourmsg
->data_len
)
932 bcopy(ourmsg
->data
, neg
->service
.data
,
934 neg
->service_len
= ourmsg
->data_len
;
936 case NGM_PPPOE_SETMODE
:
941 if (msg
->header
.arglen
== 0)
944 s
= (char *)msg
->data
;
945 len
= msg
->header
.arglen
- 1;
947 /* Search for matching mode string. */
948 if (len
== strlen(NG_PPPOE_STANDARD
) &&
949 (strncmp(NG_PPPOE_STANDARD
, s
, len
) == 0)) {
951 privp
->eh
.ether_type
= ETHERTYPE_PPPOE_DISC
;
954 if (len
== strlen(NG_PPPOE_3COM
) &&
955 (strncmp(NG_PPPOE_3COM
, s
, len
) == 0)) {
956 privp
->flags
|= COMPAT_3COM
;
957 privp
->eh
.ether_type
=
958 ETHERTYPE_PPPOE_3COM_DISC
;
961 if (len
== strlen(NG_PPPOE_DLINK
) &&
962 (strncmp(NG_PPPOE_DLINK
, s
, len
) == 0)) {
963 privp
->flags
|= COMPAT_DLINK
;
969 case NGM_PPPOE_GETMODE
:
974 if (privp
->flags
== 0)
975 len
+= strlen(NG_PPPOE_STANDARD
) + 1;
976 if (privp
->flags
& COMPAT_3COM
)
977 len
+= strlen(NG_PPPOE_3COM
) + 1;
978 if (privp
->flags
& COMPAT_DLINK
)
979 len
+= strlen(NG_PPPOE_DLINK
) + 1;
981 NG_MKRESPONSE(resp
, msg
, len
, M_WAITOK
| M_NULLOK
);
985 s
= (char *)resp
->data
;
986 if (privp
->flags
== 0) {
987 len
= strlen(NG_PPPOE_STANDARD
);
988 strlcpy(s
, NG_PPPOE_STANDARD
, len
+ 1);
991 if (privp
->flags
& COMPAT_3COM
) {
992 len
= strlen(NG_PPPOE_3COM
);
993 strlcpy(s
, NG_PPPOE_3COM
, len
+ 1);
996 if (privp
->flags
& COMPAT_DLINK
) {
999 len
= strlen(NG_PPPOE_DLINK
);
1000 strlcpy(s
, NG_PPPOE_DLINK
, len
+ 1);
1004 case NGM_PPPOE_SETENADDR
:
1005 if (msg
->header
.arglen
!= ETHER_ADDR_LEN
)
1007 bcopy(msg
->data
, &privp
->eh
.ether_shost
,
1014 case NGM_ETHER_COOKIE
:
1015 if (!(msg
->header
.flags
& NGF_RESP
))
1017 switch (msg
->header
.cmd
) {
1018 case NGM_ETHER_GET_ENADDR
:
1019 if (msg
->header
.arglen
!= ETHER_ADDR_LEN
)
1021 bcopy(msg
->data
, &privp
->eh
.ether_shost
,
1032 /* Take care of synchronous response, if any. */
1034 CTR2(KTR_NET
, "%20s: returning %d", __func__
, error
);
1035 NG_RESPOND_MSG(error
, node
, item
, resp
);
1036 /* Free the message and return. */
1042 * Start a client into the first state. A separate function because
1043 * it can be needed if the negotiation times out.
1046 pppoe_start(sessp sp
)
1048 hook_p hook
= sp
->hook
;
1049 node_p node
= NG_HOOK_NODE(hook
);
1050 priv_p privp
= NG_NODE_PRIVATE(node
);
1053 struct pppoe_tag hdr
;
1060 * Kick the state machine into starting up.
1062 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1063 sp
->state
= PPPOE_SINIT
;
1065 * Reset the packet header to broadcast. Since we are
1066 * in a client mode use configured ethertype.
1068 memcpy((void *)&neg
->pkt
->pkt_header
.eh
, &privp
->eh
,
1069 sizeof(struct ether_header
));
1070 neg
->pkt
->pkt_header
.ph
.code
= PADI_CODE
;
1071 uniqtag
.hdr
.tag_type
= PTT_HOST_UNIQ
;
1072 uniqtag
.hdr
.tag_len
= htons((u_int16_t
)sizeof(uniqtag
.data
));
1073 uniqtag
.data
.pointer
= sp
;
1075 insert_tag(sp
, &uniqtag
.hdr
);
1076 insert_tag(sp
, &neg
->service
.hdr
);
1079 * Send packet and prepare to retransmit it after timeout.
1081 ng_callout(&neg
->handle
, node
, hook
, PPPOE_INITIAL_TIMEOUT
* hz
,
1082 pppoe_ticker
, NULL
, 0);
1083 neg
->timeout
= PPPOE_INITIAL_TIMEOUT
* 2;
1084 m0
= m_copypacket(neg
->m
, MB_DONTWAIT
);
1085 NG_SEND_DATA_ONLY(error
, privp
->ethernet_hook
, m0
);
1089 send_acname(sessp sp
, const struct pppoe_tag
*tag
)
1092 struct ng_mesg
*msg
;
1093 struct ngpppoe_sts
*sts
;
1095 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1097 NG_MKMESSAGE(msg
, NGM_PPPOE_COOKIE
, NGM_PPPOE_ACNAME
,
1098 sizeof(struct ngpppoe_sts
), M_WAITOK
| M_NULLOK
);
1102 sts
= (struct ngpppoe_sts
*)msg
->data
;
1103 tlen
= min(NG_HOOKSIZ
- 1, ntohs(tag
->tag_len
));
1104 strncpy(sts
->hook
, tag
->tag_data
, tlen
);
1105 sts
->hook
[tlen
] = '\0';
1106 NG_SEND_MSG_ID(error
, NG_HOOK_NODE(sp
->hook
), msg
, sp
->creator
, 0);
1112 send_sessionid(sessp sp
)
1115 struct ng_mesg
*msg
;
1117 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1119 NG_MKMESSAGE(msg
, NGM_PPPOE_COOKIE
, NGM_PPPOE_SESSIONID
,
1120 sizeof(uint16_t), M_WAITOK
| M_NULLOK
);
1124 *(uint16_t *)msg
->data
= sp
->Session_ID
;
1125 NG_SEND_MSG_ID(error
, NG_HOOK_NODE(sp
->hook
), msg
, sp
->creator
, 0);
1131 * Receive data from session hook and do something with it.
1134 ng_pppoe_rcvdata(hook_p hook
, item_p item
)
1136 node_p node
= NG_HOOK_NODE(hook
);
1137 const priv_p privp
= NG_NODE_PRIVATE(node
);
1138 sessp sp
= NG_HOOK_PRIVATE(hook
);
1139 struct pppoe_full_hdr
*wh
;
1143 CTR6(KTR_NET
, "%20s: node [%x] (%p) received %p on \"%s\" (%p)",
1144 __func__
, node
->nd_ID
, node
, item
, hook
->hk_name
, hook
);
1147 switch (sp
->state
) {
1148 case PPPOE_NEWCONNECTED
:
1149 case PPPOE_CONNECTED
: {
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.
1156 if (m
->m_pkthdr
.len
>= 2) {
1157 if (m
->m_len
< 2 && !(m
= m_pullup(m
, 2)))
1159 if (mtod(m
, u_char
*)[0] == 0xff &&
1160 mtod(m
, u_char
*)[1] == 0x03)
1164 * Bang in a pre-made header, and set the length up
1165 * to be correct. Then send it to the ethernet driver.
1167 M_PREPEND(m
, sizeof(*wh
), MB_DONTWAIT
);
1171 wh
= mtod(m
, struct pppoe_full_hdr
*);
1172 bcopy(&sp
->pkt_hdr
, wh
, sizeof(*wh
));
1173 wh
->ph
.length
= htons(m
->m_pkthdr
.len
- sizeof(*wh
));
1174 NG_FWD_NEW_DATA(error
, item
, privp
->ethernet_hook
, m
);
1175 privp
->packets_out
++;
1178 case PPPOE_PRIMED
: {
1180 struct pppoe_tag hdr
;
1183 const struct pppoe_tag
*tag
;
1185 const struct pppoe_hdr
*ph
;
1192 * A PADI packet is being returned by the application
1193 * that has set up this hook. This indicates that it
1194 * wants us to offer service.
1196 if (m
->m_len
< sizeof(*wh
)) {
1197 m
= m_pullup(m
, sizeof(*wh
));
1201 wh
= mtod(m
, struct pppoe_full_hdr
*);
1203 session
= ntohs(wh
->ph
.sid
);
1204 length
= ntohs(wh
->ph
.length
);
1206 /* Use peers mode in session. */
1207 neg
->pkt
->pkt_header
.eh
.ether_type
= wh
->eh
.ether_type
;
1208 if (code
!= PADI_CODE
)
1210 ng_uncallout(&neg
->handle
, node
);
1213 * This is the first time we hear
1214 * from the client, so note it's
1215 * unicast address, replacing the
1216 * broadcast address.
1218 bcopy(wh
->eh
.ether_shost
,
1219 neg
->pkt
->pkt_header
.eh
.ether_dhost
,
1221 sp
->state
= PPPOE_SOFFER
;
1223 neg
->pkt
->pkt_header
.ph
.code
= PADO_CODE
;
1226 * Start working out the tags to respond with.
1228 uniqtag
.hdr
.tag_type
= PTT_AC_COOKIE
;
1229 uniqtag
.hdr
.tag_len
= htons((u_int16_t
)sizeof(sp
));
1230 uniqtag
.data
.pointer
= sp
;
1232 insert_tag(sp
, &neg
->ac_name
.hdr
); /* AC_NAME */
1233 if ((tag
= get_tag(ph
, PTT_SRV_NAME
)))
1234 insert_tag(sp
, tag
); /* return service */
1236 * If we have a NULL service request
1237 * and have an extra service defined in this hook,
1238 * then also add a tag for the extra service.
1239 * XXX this is a hack. eventually we should be able
1240 * to support advertising many services, not just one
1242 if (((tag
== NULL
) || (tag
->tag_len
== 0)) &&
1243 (neg
->service
.hdr
.tag_len
!= 0)) {
1244 insert_tag(sp
, &neg
->service
.hdr
); /* SERVICE */
1246 if ((tag
= get_tag(ph
, PTT_HOST_UNIQ
)))
1247 insert_tag(sp
, tag
); /* returned hostunique */
1248 insert_tag(sp
, &uniqtag
.hdr
);
1252 * Send the offer but if they don't respond
1253 * in PPPOE_OFFER_TIMEOUT seconds, forget about it.
1255 ng_callout(&neg
->handle
, node
, hook
, PPPOE_OFFER_TIMEOUT
* hz
,
1256 pppoe_ticker
, NULL
, 0);
1257 m0
= m_copypacket(sp
->neg
->m
, MB_DONTWAIT
);
1258 NG_FWD_NEW_DATA(error
, item
, privp
->ethernet_hook
, m0
);
1259 privp
->packets_out
++;
1264 * Packets coming from the hook make no sense
1265 * to sessions in the rest of states. Throw them away.
1278 * Receive data from ether and do something with it.
1281 ng_pppoe_rcvdata_ether(hook_p hook
, item_p item
)
1283 node_p node
= NG_HOOK_NODE(hook
);
1284 const priv_p privp
= NG_NODE_PRIVATE(node
);
1285 sessp sp
= NG_HOOK_PRIVATE(hook
);
1286 const struct pppoe_tag
*utag
= NULL
, *tag
= NULL
;
1287 const struct pppoe_full_hdr
*wh
;
1288 const struct pppoe_hdr
*ph
;
1298 CTR6(KTR_NET
, "%20s: node [%x] (%p) received %p on \"%s\" (%p)",
1299 __func__
, node
->nd_ID
, node
, item
, hook
->hk_name
, hook
);
1303 * Dig out various fields from the packet.
1304 * Use them to decide where to send it.
1306 privp
->packets_in
++;
1307 if( m
->m_len
< sizeof(*wh
)) {
1308 m
= m_pullup(m
, sizeof(*wh
)); /* Checks length */
1310 log(LOG_NOTICE
, "ng_pppoe[%x]: couldn't "
1311 "m_pullup(wh)\n", node
->nd_ID
);
1315 wh
= mtod(m
, struct pppoe_full_hdr
*);
1316 length
= ntohs(wh
->ph
.length
);
1317 switch(wh
->eh
.ether_type
) {
1318 case ETHERTYPE_PPPOE_3COM_DISC
: /* fall through */
1319 case ETHERTYPE_PPPOE_DISC
:
1321 * We need to try to make sure that the tag area
1322 * is contiguous, or we could wander off the end
1323 * of a buffer and make a mess.
1324 * (Linux wouldn't have this problem).
1326 if (m
->m_pkthdr
.len
<= MHLEN
) {
1327 if( m
->m_len
< m
->m_pkthdr
.len
) {
1328 m
= m_pullup(m
, m
->m_pkthdr
.len
);
1330 log(LOG_NOTICE
, "ng_pppoe[%x]: "
1331 "couldn't m_pullup(pkthdr)\n",
1337 if (m
->m_len
!= m
->m_pkthdr
.len
) {
1339 * It's not all in one piece.
1340 * We need to do extra work.
1341 * Put it into a cluster.
1344 n
= m_dup(m
, MB_DONTWAIT
);
1348 /* just check we got a cluster */
1349 if (m
->m_len
!= m
->m_pkthdr
.len
) {
1355 log(LOG_NOTICE
, "ng_pppoe[%x]: packet "
1356 "fragmented\n", node
->nd_ID
);
1360 wh
= mtod(m
, struct pppoe_full_hdr
*);
1361 length
= ntohs(wh
->ph
.length
);
1363 session
= ntohs(wh
->ph
.sid
);
1370 * Look for a hook with the required service and send
1371 * the ENTIRE packet up there. It should come back to
1372 * a new hook in PRIMED state. Look there for further
1375 tag
= get_tag(ph
, PTT_SRV_NAME
);
1377 CTR1(KTR_NET
, "%20s: PADI w/o Service-Name",
1383 * First, try to match Service-Name against our
1384 * listening hooks. If no success and we are in D-Link
1385 * compat mode and Service-Name is empty, then we
1386 * broadcast the PADI to all listening hooks.
1388 sendhook
= pppoe_match_svc(node
, tag
);
1389 if (sendhook
!= NULL
)
1390 NG_FWD_NEW_DATA(error
, item
, sendhook
, m
);
1391 else if (privp
->flags
& COMPAT_DLINK
&&
1392 ntohs(tag
->tag_len
) == 0)
1393 error
= pppoe_broadcast_padi(node
, m
);
1395 error
= ENETUNREACH
;
1400 * Use the host_uniq tag to find the hook this is in
1401 * response to. Received #2, now send #3
1402 * For now simply accept the first we receive.
1404 utag
= get_tag(ph
, PTT_HOST_UNIQ
);
1405 if ((utag
== NULL
) ||
1406 (ntohs(utag
->tag_len
) != sizeof(sp
))) {
1407 log(LOG_NOTICE
, "ng_pppoe[%x]: no host "
1408 "unique field\n", node
->nd_ID
);
1412 sendhook
= pppoe_finduniq(node
, utag
);
1413 if (sendhook
== NULL
) {
1414 log(LOG_NOTICE
, "ng_pppoe[%x]: no "
1415 "matching session\n", node
->nd_ID
);
1420 * Check the session is in the right state.
1421 * It needs to be in PPPOE_SINIT.
1423 sp
= NG_HOOK_PRIVATE(sendhook
);
1424 if (sp
->state
== PPPOE_SREQ
||
1425 sp
->state
== PPPOE_CONNECTED
) {
1426 break; /* Multiple PADO is OK. */
1428 if (sp
->state
!= PPPOE_SINIT
) {
1429 log(LOG_NOTICE
, "ng_pppoe[%x]: session "
1430 "in wrong state\n", node
->nd_ID
);
1434 /* If requested specific AC-name, check it. */
1435 if (neg
->ac_name_len
) {
1436 tag
= get_tag(ph
, PTT_AC_NAME
);
1438 /* No PTT_AC_NAME in PADO */
1441 if (neg
->ac_name_len
!= htons(tag
->tag_len
) ||
1442 strncmp(neg
->ac_name
.data
, tag
->tag_data
,
1443 neg
->ac_name_len
) != 0) {
1447 sp
->state
= PPPOE_SREQ
;
1448 ng_uncallout(&neg
->handle
, node
);
1451 * This is the first time we hear
1452 * from the server, so note it's
1453 * unicast address, replacing the
1454 * broadcast address .
1456 bcopy(wh
->eh
.ether_shost
,
1457 neg
->pkt
->pkt_header
.eh
.ether_dhost
,
1460 neg
->pkt
->pkt_header
.ph
.code
= PADR_CODE
;
1462 insert_tag(sp
, utag
); /* Host Unique */
1463 if ((tag
= get_tag(ph
, PTT_AC_COOKIE
)))
1464 insert_tag(sp
, tag
); /* return cookie */
1465 if ((tag
= get_tag(ph
, PTT_AC_NAME
))) {
1466 insert_tag(sp
, tag
); /* return it */
1467 send_acname(sp
, tag
);
1469 insert_tag(sp
, &neg
->service
.hdr
); /* Service */
1472 sp
->state
= PPPOE_SREQ
;
1473 ng_callout(&neg
->handle
, node
, sp
->hook
,
1474 PPPOE_INITIAL_TIMEOUT
* hz
,
1475 pppoe_ticker
, NULL
, 0);
1476 neg
->timeout
= PPPOE_INITIAL_TIMEOUT
* 2;
1477 m0
= m_copypacket(neg
->m
, MB_DONTWAIT
);
1478 NG_FWD_NEW_DATA(error
, item
, privp
->ethernet_hook
, m0
);
1483 * Use the ac_cookie tag to find the
1484 * hook this is in response to.
1486 utag
= get_tag(ph
, PTT_AC_COOKIE
);
1487 if ((utag
== NULL
) ||
1488 (ntohs(utag
->tag_len
) != sizeof(sp
))) {
1492 sendhook
= pppoe_finduniq(node
, utag
);
1493 if (sendhook
== NULL
)
1497 * Check the session is in the right state.
1498 * It needs to be in PPPOE_SOFFER or PPPOE_NEWCONNECTED.
1499 * If the latter, then this is a retry by the client,
1500 * so be nice, and resend.
1502 sp
= NG_HOOK_PRIVATE(sendhook
);
1503 if (sp
->state
== PPPOE_NEWCONNECTED
) {
1505 * Whoa! drop back to resend that PADS packet.
1506 * We should still have a copy of it.
1508 sp
->state
= PPPOE_SOFFER
;
1509 } else if (sp
->state
!= PPPOE_SOFFER
)
1510 LEAVE (ENETUNREACH
);
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(pppoe_getnewsession(sp
));
1521 * start working out the tags to respond with.
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 */
1532 sp
->state
= PPPOE_NEWCONNECTED
;
1534 /* Send the PADS without a timeout - we're now connected. */
1535 m0
= m_copypacket(sp
->neg
->m
, MB_DONTWAIT
);
1536 NG_FWD_NEW_DATA(error
, item
, privp
->ethernet_hook
, m0
);
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
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
;
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
);
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.
1567 utag
= get_tag(ph
, PTT_HOST_UNIQ
);
1568 if ((utag
== NULL
) ||
1569 (ntohs(utag
->tag_len
) != sizeof(sp
))) {
1570 LEAVE (ENETUNREACH
);
1572 sendhook
= pppoe_finduniq(node
, utag
);
1573 if (sendhook
== NULL
)
1577 * Check the session is in the right state.
1578 * It needs to be in PPPOE_SREQ.
1580 sp
= NG_HOOK_PRIVATE(sendhook
);
1581 if (sp
->state
!= PPPOE_SREQ
)
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 pppoe_addsession(sp
);
1590 sp
->state
= PPPOE_CONNECTED
;
1592 * Now we have gone to Connected mode,
1593 * Free all resources needed for negotiation.
1594 * Keep a copy of the header we will be using.
1596 sp
->pkt_hdr
= neg
->pkt
->pkt_header
;
1597 if (privp
->flags
& COMPAT_3COM
)
1598 sp
->pkt_hdr
.eh
.ether_type
1599 = ETHERTYPE_PPPOE_3COM_SESS
;
1601 sp
->pkt_hdr
.eh
.ether_type
1602 = ETHERTYPE_PPPOE_SESS
;
1603 sp
->pkt_hdr
.ph
.code
= 0;
1605 kfree(sp
->neg
, M_NETGRAPH_PPPOE
);
1607 pppoe_send_event(sp
, NGM_PPPOE_SUCCESS
);
1611 * Find matching peer/session combination.
1613 sp
= pppoe_findsession(privp
, wh
);
1616 /* Disconnect that hook. */
1617 ng_rmhook_self(sp
->hook
);
1620 LEAVE(EPFNOSUPPORT
);
1623 case ETHERTYPE_PPPOE_3COM_SESS
:
1624 case ETHERTYPE_PPPOE_SESS
:
1626 * Find matching peer/session combination.
1628 sp
= pppoe_findsession(privp
, wh
);
1630 LEAVE (ENETUNREACH
);
1631 m_adj(m
, sizeof(*wh
));
1633 /* If packet too short, dump it. */
1634 if (m
->m_pkthdr
.len
< length
)
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
)));
1640 if ( sp
->state
!= PPPOE_CONNECTED
) {
1641 if (sp
->state
== PPPOE_NEWCONNECTED
) {
1642 sp
->state
= PPPOE_CONNECTED
;
1644 * Now we have gone to Connected mode,
1645 * Free all resources needed for negotiation.
1646 * Be paranoid about whether there may be
1649 m_freem(sp
->neg
->m
);
1650 ng_uncallout(&sp
->neg
->handle
, node
);
1651 kfree(sp
->neg
, M_NETGRAPH_PPPOE
);
1654 LEAVE (ENETUNREACH
);
1657 NG_FWD_NEW_DATA(error
, item
, sp
->hook
, m
);
1660 LEAVE(EPFNOSUPPORT
);
1670 * Receive data from debug hook and bypass it to ether.
1673 ng_pppoe_rcvdata_debug(hook_p hook
, item_p item
)
1675 node_p node
= NG_HOOK_NODE(hook
);
1676 const priv_p privp
= NG_NODE_PRIVATE(node
);
1679 CTR6(KTR_NET
, "%20s: node [%x] (%p) received %p on \"%s\" (%p)",
1680 __func__
, node
->nd_ID
, node
, item
, hook
->hk_name
, hook
);
1682 NG_FWD_ITEM_HOOK(error
, item
, privp
->ethernet_hook
);
1683 privp
->packets_out
++;
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.
1693 ng_pppoe_shutdown(node_p node
)
1695 const priv_p privp
= NG_NODE_PRIVATE(node
);
1698 for (i
= 0; i
< SESSHASHSIZE
; i
++)
1699 mtx_destroy(&privp
->sesshash
[i
].mtx
);
1700 NG_NODE_SET_PRIVATE(node
, NULL
);
1701 NG_NODE_UNREF(privp
->node
);
1702 kfree(privp
, M_NETGRAPH_PPPOE
);
1707 * Hook disconnection
1709 * Clean up all dangling links and information about the session/hook.
1710 * For this type, removal of the last link destroys the node.
1713 ng_pppoe_disconnect(hook_p hook
)
1715 node_p node
= NG_HOOK_NODE(hook
);
1716 priv_p privp
= NG_NODE_PRIVATE(node
);
1719 if (hook
== privp
->debug_hook
) {
1720 privp
->debug_hook
= NULL
;
1721 } else if (hook
== privp
->ethernet_hook
) {
1722 privp
->ethernet_hook
= NULL
;
1723 if (NG_NODE_IS_VALID(node
))
1724 ng_rmnode_self(node
);
1726 sp
= NG_HOOK_PRIVATE(hook
);
1727 if (sp
->state
!= PPPOE_SNONE
) {
1728 pppoe_send_event(sp
, NGM_PPPOE_CLOSE
);
1731 * According to the spec, if we are connected,
1732 * we should send a DISC packet if we are shutting down
1735 if ((privp
->ethernet_hook
)
1736 && ((sp
->state
== PPPOE_CONNECTED
)
1737 || (sp
->state
== PPPOE_NEWCONNECTED
))) {
1740 /* Generate a packet of that type. */
1741 MGETHDR(m
, MB_DONTWAIT
, MT_DATA
);
1743 log(LOG_NOTICE
, "ng_pppoe[%x]: session out of "
1744 "mbufs\n", node
->nd_ID
);
1746 struct pppoe_full_hdr
*wh
;
1747 struct pppoe_tag
*tag
;
1748 int msglen
= strlen(SIGNOFF
);
1751 m
->m_pkthdr
.rcvif
= NULL
;
1752 m
->m_pkthdr
.len
= m
->m_len
= sizeof(*wh
);
1753 wh
= mtod(m
, struct pppoe_full_hdr
*);
1754 bcopy(&sp
->pkt_hdr
, wh
, sizeof(*wh
));
1756 /* Revert the stored header to DISC/PADT mode. */
1757 wh
->ph
.code
= PADT_CODE
;
1759 * Configure ethertype depending on what
1760 * was used during sessions stage.
1762 if (wh
->eh
.ether_type
==
1763 ETHERTYPE_PPPOE_3COM_SESS
)
1764 wh
->eh
.ether_type
= ETHERTYPE_PPPOE_3COM_DISC
;
1766 wh
->eh
.ether_type
= ETHERTYPE_PPPOE_DISC
;
1768 * Add a General error message and adjust
1772 tag
->tag_type
= PTT_GEN_ERR
;
1773 tag
->tag_len
= htons((u_int16_t
)msglen
);
1774 strncpy(tag
->tag_data
, SIGNOFF
, msglen
);
1775 m
->m_pkthdr
.len
= (m
->m_len
+= sizeof(*tag
) +
1777 wh
->ph
.length
= htons(sizeof(*tag
) + msglen
);
1778 NG_SEND_DATA_ONLY(error
,
1779 privp
->ethernet_hook
, m
);
1782 if (sp
->state
== PPPOE_LISTENING
)
1783 LIST_REMOVE(sp
, sessions
);
1784 else if (sp
->Session_ID
)
1785 pppoe_delsession(sp
);
1787 * As long as we have somewhere to store the timeout handle,
1788 * we may have a timeout pending.. get rid of it.
1791 ng_uncallout(&sp
->neg
->handle
, node
);
1793 m_freem(sp
->neg
->m
);
1794 kfree(sp
->neg
, M_NETGRAPH_PPPOE
);
1796 kfree(sp
, M_NETGRAPH_PPPOE
);
1797 NG_HOOK_SET_PRIVATE(hook
, NULL
);
1799 if ((NG_NODE_NUMHOOKS(node
) == 0) &&
1800 (NG_NODE_IS_VALID(node
)))
1801 ng_rmnode_self(node
);
1806 * Timeouts come here.
1809 pppoe_ticker(node_p node
, hook_p hook
, void *arg1
, int arg2
)
1811 priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(hook
));
1812 sessp sp
= NG_HOOK_PRIVATE(hook
);
1814 struct mbuf
*m0
= NULL
;
1817 CTR6(KTR_NET
, "%20s: node [%x] (%p) hook \"%s\" (%p) session %d",
1818 __func__
, node
->nd_ID
, node
, hook
->hk_name
, hook
, sp
->Session_ID
);
1821 * Resend the last packet, using an exponential backoff.
1822 * After a period of time, stop growing the backoff,
1823 * And either leave it, or revert to the start.
1827 /* Timeouts on these produce resends. */
1828 m0
= m_copypacket(sp
->neg
->m
, MB_DONTWAIT
);
1829 NG_SEND_DATA_ONLY( error
, privp
->ethernet_hook
, m0
);
1830 ng_callout(&neg
->handle
, node
, hook
, neg
->timeout
* hz
,
1831 pppoe_ticker
, NULL
, 0);
1832 if ((neg
->timeout
<<= 1) > PPPOE_TIMEOUT_LIMIT
) {
1833 if (sp
->state
== PPPOE_SREQ
) {
1834 /* Revert to SINIT mode. */
1837 neg
->timeout
= PPPOE_TIMEOUT_LIMIT
;
1843 /* A timeout on these says "give up" */
1844 ng_rmhook_self(hook
);
1847 /* Timeouts have no meaning in other states. */
1848 log(LOG_NOTICE
, "ng_pppoe[%x]: unexpected timeout\n",
1854 * Parse an incoming packet to see if any tags should be copied to the
1855 * output packet. Don't do any tags that have been handled in the main
1858 static const struct pppoe_tag
*
1859 scan_tags(sessp sp
, const struct pppoe_hdr
* ph
)
1861 const char *const end
= (const char *)next_tag(ph
);
1863 const struct pppoe_tag
*pt
= &ph
->tag
[0];
1866 * Keep processing tags while a tag header will still fit.
1868 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1870 while((const char*)(pt
+ 1) <= end
) {
1872 * If the tag data would go past the end of the packet, abort.
1874 ptn
= (((const char *)(pt
+ 1)) + ntohs(pt
->tag_len
));
1878 switch (pt
->tag_type
) {
1894 pt
= (const struct pppoe_tag
*)ptn
;
1900 pppoe_send_event(sessp sp
, enum cmd cmdid
)
1903 struct ng_mesg
*msg
;
1904 struct ngpppoe_sts
*sts
;
1906 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1908 NG_MKMESSAGE(msg
, NGM_PPPOE_COOKIE
, cmdid
,
1909 sizeof(struct ngpppoe_sts
), M_WAITOK
| M_NULLOK
);
1912 sts
= (struct ngpppoe_sts
*)msg
->data
;
1913 strncpy(sts
->hook
, NG_HOOK_NAME(sp
->hook
), NG_HOOKSIZ
);
1914 NG_SEND_MSG_ID(error
, NG_HOOK_NODE(sp
->hook
), msg
, sp
->creator
, 0);