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_rfc1490.c,v 1.24 2005/01/07 01:45:39 imp Exp $
41 * $Whistle: ng_rfc1490.c,v 1.22 1999/11/01 09:24:52 julian Exp $
45 * This node does RFC 1490 multiplexing.
47 * NOTE: RFC 1490 is updated by RFC 2427.
50 #include <sys/param.h>
51 #include <sys/systm.h>
52 #include <sys/errno.h>
53 #include <sys/kernel.h>
54 #include <sys/malloc.h>
56 #include <sys/socket.h>
59 #include <netinet/in.h>
60 #include <netinet/if_ether.h>
62 #include <netgraph7/ng_message.h>
63 #include <netgraph7/netgraph.h>
64 #include <netgraph7/ng_parse.h>
65 #include "ng_rfc1490.h"
71 /* Q.922 stuff -- see RFC 1490 */
75 #define NLPID_PPP 0xCF
76 #define NLPID_SNAP 0x80
77 #define NLPID_Q933 0x08
78 #define NLPID_CLNP 0x81
79 #define NLPID_ESIS 0x82
80 #define NLPID_ISIS 0x83
82 #define ERROUT(x) do { error = (x); goto done; } while (0)
84 /* Encapsulation methods we understand */
86 NG_RFC1490_ENCAP_IETF_IP
= 1, /* see RFC2427, chapter 7, table 1 */
87 NG_RFC1490_ENCAP_IETF_SNAP
, /* see RFC2427, chapter 7, table 2 */
88 NG_RFC1490_ENCAP_CISCO
, /* Cisco's proprietary encapsulation */
91 struct ng_rfc1490_encap_t
{
96 static const struct ng_rfc1490_encap_t ng_rfc1490_encaps
[] = {
97 { NG_RFC1490_ENCAP_IETF_IP
, "ietf-ip" },
98 { NG_RFC1490_ENCAP_IETF_SNAP
, "ietf-snap" },
99 { NG_RFC1490_ENCAP_CISCO
, "cisco" },
103 /* Node private data */
104 struct ng_rfc1490_private
{
109 const struct ng_rfc1490_encap_t
*enc
;
111 typedef struct ng_rfc1490_private
*priv_p
;
113 /* Netgraph node methods */
114 static ng_constructor_t ng_rfc1490_constructor
;
115 static ng_rcvmsg_t ng_rfc1490_rcvmsg
;
116 static ng_shutdown_t ng_rfc1490_shutdown
;
117 static ng_newhook_t ng_rfc1490_newhook
;
118 static ng_rcvdata_t ng_rfc1490_rcvdata
;
119 static ng_disconnect_t ng_rfc1490_disconnect
;
121 /* List of commands and how to convert arguments to/from ASCII */
122 static const struct ng_cmdlist ng_rfc1490_cmds
[] = {
125 NGM_RFC1490_SET_ENCAP
,
127 &ng_parse_string_type
,
132 NGM_RFC1490_GET_ENCAP
,
135 &ng_parse_string_type
140 /* Node type descriptor */
141 static struct ng_type typestruct
= {
142 .version
= NG_ABI_VERSION
,
143 .name
= NG_RFC1490_NODE_TYPE
,
144 .constructor
= ng_rfc1490_constructor
,
145 .rcvmsg
= ng_rfc1490_rcvmsg
,
146 .shutdown
= ng_rfc1490_shutdown
,
147 .newhook
= ng_rfc1490_newhook
,
148 .rcvdata
= ng_rfc1490_rcvdata
,
149 .disconnect
= ng_rfc1490_disconnect
,
150 .cmdlist
= ng_rfc1490_cmds
,
152 NETGRAPH_INIT(rfc1490
, &typestruct
);
154 /************************************************************************
156 ************************************************************************/
162 ng_rfc1490_constructor(node_p node
)
166 /* Allocate private structure */
167 priv
= kmalloc(sizeof(*priv
), M_NETGRAPH
,
168 M_WAITOK
| M_NULLOK
| M_ZERO
);
172 /* Initialize to default encapsulation method - ietf-ip */
173 priv
->enc
= ng_rfc1490_encaps
;
175 NG_NODE_SET_PRIVATE(node
, priv
);
182 * Give our ok for a hook to be added
185 ng_rfc1490_newhook(node_p node
, hook_p hook
, const char *name
)
187 const priv_p priv
= NG_NODE_PRIVATE(node
);
189 if (!strcmp(name
, NG_RFC1490_HOOK_DOWNSTREAM
)) {
192 priv
->downlink
= hook
;
193 } else if (!strcmp(name
, NG_RFC1490_HOOK_PPP
)) {
197 } else if (!strcmp(name
, NG_RFC1490_HOOK_INET
)) {
201 } else if (!strcmp(name
, NG_RFC1490_HOOK_ETHERNET
)) {
204 priv
->ethernet
= hook
;
211 * Receive a control message.
214 ng_rfc1490_rcvmsg(node_p node
, item_p item
, hook_p lasthook
)
216 const priv_p priv
= NG_NODE_PRIVATE(node
);
218 struct ng_mesg
*resp
= NULL
;
221 NGI_GET_MSG(item
, msg
);
223 if (msg
->header
.typecookie
== NGM_RFC1490_COOKIE
) {
224 switch (msg
->header
.cmd
) {
225 case NGM_RFC1490_SET_ENCAP
:
227 const struct ng_rfc1490_encap_t
*enc
;
231 if (msg
->header
.arglen
== 0)
234 s
= (char *)msg
->data
;
235 len
= msg
->header
.arglen
- 1;
237 /* Search for matching encapsulation method */
238 for (enc
= ng_rfc1490_encaps
; enc
->method
!= 0; enc
++ )
239 if ((strlen(enc
->name
) == len
) &&
240 !strncmp(enc
->name
, s
, len
))
243 if (enc
->method
!= 0)
249 case NGM_RFC1490_GET_ENCAP
:
251 NG_MKRESPONSE(resp
, msg
, strlen(priv
->enc
->name
) + 1, M_WAITOK
| M_NULLOK
);
255 strlcpy((char *)resp
->data
, priv
->enc
->name
,
256 strlen(priv
->enc
->name
) + 1);
267 NG_RESPOND_MSG(error
, node
, item
, resp
);
273 * Receive data on a hook and encapsulate according to RFC 1490.
274 * Only those nodes marked (*) are supported by this routine so far.
279 * ---------------------------------------------------------------------
283 * --------------------------------- -------------- |
284 * | 0x08 | 0x81 |0xCC |0xCF | 0x00 |..01.... |..10.... --------------
285 * | | | | | 0x80 | | |0x800 |
286 * Q.933 CLNP IP(*) PPP(*) SNAP ISO 8208 ISO 8208 | |
287 * | (rfc1973) | Modulo 8 Modulo 128 IP(*) Others
289 * -------------------- OUI
291 * L2 ID L3 ID -------------------------
292 * | User |00-80-C2 |00-00-00
294 * | 0x70 PID Ethertype
296 * ------------------- -----------------... ----------
297 * |0x51 |0x4E | |0x4C |0x7 |0xB | |0x806 |
299 * 7776 Q.922 Others 802.2 802.3(*) 802.6 Others IP(*) Others
304 #define MAX_ENCAPS_HDR 8
305 #define OUICMP(P,A,B,C) ((P)[0]==(A) && (P)[1]==(B) && (P)[2]==(C))
308 ng_rfc1490_rcvdata(hook_p hook
, item_p item
)
310 const node_p node
= NG_HOOK_NODE(hook
);
311 const priv_p priv
= NG_NODE_PRIVATE(node
);
316 if (hook
== priv
->downlink
) {
320 if (m
->m_len
< MAX_ENCAPS_HDR
321 && !(m
= m_pullup(m
, MAX_ENCAPS_HDR
)))
323 ptr
= start
= mtod(m
, const u_char
*);
325 if (priv
->enc
->method
== NG_RFC1490_ENCAP_CISCO
)
326 goto switch_on_etype
;
328 /* Must be UI frame */
329 if (*ptr
++ != HDLC_UI
)
332 /* Eat optional zero pad byte */
336 /* Multiplex on NLPID */
339 if (OUICMP(ptr
, 0, 0, 0)) { /* It's an ethertype */
343 switch_on_etype
: etype
= ntohs(*((const u_int16_t
*)ptr
));
345 m_adj(m
, ptr
- start
);
348 NG_FWD_NEW_DATA(error
, item
,
352 case ETHERTYPE_REVARP
:
356 } else if (OUICMP(ptr
, 0x00, 0x80, 0xc2)) {
360 ERROUT(0); /* unknown PID octet 0 */
362 ERROUT(0); /* not FCS-less 802.3 */
363 m_adj(m
, ptr
- start
);
364 NG_FWD_NEW_DATA(error
, item
, priv
->ethernet
, m
);
365 } else /* Other weird stuff... */
369 m_adj(m
, ptr
- start
);
370 NG_FWD_NEW_DATA(error
, item
, priv
->inet
, m
);
373 m_adj(m
, ptr
- start
);
374 NG_FWD_NEW_DATA(error
, item
, priv
->ppp
, m
);
381 default: /* Try PPP (see RFC 1973) */
382 ptr
--; /* NLPID becomes PPP proto */
383 if ((*ptr
& 0x01) == 0x01)
385 m_adj(m
, ptr
- start
);
386 NG_FWD_NEW_DATA(error
, item
, priv
->ppp
, m
);
389 } else if (hook
== priv
->ppp
) {
390 M_PREPEND(m
, 2, M_NOWAIT
); /* Prepend PPP NLPID */
393 mtod(m
, u_char
*)[0] = HDLC_UI
;
394 mtod(m
, u_char
*)[1] = NLPID_PPP
;
395 NG_FWD_NEW_DATA(error
, item
, priv
->downlink
, m
);
396 } else if (hook
== priv
->inet
) {
397 switch (priv
->enc
->method
) {
398 case NG_RFC1490_ENCAP_IETF_IP
:
399 M_PREPEND(m
, 2, M_NOWAIT
); /* Prepend IP NLPID */
402 mtod(m
, u_char
*)[0] = HDLC_UI
;
403 mtod(m
, u_char
*)[1] = NLPID_IP
;
405 case NG_RFC1490_ENCAP_IETF_SNAP
:
407 * According to RFC2427 frame should begin with
408 * HDLC_UI PAD NLIPID OUI PID
409 * 03 00 80 00 00 00 08 00
411 M_PREPEND(m
, 8, M_NOWAIT
);
414 mtod(m
, u_char
*)[0] = HDLC_UI
;
415 mtod(m
, u_char
*)[1] = 0x00; /* PAD */
416 mtod(m
, u_char
*)[2] = NLPID_SNAP
;
417 bzero((char *)(mtod(m
, u_char
*) + 3), 3); /* OUI 0-0-0 */
418 *((u_int16_t
*)mtod(m
, u_int16_t
*) + 6/sizeof(u_int16_t
))
419 = htons(ETHERTYPE_IP
); /* PID */
421 case NG_RFC1490_ENCAP_CISCO
:
422 M_PREPEND(m
, 2, M_NOWAIT
); /* Prepend IP ethertype */
425 *((u_int16_t
*)mtod(m
, u_int16_t
*)) = htons(ETHERTYPE_IP
);
428 NG_FWD_NEW_DATA(error
, item
, priv
->downlink
, m
);
429 } else if (hook
== priv
->ethernet
) {
430 M_PREPEND(m
, 8, M_NOWAIT
); /* Prepend NLPID, OUI, PID */
433 mtod(m
, u_char
*)[0] = HDLC_UI
;
434 mtod(m
, u_char
*)[1] = 0x00; /* pad */
435 mtod(m
, u_char
*)[2] = NLPID_SNAP
;
436 mtod(m
, u_char
*)[3] = 0x00; /* OUI */
437 mtod(m
, u_char
*)[4] = 0x80;
438 mtod(m
, u_char
*)[5] = 0xc2;
439 mtod(m
, u_char
*)[6] = 0x00; /* PID */
440 mtod(m
, u_char
*)[7] = 0x07;
441 NG_FWD_NEW_DATA(error
, item
, priv
->downlink
, m
);
456 ng_rfc1490_shutdown(node_p node
)
458 const priv_p priv
= NG_NODE_PRIVATE(node
);
460 /* Take down netgraph node */
461 bzero(priv
, sizeof(*priv
));
462 kfree(priv
, M_NETGRAPH
);
463 NG_NODE_SET_PRIVATE(node
, NULL
);
464 NG_NODE_UNREF(node
); /* let the node escape */
472 ng_rfc1490_disconnect(hook_p hook
)
474 const priv_p priv
= NG_NODE_PRIVATE(NG_HOOK_NODE(hook
));
476 if ((NG_NODE_NUMHOOKS(NG_HOOK_NODE(hook
)) == 0)
477 && (NG_NODE_IS_VALID(NG_HOOK_NODE(hook
))))
478 ng_rmnode_self(NG_HOOK_NODE(hook
));
479 else if (hook
== priv
->downlink
)
480 priv
->downlink
= NULL
;
481 else if (hook
== priv
->inet
)
483 else if (hook
== priv
->ppp
)
485 else if (hook
== priv
->ethernet
)
486 priv
->ethernet
= NULL
;