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: releng/6.1/sys/netgraph/ng_pppoe.h 155096 2006-01-31 15:36:11Z glebius $
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_3COM "3Com"
69 #define NG_PPPOE_NONSTANDARD NG_PPPOE_3COM
70 #define NG_PPPOE_DLINK "D-Link"
71
72 /**********************************************************************
73 * Netgraph commands understood by this node type.
74 * FAIL, SUCCESS, CLOSE and ACNAME are sent by the node rather than received.
75 ********************************************************************/
76 enum cmd {
77 NGM_PPPOE_SET_FLAG = 1,
78 NGM_PPPOE_CONNECT = 2, /* Client, Try find this service */
79 NGM_PPPOE_LISTEN = 3, /* Server, Await a request for this service */
80 NGM_PPPOE_OFFER = 4, /* Server, hook X should respond (*) */
81 NGM_PPPOE_SUCCESS = 5, /* State machine connected */
82 NGM_PPPOE_FAIL = 6, /* State machine could not connect */
83 NGM_PPPOE_CLOSE = 7, /* Session closed down */
84 NGM_PPPOE_SERVICE = 8, /* additional Service to advertise (in PADO) */
85 NGM_PPPOE_ACNAME = 9, /* AC_NAME for informational purposes */
86 NGM_PPPOE_GET_STATUS = 10, /* data in/out */
87 NGM_PPPOE_SESSIONID = 11, /* Session_ID for informational purposes */
88 NGM_PPPOE_SETMODE = 12, /* set to standard or 3Com mode */
89 NGM_PPPOE_GETMODE = 13, /* see current mode */
90 };
91
92 /***********************
93 * Structures passed in the various netgraph command messages.
94 ***********************/
95 /* This structure is returned by the NGM_PPPOE_GET_STATUS command */
96 struct ngpppoestat {
97 u_int packets_in; /* packets in from ethernet */
98 u_int packets_out; /* packets out towards ethernet */
99 };
100
101 /* Keep this in sync with the above structure definition */
102 #define NG_PPPOESTAT_TYPE_INFO { \
103 { "packets_in", &ng_parse_uint_type }, \
104 { "packets_out", &ng_parse_uint_type }, \
105 { NULL } \
106 }
107
108 /*
109 * When this structure is accepted by the NGM_PPPOE_CONNECT command :
110 * The data field is MANDATORY.
111 * The session sends out a PADI request for the named service.
112 *
113 *
114 * When this structure is accepted by the NGM_PPPOE_LISTEN command.
115 * If no service is given this is assumed to accept ALL PADI requests.
116 * This may at some time take a regexp expression, but not yet.
117 * Matching PADI requests will be passed up the named hook.
118 *
119 *
120 * When this structure is accepted by the NGM_PPPOE_OFFER command:
121 * The AC-NAme field is set from that given and a PADI
122 * packet is expected to arrive from the session control daemon, on the
123 * named hook. The session will then issue the appropriate PADO
124 * and begin negotiation.
125 */
126 struct ngpppoe_init_data {
127 char hook[NG_HOOKSIZ]; /* hook to monitor on */
128 u_int16_t data_len; /* Length of the service name */
129 char data[]; /* init data goes here */
130 };
131
132 /* Keep this in sync with the above structure definition */
133 #define NG_PPPOE_INIT_DATA_TYPE_INFO { \
134 { "hook", &ng_parse_hookbuf_type }, \
135 { "data", &ng_parse_sizedstring_type }, \
136 { NULL } \
137 }
138
139 /*
140 * This structure is used by the asychronous success and failure messages.
141 * (to report which hook has failed or connected). The message is sent
142 * to whoever requested the connection. (close may use this too).
143 */
144 struct ngpppoe_sts {
145 char hook[NG_HOOKSIZ]; /* hook associated with event session */
146 };
147
148 /* Keep this in sync with the above structure definition */
149 #define NG_PPPOE_STS_TYPE_INFO { \
150 { "hook", &ng_parse_hookbuf_type }, \
151 { NULL } \
152 }
153
154
155 /********************************************************************
156 * Constants and definitions specific to pppoe
157 ********************************************************************/
158
159 #define PPPOE_TIMEOUT_LIMIT 64
160 #define PPPOE_OFFER_TIMEOUT 16
161 #define PPPOE_INITIAL_TIMEOUT 2
162
163 /* Codes to identify message types */
164 #define PADI_CODE 0x09
165 #define PADO_CODE 0x07
166 #define PADR_CODE 0x19
167 #define PADS_CODE 0x65
168 #define PADT_CODE 0xa7
169
170 /* Tag identifiers */
171 #if BYTE_ORDER == BIG_ENDIAN
172 #define PTT_EOL (0x0000)
173 #define PTT_SRV_NAME (0x0101)
174 #define PTT_AC_NAME (0x0102)
175 #define PTT_HOST_UNIQ (0x0103)
176 #define PTT_AC_COOKIE (0x0104)
177 #define PTT_VENDOR (0x0105)
178 #define PTT_RELAY_SID (0x0110)
179 #define PTT_SRV_ERR (0x0201)
180 #define PTT_SYS_ERR (0x0202)
181 #define PTT_GEN_ERR (0x0203)
182
183 #define ETHERTYPE_PPPOE_DISC 0x8863 /* pppoe discovery packets */
184 #define ETHERTYPE_PPPOE_SESS 0x8864 /* pppoe session packets */
185 #define ETHERTYPE_PPPOE_3COM_DISC 0x3c12 /* pppoe discovery packets 3com? */
186 #define ETHERTYPE_PPPOE_3COM_SESS 0x3c13 /* pppoe session packets 3com? */
187 #else
188 #define PTT_EOL (0x0000)
189 #define PTT_SRV_NAME (0x0101)
190 #define PTT_AC_NAME (0x0201)
191 #define PTT_HOST_UNIQ (0x0301)
192 #define PTT_AC_COOKIE (0x0401)
193 #define PTT_VENDOR (0x0501)
194 #define PTT_RELAY_SID (0x1001)
195 #define PTT_SRV_ERR (0x0102)
196 #define PTT_SYS_ERR (0x0202)
197 #define PTT_GEN_ERR (0x0302)
198
199 #define ETHERTYPE_PPPOE_DISC 0x6388 /* pppoe discovery packets */
200 #define ETHERTYPE_PPPOE_SESS 0x6488 /* pppoe session packets */
201 #define ETHERTYPE_PPPOE_3COM_DISC 0x123c /* pppoe discovery packets 3com? */
202 #define ETHERTYPE_PPPOE_3COM_SESS 0x133c /* pppoe session packets 3com? */
203 #endif
204
205 struct pppoe_tag {
206 u_int16_t tag_type;
207 u_int16_t tag_len;
208 char tag_data[];
209 }__packed;
210
211 struct pppoe_hdr{
212 u_int8_t ver:4;
213 u_int8_t type:4;
214 u_int8_t code;
215 u_int16_t sid;
216 u_int16_t length;
217 struct pppoe_tag tag[];
218 }__packed;
219
220
221 struct pppoe_full_hdr {
222 struct ether_header eh;
223 struct pppoe_hdr ph;
224 }__packed;
225
226 union packet {
227 struct pppoe_full_hdr pkt_header;
228 u_int8_t bytes[2048];
229 };
230
231 struct datatag {
232 struct pppoe_tag hdr;
233 u_int8_t data[PPPOE_SERVICE_NAME_SIZE];
234 };
235
236
237 /*
238 * Define the order in which we will place tags in packets
239 * this may be ignored
240 */
241 /* for PADI */
242 #define TAGI_SVC 0
243 #define TAGI_HUNIQ 1
244 /* for PADO */
245 #define TAGO_ACNAME 0
246 #define TAGO_SVC 1
247 #define TAGO_COOKIE 2
248 #define TAGO_HUNIQ 3
249 /* for PADR */
250 #define TAGR_SVC 0
251 #define TAGR_HUNIQ 1
252 #define TAGR_COOKIE 2
253 /* for PADS */
254 #define TAGS_ACNAME 0
255 #define TAGS_SVC 1
256 #define TAGS_COOKIE 2
257 #define TAGS_HUNIQ 3
258 /* for PADT */
259
260 #endif /* _NETGRAPH_NG_PPPOE_H_ */
261
Cache object: 6435833ad48534ef8b33c8d1a5f5d089
|