d11bbd15cdbfce5a5a22fadf3988974b50b936ab
[oweals/gnunet.git] / src / transport / plugin_transport_http.h
1 /*
2      This file is part of GNUnet
3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
4
5      GNUnet is free software; you can redistribute it and/or modify
6      it under the terms of the GNU General Public License as published
7      by the Free Software Foundation; either version 3, or (at your
8      option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      General Public License for more details.
14
15      You should have received a copy of the GNU General Public License
16      along with GNUnet; see the file COPYING.  If not, write to the
17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file transport/plugin_transport_http.h
23  * @brief http transport service plugin
24  * @author Matthias Wachs
25  */
26
27 #include "platform.h"
28 #include "gnunet_common.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_connection_lib.h"
32 #include "gnunet_service_lib.h"
33 #include "gnunet_statistics_service.h"
34 #include "gnunet_transport_service.h"
35 #include "gnunet_resolver_service.h"
36 #include "gnunet_server_lib.h"
37 #include "gnunet_container_lib.h"
38 #include "gnunet_transport_plugin.h"
39 #include "gnunet_os_lib.h"
40 #include "gnunet_nat_lib.h"
41 #include "microhttpd.h"
42 #include <curl/curl.h>
43
44
45 #define DEBUG_HTTP GNUNET_YES
46 #define VERBOSE_SERVER GNUNET_YES
47 #define VERBOSE_CLIENT GNUNET_YES
48 #define VERBOSE_CURL GNUNET_YES
49
50 #if BUILD_HTTPS
51 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_https_init
52 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_https_done
53 #else
54 #define LIBGNUNET_PLUGIN_TRANSPORT_INIT libgnunet_plugin_transport_http_init
55 #define LIBGNUNET_PLUGIN_TRANSPORT_DONE libgnunet_plugin_transport_http_done
56 #endif
57
58 #define INBOUND  GNUNET_YES
59 #define OUTBOUND GNUNET_NO
60
61
62 #define HTTP_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
63
64 /**
65  * Encapsulation of all of the state of the plugin.
66  */
67 struct Plugin
68 {
69   /**
70    * Our environment.
71    */
72   struct GNUNET_TRANSPORT_PluginEnvironment *env;
73
74   /**
75    * List of open sessions.
76    */
77   struct Session *head;
78
79   struct Session *tail;
80
81   /**
82    * NAT handle & address management
83    */
84   struct GNUNET_NAT_Handle *nat;
85
86
87   /**
88    * ipv4 DLL head
89    */
90   struct IPv4HttpAddressWrapper *ipv4_addr_head;
91
92   /**
93    * ipv4 DLL tail
94    */
95   struct IPv4HttpAddressWrapper *ipv4_addr_tail;
96
97   /**
98    * ipv6 DLL head
99    */
100   struct IPv6HttpAddressWrapper *ipv6_addr_head;
101
102   /**
103    * ipv6 DLL tail
104    */
105   struct IPv6HttpAddressWrapper *ipv6_addr_tail;
106
107
108   /* Plugin configuration */
109
110   char *name;
111
112   char *protocol;
113
114   int ipv4;
115
116   int ipv6;
117
118   uint16_t port;
119
120   int max_connections;
121
122
123
124   /* Plugin values */
125
126
127   int cur_connections;
128   uint32_t last_tag;
129   /*
130    * Server handles
131    */
132
133   struct MHD_Daemon *server_v4;
134   GNUNET_SCHEDULER_TaskIdentifier server_v4_task;
135
136   struct MHD_Daemon *server_v6;
137   GNUNET_SCHEDULER_TaskIdentifier server_v6_task;
138
139   char *crypto_init;
140   char *key;
141   char *cert;
142
143   struct Session *server_semi_head;
144
145   struct Session *server_semi_tail;
146
147
148
149   /*
150    * Client handles
151    */
152
153   /**
154    * cURL Multihandle
155    */
156   CURLM *client_mh;
157
158   GNUNET_SCHEDULER_TaskIdentifier client_perform_task;
159
160 };
161
162 /**
163  * Session handle for connections.
164  */
165 struct Session
166 {
167
168   /**
169    * Stored in a linked list.
170    */
171   struct Session *next;
172
173   /**
174    * Stored in a linked list.
175    */
176   struct Session *prev;
177
178   /**
179    * Pointer to the global plugin struct.
180    */
181   struct Plugin *plugin;
182
183   /**
184    * next pointer for double linked list
185    */
186   struct HTTP_Message *msg_head;
187
188   /**
189    * previous pointer for double linked list
190    */
191   struct HTTP_Message *msg_tail;
192
193
194   /**
195    * message stream tokenizer for incoming data
196    */
197   struct GNUNET_SERVER_MessageStreamTokenizer *msg_tk;
198
199   /**
200    * Continuation function to call once the transmission buffer
201    * has again space available.  NULL if there is no
202    * continuation to call.
203    */
204   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
205
206
207   void *addr;
208
209   size_t addrlen;
210
211   /**
212    * Closure for transmit_cont.
213    */
214   void *transmit_cont_cls;
215
216   /**
217    * To whom are we talking to (set to our identity
218    * if we are still waiting for the welcome message)
219    */
220   struct GNUNET_PeerIdentity target;
221
222   /**
223    * At what time did we reset last_received last?
224    */
225   //struct GNUNET_TIME_Absolute last_quota_update;
226
227   /**
228    * How many bytes have we received since the "last_quota_update"
229    * timestamp?
230    */
231   //uint64_t last_received;
232
233   /**
234    * Number of bytes per ms that this peer is allowed
235    * to send to us.
236    */
237   //uint32_t quota;
238
239
240   int inbound;
241
242   void *client_put;
243   void *client_get;
244   int put_paused;
245
246   void *server_recv;
247   void *server_send;
248   struct GNUNET_TIME_Absolute delay;
249   GNUNET_SCHEDULER_TaskIdentifier reset_task;
250   uint32_t tag;
251
252 };
253
254 /**
255  *  Message to send using http
256  */
257 struct HTTP_Message
258 {
259   /**
260    * next pointer for double linked list
261    */
262   struct HTTP_Message *next;
263
264   /**
265    * previous pointer for double linked list
266    */
267   struct HTTP_Message *prev;
268
269   /**
270    * buffer containing data to send
271    */
272   char *buf;
273
274   /**
275    * amount of data already sent
276    */
277   size_t pos;
278
279   /**
280    * buffer length
281    */
282   size_t size;
283
284   /**
285    * Continuation function to call once the transmission buffer
286    * has again space available.  NULL if there is no
287    * continuation to call.
288    */
289   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
290
291   /**
292    * Closure for transmit_cont.
293    */
294   void *transmit_cont_cls;
295 };
296
297 void
298 delete_session (struct Session *s);
299
300 struct Session *
301 create_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *target,
302                 const void *addr, size_t addrlen,
303                 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls);
304
305 struct GNUNET_TIME_Relative
306 http_plugin_receive (void *cls, const struct GNUNET_PeerIdentity * peer,
307     const struct  GNUNET_MessageHeader * message,
308     struct Session * session,
309     const char *sender_address,
310     uint16_t sender_address_len);
311
312 const char *
313 http_plugin_address_to_string (void *cls, const void *addr, size_t addrlen);
314
315 int
316 client_disconnect (struct Session *s);
317
318 int
319 client_connect (struct Session *s);
320
321 int
322 client_send (struct Session *s, struct HTTP_Message *msg);
323
324 int
325 client_start (struct Plugin *plugin);
326
327 void
328 client_stop (struct Plugin *plugin);
329
330 int
331 server_disconnect (struct Session *s);
332
333 int
334 server_send (struct Session *s, struct HTTP_Message * msg);
335
336 int
337 server_start (struct Plugin *plugin);
338
339 void
340 server_stop (struct Plugin *plugin);
341
342 void
343 notify_session_end (void *cls,
344                     const struct GNUNET_PeerIdentity *
345                     peer, struct Session * s);
346
347 /* end of plugin_transport_http.h */