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;
193 * Finds a http session in our linked list using peer identity as a key
194 * @param peer peeridentity
195 * @return http session corresponding to peer identity
197 static struct Session * find_session_by_pi( const struct GNUNET_PeerIdentity *peer )
199 struct Session * cur;
200 GNUNET_HashCode hc_peer;
201 GNUNET_HashCode hc_current;
203 cur = plugin->sessions;
204 hc_peer = peer->hashPubKey;
207 hc_current = cur->sender.hashPubKey;
208 if ( 0 == GNUNET_CRYPTO_hash_cmp( &hc_peer, &hc_current))
210 cur = plugin->sessions->next;
217 * Finds a http session in our linked list using peer identity as a key
218 * @param peer peeridentity
219 * @return http session corresponding to peer identity
221 static struct Session * find_session_by_ip( char * ip )
224 struct Session * cur;
226 cur = plugin->sessions;
229 hc_current = cur->sender.hashPubKey;
230 if ( 0 == GNUNET_CRYPTO_hash_cmp( &hc_peer, &hc_current))
232 cur = plugin->sessions->next;
240 * Creates a http session in our linked list by peer identity
241 * Only peer is set here, all other fields have to be set by calling method
242 * @param peer peeridentity
243 * @return created http session
245 static struct Session * create_session_by_pi( const struct GNUNET_PeerIdentity *peer )
247 struct Session * cur;
248 struct Session * last_in_list;
249 /* Create a new session object */
250 cur = GNUNET_malloc (sizeof (struct Session));
251 memcpy( &(cur->sender), peer, sizeof( struct GNUNET_PeerIdentity ) );
255 /* Insert into linked list */
256 last_in_list = plugin->sessions;
257 while (last_in_list->next != NULL)
259 last_in_list = last_in_list->next;
261 last_in_list->next = cur;
268 * Creates a http session in our linked list by ip address
269 * Only ip is set here, all other fields have to be set by calling method
270 * @param peer peeridentity
271 * @return created http session
273 static struct Session * create_session_by_ip ( struct sockaddr_in * addr )
275 struct Session * cur;
276 struct Session * last_in_list;
277 /* Create a new session object */
278 cur = GNUNET_malloc (sizeof (struct Session));
279 // FIXME: memcpy( &(cur->ip), , sizeof( struct GNUNET_PeerIdentity ) );
283 /* Insert into linked list */
284 last_in_list = plugin->sessions;
285 while (last_in_list->next != NULL)
287 last_in_list = last_in_list->next;
289 last_in_list->next = cur;
296 * Callback called by MHD when a connection is terminated
298 static void requestCompletedCallback (void *cls, struct MHD_Connection * connection, void **httpSessionCache)
300 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Connection was terminated\n");
301 /* clean up session here*/
306 * Check if we are allowed to connect to the given IP.
309 acceptPolicyCallback (void *cls,
310 const struct sockaddr *addr, socklen_t addr_len)
312 struct sockaddr_in *addrin;
313 struct sockaddr_in6 *addrin6;
314 char * address = NULL;
317 if ( GNUNET_YES == locked )
319 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Incoming connections not accepted, rejecting connection\n");
323 /* something went wrong since last attempt to connect, lost session to free */
324 if ( NULL != current_session )
326 GNUNET_free ( current_session->ip );
327 GNUNET_free ( current_session );
332 if (addr->sa_family == AF_INET6)
334 address = GNUNET_malloc (INET6_ADDRSTRLEN);
335 addrin6 = (struct sockaddr_in6 *) addr;
336 inet_ntop(addrin6->sin6_family, &(addrin6->sin6_addr),address,INET6_ADDRSTRLEN);
337 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Incoming IPv6 connection from `%s'\n",address);
339 else if (addr->sa_family == AF_INET)
341 address = GNUNET_malloc(INET_ADDRSTRLEN);
342 addrin = (struct sockaddr_in *) addr;
343 inet_ntop(addrin->sin_family, &(addrin->sin_addr),address,INET_ADDRSTRLEN);
344 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Incoming IPv4 connection from `%s'\n",address);
346 /* are there any socket types besides ipv4 and ipv6 we want to support? */
349 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Unsupported connection type for incoming connection \n");
350 current_session = NULL;
355 /* get existing session for this address */
357 if (plugin->session_count > 0)
359 cs = plugin->sessions;
362 if ( 0 == strcmp(address,cs->ip))
364 /* existing session for this address found */
373 /* session to this addresse already existing */
374 current_session = cs;
378 /* create new session object */
379 current_session = GNUNET_malloc ( sizeof( struct Session) );
380 current_session->ip = address;
381 current_session->next = NULL;
383 /* Every connection is accepted, nothing more to do here */
389 * Process GET or PUT request received via MHD. For
390 * GET, queue response that will send back our pending
391 * messages. For PUT, process incoming data and send
392 * to GNUnet core. In either case, check if a session
393 * already exists and create a new one if not.
396 accessHandlerCallback (void *cls,
397 struct MHD_Connection *session,
401 const char *upload_data,
402 size_t * upload_data_size, void **httpSessionCache)
404 struct MHD_Response *response;
407 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"HTTP Daemon has an incoming `%s' request from `%s'\n",method, current_session->ip);
409 /* Check if new or already known session */
410 if ( NULL != current_session )
412 /* Insert session into linked list */
413 if ( plugin->sessions == NULL)
415 plugin->sessions = current_session;
416 plugin->session_count = 1;
419 cs = plugin->sessions;
420 while ( cs->next != NULL )
425 if (cs != current_session)
427 cs->next = current_session;
428 plugin->session_count++;
432 cs = plugin->sessions;
438 if (*httpSessionCache == NULL)
440 *httpSessionCache = current_session;
444 /* Since connection is established, we can unlock */
446 current_session = NULL;
448 /* Is it a PUT or a GET request */
449 if ( 0 == strcmp (MHD_HTTP_METHOD_PUT, method) )
451 /* PUT method here */
452 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Got PUT Request with size %lu \n",(*upload_data_size));
453 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"URL: `%s'\n",url);
454 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"PUT Request: `%s'\n",upload_data);
455 /* FIXME: GNUNET_STATISTICS_update( plugin->env->stats , gettext_noop("# PUT requests"), 1, GNUNET_NO); */
457 *upload_data_size = 0;
458 response = MHD_create_response_from_data (strlen (HTTP_PUT_RESPONSE),HTTP_PUT_RESPONSE, MHD_NO, MHD_NO);
459 MHD_queue_response (session, MHD_HTTP_OK, response);
460 MHD_destroy_response (response);
462 if ( 0 == strcmp (MHD_HTTP_METHOD_GET, method) )
464 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Got GET Request\n");
465 //GNUNET_STATISTICS_update( plugin->env->stats , gettext_noop("# GET requests"), 1, GNUNET_NO);
473 * Call MHD to process pending requests and then go back
474 * and schedule the next run.
476 static void http_daemon_run (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
479 * Function that queries MHD's select sets and
480 * starts the task waiting for them.
482 static GNUNET_SCHEDULER_TaskIdentifier
483 http_daemon_prepare (struct MHD_Daemon *daemon_handle)
485 GNUNET_SCHEDULER_TaskIdentifier ret;
489 struct GNUNET_NETWORK_FDSet *wrs;
490 struct GNUNET_NETWORK_FDSet *wws;
491 struct GNUNET_NETWORK_FDSet *wes;
493 unsigned long long timeout;
495 struct GNUNET_TIME_Relative tv;
500 wrs = GNUNET_NETWORK_fdset_create ();
501 wes = GNUNET_NETWORK_fdset_create ();
502 wws = GNUNET_NETWORK_fdset_create ();
504 GNUNET_assert (MHD_YES ==
505 MHD_get_fdset (daemon_handle,
510 haveto = MHD_get_timeout (daemon_handle, &timeout);
511 if (haveto == MHD_YES)
512 tv.value = (uint64_t) timeout;
514 tv = GNUNET_TIME_UNIT_FOREVER_REL;
515 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max);
516 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max);
517 GNUNET_NETWORK_fdset_copy_native (wes, &es, max);
518 ret = GNUNET_SCHEDULER_add_select (plugin->env->sched,
519 GNUNET_SCHEDULER_PRIORITY_HIGH,
520 GNUNET_SCHEDULER_NO_TASK,
526 GNUNET_NETWORK_fdset_destroy (wrs);
527 GNUNET_NETWORK_fdset_destroy (wws);
528 GNUNET_NETWORK_fdset_destroy (wes);
533 * Call MHD to process pending requests and then go back
534 * and schedule the next run.
537 http_daemon_run (void *cls,
538 const struct GNUNET_SCHEDULER_TaskContext *tc)
540 struct MHD_Daemon *daemon_handle = cls;
542 if (daemon_handle == http_daemon_v4)
543 http_task_v4 = GNUNET_SCHEDULER_NO_TASK;
545 if (daemon_handle == http_daemon_v6)
546 http_task_v6 = GNUNET_SCHEDULER_NO_TASK;
548 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
553 GNUNET_assert (MHD_YES == MHD_run (daemon_handle));
554 if (daemon_handle == http_daemon_v4)
555 http_task_v4 = http_daemon_prepare (daemon_handle);
556 if (daemon_handle == http_daemon_v6)
557 http_task_v6 = http_daemon_prepare (daemon_handle);
561 static size_t read_callback(void *ptr, size_t size, size_t nmemb, void *stream)
565 fprintf(stdout, "*** Read callback: size %u, size nmemb: %u \n", size, nmemb);
566 retcode = fread(ptr, size, nmemb, stream);
573 * Function that can be used by the transport service to transmit
574 * a message using the plugin.
577 * @param target who should receive this message
578 * @param priority how important is the message
579 * @param msgbuf the message to transmit
580 * @param msgbuf_size number of bytes in 'msgbuf'
581 * @param timeout when should we time out
582 * @param session which session must be used (or NULL for "any")
583 * @param addr the address to use (can be NULL if the plugin
584 * is "on its own" (i.e. re-use existing TCP connection))
585 * @param addrlen length of the address in bytes
586 * @param force_address GNUNET_YES if the plugin MUST use the given address,
587 * otherwise the plugin may use other addresses or
588 * existing connections (if available)
589 * @param cont continuation to call once the message has
590 * been transmitted (or if the transport is ready
591 * for the next transmission call; or if the
592 * peer disconnected...)
593 * @param cont_cls closure for cont
594 * @return number of bytes used (on the physical network, with overheads);
595 * -1 on hard errors (i.e. address invalid); 0 is a legal value
596 * and does NOT mean that the message was not transmitted (DV)
599 template_plugin_send (void *cls,
600 const struct GNUNET_PeerIdentity *
604 unsigned int priority,
605 struct GNUNET_TIME_Relative timeout,
606 struct Session *session,
610 GNUNET_TRANSPORT_TransmitContinuation
611 cont, void *cont_cls)
615 /* struct Plugin *plugin = cls; */
619 /* find session for peer */
620 ses = find_session_by_pi (target);
621 if ( ses == NULL) create_session_by_pi (target);
623 char *url = "http://localhost:12389";
625 curl_handle = curl_easy_init();
626 if( NULL == curl_handle)
628 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Getting cURL handle failed\n");
631 curl_easy_setopt(curl_handle, CURLOPT_VERBOSE, 1L);
632 curl_easy_setopt(curl_handle, CURLOPT_READFUNCTION, read_callback);
633 curl_easy_setopt(curl_handle, CURLOPT_UPLOAD, 1L);
634 curl_easy_setopt(curl_handle, CURLOPT_PUT, 1L);
635 curl_easy_setopt(curl_handle, CURLOPT_URL, url);
636 curl_easy_setopt(curl_handle, CURLOPT_READDATA, msgbuf);
637 curl_easy_setopt(curl_handle, CURLOPT_INFILESIZE_LARGE,
638 (curl_off_t)msgbuf_size);
648 * Function that can be used to force the plugin to disconnect
649 * from the given peer and cancel all previous transmissions
650 * (and their continuationc).
653 * @param target peer from which to disconnect
656 template_plugin_disconnect (void *cls,
657 const struct GNUNET_PeerIdentity *target)
659 // struct Plugin *plugin = cls;
665 * Convert the transports address to a nice, human-readable
669 * @param type name of the transport that generated the address
670 * @param addr one of the addresses of the host, NULL for the last address
671 * the specific address format depends on the transport
672 * @param addrlen length of the address
673 * @param numeric should (IP) addresses be displayed in numeric form?
674 * @param timeout after how long should we give up?
675 * @param asc function to call on each string
676 * @param asc_cls closure for asc
679 template_plugin_address_pretty_printer (void *cls,
684 struct GNUNET_TIME_Relative timeout,
685 GNUNET_TRANSPORT_AddressStringCallback
694 * Another peer has suggested an address for this
695 * peer and transport plugin. Check that this could be a valid
696 * address. If so, consider adding it to the list
700 * @param addr pointer to the address
701 * @param addrlen length of addr
702 * @return GNUNET_OK if this is a plausible address for this peer
706 template_plugin_address_suggested (void *cls,
707 void *addr, size_t addrlen)
709 /* struct Plugin *plugin = cls; */
711 /* check if the address is plausible; if so,
712 add it to our list! */
718 * Function called for a quick conversion of the binary address to
719 * a numeric address. Note that the caller must not free the
720 * address and that the next call to this function is allowed
721 * to override the address again.
724 * @param addr binary address
725 * @param addrlen length of the address
726 * @return string representing the same address
729 template_plugin_address_to_string (void *cls,
738 * Exit point from the plugin.
741 libgnunet_plugin_transport_http_done (void *cls)
743 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
744 struct Plugin *plugin = api->cls;
746 struct Session * cs_next;
748 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Unloading http plugin...\n");
750 if ( http_task_v4 != GNUNET_SCHEDULER_NO_TASK)
752 GNUNET_SCHEDULER_cancel(plugin->env->sched, http_task_v4);
753 http_task_v4 = GNUNET_SCHEDULER_NO_TASK;
756 if ( http_task_v6 != GNUNET_SCHEDULER_NO_TASK)
758 GNUNET_SCHEDULER_cancel(plugin->env->sched, http_task_v6);
759 http_task_v6 = GNUNET_SCHEDULER_NO_TASK;
762 if (http_daemon_v4 != NULL)
764 MHD_stop_daemon (http_daemon_v4);
765 http_daemon_v4 = NULL;
767 if (http_daemon_v6 != NULL)
769 MHD_stop_daemon (http_daemon_v6);
770 http_daemon_v6 = NULL;
773 curl_multi_cleanup(multi_handle);
775 /* free all sessions */
776 cs = plugin->sessions;
780 GNUNET_free (cs->ip);
782 plugin->session_count--;
786 GNUNET_free (plugin);
793 * Entry point for the plugin.
796 libgnunet_plugin_transport_http_init (void *cls)
798 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
799 struct GNUNET_TRANSPORT_PluginFunctions *api;
801 long long unsigned int port;
803 plugin = GNUNET_malloc (sizeof (struct Plugin));
805 plugin->sessions = NULL;
806 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
808 api->send = &template_plugin_send;
809 api->disconnect = &template_plugin_disconnect;
810 api->address_pretty_printer = &template_plugin_address_pretty_printer;
811 api->check_address = &template_plugin_address_suggested;
812 api->address_to_string = &template_plugin_address_to_string;
814 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting http plugin...\n");
815 /* Reading port number from config file */
817 GNUNET_CONFIGURATION_get_value_number (env->cfg,
823 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
826 ("Require valid port number for transport plugin `%s' in configuration!\n"),
828 libgnunet_plugin_transport_http_done (api);
832 if ((http_daemon_v4 == NULL) && (http_daemon_v6 == NULL) && (port != 0))
834 http_daemon_v6 = MHD_start_daemon (MHD_USE_IPv6,
836 &acceptPolicyCallback,
837 NULL , &accessHandlerCallback, NULL,
838 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
839 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
840 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
841 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
842 MHD_OPTION_NOTIFY_COMPLETED, &requestCompletedCallback, NULL,
844 http_daemon_v4 = MHD_start_daemon (MHD_NO_FLAG,
846 &acceptPolicyCallback,
847 NULL , &accessHandlerCallback, NULL,
848 MHD_OPTION_CONNECTION_LIMIT, (unsigned int) 16,
849 MHD_OPTION_PER_IP_CONNECTION_LIMIT, (unsigned int) 1,
850 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
851 MHD_OPTION_CONNECTION_MEMORY_LIMIT, (size_t) (16 * 1024),
852 MHD_OPTION_NOTIFY_COMPLETED, &requestCompletedCallback, NULL,
857 if (http_daemon_v4 != NULL)
858 http_task_v4 = http_daemon_prepare (http_daemon_v4);
859 if (http_daemon_v6 != NULL)
860 http_task_v6 = http_daemon_prepare (http_daemon_v6);
862 if (http_task_v4 != GNUNET_SCHEDULER_NO_TASK)
863 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting MHD with IPv4 on port %u\n",port);
864 if (http_task_v6 != GNUNET_SCHEDULER_NO_TASK)
865 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,"Starting MHD with IPv4 and IPv6 on port %u\n",port);
867 /* Initializing cURL */
868 multi_handle = curl_multi_init();
873 /* end of plugin_transport_template.c */