2 This file is part of GNUnet.
3 Copyright (C) 2012-2015 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 3, 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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @author Martin Schanzenbach
22 * @file src/rest/gnunet-rest-server.c
23 * @brief REST service for GNUnet services
27 #include <microhttpd.h>
28 #include "gnunet_util_lib.h"
29 #include "gnunet_rest_plugin.h"
33 * Default Socks5 listen port.
35 #define GNUNET_REST_SERVICE_PORT 7776
38 * Maximum supported length for a URI.
39 * Should die. @deprecated
41 #define MAX_HTTP_URI_LENGTH 2048
44 * Port for plaintext HTTP.
51 #define HTTPS_PORT 443
54 * After how long do we clean up unused MHD SSL/TLS instances?
56 #define MHD_CACHE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
58 #define GN_REST_STATE_INIT 0
59 #define GN_REST_STATE_PROCESSING 1
64 static struct GNUNET_SCHEDULER_Task * httpd_task;
67 * The port the service is running on (default 7776)
69 static unsigned long port = GNUNET_REST_SERVICE_PORT;
72 * The listen socket of the service for IPv4
74 static struct GNUNET_NETWORK_Handle *lsock4;
77 * The listen socket of the service for IPv6
79 static struct GNUNET_NETWORK_Handle *lsock6;
82 * The listen task ID for IPv4
84 static struct GNUNET_SCHEDULER_Task * ltask4;
87 * The listen task ID for IPv6
89 static struct GNUNET_SCHEDULER_Task * ltask6;
94 static struct MHD_Daemon *httpd;
97 * Response we return on failures.
99 static struct MHD_Response *failure_response;
104 static const struct GNUNET_CONFIGURATION_Handle *cfg;
107 * Map of loaded plugins.
109 static struct GNUNET_CONTAINER_MultiHashMap *plugin_map;
112 * Allowed Origins (CORS)
114 static char* allow_origin;
117 * Allowed Headers (CORS)
119 static char* allow_headers;
122 * MHD Connection handle
124 struct MhdConnectionHandle
126 struct MHD_Connection *con;
128 struct MHD_Response *response;
130 struct GNUNET_REST_Plugin *plugin;
132 struct RestConnectionDataHandle *data_handle;
139 /* ************************* Global helpers ********************* */
143 * Task run whenever HTTP server operations are pending.
146 * @param tc sched context
150 const struct GNUNET_SCHEDULER_TaskContext *tc);
154 * Run MHD now, we have extra data ready for the callback.
161 GNUNET_SCHEDULER_cancel (httpd_task);
162 httpd_task = GNUNET_SCHEDULER_add_now (&do_httpd,
167 * Plugin result callback
169 * @param cls closure (MHD connection handle)
170 * @param data the data to return to the caller
171 * @param len length of the data
172 * @param status #GNUNET_OK if successful
175 plugin_callback (void *cls,
176 struct MHD_Response *resp,
179 struct MhdConnectionHandle *handle = cls;
180 handle->status = status;
181 handle->response = resp;
187 cleanup_url_map (void *cls,
188 const struct GNUNET_HashCode *key,
191 GNUNET_free_non_null (value);
197 cleanup_handle (struct MhdConnectionHandle *handle)
199 if (NULL != handle->response)
200 MHD_destroy_response (handle->response);
201 if (NULL != handle->data_handle)
203 if (NULL != handle->data_handle->url_param_map)
205 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->url_param_map,
208 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->url_param_map);
210 GNUNET_free (handle->data_handle);
212 GNUNET_free (handle);
217 url_iterator (void *cls,
218 enum MHD_ValueKind kind,
222 struct RestConnectionDataHandle *handle = cls;
223 struct GNUNET_HashCode hkey;
226 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
227 GNUNET_asprintf (&val, "%s", value);
229 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
232 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
234 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
235 "Could not load add url param `%s'=%s\n",
241 /* ********************************* MHD response generation ******************* */
244 * Main MHD callback for handling requests.
247 * @param con MHD connection handle
248 * @param url the url in the request
249 * @param meth the HTTP method used ("GET", "PUT", etc.)
250 * @param ver the HTTP version string (i.e. "HTTP/1.1")
251 * @param upload_data the data being uploaded (excluding HEADERS,
252 * for a POST that fits into memory and that is encoded
253 * with a supported encoding, the POST data will NOT be
254 * given in upload_data and is instead available as
255 * part of MHD_get_connection_values; very large POST
256 * data *will* be made available incrementally in
258 * @param upload_data_size set initially to the size of the
259 * @a upload_data provided; the method must update this
260 * value to the number of bytes NOT processed;
261 * @param con_cls pointer to location where we store the 'struct Request'
262 * @return MHD_YES if the connection was handled successfully,
263 * MHD_NO if the socket must be closed due to a serious
264 * error while handling the request
267 create_response (void *cls,
268 struct MHD_Connection *con,
272 const char *upload_data,
273 size_t *upload_data_size,
277 struct GNUNET_HashCode key;
278 struct MhdConnectionHandle *con_handle;
279 struct RestConnectionDataHandle *rest_conndata_handle;
281 con_handle = *con_cls;
283 if (NULL == *con_cls)
285 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
286 "New connection %s\n", url);
287 char tmp_url[strlen(url)+1];
288 strcpy (tmp_url, url);
289 con_handle = GNUNET_new (struct MhdConnectionHandle);
290 con_handle->con = con;
291 con_handle->state = GN_REST_STATE_INIT;
292 *con_cls = con_handle;
294 plugin_name = strtok(tmp_url, "/");
296 if (NULL != plugin_name)
298 GNUNET_CRYPTO_hash (plugin_name, strlen (plugin_name), &key);
300 con_handle->plugin = GNUNET_CONTAINER_multihashmap_get (plugin_map,
303 if (NULL == con_handle->plugin)
305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
306 "Queueing response with MHD\n");
307 GNUNET_free (con_handle);
308 return MHD_queue_response (con,
314 if (GN_REST_STATE_INIT == con_handle->state)
316 rest_conndata_handle = GNUNET_new (struct RestConnectionDataHandle);
317 rest_conndata_handle->method = meth;
318 rest_conndata_handle->url = url;
319 rest_conndata_handle->data = upload_data;
320 rest_conndata_handle->data_size = *upload_data_size;
321 rest_conndata_handle->url_param_map = GNUNET_CONTAINER_multihashmap_create (16,
323 con_handle->data_handle = rest_conndata_handle;
324 MHD_get_connection_values (con,
325 MHD_GET_ARGUMENT_KIND,
327 rest_conndata_handle);
328 con_handle->state = GN_REST_STATE_PROCESSING;
329 con_handle->plugin->process_request (rest_conndata_handle,
332 *upload_data_size = 0;
334 if (NULL != con_handle->response)
336 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
337 "Queueing response from plugin with MHD\n");
339 if (NULL != allow_origin)
341 MHD_add_response_header (con_handle->response,
342 MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
345 if (NULL != allow_headers)
347 MHD_add_response_header (con_handle->response,
348 "Access-Control-Allow-Headers",
351 int ret = MHD_queue_response (con,
353 con_handle->response);
354 cleanup_handle (con_handle);
361 /* ******************** MHD HTTP setup and event loop ******************** */
364 * Function called when MHD decides that we are done with a connection.
367 * @param connection connection handle
368 * @param con_cls value as set by the last call to
369 * the MHD_AccessHandlerCallback, should be our handle
370 * @param toe reason for request termination (ignored)
373 mhd_completed_cb (void *cls,
374 struct MHD_Connection *connection,
376 enum MHD_RequestTerminationCode toe)
378 if (MHD_REQUEST_TERMINATED_COMPLETED_OK != toe)
379 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
380 "MHD encountered error handling request: %d\n",
386 * Kill the MHD daemon.
393 MHD_stop_daemon (httpd);
396 if (NULL != httpd_task)
398 GNUNET_SCHEDULER_cancel (httpd_task);
405 * Task run whenever HTTP server is idle for too long. Kill it.
408 * @param tc sched context
411 kill_httpd_task (void *cls,
412 const struct GNUNET_SCHEDULER_TaskContext *tc)
420 * Schedule MHD. This function should be called initially when an
421 * MHD is first getting its client socket, and will then automatically
422 * always be called later whenever there is work to be done.
424 * @param hd the daemon to schedule
432 struct GNUNET_NETWORK_FDSet *wrs;
433 struct GNUNET_NETWORK_FDSet *wws;
436 MHD_UNSIGNED_LONG_LONG timeout;
437 struct GNUNET_TIME_Relative tv;
443 if (MHD_YES != MHD_get_fdset (httpd, &rs, &ws, &es, &max))
448 haveto = MHD_get_timeout (httpd, &timeout);
449 if (MHD_YES == haveto)
450 tv.rel_value_us = (uint64_t) timeout * 1000LL;
452 tv = GNUNET_TIME_UNIT_FOREVER_REL;
455 wrs = GNUNET_NETWORK_fdset_create ();
456 wws = GNUNET_NETWORK_fdset_create ();
457 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
458 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
465 if (NULL != httpd_task)
466 GNUNET_SCHEDULER_cancel (httpd_task);
467 if ( (MHD_YES != haveto) &&
470 /* daemon is idle, kill after timeout */
471 httpd_task = GNUNET_SCHEDULER_add_delayed (MHD_CACHE_TIMEOUT,
478 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
483 GNUNET_NETWORK_fdset_destroy (wrs);
485 GNUNET_NETWORK_fdset_destroy (wws);
489 * Task run whenever HTTP server operations are pending.
492 * @param tc scheduler context
496 const struct GNUNET_SCHEDULER_TaskContext *tc)
505 * Accept new incoming connections
507 * @param cls the closure with the lsock4 or lsock6
508 * @param tc the scheduler context
511 do_accept (void *cls,
512 const struct GNUNET_SCHEDULER_TaskContext *tc)
514 struct GNUNET_NETWORK_Handle *lsock = cls;
515 struct GNUNET_NETWORK_Handle *s;
517 const struct sockaddr *addr;
524 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
527 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
531 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
534 s = GNUNET_NETWORK_socket_accept (lsock, NULL, NULL);
537 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "accept");
540 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
541 "Got an inbound connection, waiting for data\n");
542 fd = GNUNET_NETWORK_get_fd (s);
543 addr = GNUNET_NETWORK_get_addr (s);
544 len = GNUNET_NETWORK_get_addrlen (s);
545 if (MHD_YES != MHD_add_connection (httpd, fd, addr, len))
547 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
548 _("Failed to pass client to MHD\n"));
557 * Task run on shutdown
560 * @param tc task context
563 do_shutdown (void *cls,
564 const struct GNUNET_SCHEDULER_TaskContext *tc)
566 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
567 "Shutting down...\n");
569 GNUNET_free_non_null (allow_origin);
570 GNUNET_free_non_null (allow_headers);
575 * Create an IPv4 listen socket bound to our port.
577 * @return NULL on error
579 static struct GNUNET_NETWORK_Handle *
582 struct GNUNET_NETWORK_Handle *ls;
583 struct sockaddr_in sa4;
586 memset (&sa4, 0, sizeof (sa4));
587 sa4.sin_family = AF_INET;
588 sa4.sin_port = htons (port);
589 #if HAVE_SOCKADDR_IN_SIN_LEN
590 sa4.sin_len = sizeof (sa4);
592 ls = GNUNET_NETWORK_socket_create (AF_INET,
598 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa4,
602 GNUNET_NETWORK_socket_close (ls);
611 * Create an IPv6 listen socket bound to our port.
613 * @return NULL on error
615 static struct GNUNET_NETWORK_Handle *
618 struct GNUNET_NETWORK_Handle *ls;
619 struct sockaddr_in6 sa6;
622 memset (&sa6, 0, sizeof (sa6));
623 sa6.sin6_family = AF_INET6;
624 sa6.sin6_port = htons (port);
625 #if HAVE_SOCKADDR_IN_SIN_LEN
626 sa6.sin6_len = sizeof (sa6);
628 ls = GNUNET_NETWORK_socket_create (AF_INET6,
634 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa6,
638 GNUNET_NETWORK_socket_close (ls);
647 * Callback for plugin load
650 * @param libname the name of the library loaded
651 * @param lib_ret the object returned by the plugin initializer
654 load_plugin (void *cls,
658 struct GNUNET_REST_Plugin *plugin = lib_ret;
659 struct GNUNET_HashCode key;
662 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
663 "Could not load plugin `%s'\n",
667 GNUNET_assert (1 < strlen (plugin->name));
668 GNUNET_assert ('/' == *plugin->name);
669 GNUNET_CRYPTO_hash (plugin->name+1, strlen (plugin->name+1), &key);
670 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (plugin_map,
673 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
675 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
676 "Could not load add plugin `%s'\n",
680 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
681 "Loaded plugin `%s'\n",
687 * Main function that will be run
690 * @param args remaining command-line arguments
691 * @param cfgfile name of the configuration file used (for saving, can be NULL)
692 * @param c configuration
698 const struct GNUNET_CONFIGURATION_Handle *c)
701 plugin_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
703 /* Get CORS data from cfg */
704 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
708 //No origin specified
709 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
710 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
713 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
714 "REST_ALLOW_HEADERS",
717 //No origin specified
718 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
719 "No CORS Access-Control-Allow-Headers Header will be sent...\n");
722 /* Open listen socket proxy */
726 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
730 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock6, 5))
732 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
733 GNUNET_NETWORK_socket_close (lsock6);
738 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
739 lsock6, &do_accept, lsock6);
745 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
749 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock4, 5))
751 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
752 GNUNET_NETWORK_socket_close (lsock4);
757 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
758 lsock4, &do_accept, lsock4);
761 if ( (NULL == lsock4) &&
764 GNUNET_SCHEDULER_shutdown ();
767 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
768 "Service listens on port %u\n",
770 httpd = MHD_start_daemon (MHD_USE_DEBUG | MHD_USE_NO_LISTEN_SOCKET,
773 &create_response, NULL,
774 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
775 MHD_OPTION_NOTIFY_COMPLETED, &mhd_completed_cb, NULL,
779 GNUNET_SCHEDULER_shutdown ();
783 GNUNET_PLUGIN_load_all ("libgnunet_plugin_rest",
787 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
794 * The main function for gnunet-rest-service
796 * @param argc number of arguments from the cli
797 * @param argv command line arguments
798 * @return 0 ok, 1 on error
802 main (int argc, char *const *argv)
804 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
806 gettext_noop ("listen on specified port (default: 7776)"), 1,
807 &GNUNET_GETOPT_set_ulong, &port},
808 GNUNET_GETOPT_OPTION_END
810 static const char* err_page =
814 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
816 GNUNET_log_setup ("gnunet-rest-server", "WARNING", NULL);
817 failure_response = MHD_create_response_from_buffer (strlen(err_page),
819 MHD_RESPMEM_PERSISTENT);
822 GNUNET_PROGRAM_run (argc, argv, "gnunet-rest-server",
823 _("GNUnet REST server"),
826 MHD_destroy_response (failure_response);
827 GNUNET_free_non_null ((char *) argv);
831 /* end of gnunet-rest-server.c */