2 This file is part of GNUnet.
3 Copyright (C) 2012-2015 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, 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 struct GNUNET_SCHEDULER_Task * httpd_task;
67 * is this an ssl daemon? //TODO
72 * The port the service is running on (default 7776)
74 static unsigned long port = GNUNET_REST_SERVICE_PORT;
77 * The listen socket of the service for IPv4
79 static struct GNUNET_NETWORK_Handle *lsock4;
82 * The listen socket of the service for IPv6
84 static struct GNUNET_NETWORK_Handle *lsock6;
87 * The listen task ID for IPv4
89 static struct GNUNET_SCHEDULER_Task * ltask4;
92 * The listen task ID for IPv6
94 static struct GNUNET_SCHEDULER_Task * ltask6;
99 static struct MHD_Daemon *httpd;
102 * Response we return on failures.
104 static struct MHD_Response *failure_response;
109 static const struct GNUNET_CONFIGURATION_Handle *cfg;
112 * Map of loaded plugins.
114 struct GNUNET_CONTAINER_MultiHashMap *plugin_map;
117 * MHD Connection handle
119 struct MhdConnectionHandle
121 struct MHD_Connection *con;
123 struct MHD_Response *response;
125 struct GNUNET_REST_Plugin *plugin;
127 struct RestConnectionDataHandle *data_handle;
134 /* ************************* Global helpers ********************* */
138 * Task run whenever HTTP server operations are pending.
141 * @param tc sched context
145 const struct GNUNET_SCHEDULER_TaskContext *tc);
149 * Run MHD now, we have extra data ready for the callback.
156 GNUNET_SCHEDULER_cancel (httpd_task);
157 httpd_task = GNUNET_SCHEDULER_add_now (&do_httpd,
162 * Plugin result callback
164 * @param cls closure (MHD connection handle)
165 * @param data the data to return to the caller
166 * @param len length of the data
167 * @param status GNUNET_OK if successful
170 plugin_callback (void *cls,
175 struct MhdConnectionHandle *handle = cls;
176 struct MHD_Response *resp = MHD_create_response_from_buffer (len,
178 MHD_RESPMEM_MUST_COPY);
179 (void) MHD_add_response_header (resp,MHD_HTTP_HEADER_CONTENT_TYPE,"application/json");
180 handle->status = status;
181 handle->response = resp;
186 cleanup_url_map (void *cls,
187 const struct GNUNET_HashCode *key,
190 GNUNET_free_non_null (value);
195 cleanup_handle (struct MhdConnectionHandle *handle)
197 if (NULL != handle->response)
198 MHD_destroy_response (handle->response);
199 if (NULL != handle->data_handle)
201 if (NULL != handle->data_handle->url_param_map)
203 GNUNET_CONTAINER_multihashmap_iterate (handle->data_handle->url_param_map,
206 GNUNET_CONTAINER_multihashmap_destroy (handle->data_handle->url_param_map);
208 GNUNET_free (handle->data_handle);
210 GNUNET_free (handle);
215 url_iterator (void *cls,
216 enum MHD_ValueKind kind,
220 struct RestConnectionDataHandle *handle = cls;
221 struct GNUNET_HashCode hkey;
224 GNUNET_CRYPTO_hash (key, strlen (key), &hkey);
225 GNUNET_asprintf (&val, "%s", value);
227 GNUNET_CONTAINER_multihashmap_put (handle->url_param_map,
230 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
232 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
233 "Could not load add url param `%s'=%s\n",
239 /* ********************************* MHD response generation ******************* */
242 * Main MHD callback for handling requests.
245 * @param con MHD connection handle
246 * @param url the url in the request
247 * @param meth the HTTP method used ("GET", "PUT", etc.)
248 * @param ver the HTTP version string (i.e. "HTTP/1.1")
249 * @param upload_data the data being uploaded (excluding HEADERS,
250 * for a POST that fits into memory and that is encoded
251 * with a supported encoding, the POST data will NOT be
252 * given in upload_data and is instead available as
253 * part of MHD_get_connection_values; very large POST
254 * data *will* be made available incrementally in
256 * @param upload_data_size set initially to the size of the
257 * @a upload_data provided; the method must update this
258 * value to the number of bytes NOT processed;
259 * @param con_cls pointer to location where we store the 'struct Request'
260 * @return MHD_YES if the connection was handled successfully,
261 * MHD_NO if the socket must be closed due to a serious
262 * error while handling the request
265 create_response (void *cls,
266 struct MHD_Connection *con,
270 const char *upload_data,
271 size_t *upload_data_size,
275 struct GNUNET_HashCode key;
276 struct MhdConnectionHandle *con_handle;
277 struct RestConnectionDataHandle *rest_conndata_handle;
279 con_handle = *con_cls;
281 if (NULL == *con_cls)
283 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
284 "New connection %s\n", url);
285 char tmp_url[strlen(url)+1];
286 strcpy (tmp_url, url);
287 con_handle = GNUNET_new (struct MhdConnectionHandle);
288 con_handle->con = con;
289 con_handle->state = GN_REST_STATE_INIT;
290 *con_cls = con_handle;
292 plugin_name = strtok(tmp_url, "/");
294 if (NULL != plugin_name)
296 GNUNET_CRYPTO_hash (plugin_name, strlen (plugin_name), &key);
298 con_handle->plugin = GNUNET_CONTAINER_multihashmap_get (plugin_map,
302 con_handle->plugin = NULL;
304 if (NULL == con_handle->plugin)
306 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
307 "Queueing response with MHD\n");
308 GNUNET_free (con_handle);
309 MHD_queue_response (con,
310 MHD_HTTP_INTERNAL_SERVER_ERROR,
315 if (GN_REST_STATE_INIT == con_handle->state)
317 rest_conndata_handle = GNUNET_new (struct RestConnectionDataHandle);
318 rest_conndata_handle->method = meth;
319 rest_conndata_handle->url = url;
320 rest_conndata_handle->data = upload_data;
321 rest_conndata_handle->data_size = *upload_data_size;
322 rest_conndata_handle->url_param_map = GNUNET_CONTAINER_multihashmap_create (16,
324 con_handle->data_handle = rest_conndata_handle;
325 MHD_get_connection_values (con,
326 MHD_GET_ARGUMENT_KIND,
328 rest_conndata_handle);
329 con_handle->state = GN_REST_STATE_PROCESSING;
330 con_handle->plugin->process_request (rest_conndata_handle,
333 *upload_data_size = 0;
336 if (NULL != con_handle->response)
339 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
340 "Queueing response from plugin with MHD\n");
341 if (GNUNET_OK == con_handle->status) {
342 return MHD_queue_response (con,
344 con_handle->response);
346 return MHD_queue_response (con,
347 MHD_HTTP_BAD_REQUEST,
348 con_handle->response);
350 cleanup_handle (con_handle);
355 /* ******************** MHD HTTP setup and event loop ******************** */
358 * Function called when MHD decides that we are done with a connection.
361 * @param connection connection handle
362 * @param con_cls value as set by the last call to
363 * the MHD_AccessHandlerCallback, should be our handle
364 * @param toe reason for request termination (ignored)
367 mhd_completed_cb (void *cls,
368 struct MHD_Connection *connection,
370 enum MHD_RequestTerminationCode toe)
373 if (MHD_REQUEST_TERMINATED_COMPLETED_OK != toe)
374 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
375 "MHD encountered error handling request: %d\n",
381 * Kill the MHD daemon.
388 MHD_stop_daemon (httpd);
391 if (NULL != httpd_task)
393 GNUNET_SCHEDULER_cancel (httpd_task);
399 * Task run whenever HTTP server is idle for too long. Kill it.
402 * @param tc sched context
405 kill_httpd_task (void *cls,
406 const struct GNUNET_SCHEDULER_TaskContext *tc)
412 * Schedule MHD. This function should be called initially when an
413 * MHD is first getting its client socket, and will then automatically
414 * always be called later whenever there is work to be done.
416 * @param hd the daemon to schedule
424 struct GNUNET_NETWORK_FDSet *wrs;
425 struct GNUNET_NETWORK_FDSet *wws;
428 MHD_UNSIGNED_LONG_LONG timeout;
429 struct GNUNET_TIME_Relative tv;
435 if (MHD_YES != MHD_get_fdset (httpd, &rs, &ws, &es, &max))
440 haveto = MHD_get_timeout (httpd, &timeout);
441 if (MHD_YES == haveto)
442 tv.rel_value_us = (uint64_t) timeout * 1000LL;
444 tv = GNUNET_TIME_UNIT_FOREVER_REL;
447 wrs = GNUNET_NETWORK_fdset_create ();
448 wws = GNUNET_NETWORK_fdset_create ();
449 GNUNET_NETWORK_fdset_copy_native (wrs, &rs, max + 1);
450 GNUNET_NETWORK_fdset_copy_native (wws, &ws, max + 1);
457 if (NULL != httpd_task)
458 GNUNET_SCHEDULER_cancel (httpd_task);
459 if ( (MHD_YES != haveto) &&
462 /* daemon is idle, kill after timeout */
463 httpd_task = GNUNET_SCHEDULER_add_delayed (MHD_CACHE_TIMEOUT,
470 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
475 GNUNET_NETWORK_fdset_destroy (wrs);
477 GNUNET_NETWORK_fdset_destroy (wws);
481 * Task run whenever HTTP server operations are pending.
484 * @param tc scheduler context
488 const struct GNUNET_SCHEDULER_TaskContext *tc)
496 * Accept new incoming connections
498 * @param cls the closure with the lsock4 or lsock6
499 * @param tc the scheduler context
502 do_accept (void *cls,
503 const struct GNUNET_SCHEDULER_TaskContext *tc)
505 struct GNUNET_NETWORK_Handle *lsock = cls;
506 struct GNUNET_NETWORK_Handle *s;
508 const struct sockaddr *addr;
515 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
518 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
522 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
525 s = GNUNET_NETWORK_socket_accept (lsock, NULL, NULL);
528 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "accept");
531 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
532 "Got an inbound connection, waiting for data\n");
533 fd = GNUNET_NETWORK_get_fd (s);
534 addr = GNUNET_NETWORK_get_addr (s);
535 len = GNUNET_NETWORK_get_addrlen (s);
536 if (MHD_YES != MHD_add_connection (httpd, fd, addr, len))
538 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
539 _("Failed to pass client to MHD\n"));
547 * Task run on shutdown
550 * @param tc task context
553 do_shutdown (void *cls,
554 const struct GNUNET_SCHEDULER_TaskContext *tc)
556 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
557 "Shutting down...\n");
562 * Create an IPv4 listen socket bound to our port.
564 * @return NULL on error
566 static struct GNUNET_NETWORK_Handle *
569 struct GNUNET_NETWORK_Handle *ls;
570 struct sockaddr_in sa4;
573 memset (&sa4, 0, sizeof (sa4));
574 sa4.sin_family = AF_INET;
575 sa4.sin_port = htons (port);
576 #if HAVE_SOCKADDR_IN_SIN_LEN
577 sa4.sin_len = sizeof (sa4);
579 ls = GNUNET_NETWORK_socket_create (AF_INET,
585 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa4,
589 GNUNET_NETWORK_socket_close (ls);
597 * Create an IPv6 listen socket bound to our port.
599 * @return NULL on error
601 static struct GNUNET_NETWORK_Handle *
604 struct GNUNET_NETWORK_Handle *ls;
605 struct sockaddr_in6 sa6;
608 memset (&sa6, 0, sizeof (sa6));
609 sa6.sin6_family = AF_INET6;
610 sa6.sin6_port = htons (port);
611 #if HAVE_SOCKADDR_IN_SIN_LEN
612 sa6.sin6_len = sizeof (sa6);
614 ls = GNUNET_NETWORK_socket_create (AF_INET6,
620 GNUNET_NETWORK_socket_bind (ls, (const struct sockaddr *) &sa6,
624 GNUNET_NETWORK_socket_close (ls);
632 * Callback for plugin load
635 * @param libname the name of the library loaded
636 * @param lib_ret the object returned by the plugin initializer
639 load_plugin (void *cls,
643 struct GNUNET_REST_Plugin *plugin = lib_ret;
644 struct GNUNET_HashCode key;
647 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
648 "Could not load plugin `%s'\n",
652 GNUNET_assert (1 < strlen (plugin->name));
653 GNUNET_assert ('/' == *plugin->name);
654 GNUNET_CRYPTO_hash (plugin->name+1, strlen (plugin->name+1), &key);
655 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (plugin_map,
658 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY))
660 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
661 "Could not load add plugin `%s'\n",
665 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
666 "Loaded plugin `%s'\n",
671 * Main function that will be run
674 * @param args remaining command-line arguments
675 * @param cfgfile name of the configuration file used (for saving, can be NULL)
676 * @param c configuration
679 run (void *cls, char *const *args, const char *cfgfile,
680 const struct GNUNET_CONFIGURATION_Handle *c)
683 plugin_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
685 /* Open listen socket proxy */
688 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
691 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock6, 5))
693 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
694 GNUNET_NETWORK_socket_close (lsock6);
699 ltask6 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
700 lsock6, &do_accept, lsock6);
705 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
708 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (lsock4, 5))
710 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
711 GNUNET_NETWORK_socket_close (lsock4);
716 ltask4 = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
717 lsock4, &do_accept, lsock4);
720 if ( (NULL == lsock4) &&
723 GNUNET_SCHEDULER_shutdown ();
726 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
727 "Service listens on port %u\n",
729 httpd = MHD_start_daemon (MHD_USE_DEBUG | MHD_USE_NO_LISTEN_SOCKET,
732 &create_response, NULL,
733 MHD_OPTION_CONNECTION_TIMEOUT, (unsigned int) 16,
734 MHD_OPTION_NOTIFY_COMPLETED, &mhd_completed_cb, NULL,
738 GNUNET_SCHEDULER_shutdown ();
742 GNUNET_PLUGIN_load_all ("libgnunet_plugin_rest",
746 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
752 * The main function for gnunet-rest-service
754 * @param argc number of arguments from the cli
755 * @param argv command line arguments
756 * @return 0 ok, 1 on error
760 main (int argc, char *const *argv)
762 static const struct GNUNET_GETOPT_CommandLineOption options[] = {
764 gettext_noop ("listen on specified port (default: 7776)"), 1,
765 &GNUNET_GETOPT_set_ulong, &port},
766 GNUNET_GETOPT_OPTION_END
768 static const char* err_page =
772 if (GNUNET_OK != GNUNET_STRINGS_get_utf8_args (argc, argv, &argc, &argv))
774 GNUNET_log_setup ("gnunet-rest-service", "WARNING", NULL);
775 failure_response = MHD_create_response_from_buffer (strlen(err_page),
777 MHD_RESPMEM_PERSISTENT);
778 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
782 GNUNET_PROGRAM_run (argc, argv, "gnunet-rest-server",
783 _("GNUnet REST server"),
786 MHD_destroy_response (failure_response);
787 GNUNET_free_non_null ((char *) argv);
791 /* end of gnunet-rest-server.c */