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 * Allowed Credentials (CORS)
124 static char* allow_credentials;
127 * MHD Connection handle
129 struct MhdConnectionHandle
131 struct MHD_Connection *con;
133 struct MHD_Response *response;
135 struct GNUNET_REST_Plugin *plugin;
137 struct GNUNET_REST_RequestHandle *data_handle;
139 struct MHD_PostProcessor *pp;
146 /* ************************* Global helpers ********************* */
150 * Task run whenever HTTP server operations are pending.
155 do_httpd (void *cls);
159 * Run MHD now, we have extra data ready for the callback.
164 if (NULL != httpd_task)
166 GNUNET_SCHEDULER_cancel (httpd_task);
169 httpd_task = GNUNET_SCHEDULER_add_now (&do_httpd,
175 * Plugin result callback
177 * @param cls closure (MHD connection handle)
178 * @param data the data to return to the caller
179 * @param len length of the data
180 * @param status #GNUNET_OK if successful
183 plugin_callback (void *cls,
184 struct MHD_Response *resp,
187 struct MhdConnectionHandle *handle = cls;
188 handle->status = status;
189 handle->response = resp;
195 cleanup_url_map (void *cls,
196 const struct GNUNET_HashCode *key,
199 GNUNET_free_non_null (value);
205 cleanup_handle (struct MhdConnectionHandle *handle)
207 if (NULL != handle->response)
208 MHD_destroy_response (handle->response);
209 if (NULL != handle->data_handle)
212 if (NULL != handle->data_handle->header_param_map)
214 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->header_param_map,
217 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->header_param_map);
219 if (NULL != handle->data_handle->url_param_map)
221 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->url_param_map,
224 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->url_param_map);
226 GNUNET_free (handle->data_handle);
228 GNUNET_free (handle);
232 header_iterator (void *cls,
233 enum MHD_ValueKind kind,
237 struct GNUNET_REST_RequestHandle *handle = cls;
238 struct GNUNET_HashCode hkey;
241 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
242 GNUNET_asprintf (&val, "%s", value);
244 GNUNET_CONTAINER_multihashmap_put (handle->header_param_map,
247 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
249 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
250 "Could not load add header `%s'=%s\n",
258 url_iterator (void *cls,
259 enum MHD_ValueKind kind,
263 struct GNUNET_REST_RequestHandle *handle = cls;
264 struct GNUNET_HashCode hkey;
267 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
268 GNUNET_asprintf (&val, "%s", value);
270 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
273 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
275 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
276 "Could not load add url param `%s'=%s\n",
283 post_data_iter (void *cls,
284 enum MHD_ValueKind kind,
286 const char *filename,
287 const char *content_type,
288 const char *transfer_encoding,
293 struct GNUNET_REST_RequestHandle *handle = cls;
294 struct GNUNET_HashCode hkey;
297 if (MHD_POSTDATA_KIND != kind)
300 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
301 GNUNET_asprintf (&val, "%s", data);
303 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
306 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
308 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
309 "Could not load add url param '%s'=%s\n",
317 /* ********************************* MHD response generation ******************* */
320 * Main MHD callback for handling requests.
323 * @param con MHD connection handle
324 * @param url the url in the request
325 * @param meth the HTTP method used ("GET", "PUT", etc.)
326 * @param ver the HTTP version string (i.e. "HTTP/1.1")
327 * @param upload_data the data being uploaded (excluding HEADERS,
328 * for a POST that fits into memory and that is encoded
329 * with a supported encoding, the POST data will NOT be
330 * given in upload_data and is instead available as
331 * part of MHD_get_connection_values; very large POST
332 * data *will* be made available incrementally in
334 * @param upload_data_size set initially to the size of the
335 * @a upload_data provided; the method must update this
336 * value to the number of bytes NOT processed;
337 * @param con_cls pointer to location where we store the 'struct Request'
338 * @return MHD_YES if the connection was handled successfully,
339 * MHD_NO if the socket must be closed due to a serious
340 * error while handling the request
343 create_response (void *cls,
344 struct MHD_Connection *con,
348 const char *upload_data,
349 size_t *upload_data_size,
353 struct GNUNET_HashCode key;
354 struct MhdConnectionHandle *con_handle;
355 struct GNUNET_REST_RequestHandle *rest_conndata_handle;
357 con_handle = *con_cls;
359 if (NULL == *con_cls)
361 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
362 "New connection %s\n", url);
363 char tmp_url[strlen(url)+1];
364 strcpy (tmp_url, url);
365 con_handle = GNUNET_new (struct MhdConnectionHandle);
366 con_handle->con = con;
367 con_handle->state = GN_REST_STATE_INIT;
368 *con_cls = con_handle;
370 plugin_name = strtok(tmp_url, "/");
372 if (NULL != plugin_name)
374 GNUNET_CRYPTO_hash (plugin_name, strlen (plugin_name), &key);
376 con_handle->plugin = GNUNET_CONTAINER_multihashmap_get (plugin_map,
379 if (NULL == con_handle->plugin)
381 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
382 "Queueing response with MHD\n");
383 GNUNET_free (con_handle);
384 return MHD_queue_response (con,
391 if (GN_REST_STATE_INIT == con_handle->state)
393 rest_conndata_handle = GNUNET_new (struct GNUNET_REST_RequestHandle);
394 rest_conndata_handle->method = meth;
395 rest_conndata_handle->url = url;
396 rest_conndata_handle->data = upload_data;
397 rest_conndata_handle->data_size = *upload_data_size;
398 rest_conndata_handle->url_param_map = GNUNET_CONTAINER_multihashmap_create (16,
400 rest_conndata_handle->header_param_map = GNUNET_CONTAINER_multihashmap_create (16,
402 con_handle->data_handle = rest_conndata_handle;
403 MHD_get_connection_values (con,
404 MHD_GET_ARGUMENT_KIND,
406 rest_conndata_handle);
407 MHD_get_connection_values (con,
410 rest_conndata_handle);
411 con_handle->pp = MHD_create_post_processor(con,
414 rest_conndata_handle);
415 if (*upload_data_size)
417 MHD_post_process(con_handle->pp, upload_data, *upload_data_size);
419 MHD_destroy_post_processor(con_handle->pp);
421 con_handle->state = GN_REST_STATE_PROCESSING;
422 con_handle->plugin->process_request (rest_conndata_handle,
425 *upload_data_size = 0;
427 if (NULL != con_handle->response)
429 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
430 "Queueing response from plugin with MHD\n");
432 if (NULL != allow_origin)
434 MHD_add_response_header (con_handle->response,
435 MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
438 if (NULL != allow_credentials)
440 MHD_add_response_header (con_handle->response,
441 "Access-Control-Allow-Credentials",
444 if (NULL != allow_headers)
446 MHD_add_response_header (con_handle->response,
447 "Access-Control-Allow-Headers",
450 //Always add JSONAPI content type. TODO
451 MHD_add_response_header (con_handle->response,
452 MHD_HTTP_HEADER_CONTENT_TYPE,
453 "application/vnd.api+json");
454 int ret = MHD_queue_response (con,
456 con_handle->response);
457 cleanup_handle (con_handle);
464 /* ******************** MHD HTTP setup and event loop ******************** */
467 * Function called when MHD decides that we are done with a connection.
470 * @param connection connection handle
471 * @param con_cls value as set by the last call to
472 * the MHD_AccessHandlerCallback, should be our handle
473 * @param toe reason for request termination (ignored)
476 mhd_completed_cb (void *cls,
477 struct MHD_Connection *connection,
479 enum MHD_RequestTerminationCode toe)
481 if (MHD_REQUEST_TERMINATED_COMPLETED_OK != toe)
482 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
483 "MHD encountered error handling request: %d\n",
489 * Kill the MHD daemon.
496 MHD_stop_daemon (httpd);
499 if (NULL != httpd_task)
501 GNUNET_SCHEDULER_cancel (httpd_task);
506 GNUNET_SCHEDULER_cancel (ltask4);
511 GNUNET_SCHEDULER_cancel (ltask6);
517 GNUNET_NETWORK_socket_close (lsock4);
522 GNUNET_NETWORK_socket_close (lsock6);
529 * Schedule MHD. This function should be called initially when an
530 * MHD is first getting its client socket, and will then automatically
531 * always be called later whenever there is work to be done.
533 * @param hd the daemon to schedule
541 struct GNUNET_NETWORK_FDSet *wrs;
542 struct GNUNET_NETWORK_FDSet *wws;
545 MHD_UNSIGNED_LONG_LONG timeout;
546 struct GNUNET_TIME_Relative tv;
552 if (MHD_YES != MHD_get_fdset (httpd, &rs, &ws, &es, &max))
557 haveto = MHD_get_timeout (httpd, &timeout);
558 if (MHD_YES == haveto)
559 tv.rel_value_us = (uint64_t) timeout * 1000LL;
561 tv = GNUNET_TIME_UNIT_FOREVER_REL;
564 wrs = GNUNET_NETWORK_fdset_create ();
565 wws = GNUNET_NETWORK_fdset_create ();
566 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
567 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
574 if (NULL != httpd_task)
576 GNUNET_SCHEDULER_cancel (httpd_task);
579 if ( (MHD_YES == haveto) ||
583 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
589 GNUNET_NETWORK_fdset_destroy (wrs);
591 GNUNET_NETWORK_fdset_destroy (wws);
595 * Task run whenever HTTP server operations are pending.
609 * Accept new incoming connections
611 * @param cls the closure with the lsock4 or lsock6
612 * @param tc the scheduler context
615 do_accept (void *cls)
617 struct GNUNET_NETWORK_Handle *lsock = cls;
618 struct GNUNET_NETWORK_Handle *s;
620 const struct sockaddr *addr;
623 GNUNET_assert (NULL != lsock);
626 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
631 else if (lsock == lsock6)
633 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
640 s = GNUNET_NETWORK_socket_accept (lsock, NULL, NULL);
643 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "accept");
646 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
647 "Got an inbound connection, waiting for data\n");
648 fd = GNUNET_NETWORK_get_fd (s);
649 addr = GNUNET_NETWORK_get_addr (s);
650 len = GNUNET_NETWORK_get_addrlen (s);
651 if (MHD_YES != MHD_add_connection (httpd, fd, addr, len))
653 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
654 _("Failed to pass client to MHD\n"));
663 * Task run on shutdown
668 do_shutdown (void *cls)
670 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
671 "Shutting down...\n");
673 GNUNET_free_non_null (allow_origin);
674 GNUNET_free_non_null (allow_credentials);
675 GNUNET_free_non_null (allow_headers);
680 * Create an IPv4 listen socket bound to our port.
682 * @return NULL on error
684 static struct GNUNET_NETWORK_Handle *
687 struct GNUNET_NETWORK_Handle *ls;
688 struct sockaddr_in sa4;
691 memset (&sa4, 0, sizeof (sa4));
692 sa4.sin_family = AF_INET;
693 sa4.sin_port = htons (port);
694 #if HAVE_SOCKADDR_IN_SIN_LEN
695 sa4.sin_len = sizeof (sa4);
697 ls = GNUNET_NETWORK_socket_create (AF_INET,
703 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa4,
707 GNUNET_NETWORK_socket_close (ls);
716 * Create an IPv6 listen socket bound to our port.
718 * @return NULL on error
720 static struct GNUNET_NETWORK_Handle *
723 struct GNUNET_NETWORK_Handle *ls;
724 struct sockaddr_in6 sa6;
727 memset (&sa6, 0, sizeof (sa6));
728 sa6.sin6_family = AF_INET6;
729 sa6.sin6_port = htons (port);
730 #if HAVE_SOCKADDR_IN_SIN_LEN
731 sa6.sin6_len = sizeof (sa6);
733 ls = GNUNET_NETWORK_socket_create (AF_INET6,
739 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa6,
743 GNUNET_NETWORK_socket_close (ls);
752 * Callback for plugin load
755 * @param libname the name of the library loaded
756 * @param lib_ret the object returned by the plugin initializer
759 load_plugin (void *cls,
763 struct GNUNET_REST_Plugin *plugin = lib_ret;
764 struct GNUNET_HashCode key;
767 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
768 "Could not load plugin `%s'\n",
772 GNUNET_assert (1 < strlen (plugin->name));
773 GNUNET_assert ('/' == *plugin->name);
774 GNUNET_CRYPTO_hash (plugin->name+1, strlen (plugin->name+1), &key);
775 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (plugin_map,
778 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
780 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
781 "Could not load add plugin `%s'\n",
785 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
786 "Loaded plugin `%s'\n",
792 * Main function that will be run
795 * @param args remaining command-line arguments
796 * @param cfgfile name of the configuration file used (for saving, can be NULL)
797 * @param c configuration
803 const struct GNUNET_CONFIGURATION_Handle *c)
806 plugin_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
808 /* Get CORS data from cfg */
809 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
813 //No origin specified
814 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
815 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
818 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
819 "REST_ALLOW_CREDENTIALS",
822 //No origin specified
823 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
824 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
827 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
828 "REST_ALLOW_HEADERS",
831 //No origin specified
832 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
833 "No CORS Access-Control-Allow-Headers Header will be sent...\n");
836 /* Open listen socket proxy */
840 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
844 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock6, 5))
846 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
847 GNUNET_NETWORK_socket_close (lsock6);
852 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
853 lsock6, &do_accept, lsock6);
860 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
864 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock4, 5))
866 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
867 GNUNET_NETWORK_socket_close (lsock4);
872 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
873 lsock4, &do_accept, lsock4);
877 if ( (NULL == lsock4) &&
880 GNUNET_SCHEDULER_shutdown ();
883 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
884 "Service listens on port %llu\n",
886 httpd = MHD_start_daemon (MHD_USE_DEBUG | MHD_USE_NO_LISTEN_SOCKET,
889 &create_response, NULL,
890 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
891 MHD_OPTION_NOTIFY_COMPLETED, &mhd_completed_cb, NULL,
895 GNUNET_SCHEDULER_shutdown ();
899 GNUNET_PLUGIN_load_all ("libgnunet_plugin_rest",
903 GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
909 * The main function for gnunet-rest-service
911 * @param argc number of arguments from the cli
912 * @param argv command line arguments
913 * @return 0 ok, 1 on error
917 main (int argc, char *const *argv)
919 struct GNUNET_GETOPT_CommandLineOption options[] = {
920 GNUNET_GETOPT_option_ulong ('p',
923 gettext_noop ("listen on specified port (default: 7776)"),
925 GNUNET_GETOPT_OPTION_END
927 static const char* err_page =
931 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
933 GNUNET_log_setup ("gnunet-rest-server", "WARNING", NULL);
934 failure_response = MHD_create_response_from_buffer (strlen(err_page),
936 MHD_RESPMEM_PERSISTENT);
939 GNUNET_PROGRAM_run (argc, argv, "gnunet-rest-server",
940 _("GNUnet REST server"),
943 MHD_destroy_response (failure_response);
944 GNUNET_free_non_null ((char *) argv);
948 /* end of gnunet-rest-server.c */