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;
146 * Number of active sessions
149 unsigned int session_count;
154 * Daemon for listening for new IPv4 connections.
156 static struct MHD_Daemon *http_daemon_v4;
159 * Daemon for listening for new IPv6connections.
161 static struct MHD_Daemon *http_daemon_v6;
164 * Our primary task for http daemon handling IPv4 connections
166 static GNUNET_SCHEDULER_TaskIdentifier http_task_v4;
169 * Our primary task for http daemon handling IPv6 connections
171 static GNUNET_SCHEDULER_TaskIdentifier http_task_v6;
177 static struct Plugin *plugin;
182 static CURLM *multi_handle;
185 * session of current incoming connection
187 static struct Session * current_session;
189 static unsigned int locked;
192 * Finds a http session in our linked list using peer identity as a key
193 * @param peer peeridentity
194 * @return http session corresponding to peer identity
196 static struct Session * find_session_by_pi( const struct GNUNET_PeerIdentity *peer )
198 struct Session * cur;
199 GNUNET_HashCode hc_peer;
200 GNUNET_HashCode hc_current;
202 cur = plugin->sessions;
203 hc_peer = peer->hashPubKey;
206 hc_current = cur->sender.hashPubKey;
207 if ( 0 == GNUNET_CRYPTO_hash_cmp( &hc_peer, &hc_current))
209 cur = plugin->sessions->next;
216 * Finds a http session in our linked list using peer identity as a key
217 * @param peer peeridentity
218 * @return http session corresponding to peer identity
220 static struct Session * find_session_by_ip( struct sockaddr_in * addr )
223 struct Session * cur;
225 cur = plugin->sessions;
228 hc_current = cur->sender.hashPubKey;
229 if ( 0 == GNUNET_CRYPTO_hash_cmp( &hc_peer, &hc_current))
231 cur = plugin->sessions->next;
239 * Creates a http session in our linked list by peer identity
240 * Only peer is set here, all other fields have to be set by calling method
241 * @param peer peeridentity
242 * @return created http session
244 static struct Session * create_session_by_pi( const struct GNUNET_PeerIdentity *peer )
246 struct Session * cur;
247 struct Session * last_in_list;
248 /* Create a new session object */
249 cur = GNUNET_malloc (sizeof (struct Session));
250 memcpy( &(cur->sender), peer, sizeof( struct GNUNET_PeerIdentity ) );
254 /* Insert into linked list */
255 last_in_list = plugin->sessions;
256 while (last_in_list->next != NULL)
258 last_in_list = last_in_list->next;
260 last_in_list->next = cur;
267 * Creates a http session in our linked list by ip address
268 * Only ip is set here, all other fields have to be set by calling method
269 * @param peer peeridentity
270 * @return created http session
272 static struct Session * create_session_by_ip ( struct sockaddr_in * addr )
274 struct Session * cur;
275 struct Session * last_in_list;
276 /* Create a new session object */
277 cur = GNUNET_malloc (sizeof (struct Session));
278 // FIXME: memcpy( &(cur->ip), , sizeof( struct GNUNET_PeerIdentity ) );
282 /* Insert into linked list */
283 last_in_list = plugin->sessions;
284 while (last_in_list->next != NULL)
286 last_in_list = last_in_list->next;
288 last_in_list->next = cur;
295 * Callback called by MHD when a connection is terminated
297 static void requestCompletedCallback (void *cls, struct MHD_Connection * connection, void **httpSessionCache)
299 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Connection was terminated\n");
300 /* clean up session here*/
305 * Check if we are allowed to connect to the given IP.
308 acceptPolicyCallback (void *cls,
309 const struct sockaddr *addr, socklen_t addr_len)
311 struct sockaddr_in *addrin;
312 struct sockaddr_in6 *addrin6;
313 char * address = NULL;
315 if ( GNUNET_YES == locked )
317 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Incoming connections not accepted, rejecting connection\n");
321 /* something went wrong since last attempt to connect, lost session to free */
322 if ( NULL != current_session )
324 GNUNET_free ( current_session->ip );
325 GNUNET_free ( current_session );
330 if (addr->sa_family == AF_INET6)
332 address = GNUNET_malloc (INET6_ADDRSTRLEN);
333 addrin6 = (struct sockaddr_in6 *) addr;
334 inet_ntop(addrin6->sin6_family, &(addrin6->sin6_addr),address,INET6_ADDRSTRLEN);
335 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Incoming IPv6 connection from `%s'\n",address);
337 else if (addr->sa_family == AF_INET)
339 address = GNUNET_malloc(INET_ADDRSTRLEN);
340 addrin = (struct sockaddr_in *) addr;
341 inet_ntop(addrin->sin_family, &(addrin->sin_addr),address,INET_ADDRSTRLEN);
342 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Incoming IPv4 connection from `%s'\n",address);
344 /* are there any socket types besides ipv4 and ipv6 we want to support? */
347 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Unsupported connection type for incoming connection \n");
348 current_session = NULL;
353 /* create current session object */
354 current_session = GNUNET_malloc ( sizeof( struct Session) );
355 current_session->ip = address;
356 current_session->next = NULL;
358 /* Every connection is accepted, nothing more to do here */
364 * Process GET or PUT request received via MHD. For
365 * GET, queue response that will send back our pending
366 * messages. For PUT, process incoming data and send
367 * to GNUnet core. In either case, check if a session
368 * already exists and create a new one if not.
371 accessHandlerCallback (void *cls,
372 struct MHD_Connection *session,
376 const char *upload_data,
377 size_t * upload_data_size, void **httpSessionCache)
379 struct MHD_Response *response;
382 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"HTTP Daemon has an incoming `%s' request from `%s'\n",method, current_session->ip);
384 /* Check if new or already known session */
385 if ( NULL != current_session )
387 /* Insert session into linked list */
388 if ( plugin->sessions == NULL)
390 plugin->sessions = current_session;
391 plugin->session_count = 1;
394 cs = plugin->sessions;
395 while ( cs->next != NULL )
400 if (cs != current_session)
402 cs->next = current_session;
403 plugin->session_count++;
407 cs = plugin->sessions;
408 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Sessions in list %u \n",plugin->session_count);
411 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Session: %s \n",cs->ip);
416 if (*httpSessionCache == NULL)
418 *httpSessionCache = current_session;
422 /* Since connection is established, we can unlock */
424 current_session = NULL;
426 /* Is it a PUT or a GET request */
427 if ( 0 == strcmp (MHD_HTTP_METHOD_PUT, method) )
429 /* PUT method here */
430 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Got PUT Request with size %lu \n",(*upload_data_size));
431 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"URL: `%s'\n",url);
432 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"PUT Request: `%s'\n",upload_data);
433 /* FIXME: GNUNET_STATISTICS_update( plugin->env->stats , gettext_noop("# PUT requests"), 1, GNUNET_NO); */
435 *upload_data_size = 0;
436 response = MHD_create_response_from_data (strlen (HTTP_PUT_RESPONSE),HTTP_PUT_RESPONSE, MHD_NO, MHD_NO);
437 MHD_queue_response (session, MHD_HTTP_OK, response);
438 MHD_destroy_response (response);
440 if ( 0 == strcmp (MHD_HTTP_METHOD_GET, method) )
442 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Got GET Request\n");
443 //GNUNET_STATISTICS_update( plugin->env->stats , gettext_noop("# GET requests"), 1, GNUNET_NO);
451 * Call MHD to process pending requests and then go back
452 * and schedule the next run.
454 static void http_daemon_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
457 * Function that queries MHD's select sets and
458 * starts the task waiting for them.
460 static GNUNET_SCHEDULER_TaskIdentifier
461 http_daemon_prepare (struct MHD_Daemon *daemon_handle)
463 GNUNET_SCHEDULER_TaskIdentifier ret;
467 struct GNUNET_NETWORK_FDSet *wrs;
468 struct GNUNET_NETWORK_FDSet *wws;
469 struct GNUNET_NETWORK_FDSet *wes;
471 unsigned long long timeout;
473 struct GNUNET_TIME_Relative tv;
478 wrs = GNUNET_NETWORK_fdset_create ();
479 wes = GNUNET_NETWORK_fdset_create ();
480 wws = GNUNET_NETWORK_fdset_create ();
482 GNUNET_assert (MHD_YES ==
483 MHD_get_fdset (daemon_handle,
488 haveto = MHD_get_timeout (daemon_handle, &timeout);
489 if (haveto == MHD_YES)
490 tv.value = (uint64_t) timeout;
492 tv = GNUNET_TIME_UNIT_FOREVER_REL;
493 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max);
494 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max);
495 GNUNET_NETWORK_fdset_copy_native (wes, &es, max);
496 ret = GNUNET_SCHEDULER_add_select (plugin->env->sched,
497 GNUNET_SCHEDULER_PRIORITY_HIGH,
498 GNUNET_SCHEDULER_NO_TASK,
504 GNUNET_NETWORK_fdset_destroy (wrs);
505 GNUNET_NETWORK_fdset_destroy (wws);
506 GNUNET_NETWORK_fdset_destroy (wes);
511 * Call MHD to process pending requests and then go back
512 * and schedule the next run.
515 http_daemon_run (void *cls,
516 const struct GNUNET_SCHEDULER_TaskContext *tc)
518 struct MHD_Daemon *daemon_handle = cls;
520 if (daemon_handle == http_daemon_v4)
521 http_task_v4 = GNUNET_SCHEDULER_NO_TASK;
523 if (daemon_handle == http_daemon_v6)
524 http_task_v6 = GNUNET_SCHEDULER_NO_TASK;
526 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
531 GNUNET_assert (MHD_YES == MHD_run (daemon_handle));
532 if (daemon_handle == http_daemon_v4)
533 http_task_v4 = http_daemon_prepare (daemon_handle);
534 if (daemon_handle == http_daemon_v6)
535 http_task_v6 = http_daemon_prepare (daemon_handle);
539 static size_t read_callback(void *ptr, size_t size, size_t nmemb, void *stream)
543 fprintf(stdout, "*** Read callback: size %u, size nmemb: %u \n", size, nmemb);
544 retcode = fread(ptr, size, nmemb, stream);
551 * Function that can be used by the transport service to transmit
552 * a message using the plugin.
555 * @param target who should receive this message
556 * @param priority how important is the message
557 * @param msgbuf the message to transmit
558 * @param msgbuf_size number of bytes in 'msgbuf'
559 * @param timeout when should we time out
560 * @param session which session must be used (or NULL for "any")
561 * @param addr the address to use (can be NULL if the plugin
562 * is "on its own" (i.e. re-use existing TCP connection))
563 * @param addrlen length of the address in bytes
564 * @param force_address GNUNET_YES if the plugin MUST use the given address,
565 * otherwise the plugin may use other addresses or
566 * existing connections (if available)
567 * @param cont continuation to call once the message has
568 * been transmitted (or if the transport is ready
569 * for the next transmission call; or if the
570 * peer disconnected...)
571 * @param cont_cls closure for cont
572 * @return number of bytes used (on the physical network, with overheads);
573 * -1 on hard errors (i.e. address invalid); 0 is a legal value
574 * and does NOT mean that the message was not transmitted (DV)
577 template_plugin_send (void *cls,
578 const struct GNUNET_PeerIdentity *
582 unsigned int priority,
583 struct GNUNET_TIME_Relative timeout,
584 struct Session *session,
588 GNUNET_TRANSPORT_TransmitContinuation
589 cont, void *cont_cls)
593 /* struct Plugin *plugin = cls; */
597 /* find session for peer */
598 ses = find_session_by_pi (target);
599 if ( ses == NULL) create_session_by_pi (target);
601 char *url = "http://localhost:12389";
603 curl_handle = curl_easy_init();
604 if( NULL == curl_handle)
606 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Getting cURL handle failed\n");
609 curl_easy_setopt(curl_handle, CURLOPT_VERBOSE, 1L);
610 curl_easy_setopt(curl_handle, CURLOPT_READFUNCTION, read_callback);
611 curl_easy_setopt(curl_handle, CURLOPT_UPLOAD, 1L);
612 curl_easy_setopt(curl_handle, CURLOPT_PUT, 1L);
613 curl_easy_setopt(curl_handle, CURLOPT_URL, url);
614 curl_easy_setopt(curl_handle, CURLOPT_READDATA, msgbuf);
615 curl_easy_setopt(curl_handle, CURLOPT_INFILESIZE_LARGE,
616 (curl_off_t)msgbuf_size);
626 * Function that can be used to force the plugin to disconnect
627 * from the given peer and cancel all previous transmissions
628 * (and their continuationc).
631 * @param target peer from which to disconnect
634 template_plugin_disconnect (void *cls,
635 const struct GNUNET_PeerIdentity *target)
637 // struct Plugin *plugin = cls;
643 * Convert the transports address to a nice, human-readable
647 * @param type name of the transport that generated the address
648 * @param addr one of the addresses of the host, NULL for the last address
649 * the specific address format depends on the transport
650 * @param addrlen length of the address
651 * @param numeric should (IP) addresses be displayed in numeric form?
652 * @param timeout after how long should we give up?
653 * @param asc function to call on each string
654 * @param asc_cls closure for asc
657 template_plugin_address_pretty_printer (void *cls,
662 struct GNUNET_TIME_Relative timeout,
663 GNUNET_TRANSPORT_AddressStringCallback
672 * Another peer has suggested an address for this
673 * peer and transport plugin. Check that this could be a valid
674 * address. If so, consider adding it to the list
678 * @param addr pointer to the address
679 * @param addrlen length of addr
680 * @return GNUNET_OK if this is a plausible address for this peer
684 template_plugin_address_suggested (void *cls,
685 void *addr, size_t addrlen)
687 /* struct Plugin *plugin = cls; */
689 /* check if the address is plausible; if so,
690 add it to our list! */
696 * Function called for a quick conversion of the binary address to
697 * a numeric address. Note that the caller must not free the
698 * address and that the next call to this function is allowed
699 * to override the address again.
702 * @param addr binary address
703 * @param addrlen length of the address
704 * @return string representing the same address
707 template_plugin_address_to_string (void *cls,
716 * Exit point from the plugin.
719 libgnunet_plugin_transport_http_done (void *cls)
721 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
722 struct Plugin *plugin = api->cls;
724 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Unloading http plugin...\n");
726 if ( http_task_v4 != GNUNET_SCHEDULER_NO_TASK)
728 GNUNET_SCHEDULER_cancel(plugin->env->sched, http_task_v4);
729 http_task_v4 = GNUNET_SCHEDULER_NO_TASK;
732 if ( http_task_v6 != GNUNET_SCHEDULER_NO_TASK)
734 GNUNET_SCHEDULER_cancel(plugin->env->sched, http_task_v6);
735 http_task_v6 = GNUNET_SCHEDULER_NO_TASK;
738 if (http_daemon_v4 != NULL)
740 MHD_stop_daemon (http_daemon_v4);
741 http_daemon_v4 = NULL;
743 if (http_daemon_v6 != NULL)
745 MHD_stop_daemon (http_daemon_v6);
746 http_daemon_v6 = NULL;
749 curl_multi_cleanup(multi_handle);
751 GNUNET_free (plugin);
758 * Entry point for the plugin.
761 libgnunet_plugin_transport_http_init (void *cls)
763 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
764 struct GNUNET_TRANSPORT_PluginFunctions *api;
766 long long unsigned int port;
768 plugin = GNUNET_malloc (sizeof (struct Plugin));
770 plugin->sessions = NULL;
771 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
773 api->send = &template_plugin_send;
774 api->disconnect = &template_plugin_disconnect;
775 api->address_pretty_printer = &template_plugin_address_pretty_printer;
776 api->check_address = &template_plugin_address_suggested;
777 api->address_to_string = &template_plugin_address_to_string;
779 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting http plugin...\n");
780 /* Reading port number from config file */
782 GNUNET_CONFIGURATION_get_value_number (env->cfg,
788 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
791 ("Require valid port number for transport plugin `%s' in configuration!\n"),
793 libgnunet_plugin_transport_http_done (api);
797 if ((http_daemon_v4 == NULL) && (http_daemon_v6 == NULL) && (port != 0))
799 http_daemon_v6 = MHD_start_daemon (MHD_USE_IPv6,
801 &acceptPolicyCallback,
802 NULL , &accessHandlerCallback, NULL,
803 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
804 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
805 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
806 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
807 MHD_OPTION_NOTIFY_COMPLETED, &requestCompletedCallback, NULL,
809 http_daemon_v4 = MHD_start_daemon (MHD_NO_FLAG,
811 &acceptPolicyCallback,
812 NULL , &accessHandlerCallback, NULL,
813 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
814 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
815 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
816 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
817 MHD_OPTION_NOTIFY_COMPLETED, &requestCompletedCallback, NULL,
822 if (http_daemon_v4 != NULL)
823 http_task_v4 = http_daemon_prepare (http_daemon_v4);
824 if (http_daemon_v6 != NULL)
825 http_task_v6 = http_daemon_prepare (http_daemon_v6);
827 if (http_task_v4 != GNUNET_SCHEDULER_NO_TASK)
828 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting MHD with IPv4 on port %u\n",port);
829 if (http_task_v6 != GNUNET_SCHEDULER_NO_TASK)
830 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting MHD with IPv4 and IPv6 on port %u\n",port);
832 /* Initializing cURL */
833 multi_handle = curl_multi_init();
838 /* end of plugin_transport_template.c */