2 This file is part of GNUnet
3 (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
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 2, or (at your
8 option) any later version.
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.
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.
22 * @file transport/plugin_transport_template.c
23 * @brief template for a new transport service
24 * @author Christian Grothoff
28 #include "gnunet_protocols.h"
29 #include "gnunet_connection_lib.h"
30 #include "gnunet_server_lib.h"
31 #include "gnunet_service_lib.h"
32 #include "gnunet_statistics_service.h"
33 #include "gnunet_transport_service.h"
34 #include "plugin_transport.h"
35 #include "microhttpd.h"
36 #include <curl/curl.h>
38 #define DEBUG_HTTP GNUNET_NO
41 * Text of the response sent back after the last bytes of a PUT
42 * request have been received (just to formally obey the HTTP
45 #define HTTP_PUT_RESPONSE "Thank you!"
49 * After how long do we expire an address that we
50 * learned from another peer if it is not reconfirmed
53 #define LEARNED_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
57 * Encapsulation of all of the state of the plugin.
63 * Session handle for connections.
69 * Stored in a linked list.
74 * Pointer to the global plugin struct.
76 struct Plugin *plugin;
79 * Continuation function to call once the transmission buffer
80 * has again space available. NULL if there is no
81 * continuation to call.
83 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
86 * Closure for transmit_cont.
88 void *transmit_cont_cls;
91 * To whom are we talking to (set to our identity
92 * if we are still waiting for the welcome message)
94 struct GNUNET_PeerIdentity sender;
102 * Sender's ip address to distinguish between incoming connections
107 * Did we initiate the connection (GNUNET_YES) or the other peer (GNUNET_NO)?
109 unsigned int is_client;
112 * At what time did we reset last_received last?
114 struct GNUNET_TIME_Absolute last_quota_update;
117 * How many bytes have we received since the "last_quota_update"
120 uint64_t last_received;
123 * Number of bytes per ms that this peer is allowed
131 * Encapsulation of all of the state of the plugin.
138 struct GNUNET_TRANSPORT_PluginEnvironment *env;
141 * List of open sessions.
143 struct Session *sessions;
148 * Daemon for listening for new IPv4 connections.
150 static struct MHD_Daemon *http_daemon_v4;
153 * Daemon for listening for new IPv6connections.
155 static struct MHD_Daemon *http_daemon_v6;
158 * Our primary task for http daemon handling IPv4 connections
160 static GNUNET_SCHEDULER_TaskIdentifier http_task_v4;
163 * Our primary task for http daemon handling IPv6 connections
165 static GNUNET_SCHEDULER_TaskIdentifier http_task_v6;
167 struct Plugin *plugin;
169 static CURLM *multi_handle;
171 static struct sockaddr * current_ip;
174 * Finds a http session in our linked list using peer identity as a key
175 * @param peer peeridentity
176 * @return http session corresponding to peer identity
178 static struct Session * find_session_by_pi( const struct GNUNET_PeerIdentity *peer )
180 struct Session * cur;
181 GNUNET_HashCode hc_peer;
182 GNUNET_HashCode hc_current;
184 cur = plugin->sessions;
185 hc_peer = peer->hashPubKey;
188 hc_current = cur->sender.hashPubKey;
189 if ( 0 == GNUNET_CRYPTO_hash_cmp( &hc_peer, &hc_current))
191 cur = plugin->sessions->next;
198 * Finds a http session in our linked list using peer identity as a key
199 * @param peer peeridentity
200 * @return http session corresponding to peer identity
202 static struct Session * find_session_by_ip( struct sockaddr_in * addr )
205 struct Session * cur;
207 cur = plugin->sessions;
210 hc_current = cur->sender.hashPubKey;
211 if ( 0 == GNUNET_CRYPTO_hash_cmp( &hc_peer, &hc_current))
213 cur = plugin->sessions->next;
221 * Creates a http session in our linked list by peer identity
222 * Only peer is set here, all other fields have to be set by calling method
223 * @param peer peeridentity
224 * @return created http session
226 static struct Session * create_session_by_pi( const struct GNUNET_PeerIdentity *peer )
228 struct Session * cur;
229 struct Session * last_in_list;
230 /* Create a new session object */
231 cur = GNUNET_malloc (sizeof (struct Session));
232 memcpy( &(cur->sender), peer, sizeof( struct GNUNET_PeerIdentity ) );
236 /* Insert into linked list */
237 last_in_list = plugin->sessions;
238 while (last_in_list->next != NULL)
240 last_in_list = last_in_list->next;
242 last_in_list->next = cur;
249 * Creates a http session in our linked list by ip address
250 * Only ip is set here, all other fields have to be set by calling method
251 * @param peer peeridentity
252 * @return created http session
254 static struct Session * create_session_by_ip ( struct sockaddr_in * addr )
256 struct Session * cur;
257 struct Session * last_in_list;
258 /* Create a new session object */
259 cur = GNUNET_malloc (sizeof (struct Session));
260 // FIXME: memcpy( &(cur->ip), , sizeof( struct GNUNET_PeerIdentity ) );
264 /* Insert into linked list */
265 last_in_list = plugin->sessions;
266 while (last_in_list->next != NULL)
268 last_in_list = last_in_list->next;
270 last_in_list->next = cur;
277 * Callback called by MHD when a connection is terminated
279 static void requestCompletedCallback (void *cls, struct MHD_Connection * connection, void **httpSessionCache)
281 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Connection was terminated\n");
286 * Check if we are allowed to connect to the given IP.
289 acceptPolicyCallback (void *cls,
290 const struct sockaddr *addr, socklen_t addr_len)
292 struct sockaddr_in *addrin;
293 struct sockaddr_in6 *addrin6;
295 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Address %p\n",current_ip);
296 if (addr->sa_family == AF_INET6)
298 address = GNUNET_malloc(INET6_ADDRSTRLEN);
299 addrin6 = (struct sockaddr_in6 *) addr;
300 inet_ntop(addrin6->sin6_family, &(addrin6->sin6_addr),address,INET6_ADDRSTRLEN);
301 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Incoming IPv6 connection from `%s'\n",address);
302 memcpy(current_ip,addr, sizeof (struct sockaddr));
304 GNUNET_free (address);
306 if (addr->sa_family == AF_INET)
308 address = GNUNET_malloc(INET_ADDRSTRLEN);
309 addrin = (struct sockaddr_in *) addr;
310 inet_ntop(addrin->sin_family, &(addrin->sin_addr),address,INET_ADDRSTRLEN);
311 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Incoming IPv4 connection from `%s'\n",address);
312 memcpy(current_ip,addr, sizeof (struct sockaddr));
313 GNUNET_free (address);
315 /* Every connection is accepted, nothing more to do here */
321 * Process GET or PUT request received via MHD. For
322 * GET, queue response that will send back our pending
323 * messages. For PUT, process incoming data and send
324 * to GNUnet core. In either case, check if a session
325 * already exists and create a new one if not.
328 accessHandlerCallback (void *cls,
329 struct MHD_Connection *session,
333 const char *upload_data,
334 size_t * upload_data_size, void **httpSessionCache)
336 struct Session * http_session;
337 struct MHD_Response *response;
338 http_session = *httpSessionCache;
340 struct sockaddr *addr;
341 struct sockaddr_in *addrin;
342 struct sockaddr_in6 *addrin6;
345 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Address %p %u\n",current_ip,current_ip->sa_family);
346 if ( current_ip->sa_family == AF_INET)
348 address = GNUNET_malloc(INET_ADDRSTRLEN);
349 addrin = (struct sockaddr_in *) current_ip;
350 inet_ntop(addrin->sin_family, &(addrin->sin_addr),address,INET_ADDRSTRLEN);
352 if (current_ip->sa_family == AF_INET6)
354 address = GNUNET_malloc(INET6_ADDRSTRLEN);
355 addrin6 = (struct sockaddr_in6 *) current_ip;
356 inet_ntop(addrin6->sin6_family, &(addrin6->sin6_addr),address,INET6_ADDRSTRLEN);
359 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"HTTP Daemon has an incoming `%s' request from `%s'\n",method, address);
361 /* Check if new or already known session */
362 if ( NULL == http_session )
364 /* Create a new session */
366 /* Insert session into linked list*/
370 /* Is it a PUT or a GET request */
371 if ( 0 == strcmp (MHD_HTTP_METHOD_PUT, method) )
373 /* PUT method here */
374 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Got PUT Request with size %lu \n",(*upload_data_size));
375 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"URL: `%s'\n",url);
376 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"PUT Request: `%s'\n",upload_data);
377 /* FIXME: GNUNET_STATISTICS_update( plugin->env->stats , gettext_noop("# PUT requests"), 1, GNUNET_NO); */
379 *upload_data_size = 0;
380 response = MHD_create_response_from_data (strlen (HTTP_PUT_RESPONSE),HTTP_PUT_RESPONSE, MHD_NO, MHD_NO);
381 MHD_queue_response (session, MHD_HTTP_OK, response);
382 MHD_destroy_response (response);
384 if ( 0 == strcmp (MHD_HTTP_METHOD_GET, method) )
386 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Got GET Request\n");
387 //GNUNET_STATISTICS_update( plugin->env->stats , gettext_noop("# GET requests"), 1, GNUNET_NO);
390 GNUNET_free (address);
396 * Call MHD to process pending requests and then go back
397 * and schedule the next run.
399 static void http_daemon_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
402 * Function that queries MHD's select sets and
403 * starts the task waiting for them.
405 static GNUNET_SCHEDULER_TaskIdentifier
406 http_daemon_prepare (struct MHD_Daemon *daemon_handle)
408 GNUNET_SCHEDULER_TaskIdentifier ret;
412 struct GNUNET_NETWORK_FDSet *wrs;
413 struct GNUNET_NETWORK_FDSet *wws;
414 struct GNUNET_NETWORK_FDSet *wes;
416 unsigned long long timeout;
418 struct GNUNET_TIME_Relative tv;
423 wrs = GNUNET_NETWORK_fdset_create ();
424 wes = GNUNET_NETWORK_fdset_create ();
425 wws = GNUNET_NETWORK_fdset_create ();
427 GNUNET_assert (MHD_YES ==
428 MHD_get_fdset (daemon_handle,
433 haveto = MHD_get_timeout (daemon_handle, &timeout);
434 if (haveto == MHD_YES)
435 tv.value = (uint64_t) timeout;
437 tv = GNUNET_TIME_UNIT_FOREVER_REL;
438 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max);
439 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max);
440 GNUNET_NETWORK_fdset_copy_native (wes, &es, max);
441 ret = GNUNET_SCHEDULER_add_select (plugin->env->sched,
442 GNUNET_SCHEDULER_PRIORITY_HIGH,
443 GNUNET_SCHEDULER_NO_TASK,
449 GNUNET_NETWORK_fdset_destroy (wrs);
450 GNUNET_NETWORK_fdset_destroy (wws);
451 GNUNET_NETWORK_fdset_destroy (wes);
456 * Call MHD to process pending requests and then go back
457 * and schedule the next run.
460 http_daemon_run (void *cls,
461 const struct GNUNET_SCHEDULER_TaskContext *tc)
463 struct MHD_Daemon *daemon_handle = cls;
465 if (daemon_handle == http_daemon_v4)
466 http_task_v4 = GNUNET_SCHEDULER_NO_TASK;
468 if (daemon_handle == http_daemon_v6)
469 http_task_v6 = GNUNET_SCHEDULER_NO_TASK;
471 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
474 GNUNET_assert (MHD_YES == MHD_run (daemon_handle));
475 if (daemon_handle == http_daemon_v4)
476 http_task_v4 = http_daemon_prepare (daemon_handle);
477 if (daemon_handle == http_daemon_v6)
478 http_task_v6 = http_daemon_prepare (daemon_handle);
482 static size_t read_callback(void *ptr, size_t size, size_t nmemb, void *stream)
486 fprintf(stdout, "*** Read callback: size %u, size nmemb: %u \n", size, nmemb);
487 retcode = fread(ptr, size, nmemb, stream);
494 * Function that can be used by the transport service to transmit
495 * a message using the plugin.
498 * @param target who should receive this message
499 * @param priority how important is the message
500 * @param msgbuf the message to transmit
501 * @param msgbuf_size number of bytes in 'msgbuf'
502 * @param timeout when should we time out
503 * @param session which session must be used (or NULL for "any")
504 * @param addr the address to use (can be NULL if the plugin
505 * is "on its own" (i.e. re-use existing TCP connection))
506 * @param addrlen length of the address in bytes
507 * @param force_address GNUNET_YES if the plugin MUST use the given address,
508 * otherwise the plugin may use other addresses or
509 * existing connections (if available)
510 * @param cont continuation to call once the message has
511 * been transmitted (or if the transport is ready
512 * for the next transmission call; or if the
513 * peer disconnected...)
514 * @param cont_cls closure for cont
515 * @return number of bytes used (on the physical network, with overheads);
516 * -1 on hard errors (i.e. address invalid); 0 is a legal value
517 * and does NOT mean that the message was not transmitted (DV)
520 template_plugin_send (void *cls,
521 const struct GNUNET_PeerIdentity *
525 unsigned int priority,
526 struct GNUNET_TIME_Relative timeout,
527 struct Session *session,
531 GNUNET_TRANSPORT_TransmitContinuation
532 cont, void *cont_cls)
536 /* struct Plugin *plugin = cls; */
540 /* find session for peer */
541 ses = find_session_by_pi (target);
542 if ( ses == NULL) create_session_by_pi (target);
544 char *url = "http://localhost:12389";
546 curl_handle = curl_easy_init();
547 if( NULL == curl_handle)
549 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Getting cURL handle failed\n");
552 curl_easy_setopt(curl_handle, CURLOPT_VERBOSE, 1L);
553 curl_easy_setopt(curl_handle, CURLOPT_READFUNCTION, read_callback);
554 curl_easy_setopt(curl_handle, CURLOPT_UPLOAD, 1L);
555 curl_easy_setopt(curl_handle, CURLOPT_PUT, 1L);
556 curl_easy_setopt(curl_handle, CURLOPT_URL, url);
557 curl_easy_setopt(curl_handle, CURLOPT_READDATA, msgbuf);
558 curl_easy_setopt(curl_handle, CURLOPT_INFILESIZE_LARGE,
559 (curl_off_t)msgbuf_size);
569 * Function that can be used to force the plugin to disconnect
570 * from the given peer and cancel all previous transmissions
571 * (and their continuationc).
574 * @param target peer from which to disconnect
577 template_plugin_disconnect (void *cls,
578 const struct GNUNET_PeerIdentity *target)
580 // struct Plugin *plugin = cls;
586 * Convert the transports address to a nice, human-readable
590 * @param type name of the transport that generated the address
591 * @param addr one of the addresses of the host, NULL for the last address
592 * the specific address format depends on the transport
593 * @param addrlen length of the address
594 * @param numeric should (IP) addresses be displayed in numeric form?
595 * @param timeout after how long should we give up?
596 * @param asc function to call on each string
597 * @param asc_cls closure for asc
600 template_plugin_address_pretty_printer (void *cls,
605 struct GNUNET_TIME_Relative timeout,
606 GNUNET_TRANSPORT_AddressStringCallback
615 * Another peer has suggested an address for this
616 * peer and transport plugin. Check that this could be a valid
617 * address. If so, consider adding it to the list
621 * @param addr pointer to the address
622 * @param addrlen length of addr
623 * @return GNUNET_OK if this is a plausible address for this peer
627 template_plugin_address_suggested (void *cls,
628 void *addr, size_t addrlen)
630 /* struct Plugin *plugin = cls; */
632 /* check if the address is plausible; if so,
633 add it to our list! */
639 * Function called for a quick conversion of the binary address to
640 * a numeric address. Note that the caller must not free the
641 * address and that the next call to this function is allowed
642 * to override the address again.
645 * @param addr binary address
646 * @param addrlen length of the address
647 * @return string representing the same address
650 template_plugin_address_to_string (void *cls,
659 * Exit point from the plugin.
662 libgnunet_plugin_transport_http_done (void *cls)
664 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
665 struct Plugin *plugin = api->cls;
667 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Unloading http plugin...\n");
669 if ( http_task_v4 != GNUNET_SCHEDULER_NO_TASK)
671 GNUNET_SCHEDULER_cancel(plugin->env->sched, http_task_v4);
672 http_task_v4 = GNUNET_SCHEDULER_NO_TASK;
675 if ( http_task_v6 != GNUNET_SCHEDULER_NO_TASK)
677 GNUNET_SCHEDULER_cancel(plugin->env->sched, http_task_v6);
678 http_task_v6 = GNUNET_SCHEDULER_NO_TASK;
681 if (http_daemon_v4 != NULL)
683 MHD_stop_daemon (http_daemon_v4);
684 http_daemon_v4 = NULL;
686 if (http_daemon_v6 != NULL)
688 MHD_stop_daemon (http_daemon_v6);
689 http_daemon_v6 = NULL;
692 curl_multi_cleanup(multi_handle);
694 GNUNET_free (current_ip);
695 GNUNET_free (plugin);
702 * Entry point for the plugin.
705 libgnunet_plugin_transport_http_init (void *cls)
707 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
708 struct GNUNET_TRANSPORT_PluginFunctions *api;
710 long long unsigned int port;
712 plugin = GNUNET_malloc (sizeof (struct Plugin));
714 plugin->sessions = NULL;
715 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
717 api->send = &template_plugin_send;
718 api->disconnect = &template_plugin_disconnect;
719 api->address_pretty_printer = &template_plugin_address_pretty_printer;
720 api->check_address = &template_plugin_address_suggested;
721 api->address_to_string = &template_plugin_address_to_string;
723 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting http plugin...\n");
724 /* Reading port number from config file */
726 GNUNET_CONFIGURATION_get_value_number (env->cfg,
732 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
735 ("Require valid port number for transport plugin `%s' in configuration!\n"),
737 libgnunet_plugin_transport_http_done (api);
741 current_ip = GNUNET_malloc ( sizeof(struct sockaddr_in) );
742 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Address %p\n",current_ip);
743 if ((http_daemon_v4 == NULL) && (http_daemon_v6 == NULL) && (port != 0))
745 http_daemon_v6 = MHD_start_daemon (MHD_USE_IPv6,
747 &acceptPolicyCallback,
748 current_ip, &accessHandlerCallback, current_ip,
749 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
750 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
751 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
752 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
753 MHD_OPTION_NOTIFY_COMPLETED, &requestCompletedCallback, NULL,
755 http_daemon_v4 = MHD_start_daemon (MHD_NO_FLAG,
757 &acceptPolicyCallback,
758 current_ip, &accessHandlerCallback, current_ip,
759 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
760 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
761 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
762 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
763 MHD_OPTION_NOTIFY_COMPLETED, &requestCompletedCallback, NULL,
767 if (http_daemon_v4 != NULL)
768 http_task_v4 = http_daemon_prepare (http_daemon_v4);
769 if (http_daemon_v6 != NULL)
770 http_task_v6 = http_daemon_prepare (http_daemon_v6);
772 if (http_task_v4 != GNUNET_SCHEDULER_NO_TASK)
773 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting MHD with IPv4 on port %u\n",port);
774 if (http_task_v6 != GNUNET_SCHEDULER_NO_TASK)
775 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting MHD with IPv4 and IPv6 on port %u\n",port);
777 /* Initializing cURL */
778 multi_handle = curl_multi_init();
783 /* end of plugin_transport_template.c */