sys/netgraph/pppoe/ng_pppoe.h

   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: src/sys/netgraph/ng_pppoe.h,v 1.7.2.5 2002/06/17 02:19:06 brian Exp $
  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, CLOSE and ACNAME 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_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 */
  87 struct ngpppoestat {
  88         u_int   packets_in;     /* packets in from ethernet */
  89         u_int   packets_out;    /* packets out towards ethernet */
  90 };
  91
  92 /*
  93  * When this structure is accepted by the NGM_PPPOE_CONNECT command :
  94  * The data field is MANDATORY.
  95  * The session sends out a PADI request for the named service.
  96  *
  97  *
  98  * When this structure is accepted by the NGM_PPPOE_LISTEN command.
  99  * If no service is given this is assumed to accept ALL PADI requests.
 100  * This may at some time take a regexp expression, but not yet.
 101  * Matching PADI requests will be passed up the named hook.
 102  *
 103  *
 104  * When this structure is accepted by the NGM_PPPOE_OFFER command:
 105  * The AC-NAme field is set from that given and a PADI
 106  * packet is expected to arrive from the session control daemon, on the
 107  * named hook. The session will then issue the appropriate PADO
 108  * and begin negotiation.
 109  */
 110 struct ngpppoe_init_data {
 111         char    hook[NG_HOOKLEN + 1];   /* hook to monitor on */
 112         u_int16_t       data_len;               /* Length of the service name */
 113         char    data[0];                /* init data goes here */
 114 };
 115
 116 /*
 117  * This structure is used by the asychronous success and failure messages.
 118  * (to report which hook has failed or connected). The message is sent
 119  * to whoever requested the connection. (close may use this too).
 120  */
 121 struct ngpppoe_sts {
 122         char    hook[NG_HOOKLEN + 1]; /* hook associated with event session */
 123 };
 124
 125
 126 /********************************************************************
 127  * Constants and definitions specific to pppoe
 128  ********************************************************************/
 129
 130 #define PPPOE_TIMEOUT_LIMIT 64
 131 #define PPPOE_OFFER_TIMEOUT 16
 132 #define PPPOE_INITIAL_TIMEOUT 2
 133
 134 /* Codes to identify message types */
 135 #define PADI_CODE       0x09
 136 #define PADO_CODE       0x07
 137 #define PADR_CODE       0x19
 138 #define PADS_CODE       0x65
 139 #define PADT_CODE       0xa7
 140
 141 /* Tag identifiers */
 142 #if BYTE_ORDER == BIG_ENDIAN
 143 #define PTT_EOL         (0x0000)
 144 #define PTT_SRV_NAME    (0x0101)
 145 #define PTT_AC_NAME     (0x0102)
 146 #define PTT_HOST_UNIQ   (0x0103)
 147 #define PTT_AC_COOKIE   (0x0104)
 148 #define PTT_VENDOR      (0x0105)
 149 #define PTT_RELAY_SID   (0x0106)
 150 #define PTT_SRV_ERR     (0x0201)
 151 #define PTT_SYS_ERR     (0x0202)
 152 #define PTT_GEN_ERR     (0x0203)
 153
 154 #define ETHERTYPE_PPPOE_DISC    0x8863  /* pppoe discovery packets     */
 155 #define ETHERTYPE_PPPOE_SESS    0x8864  /* pppoe session packets       */
 156 #define ETHERTYPE_PPPOE_STUPID_DISC 0x3c12 /* pppoe discovery packets 3com? */
 157 #define ETHERTYPE_PPPOE_STUPID_SESS 0x3c13 /* pppoe session packets   3com? */
 158 #else
 159 #define PTT_EOL         (0x0000)
 160 #define PTT_SRV_NAME    (0x0101)
 161 #define PTT_AC_NAME     (0x0201)
 162 #define PTT_HOST_UNIQ   (0x0301)
 163 #define PTT_AC_COOKIE   (0x0401)
 164 #define PTT_VENDOR      (0x0501)
 165 #define PTT_RELAY_SID   (0x0601)
 166 #define PTT_SRV_ERR     (0x0102)
 167 #define PTT_SYS_ERR     (0x0202)
 168 #define PTT_GEN_ERR     (0x0302)
 169
 170 #define ETHERTYPE_PPPOE_DISC    0x6388  /* pppoe discovery packets     */
 171 #define ETHERTYPE_PPPOE_SESS    0x6488  /* pppoe session packets       */
 172 #define ETHERTYPE_PPPOE_STUPID_DISC 0x123c /* pppoe discovery packets 3com? */
 173 #define ETHERTYPE_PPPOE_STUPID_SESS 0x133c /* pppoe session packets   3com? */
 174 #endif
 175
 176 struct pppoe_tag {
 177         u_int16_t tag_type;
 178         u_int16_t tag_len;
 179         char tag_data[0];
 180 }__attribute ((packed));
 181
 182 struct pppoe_hdr{
 183         u_int8_t ver:4;
 184         u_int8_t type:4;
 185         u_int8_t code;
 186         u_int16_t sid;
 187         u_int16_t length;
 188         struct pppoe_tag tag[0];
 189 }__attribute__ ((packed));
 190
 191
 192 struct pppoe_full_hdr {
 193         struct  ether_header eh;
 194         struct pppoe_hdr ph;
 195 }__attribute__ ((packed));
 196
 197 union   packet {
 198         struct pppoe_full_hdr   pkt_header;
 199         u_int8_t        bytes[2048];
 200 };
 201
 202 struct datatag {
 203         struct pppoe_tag hdr;
 204         u_int8_t        data[PPPOE_SERVICE_NAME_SIZE];
 205 };
 206
 207
 208 /*
 209  * Define the order in which we will place tags in packets
 210  * this may be ignored
 211  */
 212 /* for PADI */
 213 #define TAGI_SVC 0
 214 #define TAGI_HUNIQ 1
 215 /* for PADO */
 216 #define TAGO_ACNAME 0
 217 #define TAGO_SVC 1
 218 #define TAGO_COOKIE 2
 219 #define TAGO_HUNIQ 3
 220 /* for PADR */
 221 #define TAGR_SVC 0
 222 #define TAGR_HUNIQ 1
 223 #define TAGR_COOKIE 2
 224 /* for PADS */
 225 #define TAGS_ACNAME 0
 226 #define TAGS_SVC 1
 227 #define TAGS_COOKIE 2
 228 #define TAGS_HUNIQ 3
 229 /* for PADT */
 230
 231 #endif /* _NETGRAPH_PPPOE_H_ */
 232