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