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 * $Whistle: ng_pppoe.c,v 1.10 1999/11/01 09:24:52 julian Exp $
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/kernel.h>
49 #include <sys/malloc.h>
50 #include <sys/errno.h>
51 #include <sys/syslog.h>
52 #include <net/ethernet.h>
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>
60 #ifdef NG_SEPARATE_MALLOC
61 MALLOC_DEFINE(M_NETGRAPH_PPPOE
, "netgraph_pppoe", "netgraph pppoe node");
63 #define M_NETGRAPH_PPPOE M_NETGRAPH
66 #define SIGNOFF "session closed"
69 * This section contains the netgraph method declarations for the
70 * pppoe node. These methods define the netgraph pppoe 'type'.
73 static ng_constructor_t ng_pppoe_constructor
;
74 static ng_rcvmsg_t ng_pppoe_rcvmsg
;
75 static ng_shutdown_t ng_pppoe_shutdown
;
76 static ng_newhook_t ng_pppoe_newhook
;
77 static ng_connect_t ng_pppoe_connect
;
78 static ng_rcvdata_t ng_pppoe_rcvdata
;
79 static ng_rcvdata_t ng_pppoe_rcvdata_ether
;
80 static ng_rcvdata_t ng_pppoe_rcvdata_debug
;
81 static ng_disconnect_t ng_pppoe_disconnect
;
83 /* Parse type for struct ngpppoe_init_data */
84 static const struct ng_parse_struct_field ngpppoe_init_data_type_fields
[]
85 = NG_PPPOE_INIT_DATA_TYPE_INFO
;
86 static const struct ng_parse_type ngpppoe_init_data_state_type
= {
87 &ng_parse_struct_type
,
88 &ngpppoe_init_data_type_fields
91 /* Parse type for struct ngpppoe_sts */
92 static const struct ng_parse_struct_field ng_pppoe_sts_type_fields
[]
93 = NG_PPPOE_STS_TYPE_INFO
;
94 static const struct ng_parse_type ng_pppoe_sts_state_type
= {
95 &ng_parse_struct_type
,
96 &ng_pppoe_sts_type_fields
99 /* List of commands and how to convert arguments to/from ASCII */
100 static const struct ng_cmdlist ng_pppoe_cmds
[] = {
105 &ngpppoe_init_data_state_type
,
112 &ngpppoe_init_data_state_type
,
119 &ngpppoe_init_data_state_type
,
126 &ngpppoe_init_data_state_type
,
133 &ng_pppoe_sts_state_type
,
140 &ng_pppoe_sts_state_type
,
147 &ng_pppoe_sts_state_type
,
154 &ng_parse_string_type
,
162 &ng_parse_string_type
168 &ng_parse_enaddr_type
,
174 /* Netgraph node type descriptor */
175 static struct ng_type typestruct
= {
176 .version
= NG_ABI_VERSION
,
177 .name
= NG_PPPOE_NODE_TYPE
,
178 .constructor
= ng_pppoe_constructor
,
179 .rcvmsg
= ng_pppoe_rcvmsg
,
180 .shutdown
= ng_pppoe_shutdown
,
181 .newhook
= ng_pppoe_newhook
,
182 .connect
= ng_pppoe_connect
,
183 .rcvdata
= ng_pppoe_rcvdata
,
184 .disconnect
= ng_pppoe_disconnect
,
185 .cmdlist
= ng_pppoe_cmds
,
187 NETGRAPH_INIT(pppoe
, &typestruct
);
190 * States for the session state machine.
191 * These have no meaning if there is no hook attached yet.
194 PPPOE_SNONE
=0, /* [both] Initial state */
195 PPPOE_LISTENING
, /* [Daemon] Listening for discover initiation pkt */
196 PPPOE_SINIT
, /* [Client] Sent discovery initiation */
197 PPPOE_PRIMED
, /* [Server] Awaiting PADI from daemon */
198 PPPOE_SOFFER
, /* [Server] Sent offer message (got PADI)*/
199 PPPOE_SREQ
, /* [Client] Sent a Request */
200 PPPOE_NEWCONNECTED
, /* [Server] Connection established, No data received */
201 PPPOE_CONNECTED
, /* [Both] Connection established, Data received */
202 PPPOE_DEAD
/* [Both] */
205 #define NUMTAGS 20 /* number of tags we are set up to work with */
208 * Information we store for each hook on each node for negotiating the
209 * session. The mbuf and cluster are freed once negotiation has completed.
210 * The whole negotiation block is then discarded.
214 struct mbuf
*m
; /* holds cluster with last sent packet */
215 union packet
*pkt
; /* points within the above cluster */
216 struct callout handle
; /* see timeout(9) */
217 u_int timeout
; /* 0,1,2,4,8,16 etc. seconds */
219 const struct pppoe_tag
*tags
[NUMTAGS
];
223 struct datatag service
;
224 struct datatag ac_name
;
226 typedef struct sess_neg
*negp
;
229 * Session information that is needed after connection.
235 ng_ID_t creator
; /* who to notify */
236 struct pppoe_full_hdr pkt_hdr
; /* used when connected */
237 negp neg
; /* used when negotiating */
238 LIST_ENTRY(sess_con
) sessions
;
240 typedef struct sess_con
*sessp
;
242 #define SESSHASHSIZE 0x0100
243 #define SESSHASH(x) (((x) ^ ((x) >> 8)) & (SESSHASHSIZE - 1))
245 struct sess_hash_entry
{
247 LIST_HEAD(hhead
, sess_con
) head
;
251 * Information we store for each node
254 node_p node
; /* back pointer to node */
255 hook_p ethernet_hook
;
257 u_int packets_in
; /* packets in from ethernet */
258 u_int packets_out
; /* packets out towards ethernet */
260 #define COMPAT_3COM 0x00000001
261 #define COMPAT_DLINK 0x00000002
262 struct ether_header eh
;
263 LIST_HEAD(, sess_con
) listeners
;
264 struct sess_hash_entry sesshash
[SESSHASHSIZE
];
266 typedef struct PPPoE
*priv_p
;
269 char bytes
[sizeof(void *)];
273 #define LEAVE(x) do { error = x; goto quit; } while(0)
274 static void pppoe_start(sessp sp
);
275 static void pppoe_ticker(node_p node
, hook_p hook
, void *arg1
, int arg2
);
276 static const struct pppoe_tag
*scan_tags(sessp sp
,
277 const struct pppoe_hdr
* ph
);
278 static int pppoe_send_event(sessp sp
, enum cmd cmdid
);
280 /*************************************************************************
281 * Some basic utilities from the Linux version with author's permission.*
282 * Author: Michal Ostrowski <mostrows@styx.uwaterloo.ca> *
283 ************************************************************************/
288 * Return the location where the next tag can be put
290 static __inline
const struct pppoe_tag
*
291 next_tag(const struct pppoe_hdr
* ph
)
293 return (const struct pppoe_tag
*)(((const char*)&ph
->tag
[0])
294 + ntohs(ph
->length
));
298 * Look for a tag of a specific type.
299 * Don't trust any length the other end says,
300 * but assume we already sanity checked ph->length.
302 static const struct pppoe_tag
*
303 get_tag(const struct pppoe_hdr
* ph
, uint16_t idx
)
305 const char *const end
= (const char *)next_tag(ph
);
306 const struct pppoe_tag
*pt
= &ph
->tag
[0];
310 * Keep processing tags while a tag header will still fit.
312 while((const char*)(pt
+ 1) <= end
) {
314 * If the tag data would go past the end of the packet, abort.
316 ptn
= (((const char *)(pt
+ 1)) + ntohs(pt
->tag_len
));
318 CTR2(KTR_NET
, "%20s: invalid length for tag %d",
322 if (pt
->tag_type
== idx
) {
323 CTR2(KTR_NET
, "%20s: found tag %d", __func__
, idx
);
327 pt
= (const struct pppoe_tag
*)ptn
;
330 CTR2(KTR_NET
, "%20s: not found tag %d", __func__
, idx
);
334 /**************************************************************************
335 * Inlines to initialise or add tags to a session's tag list.
336 **************************************************************************/
338 * Initialise the session's tag list.
343 KASSERT(sp
->neg
!= NULL
, ("%s: no neg", __func__
));
344 sp
->neg
->numtags
= 0;
348 insert_tag(sessp sp
, const struct pppoe_tag
*tp
)
353 KASSERT(neg
!= NULL
, ("%s: no neg", __func__
));
354 if ((i
= neg
->numtags
++) < NUMTAGS
) {
357 log(LOG_NOTICE
, "ng_pppoe: asked to add too many tags to "
364 * Make up a packet, using the tags filled out for the session.
366 * Assume that the actual pppoe header and ethernet header
367 * are filled out externally to this routine.
368 * Also assume that neg->wh points to the correct
369 * location at the front of the buffer space.
372 make_packet(sessp sp
) {
373 struct pppoe_full_hdr
*wh
= &sp
->neg
->pkt
->pkt_header
;
374 const struct pppoe_tag
**tag
;
380 KASSERT((sp
->neg
!= NULL
) && (sp
->neg
->m
!= NULL
),
381 ("%s: called from wrong state", __func__
));
382 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
384 dp
= (char *)wh
->ph
.tag
;
385 for (count
= 0, tag
= sp
->neg
->tags
;
386 ((count
< sp
->neg
->numtags
) && (count
< NUMTAGS
));
388 tlen
= ntohs((*tag
)->tag_len
) + sizeof(**tag
);
389 if ((length
+ tlen
) > (ETHER_MAX_LEN
- 4 - sizeof(*wh
))) {
390 log(LOG_NOTICE
, "ng_pppoe: tags too long\n");
391 sp
->neg
->numtags
= count
;
392 break; /* XXX chop off what's too long */
394 bcopy(*tag
, (char *)dp
, tlen
);
398 wh
->ph
.length
= htons(length
);
399 sp
->neg
->m
->m_len
= length
+ sizeof(*wh
);
400 sp
->neg
->m
->m_pkthdr
.len
= length
+ sizeof(*wh
);
403 /**************************************************************************
404 * Routines to match a service. *
405 **************************************************************************/
408 * Find a hook that has a service string that matches that
409 * we are seeking. For now use a simple string.
410 * In the future we may need something like regexp().
412 * Null string is a wildcard (ANY service), according to RFC2516.
413 * And historical FreeBSD wildcard is also "*".
417 pppoe_match_svc(node_p node
, const struct pppoe_tag
*tag
)
419 const priv_p privp
= NG_NODE_PRIVATE(node
);
422 LIST_FOREACH(sp
, &privp
->listeners
, sessions
) {
425 /* Empty Service-Name matches any service. */
426 if (neg
->service_len
== 0)
429 /* Special case for a blank or "*" service name (wildcard). */
430 if (neg
->service_len
== 1 && neg
->service
.data
[0] == '*')
433 /* If the lengths don't match, that aint it. */
434 if (neg
->service_len
!= ntohs(tag
->tag_len
))
437 if (strncmp(tag
->tag_data
, neg
->service
.data
,
438 ntohs(tag
->tag_len
)) == 0)
441 CTR3(KTR_NET
, "%20s: matched %p for %s", __func__
,
442 sp
?sp
->hook
:NULL
, tag
->tag_data
);
444 return (sp
?sp
->hook
:NULL
);
448 * Broadcast the PADI packet in m0 to all listening hooks.
449 * This routine is called when a PADI with empty Service-Name
450 * tag is received. Client should receive PADOs with all
451 * available services.
454 pppoe_broadcast_padi(node_p node
, struct mbuf
*m0
)
456 const priv_p privp
= NG_NODE_PRIVATE(node
);
460 LIST_FOREACH(sp
, &privp
->listeners
, sessions
) {
463 m
= m_dup(m0
, M_DONTWAIT
);
466 NG_SEND_DATA_ONLY(error
, sp
->hook
, m
);
475 * Find a hook, which name equals to given service.
478 pppoe_find_svc(node_p node
, const char *svc_name
, int svc_len
)
480 const priv_p privp
= NG_NODE_PRIVATE(node
);
483 LIST_FOREACH(sp
, &privp
->listeners
, sessions
) {
486 if (neg
->service_len
== svc_len
&&
487 strncmp(svc_name
, neg
->service
.data
, svc_len
) == 0)
494 /**************************************************************************
495 * Routines to find a particular session that matches an incoming packet. *
496 **************************************************************************/
497 /* Find free session and add to hash. */
499 pppoe_getnewsession(sessp sp
)
501 const priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(sp
->hook
));
502 static uint16_t pppoe_sid
= 1;
507 /* Atomicity is not needed here as value will be checked. */
509 /* Spec says 0xFFFF is reserved, also don't use 0x0000. */
510 if (val
== 0xffff || val
== 0x0000)
513 /* Check it isn't already in use. */
514 hash
= SESSHASH(val
);
515 mtx_lock(&privp
->sesshash
[hash
].mtx
);
516 LIST_FOREACH(tsp
, &privp
->sesshash
[hash
].head
, sessions
) {
517 if (tsp
->Session_ID
== val
)
521 sp
->Session_ID
= val
;
522 LIST_INSERT_HEAD(&privp
->sesshash
[hash
].head
, sp
, sessions
);
524 mtx_unlock(&privp
->sesshash
[hash
].mtx
);
528 CTR2(KTR_NET
, "%20s: new sid %d", __func__
, val
);
533 /* Add specified session to hash. */
535 pppoe_addsession(sessp sp
)
537 const priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(sp
->hook
));
538 uint16_t hash
= SESSHASH(sp
->Session_ID
);
540 mtx_lock(&privp
->sesshash
[hash
].mtx
);
541 LIST_INSERT_HEAD(&privp
->sesshash
[hash
].head
, sp
, sessions
);
542 mtx_unlock(&privp
->sesshash
[hash
].mtx
);
545 /* Delete specified session from hash. */
547 pppoe_delsession(sessp sp
)
549 const priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(sp
->hook
));
550 uint16_t hash
= SESSHASH(sp
->Session_ID
);
552 mtx_lock(&privp
->sesshash
[hash
].mtx
);
553 LIST_REMOVE(sp
, sessions
);
554 mtx_unlock(&privp
->sesshash
[hash
].mtx
);
557 /* Find matching peer/session combination. */
559 pppoe_findsession(priv_p privp
, const struct pppoe_full_hdr
*wh
)
561 uint16_t session
= ntohs(wh
->ph
.sid
);
562 uint16_t hash
= SESSHASH(session
);
565 mtx_lock(&privp
->sesshash
[hash
].mtx
);
566 LIST_FOREACH(sp
, &privp
->sesshash
[hash
].head
, sessions
) {
567 if (sp
->Session_ID
== session
&&
568 bcmp(sp
->pkt_hdr
.eh
.ether_dhost
,
569 wh
->eh
.ether_shost
, ETHER_ADDR_LEN
) == 0) {
573 mtx_unlock(&privp
->sesshash
[hash
].mtx
);
574 CTR3(KTR_NET
, "%20s: matched %p for %d", __func__
, sp
?sp
->hook
:NULL
,
581 pppoe_finduniq(node_p node
, const struct pppoe_tag
*tag
)
586 bcopy(tag
->tag_data
, uniq
.bytes
, sizeof(void *));
587 /* Cycle through all known hooks. */
588 LIST_FOREACH(hook
, &node
->nd_hooks
, hk_hooks
) {
589 /* Skip any nonsession hook. */
590 if (NG_HOOK_PRIVATE(hook
) == NULL
)
592 if (uniq
.pointer
== NG_HOOK_PRIVATE(hook
))
595 CTR3(KTR_NET
, "%20s: matched %p for %p", __func__
, hook
, uniq
.pointer
);
600 /**************************************************************************
601 * Start of Netgraph entrypoints. *
602 **************************************************************************/
605 * Allocate the private data structure and link it with node.
608 ng_pppoe_constructor(node_p node
)
613 /* Initialize private descriptor. */
614 privp
= malloc(sizeof(*privp
), M_NETGRAPH_PPPOE
, M_NOWAIT
| M_ZERO
);
618 /* Link structs together; this counts as our one reference to *node. */
619 NG_NODE_SET_PRIVATE(node
, privp
);
622 /* Initialize to standard mode. */
623 memset(&privp
->eh
.ether_dhost
, 0xff, ETHER_ADDR_LEN
);
624 privp
->eh
.ether_type
= ETHERTYPE_PPPOE_DISC
;
626 LIST_INIT(&privp
->listeners
);
627 for (i
= 0; i
< SESSHASHSIZE
; i
++) {
628 mtx_init(&privp
->sesshash
[i
].mtx
, "PPPoE hash mutex", NULL
, MTX_DEF
);
629 LIST_INIT(&privp
->sesshash
[i
].head
);
632 CTR3(KTR_NET
, "%20s: created node [%x] (%p)",
633 __func__
, node
->nd_ID
, node
);
639 * Give our ok for a hook to be added...
640 * point the hook's private info to the hook structure.
642 * The following hook names are special:
643 * "ethernet": the hook that should be connected to a NIC.
644 * "debug": copies of data sent out here (when I write the code).
645 * All other hook names need only be unique. (the framework checks this).
648 ng_pppoe_newhook(node_p node
, hook_p hook
, const char *name
)
650 const priv_p privp
= NG_NODE_PRIVATE(node
);
653 if (strcmp(name
, NG_PPPOE_HOOK_ETHERNET
) == 0) {
654 privp
->ethernet_hook
= hook
;
655 NG_HOOK_SET_RCVDATA(hook
, ng_pppoe_rcvdata_ether
);
656 } else if (strcmp(name
, NG_PPPOE_HOOK_DEBUG
) == 0) {
657 privp
->debug_hook
= hook
;
658 NG_HOOK_SET_RCVDATA(hook
, ng_pppoe_rcvdata_debug
);
661 * Any other unique name is OK.
662 * The infrastructure has already checked that it's unique,
663 * so just allocate it and hook it in.
665 sp
= malloc(sizeof(*sp
), M_NETGRAPH_PPPOE
, M_NOWAIT
| M_ZERO
);
669 NG_HOOK_SET_PRIVATE(hook
, sp
);
672 CTR5(KTR_NET
, "%20s: node [%x] (%p) connected hook %s (%p)",
673 __func__
, node
->nd_ID
, node
, name
, hook
);
679 * Hook has been added successfully. Request the MAC address of
680 * the underlying Ethernet node.
683 ng_pppoe_connect(hook_p hook
)
685 const priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(hook
));
689 if (hook
!= privp
->ethernet_hook
)
693 * If this is Ethernet hook, then request MAC address
694 * from our downstream.
696 NG_MKMESSAGE(msg
, NGM_ETHER_COOKIE
, NGM_ETHER_GET_ENADDR
, 0, M_NOWAIT
);
701 * Our hook and peer hook have HK_INVALID flag set,
702 * so we can't use NG_SEND_MSG_HOOK() macro here.
704 NG_SEND_MSG_ID(error
, privp
->node
, msg
,
705 NG_NODE_ID(NG_PEER_NODE(privp
->ethernet_hook
)),
706 NG_NODE_ID(privp
->node
));
711 * Get a netgraph control message.
712 * Check it is one we understand. If needed, send a response.
713 * We sometimes save the address for an async action later.
714 * Always free the message.
717 ng_pppoe_rcvmsg(node_p node
, item_p item
, hook_p lasthook
)
719 priv_p privp
= NG_NODE_PRIVATE(node
);
720 struct ngpppoe_init_data
*ourmsg
= NULL
;
721 struct ng_mesg
*resp
= NULL
;
728 NGI_GET_MSG(item
, msg
);
729 CTR5(KTR_NET
, "%20s: node [%x] (%p) got message %d with cookie %d",
730 __func__
, node
->nd_ID
, node
, msg
->header
.cmd
,
731 msg
->header
.typecookie
);
733 /* Deal with message according to cookie and command. */
734 switch (msg
->header
.typecookie
) {
735 case NGM_PPPOE_COOKIE
:
736 switch (msg
->header
.cmd
) {
737 case NGM_PPPOE_CONNECT
:
738 case NGM_PPPOE_LISTEN
:
739 case NGM_PPPOE_OFFER
:
740 case NGM_PPPOE_SERVICE
:
741 ourmsg
= (struct ngpppoe_init_data
*)msg
->data
;
742 if (msg
->header
.arglen
< sizeof(*ourmsg
)) {
743 log(LOG_ERR
, "ng_pppoe[%x]: init data too "
744 "small\n", node
->nd_ID
);
747 if (msg
->header
.arglen
- sizeof(*ourmsg
) >
748 PPPOE_SERVICE_NAME_SIZE
) {
749 log(LOG_ERR
, "ng_pppoe[%x]: service name "
750 "too big\n", node
->nd_ID
);
753 if (msg
->header
.arglen
- sizeof(*ourmsg
) <
755 log(LOG_ERR
, "ng_pppoe[%x]: init data has bad "
756 "length, %d should be %zd\n", node
->nd_ID
,
758 msg
->header
.arglen
- sizeof (*ourmsg
));
762 /* Make sure strcmp will terminate safely. */
763 ourmsg
->hook
[sizeof(ourmsg
->hook
) - 1] = '\0';
765 /* Find hook by name. */
766 hook
= ng_findhook(node
, ourmsg
->hook
);
770 sp
= NG_HOOK_PRIVATE(hook
);
774 if (msg
->header
.cmd
== NGM_PPPOE_LISTEN
) {
776 * Ensure we aren't already listening for this
779 if (pppoe_find_svc(node
, ourmsg
->data
,
780 ourmsg
->data_len
) != NULL
)
785 * PPPOE_SERVICE advertisments are set up
786 * on sessions that are in PRIMED state.
788 if (msg
->header
.cmd
== NGM_PPPOE_SERVICE
)
791 if (sp
->state
!= PPPOE_SNONE
) {
792 log(LOG_NOTICE
, "ng_pppoe[%x]: Session already "
793 "active\n", node
->nd_ID
);
798 * Set up prototype header.
800 neg
= malloc(sizeof(*neg
), M_NETGRAPH_PPPOE
,
806 neg
->m
= m_getcl(M_DONTWAIT
, MT_DATA
, M_PKTHDR
);
807 if (neg
->m
== NULL
) {
808 free(neg
, M_NETGRAPH_PPPOE
);
811 neg
->m
->m_pkthdr
.rcvif
= NULL
;
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;
823 sp
->creator
= NGI_RETADDR(item
);
825 switch (msg
->header
.cmd
) {
826 case NGM_PPPOE_GET_STATUS
:
828 struct ngpppoestat
*stats
;
830 NG_MKRESPONSE(resp
, msg
, sizeof(*stats
), M_NOWAIT
);
834 stats
= (struct ngpppoestat
*) resp
->data
;
835 stats
->packets_in
= privp
->packets_in
;
836 stats
->packets_out
= privp
->packets_out
;
839 case NGM_PPPOE_CONNECT
:
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
850 int i
, acnlen
= 0, acnsep
= 0, srvlen
;
851 for (i
= 0; i
< ourmsg
->data_len
; i
++) {
852 if (ourmsg
->data
[i
] == '\\') {
858 srvlen
= ourmsg
->data_len
- acnlen
- acnsep
;
860 bcopy(ourmsg
->data
, neg
->ac_name
.data
, acnlen
);
861 neg
->ac_name_len
= acnlen
;
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
;
871 case NGM_PPPOE_LISTEN
:
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'
879 neg
->service
.hdr
.tag_type
= PTT_SRV_NAME
;
880 neg
->service
.hdr
.tag_len
=
881 htons((uint16_t)ourmsg
->data_len
);
883 if (ourmsg
->data_len
)
884 bcopy(ourmsg
->data
, neg
->service
.data
,
886 neg
->service_len
= ourmsg
->data_len
;
887 neg
->pkt
->pkt_header
.ph
.code
= PADT_CODE
;
889 * Wait for PADI packet coming from Ethernet.
891 sp
->state
= PPPOE_LISTENING
;
892 LIST_INSERT_HEAD(&privp
->listeners
, sp
, sessions
);
894 case NGM_PPPOE_OFFER
:
896 * Check the hook exists and is Uninitialised.
897 * Store the originator of this message so we can send
898 * a success of fail message to them later.
899 * Store the AC-Name given and go to PRIMED.
901 neg
->ac_name
.hdr
.tag_type
= PTT_AC_NAME
;
902 neg
->ac_name
.hdr
.tag_len
=
903 htons((uint16_t)ourmsg
->data_len
);
904 if (ourmsg
->data_len
)
905 bcopy(ourmsg
->data
, neg
->ac_name
.data
,
907 neg
->ac_name_len
= ourmsg
->data_len
;
908 neg
->pkt
->pkt_header
.ph
.code
= PADO_CODE
;
910 * Wait for PADI packet coming from hook.
912 sp
->state
= PPPOE_PRIMED
;
914 case NGM_PPPOE_SERVICE
:
916 * Check the session is primed.
917 * for now just allow ONE service to be advertised.
918 * If you do it twice you just overwrite.
920 if (sp
->state
!= PPPOE_PRIMED
) {
921 log(LOG_NOTICE
, "ng_pppoe[%x]: session not "
922 "primed\n", node
->nd_ID
);
926 neg
->service
.hdr
.tag_type
= PTT_SRV_NAME
;
927 neg
->service
.hdr
.tag_len
=
928 htons((uint16_t)ourmsg
->data_len
);
930 if (ourmsg
->data_len
)
931 bcopy(ourmsg
->data
, neg
->service
.data
,
933 neg
->service_len
= ourmsg
->data_len
;
935 case NGM_PPPOE_SETMODE
:
940 if (msg
->header
.arglen
== 0)
943 s
= (char *)msg
->data
;
944 len
= msg
->header
.arglen
- 1;
946 /* Search for matching mode string. */
947 if (len
== strlen(NG_PPPOE_STANDARD
) &&
948 (strncmp(NG_PPPOE_STANDARD
, s
, len
) == 0)) {
950 privp
->eh
.ether_type
= ETHERTYPE_PPPOE_DISC
;
953 if (len
== strlen(NG_PPPOE_3COM
) &&
954 (strncmp(NG_PPPOE_3COM
, s
, len
) == 0)) {
955 privp
->flags
|= COMPAT_3COM
;
956 privp
->eh
.ether_type
=
957 ETHERTYPE_PPPOE_3COM_DISC
;
960 if (len
== strlen(NG_PPPOE_DLINK
) &&
961 (strncmp(NG_PPPOE_DLINK
, s
, len
) == 0)) {
962 privp
->flags
|= COMPAT_DLINK
;
968 case NGM_PPPOE_GETMODE
:
973 if (privp
->flags
== 0)
974 len
+= strlen(NG_PPPOE_STANDARD
) + 1;
975 if (privp
->flags
& COMPAT_3COM
)
976 len
+= strlen(NG_PPPOE_3COM
) + 1;
977 if (privp
->flags
& COMPAT_DLINK
)
978 len
+= strlen(NG_PPPOE_DLINK
) + 1;
980 NG_MKRESPONSE(resp
, msg
, len
, M_NOWAIT
);
984 s
= (char *)resp
->data
;
985 if (privp
->flags
== 0) {
986 len
= strlen(NG_PPPOE_STANDARD
);
987 strlcpy(s
, NG_PPPOE_STANDARD
, len
+ 1);
990 if (privp
->flags
& COMPAT_3COM
) {
991 len
= strlen(NG_PPPOE_3COM
);
992 strlcpy(s
, NG_PPPOE_3COM
, len
+ 1);
995 if (privp
->flags
& COMPAT_DLINK
) {
998 len
= strlen(NG_PPPOE_DLINK
);
999 strlcpy(s
, NG_PPPOE_DLINK
, len
+ 1);
1003 case NGM_PPPOE_SETENADDR
:
1004 if (msg
->header
.arglen
!= ETHER_ADDR_LEN
)
1006 bcopy(msg
->data
, &privp
->eh
.ether_shost
,
1013 case NGM_ETHER_COOKIE
:
1014 if (!(msg
->header
.flags
& NGF_RESP
))
1016 switch (msg
->header
.cmd
) {
1017 case NGM_ETHER_GET_ENADDR
:
1018 if (msg
->header
.arglen
!= ETHER_ADDR_LEN
)
1020 bcopy(msg
->data
, &privp
->eh
.ether_shost
,
1031 /* Take care of synchronous response, if any. */
1033 CTR2(KTR_NET
, "%20s: returning %d", __func__
, error
);
1034 NG_RESPOND_MSG(error
, node
, item
, resp
);
1035 /* Free the message and return. */
1041 * Start a client into the first state. A separate function because
1042 * it can be needed if the negotiation times out.
1045 pppoe_start(sessp sp
)
1047 hook_p hook
= sp
->hook
;
1048 node_p node
= NG_HOOK_NODE(hook
);
1049 priv_p privp
= NG_NODE_PRIVATE(node
);
1052 struct pppoe_tag hdr
;
1059 * Kick the state machine into starting up.
1061 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1062 sp
->state
= PPPOE_SINIT
;
1064 * Reset the packet header to broadcast. Since we are
1065 * in a client mode use configured ethertype.
1067 memcpy((void *)&neg
->pkt
->pkt_header
.eh
, &privp
->eh
,
1068 sizeof(struct ether_header
));
1069 neg
->pkt
->pkt_header
.ph
.code
= PADI_CODE
;
1070 uniqtag
.hdr
.tag_type
= PTT_HOST_UNIQ
;
1071 uniqtag
.hdr
.tag_len
= htons((u_int16_t
)sizeof(uniqtag
.data
));
1072 uniqtag
.data
.pointer
= sp
;
1074 insert_tag(sp
, &uniqtag
.hdr
);
1075 insert_tag(sp
, &neg
->service
.hdr
);
1078 * Send packet and prepare to retransmit it after timeout.
1080 ng_callout(&neg
->handle
, node
, hook
, PPPOE_INITIAL_TIMEOUT
* hz
,
1081 pppoe_ticker
, NULL
, 0);
1082 neg
->timeout
= PPPOE_INITIAL_TIMEOUT
* 2;
1083 m0
= m_copypacket(neg
->m
, M_DONTWAIT
);
1084 NG_SEND_DATA_ONLY(error
, privp
->ethernet_hook
, m0
);
1088 send_acname(sessp sp
, const struct pppoe_tag
*tag
)
1091 struct ng_mesg
*msg
;
1092 struct ngpppoe_sts
*sts
;
1094 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1096 NG_MKMESSAGE(msg
, NGM_PPPOE_COOKIE
, NGM_PPPOE_ACNAME
,
1097 sizeof(struct ngpppoe_sts
), M_NOWAIT
);
1101 sts
= (struct ngpppoe_sts
*)msg
->data
;
1102 tlen
= min(NG_HOOKSIZ
- 1, ntohs(tag
->tag_len
));
1103 strncpy(sts
->hook
, tag
->tag_data
, tlen
);
1104 sts
->hook
[tlen
] = '\0';
1105 NG_SEND_MSG_ID(error
, NG_HOOK_NODE(sp
->hook
), msg
, sp
->creator
, 0);
1111 send_sessionid(sessp sp
)
1114 struct ng_mesg
*msg
;
1116 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1118 NG_MKMESSAGE(msg
, NGM_PPPOE_COOKIE
, NGM_PPPOE_SESSIONID
,
1119 sizeof(uint16_t), M_NOWAIT
);
1123 *(uint16_t *)msg
->data
= sp
->Session_ID
;
1124 NG_SEND_MSG_ID(error
, NG_HOOK_NODE(sp
->hook
), msg
, sp
->creator
, 0);
1130 * Receive data from session hook and do something with it.
1133 ng_pppoe_rcvdata(hook_p hook
, item_p item
)
1135 node_p node
= NG_HOOK_NODE(hook
);
1136 const priv_p privp
= NG_NODE_PRIVATE(node
);
1137 sessp sp
= NG_HOOK_PRIVATE(hook
);
1138 struct pppoe_full_hdr
*wh
;
1142 CTR6(KTR_NET
, "%20s: node [%x] (%p) received %p on \"%s\" (%p)",
1143 __func__
, node
->nd_ID
, node
, item
, hook
->hk_name
, hook
);
1146 switch (sp
->state
) {
1147 case PPPOE_NEWCONNECTED
:
1148 case PPPOE_CONNECTED
: {
1150 * Remove PPP address and control fields, if any.
1151 * For example, ng_ppp(4) always sends LCP packets
1152 * with address and control fields as required by
1153 * generic PPP. PPPoE is an exception to the rule.
1155 if (m
->m_pkthdr
.len
>= 2) {
1156 if (m
->m_len
< 2 && !(m
= m_pullup(m
, 2)))
1158 if (mtod(m
, u_char
*)[0] == 0xff &&
1159 mtod(m
, u_char
*)[1] == 0x03)
1163 * Bang in a pre-made header, and set the length up
1164 * to be correct. Then send it to the ethernet driver.
1166 M_PREPEND(m
, sizeof(*wh
), M_DONTWAIT
);
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
++;
1177 case PPPOE_PRIMED
: {
1179 struct pppoe_tag hdr
;
1182 const struct pppoe_tag
*tag
;
1184 const struct pppoe_hdr
*ph
;
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.
1195 if (m
->m_len
< sizeof(*wh
)) {
1196 m
= m_pullup(m
, sizeof(*wh
));
1200 wh
= mtod(m
, struct pppoe_full_hdr
*);
1202 session
= ntohs(wh
->ph
.sid
);
1203 length
= ntohs(wh
->ph
.length
);
1205 /* Use peers mode in session. */
1206 neg
->pkt
->pkt_header
.eh
.ether_type
= wh
->eh
.ether_type
;
1207 if (code
!= PADI_CODE
)
1209 ng_uncallout(&neg
->handle
, node
);
1212 * This is the first time we hear
1213 * from the client, so note it's
1214 * unicast address, replacing the
1215 * broadcast address.
1217 bcopy(wh
->eh
.ether_shost
,
1218 neg
->pkt
->pkt_header
.eh
.ether_dhost
,
1220 sp
->state
= PPPOE_SOFFER
;
1222 neg
->pkt
->pkt_header
.ph
.code
= PADO_CODE
;
1225 * Start working out the tags to respond with.
1227 uniqtag
.hdr
.tag_type
= PTT_AC_COOKIE
;
1228 uniqtag
.hdr
.tag_len
= htons((u_int16_t
)sizeof(sp
));
1229 uniqtag
.data
.pointer
= 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 */
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
1241 if (((tag
== NULL
) || (tag
->tag_len
== 0)) &&
1242 (neg
->service
.hdr
.tag_len
!= 0)) {
1243 insert_tag(sp
, &neg
->service
.hdr
); /* SERVICE */
1245 if ((tag
= get_tag(ph
, PTT_HOST_UNIQ
)))
1246 insert_tag(sp
, tag
); /* returned hostunique */
1247 insert_tag(sp
, &uniqtag
.hdr
);
1251 * Send the offer but if they don't respond
1252 * in PPPOE_OFFER_TIMEOUT seconds, forget about it.
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
++;
1263 * Packets coming from the hook make no sense
1264 * to sessions in the rest of states. Throw them away.
1277 * Receive data from ether and do something with it.
1280 ng_pppoe_rcvdata_ether(hook_p hook
, item_p item
)
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
;
1297 CTR6(KTR_NET
, "%20s: node [%x] (%p) received %p on \"%s\" (%p)",
1298 __func__
, node
->nd_ID
, node
, item
, hook
->hk_name
, hook
);
1302 * Dig out various fields from the packet.
1303 * Use them to decide where to send it.
1305 privp
->packets_in
++;
1306 if( m
->m_len
< sizeof(*wh
)) {
1307 m
= m_pullup(m
, sizeof(*wh
)); /* Checks length */
1309 log(LOG_NOTICE
, "ng_pppoe[%x]: couldn't "
1310 "m_pullup(wh)\n", node
->nd_ID
);
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
:
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).
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
);
1329 log(LOG_NOTICE
, "ng_pppoe[%x]: "
1330 "couldn't m_pullup(pkthdr)\n",
1336 if (m
->m_len
!= m
->m_pkthdr
.len
) {
1338 * It's not all in one piece.
1339 * We need to do extra work.
1340 * Put it into a cluster.
1343 n
= m_dup(m
, M_DONTWAIT
);
1347 /* just check we got a cluster */
1348 if (m
->m_len
!= m
->m_pkthdr
.len
) {
1354 log(LOG_NOTICE
, "ng_pppoe[%x]: packet "
1355 "fragmented\n", node
->nd_ID
);
1359 wh
= mtod(m
, struct pppoe_full_hdr
*);
1360 length
= ntohs(wh
->ph
.length
);
1362 session
= ntohs(wh
->ph
.sid
);
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
1374 tag
= get_tag(ph
, PTT_SRV_NAME
);
1376 CTR1(KTR_NET
, "%20s: PADI w/o Service-Name",
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.
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
);
1394 error
= ENETUNREACH
;
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.
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
);
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
);
1419 * Check the session is in the right state.
1420 * It needs to be in PPPOE_SINIT.
1422 sp
= NG_HOOK_PRIVATE(sendhook
);
1423 if (sp
->state
== PPPOE_SREQ
||
1424 sp
->state
== PPPOE_CONNECTED
) {
1425 break; /* Multiple PADO is OK. */
1427 if (sp
->state
!= PPPOE_SINIT
) {
1428 log(LOG_NOTICE
, "ng_pppoe[%x]: session "
1429 "in wrong state\n", node
->nd_ID
);
1433 /* If requested specific AC-name, check it. */
1434 if (neg
->ac_name_len
) {
1435 tag
= get_tag(ph
, PTT_AC_NAME
);
1437 /* No PTT_AC_NAME in PADO */
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) {
1446 sp
->state
= PPPOE_SREQ
;
1447 ng_uncallout(&neg
->handle
, node
);
1450 * This is the first time we hear
1451 * from the server, so note it's
1452 * unicast address, replacing the
1453 * broadcast address .
1455 bcopy(wh
->eh
.ether_shost
,
1456 neg
->pkt
->pkt_header
.eh
.ether_dhost
,
1459 neg
->pkt
->pkt_header
.ph
.code
= PADR_CODE
;
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
);
1468 insert_tag(sp
, &neg
->service
.hdr
); /* Service */
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
);
1482 * Use the ac_cookie tag to find the
1483 * hook this is in response to.
1485 utag
= get_tag(ph
, PTT_AC_COOKIE
);
1486 if ((utag
== NULL
) ||
1487 (ntohs(utag
->tag_len
) != sizeof(sp
))) {
1491 sendhook
= pppoe_finduniq(node
, utag
);
1492 if (sendhook
== NULL
)
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.
1501 sp
= NG_HOOK_PRIVATE(sendhook
);
1502 if (sp
->state
== PPPOE_NEWCONNECTED
) {
1504 * Whoa! drop back to resend that PADS packet.
1505 * We should still have a copy of it.
1507 sp
->state
= PPPOE_SOFFER
;
1508 } else if (sp
->state
!= PPPOE_SOFFER
)
1509 LEAVE (ENETUNREACH
);
1511 ng_uncallout(&neg
->handle
, node
);
1512 neg
->pkt
->pkt_header
.ph
.code
= PADS_CODE
;
1513 if (sp
->Session_ID
== 0) {
1514 neg
->pkt
->pkt_header
.ph
.sid
=
1515 htons(pppoe_getnewsession(sp
));
1520 * start working out the tags to respond with.
1523 insert_tag(sp
, &neg
->ac_name
.hdr
); /* AC_NAME */
1524 if ((tag
= get_tag(ph
, PTT_SRV_NAME
)))
1525 insert_tag(sp
, tag
);/* return service */
1526 if ((tag
= get_tag(ph
, PTT_HOST_UNIQ
)))
1527 insert_tag(sp
, tag
); /* return it */
1528 insert_tag(sp
, utag
); /* ac_cookie */
1531 sp
->state
= PPPOE_NEWCONNECTED
;
1533 /* Send the PADS without a timeout - we're now connected. */
1534 m0
= m_copypacket(sp
->neg
->m
, M_DONTWAIT
);
1535 NG_FWD_NEW_DATA(error
, item
, privp
->ethernet_hook
, m0
);
1538 * Having sent the last Negotiation header,
1539 * Set up the stored packet header to be correct for
1540 * the actual session. But keep the negotialtion stuff
1541 * around in case we need to resend this last packet.
1542 * We'll discard it when we move from NEWCONNECTED
1545 sp
->pkt_hdr
= neg
->pkt
->pkt_header
;
1546 /* Configure ethertype depending on what
1547 * ethertype was used at discovery phase */
1548 if (sp
->pkt_hdr
.eh
.ether_type
==
1549 ETHERTYPE_PPPOE_3COM_DISC
)
1550 sp
->pkt_hdr
.eh
.ether_type
1551 = ETHERTYPE_PPPOE_3COM_SESS
;
1553 sp
->pkt_hdr
.eh
.ether_type
1554 = ETHERTYPE_PPPOE_SESS
;
1555 sp
->pkt_hdr
.ph
.code
= 0;
1556 pppoe_send_event(sp
, NGM_PPPOE_SUCCESS
);
1561 * Use the host_uniq tag to find the hook this is in
1562 * response to. Take the session ID and store it away.
1563 * Also make sure the pre-made header is correct and
1564 * set us into Session mode.
1566 utag
= get_tag(ph
, PTT_HOST_UNIQ
);
1567 if ((utag
== NULL
) ||
1568 (ntohs(utag
->tag_len
) != sizeof(sp
))) {
1569 LEAVE (ENETUNREACH
);
1571 sendhook
= pppoe_finduniq(node
, utag
);
1572 if (sendhook
== NULL
)
1576 * Check the session is in the right state.
1577 * It needs to be in PPPOE_SREQ.
1579 sp
= NG_HOOK_PRIVATE(sendhook
);
1580 if (sp
->state
!= PPPOE_SREQ
)
1583 ng_uncallout(&neg
->handle
, node
);
1584 neg
->pkt
->pkt_header
.ph
.sid
= wh
->ph
.sid
;
1585 sp
->Session_ID
= ntohs(wh
->ph
.sid
);
1586 pppoe_addsession(sp
);
1589 sp
->state
= PPPOE_CONNECTED
;
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.
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
;
1600 sp
->pkt_hdr
.eh
.ether_type
1601 = ETHERTYPE_PPPOE_SESS
;
1602 sp
->pkt_hdr
.ph
.code
= 0;
1604 free(sp
->neg
, M_NETGRAPH_PPPOE
);
1606 pppoe_send_event(sp
, NGM_PPPOE_SUCCESS
);
1610 * Find matching peer/session combination.
1612 sp
= pppoe_findsession(privp
, wh
);
1615 /* Disconnect that hook. */
1616 ng_rmhook_self(sp
->hook
);
1619 LEAVE(EPFNOSUPPORT
);
1622 case ETHERTYPE_PPPOE_3COM_SESS
:
1623 case ETHERTYPE_PPPOE_SESS
:
1625 * Find matching peer/session combination.
1627 sp
= pppoe_findsession(privp
, wh
);
1629 LEAVE (ENETUNREACH
);
1630 m_adj(m
, sizeof(*wh
));
1632 /* If packet too short, dump it. */
1633 if (m
->m_pkthdr
.len
< length
)
1635 /* Also need to trim excess at the end */
1636 if (m
->m_pkthdr
.len
> length
) {
1637 m_adj(m
, -((int)(m
->m_pkthdr
.len
- length
)));
1639 if ( sp
->state
!= PPPOE_CONNECTED
) {
1640 if (sp
->state
== PPPOE_NEWCONNECTED
) {
1641 sp
->state
= PPPOE_CONNECTED
;
1643 * Now we have gone to Connected mode,
1644 * Free all resources needed for negotiation.
1645 * Be paranoid about whether there may be
1648 m_freem(sp
->neg
->m
);
1649 ng_uncallout(&sp
->neg
->handle
, node
);
1650 free(sp
->neg
, M_NETGRAPH_PPPOE
);
1653 LEAVE (ENETUNREACH
);
1656 NG_FWD_NEW_DATA(error
, item
, sp
->hook
, m
);
1659 LEAVE(EPFNOSUPPORT
);
1669 * Receive data from debug hook and bypass it to ether.
1672 ng_pppoe_rcvdata_debug(hook_p hook
, item_p item
)
1674 node_p node
= NG_HOOK_NODE(hook
);
1675 const priv_p privp
= NG_NODE_PRIVATE(node
);
1678 CTR6(KTR_NET
, "%20s: node [%x] (%p) received %p on \"%s\" (%p)",
1679 __func__
, node
->nd_ID
, node
, item
, hook
->hk_name
, hook
);
1681 NG_FWD_ITEM_HOOK(error
, item
, privp
->ethernet_hook
);
1682 privp
->packets_out
++;
1687 * Do local shutdown processing..
1688 * If we are a persistant device, we might refuse to go away, and
1689 * we'd only remove our links and reset ourself.
1692 ng_pppoe_shutdown(node_p node
)
1694 const priv_p privp
= NG_NODE_PRIVATE(node
);
1697 for (i
= 0; i
< SESSHASHSIZE
; i
++)
1698 mtx_destroy(&privp
->sesshash
[i
].mtx
);
1699 NG_NODE_SET_PRIVATE(node
, NULL
);
1700 NG_NODE_UNREF(privp
->node
);
1701 free(privp
, M_NETGRAPH_PPPOE
);
1706 * Hook disconnection
1708 * Clean up all dangling links and information about the session/hook.
1709 * For this type, removal of the last link destroys the node.
1712 ng_pppoe_disconnect(hook_p hook
)
1714 node_p node
= NG_HOOK_NODE(hook
);
1715 priv_p privp
= NG_NODE_PRIVATE(node
);
1718 if (hook
== privp
->debug_hook
) {
1719 privp
->debug_hook
= NULL
;
1720 } else if (hook
== privp
->ethernet_hook
) {
1721 privp
->ethernet_hook
= NULL
;
1722 if (NG_NODE_IS_VALID(node
))
1723 ng_rmnode_self(node
);
1725 sp
= NG_HOOK_PRIVATE(hook
);
1726 if (sp
->state
!= PPPOE_SNONE
) {
1727 pppoe_send_event(sp
, NGM_PPPOE_CLOSE
);
1730 * According to the spec, if we are connected,
1731 * we should send a DISC packet if we are shutting down
1734 if ((privp
->ethernet_hook
)
1735 && ((sp
->state
== PPPOE_CONNECTED
)
1736 || (sp
->state
== PPPOE_NEWCONNECTED
))) {
1739 /* Generate a packet of that type. */
1740 MGETHDR(m
, M_DONTWAIT
, MT_DATA
);
1742 log(LOG_NOTICE
, "ng_pppoe[%x]: session out of "
1743 "mbufs\n", node
->nd_ID
);
1745 struct pppoe_full_hdr
*wh
;
1746 struct pppoe_tag
*tag
;
1747 int msglen
= strlen(SIGNOFF
);
1750 m
->m_pkthdr
.rcvif
= NULL
;
1751 m
->m_pkthdr
.len
= m
->m_len
= sizeof(*wh
);
1752 wh
= mtod(m
, struct pppoe_full_hdr
*);
1753 bcopy(&sp
->pkt_hdr
, wh
, sizeof(*wh
));
1755 /* Revert the stored header to DISC/PADT mode. */
1756 wh
->ph
.code
= PADT_CODE
;
1758 * Configure ethertype depending on what
1759 * was used during sessions stage.
1761 if (wh
->eh
.ether_type
==
1762 ETHERTYPE_PPPOE_3COM_SESS
)
1763 wh
->eh
.ether_type
= ETHERTYPE_PPPOE_3COM_DISC
;
1765 wh
->eh
.ether_type
= ETHERTYPE_PPPOE_DISC
;
1767 * Add a General error message and adjust
1771 tag
->tag_type
= PTT_GEN_ERR
;
1772 tag
->tag_len
= htons((u_int16_t
)msglen
);
1773 strncpy(tag
->tag_data
, SIGNOFF
, msglen
);
1774 m
->m_pkthdr
.len
= (m
->m_len
+= sizeof(*tag
) +
1776 wh
->ph
.length
= htons(sizeof(*tag
) + msglen
);
1777 NG_SEND_DATA_ONLY(error
,
1778 privp
->ethernet_hook
, m
);
1781 if (sp
->state
== PPPOE_LISTENING
)
1782 LIST_REMOVE(sp
, sessions
);
1783 else if (sp
->Session_ID
)
1784 pppoe_delsession(sp
);
1786 * As long as we have somewhere to store the timeout handle,
1787 * we may have a timeout pending.. get rid of it.
1790 ng_uncallout(&sp
->neg
->handle
, node
);
1792 m_freem(sp
->neg
->m
);
1793 free(sp
->neg
, M_NETGRAPH_PPPOE
);
1795 free(sp
, M_NETGRAPH_PPPOE
);
1796 NG_HOOK_SET_PRIVATE(hook
, NULL
);
1798 if ((NG_NODE_NUMHOOKS(node
) == 0) &&
1799 (NG_NODE_IS_VALID(node
)))
1800 ng_rmnode_self(node
);
1805 * Timeouts come here.
1808 pppoe_ticker(node_p node
, hook_p hook
, void *arg1
, int arg2
)
1810 priv_p privp
= NG_NODE_PRIVATE(NG_HOOK_NODE(hook
));
1811 sessp sp
= NG_HOOK_PRIVATE(hook
);
1813 struct mbuf
*m0
= NULL
;
1816 CTR6(KTR_NET
, "%20s: node [%x] (%p) hook \"%s\" (%p) session %d",
1817 __func__
, node
->nd_ID
, node
, hook
->hk_name
, hook
, sp
->Session_ID
);
1820 * Resend the last packet, using an exponential backoff.
1821 * After a period of time, stop growing the backoff,
1822 * And either leave it, or revert to the start.
1826 /* Timeouts on these produce resends. */
1827 m0
= m_copypacket(sp
->neg
->m
, M_DONTWAIT
);
1828 NG_SEND_DATA_ONLY( error
, privp
->ethernet_hook
, m0
);
1829 ng_callout(&neg
->handle
, node
, hook
, neg
->timeout
* hz
,
1830 pppoe_ticker
, NULL
, 0);
1831 if ((neg
->timeout
<<= 1) > PPPOE_TIMEOUT_LIMIT
) {
1832 if (sp
->state
== PPPOE_SREQ
) {
1833 /* Revert to SINIT mode. */
1836 neg
->timeout
= PPPOE_TIMEOUT_LIMIT
;
1842 /* A timeout on these says "give up" */
1843 ng_rmhook_self(hook
);
1846 /* Timeouts have no meaning in other states. */
1847 log(LOG_NOTICE
, "ng_pppoe[%x]: unexpected timeout\n",
1853 * Parse an incoming packet to see if any tags should be copied to the
1854 * output packet. Don't do any tags that have been handled in the main
1857 static const struct pppoe_tag
*
1858 scan_tags(sessp sp
, const struct pppoe_hdr
* ph
)
1860 const char *const end
= (const char *)next_tag(ph
);
1862 const struct pppoe_tag
*pt
= &ph
->tag
[0];
1865 * Keep processing tags while a tag header will still fit.
1867 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1869 while((const char*)(pt
+ 1) <= end
) {
1871 * If the tag data would go past the end of the packet, abort.
1873 ptn
= (((const char *)(pt
+ 1)) + ntohs(pt
->tag_len
));
1877 switch (pt
->tag_type
) {
1893 pt
= (const struct pppoe_tag
*)ptn
;
1899 pppoe_send_event(sessp sp
, enum cmd cmdid
)
1902 struct ng_mesg
*msg
;
1903 struct ngpppoe_sts
*sts
;
1905 CTR2(KTR_NET
, "%20s: called %d", __func__
, sp
->Session_ID
);
1907 NG_MKMESSAGE(msg
, NGM_PPPOE_COOKIE
, cmdid
,
1908 sizeof(struct ngpppoe_sts
), M_NOWAIT
);
1911 sts
= (struct ngpppoe_sts
*)msg
->data
;
1912 strncpy(sts
->hook
, NG_HOOK_NAME(sp
->hook
), NG_HOOKSIZ
);
1913 NG_SEND_MSG_ID(error
, NG_HOOK_NODE(sp
->hook
), msg
, sp
->creator
, 0);