1/*
2 * ng_pppoe.h
3 */
4
5/*-
6 * Copyright (c) 1996-1999 Whistle Communications, Inc.
7 * All rights reserved.
8 *
9 * Subject to the following obligations and disclaimer of warranty, use and
10 * redistribution of this software, in source or object code forms, with or
11 * without modifications are expressly permitted by Whistle Communications;
12 * provided, however, that:
13 * 1. Any and all reproductions of the source or object code must include the
14 * copyright notice above and the following disclaimer of warranties; and
15 * 2. No rights are granted, in any manner or form, to use Whistle
16 * Communications, Inc. trademarks, including the mark "WHISTLE
17 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
18 * such appears in the above copyright notice or in the software.
19 *
20 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
21 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
22 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
23 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
25 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
26 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
27 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
28 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
29 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
30 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
31 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
32 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
36 * OF SUCH DAMAGE.
37 *
38 * Author: Julian Elischer <julian@freebsd.org>
39 *
| 1/*
2 * ng_pppoe.h
3 */
4
5/*-
6 * Copyright (c) 1996-1999 Whistle Communications, Inc.
7 * All rights reserved.
8 *
9 * Subject to the following obligations and disclaimer of warranty, use and
10 * redistribution of this software, in source or object code forms, with or
11 * without modifications are expressly permitted by Whistle Communications;
12 * provided, however, that:
13 * 1. Any and all reproductions of the source or object code must include the
14 * copyright notice above and the following disclaimer of warranties; and
15 * 2. No rights are granted, in any manner or form, to use Whistle
16 * Communications, Inc. trademarks, including the mark "WHISTLE
17 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
18 * such appears in the above copyright notice or in the software.
19 *
20 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
21 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
22 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
23 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
25 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
26 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
27 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
28 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
29 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
30 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
31 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
32 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
36 * OF SUCH DAMAGE.
37 *
38 * Author: Julian Elischer <julian@freebsd.org>
39 *
|
40 * $FreeBSD: head/sys/netgraph/ng_pppoe.h 139823 2005-01-07 01:45:51Z imp $
| 40 * $FreeBSD: head/sys/netgraph/ng_pppoe.h 151800 2005-10-28 14:41:28Z ru $
|
41 * $Whistle: ng_pppoe.h,v 1.7 1999/10/16 10:16:43 julian Exp $
42 */
43
44#ifndef _NETGRAPH_NG_PPPOE_H_
45#define _NETGRAPH_NG_PPPOE_H_
46
47/********************************************************************
48 * Netgraph hook constants etc.
49 ********************************************************************/
50/* Node type name. This should be unique among all netgraph node types */
51#define NG_PPPOE_NODE_TYPE "pppoe"
52
53#define NGM_PPPOE_COOKIE 1089893072
54
55/* Number of active sessions we can handle */
56#define PPPOE_NUM_SESSIONS 16 /* for now */
57#define PPPOE_SERVICE_NAME_SIZE 64 /* for now */
58
59/* Hook names */
60#define NG_PPPOE_HOOK_ETHERNET "ethernet"
61#define NG_PPPOE_HOOK_PADI "PADI" /* default PADI requests come here */
62#define NG_PPPOE_HOOK_S_LEADIN "service" /* PADO responses from PADI */
63#define NG_PPPOE_HOOK_C_LEADIN "client" /* Connect message starts this */
64#define NG_PPPOE_HOOK_DEBUG "debug"
65
66/* Mode names */
67#define NG_PPPOE_STANDARD "standard"
68#define NG_PPPOE_NONSTANDARD "3Com"
69
70/**********************************************************************
71 * Netgraph commands understood by this node type.
72 * FAIL, SUCCESS, CLOSE and ACNAME are sent by the node rather than received.
73 ********************************************************************/
74enum cmd {
75 NGM_PPPOE_SET_FLAG = 1,
76 NGM_PPPOE_CONNECT = 2, /* Client, Try find this service */
77 NGM_PPPOE_LISTEN = 3, /* Server, Await a request for this service */
78 NGM_PPPOE_OFFER = 4, /* Server, hook X should respond (*) */
79 NGM_PPPOE_SUCCESS = 5, /* State machine connected */
80 NGM_PPPOE_FAIL = 6, /* State machine could not connect */
81 NGM_PPPOE_CLOSE = 7, /* Session closed down */
82 NGM_PPPOE_SERVICE = 8, /* additional Service to advertise (in PADO) */
83 NGM_PPPOE_ACNAME = 9, /* AC_NAME for informational purposes */
84 NGM_PPPOE_GET_STATUS = 10, /* data in/out */
85 NGM_PPPOE_SESSIONID = 11, /* Session_ID for informational purposes */
86 NGM_PPPOE_SETMODE = 12, /* set to standard or 3Com mode */
87 NGM_PPPOE_GETMODE = 13, /* see current mode */
88};
89
90/***********************
91 * Structures passed in the various netgraph command messages.
92 ***********************/
93/* This structure is returned by the NGM_PPPOE_GET_STATUS command */
94struct ngpppoestat {
95 u_int packets_in; /* packets in from ethernet */
96 u_int packets_out; /* packets out towards ethernet */
97};
98
99/* Keep this in sync with the above structure definition */
100#define NG_PPPOESTAT_TYPE_INFO { \
101 { "packets_in", &ng_parse_uint_type }, \
102 { "packets_out", &ng_parse_uint_type }, \
103 { NULL } \
104}
105
106/*
107 * When this structure is accepted by the NGM_PPPOE_CONNECT command :
108 * The data field is MANDATORY.
109 * The session sends out a PADI request for the named service.
110 *
111 *
112 * When this structure is accepted by the NGM_PPPOE_LISTEN command.
113 * If no service is given this is assumed to accept ALL PADI requests.
114 * This may at some time take a regexp expression, but not yet.
115 * Matching PADI requests will be passed up the named hook.
116 *
117 *
118 * When this structure is accepted by the NGM_PPPOE_OFFER command:
119 * The AC-NAme field is set from that given and a PADI
120 * packet is expected to arrive from the session control daemon, on the
121 * named hook. The session will then issue the appropriate PADO
122 * and begin negotiation.
123 */
124struct ngpppoe_init_data {
125 char hook[NG_HOOKSIZ]; /* hook to monitor on */
126 u_int16_t data_len; /* Length of the service name */
| 41 * $Whistle: ng_pppoe.h,v 1.7 1999/10/16 10:16:43 julian Exp $
42 */
43
44#ifndef _NETGRAPH_NG_PPPOE_H_
45#define _NETGRAPH_NG_PPPOE_H_
46
47/********************************************************************
48 * Netgraph hook constants etc.
49 ********************************************************************/
50/* Node type name. This should be unique among all netgraph node types */
51#define NG_PPPOE_NODE_TYPE "pppoe"
52
53#define NGM_PPPOE_COOKIE 1089893072
54
55/* Number of active sessions we can handle */
56#define PPPOE_NUM_SESSIONS 16 /* for now */
57#define PPPOE_SERVICE_NAME_SIZE 64 /* for now */
58
59/* Hook names */
60#define NG_PPPOE_HOOK_ETHERNET "ethernet"
61#define NG_PPPOE_HOOK_PADI "PADI" /* default PADI requests come here */
62#define NG_PPPOE_HOOK_S_LEADIN "service" /* PADO responses from PADI */
63#define NG_PPPOE_HOOK_C_LEADIN "client" /* Connect message starts this */
64#define NG_PPPOE_HOOK_DEBUG "debug"
65
66/* Mode names */
67#define NG_PPPOE_STANDARD "standard"
68#define NG_PPPOE_NONSTANDARD "3Com"
69
70/**********************************************************************
71 * Netgraph commands understood by this node type.
72 * FAIL, SUCCESS, CLOSE and ACNAME are sent by the node rather than received.
73 ********************************************************************/
74enum cmd {
75 NGM_PPPOE_SET_FLAG = 1,
76 NGM_PPPOE_CONNECT = 2, /* Client, Try find this service */
77 NGM_PPPOE_LISTEN = 3, /* Server, Await a request for this service */
78 NGM_PPPOE_OFFER = 4, /* Server, hook X should respond (*) */
79 NGM_PPPOE_SUCCESS = 5, /* State machine connected */
80 NGM_PPPOE_FAIL = 6, /* State machine could not connect */
81 NGM_PPPOE_CLOSE = 7, /* Session closed down */
82 NGM_PPPOE_SERVICE = 8, /* additional Service to advertise (in PADO) */
83 NGM_PPPOE_ACNAME = 9, /* AC_NAME for informational purposes */
84 NGM_PPPOE_GET_STATUS = 10, /* data in/out */
85 NGM_PPPOE_SESSIONID = 11, /* Session_ID for informational purposes */
86 NGM_PPPOE_SETMODE = 12, /* set to standard or 3Com mode */
87 NGM_PPPOE_GETMODE = 13, /* see current mode */
88};
89
90/***********************
91 * Structures passed in the various netgraph command messages.
92 ***********************/
93/* This structure is returned by the NGM_PPPOE_GET_STATUS command */
94struct ngpppoestat {
95 u_int packets_in; /* packets in from ethernet */
96 u_int packets_out; /* packets out towards ethernet */
97};
98
99/* Keep this in sync with the above structure definition */
100#define NG_PPPOESTAT_TYPE_INFO { \
101 { "packets_in", &ng_parse_uint_type }, \
102 { "packets_out", &ng_parse_uint_type }, \
103 { NULL } \
104}
105
106/*
107 * When this structure is accepted by the NGM_PPPOE_CONNECT command :
108 * The data field is MANDATORY.
109 * The session sends out a PADI request for the named service.
110 *
111 *
112 * When this structure is accepted by the NGM_PPPOE_LISTEN command.
113 * If no service is given this is assumed to accept ALL PADI requests.
114 * This may at some time take a regexp expression, but not yet.
115 * Matching PADI requests will be passed up the named hook.
116 *
117 *
118 * When this structure is accepted by the NGM_PPPOE_OFFER command:
119 * The AC-NAme field is set from that given and a PADI
120 * packet is expected to arrive from the session control daemon, on the
121 * named hook. The session will then issue the appropriate PADO
122 * and begin negotiation.
123 */
124struct ngpppoe_init_data {
125 char hook[NG_HOOKSIZ]; /* hook to monitor on */
126 u_int16_t data_len; /* Length of the service name */
|
127 char data[0]; /* init data goes here */
| 127 char data[]; /* init data goes here */
|
128};
129
130/* Keep this in sync with the above structure definition */
131#define NG_PPPOE_INIT_DATA_TYPE_INFO { \
132 { "hook", &ng_parse_hookbuf_type }, \
133 { "data", &ng_parse_sizedstring_type }, \
134 { NULL } \
135}
136
137/*
138 * This structure is used by the asychronous success and failure messages.
139 * (to report which hook has failed or connected). The message is sent
140 * to whoever requested the connection. (close may use this too).
141 */
142struct ngpppoe_sts {
143 char hook[NG_HOOKSIZ]; /* hook associated with event session */
144};
145
146/* Keep this in sync with the above structure definition */
147#define NG_PPPOE_STS_TYPE_INFO { \
148 { "hook", &ng_parse_hookbuf_type }, \
149 { NULL } \
150}
151
152
153/********************************************************************
154 * Constants and definitions specific to pppoe
155 ********************************************************************/
156
157#define PPPOE_TIMEOUT_LIMIT 64
158#define PPPOE_OFFER_TIMEOUT 16
159#define PPPOE_INITIAL_TIMEOUT 2
160
161/* Codes to identify message types */
162#define PADI_CODE 0x09
163#define PADO_CODE 0x07
164#define PADR_CODE 0x19
165#define PADS_CODE 0x65
166#define PADT_CODE 0xa7
167
168/* Tag identifiers */
169#if BYTE_ORDER == BIG_ENDIAN
170#define PTT_EOL (0x0000)
171#define PTT_SRV_NAME (0x0101)
172#define PTT_AC_NAME (0x0102)
173#define PTT_HOST_UNIQ (0x0103)
174#define PTT_AC_COOKIE (0x0104)
175#define PTT_VENDOR (0x0105)
176#define PTT_RELAY_SID (0x0110)
177#define PTT_SRV_ERR (0x0201)
178#define PTT_SYS_ERR (0x0202)
179#define PTT_GEN_ERR (0x0203)
180
181#define ETHERTYPE_PPPOE_DISC 0x8863 /* pppoe discovery packets */
182#define ETHERTYPE_PPPOE_SESS 0x8864 /* pppoe session packets */
183#define ETHERTYPE_PPPOE_STUPID_DISC 0x3c12 /* pppoe discovery packets 3com? */
184#define ETHERTYPE_PPPOE_STUPID_SESS 0x3c13 /* pppoe session packets 3com? */
185#else
186#define PTT_EOL (0x0000)
187#define PTT_SRV_NAME (0x0101)
188#define PTT_AC_NAME (0x0201)
189#define PTT_HOST_UNIQ (0x0301)
190#define PTT_AC_COOKIE (0x0401)
191#define PTT_VENDOR (0x0501)
192#define PTT_RELAY_SID (0x1001)
193#define PTT_SRV_ERR (0x0102)
194#define PTT_SYS_ERR (0x0202)
195#define PTT_GEN_ERR (0x0302)
196
197#define ETHERTYPE_PPPOE_DISC 0x6388 /* pppoe discovery packets */
198#define ETHERTYPE_PPPOE_SESS 0x6488 /* pppoe session packets */
199#define ETHERTYPE_PPPOE_STUPID_DISC 0x123c /* pppoe discovery packets 3com? */
200#define ETHERTYPE_PPPOE_STUPID_SESS 0x133c /* pppoe session packets 3com? */
201#endif
202
203struct pppoe_tag {
204 u_int16_t tag_type;
205 u_int16_t tag_len;
| 128};
129
130/* Keep this in sync with the above structure definition */
131#define NG_PPPOE_INIT_DATA_TYPE_INFO { \
132 { "hook", &ng_parse_hookbuf_type }, \
133 { "data", &ng_parse_sizedstring_type }, \
134 { NULL } \
135}
136
137/*
138 * This structure is used by the asychronous success and failure messages.
139 * (to report which hook has failed or connected). The message is sent
140 * to whoever requested the connection. (close may use this too).
141 */
142struct ngpppoe_sts {
143 char hook[NG_HOOKSIZ]; /* hook associated with event session */
144};
145
146/* Keep this in sync with the above structure definition */
147#define NG_PPPOE_STS_TYPE_INFO { \
148 { "hook", &ng_parse_hookbuf_type }, \
149 { NULL } \
150}
151
152
153/********************************************************************
154 * Constants and definitions specific to pppoe
155 ********************************************************************/
156
157#define PPPOE_TIMEOUT_LIMIT 64
158#define PPPOE_OFFER_TIMEOUT 16
159#define PPPOE_INITIAL_TIMEOUT 2
160
161/* Codes to identify message types */
162#define PADI_CODE 0x09
163#define PADO_CODE 0x07
164#define PADR_CODE 0x19
165#define PADS_CODE 0x65
166#define PADT_CODE 0xa7
167
168/* Tag identifiers */
169#if BYTE_ORDER == BIG_ENDIAN
170#define PTT_EOL (0x0000)
171#define PTT_SRV_NAME (0x0101)
172#define PTT_AC_NAME (0x0102)
173#define PTT_HOST_UNIQ (0x0103)
174#define PTT_AC_COOKIE (0x0104)
175#define PTT_VENDOR (0x0105)
176#define PTT_RELAY_SID (0x0110)
177#define PTT_SRV_ERR (0x0201)
178#define PTT_SYS_ERR (0x0202)
179#define PTT_GEN_ERR (0x0203)
180
181#define ETHERTYPE_PPPOE_DISC 0x8863 /* pppoe discovery packets */
182#define ETHERTYPE_PPPOE_SESS 0x8864 /* pppoe session packets */
183#define ETHERTYPE_PPPOE_STUPID_DISC 0x3c12 /* pppoe discovery packets 3com? */
184#define ETHERTYPE_PPPOE_STUPID_SESS 0x3c13 /* pppoe session packets 3com? */
185#else
186#define PTT_EOL (0x0000)
187#define PTT_SRV_NAME (0x0101)
188#define PTT_AC_NAME (0x0201)
189#define PTT_HOST_UNIQ (0x0301)
190#define PTT_AC_COOKIE (0x0401)
191#define PTT_VENDOR (0x0501)
192#define PTT_RELAY_SID (0x1001)
193#define PTT_SRV_ERR (0x0102)
194#define PTT_SYS_ERR (0x0202)
195#define PTT_GEN_ERR (0x0302)
196
197#define ETHERTYPE_PPPOE_DISC 0x6388 /* pppoe discovery packets */
198#define ETHERTYPE_PPPOE_SESS 0x6488 /* pppoe session packets */
199#define ETHERTYPE_PPPOE_STUPID_DISC 0x123c /* pppoe discovery packets 3com? */
200#define ETHERTYPE_PPPOE_STUPID_SESS 0x133c /* pppoe session packets 3com? */
201#endif
202
203struct pppoe_tag {
204 u_int16_t tag_type;
205 u_int16_t tag_len;
|
206 char tag_data[0];
| 206 char tag_data[];
|
207}__packed;
208
209struct pppoe_hdr{
210 u_int8_t ver:4;
211 u_int8_t type:4;
212 u_int8_t code;
213 u_int16_t sid;
214 u_int16_t length;
| 207}__packed;
208
209struct pppoe_hdr{
210 u_int8_t ver:4;
211 u_int8_t type:4;
212 u_int8_t code;
213 u_int16_t sid;
214 u_int16_t length;
|
215 struct pppoe_tag tag[0];
| 215 struct pppoe_tag tag[];
|
216}__packed;
217
218
219struct pppoe_full_hdr {
220 struct ether_header eh;
221 struct pppoe_hdr ph;
222}__packed;
223
224union packet {
225 struct pppoe_full_hdr pkt_header;
226 u_int8_t bytes[2048];
227};
228
229struct datatag {
230 struct pppoe_tag hdr;
231 u_int8_t data[PPPOE_SERVICE_NAME_SIZE];
232};
233
234
235/*
236 * Define the order in which we will place tags in packets
237 * this may be ignored
238 */
239/* for PADI */
240#define TAGI_SVC 0
241#define TAGI_HUNIQ 1
242/* for PADO */
243#define TAGO_ACNAME 0
244#define TAGO_SVC 1
245#define TAGO_COOKIE 2
246#define TAGO_HUNIQ 3
247/* for PADR */
248#define TAGR_SVC 0
249#define TAGR_HUNIQ 1
250#define TAGR_COOKIE 2
251/* for PADS */
252#define TAGS_ACNAME 0
253#define TAGS_SVC 1
254#define TAGS_COOKIE 2
255#define TAGS_HUNIQ 3
256/* for PADT */
257
258#endif /* _NETGRAPH_NG_PPPOE_H_ */
259
| 216}__packed;
217
218
219struct pppoe_full_hdr {
220 struct ether_header eh;
221 struct pppoe_hdr ph;
222}__packed;
223
224union packet {
225 struct pppoe_full_hdr pkt_header;
226 u_int8_t bytes[2048];
227};
228
229struct datatag {
230 struct pppoe_tag hdr;
231 u_int8_t data[PPPOE_SERVICE_NAME_SIZE];
232};
233
234
235/*
236 * Define the order in which we will place tags in packets
237 * this may be ignored
238 */
239/* for PADI */
240#define TAGI_SVC 0
241#define TAGI_HUNIQ 1
242/* for PADO */
243#define TAGO_ACNAME 0
244#define TAGO_SVC 1
245#define TAGO_COOKIE 2
246#define TAGO_HUNIQ 3
247/* for PADR */
248#define TAGR_SVC 0
249#define TAGR_HUNIQ 1
250#define TAGR_COOKIE 2
251/* for PADS */
252#define TAGS_ACNAME 0
253#define TAGS_SVC 1
254#define TAGS_COOKIE 2
255#define TAGS_HUNIQ 3
256/* for PADT */
257
258#endif /* _NETGRAPH_NG_PPPOE_H_ */
259
|