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.
159 GNUNET_SCHEDULER_cancel (httpd_task);
160 httpd_task = GNUNET_SCHEDULER_add_now (&do_httpd,
165 * Plugin result callback
167 * @param cls closure (MHD connection handle)
168 * @param data the data to return to the caller
169 * @param len length of the data
170 * @param status #GNUNET_OK if successful
173 plugin_callback (void *cls,
174 struct MHD_Response *resp,
177 struct MhdConnectionHandle *handle = cls;
178 handle->status = status;
179 handle->response = resp;
185 cleanup_url_map (void *cls,
186 const struct GNUNET_HashCode *key,
189 GNUNET_free_non_null (value);
195 cleanup_handle (struct MhdConnectionHandle *handle)
197 if (NULL != handle->response)
198 MHD_destroy_response (handle->response);
199 if (NULL != handle->data_handle)
202 if (NULL != handle->data_handle->header_param_map)
204 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->header_param_map,
207 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->header_param_map);
209 if (NULL != handle->data_handle->url_param_map)
211 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->url_param_map,
214 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->url_param_map);
216 GNUNET_free (handle->data_handle);
218 GNUNET_free (handle);
222 header_iterator (void *cls,
223 enum MHD_ValueKind kind,
227 struct GNUNET_REST_RequestHandle *handle = cls;
228 struct GNUNET_HashCode hkey;
231 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
232 GNUNET_asprintf (&val, "%s", value);
234 GNUNET_CONTAINER_multihashmap_put (handle->header_param_map,
237 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
239 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
240 "Could not load add header `%s'=%s\n",
248 url_iterator (void *cls,
249 enum MHD_ValueKind kind,
253 struct GNUNET_REST_RequestHandle *handle = cls;
254 struct GNUNET_HashCode hkey;
257 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
258 GNUNET_asprintf (&val, "%s", value);
260 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
263 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
265 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
266 "Could not load add url param `%s'=%s\n",
272 /* ********************************* MHD response generation ******************* */
275 * Main MHD callback for handling requests.
278 * @param con MHD connection handle
279 * @param url the url in the request
280 * @param meth the HTTP method used ("GET", "PUT", etc.)
281 * @param ver the HTTP version string (i.e. "HTTP/1.1")
282 * @param upload_data the data being uploaded (excluding HEADERS,
283 * for a POST that fits into memory and that is encoded
284 * with a supported encoding, the POST data will NOT be
285 * given in upload_data and is instead available as
286 * part of MHD_get_connection_values; very large POST
287 * data *will* be made available incrementally in
289 * @param upload_data_size set initially to the size of the
290 * @a upload_data provided; the method must update this
291 * value to the number of bytes NOT processed;
292 * @param con_cls pointer to location where we store the 'struct Request'
293 * @return MHD_YES if the connection was handled successfully,
294 * MHD_NO if the socket must be closed due to a serious
295 * error while handling the request
298 create_response (void *cls,
299 struct MHD_Connection *con,
303 const char *upload_data,
304 size_t *upload_data_size,
308 struct GNUNET_HashCode key;
309 struct MhdConnectionHandle *con_handle;
310 struct GNUNET_REST_RequestHandle *rest_conndata_handle;
312 con_handle = *con_cls;
314 if (NULL == *con_cls)
316 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
317 "New connection %s\n", url);
318 char tmp_url[strlen(url)+1];
319 strcpy (tmp_url, url);
320 con_handle = GNUNET_new (struct MhdConnectionHandle);
321 con_handle->con = con;
322 con_handle->state = GN_REST_STATE_INIT;
323 *con_cls = con_handle;
325 plugin_name = strtok(tmp_url, "/");
327 if (NULL != plugin_name)
329 GNUNET_CRYPTO_hash (plugin_name, strlen (plugin_name), &key);
331 con_handle->plugin = GNUNET_CONTAINER_multihashmap_get (plugin_map,
334 if (NULL == con_handle->plugin)
336 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
337 "Queueing response with MHD\n");
338 GNUNET_free (con_handle);
339 return MHD_queue_response (con,
345 if (GN_REST_STATE_INIT == con_handle->state)
347 rest_conndata_handle = GNUNET_new (struct GNUNET_REST_RequestHandle);
348 rest_conndata_handle->method = meth;
349 rest_conndata_handle->url = url;
350 rest_conndata_handle->data = upload_data;
351 rest_conndata_handle->data_size = *upload_data_size;
352 rest_conndata_handle->url_param_map = GNUNET_CONTAINER_multihashmap_create (16,
354 rest_conndata_handle->header_param_map = GNUNET_CONTAINER_multihashmap_create (16,
356 con_handle->data_handle = rest_conndata_handle;
357 MHD_get_connection_values (con,
358 MHD_GET_ARGUMENT_KIND,
360 rest_conndata_handle);
361 MHD_get_connection_values (con,
364 rest_conndata_handle);
365 con_handle->state = GN_REST_STATE_PROCESSING;
366 con_handle->plugin->process_request (rest_conndata_handle,
369 *upload_data_size = 0;
371 if (NULL != con_handle->response)
373 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
374 "Queueing response from plugin with MHD\n");
376 if (NULL != allow_origin)
378 MHD_add_response_header (con_handle->response,
379 MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
382 if (NULL != allow_headers)
384 MHD_add_response_header (con_handle->response,
385 "Access-Control-Allow-Headers",
388 //Always add JSONAPI content type. TODO
389 MHD_add_response_header (con_handle->response,
390 MHD_HTTP_HEADER_CONTENT_TYPE,
391 "application/vnd.api+json");
392 int ret = MHD_queue_response (con,
394 con_handle->response);
395 cleanup_handle (con_handle);
402 /* ******************** MHD HTTP setup and event loop ******************** */
405 * Function called when MHD decides that we are done with a connection.
408 * @param connection connection handle
409 * @param con_cls value as set by the last call to
410 * the MHD_AccessHandlerCallback, should be our handle
411 * @param toe reason for request termination (ignored)
414 mhd_completed_cb (void *cls,
415 struct MHD_Connection *connection,
417 enum MHD_RequestTerminationCode toe)
419 if (MHD_REQUEST_TERMINATED_COMPLETED_OK != toe)
420 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
421 "MHD encountered error handling request: %d\n",
427 * Kill the MHD daemon.
434 MHD_stop_daemon (httpd);
437 if (NULL != httpd_task)
439 GNUNET_SCHEDULER_cancel (httpd_task);
444 GNUNET_SCHEDULER_cancel (ltask4);
449 GNUNET_SCHEDULER_cancel (ltask6);
456 * Schedule MHD. This function should be called initially when an
457 * MHD is first getting its client socket, and will then automatically
458 * always be called later whenever there is work to be done.
460 * @param hd the daemon to schedule
468 struct GNUNET_NETWORK_FDSet *wrs;
469 struct GNUNET_NETWORK_FDSet *wws;
472 MHD_UNSIGNED_LONG_LONG timeout;
473 struct GNUNET_TIME_Relative tv;
479 if (MHD_YES != MHD_get_fdset (httpd, &rs, &ws, &es, &max))
484 haveto = MHD_get_timeout (httpd, &timeout);
485 if (MHD_YES == haveto)
486 tv.rel_value_us = (uint64_t) timeout * 1000LL;
488 tv = GNUNET_TIME_UNIT_FOREVER_REL;
491 wrs = GNUNET_NETWORK_fdset_create ();
492 wws = GNUNET_NETWORK_fdset_create ();
493 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
494 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
501 if (NULL != httpd_task)
502 GNUNET_SCHEDULER_cancel (httpd_task);
503 if ( (MHD_YES == haveto) ||
507 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
512 GNUNET_NETWORK_fdset_destroy (wrs);
514 GNUNET_NETWORK_fdset_destroy (wws);
518 * Task run whenever HTTP server operations are pending.
532 * Accept new incoming connections
534 * @param cls the closure with the lsock4 or lsock6
535 * @param tc the scheduler context
538 do_accept (void *cls)
540 struct GNUNET_NETWORK_Handle *lsock = cls;
541 struct GNUNET_NETWORK_Handle *s;
543 const struct sockaddr *addr;
551 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
555 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
558 s = GNUNET_NETWORK_socket_accept (lsock, NULL, NULL);
561 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "accept");
564 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
565 "Got an inbound connection, waiting for data\n");
566 fd = GNUNET_NETWORK_get_fd (s);
567 addr = GNUNET_NETWORK_get_addr (s);
568 len = GNUNET_NETWORK_get_addrlen (s);
569 if (MHD_YES != MHD_add_connection (httpd, fd, addr, len))
571 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
572 _("Failed to pass client to MHD\n"));
581 * Task run on shutdown
586 do_shutdown (void *cls)
588 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
589 "Shutting down...\n");
591 GNUNET_free_non_null (allow_origin);
592 GNUNET_free_non_null (allow_headers);
597 * Create an IPv4 listen socket bound to our port.
599 * @return NULL on error
601 static struct GNUNET_NETWORK_Handle *
604 struct GNUNET_NETWORK_Handle *ls;
605 struct sockaddr_in sa4;
608 memset (&sa4, 0, sizeof (sa4));
609 sa4.sin_family = AF_INET;
610 sa4.sin_port = htons (port);
611 #if HAVE_SOCKADDR_IN_SIN_LEN
612 sa4.sin_len = sizeof (sa4);
614 ls = GNUNET_NETWORK_socket_create (AF_INET,
620 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa4,
624 GNUNET_NETWORK_socket_close (ls);
633 * Create an IPv6 listen socket bound to our port.
635 * @return NULL on error
637 static struct GNUNET_NETWORK_Handle *
640 struct GNUNET_NETWORK_Handle *ls;
641 struct sockaddr_in6 sa6;
644 memset (&sa6, 0, sizeof (sa6));
645 sa6.sin6_family = AF_INET6;
646 sa6.sin6_port = htons (port);
647 #if HAVE_SOCKADDR_IN_SIN_LEN
648 sa6.sin6_len = sizeof (sa6);
650 ls = GNUNET_NETWORK_socket_create (AF_INET6,
656 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa6,
660 GNUNET_NETWORK_socket_close (ls);
669 * Callback for plugin load
672 * @param libname the name of the library loaded
673 * @param lib_ret the object returned by the plugin initializer
676 load_plugin (void *cls,
680 struct GNUNET_REST_Plugin *plugin = lib_ret;
681 struct GNUNET_HashCode key;
684 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
685 "Could not load plugin `%s'\n",
689 GNUNET_assert (1 < strlen (plugin->name));
690 GNUNET_assert ('/' == *plugin->name);
691 GNUNET_CRYPTO_hash (plugin->name+1, strlen (plugin->name+1), &key);
692 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (plugin_map,
695 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
697 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
698 "Could not load add plugin `%s'\n",
702 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
703 "Loaded plugin `%s'\n",
709 * Main function that will be run
712 * @param args remaining command-line arguments
713 * @param cfgfile name of the configuration file used (for saving, can be NULL)
714 * @param c configuration
720 const struct GNUNET_CONFIGURATION_Handle *c)
723 plugin_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
725 /* Get CORS data from cfg */
726 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
730 //No origin specified
731 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
732 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
735 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
736 "REST_ALLOW_HEADERS",
739 //No origin specified
740 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
741 "No CORS Access-Control-Allow-Headers Header will be sent...\n");
744 /* Open listen socket proxy */
748 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
752 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock6, 5))
754 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
755 GNUNET_NETWORK_socket_close (lsock6);
760 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
761 lsock6, &do_accept, lsock6);
767 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
771 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock4, 5))
773 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
774 GNUNET_NETWORK_socket_close (lsock4);
779 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
780 lsock4, &do_accept, lsock4);
783 if ( (NULL == lsock4) &&
786 GNUNET_SCHEDULER_shutdown ();
789 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
790 "Service listens on port %llu\n",
792 httpd = MHD_start_daemon (MHD_USE_DEBUG | MHD_USE_NO_LISTEN_SOCKET,
795 &create_response, NULL,
796 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
797 MHD_OPTION_NOTIFY_COMPLETED, &mhd_completed_cb, NULL,
801 GNUNET_SCHEDULER_shutdown ();
805 GNUNET_PLUGIN_load_all ("libgnunet_plugin_rest",
809 GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
815 * The main function for gnunet-rest-service
817 * @param argc number of arguments from the cli
818 * @param argv command line arguments
819 * @return 0 ok, 1 on error
823 main (int argc, char *const *argv)
825 struct GNUNET_GETOPT_CommandLineOption options[] = {
826 GNUNET_GETOPT_option_ulong ('p',
829 gettext_noop ("listen on specified port (default: 7776)"),
831 GNUNET_GETOPT_OPTION_END
833 static const char* err_page =
837 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
839 GNUNET_log_setup ("gnunet-rest-server", "WARNING", NULL);
840 failure_response = MHD_create_response_from_buffer (strlen(err_page),
842 MHD_RESPMEM_PERSISTENT);
845 GNUNET_PROGRAM_run (argc, argv, "gnunet-rest-server",
846 _("GNUnet REST server"),
849 MHD_destroy_response (failure_response);
850 GNUNET_free_non_null ((char *) argv);
854 /* end of gnunet-rest-server.c */