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$ 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 #define NGM_PPPOE_SETMAXP_COOKIE 1441624322 55 #define NGM_PPPOE_PADM_COOKIE 1488405822 56 57 #define PPPOE_SERVICE_NAME_SIZE 64 /* for now */ 58 #define PPPOE_PADM_VALUE_SIZE 128 /* for now */ 59 60 /* Hook names */ 61 #define NG_PPPOE_HOOK_ETHERNET "ethernet" 62 #define NG_PPPOE_HOOK_DEBUG "debug" 63 64 /* Mode names */ 65 #define NG_PPPOE_STANDARD "standard" 66 #define NG_PPPOE_3COM "3Com" 67 #define NG_PPPOE_NONSTANDARD NG_PPPOE_3COM 68 #define NG_PPPOE_DLINK "D-Link" 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 ********************************************************************/ 74 enum 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 compat modes */ 87 NGM_PPPOE_GETMODE = 13, /* see current mode */ 88 NGM_PPPOE_SETENADDR = 14, /* set Ethernet address */ 89 NGM_PPPOE_SETMAXP = 15, /* Set PPP-Max-Payload value */ 90 NGM_PPPOE_SEND_HURL = 16, /* Send PADM HURL message */ 91 NGM_PPPOE_HURL = 17, /* HURL for informational purposes */ 92 NGM_PPPOE_SEND_MOTM = 18, /* Send PADM MOTM message */ 93 NGM_PPPOE_MOTM = 19 /* MOTM for informational purposes */ 94 }; 95 96 /*********************** 97 * Structures passed in the various netgraph command messages. 98 ***********************/ 99 /* This structure is returned by the NGM_PPPOE_GET_STATUS command */ 100 struct ngpppoestat { 101 u_int packets_in; /* packets in from ethernet */ 102 u_int packets_out; /* packets out towards ethernet */ 103 }; 104 105 /* Keep this in sync with the above structure definition */ 106 #define NG_PPPOESTAT_TYPE_INFO { \ 107 { "packets_in", &ng_parse_uint_type }, \ 108 { "packets_out", &ng_parse_uint_type }, \ 109 { NULL } \ 110 } 111 112 /* 113 * When this structure is accepted by the NGM_PPPOE_CONNECT command : 114 * The data field is MANDATORY. 115 * The session sends out a PADI request for the named service. 116 * 117 * 118 * When this structure is accepted by the NGM_PPPOE_LISTEN command. 119 * If no service is given this is assumed to accept ALL PADI requests. 120 * This may at some time take a regexp expression, but not yet. 121 * Matching PADI requests will be passed up the named hook. 122 * 123 * 124 * When this structure is accepted by the NGM_PPPOE_OFFER command: 125 * The AC-NAme field is set from that given and a PADI 126 * packet is expected to arrive from the session control daemon, on the 127 * named hook. The session will then issue the appropriate PADO 128 * and begin negotiation. 129 */ 130 struct ngpppoe_init_data { 131 char hook[NG_HOOKSIZ]; /* hook to monitor on */ 132 u_int16_t data_len; /* Length of the service name */ 133 char data[]; /* init data goes here */ 134 }; 135 136 /* Keep this in sync with the above structure definition */ 137 #define NG_PPPOE_INIT_DATA_TYPE_INFO { \ 138 { "hook", &ng_parse_hookbuf_type }, \ 139 { "data", &ng_parse_sizedstring_type }, \ 140 { NULL } \ 141 } 142 143 /* 144 * This structure is used by the asychronous success and failure messages. 145 * (to report which hook has failed or connected). The message is sent 146 * to whoever requested the connection. (close may use this too). 147 */ 148 struct ngpppoe_sts { 149 char hook[NG_HOOKSIZ]; /* hook associated with event session */ 150 }; 151 152 /* Keep this in sync with the above structure definition */ 153 #define NG_PPPOE_STS_TYPE_INFO { \ 154 { "hook", &ng_parse_hookbuf_type }, \ 155 { NULL } \ 156 } 157 158 /* 159 * This structure is used to send PPP-Max-Payload value from server to client. 160 */ 161 struct ngpppoe_maxp { 162 char hook[NG_HOOKSIZ]; /* hook associated with event session */ 163 uint16_t data; 164 }; 165 166 /* 167 * This structure is used to send PADM messages from server to client. 168 */ 169 struct ngpppoe_padm { 170 char msg[PPPOE_PADM_VALUE_SIZE]; 171 }; 172 173 /******************************************************************** 174 * Constants and definitions specific to pppoe 175 ********************************************************************/ 176 177 #define PPPOE_TIMEOUT_LIMIT 64 178 #define PPPOE_OFFER_TIMEOUT 16 179 #define PPPOE_INITIAL_TIMEOUT 2 180 181 /* Codes to identify message types */ 182 #define PADI_CODE 0x09 183 #define PADO_CODE 0x07 184 #define PADR_CODE 0x19 185 #define PADS_CODE 0x65 186 #define PADT_CODE 0xa7 187 #define PADM_CODE 0xd3 188 189 /* Tag identifiers */ 190 #if BYTE_ORDER == BIG_ENDIAN 191 #define PTT_EOL (0x0000) 192 #define PTT_SRV_NAME (0x0101) 193 #define PTT_AC_NAME (0x0102) 194 #define PTT_HOST_UNIQ (0x0103) 195 #define PTT_AC_COOKIE (0x0104) 196 #define PTT_VENDOR (0x0105) 197 #define PTT_RELAY_SID (0x0110) 198 #define PTT_HURL (0x0111) /* PPPoE Extensions (CARREL) */ 199 #define PTT_MOTM (0x0112) /* PPPoE Extensions (CARREL) */ 200 #define PTT_MAX_PAYL (0x0120) /* PPP-Max-Payload (RFC4638) */ 201 #define PTT_SRV_ERR (0x0201) 202 #define PTT_SYS_ERR (0x0202) 203 #define PTT_GEN_ERR (0x0203) 204 205 #define ETHERTYPE_PPPOE_DISC 0x8863 /* pppoe discovery packets */ 206 #define ETHERTYPE_PPPOE_SESS 0x8864 /* pppoe session packets */ 207 #define ETHERTYPE_PPPOE_3COM_DISC 0x3c12 /* pppoe discovery packets 3com? */ 208 #define ETHERTYPE_PPPOE_3COM_SESS 0x3c13 /* pppoe session packets 3com? */ 209 #else 210 #define PTT_EOL (0x0000) 211 #define PTT_SRV_NAME (0x0101) 212 #define PTT_AC_NAME (0x0201) 213 #define PTT_HOST_UNIQ (0x0301) 214 #define PTT_AC_COOKIE (0x0401) 215 #define PTT_VENDOR (0x0501) 216 #define PTT_RELAY_SID (0x1001) 217 #define PTT_HURL (0x1101) /* PPPoE Extensions (CARREL) */ 218 #define PTT_MOTM (0x1201) /* PPPoE Extensions (CARREL) */ 219 #define PTT_MAX_PAYL (0x2001) /* PPP-Max-Payload (RFC4638) */ 220 #define PTT_SRV_ERR (0x0102) 221 #define PTT_SYS_ERR (0x0202) 222 #define PTT_GEN_ERR (0x0302) 223 224 #define ETHERTYPE_PPPOE_DISC 0x6388 /* pppoe discovery packets */ 225 #define ETHERTYPE_PPPOE_SESS 0x6488 /* pppoe session packets */ 226 #define ETHERTYPE_PPPOE_3COM_DISC 0x123c /* pppoe discovery packets 3com? */ 227 #define ETHERTYPE_PPPOE_3COM_SESS 0x133c /* pppoe session packets 3com? */ 228 #endif 229 230 struct pppoe_tag { 231 u_int16_t tag_type; 232 u_int16_t tag_len; 233 }__packed; 234 235 struct pppoe_hdr{ 236 u_int8_t ver:4; 237 u_int8_t type:4; 238 u_int8_t code; 239 u_int16_t sid; 240 u_int16_t length; 241 }__packed; 242 243 struct pppoe_full_hdr { 244 struct ether_header eh; 245 struct pppoe_hdr ph; 246 }__packed; 247 248 union packet { 249 struct pppoe_full_hdr pkt_header; 250 u_int8_t bytes[2048]; 251 }; 252 253 struct datatag { 254 struct pppoe_tag hdr; 255 u_int8_t data[PPPOE_SERVICE_NAME_SIZE]; 256 }; 257 258 struct maxptag { 259 struct pppoe_tag hdr; 260 uint16_t data; 261 }; 262 263 /* 264 * Define the order in which we will place tags in packets 265 * this may be ignored 266 */ 267 /* for PADI */ 268 #define TAGI_SVC 0 269 #define TAGI_HUNIQ 1 270 /* for PADO */ 271 #define TAGO_ACNAME 0 272 #define TAGO_SVC 1 273 #define TAGO_COOKIE 2 274 #define TAGO_HUNIQ 3 275 /* for PADR */ 276 #define TAGR_SVC 0 277 #define TAGR_HUNIQ 1 278 #define TAGR_COOKIE 2 279 /* for PADS */ 280 #define TAGS_ACNAME 0 281 #define TAGS_SVC 1 282 #define TAGS_COOKIE 2 283 #define TAGS_HUNIQ 3 284 /* for PADT */ 285 286 #endif /* _NETGRAPH_NG_PPPOE_H_ */ 287