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