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;
134 struct MHD_PostProcessor *pp;
141 /* ************************* Global helpers ********************* */
145 * Task run whenever HTTP server operations are pending.
150 do_httpd (void *cls);
154 * Run MHD now, we have extra data ready for the callback.
159 if (NULL != httpd_task)
161 GNUNET_SCHEDULER_cancel (httpd_task);
164 httpd_task = GNUNET_SCHEDULER_add_now (&do_httpd,
170 * Plugin result callback
172 * @param cls closure (MHD connection handle)
173 * @param data the data to return to the caller
174 * @param len length of the data
175 * @param status #GNUNET_OK if successful
178 plugin_callback (void *cls,
179 struct MHD_Response *resp,
182 struct MhdConnectionHandle *handle = cls;
183 handle->status = status;
184 handle->response = resp;
190 cleanup_url_map (void *cls,
191 const struct GNUNET_HashCode *key,
194 GNUNET_free_non_null (value);
200 cleanup_handle (struct MhdConnectionHandle *handle)
202 if (NULL != handle->response)
203 MHD_destroy_response (handle->response);
204 if (NULL != handle->data_handle)
206 if (NULL != handle->data_handle->url_param_map)
208 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->url_param_map,
211 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->url_param_map);
213 GNUNET_free (handle->data_handle);
215 GNUNET_free (handle);
220 url_iterator (void *cls,
221 enum MHD_ValueKind kind,
225 struct GNUNET_REST_RequestHandle *handle = cls;
226 struct GNUNET_HashCode hkey;
229 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
230 GNUNET_asprintf (&val, "%s", value);
232 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
235 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
237 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
238 "Could not load add url param `%s'=%s\n",
245 post_data_iter (void *cls,
246 enum MHD_ValueKind kind,
248 const char *filename,
249 const char *content_type,
250 const char *transfer_encoding,
255 struct GNUNET_REST_RequestHandle *handle = cls;
256 struct GNUNET_HashCode hkey;
259 if (MHD_POSTDATA_KIND != kind)
262 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
263 GNUNET_asprintf (&val, "%s", data);
265 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
268 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
270 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
271 "Could not load add url param `%s'=%s\n",
278 /* ********************************* MHD response generation ******************* */
281 * Main MHD callback for handling requests.
284 * @param con MHD connection handle
285 * @param url the url in the request
286 * @param meth the HTTP method used ("GET", "PUT", etc.)
287 * @param ver the HTTP version string (i.e. "HTTP/1.1")
288 * @param upload_data the data being uploaded (excluding HEADERS,
289 * for a POST that fits into memory and that is encoded
290 * with a supported encoding, the POST data will NOT be
291 * given in upload_data and is instead available as
292 * part of MHD_get_connection_values; very large POST
293 * data *will* be made available incrementally in
295 * @param upload_data_size set initially to the size of the
296 * @a upload_data provided; the method must update this
297 * value to the number of bytes NOT processed;
298 * @param con_cls pointer to location where we store the 'struct Request'
299 * @return MHD_YES if the connection was handled successfully,
300 * MHD_NO if the socket must be closed due to a serious
301 * error while handling the request
304 create_response (void *cls,
305 struct MHD_Connection *con,
309 const char *upload_data,
310 size_t *upload_data_size,
314 struct GNUNET_HashCode key;
315 struct MhdConnectionHandle *con_handle;
316 struct GNUNET_REST_RequestHandle *rest_conndata_handle;
318 con_handle = *con_cls;
320 if (NULL == *con_cls)
322 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
323 "New connection %s\n", url);
324 char tmp_url[strlen(url)+1];
325 strcpy (tmp_url, url);
326 con_handle = GNUNET_new (struct MhdConnectionHandle);
327 con_handle->con = con;
328 con_handle->state = GN_REST_STATE_INIT;
329 *con_cls = con_handle;
331 plugin_name = strtok(tmp_url, "/");
333 if (NULL != plugin_name)
335 GNUNET_CRYPTO_hash (plugin_name, strlen (plugin_name), &key);
337 con_handle->plugin = GNUNET_CONTAINER_multihashmap_get (plugin_map,
340 if (NULL == con_handle->plugin)
342 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
343 "Queueing response with MHD\n");
344 GNUNET_free (con_handle);
345 return MHD_queue_response (con,
352 if (GN_REST_STATE_INIT == con_handle->state)
354 rest_conndata_handle = GNUNET_new (struct GNUNET_REST_RequestHandle);
355 rest_conndata_handle->method = meth;
356 rest_conndata_handle->url = url;
357 rest_conndata_handle->data = upload_data;
358 rest_conndata_handle->data_size = *upload_data_size;
359 rest_conndata_handle->url_param_map = GNUNET_CONTAINER_multihashmap_create (16,
361 con_handle->data_handle = rest_conndata_handle;
362 MHD_get_connection_values (con,
363 MHD_GET_ARGUMENT_KIND,
365 rest_conndata_handle);
366 con_handle->pp = MHD_create_post_processor(con,
369 rest_conndata_handle);
370 if (*upload_data_size)
372 MHD_post_process(con_handle->pp, upload_data, *upload_data_size);
376 MHD_destroy_post_processor(con_handle->pp);
378 con_handle->state = GN_REST_STATE_PROCESSING;
379 con_handle->plugin->process_request (rest_conndata_handle,
382 *upload_data_size = 0;
384 if (NULL != con_handle->response)
386 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
387 "Queueing response from plugin with MHD\n");
389 if (NULL != allow_origin)
391 MHD_add_response_header (con_handle->response,
392 MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
395 if (NULL != allow_headers)
397 MHD_add_response_header (con_handle->response,
398 "Access-Control-Allow-Headers",
401 //Always add JSONAPI content type. TODO
402 MHD_add_response_header (con_handle->response,
403 MHD_HTTP_HEADER_CONTENT_TYPE,
404 "application/vnd.api+json");
405 int ret = MHD_queue_response (con,
407 con_handle->response);
408 cleanup_handle (con_handle);
415 /* ******************** MHD HTTP setup and event loop ******************** */
418 * Function called when MHD decides that we are done with a connection.
421 * @param connection connection handle
422 * @param con_cls value as set by the last call to
423 * the MHD_AccessHandlerCallback, should be our handle
424 * @param toe reason for request termination (ignored)
427 mhd_completed_cb (void *cls,
428 struct MHD_Connection *connection,
430 enum MHD_RequestTerminationCode toe)
432 if (MHD_REQUEST_TERMINATED_COMPLETED_OK != toe)
433 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
434 "MHD encountered error handling request: %d\n",
440 * Kill the MHD daemon.
447 MHD_stop_daemon (httpd);
450 if (NULL != httpd_task)
452 GNUNET_SCHEDULER_cancel (httpd_task);
457 GNUNET_SCHEDULER_cancel (ltask4);
462 GNUNET_SCHEDULER_cancel (ltask6);
468 GNUNET_NETWORK_socket_close (lsock4);
473 GNUNET_NETWORK_socket_close (lsock6);
480 * Schedule MHD. This function should be called initially when an
481 * MHD is first getting its client socket, and will then automatically
482 * always be called later whenever there is work to be done.
484 * @param hd the daemon to schedule
492 struct GNUNET_NETWORK_FDSet *wrs;
493 struct GNUNET_NETWORK_FDSet *wws;
496 MHD_UNSIGNED_LONG_LONG timeout;
497 struct GNUNET_TIME_Relative tv;
503 if (MHD_YES != MHD_get_fdset (httpd, &rs, &ws, &es, &max))
508 haveto = MHD_get_timeout (httpd, &timeout);
509 if (MHD_YES == haveto)
510 tv.rel_value_us = (uint64_t) timeout * 1000LL;
512 tv = GNUNET_TIME_UNIT_FOREVER_REL;
515 wrs = GNUNET_NETWORK_fdset_create ();
516 wws = GNUNET_NETWORK_fdset_create ();
517 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
518 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
525 if (NULL != httpd_task)
527 GNUNET_SCHEDULER_cancel (httpd_task);
530 if ( (MHD_YES == haveto) ||
534 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
540 GNUNET_NETWORK_fdset_destroy (wrs);
542 GNUNET_NETWORK_fdset_destroy (wws);
546 * Task run whenever HTTP server operations are pending.
560 * Accept new incoming connections
562 * @param cls the closure with the lsock4 or lsock6
563 * @param tc the scheduler context
566 do_accept (void *cls)
568 struct GNUNET_NETWORK_Handle *lsock = cls;
569 struct GNUNET_NETWORK_Handle *s;
571 const struct sockaddr *addr;
574 GNUNET_assert (NULL != lsock);
577 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
582 else if (lsock == lsock6)
584 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
591 s = GNUNET_NETWORK_socket_accept (lsock, NULL, NULL);
594 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "accept");
597 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
598 "Got an inbound connection, waiting for data\n");
599 fd = GNUNET_NETWORK_get_fd (s);
600 addr = GNUNET_NETWORK_get_addr (s);
601 len = GNUNET_NETWORK_get_addrlen (s);
602 if (MHD_YES != MHD_add_connection (httpd, fd, addr, len))
604 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
605 _("Failed to pass client to MHD\n"));
614 * Task run on shutdown
619 do_shutdown (void *cls)
621 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
622 "Shutting down...\n");
624 GNUNET_free_non_null (allow_origin);
625 GNUNET_free_non_null (allow_headers);
630 * Create an IPv4 listen socket bound to our port.
632 * @return NULL on error
634 static struct GNUNET_NETWORK_Handle *
637 struct GNUNET_NETWORK_Handle *ls;
638 struct sockaddr_in sa4;
641 memset (&sa4, 0, sizeof (sa4));
642 sa4.sin_family = AF_INET;
643 sa4.sin_port = htons (port);
644 #if HAVE_SOCKADDR_IN_SIN_LEN
645 sa4.sin_len = sizeof (sa4);
647 ls = GNUNET_NETWORK_socket_create (AF_INET,
653 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa4,
657 GNUNET_NETWORK_socket_close (ls);
666 * Create an IPv6 listen socket bound to our port.
668 * @return NULL on error
670 static struct GNUNET_NETWORK_Handle *
673 struct GNUNET_NETWORK_Handle *ls;
674 struct sockaddr_in6 sa6;
677 memset (&sa6, 0, sizeof (sa6));
678 sa6.sin6_family = AF_INET6;
679 sa6.sin6_port = htons (port);
680 #if HAVE_SOCKADDR_IN_SIN_LEN
681 sa6.sin6_len = sizeof (sa6);
683 ls = GNUNET_NETWORK_socket_create (AF_INET6,
689 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa6,
693 GNUNET_NETWORK_socket_close (ls);
702 * Callback for plugin load
705 * @param libname the name of the library loaded
706 * @param lib_ret the object returned by the plugin initializer
709 load_plugin (void *cls,
713 struct GNUNET_REST_Plugin *plugin = lib_ret;
714 struct GNUNET_HashCode key;
717 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
718 "Could not load plugin `%s'\n",
722 GNUNET_assert (1 < strlen (plugin->name));
723 GNUNET_assert ('/' == *plugin->name);
724 GNUNET_CRYPTO_hash (plugin->name+1, strlen (plugin->name+1), &key);
725 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (plugin_map,
728 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
730 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
731 "Could not load add plugin `%s'\n",
735 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
736 "Loaded plugin `%s'\n",
742 * Main function that will be run
745 * @param args remaining command-line arguments
746 * @param cfgfile name of the configuration file used (for saving, can be NULL)
747 * @param c configuration
753 const struct GNUNET_CONFIGURATION_Handle *c)
756 plugin_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
758 /* Get CORS data from cfg */
759 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
763 //No origin specified
764 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
765 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
768 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
769 "REST_ALLOW_HEADERS",
772 //No origin specified
773 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
774 "No CORS Access-Control-Allow-Headers Header will be sent...\n");
777 /* Open listen socket proxy */
781 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
785 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock6, 5))
787 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
788 GNUNET_NETWORK_socket_close (lsock6);
793 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
794 lsock6, &do_accept, lsock6);
801 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
805 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock4, 5))
807 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
808 GNUNET_NETWORK_socket_close (lsock4);
813 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
814 lsock4, &do_accept, lsock4);
818 if ( (NULL == lsock4) &&
821 GNUNET_SCHEDULER_shutdown ();
824 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
825 "Service listens on port %llu\n",
827 httpd = MHD_start_daemon (MHD_USE_DEBUG | MHD_USE_NO_LISTEN_SOCKET,
830 &create_response, NULL,
831 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
832 MHD_OPTION_NOTIFY_COMPLETED, &mhd_completed_cb, NULL,
836 GNUNET_SCHEDULER_shutdown ();
840 GNUNET_PLUGIN_load_all ("libgnunet_plugin_rest",
844 GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
850 * The main function for gnunet-rest-service
852 * @param argc number of arguments from the cli
853 * @param argv command line arguments
854 * @return 0 ok, 1 on error
858 main (int argc, char *const *argv)
860 struct GNUNET_GETOPT_CommandLineOption options[] = {
861 GNUNET_GETOPT_option_ulong ('p',
864 gettext_noop ("listen on specified port (default: 7776)"),
866 GNUNET_GETOPT_OPTION_END
868 static const char* err_page =
872 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
874 GNUNET_log_setup ("gnunet-rest-server", "WARNING", NULL);
875 failure_response = MHD_create_response_from_buffer (strlen(err_page),
877 MHD_RESPMEM_PERSISTENT);
880 GNUNET_PROGRAM_run (argc, argv, "gnunet-rest-server",
881 _("GNUnet REST server"),
884 MHD_destroy_response (failure_response);
885 GNUNET_free_non_null ((char *) argv);
889 /* end of gnunet-rest-server.c */