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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
16 * @author Martin Schanzenbach
17 * @file src/rest/gnunet-rest-server.c
18 * @brief REST service for GNUnet services
22 #include <microhttpd.h>
23 #include "gnunet_util_lib.h"
24 #include "gnunet_rest_plugin.h"
28 * Default Socks5 listen port.
30 #define GNUNET_REST_SERVICE_PORT 7776
33 * Maximum supported length for a URI.
34 * Should die. @deprecated
36 #define MAX_HTTP_URI_LENGTH 2048
39 * Port for plaintext HTTP.
46 #define HTTPS_PORT 443
49 * After how long do we clean up unused MHD SSL/TLS instances?
51 #define MHD_CACHE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
53 #define GN_REST_STATE_INIT 0
54 #define GN_REST_STATE_PROCESSING 1
59 static struct GNUNET_SCHEDULER_Task *httpd_task;
62 * The port the service is running on (default 7776)
64 static unsigned long long port = GNUNET_REST_SERVICE_PORT;
67 * The listen socket of the service for IPv4
69 static struct GNUNET_NETWORK_Handle *lsock4;
72 * The listen socket of the service for IPv6
74 static struct GNUNET_NETWORK_Handle *lsock6;
77 * The listen task ID for IPv4
79 static struct GNUNET_SCHEDULER_Task * ltask4;
82 * The listen task ID for IPv6
84 static struct GNUNET_SCHEDULER_Task * ltask6;
89 static struct MHD_Daemon *httpd;
92 * Response we return on failures.
94 static struct MHD_Response *failure_response;
99 static const struct GNUNET_CONFIGURATION_Handle *cfg;
102 * Map of loaded plugins.
104 static struct GNUNET_CONTAINER_MultiHashMap *plugin_map;
107 * Allowed Origins (CORS)
109 static char* allow_origin;
112 * Allowed Headers (CORS)
114 static char* allow_headers;
117 * Allowed Credentials (CORS)
119 static char* allow_credentials;
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)
207 if (NULL != handle->data_handle->header_param_map)
209 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->header_param_map,
212 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->header_param_map);
214 if (NULL != handle->data_handle->url_param_map)
216 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->url_param_map,
219 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->url_param_map);
221 GNUNET_free (handle->data_handle);
223 GNUNET_free (handle);
227 header_iterator (void *cls,
228 enum MHD_ValueKind kind,
232 struct GNUNET_REST_RequestHandle *handle = cls;
233 struct GNUNET_HashCode hkey;
237 lowerkey = GNUNET_strdup (key);
238 GNUNET_STRINGS_utf8_tolower (key, lowerkey);
239 GNUNET_CRYPTO_hash (lowerkey, strlen (lowerkey), &hkey);
240 GNUNET_asprintf (&val, "%s", value);
242 GNUNET_CONTAINER_multihashmap_put (handle->header_param_map,
245 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
247 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
248 "Could not load add header `%s'=%s\n",
251 GNUNET_free (lowerkey);
257 url_iterator (void *cls,
258 enum MHD_ValueKind kind,
262 struct GNUNET_REST_RequestHandle *handle = cls;
263 struct GNUNET_HashCode hkey;
266 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
267 GNUNET_asprintf (&val, "%s", value);
269 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
272 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
274 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
275 "Could not load add url param `%s'=%s\n",
282 post_data_iter (void *cls,
283 enum MHD_ValueKind kind,
285 const char *filename,
286 const char *content_type,
287 const char *transfer_encoding,
292 struct GNUNET_REST_RequestHandle *handle = cls;
293 struct GNUNET_HashCode hkey;
296 if (MHD_POSTDATA_KIND != kind)
299 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
300 GNUNET_asprintf (&val, "%s", data);
302 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
305 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
307 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
308 "Could not load add url param '%s'=%s\n",
316 /* ********************************* MHD response generation ******************* */
319 * Main MHD callback for handling requests.
322 * @param con MHD connection handle
323 * @param url the url in the request
324 * @param meth the HTTP method used ("GET", "PUT", etc.)
325 * @param ver the HTTP version string (i.e. "HTTP/1.1")
326 * @param upload_data the data being uploaded (excluding HEADERS,
327 * for a POST that fits into memory and that is encoded
328 * with a supported encoding, the POST data will NOT be
329 * given in upload_data and is instead available as
330 * part of MHD_get_connection_values; very large POST
331 * data *will* be made available incrementally in
333 * @param upload_data_size set initially to the size of the
334 * @a upload_data provided; the method must update this
335 * value to the number of bytes NOT processed;
336 * @param con_cls pointer to location where we store the 'struct Request'
337 * @return MHD_YES if the connection was handled successfully,
338 * MHD_NO if the socket must be closed due to a serious
339 * error while handling the request
342 create_response (void *cls,
343 struct MHD_Connection *con,
347 const char *upload_data,
348 size_t *upload_data_size,
352 struct GNUNET_HashCode key;
353 struct MhdConnectionHandle *con_handle;
354 struct GNUNET_REST_RequestHandle *rest_conndata_handle;
356 con_handle = *con_cls;
358 if (NULL == *con_cls)
360 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
361 "New connection %s\n", url);
362 char tmp_url[strlen(url)+1];
363 strcpy (tmp_url, url);
364 con_handle = GNUNET_new (struct MhdConnectionHandle);
365 con_handle->con = con;
366 con_handle->state = GN_REST_STATE_INIT;
367 *con_cls = con_handle;
369 plugin_name = strtok(tmp_url, "/");
371 if (NULL != plugin_name)
373 GNUNET_CRYPTO_hash (plugin_name, strlen (plugin_name), &key);
375 con_handle->plugin = GNUNET_CONTAINER_multihashmap_get (plugin_map,
378 if (NULL == con_handle->plugin)
380 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
381 "Queueing response with MHD\n");
382 GNUNET_free (con_handle);
383 return MHD_queue_response (con,
390 if (GN_REST_STATE_INIT == con_handle->state)
392 rest_conndata_handle = GNUNET_new (struct GNUNET_REST_RequestHandle);
393 rest_conndata_handle->method = meth;
394 rest_conndata_handle->url = url;
395 rest_conndata_handle->data = upload_data;
396 rest_conndata_handle->data_size = *upload_data_size;
397 rest_conndata_handle->url_param_map = GNUNET_CONTAINER_multihashmap_create (16,
399 rest_conndata_handle->header_param_map = GNUNET_CONTAINER_multihashmap_create (16,
401 con_handle->data_handle = rest_conndata_handle;
402 MHD_get_connection_values (con,
403 MHD_GET_ARGUMENT_KIND,
405 rest_conndata_handle);
406 MHD_get_connection_values (con,
409 rest_conndata_handle);
410 con_handle->pp = MHD_create_post_processor(con,
413 rest_conndata_handle);
414 if (*upload_data_size)
416 MHD_post_process(con_handle->pp, upload_data, *upload_data_size);
418 MHD_destroy_post_processor(con_handle->pp);
420 con_handle->state = GN_REST_STATE_PROCESSING;
421 con_handle->plugin->process_request (rest_conndata_handle,
424 *upload_data_size = 0;
426 if (NULL != con_handle->response)
428 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
429 "Queueing response from plugin with MHD\n");
431 if (NULL != allow_origin)
433 MHD_add_response_header (con_handle->response,
434 MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
437 if (NULL != allow_credentials)
439 MHD_add_response_header (con_handle->response,
440 "Access-Control-Allow-Credentials",
443 if (NULL != allow_headers)
445 MHD_add_response_header (con_handle->response,
446 "Access-Control-Allow-Headers",
449 //Always add JSONAPI content type. TODO
450 MHD_add_response_header (con_handle->response,
451 MHD_HTTP_HEADER_CONTENT_TYPE,
452 "application/vnd.api+json");
453 int ret = MHD_queue_response (con,
455 con_handle->response);
456 cleanup_handle (con_handle);
463 /* ******************** MHD HTTP setup and event loop ******************** */
466 * Function called when MHD decides that we are done with a connection.
469 * @param connection connection handle
470 * @param con_cls value as set by the last call to
471 * the MHD_AccessHandlerCallback, should be our handle
472 * @param toe reason for request termination (ignored)
475 mhd_completed_cb (void *cls,
476 struct MHD_Connection *connection,
478 enum MHD_RequestTerminationCode toe)
480 if (MHD_REQUEST_TERMINATED_COMPLETED_OK != toe)
481 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
482 "MHD encountered error handling request: %d\n",
488 * Kill the MHD daemon.
495 MHD_stop_daemon (httpd);
498 if (NULL != httpd_task)
500 GNUNET_SCHEDULER_cancel (httpd_task);
505 GNUNET_SCHEDULER_cancel (ltask4);
510 GNUNET_SCHEDULER_cancel (ltask6);
516 GNUNET_NETWORK_socket_close (lsock4);
521 GNUNET_NETWORK_socket_close (lsock6);
528 * Schedule MHD. This function should be called initially when an
529 * MHD is first getting its client socket, and will then automatically
530 * always be called later whenever there is work to be done.
532 * @param hd the daemon to schedule
540 struct GNUNET_NETWORK_FDSet *wrs;
541 struct GNUNET_NETWORK_FDSet *wws;
544 MHD_UNSIGNED_LONG_LONG timeout;
545 struct GNUNET_TIME_Relative tv;
551 if (MHD_YES != MHD_get_fdset (httpd, &rs, &ws, &es, &max))
556 haveto = MHD_get_timeout (httpd, &timeout);
557 if (MHD_YES == haveto)
558 tv.rel_value_us = (uint64_t) timeout * 1000LL;
560 tv = GNUNET_TIME_UNIT_FOREVER_REL;
563 wrs = GNUNET_NETWORK_fdset_create ();
564 wws = GNUNET_NETWORK_fdset_create ();
565 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
566 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
573 if (NULL != httpd_task)
575 GNUNET_SCHEDULER_cancel (httpd_task);
578 if ( (MHD_YES == haveto) ||
582 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
588 GNUNET_NETWORK_fdset_destroy (wrs);
590 GNUNET_NETWORK_fdset_destroy (wws);
594 * Task run whenever HTTP server operations are pending.
608 * Accept new incoming connections
610 * @param cls the closure with the lsock4 or lsock6
611 * @param tc the scheduler context
614 do_accept (void *cls)
616 struct GNUNET_NETWORK_Handle *lsock = cls;
617 struct GNUNET_NETWORK_Handle *s;
619 const struct sockaddr *addr;
622 GNUNET_assert (NULL != lsock);
625 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
630 else if (lsock == lsock6)
632 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
639 s = GNUNET_NETWORK_socket_accept (lsock, NULL, NULL);
642 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "accept");
645 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
646 "Got an inbound connection, waiting for data\n");
647 fd = GNUNET_NETWORK_get_fd (s);
648 addr = GNUNET_NETWORK_get_addr (s);
649 len = GNUNET_NETWORK_get_addrlen (s);
650 if (MHD_YES != MHD_add_connection (httpd, fd, addr, len))
652 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
653 _("Failed to pass client to MHD\n"));
662 * Task run on shutdown
667 do_shutdown (void *cls)
669 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
670 "Shutting down...\n");
672 GNUNET_free_non_null (allow_origin);
673 GNUNET_free_non_null (allow_credentials);
674 GNUNET_free_non_null (allow_headers);
679 * Create an IPv4 listen socket bound to our port.
681 * @return NULL on error
683 static struct GNUNET_NETWORK_Handle *
686 struct GNUNET_NETWORK_Handle *ls;
687 struct sockaddr_in sa4;
690 memset (&sa4, 0, sizeof (sa4));
691 sa4.sin_family = AF_INET;
692 sa4.sin_port = htons (port);
693 #if HAVE_SOCKADDR_IN_SIN_LEN
694 sa4.sin_len = sizeof (sa4);
696 ls = GNUNET_NETWORK_socket_create (AF_INET,
702 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa4,
706 GNUNET_NETWORK_socket_close (ls);
715 * Create an IPv6 listen socket bound to our port.
717 * @return NULL on error
719 static struct GNUNET_NETWORK_Handle *
722 struct GNUNET_NETWORK_Handle *ls;
723 struct sockaddr_in6 sa6;
726 memset (&sa6, 0, sizeof (sa6));
727 sa6.sin6_family = AF_INET6;
728 sa6.sin6_port = htons (port);
729 #if HAVE_SOCKADDR_IN_SIN_LEN
730 sa6.sin6_len = sizeof (sa6);
732 ls = GNUNET_NETWORK_socket_create (AF_INET6,
738 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa6,
742 GNUNET_NETWORK_socket_close (ls);
751 * Callback for plugin load
754 * @param libname the name of the library loaded
755 * @param lib_ret the object returned by the plugin initializer
758 load_plugin (void *cls,
762 struct GNUNET_REST_Plugin *plugin = lib_ret;
763 struct GNUNET_HashCode key;
766 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
767 "Could not load plugin `%s'\n",
771 GNUNET_assert (1 < strlen (plugin->name));
772 GNUNET_assert ('/' == *plugin->name);
773 GNUNET_CRYPTO_hash (plugin->name+1, strlen (plugin->name+1), &key);
774 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (plugin_map,
777 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
779 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
780 "Could not load add plugin `%s'\n",
784 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
785 "Loaded plugin `%s'\n",
791 * Main function that will be run
794 * @param args remaining command-line arguments
795 * @param cfgfile name of the configuration file used (for saving, can be NULL)
796 * @param c configuration
802 const struct GNUNET_CONFIGURATION_Handle *c)
805 plugin_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
807 /* Get CORS data from cfg */
808 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
812 //No origin specified
813 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
814 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
817 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
818 "REST_ALLOW_CREDENTIALS",
821 //No origin specified
822 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
823 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
826 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
827 "REST_ALLOW_HEADERS",
830 //No origin specified
831 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
832 "No CORS Access-Control-Allow-Headers Header will be sent...\n");
835 /* Open listen socket proxy */
839 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
843 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock6, 5))
845 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
846 GNUNET_NETWORK_socket_close (lsock6);
851 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
852 lsock6, &do_accept, lsock6);
859 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
863 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock4, 5))
865 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
866 GNUNET_NETWORK_socket_close (lsock4);
871 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
872 lsock4, &do_accept, lsock4);
876 if ( (NULL == lsock4) &&
879 GNUNET_SCHEDULER_shutdown ();
882 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
883 "Service listens on port %llu\n",
885 httpd = MHD_start_daemon (MHD_USE_DEBUG | MHD_USE_NO_LISTEN_SOCKET,
888 &create_response, NULL,
889 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
890 MHD_OPTION_NOTIFY_COMPLETED, &mhd_completed_cb, NULL,
894 GNUNET_SCHEDULER_shutdown ();
898 GNUNET_PLUGIN_load_all ("libgnunet_plugin_rest",
902 GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
908 * The main function for gnunet-rest-service
910 * @param argc number of arguments from the cli
911 * @param argv command line arguments
912 * @return 0 ok, 1 on error
916 main (int argc, char *const *argv)
918 struct GNUNET_GETOPT_CommandLineOption options[] = {
919 GNUNET_GETOPT_option_ulong ('p',
922 gettext_noop ("listen on specified port (default: 7776)"),
924 GNUNET_GETOPT_OPTION_END
926 static const char* err_page =
930 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
932 GNUNET_log_setup ("gnunet-rest-server", "WARNING", NULL);
933 failure_response = MHD_create_response_from_buffer (strlen(err_page),
935 MHD_RESPMEM_PERSISTENT);
938 GNUNET_PROGRAM_run (argc, argv, "gnunet-rest-server",
939 _("GNUnet REST server"),
942 MHD_destroy_response (failure_response);
943 GNUNET_free_non_null ((char *) argv);
947 /* end of gnunet-rest-server.c */