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