ng_pppoe.h revision 72946
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 72946 2001-02-23 16:34:22Z julian $ 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 ********************************************************************/ 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_GET_STATUS 79}; 80 81/*********************** 82 * Structures passed in the various netgraph command messages. 83 ***********************/ 84/* This structure is returned by the NGM_PPPOE_GET_STATUS command */ 85struct ngpppoestat { 86 u_int packets_in; /* packets in from ethernet */ 87 u_int packets_out; /* packets out towards ethernet */ 88}; 89 90/* Keep this in sync with the above structure definition */ 91#define NG_PPPOESTAT_TYPE_INFO { \ 92 { \ 93 { "packets_in", &ng_parse_uint_type }, \ 94 { "packets_out", &ng_parse_uint_type }, \ 95 { NULL } \ 96 } \ 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_HOOKLEN + 1]; /* 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 { \ 126 { "hook", &ng_parse_hookbuf_type }, \ 127 { "data", &ng_parse_sizedstring_type }, \ 128 { NULL } \ 129 } \ 130} 131 132/* 133 * This structure is used by the asychronous success and failure messages. 134 * (to report which hook has failed or connected). The message is sent 135 * to whoever requested the connection. (close may use this too). 136 */ 137struct ngpppoe_sts { 138 char hook[NG_HOOKLEN + 1]; /* hook associated with event session */ 139}; 140 141/* Keep this in sync with the above structure definition */ 142#define NG_PPPOE_STS_TYPE_INFO { \ 143 { \ 144 { "hook", &ng_parse_hookbuf_type }, \ 145 { NULL } \ 146 } \ 147} 148 149 150/******************************************************************** 151 * Constants and definitions specific to pppoe 152 ********************************************************************/ 153 154#define PPPOE_TIMEOUT_LIMIT 64 155#define PPPOE_OFFER_TIMEOUT 16 156#define PPPOE_INITIAL_TIMEOUT 2 157 158/* Codes to identify message types */ 159#define PADI_CODE 0x09 160#define PADO_CODE 0x07 161#define PADR_CODE 0x19 162#define PADS_CODE 0x65 163#define PADT_CODE 0xa7 164 165/* Tag identifiers */ 166#if BYTE_ORDER == BIG_ENDIAN 167#define PTT_EOL (0x0000) 168#define PTT_SRV_NAME (0x0101) 169#define PTT_AC_NAME (0x0102) 170#define PTT_HOST_UNIQ (0x0103) 171#define PTT_AC_COOKIE (0x0104) 172#define PTT_VENDOR (0x0105) 173#define PTT_RELAY_SID (0x0106) 174#define PTT_SRV_ERR (0x0201) 175#define PTT_SYS_ERR (0x0202) 176#define PTT_GEN_ERR (0x0203) 177 178#define ETHERTYPE_PPPOE_DISC 0x8863 /* pppoe discovery packets */ 179#define ETHERTYPE_PPPOE_SESS 0x8864 /* pppoe session packets */ 180#define ETHERTYPE_PPPOE_STUPID_DISC 0x3c12 /* pppoe discovery packets 3com? */ 181#define ETHERTYPE_PPPOE_STUPID_SESS 0x3c13 /* pppoe session packets 3com? */ 182#else 183#define PTT_EOL (0x0000) 184#define PTT_SRV_NAME (0x0101) 185#define PTT_AC_NAME (0x0201) 186#define PTT_HOST_UNIQ (0x0301) 187#define PTT_AC_COOKIE (0x0401) 188#define PTT_VENDOR (0x0501) 189#define PTT_RELAY_SID (0x0601) 190#define PTT_SRV_ERR (0x0102) 191#define PTT_SYS_ERR (0x0202) 192#define PTT_GEN_ERR (0x0302) 193 194#define ETHERTYPE_PPPOE_DISC 0x6388 /* pppoe discovery packets */ 195#define ETHERTYPE_PPPOE_SESS 0x6488 /* pppoe session packets */ 196#define ETHERTYPE_PPPOE_STUPID_DISC 0x123c /* pppoe discovery packets 3com? */ 197#define ETHERTYPE_PPPOE_STUPID_SESS 0x133c /* pppoe session packets 3com? */ 198#endif 199 200struct pppoe_tag { 201 u_int16_t tag_type; 202 u_int16_t tag_len; 203 char tag_data[0]; 204}__attribute ((packed)); 205 206struct pppoe_hdr{ 207 u_int8_t ver:4; 208 u_int8_t type:4; 209 u_int8_t code; 210 u_int16_t sid; 211 u_int16_t length; 212 struct pppoe_tag tag[0]; 213}__attribute__ ((packed)); 214 215 216struct pppoe_full_hdr { 217 struct ether_header eh; 218 struct pppoe_hdr ph; 219}__attribute__ ((packed)); 220 221union packet { 222 struct pppoe_full_hdr pkt_header; 223 u_int8_t bytes[2048]; 224}; 225 226struct datatag { 227 struct pppoe_tag hdr; 228 u_int8_t data[PPPOE_SERVICE_NAME_SIZE]; 229}; 230 231 232/* 233 * Define the order in which we will place tags in packets 234 * this may be ignored 235 */ 236/* for PADI */ 237#define TAGI_SVC 0 238#define TAGI_HUNIQ 1 239/* for PADO */ 240#define TAGO_ACNAME 0 241#define TAGO_SVC 1 242#define TAGO_COOKIE 2 243#define TAGO_HUNIQ 3 244/* for PADR */ 245#define TAGR_SVC 0 246#define TAGR_HUNIQ 1 247#define TAGR_COOKIE 2 248/* for PADS */ 249#define TAGS_ACNAME 0 250#define TAGS_SVC 1 251#define TAGS_COOKIE 2 252#define TAGS_HUNIQ 3 253/* for PADT */ 254 255#endif /* _NETGRAPH_PPPOE_H_ */ 256 257