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.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * @author Martin Schanzenbach
20 * @file src/rest/gnunet-rest-server.c
21 * @brief REST service for GNUnet services
25 #include <microhttpd.h>
26 #include "gnunet_util_lib.h"
27 #include "gnunet_rest_plugin.h"
31 * Default Socks5 listen port.
33 #define GNUNET_REST_SERVICE_PORT 7776
36 * Maximum supported length for a URI.
37 * Should die. @deprecated
39 #define MAX_HTTP_URI_LENGTH 2048
42 * Port for plaintext HTTP.
49 #define HTTPS_PORT 443
52 * After how long do we clean up unused MHD SSL/TLS instances?
54 #define MHD_CACHE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
56 #define GN_REST_STATE_INIT 0
57 #define GN_REST_STATE_PROCESSING 1
62 static struct GNUNET_SCHEDULER_Task *httpd_task;
65 * The port the service is running on (default 7776)
67 static unsigned long long port = GNUNET_REST_SERVICE_PORT;
70 * The listen socket of the service for IPv4
72 static struct GNUNET_NETWORK_Handle *lsock4;
75 * The listen socket of the service for IPv6
77 static struct GNUNET_NETWORK_Handle *lsock6;
80 * The listen task ID for IPv4
82 static struct GNUNET_SCHEDULER_Task * ltask4;
85 * The listen task ID for IPv6
87 static struct GNUNET_SCHEDULER_Task * ltask6;
92 static struct MHD_Daemon *httpd;
95 * Response we return on failures.
97 static struct MHD_Response *failure_response;
102 static const struct GNUNET_CONFIGURATION_Handle *cfg;
105 * Map of loaded plugins.
107 static struct GNUNET_CONTAINER_MultiHashMap *plugin_map;
110 * Allowed Origins (CORS)
112 static char* allow_origin;
115 * Allowed Headers (CORS)
117 static char* allow_headers;
120 * Allowed Credentials (CORS)
122 static char* allow_credentials;
125 * MHD Connection handle
127 struct MhdConnectionHandle
129 struct MHD_Connection *con;
131 struct MHD_Response *response;
133 struct GNUNET_REST_Plugin *plugin;
135 struct GNUNET_REST_RequestHandle *data_handle;
137 struct MHD_PostProcessor *pp;
144 /* ************************* Global helpers ********************* */
148 * Task run whenever HTTP server operations are pending.
153 do_httpd (void *cls);
157 * Run MHD now, we have extra data ready for the callback.
162 if (NULL != httpd_task)
164 GNUNET_SCHEDULER_cancel (httpd_task);
167 httpd_task = GNUNET_SCHEDULER_add_now (&do_httpd,
173 * Plugin result callback
175 * @param cls closure (MHD connection handle)
176 * @param data the data to return to the caller
177 * @param len length of the data
178 * @param status #GNUNET_OK if successful
181 plugin_callback (void *cls,
182 struct MHD_Response *resp,
185 struct MhdConnectionHandle *handle = cls;
186 handle->status = status;
187 handle->response = resp;
193 cleanup_url_map (void *cls,
194 const struct GNUNET_HashCode *key,
197 GNUNET_free_non_null (value);
203 cleanup_handle (struct MhdConnectionHandle *handle)
205 if (NULL != handle->response)
206 MHD_destroy_response (handle->response);
207 if (NULL != handle->data_handle)
210 if (NULL != handle->data_handle->header_param_map)
212 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->header_param_map,
215 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->header_param_map);
217 if (NULL != handle->data_handle->url_param_map)
219 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->url_param_map,
222 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->url_param_map);
224 GNUNET_free (handle->data_handle);
226 GNUNET_free (handle);
230 header_iterator (void *cls,
231 enum MHD_ValueKind kind,
235 struct GNUNET_REST_RequestHandle *handle = cls;
236 struct GNUNET_HashCode hkey;
240 lowerkey = GNUNET_strdup (key);
241 GNUNET_STRINGS_utf8_tolower (key, lowerkey);
242 GNUNET_CRYPTO_hash (lowerkey, strlen (lowerkey), &hkey);
243 GNUNET_asprintf (&val, "%s", value);
245 GNUNET_CONTAINER_multihashmap_put (handle->header_param_map,
248 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
250 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
251 "Could not load add header `%s'=%s\n",
254 GNUNET_free (lowerkey);
260 url_iterator (void *cls,
261 enum MHD_ValueKind kind,
265 struct GNUNET_REST_RequestHandle *handle = cls;
266 struct GNUNET_HashCode hkey;
269 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
270 GNUNET_asprintf (&val, "%s", value);
272 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
275 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
277 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
278 "Could not load add url param `%s'=%s\n",
285 post_data_iter (void *cls,
286 enum MHD_ValueKind kind,
288 const char *filename,
289 const char *content_type,
290 const char *transfer_encoding,
295 struct GNUNET_REST_RequestHandle *handle = cls;
296 struct GNUNET_HashCode hkey;
299 if (MHD_POSTDATA_KIND != kind)
302 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
303 GNUNET_asprintf (&val, "%s", data);
305 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
308 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
310 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
311 "Could not load add url param '%s'=%s\n",
319 /* ********************************* MHD response generation ******************* */
322 * Main MHD callback for handling requests.
325 * @param con MHD connection handle
326 * @param url the url in the request
327 * @param meth the HTTP method used ("GET", "PUT", etc.)
328 * @param ver the HTTP version string (i.e. "HTTP/1.1")
329 * @param upload_data the data being uploaded (excluding HEADERS,
330 * for a POST that fits into memory and that is encoded
331 * with a supported encoding, the POST data will NOT be
332 * given in upload_data and is instead available as
333 * part of MHD_get_connection_values; very large POST
334 * data *will* be made available incrementally in
336 * @param upload_data_size set initially to the size of the
337 * @a upload_data provided; the method must update this
338 * value to the number of bytes NOT processed;
339 * @param con_cls pointer to location where we store the 'struct Request'
340 * @return MHD_YES if the connection was handled successfully,
341 * MHD_NO if the socket must be closed due to a serious
342 * error while handling the request
345 create_response (void *cls,
346 struct MHD_Connection *con,
350 const char *upload_data,
351 size_t *upload_data_size,
355 struct GNUNET_HashCode key;
356 struct MhdConnectionHandle *con_handle;
357 struct GNUNET_REST_RequestHandle *rest_conndata_handle;
359 con_handle = *con_cls;
361 if (NULL == *con_cls)
363 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
364 "New connection %s\n", url);
365 char tmp_url[strlen(url)+1];
366 strcpy (tmp_url, url);
367 con_handle = GNUNET_new (struct MhdConnectionHandle);
368 con_handle->con = con;
369 con_handle->state = GN_REST_STATE_INIT;
370 *con_cls = con_handle;
372 plugin_name = strtok(tmp_url, "/");
374 if (NULL != plugin_name)
376 GNUNET_CRYPTO_hash (plugin_name, strlen (plugin_name), &key);
378 con_handle->plugin = GNUNET_CONTAINER_multihashmap_get (plugin_map,
381 if (NULL == con_handle->plugin)
383 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
384 "Queueing response with MHD\n");
385 GNUNET_free (con_handle);
386 return MHD_queue_response (con,
393 if (GN_REST_STATE_INIT == con_handle->state)
395 rest_conndata_handle = GNUNET_new (struct GNUNET_REST_RequestHandle);
396 rest_conndata_handle->method = meth;
397 rest_conndata_handle->url = url;
398 rest_conndata_handle->data = upload_data;
399 rest_conndata_handle->data_size = *upload_data_size;
400 rest_conndata_handle->url_param_map = GNUNET_CONTAINER_multihashmap_create (16,
402 rest_conndata_handle->header_param_map = GNUNET_CONTAINER_multihashmap_create (16,
404 con_handle->data_handle = rest_conndata_handle;
405 MHD_get_connection_values (con,
406 MHD_GET_ARGUMENT_KIND,
408 rest_conndata_handle);
409 MHD_get_connection_values (con,
412 rest_conndata_handle);
413 con_handle->pp = MHD_create_post_processor(con,
416 rest_conndata_handle);
417 if (*upload_data_size)
419 MHD_post_process(con_handle->pp, upload_data, *upload_data_size);
421 MHD_destroy_post_processor(con_handle->pp);
423 con_handle->state = GN_REST_STATE_PROCESSING;
424 con_handle->plugin->process_request (rest_conndata_handle,
427 *upload_data_size = 0;
429 if (NULL != con_handle->response)
431 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
432 "Queueing response from plugin with MHD\n");
434 if (NULL != allow_origin)
436 MHD_add_response_header (con_handle->response,
437 MHD_HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
440 if (NULL != allow_credentials)
442 MHD_add_response_header (con_handle->response,
443 "Access-Control-Allow-Credentials",
446 if (NULL != allow_headers)
448 MHD_add_response_header (con_handle->response,
449 "Access-Control-Allow-Headers",
452 //Always add JSONAPI content type. TODO
453 MHD_add_response_header (con_handle->response,
454 MHD_HTTP_HEADER_CONTENT_TYPE,
455 "application/vnd.api+json");
456 int ret = MHD_queue_response (con,
458 con_handle->response);
459 cleanup_handle (con_handle);
466 /* ******************** MHD HTTP setup and event loop ******************** */
469 * Function called when MHD decides that we are done with a connection.
472 * @param connection connection handle
473 * @param con_cls value as set by the last call to
474 * the MHD_AccessHandlerCallback, should be our handle
475 * @param toe reason for request termination (ignored)
478 mhd_completed_cb (void *cls,
479 struct MHD_Connection *connection,
481 enum MHD_RequestTerminationCode toe)
483 if (MHD_REQUEST_TERMINATED_COMPLETED_OK != toe)
484 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
485 "MHD encountered error handling request: %d\n",
491 * Kill the MHD daemon.
498 MHD_stop_daemon (httpd);
501 if (NULL != httpd_task)
503 GNUNET_SCHEDULER_cancel (httpd_task);
508 GNUNET_SCHEDULER_cancel (ltask4);
513 GNUNET_SCHEDULER_cancel (ltask6);
519 GNUNET_NETWORK_socket_close (lsock4);
524 GNUNET_NETWORK_socket_close (lsock6);
531 * Schedule MHD. This function should be called initially when an
532 * MHD is first getting its client socket, and will then automatically
533 * always be called later whenever there is work to be done.
535 * @param hd the daemon to schedule
543 struct GNUNET_NETWORK_FDSet *wrs;
544 struct GNUNET_NETWORK_FDSet *wws;
547 MHD_UNSIGNED_LONG_LONG timeout;
548 struct GNUNET_TIME_Relative tv;
554 if (MHD_YES != MHD_get_fdset (httpd, &rs, &ws, &es, &max))
559 haveto = MHD_get_timeout (httpd, &timeout);
560 if (MHD_YES == haveto)
561 tv.rel_value_us = (uint64_t) timeout * 1000LL;
563 tv = GNUNET_TIME_UNIT_FOREVER_REL;
566 wrs = GNUNET_NETWORK_fdset_create ();
567 wws = GNUNET_NETWORK_fdset_create ();
568 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
569 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
576 if (NULL != httpd_task)
578 GNUNET_SCHEDULER_cancel (httpd_task);
581 if ( (MHD_YES == haveto) ||
585 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
591 GNUNET_NETWORK_fdset_destroy (wrs);
593 GNUNET_NETWORK_fdset_destroy (wws);
597 * Task run whenever HTTP server operations are pending.
611 * Accept new incoming connections
613 * @param cls the closure with the lsock4 or lsock6
614 * @param tc the scheduler context
617 do_accept (void *cls)
619 struct GNUNET_NETWORK_Handle *lsock = cls;
620 struct GNUNET_NETWORK_Handle *s;
622 const struct sockaddr *addr;
625 GNUNET_assert (NULL != lsock);
628 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
633 else if (lsock == lsock6)
635 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
642 s = GNUNET_NETWORK_socket_accept (lsock, NULL, NULL);
645 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "accept");
648 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
649 "Got an inbound connection, waiting for data\n");
650 fd = GNUNET_NETWORK_get_fd (s);
651 addr = GNUNET_NETWORK_get_addr (s);
652 len = GNUNET_NETWORK_get_addrlen (s);
653 if (MHD_YES != MHD_add_connection (httpd, fd, addr, len))
655 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
656 _("Failed to pass client to MHD\n"));
665 * Task run on shutdown
670 do_shutdown (void *cls)
672 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
673 "Shutting down...\n");
675 GNUNET_free_non_null (allow_origin);
676 GNUNET_free_non_null (allow_credentials);
677 GNUNET_free_non_null (allow_headers);
682 * Create an IPv4 listen socket bound to our port.
684 * @return NULL on error
686 static struct GNUNET_NETWORK_Handle *
689 struct GNUNET_NETWORK_Handle *ls;
690 struct sockaddr_in sa4;
693 memset (&sa4, 0, sizeof (sa4));
694 sa4.sin_family = AF_INET;
695 sa4.sin_port = htons (port);
696 #if HAVE_SOCKADDR_IN_SIN_LEN
697 sa4.sin_len = sizeof (sa4);
699 ls = GNUNET_NETWORK_socket_create (AF_INET,
705 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa4,
709 GNUNET_NETWORK_socket_close (ls);
718 * Create an IPv6 listen socket bound to our port.
720 * @return NULL on error
722 static struct GNUNET_NETWORK_Handle *
725 struct GNUNET_NETWORK_Handle *ls;
726 struct sockaddr_in6 sa6;
729 memset (&sa6, 0, sizeof (sa6));
730 sa6.sin6_family = AF_INET6;
731 sa6.sin6_port = htons (port);
732 #if HAVE_SOCKADDR_IN_SIN_LEN
733 sa6.sin6_len = sizeof (sa6);
735 ls = GNUNET_NETWORK_socket_create (AF_INET6,
741 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa6,
745 GNUNET_NETWORK_socket_close (ls);
754 * Callback for plugin load
757 * @param libname the name of the library loaded
758 * @param lib_ret the object returned by the plugin initializer
761 load_plugin (void *cls,
765 struct GNUNET_REST_Plugin *plugin = lib_ret;
766 struct GNUNET_HashCode key;
769 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
770 "Could not load plugin `%s'\n",
774 GNUNET_assert (1 < strlen (plugin->name));
775 GNUNET_assert ('/' == *plugin->name);
776 GNUNET_CRYPTO_hash (plugin->name+1, strlen (plugin->name+1), &key);
777 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (plugin_map,
780 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
782 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
783 "Could not load add plugin `%s'\n",
787 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
788 "Loaded plugin `%s'\n",
794 * Main function that will be run
797 * @param args remaining command-line arguments
798 * @param cfgfile name of the configuration file used (for saving, can be NULL)
799 * @param c configuration
805 const struct GNUNET_CONFIGURATION_Handle *c)
808 plugin_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
810 /* Get CORS data from cfg */
811 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
815 //No origin specified
816 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
817 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
820 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
821 "REST_ALLOW_CREDENTIALS",
824 //No origin specified
825 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
826 "No CORS Access-Control-Allow-Origin Header will be sent...\n");
829 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (cfg, "rest",
830 "REST_ALLOW_HEADERS",
833 //No origin specified
834 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
835 "No CORS Access-Control-Allow-Headers Header will be sent...\n");
838 /* Open listen socket proxy */
842 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
846 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock6, 5))
848 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
849 GNUNET_NETWORK_socket_close (lsock6);
854 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
855 lsock6, &do_accept, lsock6);
862 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
866 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock4, 5))
868 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
869 GNUNET_NETWORK_socket_close (lsock4);
874 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
875 lsock4, &do_accept, lsock4);
879 if ( (NULL == lsock4) &&
882 GNUNET_SCHEDULER_shutdown ();
885 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
886 "Service listens on port %llu\n",
888 httpd = MHD_start_daemon (MHD_USE_DEBUG | MHD_USE_NO_LISTEN_SOCKET,
891 &create_response, NULL,
892 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
893 MHD_OPTION_NOTIFY_COMPLETED, &mhd_completed_cb, NULL,
897 GNUNET_SCHEDULER_shutdown ();
901 GNUNET_PLUGIN_load_all ("libgnunet_plugin_rest",
905 GNUNET_SCHEDULER_add_shutdown (&do_shutdown, NULL);
911 * The main function for gnunet-rest-service
913 * @param argc number of arguments from the cli
914 * @param argv command line arguments
915 * @return 0 ok, 1 on error
919 main (int argc, char *const *argv)
921 struct GNUNET_GETOPT_CommandLineOption options[] = {
922 GNUNET_GETOPT_option_ulong ('p',
925 gettext_noop ("listen on specified port (default: 7776)"),
927 GNUNET_GETOPT_OPTION_END
929 static const char* err_page =
933 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
935 GNUNET_log_setup ("gnunet-rest-server", "WARNING", NULL);
936 failure_response = MHD_create_response_from_buffer (strlen(err_page),
938 MHD_RESPMEM_PERSISTENT);
941 GNUNET_PROGRAM_run (argc, argv, "gnunet-rest-server",
942 _("GNUnet REST server"),
945 MHD_destroy_response (failure_response);
946 GNUNET_free_non_null ((char *) argv);
950 /* end of gnunet-rest-server.c */