2 This file is part of GNUnet.
3 Copyright (C) 2012-2015 GNUnet e.V.
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 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 GNUNET_REST_RequestHandle *data_handle;
139 /* ************************* Global helpers ********************* */
143 * Task run whenever HTTP server operations are pending.
148 do_httpd (void *cls);
152 * Run MHD now, we have extra data ready for the callback.
157 if (NULL != httpd_task)
159 GNUNET_SCHEDULER_cancel (httpd_task);
162 httpd_task = GNUNET_SCHEDULER_add_now (&do_httpd,
168 * Plugin result callback
170 * @param cls closure (MHD connection handle)
171 * @param data the data to return to the caller
172 * @param len length of the data
173 * @param status #GNUNET_OK if successful
176 plugin_callback (void *cls,
177 struct MHD_Response *resp,
180 struct MhdConnectionHandle *handle = cls;
181 handle->status = status;
182 handle->response = resp;
188 cleanup_url_map (void *cls,
189 const struct GNUNET_HashCode *key,
192 GNUNET_free_non_null (value);
198 cleanup_handle (struct MhdConnectionHandle *handle)
200 if (NULL != handle->response)
201 MHD_destroy_response (handle->response);
202 if (NULL != handle->data_handle)
204 if (NULL != handle->data_handle->url_param_map)
206 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->url_param_map,
209 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->url_param_map);
211 GNUNET_free (handle->data_handle);
213 GNUNET_free (handle);
218 url_iterator (void *cls,
219 enum MHD_ValueKind kind,
223 struct GNUNET_REST_RequestHandle *handle = cls;
224 struct GNUNET_HashCode hkey;
227 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
228 GNUNET_asprintf (&val, "%s", value);
230 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
233 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
235 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
236 "Could not load add url param `%s'=%s\n",
242 /* ********************************* MHD response generation ******************* */
245 * Main MHD callback for handling requests.
248 * @param con MHD connection handle
249 * @param url the url in the request
250 * @param meth the HTTP method used ("GET", "PUT", etc.)
251 * @param ver the HTTP version string (i.e. "HTTP/1.1")
252 * @param upload_data the data being uploaded (excluding HEADERS,
253 * for a POST that fits into memory and that is encoded
254 * with a supported encoding, the POST data will NOT be
255 * given in upload_data and is instead available as
256 * part of MHD_get_connection_values; very large POST
257 * data *will* be made available incrementally in
259 * @param upload_data_size set initially to the size of the
260 * @a upload_data provided; the method must update this
261 * value to the number of bytes NOT processed;
262 * @param con_cls pointer to location where we store the 'struct Request'
263 * @return MHD_YES if the connection was handled successfully,
264 * MHD_NO if the socket must be closed due to a serious
265 * error while handling the request
268 create_response (void *cls,
269 struct MHD_Connection *con,
273 const char *upload_data,
274 size_t *upload_data_size,
278 struct GNUNET_HashCode key;
279 struct MhdConnectionHandle *con_handle;
280 struct GNUNET_REST_RequestHandle *rest_conndata_handle;
282 con_handle = *con_cls;
284 if (NULL == *con_cls)
286 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
287 "New connection %s\n", url);
288 char tmp_url[strlen(url)+1];
289 strcpy (tmp_url, url);
290 con_handle = GNUNET_new (struct MhdConnectionHandle);
291 con_handle->con = con;
292 con_handle->state = GN_REST_STATE_INIT;
293 *con_cls = con_handle;
295 plugin_name = strtok(tmp_url, "/");
297 if (NULL != plugin_name)
299 GNUNET_CRYPTO_hash (plugin_name, strlen (plugin_name), &key);
301 con_handle->plugin = GNUNET_CONTAINER_multihashmap_get (plugin_map,
304 if (NULL == con_handle->plugin)
306 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
307 "Queueing response with MHD\n");
308 GNUNET_free (con_handle);
309 return MHD_queue_response (con,
315 if (GN_REST_STATE_INIT == con_handle->state)
317 rest_conndata_handle = GNUNET_new (struct GNUNET_REST_RequestHandle);
318 rest_conndata_handle->method = meth;
319 rest_conndata_handle->url = url;
320 rest_conndata_handle->data = upload_data;
321 rest_conndata_handle->data_size = *upload_data_size;
322 rest_conndata_handle->url_param_map = GNUNET_CONTAINER_multihashmap_create (16,
324 con_handle->data_handle = rest_conndata_handle;
325 MHD_get_connection_values (con,
326 MHD_GET_ARGUMENT_KIND,
328 rest_conndata_handle);
329 con_handle->state = GN_REST_STATE_PROCESSING;
330 con_handle->plugin->process_request (rest_conndata_handle,
333 *upload_data_size = 0;
335 if (NULL != con_handle->response)
337 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
338 "Queueing response from plugin with MHD\n");
340 if (NULL != allow_origin)
342 MHD_add_response_header (con_handle->response,
343 MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
346 if (NULL != allow_headers)
348 MHD_add_response_header (con_handle->response,
349 "Access-Control-Allow-Headers",
352 //Always add JSONAPI content type. TODO
353 MHD_add_response_header (con_handle->response,
354 MHD_HTTP_HEADER_CONTENT_TYPE,
355 "application/vnd.api+json");
356 int ret = MHD_queue_response (con,
358 con_handle->response);
359 cleanup_handle (con_handle);
366 /* ******************** MHD HTTP setup and event loop ******************** */
369 * Function called when MHD decides that we are done with a connection.
372 * @param connection connection handle
373 * @param con_cls value as set by the last call to
374 * the MHD_AccessHandlerCallback, should be our handle
375 * @param toe reason for request termination (ignored)
378 mhd_completed_cb (void *cls,
379 struct MHD_Connection *connection,
381 enum MHD_RequestTerminationCode toe)
383 if (MHD_REQUEST_TERMINATED_COMPLETED_OK != toe)
384 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
385 "MHD encountered error handling request: %d\n",
391 * Kill the MHD daemon.
398 MHD_stop_daemon (httpd);
401 if (NULL != httpd_task)
403 GNUNET_SCHEDULER_cancel (httpd_task);
408 GNUNET_SCHEDULER_cancel (ltask4);
413 GNUNET_SCHEDULER_cancel (ltask6);
419 GNUNET_NETWORK_socket_close (lsock4);
424 GNUNET_NETWORK_socket_close (lsock6);
431 * Schedule MHD. This function should be called initially when an
432 * MHD is first getting its client socket, and will then automatically
433 * always be called later whenever there is work to be done.
435 * @param hd the daemon to schedule
443 struct GNUNET_NETWORK_FDSet *wrs;
444 struct GNUNET_NETWORK_FDSet *wws;
447 MHD_UNSIGNED_LONG_LONG timeout;
448 struct GNUNET_TIME_Relative tv;
454 if (MHD_YES != MHD_get_fdset (httpd, &rs, &ws, &es, &max))
459 haveto = MHD_get_timeout (httpd, &timeout);
460 if (MHD_YES == haveto)
461 tv.rel_value_us = (uint64_t) timeout * 1000LL;
463 tv = GNUNET_TIME_UNIT_FOREVER_REL;
466 wrs = GNUNET_NETWORK_fdset_create ();
467 wws = GNUNET_NETWORK_fdset_create ();
468 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
469 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
476 if (NULL != httpd_task)
478 GNUNET_SCHEDULER_cancel (httpd_task);
481 if ( (MHD_YES == haveto) ||
485 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
491 GNUNET_NETWORK_fdset_destroy (wrs);
493 GNUNET_NETWORK_fdset_destroy (wws);
497 * Task run whenever HTTP server operations are pending.
511 * Accept new incoming connections
513 * @param cls the closure with the lsock4 or lsock6
514 * @param tc the scheduler context
517 do_accept (void *cls)
519 struct GNUNET_NETWORK_Handle *lsock = cls;
520 struct GNUNET_NETWORK_Handle *s;
522 const struct sockaddr *addr;
525 GNUNET_assert (NULL != lsock);
528 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
533 else if (lsock == lsock6)
535 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
542 s = GNUNET_NETWORK_socket_accept (lsock, NULL, NULL);
545 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "accept");
548 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
549 "Got an inbound connection, waiting for data\n");
550 fd = GNUNET_NETWORK_get_fd (s);
551 addr = GNUNET_NETWORK_get_addr (s);
552 len = GNUNET_NETWORK_get_addrlen (s);
553 if (MHD_YES != MHD_add_connection (httpd, fd, addr, len))
555 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
556 _("Failed to pass client to MHD\n"));
565 * Task run on shutdown
570 do_shutdown (void *cls)
572 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
573 "Shutting down...\n");
575 GNUNET_free_non_null (allow_origin);
576 GNUNET_free_non_null (allow_headers);
581 * Create an IPv4 listen socket bound to our port.
583 * @return NULL on error
585 static struct GNUNET_NETWORK_Handle *
588 struct GNUNET_NETWORK_Handle *ls;
589 struct sockaddr_in sa4;
592 memset (&sa4, 0, sizeof (sa4));
593 sa4.sin_family = AF_INET;
594 sa4.sin_port = htons (port);
595 #if HAVE_SOCKADDR_IN_SIN_LEN
596 sa4.sin_len = sizeof (sa4);
598 ls = GNUNET_NETWORK_socket_create (AF_INET,
604 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa4,
608 GNUNET_NETWORK_socket_close (ls);
617 * Create an IPv6 listen socket bound to our port.
619 * @return NULL on error
621 static struct GNUNET_NETWORK_Handle *
624 struct GNUNET_NETWORK_Handle *ls;
625 struct sockaddr_in6 sa6;
628 memset (&sa6, 0, sizeof (sa6));
629 sa6.sin6_family = AF_INET6;
630 sa6.sin6_port = htons (port);
631 #if HAVE_SOCKADDR_IN_SIN_LEN
632 sa6.sin6_len = sizeof (sa6);
634 ls = GNUNET_NETWORK_socket_create (AF_INET6,
640 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa6,
644 GNUNET_NETWORK_socket_close (ls);
653 * Callback for plugin load
656 * @param libname the name of the library loaded
657 * @param lib_ret the object returned by the plugin initializer
660 load_plugin (void *cls,
664 struct GNUNET_REST_Plugin *plugin = lib_ret;
665 struct GNUNET_HashCode key;
668 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
669 "Could not load plugin `%s'\n",
673 GNUNET_assert (1 < strlen (plugin->name));
674 GNUNET_assert ('/' == *plugin->name);
675 GNUNET_CRYPTO_hash (plugin->name+1, strlen (plugin->name+1), &key);
676 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (plugin_map,
679 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
681 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
682 "Could not load add plugin `%s'\n",
686 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
687 "Loaded plugin `%s'\n",
693 * Main function that will be run
696 * @param args remaining command-line arguments
697 * @param cfgfile name of the configuration file used (for saving, can be NULL)
698 * @param c configuration
704 const struct GNUNET_CONFIGURATION_Handle *c)
707 plugin_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
709 /* Get CORS data from cfg */
710 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
714 //No origin specified
715 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
716 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
719 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
720 "REST_ALLOW_HEADERS",
723 //No origin specified
724 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
725 "No CORS Access-Control-Allow-Headers Header will be sent...\n");
728 /* Open listen socket proxy */
732 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
736 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock6, 5))
738 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
739 GNUNET_NETWORK_socket_close (lsock6);
744 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
745 lsock6, &do_accept, lsock6);
752 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
756 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock4, 5))
758 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
759 GNUNET_NETWORK_socket_close (lsock4);
764 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
765 lsock4, &do_accept, lsock4);
769 if ( (NULL == lsock4) &&
772 GNUNET_SCHEDULER_shutdown ();
775 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
776 "Service listens on port %llu\n",
778 httpd = MHD_start_daemon (MHD_USE_DEBUG | MHD_USE_NO_LISTEN_SOCKET,
781 &create_response, NULL,
782 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
783 MHD_OPTION_NOTIFY_COMPLETED, &mhd_completed_cb, NULL,
787 GNUNET_SCHEDULER_shutdown ();
791 GNUNET_PLUGIN_load_all ("libgnunet_plugin_rest",
795 GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
801 * The main function for gnunet-rest-service
803 * @param argc number of arguments from the cli
804 * @param argv command line arguments
805 * @return 0 ok, 1 on error
809 main (int argc, char *const *argv)
811 struct GNUNET_GETOPT_CommandLineOption options[] = {
812 GNUNET_GETOPT_option_ulong ('p',
815 gettext_noop ("listen on specified port (default: 7776)"),
817 GNUNET_GETOPT_OPTION_END
819 static const char* err_page =
823 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
825 GNUNET_log_setup ("gnunet-rest-server", "WARNING", NULL);
826 failure_response = MHD_create_response_from_buffer (strlen(err_page),
828 MHD_RESPMEM_PERSISTENT);
831 GNUNET_PROGRAM_run (argc, argv, "gnunet-rest-server",
832 _("GNUnet REST server"),
835 MHD_destroy_response (failure_response);
836 GNUNET_free_non_null ((char *) argv);
840 /* end of gnunet-rest-server.c */