pppd/plugins/rp-pppoe/pppoe.h

   1 /***********************************************************************
   2 *
   3 * pppoe.h
   4 *
   5 * Declaration of various PPPoE constants
   6 *
   7 * Copyright (C) 2000 Roaring Penguin Software Inc.
   8 *
   9 * This program may be distributed according to the terms of the GNU
  10 * General Public License, version 2 or (at your option) any later version.
  11 *
  12 * $Id: pppoe.h,v 1.4 2008/06/15 04:35:50 paulus Exp $
  13 *
  14 ***********************************************************************/
  15
  16 #include "config.h"
  17
  18 #include <stdio.h>              /* For FILE */
  19 #include <sys/types.h>          /* For pid_t */
  20
  21 #include "pppd/pppd.h"          /* For error */
  22
  23 /* How do we access raw Ethernet devices? */
  24 #undef USE_LINUX_PACKET
  25 #undef USE_BPF
  26
  27 #if defined(HAVE_NETPACKET_PACKET_H) || defined(HAVE_LINUX_IF_PACKET_H)
  28 #define USE_LINUX_PACKET 1
  29 #elif defined(HAVE_SYS_DLPI_H)
  30 #define USE_DLPI
  31 #elif defined(HAVE_NET_BPF_H)
  32 #define USE_BPF 1
  33 #endif
  34
  35 /* Sanity check */
  36 #if !defined(USE_BPF) && !defined(USE_LINUX_PACKET) && !defined(USE_DLPI)
  37 #error Unknown method for accessing raw Ethernet frames
  38 #endif
  39
  40 #ifdef HAVE_SYS_CDEFS_H
  41 #include <sys/cdefs.h>
  42 #endif
  43
  44 #ifdef HAVE_SYS_SOCKET_H
  45 #include <sys/socket.h>
  46 #endif
  47
  48 /* This has to be included before Linux 4.8's linux/in.h
  49  * gets dragged in. */
  50 #include <netinet/in.h>
  51
  52 /* Ugly header files on some Linux boxes... */
  53 #if defined(HAVE_LINUX_IF_H)
  54 #include <linux/if.h>
  55 #elif defined(HAVE_NET_IF_H)
  56 #include <net/if.h>
  57 #endif
  58
  59 #ifdef HAVE_NET_IF_TYPES_H
  60 #include <net/if_types.h>
  61 #endif
  62
  63 #define BPF_BUFFER_IS_EMPTY 1
  64 #define BPF_BUFFER_HAS_DATA 0
  65
  66 /* Define various integer types -- assumes a char is 8 bits */
  67 #if SIZEOF_UNSIGNED_SHORT == 2
  68 typedef unsigned short UINT16_t;
  69 #elif SIZEOF_UNSIGNED_INT == 2
  70 typedef unsigned int UINT16_t;
  71 #else
  72 #error Could not find a 16-bit integer type
  73 #endif
  74
  75 #if SIZEOF_UNSIGNED_SHORT == 4
  76 typedef unsigned short UINT32_t;
  77 #elif SIZEOF_UNSIGNED_INT == 4
  78 typedef unsigned int UINT32_t;
  79 #elif SIZEOF_UNSIGNED_LONG == 4
  80 typedef unsigned long UINT32_t;
  81 #else
  82 #error Could not find a 32-bit integer type
  83 #endif
  84
  85 #ifdef HAVE_LINUX_IF_ETHER_H
  86 #include <linux/if_ether.h>
  87 #endif
  88
  89 #ifdef HAVE_NETINET_IF_ETHER_H
  90 #include <sys/types.h>
  91
  92 #ifdef HAVE_SYS_SOCKET_H
  93 #include <sys/socket.h>
  94 #endif
  95 #ifndef HAVE_SYS_DLPI_H
  96 #include <netinet/if_ether.h>
  97 #endif
  98 #endif
  99
 100
 101 /* Ethernet frame types according to RFC 2516 */
 102 #define ETH_PPPOE_DISCOVERY 0x8863
 103 #define ETH_PPPOE_SESSION   0x8864
 104
 105 /* But some brain-dead peers disobey the RFC, so frame types are variables */
 106 extern UINT16_t Eth_PPPOE_Discovery;
 107 extern UINT16_t Eth_PPPOE_Session;
 108
 109 /* PPPoE codes */
 110 #define CODE_PADI           0x09
 111 #define CODE_PADO           0x07
 112 #define CODE_PADR           0x19
 113 #define CODE_PADS           0x65
 114 #define CODE_PADT           0xA7
 115
 116 /* Extensions from draft-carrel-info-pppoe-ext-00 */
 117 /* I do NOT like PADM or PADN, but they are here for completeness */
 118 #define CODE_PADM           0xD3
 119 #define CODE_PADN           0xD4
 120
 121 #define CODE_SESS           0x00
 122
 123 /* PPPoE Tags */
 124 #define TAG_END_OF_LIST        0x0000
 125 #define TAG_SERVICE_NAME       0x0101
 126 #define TAG_AC_NAME            0x0102
 127 #define TAG_HOST_UNIQ          0x0103
 128 #define TAG_AC_COOKIE          0x0104
 129 #define TAG_VENDOR_SPECIFIC    0x0105
 130 #define TAG_RELAY_SESSION_ID   0x0110
 131 #define TAG_PPP_MAX_PAYLOAD    0x0120
 132 #define TAG_SERVICE_NAME_ERROR 0x0201
 133 #define TAG_AC_SYSTEM_ERROR    0x0202
 134 #define TAG_GENERIC_ERROR      0x0203
 135
 136 /* Extensions from draft-carrel-info-pppoe-ext-00 */
 137 /* I do NOT like these tags one little bit */
 138 #define TAG_HURL               0x111
 139 #define TAG_MOTM               0x112
 140 #define TAG_IP_ROUTE_ADD       0x121
 141
 142 /* Discovery phase states */
 143 #define STATE_SENT_PADI     0
 144 #define STATE_RECEIVED_PADO 1
 145 #define STATE_SENT_PADR     2
 146 #define STATE_SESSION       3
 147 #define STATE_TERMINATED    4
 148
 149 /* How many PADI/PADS attempts? */
 150 #define MAX_PADI_ATTEMPTS 3
 151
 152 /* Initial timeout for PADO/PADS */
 153 #define PADI_TIMEOUT 5
 154
 155 /* States for scanning PPP frames */
 156 #define STATE_WAITFOR_FRAME_ADDR 0
 157 #define STATE_DROP_PROTO         1
 158 #define STATE_BUILDING_PACKET    2
 159
 160 /* Special PPP frame characters */
 161 #define FRAME_ESC    0x7D
 162 #define FRAME_FLAG   0x7E
 163 #define FRAME_ADDR   0xFF
 164 #define FRAME_CTRL   0x03
 165 #define FRAME_ENC    0x20
 166
 167 #define IPV4ALEN     4
 168 #define SMALLBUF   256
 169
 170 /* There are other fixed-size buffers preventing
 171    this from being increased to 16110. The buffer
 172    sizes would need to be properly de-coupled from
 173    the default MRU. For now, getting up to 1500 is
 174    enough. */
 175 #define ETH_JUMBO_LEN 1508
 176
 177 /* A PPPoE Packet, including Ethernet headers */
 178 typedef struct PPPoEPacketStruct {
 179     struct ethhdr ethHdr;       /* Ethernet header */
 180     unsigned int vertype:8;     /* PPPoE Version and Type (must both be 1) */
 181     unsigned int code:8;        /* PPPoE code */
 182     unsigned int session:16;    /* PPPoE session */
 183     unsigned int length:16;     /* Payload length */
 184     unsigned char payload[ETH_JUMBO_LEN]; /* A bit of room to spare */
 185 } PPPoEPacket;
 186
 187 #define PPPOE_VER(vt)           ((vt) >> 4)
 188 #define PPPOE_TYPE(vt)          ((vt) & 0xf)
 189 #define PPPOE_VER_TYPE(v, t)    (((v) << 4) | (t))
 190
 191 /* Header size of a PPPoE packet */
 192 #define PPPOE_OVERHEAD 6  /* type, code, session, length */
 193 #define HDR_SIZE (sizeof(struct ethhdr) + PPPOE_OVERHEAD)
 194 #define MAX_PPPOE_PAYLOAD (ETH_JUMBO_LEN - PPPOE_OVERHEAD)
 195 #define PPP_OVERHEAD 2  /* protocol */
 196 #define MAX_PPPOE_MTU (MAX_PPPOE_PAYLOAD - PPP_OVERHEAD)
 197 #define TOTAL_OVERHEAD (PPPOE_OVERHEAD + PPP_OVERHEAD)
 198 #define ETH_PPPOE_MTU (ETH_DATA_LEN - TOTAL_OVERHEAD)
 199
 200 /* PPPoE Tag */
 201
 202 typedef struct PPPoETagStruct {
 203     unsigned int type:16;       /* tag type */
 204     unsigned int length:16;     /* Length of payload */
 205     unsigned char payload[ETH_JUMBO_LEN]; /* A LOT of room to spare */
 206 } PPPoETag;
 207 /* Header size of a PPPoE tag */
 208 #define TAG_HDR_SIZE 4
 209
 210 /* Chunk to read from stdin */
 211 #define READ_CHUNK 4096
 212
 213 /* Function passed to parsePacket */
 214 typedef void ParseFunc(UINT16_t type,
 215                        UINT16_t len,
 216                        unsigned char *data,
 217                        void *extra);
 218
 219 #define PPPINITFCS16    0xffff  /* Initial FCS value */
 220
 221 /* Keep track of the state of a connection -- collect everything in
 222    one spot */
 223
 224 typedef struct PPPoEConnectionStruct {
 225     int discoveryState;         /* Where we are in discovery */
 226     int discoverySocket;        /* Raw socket for discovery frames */
 227     int sessionSocket;          /* Raw socket for session frames */
 228     unsigned char myEth[ETH_ALEN]; /* My MAC address */
 229     unsigned char peerEth[ETH_ALEN]; /* Peer's MAC address */
 230     unsigned char req_peer_mac[ETH_ALEN]; /* required peer MAC address */
 231     unsigned char req_peer;     /* require mac addr to match req_peer_mac */
 232     UINT16_t session;           /* Session ID */
 233     char *ifName;               /* Interface name */
 234     char *serviceName;          /* Desired service name, if any */
 235     char *acName;               /* Desired AC name, if any */
 236     int synchronous;            /* Use synchronous PPP */
 237     int useHostUniq;            /* Use Host-Uniq tag */
 238     int printACNames;           /* Just print AC names */
 239     FILE *debugFile;            /* Debug file for dumping packets */
 240     int numPADOs;               /* Number of PADO packets received */
 241     PPPoETag cookie;            /* We have to send this if we get it */
 242     PPPoETag relayId;           /* Ditto */
 243     int error;                  /* Error packet received */
 244     int debug;                  /* Set to log packets sent and received */
 245     int discoveryTimeout;       /* Timeout for discovery packets */
 246     int discoveryAttempts;      /* Number of discovery attempts */
 247     int seenMaxPayload;
 248     int mtu;                    /* Stored MTU */
 249     int mru;                    /* Stored MRU */
 250 } PPPoEConnection;
 251
 252 /* Structure used to determine acceptable PADO or PADS packet */
 253 struct PacketCriteria {
 254     PPPoEConnection *conn;
 255     int acNameOK;
 256     int serviceNameOK;
 257     int seenACName;
 258     int seenServiceName;
 259 };
 260
 261 /* Function Prototypes */
 262 UINT16_t etherType(PPPoEPacket *packet);
 263 int openInterface(char const *ifname, UINT16_t type, unsigned char *hwaddr);
 264 int sendPacket(PPPoEConnection *conn, int sock, PPPoEPacket *pkt, int size);
 265 int receivePacket(int sock, PPPoEPacket *pkt, int *size);
 266 void fatalSys(char const *str);
 267 void rp_fatal(char const *str);
 268 void printErr(char const *str);
 269 void sysErr(char const *str);
 270 void dumpPacket(FILE *fp, PPPoEPacket *packet, char const *dir);
 271 void dumpHex(FILE *fp, unsigned char const *buf, int len);
 272 int parsePacket(PPPoEPacket *packet, ParseFunc *func, void *extra);
 273 void parseLogErrs(UINT16_t typ, UINT16_t len, unsigned char *data, void *xtra);
 274 void syncReadFromPPP(PPPoEConnection *conn, PPPoEPacket *packet);
 275 void asyncReadFromPPP(PPPoEConnection *conn, PPPoEPacket *packet);
 276 void asyncReadFromEth(PPPoEConnection *conn, int sock, int clampMss);
 277 void syncReadFromEth(PPPoEConnection *conn, int sock, int clampMss);
 278 char *strDup(char const *str);
 279 void sendPADT(PPPoEConnection *conn, char const *msg);
 280 void sendSessionPacket(PPPoEConnection *conn,
 281                        PPPoEPacket *packet, int len);
 282 void initPPP(void);
 283 void clampMSS(PPPoEPacket *packet, char const *dir, int clampMss);
 284 UINT16_t computeTCPChecksum(unsigned char *ipHdr, unsigned char *tcpHdr);
 285 UINT16_t pppFCS16(UINT16_t fcs, unsigned char *cp, int len);
 286 void discovery(PPPoEConnection *conn);
 287 unsigned char *findTag(PPPoEPacket *packet, UINT16_t tagType,
 288                        PPPoETag *tag);
 289
 290 void pppoe_printpkt(PPPoEPacket *packet,
 291                     void (*printer)(void *, char *, ...), void *arg);
 292 void pppoe_log_packet(const char *prefix, PPPoEPacket *packet);
 293
 294 #define SET_STRING(var, val) do { if (var) free(var); var = strDup(val); } while(0);
 295
 296 #define CHECK_ROOM(cursor, start, len) \
 297 do {\
 298     if (((cursor)-(start))+(len) > MAX_PPPOE_PAYLOAD) { \
 299         error("Would create too-long packet");  \
 300         return; \
 301     } \
 302 } while(0)
 303
 304 /* True if Ethernet address is broadcast or multicast */
 305 #define NOT_UNICAST(e) ((e[0] & 0x01) != 0)
 306 #define BROADCAST(e) ((e[0] & e[1] & e[2] & e[3] & e[4] & e[5]) == 0xFF)
 307 #define NOT_BROADCAST(e) ((e[0] & e[1] & e[2] & e[3] & e[4] & e[5]) != 0xFF)