www.usr.com/support/gpl/USR9107_release.1.4.tar.gz
[bcm963xx.git] / userapps / opensource / ppp / pppoecd / 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 #include "pppd.h"
58
59 #define CONNECTED 1
60 #define DISCONNECTED 0
61
62 #ifndef _PATH_PPPD
63 #define _PATH_PPPD "/usr/sbin/pppd"
64 #endif
65
66 #ifndef LOG_PPPOE
67 #define LOG_PPPOE LOG_DAEMON
68 #endif
69
70
71 #define VERSION_MAJOR 0
72 #define VERSION_MINOR 4
73 #define VERSION_DATE 991120
74
75 /* Bigger than the biggest ethernet packet we'll ever see, in bytes */
76 #define MAX_PACKET      2000
77
78 /* references: RFC 2516 */
79 /* ETHER_TYPE fields for PPPoE */
80
81 #define ETH_P_PPPOE_DISC 0x8863 /* discovery stage */
82 #define ETH_P_PPPOE_SESS 0x8864
83
84 /* ethernet broadcast address */
85 #define MAC_BCAST_ADDR "\xff\xff\xff\xff\xff\xff"
86
87 /* Format for parsing long device-name */
88 #define _STR(x) #x
89 #define FMTSTRING(size) "%x:%x:%x:%x:%x:%x/%x/%" _STR(size) "s"
90
91 /* maximum payload length */
92 #define MAX_PAYLOAD 1484
93
94
95
96 /* PPPoE tag types */
97 #define MAX_TAGS                11
98
99
100 /* PPPoE packet; includes Ethernet headers and such */
101 struct pppoe_packet{
102         struct sockaddr_ll addr;
103         struct pppoe_tag *tags[MAX_TAGS];
104         struct pppoe_hdr *hdr;
105         char buf[MAX_PAYLOAD];          /* buffer in which tags are held */
106 };
107 /* Defines meaning of each "tags" element */
108
109 #define TAG_SRV_NAME    0
110 #define TAG_AC_NAME     1
111 #define TAG_HOST_UNIQ   2
112 #define TAG_AC_COOKIE   3
113 #define TAG_VENDOR      4
114 #define TAG_RELAY_SID   5
115 #define TAG_SRV_ERR     6
116 #define TAG_SYS_ERR     7
117 #define TAG_GEN_ERR     8
118 #define TAG_EOL         9
119
120 static int tag_map[] = { PTT_SRV_NAME,
121                          PTT_AC_NAME,
122                          PTT_HOST_UNIQ,
123                          PTT_AC_COOKIE,
124                          PTT_VENDOR,
125                          PTT_RELAY_SID,
126                          PTT_SRV_ERR,
127                          PTT_SYS_ERR,
128                          PTT_GEN_ERR,
129                          PTT_EOL
130 };
131
132
133 /* Debug flags */
134 int DEB_DISC,DEB_DISC2;
135 /*
136   #define DEB_DISC              (opt_debug & 0x0002)
137   #define DEB_DISC2             (opt_debug & 0x0004)
138 */
139 #define MAX_FNAME               256
140
141
142 struct session;
143
144 /* return <0 --> fatal error; abor
145    return =0 --> ok, proceed
146    return >0 --> ok, qui
147 */
148 typedef int (*packet_cb_t)(struct session* ses,
149                            struct pppoe_packet *p_in,
150                            struct pppoe_packet **p_out);
151
152 /* various override filter tags */
153 struct filter {
154         struct pppoe_tag *stag;  /* service name tag override */
155         struct pppoe_tag *ntag;  /*AC name override */
156         struct pppoe_tag *htag;  /* hostuniq override */
157         int num_restart;
158         int peermode;
159         char *fname;
160         char *pppd;
161 } __attribute__ ((packed));
162
163
164 struct pppoe_tag *make_filter_tag(short type, short length, char* data);
165
166 /* Session type definitions */
167 #define SESSION_CLIENT  0
168 #define SESSION_SERVER  1
169 #define SESSION_RELAY   2
170
171 struct session {
172
173         /* Administrative */
174         int type;
175         int opt_debug;
176         int detached;
177         int np;
178         int log_to_fd;
179         int ifindex;                    /* index of device */
180         char name[IFNAMSIZ];            /*dev name */
181         struct pppoe_packet curr_pkt;
182
183         packet_cb_t init_disc;
184         packet_cb_t rcv_pado;
185         packet_cb_t rcv_padi;
186         packet_cb_t rcv_pads;
187         packet_cb_t rcv_padr;
188         packet_cb_t rcv_padt;
189         packet_cb_t timeout;
190
191
192         /* Generic */
193         struct filter *filt;
194         struct sockaddr_ll local;
195         struct sockaddr_ll remote;
196         struct sockaddr_pppox sp;
197         int fd;                         /* fd of PPPoE socket */
198
199
200         /* For client */
201         int retransmits;                /* Number of retransmission performed
202                                            if < 0 , retransmissions disabled */
203         int retries;
204         int state;
205         int opt_daemonize;
206
207         /* For server */
208         int fork;
209
210         /* For forwarding */
211         int fwd_sock;
212         char fwd_name[IFNAMSIZ];        /* Name of device to forward to */
213 } __attribute__ ((packed));
214
215 /*
216   retransmit retries for the PADR and PADI packets
217   during discovery
218 */
219 int PADR_ret;
220 int PADI_ret;
221
222 int log_to_fd;
223 int ctrl_fd;
224 int opt_debug;
225 int opt_daemonize;
226
227
228 /* Structure for keeping track of connection relays */
229 struct pppoe_con{
230         struct pppoe_con *next;
231         int id;
232         int connected;
233         int  cl_sock;
234         int  sv_sock;
235         int ref_count;
236         char client[ETH_ALEN];
237         char server[ETH_ALEN];
238         char key_len;
239         char key[32];
240 };
241
242 /* Functions exported from utils.c. */
243
244 /* Functions exported from pppoehash.c */
245 struct pppoe_con *get_con(int len, char *key);
246 int store_con(struct pppoe_con *pc);
247 struct pppoe_con *delete_con(unsigned long len, char *key);
248
249 /* exported by lib.c */
250
251 extern int init_lib();
252
253 extern int get_sockaddr_ll(const char *devnam,struct sockaddr_ll* sll);
254
255 extern int client_init_ses (struct session *ses, char* devnam);
256 extern int relay_init_ses(struct session *ses, char* from, char* to);
257 extern int srv_init_ses(struct session *ses, char* from);
258 extern int session_connect(struct session *ses);
259 extern int session_disconnect(struct session*ses);
260
261 extern int verify_packet( struct session *ses, struct pppoe_packet *p);
262
263 extern void copy_tag(struct pppoe_packet *dest, struct pppoe_tag *pt);
264 extern struct pppoe_tag *get_tag(struct pppoe_hdr *ph, u_int16_t idx);
265 extern int send_disc(struct session *ses, struct pppoe_packet *p);
266
267
268 extern int add_client(char *addr);
269
270 /* Make connections (including spawning pppd) as server/client */
271 extern int ppp_connect(struct session *ses);
272
273 #include <pppd.h>
274
275 #define poe_die die
276
277 #ifdef DEBUG
278 #define poe_dbglog(ses,a,b...) dbglog(a, ## b)
279 #define poe_info(ses,a,b...) info(a, ## b)
280 #define poe_notice(ses,a,b...) notice(a, ## b)
281 #define poe_warn(ses,a,b...) warn(a, ## b)
282 #define poe_error(ses,a,b...) error(a, ## b)
283 #define poe_fatal(ses,a,b...) fatal(a, ## b)
284 #else
285 #define poe_dbglog(a,b...)
286 #define poe_info(a,b...)
287 #define poe_notice(a,b...)
288 #define poe_warn(a,b...)
289 #define poe_error(a,b...)
290 #define poe_fatal(a,b...)
291 #endif
292
293 #endif