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;
242 lowerkey = GNUNET_strdup (key);
243 GNUNET_STRINGS_utf8_tolower (key, lowerkey);
244 GNUNET_CRYPTO_hash (lowerkey, strlen (lowerkey), &hkey);
245 GNUNET_asprintf (&val, "%s", value);
247 GNUNET_CONTAINER_multihashmap_put (handle->header_param_map,
250 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
252 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
253 "Could not load add header `%s'=%s\n",
256 GNUNET_free (lowerkey);
262 url_iterator (void *cls,
263 enum MHD_ValueKind kind,
267 struct GNUNET_REST_RequestHandle *handle = cls;
268 struct GNUNET_HashCode hkey;
271 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
272 GNUNET_asprintf (&val, "%s", value);
274 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
277 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
279 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
280 "Could not load add url param `%s'=%s\n",
287 post_data_iter (void *cls,
288 enum MHD_ValueKind kind,
290 const char *filename,
291 const char *content_type,
292 const char *transfer_encoding,
297 struct GNUNET_REST_RequestHandle *handle = cls;
298 struct GNUNET_HashCode hkey;
301 if (MHD_POSTDATA_KIND != kind)
304 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
305 GNUNET_asprintf (&val, "%s", data);
307 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
310 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
312 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
313 "Could not load add url param '%s'=%s\n",
321 /* ********************************* MHD response generation ******************* */
324 * Main MHD callback for handling requests.
327 * @param con MHD connection handle
328 * @param url the url in the request
329 * @param meth the HTTP method used ("GET", "PUT", etc.)
330 * @param ver the HTTP version string (i.e. "HTTP/1.1")
331 * @param upload_data the data being uploaded (excluding HEADERS,
332 * for a POST that fits into memory and that is encoded
333 * with a supported encoding, the POST data will NOT be
334 * given in upload_data and is instead available as
335 * part of MHD_get_connection_values; very large POST
336 * data *will* be made available incrementally in
338 * @param upload_data_size set initially to the size of the
339 * @a upload_data provided; the method must update this
340 * value to the number of bytes NOT processed;
341 * @param con_cls pointer to location where we store the 'struct Request'
342 * @return MHD_YES if the connection was handled successfully,
343 * MHD_NO if the socket must be closed due to a serious
344 * error while handling the request
347 create_response (void *cls,
348 struct MHD_Connection *con,
352 const char *upload_data,
353 size_t *upload_data_size,
357 struct GNUNET_HashCode key;
358 struct MhdConnectionHandle *con_handle;
359 struct GNUNET_REST_RequestHandle *rest_conndata_handle;
361 con_handle = *con_cls;
363 if (NULL == *con_cls)
365 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
366 "New connection %s\n", url);
367 char tmp_url[strlen(url)+1];
368 strcpy (tmp_url, url);
369 con_handle = GNUNET_new (struct MhdConnectionHandle);
370 con_handle->con = con;
371 con_handle->state = GN_REST_STATE_INIT;
372 *con_cls = con_handle;
374 plugin_name = strtok(tmp_url, "/");
376 if (NULL != plugin_name)
378 GNUNET_CRYPTO_hash (plugin_name, strlen (plugin_name), &key);
380 con_handle->plugin = GNUNET_CONTAINER_multihashmap_get (plugin_map,
383 if (NULL == con_handle->plugin)
385 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
386 "Queueing response with MHD\n");
387 GNUNET_free (con_handle);
388 return MHD_queue_response (con,
395 if (GN_REST_STATE_INIT == con_handle->state)
397 rest_conndata_handle = GNUNET_new (struct GNUNET_REST_RequestHandle);
398 rest_conndata_handle->method = meth;
399 rest_conndata_handle->url = url;
400 rest_conndata_handle->data = upload_data;
401 rest_conndata_handle->data_size = *upload_data_size;
402 rest_conndata_handle->url_param_map = GNUNET_CONTAINER_multihashmap_create (16,
404 rest_conndata_handle->header_param_map = GNUNET_CONTAINER_multihashmap_create (16,
406 con_handle->data_handle = rest_conndata_handle;
407 MHD_get_connection_values (con,
408 MHD_GET_ARGUMENT_KIND,
410 rest_conndata_handle);
411 MHD_get_connection_values (con,
414 rest_conndata_handle);
415 con_handle->pp = MHD_create_post_processor(con,
418 rest_conndata_handle);
419 if (*upload_data_size)
421 MHD_post_process(con_handle->pp, upload_data, *upload_data_size);
423 MHD_destroy_post_processor(con_handle->pp);
425 con_handle->state = GN_REST_STATE_PROCESSING;
426 con_handle->plugin->process_request (rest_conndata_handle,
429 *upload_data_size = 0;
431 if (NULL != con_handle->response)
433 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
434 "Queueing response from plugin with MHD\n");
436 if (NULL != allow_origin)
438 MHD_add_response_header (con_handle->response,
439 MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
442 if (NULL != allow_credentials)
444 MHD_add_response_header (con_handle->response,
445 "Access-Control-Allow-Credentials",
448 if (NULL != allow_headers)
450 MHD_add_response_header (con_handle->response,
451 "Access-Control-Allow-Headers",
454 //Always add JSONAPI content type. TODO
455 MHD_add_response_header (con_handle->response,
456 MHD_HTTP_HEADER_CONTENT_TYPE,
457 "application/vnd.api+json");
458 int ret = MHD_queue_response (con,
460 con_handle->response);
461 cleanup_handle (con_handle);
468 /* ******************** MHD HTTP setup and event loop ******************** */
471 * Function called when MHD decides that we are done with a connection.
474 * @param connection connection handle
475 * @param con_cls value as set by the last call to
476 * the MHD_AccessHandlerCallback, should be our handle
477 * @param toe reason for request termination (ignored)
480 mhd_completed_cb (void *cls,
481 struct MHD_Connection *connection,
483 enum MHD_RequestTerminationCode toe)
485 if (MHD_REQUEST_TERMINATED_COMPLETED_OK != toe)
486 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
487 "MHD encountered error handling request: %d\n",
493 * Kill the MHD daemon.
500 MHD_stop_daemon (httpd);
503 if (NULL != httpd_task)
505 GNUNET_SCHEDULER_cancel (httpd_task);
510 GNUNET_SCHEDULER_cancel (ltask4);
515 GNUNET_SCHEDULER_cancel (ltask6);
521 GNUNET_NETWORK_socket_close (lsock4);
526 GNUNET_NETWORK_socket_close (lsock6);
533 * Schedule MHD. This function should be called initially when an
534 * MHD is first getting its client socket, and will then automatically
535 * always be called later whenever there is work to be done.
537 * @param hd the daemon to schedule
545 struct GNUNET_NETWORK_FDSet *wrs;
546 struct GNUNET_NETWORK_FDSet *wws;
549 MHD_UNSIGNED_LONG_LONG timeout;
550 struct GNUNET_TIME_Relative tv;
556 if (MHD_YES != MHD_get_fdset (httpd, &rs, &ws, &es, &max))
561 haveto = MHD_get_timeout (httpd, &timeout);
562 if (MHD_YES == haveto)
563 tv.rel_value_us = (uint64_t) timeout * 1000LL;
565 tv = GNUNET_TIME_UNIT_FOREVER_REL;
568 wrs = GNUNET_NETWORK_fdset_create ();
569 wws = GNUNET_NETWORK_fdset_create ();
570 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
571 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
578 if (NULL != httpd_task)
580 GNUNET_SCHEDULER_cancel (httpd_task);
583 if ( (MHD_YES == haveto) ||
587 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
593 GNUNET_NETWORK_fdset_destroy (wrs);
595 GNUNET_NETWORK_fdset_destroy (wws);
599 * Task run whenever HTTP server operations are pending.
613 * Accept new incoming connections
615 * @param cls the closure with the lsock4 or lsock6
616 * @param tc the scheduler context
619 do_accept (void *cls)
621 struct GNUNET_NETWORK_Handle *lsock = cls;
622 struct GNUNET_NETWORK_Handle *s;
624 const struct sockaddr *addr;
627 GNUNET_assert (NULL != lsock);
630 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
635 else if (lsock == lsock6)
637 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
644 s = GNUNET_NETWORK_socket_accept (lsock, NULL, NULL);
647 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "accept");
650 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
651 "Got an inbound connection, waiting for data\n");
652 fd = GNUNET_NETWORK_get_fd (s);
653 addr = GNUNET_NETWORK_get_addr (s);
654 len = GNUNET_NETWORK_get_addrlen (s);
655 if (MHD_YES != MHD_add_connection (httpd, fd, addr, len))
657 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
658 _("Failed to pass client to MHD\n"));
667 * Task run on shutdown
672 do_shutdown (void *cls)
674 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
675 "Shutting down...\n");
677 GNUNET_free_non_null (allow_origin);
678 GNUNET_free_non_null (allow_credentials);
679 GNUNET_free_non_null (allow_headers);
684 * Create an IPv4 listen socket bound to our port.
686 * @return NULL on error
688 static struct GNUNET_NETWORK_Handle *
691 struct GNUNET_NETWORK_Handle *ls;
692 struct sockaddr_in sa4;
695 memset (&sa4, 0, sizeof (sa4));
696 sa4.sin_family = AF_INET;
697 sa4.sin_port = htons (port);
698 #if HAVE_SOCKADDR_IN_SIN_LEN
699 sa4.sin_len = sizeof (sa4);
701 ls = GNUNET_NETWORK_socket_create (AF_INET,
707 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa4,
711 GNUNET_NETWORK_socket_close (ls);
720 * Create an IPv6 listen socket bound to our port.
722 * @return NULL on error
724 static struct GNUNET_NETWORK_Handle *
727 struct GNUNET_NETWORK_Handle *ls;
728 struct sockaddr_in6 sa6;
731 memset (&sa6, 0, sizeof (sa6));
732 sa6.sin6_family = AF_INET6;
733 sa6.sin6_port = htons (port);
734 #if HAVE_SOCKADDR_IN_SIN_LEN
735 sa6.sin6_len = sizeof (sa6);
737 ls = GNUNET_NETWORK_socket_create (AF_INET6,
743 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa6,
747 GNUNET_NETWORK_socket_close (ls);
756 * Callback for plugin load
759 * @param libname the name of the library loaded
760 * @param lib_ret the object returned by the plugin initializer
763 load_plugin (void *cls,
767 struct GNUNET_REST_Plugin *plugin = lib_ret;
768 struct GNUNET_HashCode key;
771 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
772 "Could not load plugin `%s'\n",
776 GNUNET_assert (1 < strlen (plugin->name));
777 GNUNET_assert ('/' == *plugin->name);
778 GNUNET_CRYPTO_hash (plugin->name+1, strlen (plugin->name+1), &key);
779 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (plugin_map,
782 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
784 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
785 "Could not load add plugin `%s'\n",
789 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
790 "Loaded plugin `%s'\n",
796 * Main function that will be run
799 * @param args remaining command-line arguments
800 * @param cfgfile name of the configuration file used (for saving, can be NULL)
801 * @param c configuration
807 const struct GNUNET_CONFIGURATION_Handle *c)
810 plugin_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
812 /* Get CORS data from cfg */
813 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
817 //No origin specified
818 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
819 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
822 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
823 "REST_ALLOW_CREDENTIALS",
826 //No origin specified
827 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
828 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
831 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
832 "REST_ALLOW_HEADERS",
835 //No origin specified
836 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
837 "No CORS Access-Control-Allow-Headers Header will be sent...\n");
840 /* Open listen socket proxy */
844 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
848 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock6, 5))
850 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
851 GNUNET_NETWORK_socket_close (lsock6);
856 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
857 lsock6, &do_accept, lsock6);
864 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
868 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock4, 5))
870 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
871 GNUNET_NETWORK_socket_close (lsock4);
876 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
877 lsock4, &do_accept, lsock4);
881 if ( (NULL == lsock4) &&
884 GNUNET_SCHEDULER_shutdown ();
887 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
888 "Service listens on port %llu\n",
890 httpd = MHD_start_daemon (MHD_USE_DEBUG | MHD_USE_NO_LISTEN_SOCKET,
893 &create_response, NULL,
894 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
895 MHD_OPTION_NOTIFY_COMPLETED, &mhd_completed_cb, NULL,
899 GNUNET_SCHEDULER_shutdown ();
903 GNUNET_PLUGIN_load_all ("libgnunet_plugin_rest",
907 GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
913 * The main function for gnunet-rest-service
915 * @param argc number of arguments from the cli
916 * @param argv command line arguments
917 * @return 0 ok, 1 on error
921 main (int argc, char *const *argv)
923 struct GNUNET_GETOPT_CommandLineOption options[] = {
924 GNUNET_GETOPT_option_ulong ('p',
927 gettext_noop ("listen on specified port (default: 7776)"),
929 GNUNET_GETOPT_OPTION_END
931 static const char* err_page =
935 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
937 GNUNET_log_setup ("gnunet-rest-server", "WARNING", NULL);
938 failure_response = MHD_create_response_from_buffer (strlen(err_page),
940 MHD_RESPMEM_PERSISTENT);
943 GNUNET_PROGRAM_run (argc, argv, "gnunet-rest-server",
944 _("GNUnet REST server"),
947 MHD_destroy_response (failure_response);
948 GNUNET_free_non_null ((char *) argv);
952 /* end of gnunet-rest-server.c */