pppoe plugin stuff - Michal Ostrowski's version, lightly hacked
[ppp.git] / pppd / plugins / pppoe / pppoe.h
1 /* PPPoE support library "libpppoe"
2  *
3  * Copyright 2000 Michal Ostrowski <mostrows@styx.uwaterloo.ca>,
4  *                Jamal Hadi Salim <hadi@cyberus.ca>
5  *
6  *  This program is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU General Public License
8  *  as published by the Free Software Foundation; either version
9  *  2 of the License, or (at your option) any later version.
10  */
11
12 #ifndef PPPOE_H
13 #define PPPOE_H 1
14 #include <stdio.h>              /* stdio               */
15 #include <stdlib.h>             /* strtoul(), realloc() */
16 #include <unistd.h>             /* STDIN_FILENO,exec    */
17 #include <string.h>             /* memcpy()             */
18 #include <errno.h>              /* errno                */
19 #include <signal.h>
20 #include <getopt.h>
21 #include <stdarg.h>
22 #include <syslog.h>
23 #include <paths.h>
24
25 #include <sys/types.h>          /* socket types         */
26 #include <asm/types.h>
27 #include <sys/time.h>
28 #include <sys/wait.h>
29 #include <sys/fcntl.h>
30 #include <sys/ioctl.h>          /* ioctl()              */
31 #include <sys/select.h>
32 #include <sys/socket.h>         /* socket()             */
33 #include <net/if.h>             /* ifreq struct         */
34 #include <net/if_arp.h>
35 #include <netinet/in.h>
36
37 #if __GLIBC__ >= 2 && __GLIBC_MINOR >= 1
38 #include <netpacket/packet.h>
39 //#include <net/ethernet.h>
40 #else
41 #include <asm/types.h>
42 #include <linux/if_packet.h>
43 #include <linux/if_ether.h>
44 #endif
45
46
47 #include <asm/byteorder.h>
48
49 /*
50   jamal: we really have to change this
51   to make it compatible to the 2.2 and
52   2.3 kernel
53 */
54
55 #include <linux/if_pppox.h>
56
57
58 #define CONNECTED 1
59 #define DISCONNECTED 0
60
61 #ifndef _PATH_PPPD
62 #define _PATH_PPPD "/usr/sbin/pppd"
63 #endif
64
65 #ifndef LOG_PPPOE
66 #define LOG_PPPOE LOG_DAEMON
67 #endif
68
69
70 #define VERSION_MAJOR 0
71 #define VERSION_MINOR 4
72 #define VERSION_DATE 991120
73
74 /* Bigger than the biggest ethernet packet we'll ever see, in bytes */
75 #define MAX_PACKET      2000
76
77 /* references: RFC 2516 */
78 /* ETHER_TYPE fields for PPPoE */
79
80 #define ETH_P_PPPOE_DISC 0x8863 /* discovery stage */
81 #define ETH_P_PPPOE_SESS 0x8864
82
83 /* ethernet broadcast address */
84 #define MAC_BCAST_ADDR "\xff\xff\xff\xff\xff\xff"
85
86 /* Format for parsing long device-name */
87 #define _STR(x) #x
88 #define FMTSTRING(size) "%x:%x:%x:%x:%x:%x/%x/%" _STR(size) "s"
89
90 /* maximum payload length */
91 #define MAX_PAYLOAD 1484
92
93
94
95 /* PPPoE tag types */
96 #define MAX_TAGS                11
97
98
99 /* PPPoE packet; includes Ethernet headers and such */
100 struct pppoe_packet{
101         struct sockaddr_ll addr;
102         struct pppoe_tag *tags[MAX_TAGS];
103         struct pppoe_hdr *hdr;
104         char buf[MAX_PAYLOAD];          /* buffer in which tags are held */
105 };
106 /* Defines meaning of each "tags" element */
107
108 #define TAG_SRV_NAME    0
109 #define TAG_AC_NAME     1
110 #define TAG_HOST_UNIQ   2
111 #define TAG_AC_COOKIE   3
112 #define TAG_VENDOR      4
113 #define TAG_RELAY_SID   5
114 #define TAG_SRV_ERR     6
115 #define TAG_SYS_ERR     7
116 #define TAG_GEN_ERR     8
117 #define TAG_EOL         9
118
119 static int tag_map[] = { PTT_SRV_NAME,
120                          PTT_AC_NAME,
121                          PTT_HOST_UNIQ,
122                          PTT_AC_COOKIE,
123                          PTT_VENDOR,
124                          PTT_RELAY_SID,
125                          PTT_SRV_ERR,
126                          PTT_SYS_ERR,
127                          PTT_GEN_ERR,
128                          PTT_EOL
129 };
130
131
132 /* Debug flags */
133 int DEB_DISC,DEB_DISC2;
134 /*
135   #define DEB_DISC              (opt_debug & 0x0002)
136   #define DEB_DISC2             (opt_debug & 0x0004)
137 */
138 #define MAX_FNAME               256
139
140
141 struct session;
142
143 /* return <0 --> fatal error; abor
144    return =0 --> ok, proceed
145    return >0 --> ok, qui
146 */
147 typedef int (*packet_cb_t)(struct session* ses,
148                            struct pppoe_packet *p_in,
149                            struct pppoe_packet **p_out);
150
151 /* various override filter tags */
152 struct filter {
153         struct pppoe_tag *stag;  /* service name tag override */
154         struct pppoe_tag *ntag;  /*AC name override */
155         struct pppoe_tag *htag;  /* hostuniq override */
156         int num_restart;
157         int peermode;
158         char *fname;
159         char *pppd;
160 } __attribute__ ((packed));
161
162
163 struct pppoe_tag *make_filter_tag(short type, short length, char* data);
164
165 /* Session type definitions */
166 #define SESSION_CLIENT  0
167 #define SESSION_SERVER  1
168 #define SESSION_RELAY   2
169
170 struct session {
171
172         /* Administrative */
173         int type;
174         int opt_debug;
175         int detached;
176         int np;
177         int log_to_fd;
178         int ifindex;                    /* index of device */
179         char name[IFNAMSIZ];            /*dev name */
180         struct pppoe_packet curr_pkt;
181
182         packet_cb_t init_disc;
183         packet_cb_t rcv_pado;
184         packet_cb_t rcv_padi;
185         packet_cb_t rcv_pads;
186         packet_cb_t rcv_padr;
187         packet_cb_t rcv_padt;
188         packet_cb_t timeout;
189
190
191         /* Generic */
192         struct filter *filt;
193         struct sockaddr_ll local;
194         struct sockaddr_ll remote;
195         struct sockaddr_pppox sp;
196         int fd;                         /* fd of PPPoE socket */
197
198
199         /* For client */
200         int retransmits;                /* Number of retransmission performed
201                                            if < 0 , retransmissions disabled */
202         int retries;
203         int state;
204         int opt_daemonize;
205
206         /* For server */
207         int fork;
208
209         /* For forwarding */
210         int fwd_sock;
211         char fwd_name[IFNAMSIZ];        /* Name of device to forward to */
212 } __attribute__ ((packed));
213
214 /*
215   retransmit retries for the PADR and PADI packets
216   during discovery
217 */
218 int PADR_ret;
219 int PADI_ret;
220
221 int log_to_fd;
222 int ctrl_fd;
223 int opt_debug;
224 int opt_daemonize;
225
226
227 /* Structure for keeping track of connection relays */
228 struct pppoe_con{
229         struct pppoe_con *next;
230         int id;
231         int connected;
232         int  cl_sock;
233         int  sv_sock;
234         int ref_count;
235         char client[ETH_ALEN];
236         char server[ETH_ALEN];
237         char key_len;
238         char key[32];
239 };
240
241 /* Functions exported from utils.c. */
242
243 /* Functions exported from pppoehash.c */
244 struct pppoe_con *get_con(int len, char *key);
245 int store_con(struct pppoe_con *pc);
246 struct pppoe_con *delete_con(unsigned long len, char *key);
247
248 /* exported by lib.c */
249
250 extern int init_lib();
251
252 extern int get_sockaddr_ll(const char *devnam,struct sockaddr_ll* sll);
253
254 extern int client_init_ses (struct session *ses, char* devnam);
255 extern int relay_init_ses(struct session *ses, char* from, char* to);
256 extern int srv_init_ses(struct session *ses, char* from);
257 extern int session_connect(struct session *ses);
258 extern int session_disconnect(struct session*ses);
259
260 extern int verify_packet( struct session *ses, struct pppoe_packet *p);
261
262 extern void copy_tag(struct pppoe_packet *dest, struct pppoe_tag *pt);
263 extern struct pppoe_tag *get_tag(struct pppoe_hdr *ph, u_int16_t idx);
264 extern int send_disc(struct session *ses, struct pppoe_packet *p);
265
266
267 extern int add_client(char *addr);
268
269 /* Make connections (including spawning pppd) as server/client */
270 extern ppp_connect(struct session *ses);
271
272
273 #endif